Fix to 25581a94c5113eb78b2baf7110408df96efc4418: always set $editalt,

[mmh] / man / whom.man

diff --git a/man/whom.man b/man/whom.man
index 8895a64..4994270 100644 (file)
--- a/man/whom.man
+++ b/man/whom.man
@@ -1,8 +1,7 @@
+.TH WHOM %manext1% "July 11, 2012" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.TH WHOM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 whom \- report to whom a message would go
 .SH SYNOPSIS
 .SH NAME
 whom \- report to whom a message would go
 .SH SYNOPSIS

@@ -12,13 +11,27 @@ whom \- report to whom a message would go
 .RB [ \-alias
 .IR aliasfile ]
 .RB [ \-check " | " \-nocheck ]
 .RB [ \-alias
 .IR aliasfile ]
 .RB [ \-check " | " \-nocheck ]

-.RB [ \-draft ]

 .RB [ \-draftfolder
 .IR +folder ]
 .RB [ \-draftmessage
 .IR msg ]
 .RB [ \-nodraftfolder ]
 .RB [ \-draftfolder
 .IR +folder ]
 .RB [ \-draftmessage
 .IR msg ]
 .RB [ \-nodraftfolder ]

+.RB [ \-mts
+.IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
+.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 ]
 .RI [ file ]

+.RB [ \-draft ]

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

@@ -41,9 +54,69 @@ the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult the

-.BR mh-draft (5)
+.IR mh-draft (5)

 man page for more information.
 .PP
 man page for more information.
 .PP

+The mail transport system default is provided in
+.I %etcdir%/mts.conf
+but can be overriiden here with the
+.B \-mts
+switch.
+.PP
+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
 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
 additional alias files given by the
 .B \-alias

@@ -52,16 +125,14 @@ switch will be
 read (more than one file, each preceded by
 .BR \-alias ,
 can be named). See
 read (more than one file, each preceded by
 .BR \-alias ,
 can be named). See

-.BR mh\-alias (5)
+.IR mh\-alias (5)

 for more information.
 for more information.

-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%etcdir%/ExtraBigFileName  'u

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

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf

@@ -72,20 +143,17 @@ for more information.
 ^Aliasfile:~^For a default alias file
 ^postproc:~^Program to post the message
 .fi
 ^Aliasfile:~^For a default alias file
 ^postproc:~^Program to post the message
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-mh\-alias(5), post(8)
-
+.IR mh\-alias (5),
+.IR post (8)

 .SH DEFAULTS
 .nf
 .RB ` file "' defaults to <mh\-dir>/draft"
 .RB ` \-nocheck '
 .RB ` \-alias "' defaults to  %etcdir%/MailAliases"
 .fi
 .SH DEFAULTS
 .nf
 .RB ` file "' defaults to <mh\-dir>/draft"
 .RB ` \-nocheck '
 .RB ` \-alias "' defaults to  %etcdir%/MailAliases"
 .fi

-

 .SH CONTEXT
 None
 .SH CONTEXT
 None

-

 .SH BUGS
 With the
 .B \-check
 .SH BUGS
 With the
 .B \-check