]> diplodocus.org Git - nmh/blobdiff - man/inc.man
Add code for (and convert world to) the new world lock order.
[nmh] / man / inc.man
index 73a5bcd45b5bf3c9663c7253b091d7dd82599daf..b534d1b12cfe8b5278f480e0653fb12e6ec0dd08 100644 (file)
@@ -1,7 +1,7 @@
+.TH INC %manext1% "February 16, 2013" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
-.TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] XXX
 .SH NAME
 inc \- incorporate new mail
 .SH SYNOPSIS
@@ -25,6 +25,8 @@ inc \- incorporate new mail
 .IR columns ]
 .RB [ \-host
 .IR hostname ]
+.RB [ \-port
+.IR portname/number ]
 .RB [ \-user
 .IR username ]
 .RB [ \-pack
@@ -32,7 +34,7 @@ inc \- incorporate new mail
 .RB [ \-nopack ]
 .RB [ \-proxy
 .IR command ]
-.RB [ \-sasl ]
+.RB [ \-sasl " | " \-nosasl ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-snoop ]
@@ -151,6 +153,13 @@ Note that the name file will NOT be zeroed, unless the
 .B \-truncate
 switch is given.
 .PP
+The
+.B \-file
+switch does not support use of standard input.  Instead,
+the
+.B rcvstore
+command can be used to incorporate mail from the standard input stream.
+.PP
 If the environment variable
 .B $MAILDROP
 is set, then
@@ -198,7 +207,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
-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
@@ -283,44 +295,74 @@ Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
 when viewing the POP transaction with the
 .B \-snoop
 switch.
-
 .SH FILES
-.fc ^ ~
-.nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
-^%etcdir%/mts.conf~^nmh mts configuration file
-^%mailspool%/$USER~^Location of mail drop
-.fi
-
+.PD 0
+.TP 20
+$HOME/.mh\-profile
+The user's profile.
+.TP
+%etcdir%/mts.conf
+mts configuration file.
+.TP
+%mailspool%/$USER
+Location of the system mail drop.
+.PD
 .SH "PROFILE COMPONENTS"
-.fc ^ ~
-.nf
-.ta 2.4i
-.ta \w'ExtraBigProfileName  'u
-^Path:~^To determine the user's nmh directory
-^Alternate\-Mailboxes:~^To determine the user's mailboxes
-^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
-^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
-
+.PD 0
+.TP 20
+Path:
+To determine the user's nmh directory.
+.TP
+Alternate\-Mailboxes:
+To determine the user's mailboxes.
+.TP
+Inbox:
+To determine the inbox.
+.TP
+Folder\-Protect:
+To set mode when creating a new folder.
+.TP
+Msg\-Protect:
+To set mode when creating a new message and audit\-file.
+.TP
+Unseen\-Sequence:
+To name sequences denoting unseen messages.
+.PD
 .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),
+.IR rcvstore (1)
 .SH DEFAULTS
-.nf
-.RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
-.RB ` \-noaudit '
-.RB ` \-changecur '
-.RB ` \-format "' defaulted as described above"
-.RB ` \-nosilent '
-.RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
-.RB ` \-width "' defaulted to the width of the terminal"
-.RB ` \-nopack '
-.fi
-
+.PD 0
+.TP 20
++folder
+defaulted by \*(lqInbox\*(rq above.
+.TP
+\-noaudit
+.TP
+\-changecur
+.TP
+\-format
+As described above.
+.TP
+\-nosilent
+.TP
+\-nosasl
+.TP
+\-truncate
+If
+.B \-file
+.I name
+not given,
+\-notruncate otherwise.
+.TP
+\-width
+The width of the terminal.
+.TP
+\-nopack
+.PD
 .SH CONTEXT
 The folder into which messages are being incorporated will become the
 current folder.  The first message incorporated will become the current
@@ -329,12 +371,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
-quotes.