Fix spelling in C comments.

[nmh] / man / msgchk.man

diff --git a/man/msgchk.man b/man/msgchk.man
index 8ec21994fbede1bd55d4cc613178d7bb1dcd110a..f94f4d6601fa9caf6356dcec0cfc3a3566a3eae0 100644 (file)
--- a/man/msgchk.man
+++ b/man/msgchk.man
@@ -1,13 +1,15 @@
-.TH MSGCHK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
-.\"
+.TH MSGCHK %manext1% 2016-11-02 "%nmhversion%"
+.

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

-.\"
+.

 .SH NAME
 msgchk \- check for messages
 .SH SYNOPSIS
 .HP 5
 .na
 .B msgchk
 .SH NAME
 msgchk \- check for messages
 .SH SYNOPSIS
 .HP 5
 .na
 .B msgchk

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

 .RB [ \-date " | " \-nodate ]
 .RB [ \-notify
 all/mail/nomail ]
 .RB [ \-date " | " \-nodate ]
 .RB [ \-notify
 all/mail/nomail ]


@@ -17,14 +19,17 @@ all/mail/nomail ]
 .IR hostname ]
 .RB [ \-user
 .IR username ]
 .IR hostname ]
 .RB [ \-user
 .IR username ]

-.RB [ \-sasl ]
+.RB [ \-sasl " | " \-nosasl ]

 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-saslmech
 .IR mechanism ]

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

 .RB [ \-snoop ]
 .RI [ users
 \&... ]
 .RB [ \-snoop ]
 .RI [ users
 \&... ]

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

 .ad
 .SH DESCRIPTION
 The
 .ad
 .SH DESCRIPTION
 The


@@ -46,12 +51,12 @@ should produce a message.  The default is
 which says that
 .B msgchk
 should always report the status of the
 which says that
 .B msgchk
 should always report the status of the

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

 .B msgchk
 should report the status of waiting mail; and, `nomail'
 which says that
 .B msgchk
 .B msgchk
 should report the status of waiting mail; and, `nomail'
 which says that
 .B msgchk

-should report the status of empty maildrops.
+should report the status of empty mail drops.

 The
 .B \-nonotify
 .I type
 The
 .B \-nonotify
 .I type


@@ -61,10 +66,10 @@ switch has the inverted sense, so
 directs
 .B msgchk
 to never report the status of
 directs
 .B msgchk
 to never report the status of

-maildrops.  This is useful if the user wishes to check
+mail drops.  This is useful if the user wishes to check

 .BR msgchk 's
 .BR msgchk 's

-exit status.  A non\-zero exit status indicates that mail was
-.B not
+exit status.  A non-zero exit status indicates that mail was
+.I not

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


@@ -87,44 +92,19 @@ switch is given,
 will query this POP service host as to the status of
 mail waiting.
 .PP
 will query this POP service host as to the status of
 mail waiting.
 .PP

-The default is for
-.B msgchk
-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.
-.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
-machine
-.I mypopserver
-login
-.I mylogin
-password
-.I mypassword
-.RE
-.PP
-This
-.RI \*(lq \&.netrc \*(rq
-file should be owned and readable only by you.
+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
 .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

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

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


@@ -133,25 +113,73 @@ has been compiled with SASL support, the
 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
 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
 If SASL authentication is successful,
 .B \-saslmech
 switch can be used to select a particular SASL mechanism.
 .PP
 If SASL authentication is successful,

-.B inc
+.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
 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.
+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 \-saslmech xoauth2
+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 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
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
-^%etcdir%/mts.conf~^nmh mts configuration file
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile
+^%nmhetcdir%/mts.conf~^nmh mts configuration file

 ^%mailspool%/$USER~^Location of mail drop
 .fi
 .SH "PROFILE COMPONENTS"
 ^%mailspool%/$USER~^Location of mail drop
 .fi
 .SH "PROFILE COMPONENTS"


@@ -162,7 +190,9 @@ switch.
 None
 .fi
 .SH "SEE ALSO"
 None
 .fi
 .SH "SEE ALSO"

-inc(1)
+.IR inc (1),
+.IR mh\-mail (5)
+.IR post (8)

 .SH DEFAULTS
 .nf
 .RB ` user "' defaults to the current user"
 .SH DEFAULTS
 .nf
 .RB ` user "' defaults to the current user"