Initial revision
[mmh] / 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% 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 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 Messages that are packed by \fIpackf\fR can be unpacked using
43 \fIinc\fR.
44
45 .Fi
46 ^$HOME/\&.mh\(ruprofile~^The user profile
47 ^\&.msgbox\&.map~^A binary index of the file
48 .Pr
49 ^Path:~^To determine the user's nmh directory
50 .Ps
51 ^Current\-Folder:~^To find the default current folder
52 .Ps
53 ^Msg\-Protect:~^To set mode when creating a new `file'
54 .Sa
55 inc(1)
56 .De
57 `+folder' defaults to the current folder
58 .Ds
59 `msgs' defaults to all
60 .Ds
61 `\-mbox'
62 .Ds
63 `\-file ./msgbox' 
64 .Co
65 If a folder is given, it will become the current folder.  The first
66 message packed will become the current message.
67 .En