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