From: David Levine <levinedl@acm.org>
Date: Sun, 18 Mar 2012 14:17:56 +0000 (-0500)
Subject: Added documentation of -sever, -port, -sasl, -saslmech, -snoop, -user,
X-Git-Url: http://git.marmaro.de/?a=commitdiff_plain;h=307383ed8da4c05a4e5cb98bab9bf6161dd51bf3;p=mmh

Added documentation of -sever, -port, -sasl, -saslmech, -snoop, -user,
-tls, and -notls to whom man page.
---

diff --git a/man/whom.man b/man/whom.man
index fc386bb..d319e72 100644
--- a/man/whom.man
+++ b/man/whom.man
@@ -11,14 +11,25 @@ whom \- report to whom a message would go
 .RB [ \-alias
 .IR aliasfile ]
 .RB [ \-check " | " \-nocheck ]
-.RB [ \-draft ]
 .RB [ \-draftfolder
 .IR +folder ]
 .RB [ \-draftmessage
 .IR msg ]
 .RB [ \-nodraftfolder ]
+.RB [ \-server
+.IR servername ]
+.RB [ \-port
+.IR port-name/number ]
+.RB [ \-sasl ]
+.RB [ \-saslmech
+.IR mechanism ]
 .RB [ \-snoop ]
+.RB [ \-user
+.IR username ]
+.RB [ \-tls ]
+.RB [ \-notls ]
 .RI [ file ]
+.RB [ \-draft ]
 .RB [ \-version ]
 .RB [ \-help ]
 .ad
@@ -44,12 +55,60 @@ useful) feature.  Consult the
 .BR mh-draft (5)
 man page for more information.
 .PP
-The
+If nmh is using the SMTP MTA, the
+.B \-server
+and the
+.B \-port
+switches can be used to override the default mail server (defined by the
+.I %etcdir%/mts.conf
+.RI servers
+entry).  The
 .B \-snoop
 switch can be used to view the SMTP transaction.  (Beware that the
 SMTP transaction may contain authentication information either in
 plaintext or easily decoded base64.)
 .PP
+If
+.B nmh
+has been compiled with SASL support, the
+.B \-sasl
+switch will enable
+the use of SASL authentication with the SMTP MTA.  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).
+.B \-saslmech
+switch can be used to select a particular SASL mechanism,
+and the the
+.B \-user
+switch can be used to select a authorization userid
+to provide to SASL other than the default.
+.PP
+If SASL authentication is successful, 
+.BR nmh
+will attempt to negotiate a security layer for session encryption.
+Encrypted data is labelled with `(encrypted)' and `(decrypted)' when
+viewing the SMTP transaction with the
+.B \-snoop
+switch.  The
+.B \-saslmaxssf
+switch can be used to select the maximum value of the Security Strength Factor.
+This is an integer value and the exact meaning of this value depends on the
+underlying SASL mechanism.  A value of 0 disables encryption.
+.PP
+If
+.B nmh
+has been compiled with TLS support, the
+.B \-tls
+and
+.B \-notls
+switches will require and disable the negotiation of TLS support when connecting to the
+SMTP MTA.  Encrypted data is labelled with `(tls-encrypted)' and
+`(tls-decrypted)' when viewing the SMTP transction with the
+.B \-snoop
+switch.
+.PP
 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
 additional alias files given by the
 .B \-alias