Changed msg_style and msg_delim to be file static to m_getfld.c
[mmh] / man / inc.man
index 540b378..627c20e 100644 (file)
@@ -1,7 +1,7 @@
+.TH INC %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"
-.TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 inc \- incorporate new mail
 .SH SYNOPSIS
 .SH NAME
 inc \- incorporate new mail
 .SH SYNOPSIS
@@ -23,9 +23,10 @@ inc \- incorporate new mail
 .RB [ \-truncate " | " \-notruncate ]
 .RB [ \-width
 .IR columns ]
 .RB [ \-truncate " | " \-notruncate ]
 .RB [ \-width
 .IR columns ]
-%nmhbeginpop%
 .RB [ \-host
 .IR hostname ]
 .RB [ \-host
 .IR hostname ]
+.RB [ \-port
+.IR portname/number ]
 .RB [ \-user
 .IR username ]
 .RB [ \-pack
 .RB [ \-user
 .IR username ]
 .RB [ \-pack
@@ -33,11 +34,10 @@ inc \- incorporate new mail
 .RB [ \-nopack ]
 .RB [ \-proxy
 .IR command ]
 .RB [ \-nopack ]
 .RB [ \-proxy
 .IR command ]
-.RB [ \-sasl ]
+.RB [ \-sasl " | " \-nosasl ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-snoop ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-snoop ]
-%nmhendpop%
 .RB [ \-version ]
 .RB [ \-help ]
 .ad
 .RB [ \-version ]
 .RB [ \-help ]
 .ad
@@ -47,6 +47,14 @@ incorporates mail from the user's incoming mail drop into
 an
 .B nmh
 folder.
 an
 .B nmh
 folder.
+If the mail drop is a file, it can be in
+.B mbox
+or
+.B MMDF
+format.
+If the mail drop is a directory it will considered to be a
+.B Maildir
+format mail drop.
 .PP
 You may specify which folder to use with
 .IR +folder .
 .PP
 You may specify which folder to use with
 .IR +folder .
@@ -67,12 +75,12 @@ listing of the new mail is produced.
 .PP
 If the user's profile contains a
 .RI \*(lq "Msg\-Protect: nnn" \*(rq
 .PP
 If the user's profile contains a
 .RI \*(lq "Msg\-Protect: nnn" \*(rq
-entry, it
-will be used as the protection on the newly created messages, otherwise
-the
+entry, it will be used as the protection on the newly created
+messages, otherwise the
 .B nmh
 .B nmh
-default of 0644 will be used.  For all subsequent operations
-on these messages, this initially assigned protection will be preserved.
+default of 0600 will be used (on filesystems that support it).  For
+all subsequent operations on these messages, this initially assigned
+protection will be preserved.
 .PP
 If the switch
 .B \-audit
 .PP
 If the switch
 .B \-audit
@@ -172,7 +180,6 @@ switch directs
 to be quiet and not ask any questions at all.  This is useful for putting
 .B inc
 in the background and going on to other things.
 to be quiet and not ask any questions at all.  This is useful for putting
 .B inc
 in the background and going on to other things.
-%nmhbeginpop%
 .PP
 .SS "Using POP"
 .B inc
 .PP
 .SS "Using POP"
 .B inc
@@ -193,7 +200,10 @@ will query this POP service host for mail to incorporate.  If
 is set and
 .B \-host
 is specified as well, the commandline switch will override
 is set and
 .B \-host
 is specified as well, the commandline switch will override
-the environment variable.
+the environment variable.  The
+.B \-port
+switch specifies the port name or number used to connect to the POP
+server.  If unspecified the default is \*(lqpop3\*(rq.
 .PP
 The default is for
 .B inc
 .PP
 The default is for
 .B inc
@@ -278,8 +288,6 @@ Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
 when viewing the POP transaction with the
 .B \-snoop
 switch.
 when viewing the POP transaction with the
 .B \-snoop
 switch.
-%nmhendpop%
-
 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf
@@ -288,7 +296,6 @@ switch.
 ^%etcdir%/mts.conf~^nmh mts configuration file
 ^%mailspool%/$USER~^Location of mail drop
 .fi
 ^%etcdir%/mts.conf~^nmh mts configuration file
 ^%mailspool%/$USER~^Location of mail drop
 .fi
-
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
@@ -301,10 +308,11 @@ switch.
 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi
 ^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"
 .SH "SEE ALSO"
-mhmail(1), scan(1), mh\-mail(5), post(8)
-
+.IR mhmail (1),
+.IR scan (1),
+.IR mh\-mail (5),
+.IR post (8)
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
@@ -312,13 +320,11 @@ mhmail(1), scan(1), mh\-mail(5), post(8)
 .RB ` \-changecur '
 .RB ` \-format "' defaulted as described above"
 .RB ` \-nosilent '
 .RB ` \-changecur '
 .RB ` \-format "' defaulted as described above"
 .RB ` \-nosilent '
+.RB ` \-nosasl '
 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
 .RB ` \-width "' defaulted to the width of the terminal"
 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
 .RB ` \-width "' defaulted to the width of the terminal"
-%nmhbeginpop%
 .RB ` \-nopack '
 .RB ` \-nopack '
-%nmhendpop%
 .fi
 .fi
-
 .SH CONTEXT
 The folder into which messages are being incorporated will become the
 current folder.  The first message incorporated will become the current
 .SH CONTEXT
 The folder into which messages are being incorporated will become the
 current folder.  The first message incorporated will become the current
@@ -327,12 +333,3 @@ message, unless the
 option is specified.  This leaves the context ready for a
 .B show
 of the first new message.
 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.