uip/dp.c: Increase coverage to 100%.

[nmh] / man / post.man

diff --git a/man/post.man b/man/post.man
index 24465fc664a99fdda5fefd4814ad0a7d58b711c2..fa5a44a49b76d70cc2e422d4b96bc028017748a5 100644 (file)
--- a/man/post.man
+++ b/man/post.man
@@ -1,13 +1,15 @@
+.TH POST %manext8% "October 17, 2016" "%nmhversion%"

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

-.TH POST %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 post \- deliver a message
 .SH SYNOPSIS
 .HP 5
 .na
 .SH NAME
 post \- deliver a message
 .SH SYNOPSIS
 .HP 5
 .na

-.B %libdir%/post 
+.B %nmhlibexecdir%/post 
+.RB [ \-help ]
+.RB [ \-version ]

 .RB [ \-alias
 .IR aliasfile ]
 .RB [ \-filter
 .RB [ \-alias
 .IR aliasfile ]
 .RB [ \-filter


@@ -16,32 +18,33 @@ post \- deliver a message
 .RB [ \-format " | " \-noformat ]
 .RB [ \-mime " | " \-nomime ]
 .RB [ \-msgid " | " \-nomsgid ]
 .RB [ \-format " | " \-noformat ]
 .RB [ \-mime " | " \-nomime ]
 .RB [ \-msgid " | " \-nomsgid ]

+.RB [ \-messageid
+.IR localname " | " random ]

 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-watch " | " \-nowatch ]
 .RB [ \-width
 .IR columns ]
 .RB [ \-mts
 .IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-watch " | " \-nowatch ]
 .RB [ \-width
 .IR columns ]
 .RB [ \-mts
 .IR smtp " | " sendmail/smtp " | " sendmail/pipe ]

+.RB [ \-sendmail
+.IR program ]

 .RB [ \-server
 .IR servername ]
 .RB [ \-port
 .IR portname/number ]
 .RB [ \-sasl ]
 .RB [ \-nosasl ]
 .RB [ \-server
 .IR servername ]
 .RB [ \-port
 .IR portname/number ]
 .RB [ \-sasl ]
 .RB [ \-nosasl ]

-.RB [ \-saslmaxssf
-.IR ssf ]

 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-user
 .IR username ]
 .RB [ \-tls ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-user
 .IR username ]
 .RB [ \-tls ]

+.RB [ \-initialtls ]

 .RB [ \-notls ]
 .I file
 .RB [ \-notls ]
 .I file

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

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.B Post
+.B post

 is the default program called by
 .B send
 to deliver
 is the default program called by
 .B send
 to deliver


@@ -59,10 +62,16 @@ Thus, it is
 .B post
 which parses the various header fields, appends a
 \*(lqDate:\*(rq line, and interacts with the mail transport system.
 .B post
 which parses the various header fields, appends a
 \*(lqDate:\*(rq line, and interacts with the mail transport system.

-.B Post
-will not normally be called directly by the user.
+.B post
+will not normally be called directly by the user,
+but can be replaced by the user with a
+.I postproc
+profile component that will have
+.I file
+as its final argument.
+See the mh-profile(5) man page for more information on postproc.

 .PP
 .PP

-.B Post
+.B post

 searches the \*(lqTo:\*(rq, \*(lqcc:\*(rq, \*(lqBcc:\*(rq,
 \*(lqFcc:\*(rq, and \*(lqResent\-xxx:\*(rq header lines of the specified
 message for destination addresses, checks these addresses for validity,
 searches the \*(lqTo:\*(rq, \*(lqcc:\*(rq, \*(lqBcc:\*(rq,
 \*(lqFcc:\*(rq, and \*(lqResent\-xxx:\*(rq header lines of the specified
 message for destination addresses, checks these addresses for validity,


@@ -112,6 +121,23 @@ switch indicates that a \*(lqMessage\-ID:\*(rq or
 \*(lqResent\-Message\-ID:\*(rq field should be added to the header.
 .PP
 The
 \*(lqResent\-Message\-ID:\*(rq field should be added to the header.
 .PP
 The

+.B \-messageid
+switch selects the style used for the part appearing after the @
+in \*(lqMessage\-ID:\*(rq, \*(lqResent\-Message\-ID:\*(rq, and
+\*(lqContent\-ID:\*(rq header fields.  The two acceptable options are
+.B localname
+(which is the default),
+and
+.BR random .
+With
+.BR localname ,
+the local hostname is used.  With
+.BR random ,
+a random sequence of characters is used instead.  Note that the
+.B \-msgid
+switch must be enabled for this switch to have any effect.
+.PP
+The

 .B \-verbose
 switch indicates that the user should be informed of
 each step of the posting/filing process.
 .B \-verbose
 switch indicates that the user should be informed of
 each step of the posting/filing process.


@@ -125,7 +151,7 @@ delivery).
 Under normal circumstances,
 .B post
 uses the \*(lqFrom:\*(rq line in the message draft as the identity of
 Under normal circumstances,
 .B post
 uses the \*(lqFrom:\*(rq line in the message draft as the identity of

-the the originating mailbox.  A \*(lqFrom:\*(rq line is required in
+the originating mailbox.  A \*(lqFrom:\*(rq line is required in

 all message draft.  By default the message composition utilities such
 as
 .BR comp ,
 all message draft.  By default the message composition utilities such
 as
 .BR comp ,


@@ -159,11 +185,19 @@ will be instructed to not send any bounces in response to the message.
 Not all mail transport systems support this feature.
 .PP
 The mail transport system default is provided in
 Not all mail transport systems support this feature.
 .PP
 The mail transport system default is provided in

-.I %etcdir%/mts.conf
-but can be overriiden here with the
+.I %nmhetcdir%/mts.conf
+but can be overridden here with the

 .B \-mts
 switch.
 .PP
 .B \-mts
 switch.
 .PP

+If nmh is using as its mail transport system
+.BR sendmail/pipe ,
+the
+.B \-sendmail
+switch can be used to override the default
+.B sendmail
+program.
+.PP

 If nmh is using the SMTP MTA, the
 .B \-server
 and the
 If nmh is using the SMTP MTA, the
 .B \-server
 and the


@@ -171,7 +205,7 @@ and the
 switches can be used to override the default mail server (defined by the
 .RI servers
 entry in
 switches can be used to override the default mail server (defined by the
 .RI servers
 entry in

-.I %etcdir%/mts.conf
+.I %nmhetcdir%/mts.conf

 ).
 .PP
 If
 ).
 .PP
 If


@@ -184,14 +218,17 @@ switches will enable and disable
 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
 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).
+.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,
 .B \-saslmech
 switch can be used to select a particular SASL mechanism,

-and the the
+and the

 .B \-user
 .B \-user

-switch can be used to select a authorization userid
-to provide to SASL other than the default.
+switch can be used to select a authorization userid to provide to SASL
+other than the default.  The credentials profile entry in the
+mh\-profile(5) man page describes the ways to supply a username and
+password.

 .PP
 If SASL authentication is successful, 
 .BR nmh
 .PP
 If SASL authentication is successful, 
 .BR nmh


@@ -199,64 +236,89 @@ will attempt to negotiate a security layer for session encryption.
 Encrypted data is labelled with `(sasl-encrypted)' and `(sasl-decrypted)' when
 viewing the SMTP transaction with the
 .B \-snoop
 Encrypted data is labelled with `(sasl-encrypted)' and `(sasl-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.
+switch.
+Base64-encoded data is wrapped with `b64<>'.
+(Beware that the SMTP transaction may contain authentication information either
+in plaintext or easily decoded base64.)

 .PP
 If
 .B nmh
 has been compiled with TLS support, the
 .B \-tls
 and
 .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 \-initialtls
+switches will require the negotiation of TLS when
+connecting to the SMTP MTA.  The
+.B \-tls
+switch will negotiate TLS as part of the normal SMTP protocol
+using the STARTTLS command.  The
+.B \-initialtls
+will negotiate TLS immediately after the connection has
+taken place, before any SMTP commands are sent or received.  Encrypted data
+is labelled with `(tls-encrypted)' and
+`(tls-decrypted)' when viewing the SMTP transaction with the

 .B \-snoop
 switch.
 .B \-snoop
 switch.

-
+Base64-encoded data is wrapped with `b64<>'.
+(Beware that the SMTP transaction may contain authentication information either
+in plaintext or easily decoded base64.)
+The
+.B \-notls
+switch will disable all attempts to negotiate TLS.
+.PP
+If port 465 is specified and none of the TLS switches were enabled,
+.B \-initialtls
+will be implied if TLS support was compiled in.  Though port 465 for
+SMTPS (SMTP over SSL) was deregistered by IANA in 1998, it is still
+used for that service.
+.PP
+.B post
+filters out header lines with names beginning with \*(lqNmh-\*(rq
+(case insensitive) from the message draft.
+Those lines are reserved for internal
+.B nmh
+use.

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

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^%etcdir%/mts.conf~^nmh mts configuration file
-^%etcdir%/MailAliases~^global nmh alias file
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^%nmhetcdir%/mts.conf~^nmh mts configuration file
+^%nmhetcdir%/MailAliases~^global nmh alias file

 ^%bindir%/refile~^Program to process Fcc:s
 ^%bindir%/refile~^Program to process Fcc:s

-^%libdir%/mhl~^Program to process Bcc:s
+^%nmhlibexecdir%/mhl~^Program to process Bcc:s

 .fi
 .fi

-

 .SH "PROFILE COMPONENTS"
 .B post
 does
 .B NOT
 consult the user's
 .I \&.mh\(ruprofile
 .SH "PROFILE COMPONENTS"
 .B post
 does
 .B NOT
 consult the user's
 .I \&.mh\(ruprofile

-

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

-mhmail(1), send(1), mh\-mail(5), mh\-alias(5), mh\-tailor(5),
+.IR mhmail (1),
+.IR send (1),
+.IR mh\-mail (5),
+.IR mh\-alias (5),
+.IR mh\-profile (5),
+.IR mh\-tailor (5)
+.PP

 .I "Standard for the Format of ARPA Internet Text Messages"
 .I "Standard for the Format of ARPA Internet Text Messages"

-(RFC\-822)
-
+(RFC 822)

 .SH DEFAULTS
 .nf
 .SH DEFAULTS
 .nf

-.RB ` \-alias "' defaults to %etcdir%/MailAliases"
+.RB ` \-alias "' defaults to %nmhetcdir%/MailAliases"

 .RB ` \-format '
 .RB ` \-nomime '
 .RB ` \-nomsgid '
 .RB ` \-format '
 .RB ` \-nomime '
 .RB ` \-nomsgid '

+.RB ` "\-messageid\ localname" '

 .RB ` \-noverbose '
 .RB ` \-nowatch '
 .RB ` "\-width\ 72" '
 .RB ` \-nofilter '
 .fi
 .RB ` \-noverbose '
 .RB ` \-nowatch '
 .RB ` "\-width\ 72" '
 .RB ` \-nofilter '
 .fi

-

 .SH CONTEXT
 None
 .SH CONTEXT
 None

-

 .SH BUGS
 \*(lqReply\-To:\*(rq fields are allowed to have groups in them according
 .SH BUGS
 \*(lqReply\-To:\*(rq fields are allowed to have groups in them according

-to the 822 specification, but
+to the RFC 822 specification, but

 .B post
 won't let you use them.
 .B post
 won't let you use them.