.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
.TH SHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
show \- show (display) messages
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-show
-\%[+folder] \%[msgs]
-\%[\-showproc\ program]
-.br
-\%[\-showmimeproc\ program]
-\%[\-header] \%[\-noheader]
-.br
-\%[\-draft]
-\%[\-checkmime] \%[\-nocheckmime]
-.br
-\%[switches\ for\ \fIshowproc\fR or \fIshowmimeproc\fR]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B show
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-draft ]
+.RB [\-showproc
+.IR program ]
+.RB [ \-showmimeproc
+.IR program ]
+.RB [ \-header " | " \-noheader ]
+.RB [ \-checkmime " | " \-nocheckmime ]
+[switches\ for
+.I showproc
+or
+.IR showmimeproc ]
+.RB [ \-version ]
+.RB [ \-help ]
.SH DESCRIPTION
-\fIShow\fR lists each of the specified messages to the standard output
+.B Show
+lists each of the specified messages to the standard output
(typically, the terminal).
-
+.PP
By default, text (non-MIME) messages are filtered and displayed by
-the \fInmh\fR command \fImhl\fR. This command will display text
+the
+.B nmh
+command
+.BR mhl .
+This command will display text
messages in a nice, uniform format. It also allows you to configure
the format of the displayed messages and which headers fields are
-shown. See the \fImhl\fR(1) manual page for the details about this
-command. This default can be changed by defining the \fIshowproc\fR
-profile component. Any switches not recognized by \fIshow\fR are
+shown. See the
+.BR mhl (1)
+manual page for the details about this
+command. This default can be changed by defining the
+.I showproc
+profile component. Any switches not recognized by
+.B show
+are
passed along to that program. To override the default and the
-\fIshowproc\fR profile component, use the `\-showproc\ program'
-switch. For example, `\-showproc\ more' will cause the \fImore\fR(1)
+.I showproc
+profile component, use the
+.B \-showproc
+.I program
+switch. For example,
+.B \-showproc
+.I more
+will cause the
+.B more
program to list the messages with no reformatting. Normally, this
-program is specified as the \fIshowproc\fR in the user's
-\&.mh\(ruprofile, rather than using a command line switch.
-
+program is specified as the
+.I showproc
+in the user's
+.IR \&.mh\(ruprofile ,
+rather than using a command line switch.
+.PP
By default, non-text messages (MIME messages with multi-media
-contents) are processed and displayed by the \fInmh\fR command
-\fImhshow\fR. See the \fImhshow\fR(1) manual page for details
+contents) are processed and displayed by the
+.B nmh
+command
+.BR mhshow .
+See the
+.BR mhshow (1)
+manual page for details
about this command. This default can changed by defining the
-\fIshowmimeproc\fR profile component. Any switches not recognized
-by \fIshow\fR are passed along to that program. To override this
-default and the \fIshowmimeproc\fR profile component, use the
-`\-showmimeproc\ program' switch.
-
-Note that in some cases, \fIshow\fR may invoke the \fIshowmimeproc\fR
+.I showmimeproc
+profile component. Any switches not recognized
+by
+.B show
+are passed along to that program. To override this
+default and the
+.B showmimeproc
+profile component, use the
+.B \-showmimeproc
+.I program
+switch.
+.PP
+Note that in some cases,
+.B show
+may invoke the
+.I showmimeproc
even for textual contents. This will happen for text messages that
specify a transfer encoding (such as MIME quoted-printable or
-base64) or specify a character set that \fIshow\fR doesn't believe
-can be displayed natively. The environment variable MM_CHARSET
+base64) or specify a character set that
+.B show
+doesn't believe
+can be displayed natively. The environment variable
+.B $MM_CHARSET
should be set to the terminal's native character set to avoid
-gratuitous invocations of the \fIshowmimeproc\fR. See the
-mh-profile(5) man page for details about this environment variable.
-
-The option `\-checkmime' (set by default) instructs \fIshow\fR to
+gratuitous invocations of the
+.IR showmimeproc .
+See the
+.BR mh-profile (5)
+man page for details about this environment variable.
+.PP
+The option
+.B \-checkmime
+(set by default) instructs
+.B show
+to
test if any of the messages to be displayed are non-text (MIME)
messages. If any are non-text, they are displayed by the program
-\fIshowmimeproc\fR, else they are displayed by the program
-\fIshowproc\fR. The option `-nocheckmime' disables this test and
-instructs \fIshow\fR to use \fIshowproc\fR, regardless of whether
+.IR showmimeproc ,
+else they are displayed by the program
+.IR showproc .
+The option
+.B \-nocheckmime
+disables this test and instructs
+.B show
+to use
+.IR showproc ,
+regardless of whether
any of the messages are non-text (MIME) messages.
-
-The `\-noshowproc' switch will disable any formatting or paging of
-messages. It is equivalent to `-nocheckmime\ -showproc\ cat'. It
-is still accepted, but should be considered (somewhat) obsolete.
-
-If the environment variable \fBNOMHNPROC\fR is set, the test for
+.P
+The
+.B \-noshowproc
+switch will disable any formatting or paging of
+messages. It is equivalent to
+.B \-nocheckmime
+.B \-showproc
+.IR cat .
+It is still accepted, but should be considered (somewhat) obsolete.
+.PP
+If the environment variable
+.B $NOMHNPROC
+is set, the test for
non-text (MIME) messages will be disabled. This method is obsolete.
-Use the `-nocheckmime' switch instead.
-
-The `\-header' switch tells \fIshow\fR to display a one\-line
+Use the
+.B \-nocheckmime
+switch instead.
+.PP
+The
+.B \-header
+switch tells
+.B show
+to display a one\-line
description of the message being shown. This description includes
the folder and the message number.
-
+.PP
If no `msgs' are specified, the current message is used. Although
-it depends on the specific \fIshowproc\fR or \fIshowmimeproc\fR,
+it depends on the specific
+.I showproc
+or
+.IR showmimeproc ,
in the default setup when more than one message is specified, you
will be prompted for a <RETURN> prior to listing each message.
Each message will be listed a page at a time, and when the end of
page is reached, the program will wait for a <SPACE> or <RETURN>.
If a <RETURN> is entered, it will print the next line, whereas
<SPACE> will print the next screenful.
-
+.PP
If the standard output is not a terminal, no queries are made, and
each file is listed with a one\-line header and two lines of
separation.
-
-\*(lqshow \-draft\*(rq will list the file <mh\-dir>/draft if it
+.PP
+.RB \*(lq "show \-draft" \*(rq
+will list the file <mh\-dir>/draft if it
exists.
-
+.PP
If the profile entry \*(lqUnseen\-Sequence\*(rq is present and
-non\-empty, then \fIshow\fR will remove each of the messages shown
+non\-empty, then
+.B show
+will remove each of the messages shown
from each sequence named by the profile entry.
-.Fi
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName 'u
^Path:~^To determine the user's nmh directory
-.Ps
^Current\-Folder:~^To find the default current folder
-.Ps
^Unseen\-Sequence:~^To name sequences denoting unseen messages
-.Ps
^showproc:~^Program to show text (non-MIME) messages
-.Ps
^showmimeproc:~^Program to show non-text (MIME) messages
-.Sa
+.fi
+
+.SH "SEE ALSO"
mhl(1), mhshow(1), more(1), next(1), prev(1), scan(1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to cur
-.Ds
-`\-checkmime'
-.Ds
-`\-header'
-.Co
+
+.SH DEFAULTS
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msgs "' defaults to cur"
+.RB ` \-checkmime '
+.RB ` \-header '
+.fi
+
+.SH CONTEXT
If a folder is given, it will become the current folder. The last
message shown will become the current message.
-.Bu
-The `\-header' switch doesn't work when `msgs' expands to more than
-one message. If the \fIshowproc\fR is \fImhl\fR, then is problem can
-be circumvented by referencing the \*(lqmessagename\*(rq field in the
-\fImhl\fR format file.
-\fIShow\fR updates the user's context before showing the message.
-Hence \fIshow\fR will mark messages as seen prior to the user actually
+.SH BUGS
+The
+.B \-header
+switch doesn't work when `msgs' expands to more than
+one message. If the
+.I showproc
+is
+.BR mhl ,
+then this problem can
+be circumvented by referencing the \*(lqmessagename\*(rq field in the
+.B mhl
+format file.
+.PP
+.B Show
+updates the user's context before showing the message.
+Hence
+.B show
+will mark messages as seen prior to the user actually
seeing them. This is generally not a problem, unless the user relies
-on the \*(lqunseen\*(rq messages mechanism, and interrupts \fIshow\fR
+on the \*(lqunseen\*(rq messages mechanism, and interrupts
+.B show
while it is showing \*(lqunseen\*(rq messages.
-
-If your \fIshowproc\fR is \fImhl\fR (the default), then \fIshow\fR uses
-a built\-in \fImhl\fR: it does not actually run the \fImhl\fR program.
-Hence, if you define your own \fIshowproc\fR, don't call it \fImhl\fR
-since \fIshow\fR won't run it.
-
-If your \fIshowproc\fR is the pager \fImore\fR, then avoid running
-\fIshow\fR in the background with only its standard output piped to
+.PP
+If your
+.I showproc
+is
+.B mhl
+(the default), then
+.B show
+uses
+a built\-in
+.BR mhl :
+it does not actually run the
+.B mhl
+program.
+Hence, if you define your own
+.B showproc ,
+don't call it
+.B mhl
+since
+.B show
+won't run it.
+.PP
+If your
+.I showproc
+is the pager
+.BR more ,
+then avoid running
+.B show
+in the background with only its standard output piped to
another process, as in
-
-.ti +.5i
+.PP
+.RS 5
show | imprint &
-
-Due to a bug in \fImore\fR, show will go into a \*(lqtty input\*(rq state.
-To avoid this problem, re\-direct \fIshow\fR's diagnostic output as well.
-For users of \fIcsh\fR:
-
-.ti +.5i
+.RE
+.PP
+Due to a bug in
+.BR more ,
+show will go into a \*(lqtty input\*(rq state.
+To avoid this problem, re\-direct
+.BR show 's
+diagnostic output as well.
+For users of
+.BR csh :
+.PP
+.RS 5
show |& imprint &
-
-For users of \fIsh\fR:
-
-.ti +.5i
+.RE
+.PP
+For users of
+.BR sh :
+.PP
+.RS 5
show 2>&1 | imprint &
-.En
+.RE
.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
.TH SLOCAL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
slocal \- asynchronously filter and deliver new mail
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-%libdir%/slocal \%[address\ info\ sender]
-.na
-.br
-\%[\-addr\ address]
-\%[\-info\ data]
-\%[\-sender\ sender]
-.br
-\%[\-user\ username]
-\%[\-mailbox\ mbox]
+.HP 5
+.B %libdir%/slocal
+[address\ info\ sender]
+.RB [ \-addr
+.IR address ]
+.RB [ \-info
+.IR data ]
+.RB [ \-sender
+.IR sender ]
+.RB [ \-user
+.IR username ]
+.RB [ \-mailbox
+.IR mbox ]
.\" \%[\-home\ homedir]
-\%[\-file\ file]
-.br
-\%[\-maildelivery\ deliveryfile]
-\%[\-verbose] \%[\-noverbose]
-.br
-\%[\-suppressdup] \%[\-nosuppressdup]
-\%[\-debug]
-.br
-\%[\-version]
-\%[\-help]
-.ad
-.in -.5i
+.RB [ \-file
+.IR file ]
+.RB [ \-maildelivery
+.IR deliveryfile ]
+.RB [ \-verbose " | " \-noverbose ]
+.RB [ \-suppressdup " | " \-nosuppressdup ]
+.RB [ \-debug ]
+.RB [ \-version ]
+.RB [ \-help ]
.SH DESCRIPTION
-\fISlocal\fP is a program designed to allow you to have your inbound
+.B Slocal
+is a program designed to allow you to have your inbound
mail processed according to a complex set of selection criteria.
-You do not normally invoke \fIslocal\fP yourself, rather \fIslocal\fP
+You do not normally invoke
+.B slocal
+yourself, rather
+.B slocal
is invoked on your behalf by your system's Message Transfer Agent
-(such as sendmail) when the message arrives.
-
-The message selection criteria used by \fIslocal\fP is specified
-in the file \fI\&.maildelivery\fP in the user's home directory.
-You can specify an alternate file with the `\-maildelivery file'
+(such as
+.BR sendmail )
+when the message arrives.
+.PP
+The message selection criteria used by
+.B slocal is specified
+in the file
+.RI \*(lq \&.maildelivery \*(rq
+in the user's home directory.
+You can specify an alternate file with the
+.B \-maildelivery
+.I file
option. The syntax of this file is specified below.
-
+.PP
The message delivery address and message sender are determined from
the Message Transfer Agent envelope information, if possible.
-Under \fIsendmail\fP, the sender will obtained from the UUCP
-\*(lqFrom\ \*(rq line, if present. The user may override these
-values with command line arguments, or arguments to the `\-addr'
-and `\-sender' switches.
-
-The message is normally read from the standard input. The `\-file'
+Under
+.BR sendmail ,
+the sender will obtained from the UUCP
+\*(lqFrom:\*(rq line, if present. The user may override these
+values with command line arguments, or arguments to the
+.B \-addr
+and
+.B \-sender
+switches.
+.PP
+The message is normally read from the standard input. The
+.B \-file
switch sets the name of the file from which the message should be
read, instead of reading stdin. This is useful when debugging a
-\fI\&.maildelivery\fP file.
-
-The `\-user' switch tells \fIslocal\fP the name of the user for
-whom it is delivering mail. The `\-mailbox' switch tells \fIslocal\fP
+.RI \*(lq \&.maildelivery \*(rq
+file.
+.PP
+The
+.B \-user
+switch tells
+.B slocal
+the name of the user for
+whom it is delivering mail. The
+.B \-mailbox
+switch tells
+.B slocal
the name of the user's maildrop file.
-
-\fIslocal\fR is able to detect and suppress duplicate messages.
-To enable this, use the option `\-suppressdup'. \fIslocal\fR will
+.PP
+.B slocal
+is able to detect and suppress duplicate messages.
+To enable this, use the option
+.BR \-suppressdup .
+.B slocal
+will
keep a database containing the Message-ID's of incoming messages,
in order to detect duplicates. Depending on your configuration,
this database will be in either ndbm or Berkeley db format.
-
-The `\-info' switch may be used to pass an arbitrary argument to
-sub-processes which \fIslocal\fP may invoke on your behalf.
-
-The `\-verbose' switch causes \fIslocal\fP to give information on
-stdout about its progress. The `\-debug' switch produces more
+.PP
+The
+.B \-info
+switch may be used to pass an arbitrary argument to
+sub-processes which
+.B slocal
+may invoke on your behalf.
+.PP
+The
+.B \-verbose
+switch causes
+.B slocal
+to give information on
+stdout about its progress. The
+.B \-debug
+switch produces more
verbose debugging output on stderr. These flags are useful when
-creating and debugging your \fI\&.maildelivery\fP file, as they
-allow you to see the decisions and actions that \fIslocal\fR is
-taking, as well as check for syntax errors in your \fI\&.maildelivery\fP
+creating and debugging your
+.RI \*(lq \&.maildelivery \*(rq
+file, as they
+allow you to see the decisions and actions that
+.B slocal
+is taking, as well as check for syntax errors in your
+.RI \*(lq \&.maildelivery \*(rq
file.
-.Uh "Message Transfer Agents"
-If your MTA is \fIsendmail\fP, you should include the line
-.sp
-.nf
-.in +.5i
- \*(lq|\ %libdir%/slocal\ \-user\ username\*(rq
-.in -.5i
-.fi
-.sp
+.SS "Message Transfer Agents"
+If your MTA is
+.BR sendmail ,
+you should include the line
+.PP
+.RS 5
+\*(lq|\ %libdir%/slocal\ \-user\ username\*(rq
+.RE
+.PP
in your \&.forward file in your home directory. This will cause
-\fIsendmail\fP to invoke \fIslocal\fP on your behalf when a
-message arrives.
-
-If your MTA is \fIMMDF-I\fP, you should (symbolically) link
-%libdir%/slocal to the file bin/rcvmail in your home directory. This will
-cause \fIMMDF-I\fP to invoke \fIslocal\fP on your behalf with the correct
-\*(lq\fIaddress\ info\ sender\fP\*(rq arguments.
-
-If your MTA is \fIMMDF-II\fP, then you should not use \fIslocal\fP.
-An equivalent functionality is already provided by \fIMMDF-II\fP; see
-maildelivery(5) for details.
-
-.Uh "The Maildelivery File"
-
-The \fI\&.maildelivery\fR file controls how slocal filters and delivers
+.B sendmail
+to invoke
+.B slocal
+on your behalf when a message arrives.
+.PP
+If your MTA is
+.BR MMDF-I ,
+you should (symbolically) link
+.B %libdir%/slocal
+to the file
+.B bin/rcvmail
+in your home directory. This will
+cause
+.B MMDF-I
+to invoke
+.B slocal
+on your behalf with the correct
+.RI \*(lq "address\ info\ sender" \*(rq
+arguments.
+.PP
+If your MTA is
+.BR MMDF-II ,
+then you should not use
+.B slocal.
+An equivalent functionality is already provided by
+.BR MMDF-II ;
+see
+.BR maildelivery (5)
+for details.
+
+.SS "The Maildelivery File"
+The
+.RI \*(lq \&.maildelivery \*(rq
+file controls how
+.B slocal
+filters and delivers
incoming mail. Each line of this file consists of five fields, separated
by white-space or comma. Since double-quotes are honored, these
characters may be included in a single argument by enclosing the entire
argument in double-quotes. A double-quote can be included by preceding it
with a backslash. Lines beginning with `#' and blank lines are ignored.
-
-The format of each line in the \fI\&.maildelivery\fR file is:
-
- \fBheader pattern action result string\fR
-.sp
-.in +.5i
-.ti -.5i
-\fBheader\fP:
-.br
+.PP
+The format of each line in the
+.RI \*(lq \&.maildelivery \*(rq
+file is:
+.PP
+.RS 5
+.B header pattern action result string
+.RE
+.PP
+.BR header :
+.RS 5
The name of a header field (such as To, Cc, or From) that is to
be searched for a pattern. This is any field in the headers of
the message that might be present.
-
+.PP
The following special fields are also defined:
-.sp
-.in +1i
-.ta +1i
-.ti -1i
-\fIsource\fR the out-of-band sender information
-.ti -1i
-\fIaddr\fR the address that was used to cause delivery to the recipient
-.ti -1i
-\fIdefault\fR this matches \fIonly\fR if the message hasn't been delivered yet
-.ti -1i
-\fI*\fR this always matches
-.in -1i
-
-.ti -.5i
-\fBpattern\fR:
-.br
+.TP \w'defaultrrr'u
+.I source
+the out-of-band sender information
+.TP \w'defaultrrr'u
+.I addr
+the address that was used to cause delivery to the recipient
+.TP \w'defaultrrr'u
+.I default
+this matches
+.B only
+if the message hasn't been delivered yet
+.TP \w'defaultrrr'u
+.I *
+this always matches
+.RE
+.PP
+.BR pattern :
+.RS 5
The sequence of characters to match in the specified header field.
Matching is case-insensitive, but does not use regular expressions.
-
-.ti -.5i
-\fBaction\fR:
-.br
+.RE
+.PP
+.BR action :
+.RS 5
The action to take to deliver the message. When a message is delivered,
a \*(lqDelivery\-Date:\ date\*(rq header is added which indicates the date
and time that message was delivered.
-.sp
-.in +1i
-.ta +1i
-.ti -1i
-\fIdestroy\fR
+.TP \w'qpipezorztzzz'u
+.I destroy
This action always succeeds.
-
-.ti -1i
-\fIfile\fR, \fImbox\fR, or >
-Append the message to the file named by \fBstring\fR. The message is
+.IR file ", " mbox ", or " >
+Append the message to the file named by
+.IR string .
+The message is
appended to the file in mbox (uucp) format. This is the format used by most
other mail clients (such as mailx, elm). If the message can be appended to
the file, then this action succeeds.
-
-.ti -1i
-\fImmdf\fR Identical to \fIfile\fR, but always appends the message using
-the MMDF mailbox format.
-
-.ti -1i
-\fIpipe\fR or |
+.TP \w'qpipezorztzzz'u
+.I mmdf
+Identical to
+.IR file ,
+but always appends the message using the MMDF mailbox format.
+.TP \w'qpipezorztzzz'u
+.IR pipe " or " |
Pipe the message as the standard input to the command named by
-\fBstring\fR, using the Bourne shell \fIsh\fR(1) to interpret the string.
+.IR string ,
+using the Bourne shell
+.B sh
+to interpret the string.
Prior to giving the string to the shell, it is expanded with the following
built-in variables:
-.sp
-.in +1i
-.ta +1i
-.ti -1i
-$(sender) the out-of-band sender information
-.ti -1i
-$(address) the address that was used to cause delivery to the recipient
-.ti -1i
-$(size) the size of the message in bytes
-.ti -1i
-$(reply\-to) either the \*(lqReply\-To:\*(rq or \*(lqFrom:\*(rq field
-of the message
-.ti -1i
-$(info) the out-of-band information specified
-.in -1i
-
-.ti -1i
-\fIqpipe\fR or <caret> Similar to \fIpipe\fR, but executes the command
+.RS \w'qpipezorztzzz'u
+.TP \w'zzreplyztozaaa'u
+$(sender)
+the out-of-band sender information
+.TP \w'zzreplyztozaaa'u
+$(address)
+the address that was used to cause delivery to the recipient
+.TP \w'zzreplyztozaaa'u
+$(size)
+the size of the message in bytes
+.TP \w'zzreplyztozaaa'u
+$(reply\-to)
+either the \*(lqReply\-To:\*(rq or \*(lqFrom:\*(rq field of the message
+.TP \w'zzreplyztozaaa'u
+$(info)
+the out-of-band information specified
+.RE
+.PP
+.TP \w'qpipezorztzzz'u
+.IR qpipe " or " ^
+Similar to
+.IR pipe ,
+but executes the command
directly, after built-in variable expansion, without assistance from
the shell. This action can be used to avoid quoting special characters
which your shell might interpret.
-
-.ti -1i
-\fIfolder\fR or \fI\+\fR Store the message in the nmh folder named
-by \fBstring\fR. Currently this is handled by piping the message to the nmh
-program `rcvstore', although this may change in the future.
-
-.in -1i
-.ti -.5i
-\fBresult\fR:
-.br
+.TP \w'qpipezorztzzz'u
+.IR folder " or " +
+Store the message in the
+.B nmh
+folder named by
+.IR string .
+Currently this is handled by piping the message to the
+.B nmh
+program
+.BR rcvstore ,
+although this may change in the future.
+.RE
+.PP
+.BR result :
+.RS 5
Indicates how the action should be performed:
-
-.in +1i
-.ta +1i
-.ti -1i
-\fIA\fR Perform the action. If the action succeeds, then the message
+.TP \w'Azzz'u
+.I A
+Perform the action. If the action succeeds, then the message
is considered delivered.
-
-.ti -1i
-\fIR\fR Perform the action.
-Regardless of the outcome of the action, the message is not considered
-delivered.
-
-.ti -1i
-\fI?\fR Perform the action only if the message has not been delivered.
+.TP \w'Azzz'u
+.I R
+Perform the action. Regardless of the outcome of the action,
+the message is not considered delivered.
+.TP \w'Azzz'u
+.I ?
+Perform the action only if the message has not been delivered.
If the action succeeds, then the message is considered delivered.
-
-.ti -1i
-\fIN\fR Perform the action only if the message has not been delivered
+.TP \w'Azzz'u
+.I N
+Perform the action only if the message has not been delivered
and the previous action succeeded. If this action succeeds, then the
message is considered delivered.
-.sp
-.in -1i
-.in -.5i
-
+.PP
The delivery file is always read completely, so that several matches
can be made and several actions can be taken.
-.fi
+.RE
-.Uh "Security of Delivery Files"
-In order to prevent security problems, the \fI\&.maildelivery\fR
+.SS "Security of Delivery Files"
+In order to prevent security problems, the
+.RI \*(lq \&.maildelivery \*(rq
file must be owned either by the user or by root, and must be
writable only by the owner. If this is not the case, the file is
not read.
-
-If the \fI\&.maildelivery\fR file cannot be found, or does not
-perform an action which delivers the message, then \fIslocal\fP
-will check for a global delivery file at %etcdir%/maildelivery.
+.PP
+If the
+.RI \*(lq \&.maildelivery \*(rq
+file cannot be found, or does not
+perform an action which delivers the message, then
+.B slocal
+will check for a global delivery file at
+.IR %etcdir%/maildelivery .
This file is read according to the same rules. This file must be
owned by the root and must be writable only by the root.
-
+.PP
If a global delivery file cannot be found or does not perform an
action which delivers the message, then standard delivery to the
user's maildrop is performed.
-.fi
-.Uh "Example Delivery File"
+.SS "Example Delivery File"
To summarize, here's an example delivery file:
-.sp
-.if t .in +.5i
+.PP
.nf
.ta \w'default 'u +\w'mh-workersxx 'uC +\w'destroy 'uC +\w'result 'u
#
# always run rcvtty
* \- pipe R /nmh/lib/rcvtty
-.re
.fi
-.Uh "Sub-process environment"
+.SS "Sub-process environment"
When a process is invoked, its environment is: the user/group-ids are
set to recipient's ids; the working directory is the recipient's home
directory; the umask is 0077; the process has no /dev/tty; the standard
input is set to the message; the standard output and diagnostic output are
set to /dev/null; all other file-descriptors are closed; the environment
-variables \fB$USER\fR, \fB$HOME\fR, \fB$SHELL\fR are set appropriately,
-and no other environment variables exist.
-
+variables
+.BR $USER ,
+.BR $HOME ,
+.B $SHELL
+are set appropriately, and no other environment variables exist.
+.PP
The process is given a certain amount of time to execute. If the process
does not exit within this limit, the process will be terminated with
extreme prejudice. The amount of time is calculated as ((size / 60) +
300) seconds, where size is the number of bytes in the message (with
30 minutes the maximum time allowed).
-
+.PP
The exit status of the process is consulted in determining the success
of the action. An exit status of zero means that the action succeeded.
Any other exit status (or abnormal termination) means that the action
failed.
-
+.PP
In order to avoid any time limitations, you might implement a process
-that began by \fIforking\fR. The parent would return the appropriate
+that began by
+.BR fork ()-ing.
+The parent would return the appropriate
value immediately, and the child could continue on, doing whatever it
wanted for as long as it wanted. This approach is somewhat risky if
the parent is going to return an exit status of zero. If the parent is
going to return a non-zero exit status, then this approach can lead to
quicker delivery into your maildrop.
-.Fi
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^%etcdir%/mts.conf~^nmh mts configuration file
^$HOME/\&.maildelivery~^The file controlling local delivery
^%etcdir%/maildelivery~^Rather than the standard file
^%mailspool%/$USER~^The default maildrop
-.Sa
+.fi
+
+.SH "SEE ALSO"
rcvdist(1), rcvpack(1), rcvstore(1), rcvtty(1), mh\-format(5)
-.De
-`\-noverbose'
-.Ds
-`\-nosuppressdup'
-.Ds
-`\-maildelivery \&.maildelivery'
-.Ds
-`\-mailbox %mailspool%/$USER'
-.Ds
-`\-file' defaults to stdin
-.Ds
-`\-user' defaults to the current user
-.Co
+
+.SH DEFAULTS
+.nf
+.RB ` \-noverbose '
+.RB ` \-nosuppressdup '
+.RB ` \-maildelivery "' defaults to $HOME/\&.maildelivery"
+.RB ` \-mailbox "' deaults to %mailspool%/$USER"
+.RB ` \-file "' defaults to stdin"
+.RB ` \-user "' defaults to the current user"
+.fi
+
+.SH CONTEXT
None
-.Hi
-\fISlocal\fP was originally designed to be backward-compatible with
-the \fImaildelivery\fP facility provided by \fIMMDF-II\fP. Thus, the
-\fI\&.maildelivery\fP file syntax is somewhat limited. But \fIslocal\fP
-has been modified and extended, so that is it no longer compatible with
-\fIMMDF-II\fP.
-In addition to an exit status of zero, the \fIMMDF\fR values \fIRP_MOK\fR
-(32) and \fIRP_OK\fR (9) mean that the message has been fully delivered.
+.SH HISTORY
+.B Slocal
+was originally designed to be backward-compatible with
+the
+.B maildelivery
+facility provided by
+.BR MMDF-II .
+Thus, the
+.RI \*(lq \&.maildelivery \*(rq
+file syntax is somewhat limited. But
+.B slocal
+has been modified and extended, so that is it no longer compatible with
+.BR MMDF-II .
+.PP
+In addition to an exit status of zero, the
+.B MMDF
+values
+.B RP_MOK
+(32) and
+.B RP_OK
+(9) mean that the message has been fully delivered.
Any other non-zero exit status, including abnormal termination, is
-interpreted as the \fIMMDF\fR value \fIRP_MECH\fR (200), which means
+interpreted as the
+.B MMDF
+value
+.B RP_MECH
+(200), which means
\*(lquse an alternate route\*(rq (deliver the message to the maildrop).
-.Bu
-Only two return codes are meaningful, others should be.
-\fISlocal\fP was originally designed to be backwards-compatible with the
-\fImaildelivery\fP functionality provided by \fBMMDF-II\fP.
+.SH BUGS
+Only two return codes are meaningful, others should be.
+.PP
+.B Slocal
+was originally designed to be backwards-compatible with the
+.B maildelivery
+functionality provided by
+.BR MMDF-II .
.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
.TH SORTM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
sortm \- sort messages
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-sortm
-\%[+folder] \%[msgs]
-\%[\-datefield\ field]
-\%[\-textfield\ field]
-.br
-\%[\-notextfield]
-\%[\-limit days] \%[\-nolimit]
-\%[\-verbose]
-.br
-\%[\-noverbose]
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B sortm
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-datefield
+.IR field ]
+.RB [ \-textfield
+.IR field ]
+.RB [ \-notextfield ]
+.RB [ \-limit
+.IR days ]
+.RB [ \-nolimit ]
+.RB [ \-verbose " | " \-noverbose ]
+.RB [ \-version ]
+.RB [ \-help ]
.SH DESCRIPTION
-\fISortm\fR sorts the specified messages in the named folder according
+.B Sortm
+sorts the specified messages in the named folder according
to the chronological order of the \*(lqDate:\*(rq field of each message.
-
-The `\-verbose' switch directs \fIsortm\fR to tell the user the general
+.PP
+The
+.B \-verbose
+switch directs
+.B sortm
+to tell the user the general
actions that it is taking to place the folder in sorted order.
-
-The `\-datefield\ field' switch tells \fIsortm\fR the name of the field to
+.PP
+The
+.B \-datefield
+.I field
+switch tells
+.B sortm
+the name of the field to
use when making the date comparison. If the user has a special field in
each message, such as \*(lqBB\-Posted:\*(rq or \*(lqDelivery\-Date:\*(rq,
-then the `\-datefield' switch can be used to direct \fIsortm\fR which
-field to examine.
-
-The `\-textfield\ field' switch causes \fIsortm\fR to sort messages
+then the
+.B \-datefield
+switch can be used to direct
+.B sortm
+which field to examine.
+.PP
+The
+.B \-textfield
+.I field
+switch causes
+.B sortm
+to sort messages
by the specified text field. If this field is \*(lqsubject\*(rq, any
leading "re:" is stripped off. In any case, all characters except
letters and numbers are stripped and the resulting strings are sorted
datefield\-major, textfield\-minor, using a case insensitive comparison.
-
-With `\-textfield\ field', if `\-limit\ days' is specified, messages
+.PP
+With
+.B \-textfield
+.IR field ,
+if
+.B \-limit
+.I days
+is specified, messages
with similar textfields that are dated within `days' of each other
-appear together. Specifying `\-nolimit' makes the limit infinity.
-With `\-limit 0', the sort is instead made textfield\-major, date\-minor.
-
-.\"Ex
+appear together. Specifying
+.B \-nolimit
+makes the limit infinity.
+With
+.B \-limit
+.IR 0 ,
+the sort is instead made textfield\-major, date\-minor.
+.PP
For example, to order a folder by date-major, subject-minor, use:
-
-.ti +.5i
+.PP
+.RS 5
sortm -textfield subject +folder
+.RE
-.Fi
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName 'u
^Path:~^To determine the user's nmh directory
-.Ps
^Current\-Folder:~^To find the default current folder
-.Sa
-folder (1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to all
-.Ds
-`\-datefield date'
-.Ds
-`\-notextfield'
-.Ds
-`\-noverbose'
-.Ds
-`\-nolimit'
-.Co
+.fi
+
+.SH "SEE ALSO"
+folder(1)
+
+.SH DEFAULTS
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msgs"' defaults to all"
+.RB ` \-datefield "' defaults to date"
+.RB ` \-notextfield '
+.RB ` \-noverbose '
+.RB ` \-nolimit '
+.fi
+
+.SH CONTEXT
If a folder is given, it will become the current folder. If the current
-message is moved, \fIsortm\fR will preserve its status as current.
-.Hi
-Timezones used to be ignored when comparing dates: they aren't any more.
+message is moved,
+.B sortm
+ will preserve its status as current.
+.SH HISTORY
+Timezones used to be ignored when comparing dates: they aren't any more.
+.PP
Messages which were in the folder, but not specified by `msgs', used to
be moved to the end of the folder; now such messages are left untouched.
-
-\fISortm\fP sometimes did not preserve the message numbering in a folder
+.PP
+.B Sortm
+sometimes did not preserve the message numbering in a folder
(e.g., messages 1, 3, and 5, might have been renumbered to 1, 2, 3 after
sorting). This was a bug, and has been fixed. To compress the message
-numbering in a folder, use \*(lq\fIfolder\ \-pack\fR\|\*(rq as always.
-.Bu
-If \fIsortm\fR encounters a message without a date\-field, or if the
-message has a date\-field that \fIsortm\fR cannot parse, then \fIsortm\fR
+numbering in a folder, use
+.RB \*(lq "folder\ \-pack" \*(rq
+as always.
+
+.SH BUGS
+If
+.B sortm
+encounters a message without a date\-field, or if the
+message has a date\-field that
+.B sortm
+cannot parse, then
+.B sortm
attempts to keep the message in the same relative position. This does
not always work. For instance, if the first message encountered lacks
a date which can be parsed, then it will usually be placed at the end
of the messages being sorted.
-
-When \fIsortm\fR complains about a message which it can't temporally
-order, it complains about the message number \fIprior\fR to sorting.
-It should indicate what the message number will be \fIafter\fR sorting.
-.En
+.PP
+When
+.B sortm
+complains about a message which it can't temporally
+order, it complains about the message number
+.B prior
+to sorting.
+It should indicate what the message number will be
+.B after
+sorting.
.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
.TH WHATNOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
whatnow \- prompting front-end for sending messages
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-whatnow
-\%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
-.br
-\%[\-nodraftfolder]
-\%[\-editor\ editor] \%[\-noedit]
-.br
-\%[\-prompt\ string]
-\%[file]
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B whatnow
+.RB [ \-draftfolder
+.IR +folder ]
+.RB [ \-draftmessage
+.IR msg ]
+.RB [ \-nodraftfolder ]
+.RB [ \-editor
+.IR editor ]
+.RB [ \-noedit ]
+.RB [ \-prompt
+.IR string ]
+.RI [ file ]
+.RB [ \-version ]
+.RB [ \-help ]
.SH DESCRIPTION
-\fIWhatnow\fR is the default program that queries the user about
+.B Whatnow
+is the default program that queries the user about
the disposition of a composed draft. It is normally automatically
-invoked by one of the \fInmh\fR commands \fIcomp\fR, \fIdist\fR,
-\fIforw\fR, or \fIrepl\fR after the initial edit.
-
-When started, the editor is started on the draft (unless `\-noedit'
+invoked by one of the
+.B nmh
+commands
+.BR comp ,
+.BR dist ,
+.BR forw ,
+or
+.B repl
+after the initial edit.
+.PP
+When started, the editor is started on the draft (unless
+.B \-noedit
is given, in which case the initial edit is suppressed). Then,
-\fIwhatnow\fR repetitively prompts the user with \*(lqWhat now?\*(rq
+.B whatnow
+repetitively prompts the user with \*(lqWhat now?\*(rq
and awaits a response. The valid responses are:
-
-.nf
-.in .5i
-.ta \w'\fBrefile +folder\fR 'u
-^\fBedit\fR~^re\-edit using the same editor that was used on the
-^~^preceding round unless a profile entry
-^~^\*(lq<lasteditor>\-next: <editor>\*(rq names an alternate editor
-^\fBedit <editor>\fR~^invoke <editor> for further editing
-^\fBrefile +folder\fR~^refile the draft into the given folder
-^\fBmime\fR~^process the draft as MIME composition file using
-^~^the "buildmimeproc" command (mhbuild by default)
-^\fBdisplay\fR~^list the message being distributed/replied\-to
-^~^on the terminal
-^\fBlist\fR~^list the draft on the terminal
-^\fBsend\fR~^send the message
-^\fBsend \-watch\fR~^send the message and monitor the delivery process
-^\fBpush\fR~^send the message in the background
-^\fBwhom\fR~^list the addresses that the message will go to
-^\fBwhom \-check\fR~^list the addresses and verify that they are
-^~^acceptable to the transport service
-^\fBquit\fR~^preserve the draft and exit
-^\fBquit \-delete\fR~^delete the draft and exit
-^\fBdelete\fR~^delete the draft and exit
-.fi
-.re
-
+.PP
+.RS 5
+.TP \w'refilezzfolderz'u
+.B edit
+re\-edit using the same editor that was used on the
+preceding round unless a profile entry
+\*(lq<lasteditor>\-next: <editor>\*(rq names an alternate editor
+.TP \w'refilezzfolderz'u
+.B edit <editor>
+invoke <editor> for further editing
+.TP \w'refilezzfolderz'u
+.B refile +folder
+refile the draft into the given folder
+.TP \w'refilezzfolderz'u
+.B mime
+process the draft as MIME composition file using
+the
+.I buildmimeproc
+command
+.RB ( mhbuild
+by default)
+.TP \w'refilezzfolderz'u
+.B display
+list the message being distributed/replied\-to
+on the terminal
+.TP \w'refilezzfolderz'u
+.B list
+list the draft on the terminal
+.TP \w'refilezzfolderz'u
+.B send
+send the message
+.TP \w'refilezzfolderz'u
+.B send \-watch
+send the message and monitor the delivery process
+.TP \w'refilezzfolderz'u
+.B push
+send the message in the background
+.TP \w'refilezzfolderz'u
+.B whom
+list the addresses that the message will go to
+.TP \w'refilezzfolderz'u
+.B whom \-check
+list the addresses and verify that they are
+acceptable to the transport service
+.TP \w'refilezzfolderz'u
+.B quit
+preserve the draft and exit
+.TP \w'refilezzfolderz'u
+.B quit \-delete
+delete the draft and exit
+.TP \w'refilezzfolderz'u
+.B delete
+delete the draft and exit
+.RE
+.PP
When entering your response, you need only type enough characters
to uniquely identify the response.
-
-For the \fBedit\fR response, any valid switch to the editor is valid.
-
-For the \fBsend\fR and \fBpush\fR responses, any valid switch to
-\fIsend\fR\0(1) are valid (as \fBpush\fR merely invokes \fIsend\fR
-with the `\-push' option).
-
-For the \fBwhom\fR response, any valid switch to \fIwhom\fR\0(1)
+.PP
+For the
+.B edit
+response, any valid switch to the editor is valid.
+.PP
+For the
+.B send
+and
+.B push
+responses, any valid switch to
+.BR send (1)
+is valid (as
+.B push
+merely invokes
+.B send
+with the
+.B \-push
+option).
+.PP
+For the
+.B whom
+response, any valid switch to
+.BR whom (1)
is valid.
-
-For the \fBrefile\fR response, any valid switch to the \fIfileproc\fR
+.PP
+For the
+.B refile
+response, any valid switch to the
+.I fileproc
is valid.
-
-For the \fBdisplay\fR and \fBlist\fR responses, any valid argument to
-the \fIlproc\fR is valid. If any non\-switch arguments are present, then
+.PP
+For the
+.B display
+and
+.B list
+responses, any valid argument to
+the
+.I lproc
+is valid. If any non\-switch arguments are present, then
the pathname of the draft will be excluded from the argument list given
-to the \fIlproc\fR (this is useful for listing another \fInmh\fR message).
-
-See \fImh\-profile\fR\0(5) for further information about how editors
-are used by nmh. It also discusses how environment variables can be
-used to direct \fIwhatnow\fR's actions in complex ways.
-
-The `\-prompt\ string' switch sets the prompting string for \fIwhatnow\fR.
-
-The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
-the \fInmh\fR draft folder facility. This is an advanced (and highly
-useful) feature. Consult the \fImh-draft\fR(5) man page for more
+to the
+.I lproc
+(this is useful for listing another
+.B nmh
+message).
+.PP
+See
+.BR mh\-profile (5)
+for further information about how editors
+are used by
+.BR nmh .
+It also discusses how environment variables can be
+used to direct
+.BR whatnow 's
+actions in complex ways.
+.PP
+The
+.B \-prompt
+.I string
+switch sets the prompting string for
+.BR whatnow .
+.PP
+The
+.B \-draftfolder
+.I +folder
+and
+.B \-draftmessage
+.I msg
+switches invoke
+the
+.B nmh
+draft folder facility. This is an advanced (and highly
+useful) feature. Consult the
+.BR mh-draft (5)
+man page for more
information.
-.Fi
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
^<mh\-dir>/draft~^The draft file
-.Pr
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName 'u
^Path:~^To determine the user's nmh directory
-.Ps
^Draft\-Folder:~^To find the default draft\-folder
-.Ps
^Editor:~^To override the default editor
-.Ps
^<lasteditor>\-next:~^To name an editor to be used after exit
^~^from <lasteditor>
-.Ps
^automimeproc:~^If value is 1, and the draft is a MIME
^~^composition file, then automatically call
^~^buildmimeproc prior to sending.
-.Ps
^buildmimeproc:~^Program to translate MIME composition files
-.Ps
^fileproc:~^Program to refile the message
-.Ps
^lproc:~^Program to list the contents of a message
-.Ps
^sendproc:~^Program to use to send the message
-.Ps
^whomproc:~^Program to determine who a message would go to
-.Sa
-send(1), whom(1)
-.De
-`\-prompt\ \*(lqWhat\ Now?\ \*(rq'
-.Co
-None
-.Bu
-The argument to the `\-prompt' switch must be interpreted as a single
-token by the shell that invokes \fIwhatnow\fR. Therefore, one must
-usually place the argument to this switch inside double\-quotes.
+.fi
-If the initial edit fails, \fIwhatnow\fR deletes your draft (by renaming
-it with a leading comma); failure of a later edit preserves the draft.
+.SH "SEE ALSO"
+send(1), whom(1)
-If the \fIbuildmimeproc\fR fails (returns a nonzero status), \fIwhatnow\fR
-simply prints a \*(lqWhat now?\*(rq prompt. \fIwhatnow\fR depends on the
-\fIbuildmimeproc\fR to tell the user that something went wrong.
+.SH DEFAULTS
+.nf
+.RB ` \-prompt "' defaults to \*(lqWhat\ Now?\ \*(rq"
+.fi
-If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIcomp\fR, \fIdist\fP,
-\fIforw\fP, and \fIrepl\fP use a built\-in \fIwhatnow\fR, and do not
-actually run the \fIwhatnow\fR program. Hence, if you define your own
-\fIwhatnowproc\fR, don't call it \fIwhatnow\fR since it won't be run.
+.SH CONTEXT
+None
-If \fIsendproc\fR is \fIsend\fR, then \fIwhatnow\fR uses a built\-in
-\fIsend\fR, it does not actually run the \fIsend\fR program. Hence, if
-you define your own \fIsendproc\fR, don't call it \fIsend\fR since
-\fIwhatnow\fR won't run it.
-.En
+.SH BUGS
+The argument to the
+.B \-prompt
+switch must be interpreted as a single
+token by the shell that invokes
+.BR whatnow .
+Therefore, one must
+usually place the argument to this switch inside double\-quotes.
+.PP
+If the initial edit fails,
+.B whatnow
+deletes your draft (by renaming
+it with a leading comma); failure of a later edit preserves the draft.
+.PP
+If the
+.I buildmimeproc
+fails (returns a nonzero status),
+.B whatnow
+simply prints a \*(lqWhat now?\*(rq prompt.
+.B whatnow
+depends on the
+.I buildmimeproc
+to tell the user that something went wrong.
+.PP
+If
+.I whatnowproc
+is
+.BR whatnow ,
+then
+.BR comp ,
+.BR dist ,
+.BR forw ,
+and
+.B repl
+use a built\-in
+.BR whatnow ,
+and do not actually run the
+.B whatnow
+program. Hence, if you define your own
+.IR whatnowproc ,
+don't call it
+.B whatnow
+since it won't be run.
+.PP
+If
+.I sendproc
+is
+.BR send ,
+then
+.B whatnow
+uses a built\-in
+.BR send ,
+it does not actually run the
+.B send
+program. Hence, if
+you define your own
+.IR sendproc ,
+don't call it
+.B send
+since
+.B whatnow
+won't run it.
.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
.TH WHOM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
whom \- report to whom a message would go
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-whom
-\%[\-alias\ aliasfile]
-\%[\-check] \%[\-nocheck]
-\%[\-draft]
-.br
-\%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
-.br
-\%[\-nodraftfolder]
-\%[file]
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B whom
+.RB [ \-alias
+.IR aliasfile ]
+.RB [ \-check " | " \-nocheck ]
+.RB [ \-draft ]
+.RB [ \-draftfolder
+.IR +folder ]
+.RB [ \-draftmessage
+.IR msg ]
+.RB [ \-nodraftfolder ]
+.RI [ file ]
+.RB [ \-version ]
+.RB [ \-help ]
.SH DESCRIPTION
-\fIWhom\fR is used to expand the headers of a message into a set of
+.B Whom
+is used to expand the headers of a message into a set of
addresses and optionally verify that those addresses are deliverable at
-that time (if `\-check' is given).
-
-The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
-the \fInmh\fR draft folder facility. This is an advanced (and highly
-useful) feature. Consult the \fImh-draft\fR(5) man page for more
-information.
-
+that time (if
+.B \-check
+is given).
+.PP
+The
+.B \-draftfolder
+.I +folder
+and
+.B \-draftmessage
+.I msg
+switches invoke
+the
+.B nmh
+draft folder facility. This is an advanced (and highly
+useful) feature. Consult the
+.BR mh-draft (5)
+man page for more information.
+.PP
The files specified by the profile entry \*(lqAliasfile:\*(rq and any
-additional alias files given by the `\-alias aliasfile' switch will be
-read (more than one file, each preceded by `\-alias', can be named).
-See \fImh\-alias\fR\0(5) for more information.
+additional alias files given by the
+.B \-alias
+.I aliasfile
+switch will be
+read (more than one file, each preceded by
+.BR \-alias ,
+can be named). See
+.BR mh\-alias (5)
+for more information.
-.Fi
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName 'u
^Path:~^To determine the user's nmh directory
-.Ps
^Draft\-Folder:~^To find the default draft\-folder
-.Ps
^Aliasfile:~^For a default alias file
-.Ps
^postproc:~^Program to post the message
-.Sa
+.fi
+
+.SH "SEE ALSO"
mh\-alias(5), post(8)
-.De
-`file' defaults to <mh\-dir>/draft
-.Ds
-`\-nocheck'
-.Ds
-`\-alias %etcdir%/MailAliases'
-.Co
+
+.SH DEFAULTS
+.nf
+.RB ` file "' defaults to <mh\-dir>/draft"
+.RB ` \-nocheck '
+.RB ` \-alias "' defaults to %etcdir%/MailAliases"
+.fi
+
+.SH CONTEXT
None
-.Bu
-With the `\-check' option, \fIwhom\fR makes no guarantees that the
+
+.SH BUGS
+With the
+.B \-check
+option,
+.B whom
+makes no guarantees that the
addresses listed as being ok are really deliverable, rather, an address
-being listed as ok means that at the time that \fIwhom\fR was run
+being listed as ok means that at the time that
+.B whom
+was run
the address was thought to be deliverable by the transport service.
For local addresses, this is absolute; for network addresses, it means
that the host is known; for uucp addresses, it (often) means that the
-\fIUUCP\fR network is available for use.
-.En
+.B UUCP
+network is available for use.
projects / mmh / commitdiff