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

   1 .TH PACKF %manext1% "January 8, 2012" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 packf \- pack messages in nmh folder into a single file
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B packf
  11 .RI [ +folder ]
  12 .RI [ msgs ]
  13 .RB [ \-file
  14 .IR name ]
  15 .RB [ \-mbox ]
  16 .RB [ \-mmdf ]
  17 .RB [ \-version ]
  18 .RB [ \-help ]
  19 .ad
  20 .SH DESCRIPTION
  21 .B Packf
  22 will pack copies of messages from a folder, into a single
  23 file.
  24 .PP
  25 If the
  26 .B \-mbox
  27 switch is given (the default), then the messages are
  28 separated using mbox (uucp) style delimiters.  This is the format used
  29 by most mail clients (elm, mailx, etc.).
  30 .PP
  31 If the
  32 .B \-mmdf
  33 switch is given, then the messages are separated by
  34 mmdf style delimiters.  Each message in the file is separated by four
  35 CTRL\-A's and a newline.
  36 .PP
  37 You may specify the name of the file in which to use with the
  38 .B \-file
  39 .I name
  40 switch.  If you do not specify the name of the file, it
  41 will default to
  42 .RI \*(lq msgbox \*(rq.
  43 .PP
  44 If the given file name points to an existing file, then the specified
  45 messages will be appended to the end of the file, otherwise the file
  46 will be created and the messages appended.
  47 .PP
  48 .B packf
  49 makes an mbox-style delimiter by examining the first line
  50 of the message.  If the first line is a \*(lqReturn-Path\*(rq
  51 field, its address and the current date and time are used.  Otherwise,
  52 if the first line has an \*(lqX-Envelope-From\*(rq field, its
  53 contents (which should already be in the correct format) are used.
  54 Otherwise, a dummy address and the current date and time are used.
  55 .PP
  56 Messages that are packed by
  57 .B packf
  58 can be unpacked using
  59 .BR inc .
  60 .SH FILES
  61 .fc ^ ~
  62 .nf
  63 .ta \w'%etcdir%/ExtraBigFileName  'u
  64 ^$HOME/\&.mh\(ruprofile~^The user profile
  65 ^\&.msgbox\&.map~^A binary index of the file
  66 .fi
  67 .SH "PROFILE COMPONENTS"
  68 .fc ^ ~
  69 .nf
  70 .ta 2.4i
  71 .ta \w'ExtraBigProfileName  'u
  72 ^Path:~^To determine the user's nmh directory
  73 ^Current\-Folder:~^To find the default current folder
  74 ^Msg\-Protect:~^To set mode when creating a new `file'
  75 .fi
  76 .SH "SEE ALSO"
  77 .IR inc (1),
  78 .IR msh (1)
  79 .SH DEFAULTS
  80 .nf
  81 .RB ` +folder "' defaults to the current folder"
  82 .RB ` msgs "' defaults to all"
  83 .RB ` \-mbox '
  84 .RB ` "\-file ./msgbox" '
  85 .fi
  86 .SH CONTEXT
  87 If a folder is given, it will become the current folder.  The first
  88 message packed will become the current message.