]> diplodocus.org Git - nmh/blobdiff - man/msgchk.man
Fix invalid pointer arithmetic.
[nmh] / man / msgchk.man
index 45ac8724eb5624f1702b4fc677c540470295ce94..84a40ca9ed1f8ce275afb714a81bfc7cf756022e 100644 (file)
@@ -1,13 +1,15 @@
-.TH MSGCHK %manext1% "March 23, 2016" "%nmhversion%"
-.\"
+.TH MSGCHK %manext1% 2016-11-02 "%nmhversion%"
+.
 .\" %nmhwarning%
 .\" %nmhwarning%
-.\"
+.
 .SH NAME
 .SH NAME
-msgchk \- check for messages
+msgchk \- nmh's check for incoming email
 .SH SYNOPSIS
 .HP 5
 .na
 .B msgchk
 .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,16 +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 [ \-authservice
 .IR service ]
 .RB [ \-snoop ]
 .RI [ users
 \&... ]
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
 The
 .ad
 .SH DESCRIPTION
 The
@@ -48,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
@@ -63,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
@@ -92,7 +95,8 @@ mail waiting.
 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
+.IR mh\-profile (5)
 describes the ways to supply a username and password.
 .PP
 For debugging purposes, there is also a switch
 describes the ways to supply a username and password.
 .PP
 For debugging purposes, there is also a switch
@@ -100,7 +104,7 @@ For debugging purposes, there is also a switch
 which will
 allow you to watch the POP transaction take place between you and the
 POP server.  If
 which will
 allow you to watch the POP transaction take place between you and the
 POP server.  If
-.B \-saslmech xoauth2
+.B \-sasl \-saslmech xoauth2
 is used, the HTTP transaction is also shown.
 .PP
 If
 is used, the HTTP transaction is also shown.
 .PP
 If
@@ -111,8 +115,9 @@ 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
 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
+file can be used to store this password, as described in
+.IR mh-profile (5).
+The
 .B \-saslmech
 switch can be used to select a particular SASL mechanism.
 .PP
 .B \-saslmech
 switch can be used to select a particular SASL mechanism.
 .PP
@@ -123,12 +128,16 @@ a security layer for session encryption.  Encrypted traffic is labelled
 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 with the
 .B \-snoop
 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 with the
 .B \-snoop
-switch.
+switch; see
+.IR post (8)'s
+description of
+.B \-snoop
+for its other features.
 .PP
 If
 .B nmh
 has been compiled with OAuth support, the
 .PP
 If
 .B nmh
 has been compiled with OAuth support, the
-.B \-saslmech xoauth2
+.B \-sasl \-saslmech xoauth2
 switch will enable OAuth authentication.  The
 .B \-user
 switch must be used, and the
 switch will enable OAuth authentication.  The
 .B \-user
 switch must be used, and the
@@ -139,19 +148,39 @@ be specified with the
 .I service
 switch.  Before using this, the user must authorize nmh by running
 .B mhlogin
 .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.
+and grant authorization to that account.  See
+.IR mhlogin (1)
+for more details.
 .PP
 .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'
+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
 .ta \w'%nmhetcdir%/ExtraBigFileName  'u
 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%nmhetcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+^$HOME/.mh_profile~^The user profile
 ^%nmhetcdir%/mts.conf~^nmh mts configuration file
 ^%mailspool%/$USER~^Location of mail drop
 .fi
 ^%nmhetcdir%/mts.conf~^nmh mts configuration file
 ^%mailspool%/$USER~^Location of mail drop
 .fi
@@ -164,7 +193,8 @@ None
 .fi
 .SH "SEE ALSO"
 .IR inc (1),
 .fi
 .SH "SEE ALSO"
 .IR inc (1),
-.IR mh\-mail (5)
+.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"