+.TH INC %manext1% "April 18, 2014" "%nmhversion%"
.\"
.\" %nmhwarning%
-.\" $Id$
.\"
-.TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
inc \- incorporate new mail
.SH SYNOPSIS
.RB [ \-truncate " | " \-notruncate ]
.RB [ \-width
.IR columns ]
-%nmhbeginpop%
.RB [ \-host
.IR hostname ]
+.RB [ \-port
+.IR portname/number ]
.RB [ \-user
.IR username ]
.RB [ \-pack
.RB [ \-nopack ]
.RB [ \-proxy
.IR command ]
-.RB [ \-apop " | " \-noapop ]
-.RB [ \-kpop ]
-.RB [ \-sasl ]
+.RB [ \-sasl " | " \-nosasl ]
.RB [ \-saslmech
.IR mechanism ]
.RB [ \-snoop ]
-%nmhendpop%
.RB [ \-version ]
.RB [ \-help ]
.ad
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
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
-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
.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
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
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
.B inc
simply uses the POP to
.B packf
-the user's maildrop from the POP service host to the named file. This switch
-is provided for those users who prefer to use
-.B msh
-to read their maildrops.
+the user's maildrop from the POP service host to the named file.
.PP
For debugging purposes, you may give the switch
.BR \-snoop ,
.PP
If
.B nmh
-has been compiled with APOP support, the
-.B \-apop
-switch will cause
-.B inc
-to use APOP rather than standard POP3 authentication. Under APOP, a
-unique string (generally of the format
-.RI < pid . timestamp @ hostname >
-) is announced by the POP server.
-Rather than `USER
-.IR user ',
-`PASS
-.IR password ',
-.B inc
-sends `APOP
-.I user
-.IR digest ',
-where digest is the MD5 hash of the unique string followed by a
-`secret' shared by client and server, essentially equivalent to the user's
-password (though an APOP-enabled POP3 server could have separate APOP and plain
-POP3 passwords for a single user).
-.B \-noapop
-disables APOP in cases where it'd otherwise be used.
-.PP
-If
-.B nmh
-has been compiled with KPOP support, the
-.B \-kpop
-switch will allow
-.B inc
-to use Kerberized POP rather than standard POP3 on a given invocation.
-If POPSERVICE was also #defined to "kpop",
-.B inc
-will be hardwired to always use KPOP.
-.PP
-If
-.B nmh
has been compiled with SASL support, the
.B \-sasl
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
when viewing the POP transaction with the
.B \-snoop
switch.
-%nmhendpop%
-
.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
+%nmhetcdir%/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 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"
-%nmhbeginpop%
-.RB ` \-nopack '
-%nmhendpop%
-.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
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.
projects / nmh / blobdiff