Create and use header file for uip/mhfree.c's exports.

[nmh] / man / packf.man

diff --git a/man/packf.man b/man/packf.man
index a9f66cbdf5fb1d74a5f44739eb50639dd96a4321..b96489da4a259d7ab1e23c291e05645450db314e 100644 (file)
--- a/man/packf.man
+++ b/man/packf.man
@@ -1,67 +1,87 @@
-.\"
+.TH PACKF %manext1% 1999-05-13 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH PACKF %manext1% MH.6.8 [%nmhversion%]
+.

 .SH NAME
 packf \- pack messages in nmh folder into a single file
 .SH SYNOPSIS
 .SH NAME
 packf \- pack messages in nmh folder into a single file
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-packf
-\%[+folder] \%[msgs]
-\%[\-file\ name]
-\%[\-mbox] \%[-mmdf]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B packf
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-file
+.IR name ]
+.RB [ \-mbox ]
+.RB [ \-mmdf ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fIPackf\fR will pack copies of messages from a folder, into a single
+.B packf
+will pack copies of messages from a folder, into a single

 file.
 file.

-
-If the `-mbox' switch is given (the default), then the messages are
+.PP
+If the
+.B \-mbox
+switch is given (the default), then the messages are

 separated using mbox (uucp) style delimiters.  This is the format used
 by most mail clients (elm, mailx, etc.).
 separated using mbox (uucp) style delimiters.  This is the format used
 by most mail clients (elm, mailx, etc.).

-
-If the `-mmdf' switch is given, then the messages are separated by
+.PP
+If the
+.B \-mmdf
+switch is given, then the messages are separated by

 mmdf style delimiters.  Each message in the file is separated by four
 CTRL\-A's and a newline.
 mmdf style delimiters.  Each message in the file is separated by four
 CTRL\-A's and a newline.

-
-You may specify the name of the file in which to use with the
-`\-file\ name' switch.  If you do specify the name of the file, it
-will default to `msgbox'.
-
+.PP
+You may specify the name of the file in which to pack messages with the
+.B \-file
+.I name
+switch.  If you do not specify the name of the file, it
+will default to
+.RI \*(lq msgbox \*(rq.
+.PP

 If the given file name points to an existing file, then the specified
 messages will be appended to the end of the file, otherwise the file
 will be created and the messages appended.
 If the given file name points to an existing file, then the specified
 messages will be appended to the end of the file, otherwise the file
 will be created and the messages appended.

-
-Messages that are packed by \fIpackf\fR can be unpacked using
-\fIinc\fR.
-
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-^\&.msgbox\&.map~^A binary index of the file
-.Pr
+.PP
+.B packf
+makes an mbox-style delimiter by examining the first line
+of the message.  If the first line is a \*(lqReturn-Path\*(rq
+field, its address and the current date and time are used.  Otherwise,
+if the first line has an \*(lqX-Envelope-From\*(rq field, its
+contents (which should already be in the correct format) are used.
+Otherwise, a dummy address and the current date and time are used.
+.PP
+Messages that are packed by
+.B packf
+can be unpacked using
+.BR inc .
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile
+^.msgbox.map~^A binary index of the file
+.fi
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u

 ^Path:~^To determine the user's nmh directory
 ^Path:~^To determine the user's nmh directory

-.Ps

 ^Current\-Folder:~^To find the default current folder
 ^Current\-Folder:~^To find the default current folder

-.Ps

 ^Msg\-Protect:~^To set mode when creating a new `file'
 ^Msg\-Protect:~^To set mode when creating a new `file'

-.Sa
-inc(1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to all
-.Ds
-`\-mbox'
-.Ds
-`\-file ./msgbox' 
-.Co
+.fi
+.SH "SEE ALSO"
+.IR inc (1),
+.SH DEFAULTS
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msgs "' defaults to all"
+.RB ` \-mbox '
+.RB ` "\-file ./msgbox" '
+.fi
+.SH CONTEXT

 If a folder is given, it will become the current folder.  The first
 message packed will become the current message.
 If a folder is given, it will become the current folder.  The first
 message packed will become the current message.

-.En