Sort JSON output from oauth tests so that comparisons don't

[nmh] / man / msgchk.man

diff --git a/man/msgchk.man b/man/msgchk.man
index 973fb4ba9e830df77227278477ff4c13a000c0d3..5b02c52ce1e510172429913cf670265c41c1323a 100644 (file)
--- a/man/msgchk.man
+++ b/man/msgchk.man
@@ -1,100 +1,175 @@
+.TH MSGCHK %manext1% "November 25, 2014" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH MSGCHK %manext1% MH.6.8 [%nmhversion%]

 .SH NAME
 msgchk \- check for messages
 .SH SYNOPSIS
 .SH NAME
 msgchk \- check for messages
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-msgchk
-\%[\-date] \%[\-nodate]
-\%[\-notify\ all/mail/nomail]
-.br
-\%[\-nonotify\ all/mail/nomail]
-.br
-%nmhbeginpop%
-\%[\-host\ hostname]
-\%[\-user\ username]
-\%[\-kpop]
-.br
-%nmhendpop%
-\%[users\ ...]
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B msgchk
+.RB [ \-date " | " \-nodate ]
+.RB [ \-notify
+all/mail/nomail ]
+.RB [ \-nonotify
+all/mail/nomail ]
+.RB [ \-host
+.IR hostname ]
+.RB [ \-user
+.IR username ]
+.RB [ \-sasl ]
+.RB [ \-saslmech
+.IR mechanism ]
+.RB [ \-oauth
+.IR service ]
+.RB [ \-snoop ]
+.RI [ users
+\&... ]
+.RB [ \-version ]
+.RB [ \-help ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-The \fImsgchk\fR program checks all known mail drops for mail waiting
-for you.  For those drops which have mail for you, \fImsgchk\fR will
+The
+.B msgchk
+program checks all known mail drops for mail waiting
+for you.  For those drops which have mail for you,
+.B msgchk
+will

 indicate if it believes that you have seen the mail in question before.
 indicate if it believes that you have seen the mail in question before.

-
-The `\-notify\ type' switch indicates under what circumstances
-\fImsgchk\fR should produce a message.  The default is `\-notify\ all'
-which says that \fImsgchk\fR should always report the status of the
+.PP
+The
+.B \-notify
+.I type
+switch indicates under what circumstances
+.B msgchk
+should produce a message.  The default is
+.B \-notify
+.I all
+which says that
+.B msgchk
+should always report the status of the

 users maildrop.  Other values for `type' include `mail' which says that
 users maildrop.  Other values for `type' include `mail' which says that

-\fImsgchk\fR should report the status of waiting mail; and, `nomail'
-which says that \fImsgchk\fR should report the status of empty maildrops.
-The `\-nonotify\ type' switch has the inverted sense, so
-`\-nonotify\ all' directs \fImsgchk\fR to never report the status of
-maildrops.  This is useful if the user wishes to check \fImsgchk\fR's
-exit status.  A non\-zero exit status indicates that mail was \fBnot\fR
+.B msgchk
+should report the status of waiting mail; and, `nomail'
+which says that
+.B msgchk
+should report the status of empty maildrops.
+The
+.B \-nonotify
+.I type
+switch has the inverted sense, so
+.B \-nonotify
+.I all
+directs
+.B msgchk
+to never report the status of
+maildrops.  This is useful if the user wishes to check
+.BR msgchk 's
+exit status.  A non\-zero exit status indicates that mail was
+.B not

 waiting for at least one of the indicated users.
 waiting for at least one of the indicated users.

-
-If \fImsgchk\fR produces output, then the `\-date' switch directs
-\fImsgchk\fR to print out the last date mail was read, if this can
+.PP
+If
+.B msgchk
+produces output, then the
+.B \-date
+switch directs
+.B msgchk
+to print out the last date mail was read, if this can

 be determined.
 be determined.

-%nmhbeginpop%
- 
-.Uh "Using POP"
-\fImsgchk\fR will normally check all the local mail drops, but if
+.SS "Using POP"
+.B msgchk
+will normally check all the local mail drops, but if

 the option \*(lqpophost:\*(rq is set in the mts configuration file
 the option \*(lqpophost:\*(rq is set in the mts configuration file

-\*(lqmts.conf\*(rq, or if the `\-host\ hostname' switch is given,
-\fImsgchk\fR will query this POP service host as to the status of
+\*(lqmts.conf\*(rq, or if the
+.B \-host
+.I hostname
+switch is given,
+.B msgchk
+will query this POP service host as to the status of

 mail waiting.
 mail waiting.

-
-The default is for \fImsgchk\fR to assume that your account name
-on the POP server is the same as your current username.  To specify
-a different username, use the `\-user\ username' switch.
-
-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 \*(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 mypopserver, mylogin, and mypassword with
-your own account information.
-
-machine mypopserver login mylogin password mypassword
-
-This \*(lq.netrc\*(rq file should be owned and readable only by
-you.
-
-For debugging purposes, there is also a switch `\-snoop', which will
+.PP
+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
+describes the ways to supply a username and password.
+.PP
+For debugging purposes, there is also a switch
+.BR \-snoop ,
+which will

 allow you to watch the POP transaction take place between you and the
 allow you to watch the POP transaction take place between you and the

-POP server.
-
-If nmh has been compiled with KPOP #defined, but without POPSERVICE being set to
-"kpop", the -kpop switch may be specified to cause the use of Kerberized POP
-rather than standard POP3 during a given invocation of \fImsgchk\fR.
-%nmhendpop%
-.Fi
+POP server.  If
+.B \-oauth
+is used, the HTTP transaction is also shown.
+.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
+.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
+If SASL authentication is successful,
+.B msgchk
+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
+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 msgchk
+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
+.fc ^ ~
+.nf
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u

 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^$HOME/\&.mh\(ruprofile~^The user profile

-^%etcdir%/mts.conf~^nmh mts configuration file
+^%nmhetcdir%/mts.conf~^nmh mts configuration file

 ^%mailspool%/$USER~^Location of mail drop
 ^%mailspool%/$USER~^Location of mail drop

-.Pr
+.fi
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u

 None
 None

-.Sa
-inc(1)
-.De
-`user' defaults to the current user
-.Ds
-`\-date'
-.Ds
-`\-notify\ all'
-.Co
+.fi
+.SH "SEE ALSO"
+.IR inc (1),
+.IR mh\-mail (5)
+.SH DEFAULTS
+.nf
+.RB ` user "' defaults to the current user"
+.RB ` \-date '
+.RB ` "\-notify\ all" '
+.fi
+.SH CONTEXT

 None
 None

-.En