]> diplodocus.org Git - nmh/blobdiff - man/inc.man
Added note that suffixes were removed from filenames of temporary files.
[nmh] / man / inc.man
index d725b6c8771b8d3f70270265dd87a92301c8c15c..8d0a46269c45ff1d1ebb2323bac41df894603efd 100644 (file)
@@ -1,4 +1,4 @@
-.TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] XXX
+.TH INC %manext1% "April 14, 2013" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -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,42 +207,16 @@ 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
-to assume that your account name on
-the POP server is the same as your current username.  To specify
-a different username, use the
+To specify a username for authentication with the POP server, use the
 .B \-user
 .I username
-switch.
-.PP
-When using POP, you will normally need to type the password for
-your account on the POP server, in order to retrieve your messages.
-It is possible to automate this process by creating a
-.RI \*(lq .netrc \*(rq
-file containing your login account information for this POP server.
-For each POP server, this file should have a line of the following
-form.  Replace the words
-.IR mypopserver ,
-.IR mylogin ,
-and
-.I mypassword
-with your own account information.
-.PP
-.RS 5
-.B machine
-.I mypopserver
-.B login
-.I mylogin
-.B password
-.I mypassword
-.RE
-.PP
-This
-.RI \*(lq .netrc \*(rq
-file should be owned and readable only by you.
+switch.  The credentials profile entry in the mh_profile(5) man page
+describes the ways to supply a username and password.
 .PP
 If passed the
 .B \-proxy
@@ -271,8 +254,9 @@ has been compiled with SASL support, the
 switch will enable
 the use of SASL authentication.  Depending on the SASL mechanism used, this
 may require an additional password prompt from the user (but the
-.RI \*(lq .netrc \*(rq
-file can be used to store this password).  The
+.I netrc
+file can be used to store this password, as described in the
+mh-profile(5) man page).  The
 .B \-saslmech
 switch can be used to select a particular SASL mechanism.
 .PP
@@ -284,41 +268,74 @@ 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"
 .IR mhmail (1),
 .IR scan (1),
 .IR mh\-mail (5),
-.IR post (8)
+.IR mh\-profile (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
@@ -327,11 +344,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.