git.marmaro.de Git - mmh/blob - man/packf.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH PACKF %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 packf \- pack messages in nmh folder into a single file
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 packf
  15 \%[+folder] \%[msgs]
  16 \%[\-file\ name]
  17 \%[\-mbox] \%[-mmdf]
  18 .br
  19 \%[\-version]
  20 \%[\-help]
  21 .in -.5i
  22 .SH DESCRIPTION
  23 \fIPackf\fR will pack copies of messages from a folder, into a single
  24 file.
  25
  26 If the `-mbox' switch is given (the default), then the messages are
  27 separated using mbox (uucp) style delimiters.  This is the format used
  28 by most mail clients (elm, mailx, etc.).
  29
  30 If the `-mmdf' switch is given, then the messages are separated by
  31 mmdf style delimiters.  Each message in the file is separated by four
  32 CTRL\-A's and a newline.
  33
  34 You may specify the name of the file in which to use with the
  35 `\-file\ name' switch.  If you do not specify the name of the file, it
  36 will default to `msgbox'.
  37
  38 If the given file name points to an existing file, then the specified
  39 messages will be appended to the end of the file, otherwise the file
  40 will be created and the messages appended.
  41
  42 \fIpackf\fR makes an mbox-style delimiter by examining the first line
  43 of the message.  If the first line is a \*(lqReturn-Path:\*(rq
  44 field, its address and the current date and time are used.  Otherwise,
  45 if the first line has an \*(lqX-Envelope-From:\*(rq field, its
  46 contents (which should already be in the correct format) are used.
  47 Otherwise, a dummy address and the current date and time are used.
  48
  49 Messages that are packed by \fIpackf\fR can be unpacked using
  50 \fIinc\fR.
  51
  52 .Fi
  53 ^$HOME/\&.mh\(ruprofile~^The user profile
  54 ^\&.msgbox\&.map~^A binary index of the file
  55 .Pr
  56 ^Path:~^To determine the user's nmh directory
  57 .Ps
  58 ^Current\-Folder:~^To find the default current folder
  59 .Ps
  60 ^Msg\-Protect:~^To set mode when creating a new `file'
  61 .Sa
  62 inc(1)
  63 .De
  64 `+folder' defaults to the current folder
  65 .Ds
  66 `msgs' defaults to all
  67 .Ds
  68 `\-mbox'
  69 .Ds
  70 `\-file ./msgbox'
  71 .Co
  72 If a folder is given, it will become the current folder.  The first
  73 message packed will become the current message.
  74 .En