Factor trim format function out
[mmh] / man / inc.man1
index 1dc9589..ed586c1 100644 (file)
@@ -15,22 +15,20 @@ inc \- incorporate new mail
 .RB [ \-changecur " | " \-nochangecur ]
 .RB [ \-form
 .IR formfile ]
-.RB [ \-format
-.IR string ]
 .RB [ \-file
 .IR name ]
 .RB [ \-silent " | " \-nosilent ]
 .RB [ \-truncate " | " \-notruncate ]
 .RB [ \-width
 .IR columns ]
-.RB [ \-version ]
+.RB [ \-Version ]
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
 .B Inc
 incorporates mail from the user's incoming mail drop into
 an
-.B nmh
+.B mh
 folder.
 .PP
 You may specify which folder to use with
@@ -38,11 +36,13 @@ You may specify which folder to use with
 If no folder is specified, then
 .B inc
 will use either the folder given by a (non\-empty)
-.RI \*(lq Inbox \*(rq
+.RI ` Inbox '
 entry in the user's profile, or the folder named
-.RI \*(lq inbox \*(rq.
+.RI ` inbox '.
 If the specified (or default) folder doesn't
-exist, the user will be queried prior to its creation.
+exist, the user will (in
+.B \-nosilent
+mode) be queried prior to its creation.
 .PP
 When the new messages are incorporated into the folder, they are assigned
 numbers starting with the next highest number for the folder.  As the
@@ -51,11 +51,11 @@ messages are processed, a
 listing of the new mail is produced.
 .PP
 If the user's profile contains a
-.RI \*(lq "Msg\-Protect: nnn" \*(rq
+.RI ` "Msg\-Protect: nnn" '
 entry, it
 will be used as the protection on the newly created messages, otherwise
 the
-.B nmh
+.B mmh
 default of 0644 will be used.  For all subsequent operations
 on these messages, this initially assigned protection will be preserved.
 .PP
@@ -85,15 +85,15 @@ Eventually,
 and
 .B dist
 may also produce audits to this (or another) file, perhaps with
-.RI \*(lq Message\-Id \*(rq
+.RI ` Message\-Id '
 information to keep an exact correspondence
 history.
-.RI \*(lq Audit\-file \*(rq
+.RI ` Audit\-file '
 will be in the current directory unless a full path is specified.
 .PP
 .B Inc
 will incorporate even improperly formatted messages into the
-user's nmh folder, inserting a blank line prior to the offending component
+user's mh folder, inserting a blank line prior to the offending component
 and printing a comment identifying the bad message.
 .PP
 In all cases, the user's mail drop will be zeroed, unless the
@@ -101,7 +101,7 @@ In all cases, the user's mail drop will be zeroed, unless the
 switch is given.
 .PP
 If the profile entry
-.RI \*(lq Unseen\-Sequence \*(rq
+.RI ` Unseen\-Sequence '
 is present and non\-empty, then
 .B inc
 will add each of the newly incorporated messages to
@@ -112,8 +112,6 @@ will not zero each sequence prior to adding messages.
 The interpretation of the
 .B \-form
 .IR formatfile ,
-.B \-format
-.IR string ,
 and
 .B \-width
 .I columns
@@ -126,7 +124,14 @@ By using the
 switch, one can direct
 .B inc
 to incorporate messages from a file other than the user's maildrop.
-Note that the name file will NOT be zeroed, unless the
+In particular, if
+.I name
+is
+.RI ` - '
+then
+.B inc
+will read messages from standard input.
+Note that the named file will NOT be zeroed, unless the
 .B \-truncate
 switch is given.
 .PP
@@ -142,10 +147,10 @@ switch still overrides this, however).  If this
 environment variable is not set, then
 .B inc
 will consult the profile entry
-.RI \*(lq MailDrop \*(rq
+.RI ` MailDrop '
 for this information.  If the value found is
 not absolute, then it is interpreted relative to the user's
-.B nmh
+.B mh
 directory.  If the value is not found, then
 .B inc
 will look in the standard system location for the user's maildrop.
@@ -163,7 +168,6 @@ in the background and going on to other things.
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/.mmh/profile~^The user profile
-^%etcdir%/mts.conf~^nmh mts configuration file
 ^%mailspool%/$USER~^Location of mail drop
 .fi
 
@@ -174,21 +178,21 @@ in the background and going on to other things.
 .ta \w'ExtraBigProfileName  'u
 ^Path:~^To determine the user's mail storage
 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
-^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
+^Inbox:~^To determine the inbox, default `inbox'
 ^Folder\-Protect:~^To set mode when creating a new folder
 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi
 
 .SH "SEE ALSO"
-mhmail(1), scan(1), mh\-mail(5), post(8)
+scan(1), mh\-mail(5)
 
 .SH DEFAULTS
 .nf
-.RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
+.RB ` +folder "' defaulted by `Inbox' above"
 .RB ` \-noaudit '
 .RB ` \-changecur '
-.RB ` \-format "' defaulted as described above"
+.RB ` \-form "' defaulted as described above"
 .RB ` \-nosilent '
 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
 .RB ` \-width "' defaulted to the width of the terminal"
@@ -202,12 +206,3 @@ message, unless the
 option is specified.  This leaves the context ready for a
 .B show
 of the first new message.
-
-.SH BUGS
-The argument to the
-.B \-format
-switch must be interpreted as a single
-token by the shell that invokes
-.BR inc .
-Therefore, one must usually place the argument to this switch inside
-double\-quotes.