Have to check for missing type parameter in message/related part

[nmh] / man / mh-tailor.man

diff --git a/man/mh-tailor.man b/man/mh-tailor.man
index ea95045a3e977ac33ba0f63c33192698cdb4d21e..4b2362ff6c78f294a73e90a4d1bacd9aa1e25680 100644 (file)
--- a/man/mh-tailor.man
+++ b/man/mh-tailor.man
@@ -1,298 +1,341 @@
+.TH MH-TAILOR %manext5% "April 18, 2014" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH MH-TAILOR %manext5% MH.6.8 [%nmhversion%]

 .SH NAME
 .SH NAME

-mh-tailor, mts.conf \- mail transport customization for nmh message handler
-
-.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-\fI%etcdir%/mts.conf\fP
-.in -.5i
+mh-tailor, mts.conf \- mail transport configuration for nmh message handler

 .SH DESCRIPTION
 .SH DESCRIPTION

-The file %etcdir%/mts.conf defines run-time options for those \fInmh\fR
+The file
+.I %nmhetcdir%/mts.conf
+defines run-time options for those
+.B nmh

 programs which interact (in some form) with the message transport system.
 programs which interact (in some form) with the message transport system.

-At present, these (user) programs are: \fIap\fR, \fIconflict\fR,
-\fIinc\fR, \fImsgchk\fR, \fImsh\fR, \fIpost\fR, \fIrcvdist\fR, and
-\fIrcvpack\fR.
-
+At present, these (user) programs are:
+.BR ap ,
+.BR inc ,
+.BR msgchk ,
+.BR post ,
+.BR rcvdist ,
+and
+.BR rcvpack .
+.PP

 Each option should be given on a single line.  Blank lines and lines
 which begin with `#' are ignored.  The options available along with
 default values and a description of their meanings are listed below:
 Each option should be given on a single line.  Blank lines and lines
 which begin with `#' are ignored.  The options available along with
 default values and a description of their meanings are listed below:

-
-.in +.5i
-.ti -.5i
-localname:
-.br
-The hostname \fInmh\fR considers local.  It should typically be a fully
+.PP
+.BR mts :
+.RS 5
+The mail transport method to use.  The three acceptable options are
+.B smtp
+(which is the default),
+.BR sendmail/smtp ,
+and
+.BR sendmail/pipe .
+.PP
+If you use
+.BR smtp ,
+this will enable a direct SMTP (simple mail transport
+protocol) interface in
+.BR nmh .
+When sending mail, instead of passing the
+message to the mail transport agent,
+.B post
+will open a socket connection
+to the mail port on the machine specified in the
+.B servers
+entry.
+.PP
+If you use
+.BR sendmail/smtp ,
+then
+.B post
+will send messages by forking a
+local copy of
+.BR sendmail .
+It will still speak SMTP with this local copy of
+.BR sendmail .
+For backward compatibility,
+.B sendmail/smtp
+can be abbreviated to
+.BR sendmail .
+.PP
+The third alternative,
+.BR sendmail/pipe ,
+also forks a local copy of
+.B sendmail
+but feeds the message directly to it, using
+.B sendmail
+.BR -t .
+This replaces the old, undocumented
+.B spost
+mechanism and retains some of its limitations, such as lack of
+support for the
+.B \-whom
+switch and
+\*(lqDcc:\*(rq header field.
+.RE
+.PP
+.BR localname :
+.RS 5
+The hostname
+.B nmh
+considers local.  It should typically be a fully

 qualified hostname.  If this is not set, depending on the version of
 qualified hostname.  If this is not set, depending on the version of

-UNIX you're running, \fInmh\fR will query the system for this value
-(e.g., uname, gethostname, etc.), and attempt to fully qualify this
+UNIX you're running,
+.B nmh
+will query the system for this value
+(e.g. uname, gethostname, etc.), and attempt to fully qualify this

 value.
 value.

-
+.PP

 If you are using POP to retrieve new messages, you may want to set this
 value to the name of the POP server, so that outgoing message appear to
 have originated on the POP server.
 If you are using POP to retrieve new messages, you may want to set this
 value to the name of the POP server, so that outgoing message appear to
 have originated on the POP server.

-
-.ti -.5i
-localdomain:
-.br
+.RE
+.PP
+.BR localdomain :
+.RS 5

 If this is set, a `.' followed by this string will be appended to your
 hostname.
 If this is set, a `.' followed by this string will be appended to your
 hostname.

-
-This should only be needed, if for some reason \fInmh\fR is not able to
-fully qualify the hostname returned by the system (e.g., uname,
+.PP
+This should only be needed, if for some reason
+.B nmh
+is not able to
+fully qualify the hostname returned by the system (e.g. uname,

 gethostname, etc.).
 gethostname, etc.).

-
-.ti -.5i
-clientname:
-.br
-This option specifies the host name that \fInmh\fP will give in the
-SMTP \fBHELO\fP (and \fBEHLO\fP) command, when posting mail.  If not
-set, the default is to use the host name that \fInmh\fR considers local
-(see \*(lqlocalname\*(rq above).  If this option is set, but empty, no
-\fBHELO\fP command will be given.
-
-.sp
-Although the \fBHELO\fP command is required by RFC\-821, many SMTP servers
-do not require it.  Early versions of SendMail will fail if the hostname
-given in the \fBHELO\fP command is the local host.  Later versions of
-SendMail will complain if you omit the \fBHELO\fP command.  If you run
-SendMail, find out what your system expects and set this field if needed.
-
-.ti -.5i
-systemname:
-.br
+.RE
+.PP
+.BR clientname :
+.RS 5
+This option specifies the host name that
+.B nmh
+will give in the
+SMTP
+.B HELO
+(and
+.BR EHLO )
+command, when posting mail.  If not
+set, the default is to use the host name that
+.B nmh
+considers local
+(see
+.B localname
+above).  If this option is set, but empty, no
+.B HELO
+command will be given.
+.PP
+Although the
+.B HELO
+command is required by RFC 821, many SMTP servers
+do not require it.  Early versions of
+.I SendMail
+will fail if the hostname
+given in the
+.B HELO
+command is the local host.  Later versions of
+.I SendMail
+will complain if you omit the
+.B HELO
+command.  If you run
+.IR SendMail ,
+find out what your system expects and set this field if needed.
+.RE
+.PP
+.BR systemname :
+.RS 5

 This option is only used for UUCP mail.  It specifies the name of the
 This option is only used for UUCP mail.  It specifies the name of the

-local host in the \fIUUCP\fR \*(lqdomain\*(rq.  If not set, depending
-on the version of UNIX you're running, \fInmh\fR will query the system
-for this value.  This has no equivalent in the \fInmh\fR configuration
+local host in the UUCP \*(lqdomain\*(rq.  If not set, depending
+on the version of UNIX you're running,
+.B nmh
+will query the system
+for this value.  This has no equivalent in the
+.B nmh
+configuration

 file.
 file.

-
-.ti -.5i
-mmdfldir: %mailspool%
-.br
+.RE
+.PP
+.BR mmdfldir :
+%mailspool%
+.RS 5

 The directory where maildrops are kept.  If this option is set, but empty,
 the user's home directory is used.  This overrides the default value
 chosen at the time of compilation.
 The directory where maildrops are kept.  If this option is set, but empty,
 the user's home directory is used.  This overrides the default value
 chosen at the time of compilation.

-
-.ti -.5i
-mmdflfil: 
-.br
+.RE
+.PP
+.BR mmdflfil :
+.RS 5

 The name of the maildrop file in the directory where maildrops are kept.
 If this is empty, the user's login name is used.  This overrides the default
 value (which is empty).
 The name of the maildrop file in the directory where maildrops are kept.
 If this is empty, the user's login name is used.  This overrides the default
 value (which is empty).

-
-.ti -.5i
-mmdelim1: \\001\\001\\001\\001\\n
-.br
+.RE
+.PP
+.BR mmdelim1 :
+\&\\001\\001\\001\\001\\n
+.RS 5

 The beginning-of-message delimiter for maildrops.
 The beginning-of-message delimiter for maildrops.

-
-.ti -.5i
-mmdelim2: \\001\\001\\001\\001\\n
-.br
+.RE
+.PP
+.BR mmdelim2 :
+\&\\001\\001\\001\\001\\n
+.RS 5

 The end-of-message delimiter for maildrops.
 The end-of-message delimiter for maildrops.

-
-.ti -.5i
-mmailid: 0
-.br
-If this is non-zero, two different types of email address masquerading are
-allowed ("mmailid" = "masquerade mail ID").  The first type is GECOS-based
-masquerading.  \fInmh\fR will check if the user's pw_gecos field in the passwd
-file is of the form:
-
-.ti +.5i
-Full Name <fakeusername>
-
-If it is, the internal \fInmh\fR routines that find the username and full name
-of that user will return "fakeusername" and "Full Name" respectively.  This is
-useful if you want the messages you send to always appear to come from the name
-of an MTA alias rather than your actual account name.  For instance, many
-organizations set up "First.Last" sendmail aliases for all users.  If this is
-the case, the GECOS field for each user should look like:
-
-.ti +.5i
-First [Middle] Last <First.Last>
-
-The other type of masquerading that mmailid turns on is envelope "From:"
-masquerading based on draft contents.  When a user explicitly specifies a
-"From:" header in a message, \fInmh\fR uses it rather than constructing its own.
-However, the SMTP envelope "From:" and the "Sender:" header are set to the
-user's real address.  Turning on mmailid prevents this latter behavior.  This is
-useful when the user wants to pretend to be sending mail "directly" from a
-remote POP3 account, or when remote mail robots incorrectly use the envelope
-"From:" in preference to the body "From:" (or refuse to take action when the two
-don't match).
-
-.ti -.5i
-maildelivery: %libdir%/maildelivery
-.br
-The name of the system-wide default \fI\&.maildelivery\fR file.
-See \fIslocal\fR\0(1) for the details.
-
-.ti -.5i
-everyone: 200
-.br
-The highest user-id which should NOT receive mail addressed to
-\*(lqeveryone\*(rq.
-
-.ti -.5i
-noshell: 
-.br
-If set, then each user-id greater than \*(lqeveryone\*(rq that has a
-login shell equivalent to the given value (e.g., \*(lq/bin/csh\*(rq)
-indicates that mail for \*(lqeveryone\*(rq should not be sent to them.
-This is useful for handling admin, dummy, and guest logins.
-
-.in -.5i
-.Uh "SMTP support"
-These options are only available if you compiled \fInmh\fP with the
-\*(lq/smtp\*(rq support.
-
-.in +.5i
-.ti -.5i
-hostable: %etcdir%/hosts
-.br
-The exceptions file for /etc/hosts used by \fIpost\fR to try to find
-official names.  The format of this file is quite simple:
-
-.in +.5i
-1. Comments are surrounded by sharp (`#') and newline.
-.br
-2. Words are surrounded by white space.
-.br
-3. The first word on the line is the official name of a host.
-.br
-4. All words following the official names are aliases for that host.
-.in -.5i
-
-.ti -.5i
-servers: localhost \\01localnet
-.br
+.RE
+.PP
+.BR spoollocking :
+%default_locking%
+.RS 5
+The locking algorithm to use when opening the maildrop.  Can be any one of
+the following:
+.PP
+.RS 5
+.nf
+%supported_locks%
+.fi
+.RE
+.RE
+.PP
+.BR maildelivery :
+%nmhlibexecdir%/maildelivery
+.RS 5
+The name of the system-wide default
+.I maildelivery
+file.
+See
+.IR slocal (1)
+for the details.
+.RE
+.SS "SMTP support"
+This option is only available if you set
+.B mts
+to
+.BR smtp .
+.PP
+.BR servers :
+localhost
+.RS 5

 A lists of hosts and networks which to look for SMTP servers when
 A lists of hosts and networks which to look for SMTP servers when

-posting local mail.  It turns out this is a major win for hosts which
-don't run an message transport system.  The value of \*(lqservers\*(rq
-should be one or more items.  Each item is the name of either a host
-or a net (in the latter case, precede the name of the net by a \\01).
-This list is searched when looking for a smtp server to post mail.
-If a host is present, the SMTP port on that host is tried.  If a net
-is present, the SMTP port on each host in that net is tried.  Note that
-if you are running with the BIND code, then any networks specified are
-ignored (sorry, the interface went away under BIND).
-
-.in -.5i
-.Uh "SendMail"
-This option is only available if you compiled \fInmh\fP to use
-\fISendMail\fP as your delivery agent.
-
-.in +.5i
-.ti -.5i
-sendmail: %sendmailpath%
-.br
-The pathname to the \fIsendmail\fR program.
-
-.in -.5i
-.Uh "Post Office Protocol"
-This option is only available if you have compiled \fInmh\fP with POP
-support enabled (i.e., \*(lq--enable-nmh-pop\*(rq).
-
-.in +.5i
-.ti -.5i
-pophost:
-.br
+posting non\-local mail.  It turns out this is a major win for hosts
+which don't run an message transport system.  The value of
+.B servers
+should be one or more items.  Each item is the name of a host which
+is (hopefully) running a SMTP server.
+.SS "SendMail"
+This option is only available if you set
+.B mts
+to
+.BR sendmail .
+.PP
+.BR sendmail :
+%sendmailpath%
+.RS 5
+The pathname to the
+.B sendmail
+program.
+.RE
+.SS "Post Office Protocol"
+.BR pophost :
+.RS 5

 The name of the default POP service host.  If this is not set, then
 The name of the default POP service host.  If this is not set, then

-\fInmh\fR looks in the standard maildrop areas for waiting mail, otherwise
+.B nmh
+looks in the standard maildrop areas for waiting mail, otherwise

 the named POP service host is consulted.
 the named POP service host is consulted.

-
-.in -.5i
-.Uh "BBoards Delivery"
-This option is only available if you compiled \fInmh\fP with
-\*(lqbbdelivery:\ on\*(rq.
-
-.in +.5i
-.ti -.5i
-bbdomain:
-.br
-The local BBoards domain (a UCI hack).
-
-.in -.5i
-.Uh "BBoards & The POP"
-These options are only available if you compiled \fInmh\fP with
-\*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
-
-.in +.5i
-.ti -.5i
-popbbhost:
-.br
-The POP service host which also acts as a BBoard server.  This variable
-should be set on the POP BBoards client host.
-
-.ti -.5i
-popbbuser:
-.br
-The guest account on the POP/BB service host.  This should be a different
-login ID than either the POP user or the BBoards user.  (The user-id
-\*(lqftp\*(rq is highly recommended.)  This variable should be set on
-both the POP BBoards client and service hosts.
-
-.ti -.5i
-popbblist: %etcdir%/hosts.popbb
-.br
-A file containing of lists of hosts that are allowed to use the POP
-facility to access BBoards using the guest account.  If this file is not
-present, then no check is made.  This variable should be set on the POP
-BBoards service host.
-
-.in -.5i
-.if n .ne 8
-.Uh "BBoards & The NNTP"
-This option is only available if you compiled \fInmh\fP with
-\*(lqbboards:\ nntp\*(rq and \*(lqpop:\ on\*(rq.
-
-.in +.5i
-.ti -.5i
-nntphost:
-.br
-The host which provides the NNTP service.  This variable should be set
-on the NNTP BBoards client host.
-
-.in -.5i
-.Uh "File Locking"
-A few words on locking: \fInmh\fR has several methods for creating locks
-on files.  When configuring \fInmh\fR, you will need to decide on the
-locking style and locking directory (if any).  The first controls the
-method of locking, the second says where lock files should be created.
-
-To configure \fInmh\fR for kernel locking, define \fBFLOCK_LOCKING\fP if
-you want to use the \fIflock\fP system call; define \fBLOCKF_LOCKING\fP if
-you want to use the \fIlockf\fP system call; or define \fBFCNTL_LOCKING\fP
-if you want to use the \fIfcntl\fP system call for kernel-level locking.
-
-Instead of kernel locking, you can configure \fInmh\fR to use dot
-locking by defining \fBDOT_LOCKING\fP.  Dot locking specifies that
-a file should be created whose existence means \*(lqlocked\*(rq and
-whose non-existence means \*(lqunlocked\*(rq.  The name of this file is
-constructed by appending \*(lq.lock\*(rq to the name of the file being
-locked.  If \fBLOCKDIR\fP is not specified, lock files will be created
+.RE
+.\"  .SS "BBoards Delivery"
+.\"  This option is only available if you compiled \fInmh\fP with
+.\"  \*(lqbbdelivery:\ on\*(rq.
+.\"  .PP
+.\"  .BR bbdomain :
+.\"  .RS 5
+.\"  The local BBoards domain (a UCI hack).
+.\"  .RE
+.\"  .SS "BBoards & The POP"
+.\"  These options are only available if you compiled \fInmh\fP with
+.\"  \*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
+.\"  .PP
+.\"  .BR popbbhost :
+.\"  .RS 5
+.\"  The POP service host which also acts as a BBoard server.  This variable
+.\"  should be set on the POP BBoards client host.
+.\"  .RE
+.\"  .PP
+.\"  .BR popbbuser :
+.\"  .RS 5
+.\"  The guest account on the POP/BB service host.  This should be a different
+.\"  login ID than either the POP user or the BBoards user.  (The user-id
+.\"  \*(lqftp\*(rq is highly recommended.)  This variable should be set on
+.\"  both the POP BBoards client and service hosts.
+.\"  .RE
+.\"  .PP
+.\"  .BR popbblist :
+.\"  %nmhetcdir%/hosts.popbb
+.\"  .RS 5
+.\"  A file containing of lists of hosts that are allowed to use the POP
+.\"  facility to access BBoards using the guest account.  If this file is not
+.\"  present, then no check is made.  This variable should be set on the POP
+.\"  BBoards service host.
+.\"  .RE
+.SS "File Locking"
+A few words on locking:
+.B nmh
+has two main uses for locking: locking the mail spool during mail
+incorporation, and locking metadata files (sequence files, the context)
+during updates.  These locking methods can be configured separately
+from each other.
+.PP
+For locking the mail spool, the
+.I spoollocking
+entry in
+.IR mh\-tailor (5)
+will control the locking algorithm to use when
+.B inc
+incorporates mail from the spool file.  If no entry is given, a default
+based on the operating system type will be chosen.
+.PP
+For locking all other files, the
+.I datalocking
+entry in
+.IR mh-profile (5)
+controls the locking algorithm used for all other file access.
+If no entry is given, the
+.I fcntl
+lock method will be chosen.
+.PP
+If you do not wish to use kernel\-based locking,
+.I dot
+locking is an option available.
+If \*(lq--enable-lockdir=directory\*(rq
+is not specified at build time, lock files will be created

 in the directory where the file being locked resides.  Otherwise, lock
 in the directory where the file being locked resides.  Otherwise, lock

-files will be created in the directory specified by \fBLOCKDIR\fP.
-
-Prior to installing \fInmh\fR, you should see how locking is done at
+files will be created in the directory specified by
+\*(lq--enable-lockdir\*(rq.
+.PP
+Prior to installing
+.BR nmh ,
+you should see how locking is done at

 your site, and set the appropriate values.
 your site, and set the appropriate values.

-
-.Fi
-^%etcdir%/mts.conf~^nmh mts configuration file
-.Pr
-None
-.Sa
-mh\-mts(8)
-.De
-As listed above
-.Co
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^%nmhetcdir%/mts.conf~^nmh mts configuration file
+.fi
+.SH "PROFILE COMPONENTS"

 None
 None

-.En
+.SH "SEE ALSO"
+.IR mh\-mts (8),
+.IR post (8)
+.SH DEFAULTS
+As listed above.  The path of the mail transport configuration
+file can be changed with the
+.B MHMTSCONF
+environment variable and augmented with the
+.B MHMTSUSERCONF
+environment variable, see mh\-profile(5).
+.SH BUGS
+Failure to open any mail transport configuration file is silently
+ignored.  Therefore, it's best to avoid dynamic creation of such
+a file with the intent of use via the
+.B MHMTSCONF
+or
+.B MHMTSUSERCONF
+environment variables.  If such use is necessary, the ability
+to successfully open the file should first be verified.