]> diplodocus.org Git - nmh/blobdiff - man/post.man
Allow advertise() to assume strerror(3) won't fail.
[nmh] / man / post.man
index 8b2c943522b69bec5adbc83ce8693fe266360157..22d86e7a117f77d90d31998535d9968e5444d2e9 100644 (file)
@@ -1,13 +1,15 @@
-.TH POST %manext8% "April 9, 2013" "%nmhversion%"
-.\"
+.TH POST %manext8% 2016-10-17 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\"
+.
 .SH NAME
-post \- deliver a message
+post \- deliver an nmh message
 .SH SYNOPSIS
 .HP 5
 .na
-.B %libdir%/post 
+.B %nmhlibexecdir%/post
+.RB [ \-help ]
+.RB [ \-version ]
 .RB [ \-alias
 .IR aliasfile ]
 .RB [ \-filter
@@ -24,14 +26,14 @@ post \- deliver a message
 .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 [ \-saslmaxssf
-.IR ssf ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-user
@@ -40,18 +42,15 @@ post \- deliver a message
 .RB [ \-initialtls ]
 .RB [ \-notls ]
 .I file
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
-.B Post
+.B post
 is the default program called by
 .B send
-to deliver
-the message in
+to deliver the message in
 .I file
-to local and remote users.  In fact, most of
-the features attributed to
+to local and remote users.
+In fact, most of the features attributed to
 .B send
 in its manual page are performed by
 .BR post ,
@@ -62,10 +61,18 @@ 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
-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
+.IR mh-profile (5)
+for more information on postproc.
 .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,
@@ -88,26 +95,22 @@ message will be a copy of the message sent to the sighted recipients.
 If
 .B \-filter
 .I filterfile
-is specified, then this copy is filtered
-(re\-formatted) by
+is specified, then this copy is filtered (re-formatted) by
 .B mhl
 prior to being sent to the blind recipients.
 Alternately, if the
 .B \-mime
 switch is given, then
 .B post
-will use
-the MIME rules for encapsulation.
+will use the MIME rules for encapsulation.
 .PP
 The
 .B \-alias
 .I aliasfile
-switch can be used to specify a file that post
-should take aliases from.  More than one file can be specified, each
-being preceded with
+switch can be used to specify a file that post should read aliases from.
+More than one file can be specified, with each being preceded by
 .BR \-alias .
-In any event, the primary alias file is
-read first.
+In any event, the primary alias file is read first.
 .PP
 The
 .B \-msgid
@@ -146,7 +149,7 @@ Under normal circumstances,
 .B post
 uses the \*(lqFrom:\*(rq line in the message draft as the identity of
 the originating mailbox.  A \*(lqFrom:\*(rq line is required in
-all message draft.  By default the message composition utilities such
+all message drafts.  By default the message composition utilities such
 as
 .BR comp ,
 .B repl
@@ -178,12 +181,20 @@ have a blank value; if the value is blank, then the mail transport system
 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
-.I %etcdir%/mts.conf
-but can be overriiden here with the
+The mail transport system default is defined in
+.I %nmhetcdir%/mts.conf
+but can be overridden here with the
 .B \-mts
 switch.
 .PP
+If nmh is using
+.BR sendmail/pipe ,
+as its mail transport system, 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
@@ -191,7 +202,7 @@ and the
 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
@@ -204,26 +215,29 @@ 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
-.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
+.IR mh-profile (5).
+The
 .B \-saslmech
 switch can be used to select a particular SASL mechanism,
 and the
 .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 an authorization userid to provide to SASL,
+other than the default.  The credentials profile entry in
+.IR mh-profile (5)
+describes the ways to supply a username and password.
 .PP
-If SASL authentication is successful, 
+If SASL authentication is successful,
 .BR nmh
 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
-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
@@ -231,8 +245,8 @@ has been compiled with TLS support, the
 .B \-tls
 and
 .B \-initialtls
-switches will require the negotiation of TLS when
-connecting to the SMTP MTA.  The
+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
@@ -240,39 +254,56 @@ using the STARTTLS command.  The
 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 transction with the
+`(tls-decrypted)' when viewing the SMTP transaction with the
 .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
-.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
-^%libdir%/mhl~^Program to process Bcc:s
+^%nmhlibexecdir%/mhl~^Program to process Bcc:s
 .fi
 .SH "PROFILE COMPONENTS"
 .B post
 does
 .B NOT
 consult the user's
-.I \&.mh\(ruprofile
+.I \&.mh_profile
 .SH "SEE ALSO"
 .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"
-(RFC\-822)
+(RFC 822)
 .SH DEFAULTS
 .nf
-.RB ` \-alias "' defaults to %etcdir%/MailAliases"
+.RB ` \-alias "' defaults to %nmhetcdir%/MailAliases"
 .RB ` \-format '
 .RB ` \-nomime '
 .RB ` \-nomsgid '
@@ -286,6 +317,6 @@ consult the user's
 None
 .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.