Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / doc / packf.me
1 .\"     This file is automatically generated.  Do not edit!
2 .\" @(#)$Id: packf.rf,v 1.8 1992/05/12 22:24:59 jromine Exp $
3 .SC PACKF 1
4 .NA
5 packf \- compress an MH folder into a single file
6 .SY
7 packf
8 \%[+folder] \%[msgs]
9 \%[\-file\ name]
10 \%[\-help]
11 .DE
12 \fIPackf\fR
13 takes messages from a folder and copies them to a single file.
14 Each message in the file is separated by four CTRL\-A's and a
15 newline.
16 Messages packed can be unpacked using \fIinc\fR.
17
18 If the \fIname\fR given to the `\-file\ name' switch exists,
19 then the messages specified
20 will be appended to the end of the file, otherwise the file will be created
21 and the messages appended.
22 .Fi
23 ^$HOME/\&.mh\(ruprofile~^The user profile
24 ^\&.msgbox\&.map~^A binary index of the file
25 .Pr
26 ^Path:~^To determine the user's MH directory
27 .Ps
28 ^Current\-Folder:~^To find the default current folder
29 .Ps
30 ^Msg\-Protect:~^To set mode when creating a new `file'
31 .Sa
32 inc(1)
33 .De
34 `+folder' defaults to the current folder
35 .Ds
36 `msgs' defaults to all
37 .Ds
38 `\-file ./msgbox' 
39 .Co
40 If a folder is given, it will become the current folder.
41 The first message packed will become the current message.
42 .Bu
43 \fIPackf\fP doesn't handle the old UUCP-style \*(lqmbox\*(rq format
44 (used by \fISendMail\fP).
45 To pack messages into this format,
46 use the script \fI/opt/mh-6.8.5/lib/packmbox\fP.
47 Note that \fIpackmbox\fP does not take the `\-file' option of \fIpackf\fP,
48 and instead writes its output on \fIstdout\fP.
49 .En