Added filename completion to bash_completion_nmh.

[nmh] / man / inc.man

diff --git a/man/inc.man b/man/inc.man
index 46dda0e47be10ab2d7c3c3997bf4abac446407d3..d9ceaa400e6263d960424b6329bd824d765fb9c6 100644 (file)
--- a/man/inc.man
+++ b/man/inc.man
@@ -1,4 +1,4 @@
-.TH INC %manext1% "August 14, 2016" "%nmhversion%"
+.TH INC %manext1% "October 9, 2016" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"


@@ -8,6 +8,8 @@ inc \- incorporate new mail
 .HP 5
 .na
 .B inc
 .HP 5
 .na
 .B inc

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RB [ \-audit
 .IR audit\-file ]
 .RI [ +folder ]
 .RB [ \-audit
 .IR audit\-file ]


@@ -37,12 +39,15 @@ inc \- incorporate new mail
 .RB [ \-sasl " | " \-nosasl ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-sasl " | " \-nosasl ]
 .RB [ \-saslmech
 .IR mechanism ]

+.RB [ \-authservice
+.IR service ]
+.RB [ \-initialtls ]
+.RB [ \-notls ]
+.RB [ \-certverify " | " \-nocertverify ]

 .RB [ \-snoop ]
 .RB [ \-snoop ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.B Inc
+.B inc

 incorporates mail from the user's incoming mail drop into
 an
 .B nmh
 incorporates mail from the user's incoming mail drop into
 an
 .B nmh


@@ -114,7 +119,7 @@ history.
 .RI \*(lq Audit\-file \*(rq
 will be in the user's nmh directory unless a full path is specified.
 .PP
 .RI \*(lq Audit\-file \*(rq
 will be in the user's nmh directory unless a full path is specified.
 .PP

-.B Inc
+.B inc

 will incorporate even improperly formatted messages into the
 user's nmh folder, inserting a blank line prior to the offending component
 and printing a comment identifying the bad message.
 will incorporate even improperly formatted messages into the
 user's nmh folder, inserting a blank line prior to the offending component
 and printing a comment identifying the bad message.


@@ -129,7 +134,7 @@ is present and non\-empty, then
 .B inc
 will add each of the newly incorporated messages to
 each sequence named by the profile entry.
 .B inc
 will add each of the newly incorporated messages to
 each sequence named by the profile entry.

-.B Inc
+.B inc

 will not zero each sequence prior to adding messages.
 .PP
 The interpretation of the
 will not zero each sequence prior to adding messages.
 .PP
 The interpretation of the


@@ -206,7 +211,7 @@ will query this POP service host for mail to incorporate.  If
 .B $MAILHOST
 is set and
 .B \-host
 .B $MAILHOST
 is set and
 .B \-host

-is specified as well, the commandline switch will override
+is specified as well, the command-line switch will override

 the environment variable.  The
 .B \-port
 switch specifies the port name or number used to connect to the POP
 the environment variable.  The
 .B \-port
 switch specifies the port name or number used to connect to the POP


@@ -224,7 +229,7 @@ If passed the
 switch,
 .B inc
 will use the specified command to establish the connection to the POP
 switch,
 .B inc
 will use the specified command to establish the connection to the POP

-server. The string
+server.  The string

 .IR %h
 in the command will be substituted by the hostname to connect to.
 .PP
 .IR %h
 in the command will be substituted by the hostname to connect to.
 .PP


@@ -233,7 +238,7 @@ If
 uses POP, then the
 .B \-pack
 .I file
 uses POP, then the
 .B \-pack
 .I file

-switch is considered. If given, then
+switch is considered.  If given, then

 .B inc
 simply uses the POP to
 .B packf
 .B inc
 simply uses the POP to
 .B packf


@@ -242,7 +247,9 @@ the user's maildrop from the POP service host to the named file.
 For debugging purposes, you may give the switch
 .BR \-snoop ,
 which will allow you to watch the POP transaction take place
 For debugging purposes, you may give the switch
 .BR \-snoop ,
 which will allow you to watch the POP transaction take place

-between you and the POP server.
+between you and the POP server.  If
+.B \-sasl \-saslmech xoauth2
+is used, the HTTP transaction is also shown.

 .PP
 If
 .B nmh
 .PP
 If
 .B nmh


@@ -268,6 +275,51 @@ switch; see the
 man page description of
 .B \-snoop
 for its other features.
 man page description of
 .B \-snoop
 for its other features.

+.PP
+If
+.B nmh
+has been compiled with OAuth support, the
+.B \-sasl
+and
+.B \-saslmech xoauth2
+switches will enable OAuth authentication.  The
+.B \-user
+switch must be used, and the
+.I user-name
+must be an email address the user has for the service, which must
+be specified with the
+.B \-authservice
+.I service
+switch.  Before using this, the user must authorize nmh by running
+.B mhlogin
+and grant authorization to that account.  See the
+.B mhlogin
+man page for more details.
+.PP
+If
+.B nmh
+has been compiled with TLS support, the
+.B \-initialtls
+switch will require the negotiation of TLS when connecting
+to the remote POP server.  The
+.B \-initialtls
+switch will negotiate TLS immediately after the connection has taken place,
+before any POP commands are sent or received.  Data encrypted by TLS is
+labeled `(tls-encrypted)' and `(tls-decrypted)` with viewing the POP
+transaction with the
+.B \-snoop
+switch.  The
+.B \-notls
+switch will disable all attempts to negotiate TLS.
+.PP
+When using TLS the default is to verify the remote certificate and SubjectName
+against the local trusted certificate store.  This can be controlled by
+the
+.B \-certverify
+and
+.B \-nocertverify
+switches.  See your OpenSSL documentation for more information on certificate
+verification.

 .SH FILES
 .PD 0
 .TP 20
 .SH FILES
 .PD 0
 .TP 20


@@ -306,6 +358,7 @@ To name sequences denoting unseen messages.
 .IR scan (1),
 .IR mh\-mail (5),
 .IR mh\-profile (5),
 .IR scan (1),
 .IR mh\-mail (5),
 .IR mh\-profile (5),

+.IR mhlogin (1),

 .IR post (8),
 .IR rcvstore (1)
 .SH DEFAULTS
 .IR post (8),
 .IR rcvstore (1)
 .SH DEFAULTS