Migrated man page post(8) to spost(8).
authormarkus schnalke <meillo@marmaro.de>
Thu, 29 Mar 2012 15:12:37 +0000 (17:12 +0200)
committermarkus schnalke <meillo@marmaro.de>
Thu, 29 Mar 2012 15:12:37 +0000 (17:12 +0200)
It would be nice to have it improved a bit more.
Spost is located in section 8 (maintenance commands) of the manual,
but it is located in the bindir, rather than the sbindir. This is
on purpose. The sections of the manual are mostly informational (today),
whereas directories are either in $PATH or not, and thus cause a
functional difference. Hence, I don't blindly link sbindir to section 8.

man/Makefile.in
man/post.man8 [deleted file]
man/spost.man8 [new file with mode: 0644]

index 08a2bc1..4703ebd 100644 (file)
@@ -60,7 +60,7 @@ MAN5SRC = mh-alias. mh-format. mh-mail. mh-profile. mh-tailor.
 
 MAN7SRC = mmh-intro. mh-chart. mh-draft. mh-sequence. 
 
-MAN8SRC = ap. dp. fmtdump. post.
+MAN8SRC = spost. ap. dp. fmtdump.
 
 MAN1 = $(MAN1SRC:.=.$(manext1))
 MAN5 = $(MAN5SRC:.=.$(manext5))
diff --git a/man/post.man8 b/man/post.man8
deleted file mode 100644 (file)
index 5bac6f7..0000000
+++ /dev/null
@@ -1,224 +0,0 @@
-.\"
-.\" %nmhwarning%
-.\"
-.TH POST %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
-.SH NAME
-post \- deliver a message
-.SH SYNOPSIS
-.HP 5
-.na
-.B post
-.RB [ \-alias
-.IR aliasfile ]
-.RB [ \-filter
-.IR filterfile ]
-.RB [ \-nofilter ]
-.RB [ \-format " | " \-noformat ]
-.RB [ \-mime " | " \-nomime ]
-.RB [ \-msgid " | " \-nomsgid ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-watch " | " \-nowatch ]
-.RB [ \-width
-.IR columns ]
-.I file
-.RB [ \-version ]
-.RB [ \-help ]
-.ad
-.SH DESCRIPTION
-.B Post
-is the default program called by
-.B send
-to deliver
-the message in
-.I file
-to local and remote users.  In fact, most of
-the features attributed to
-.B send
-in its manual page are performed by
-.BR post ,
-with
-.B send
-acting as a relatively simple preprocessor.
-Thus, it is
-.B post
-which parses the various header fields, appends
-\*(lqFrom:\*(rq and \*(lqDate:\*(rq lines, and interacts with the mail transport system.
-.B Post
-will not normally be called directly by the user.
-.PP
-.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,
-and formats them so as to conform to ARPAnet Internet Message Format
-protocol, unless the
-.B \-noformat
-flag is set.  This will normally cause
-\*(lq@\fIlocal\-site\fR\*(rq to be appended to each local destination
-address, as well as any local return addresses.  The
-.B \-width
-.I columns
-switch can be used to indicate the preferred length of the header
-components that contain addresses.
-.PP
-If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for
-delivery, and the \*(lqBcc:\*(rq field will be removed from the message
-sent to sighted recipients.  The blind recipients will receive an entirely
-new message with a minimal set of headers.  Included in the body of the
-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
-.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.
-.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
-.BR \-alias .
-In any event, the primary alias file is
-read first. \" TODO: clarify. What means ``primary''?
-.PP
-The
-.B \-msgid
-switch indicates that a \*(lqMessage\-ID:\*(rq or
-\*(lqResent\-Message\-ID:\*(rq field should be added to the header.
-.PP
-The
-.B \-verbose
-switch indicates that the user should be informed of
-each step of the posting/filing process.
-.PP
-The
-.B \-watch
-switch indicates that the user would like to watch the
-transport system's handling of the message (e.g., local and \*(lqfast\*(rq
-delivery).
-.PP
-Under normal circumstances,
-.B post
-constructs the \*(lqFrom:\*(rq line of the
-message from the user's login name, the full name from the GECOS field of the
-passwd file, and the fully\-qualified name of the local machine.
-An example is \*(lqFrom: Dan Harkless
-<dan@machine.company.com>\*(rq.  There are four ways to override these values,
-however.  Note that they apply equally to \*(lqResent\-From:\*(rq lines in messages sent
-with
-.BR dist .
-.PP
-The first way is GECOS\-based username masquerading.  If the \*(lqmasquerade:\*(rq line
-in
-.I mts.conf
-contains \*(lqmmailid\*(rq, this processing is activated.  If a user's GECOS
-field in the passwd file is of the form \*(lqFull Name <fakename>\*(rq then \*(lqfakename\*(rq
-will be used in place of the real username.  For instance, a GECOS field of \*(lqDan
-Harkless <Dan.Harkless>\*(rq would result in \*(lqFrom: Dan Harkless
-<Dan.Harkless@machine.company.com>\*(rq.  Naturally if you were doing something like
-this you'd want to set up an MTA alias (e.g. in /etc/aliases) from, for
-instance, \*(lqDan.Harkless\*(rq to \*(lqdan\*(rq.
-.PP
-The second way to override default construction of \*(lqFrom:\*(rq is to set the
-.B $SIGNATURE
-environment variable.  This variable overrides the full name
-from the GECOS field, even if GECOS\-based masquerading is being done.  This
-processing is always active, and does not need to be enabled from
-.IR mts.conf .
-.PP
-The third way is controlled by the \*(lquser_extension\*(rq value of \*(lqmasquerade:\*(rq line
-of
-.IR mts.conf .
-When that's turned on, setting the
-.B $USERNAME_EXTENSION
-environment variable will result in its value being appended the user's login
-name.  For instance, if I set
-.B $USERNAME_EXTENSION
-to \*(lq+www\*(rq, my \*(lqFrom:\*(rq
-line will contain \*(lqDan Harkless <dan+www@machine.company.com>\*(rq (or
-\*(lqDan.Harkless+www\*(rq if I'm using mmailid masquerading as well).  Recent versions
-of
-.B sendmail
-automatically deliver all mail sent to
-.IR user + string
-to
-.IR user .
-.B qmail
-has a similar feature which uses '\-' as the delimiter by
-default, but can use other characters as well.
-.PP
-The fourth method of address masquerading is to specify a \*(lqFrom:\*(rq line manually
-in the message draft.  It will be used as provided (after alias substitution),
-but normally, to discourage email forgery, the user's
-.B real
-address will be
-used in the SMTP envelope \*(lqFrom:\*(rq and in a \*(lqSender:\*(rq header.  However, if the
-\*(lqmasquerade:\*(rq line of
-.I mts.conf
-contains \*(lqdraft_from\*(rq, the SMTP envelope \*(lqFrom:\*(rq
-will use the address given in the draft \*(lqFrom:\*(rq, and there will be no \*(lqSender:\*(rq
-header.  This is useful in pretending to send mail \*(lqdirectly\*(rq from a remote POP3
-account, or when remote email robots give improper precedence to the envelope
-\*(lqFrom:\*(rq.  Note that your MTA may still reveal your real identity (e.g.
-.BR sendmail 's
-\*(lqX\-Authentication\-Warning:\*(rq header).
-.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
-.RI servers
-entry in
-.I %etcdir%/mts.conf
-).
-
-.SH FILES
-.fc ^ ~
-.nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
-^%etcdir%/mts.conf~^nmh mts configuration file
-^refile~^Program to process Fcc:s
-^mhl~^Program to process Bcc:s
-.fi
-
-.SH "PROFILE COMPONENTS"
-.B post
-does
-.B NOT
-consult the user's profile.
-
-.SH "SEE ALSO"
-mhmail(1), send(1), mh\-mail(5), mh\-alias(5), mh\-tailor(5),
-refile(1), mhl(1),
-.I "Standard for the Format of ARPA Internet Text Messages"
-(RFC\-822)
-
-.SH DEFAULTS
-.nf
-.RB ` \-format '
-.RB ` \-nomime '
-.RB ` \-nomsgid '
-.RB ` \-noverbose '
-.RB ` \-nowatch '
-.RB ` "\-width\ 72" '
-.RB ` \-nofilter '
-.fi
-
-.SH CONTEXT
-None
-
-.SH BUGS
-\*(lqReply\-To:\*(rq fields are allowed to have groups in them according
-to the 822 specification, but
-.B post
-won't let you use them.
diff --git a/man/spost.man8 b/man/spost.man8
new file mode 100644 (file)
index 0000000..00f1d7b
--- /dev/null
@@ -0,0 +1,143 @@
+.\"
+.\" %nmhwarning%
+.\"
+.TH SPOST %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.SH NAME
+spost \- feed a message to sendmail
+.SH SYNOPSIS
+.HP 5
+.na
+.HP 5
+.B spost
+.RB [ \-alias
+.IR aliasfile
+.RB " | " \-noalias ]
+.RB [ \-dist ]
+.RB [ \-push " | " \-nopush ]
+.RB [ \-verbose " | " \-noverbose ]
+.RB [ \-watch " | " \-nowatch ]
+.I file
+.RB [ \-version ]
+.RB [ \-help ]
+.ad
+.SH DESCRIPTION
+.B Spost
+is the program called by
+.B send
+to feed the message in
+.I file
+to
+.B sendmail
+for delivery.  In fact, many of
+the features attributed to
+.B send
+in its manual page are performed by
+.BR spost ,
+with
+.B send
+acting as a preprocessor.
+Thus, it is
+.B spost
+which parses the various header fields, appends
+\*(lqFrom:\*(rq and \*(lqDate:\*(rq lines,
+and finally feeds the message to the MTA.
+.B Spost
+will not normally be called directly by the user.
+.PP
+.B Spost
+searches the \*(lqTo:\*(rq, \*(lqCc:\*(rq, \*(lqBcc:\*(rq,
+\*(lqFcc:\*(rq, and \*(lqResent\-xxx:\*(rq header lines of the specified
+message for destination addresses,
+.PP
+If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for
+delivery, and the \*(lqBcc:\*(rq field will be removed from the message
+sent to sighted recipients.  The blind recipients will receive a newly
+constructed message with a copy of the original message attached.
+MIME rules are used for encapsulation.
+.RB ( spost
+invokes
+.B send
+to send the Bcc message.)
+.PP
+The
+.B \-alias
+.I aliasfile
+switch can be used to specify a file that spost
+should take aliases from.  More than one file can be specified, each
+being preceded with
+.BR \-alias .
+In any event, the alias file, set with the `Aliasfile' profile entry, is
+read first.
+.PP
+The
+.B \-verbose
+enables the output of informational messages.
+This option sets \-watch, too.
+.PP
+The
+.B \-watch
+switch adds the `\-v' switch to the
+.B sendmail
+invocation.
+.PP
+.B Spost
+constructs the \*(lqFrom:\*(rq line of the
+message from the user's login name and the full name from the GECOS field
+of the passwd file.
+An example is \*(lqFrom: Dan Harkless <dan>\*(rq.
+.PP
+If you set the
+.B $SIGNATURE
+environment variable.
+Its value overrides the full name from the GECOS field.
+.PP
+If you specify a \*(lqFrom:\*(rq
+line manually in the message draft.
+It will be used as provided.
+However, a \*(lqSender:\*(rq header with the user's
+.B real
+address will be added.
+.PP
+Note that this applies equally to \*(lqResent\-From:\*(rq lines
+in messages sent with
+.BR dist .
+.PP
+Your MTA is supposed to care to fully qualitfy the addresses
+with the correct domain name.
+.PP
+The draft is filed to the folders in the Fcc headers by
+.BR refile .
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'ExtraBigFileName  'u
+None
+.fi
+
+.SH "PROFILE COMPONENTS"
+.B spost
+does
+.B NOT
+consult the user's profile.
+
+.SH "SEE ALSO"
+mhmail(1), send(1), mh\-mail(5), mh\-alias(5), mh\-tailor(5),
+refile(1),
+.I "Standard for the Format of ARPA Internet Text Messages"
+(RFC\-822)
+
+.SH DEFAULTS
+.nf
+.RB ` \-noverbose '
+.RB ` \-nowatch '
+.RB ` \-nopush '
+.fi
+
+.SH CONTEXT
+None
+
+.SH BUGS
+Spost does not qualify addresses.
+.PP
+Spost does only basic processing and checking, yet.