Teach mhparam about oauth support.

[nmh] / man / inc.man

diff --git a/man/inc.man b/man/inc.man
index 61f6f8442ae4baa1d075c992f68975bf5e8079e1..f72b1f21a999d06586966924332f360bb9c4c418 100644 (file)
--- a/man/inc.man
+++ b/man/inc.man
@@ -1,4 +1,4 @@
-.TH INC %manext1% "April 18, 2014" "%nmhversion%"
+.TH INC %manext1% "November 25, 2014" "%nmhversion%"

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


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

+.RB [ \-oauth
+.IR service ]

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


@@ -242,7 +244,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 \-oauth
+is used, the HTTP transaction is also shown.

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


@@ -264,6 +268,29 @@ Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
 when viewing the POP transaction with the
 .B \-snoop
 switch.
 when viewing the POP transaction with the
 .B \-snoop
 switch.

+.PP
+If
+.B nmh
+has been compiled with OAuth support, the
+.B \-oauth
+switch 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 that service.  Before using this,
+the user must authorize nmh by running
+.B mhlogin
+and grant authorization to that account.  Only
+.B -oauth
+.I gmail
+is supported.  See the
+.B mhlogin
+man page for more details.
+.PP
+Gmail only supports POP3 over TLS, but
+.B inc
+has no TLS support.  To work around this, use something like
+.B -proxy 'openssl s_client -connect %h:995 -CAfile /etc/ssl/certs/ca-certificates.crt -quiet'

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


@@ -302,6 +329,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