]> diplodocus.org Git - nmh/blobdiff - man/inc.man
Don't `else' after goto. Simplify control flow.
[nmh] / man / inc.man
index 8d0a46269c45ff1d1ebb2323bac41df894603efd..0d680ea833acb114ea45b152289bd60cc95b39f9 100644 (file)
@@ -1,4 +1,4 @@
-.TH INC %manext1% "April 14, 2013" "%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,9 +39,11 @@ 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 [ \-snoop ]
 .RB [ \-snoop ]
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
 .B Inc
 .ad
 .SH DESCRIPTION
 .B Inc
@@ -215,7 +219,7 @@ server.  If unspecified the default is \*(lqpop3\*(rq.
 To specify a username for authentication with the POP server, use the
 .B \-user
 .I username
 To specify a username for authentication with the POP server, use the
 .B \-user
 .I username
-switch.  The credentials profile entry in the mh_profile(5) man page
+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
 describes the ways to supply a username and password.
 .PP
 If passed the
@@ -224,7 +228,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,19 +237,18 @@ 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
-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 ,
 which will allow you to watch the POP transaction take place
 .PP
 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
@@ -266,14 +269,54 @@ will attempt to negotiate a security layer for session encryption.
 Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
 when viewing the POP transaction with the
 .B \-snoop
 Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
 when viewing the POP transaction with the
 .B \-snoop
-switch.
+switch; see the
+.B post
+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.
 .SH FILES
 .PD 0
 .TP 20
 .SH FILES
 .PD 0
 .TP 20
-$HOME/.mh\-profile
+$HOME/.mh_profile
 The user's profile.
 .TP
 The user's profile.
 .TP
-%etcdir%/mts.conf
+%nmhetcdir%/mts.conf
 mts configuration file.
 .TP
 %mailspool%/$USER
 mts configuration file.
 .TP
 %mailspool%/$USER
@@ -305,6 +348,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