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

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