.SH NAME
ali \- list mail aliases
.SH SYNOPSIS
+.HP 5
.B ali
.RB [ \-alias
.IR aliasfile ]
.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH ANNO %manext1% MH.6.8 [%nmhversion%]
+.TH ANNO %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
anno \- annotate messages
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-anno
-\%[+folder] \%[msgs]
-\%[\-component\ field]
-\%[\-inplace]
-.br
-\%[\-noinplace]
-\%[\-date] \%[\-nodate]
-\%[\-text\ body]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B anno
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-component
+.IR field ]
+.RB [ \-inplace " | " \-noinplace ]
+.RB [ \-date " | " \-nodate ]
+.RB [ \-version ]
+.RB [ \-help ]
+.RB [ \-text
+.IR body ]
.SH DESCRIPTION
-\fIAnno\fR annotates the specified messages in the named folder using
+.B Anno
+annotates the specified messages in the named folder using
the field and body.
-
-Usually, annotation is performed by the commands \fIdist\fR, \fIforw\fR,
-and \fIrepl\fR, if they are given the `\-anno' switch. This allows you
-to keep track of your distribution of, forwarding of, and replies to
-a message.
-
-By using \fIanno\fR, you can perform arbitrary annotations of your own.
+.PP
+Usually, annotation is performed by the commands
+.BR dist ,
+.BR forw ,
+.RB "and " repl ,
+if they are given the
+.B \-anno
+switch. This allows you to keep track of your distribution of,
+forwarding of, and replies to a message.
+.PP
+By using
+.BR anno ,
+you can perform arbitrary annotations of your own.
Each message selected will be annotated with the lines
-
+.PP
field:\ date
field:\ body
-
-The `\-nodate' switch inhibits the date annotation, leaving only the
+.PP
+The
+.B \-nodate
+switch inhibits the date annotation, leaving only the
body annotation.
-If a `\-component\ field' is not specified when \fIanno\fR is invoked,
-\fIanno\fR will prompt the user for the name of field for the annotation.
-
+If a
+.BI \-component " field"
+is not specified when
+.B anno
+is invoked,
+.B anno
+will prompt the user for the name of field for the annotation.
+.PP
The field specified should be a valid 822-style message field name,
which means that it should consist of alphanumerics (or dashes) only.
The body specified is arbitrary text.
-
-Normally \fIanno\fR does the annotation inplace in order to preserve
-any links to the message. You may change this by using the `\-noinplace'
+.PP
+Normally
+.B anno
+does the annotation inplace in order to preserve
+any links to the message. You may change this by using the
+.B \-noinplace
switch.
-.Fi
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+
+.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
-dist (1), forw (1), repl (1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to cur
-.Ds
-`\-inplace'
-.Ds
-`\-date'
-.Co
+
+.SH "SEE ALSO"
+dist(1), forw(1), repl(1)
+
+.SH "DEFAULTS"
+.nf
+.RI ` +folder "' defaults to the current folder"
+.RI ` msgs "' defaults to cur"
+.RB ` \-inplace '
+.RB ` \-date '
+
+.SH CONTEXT
If a folder is given, it will become the current folder. The first
message annotated will become the current message.
-.En
.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH AP %manext8% MH.6.8 [%nmhversion%]
+.TH AP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
ap \- parse addresses 822-style
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-%libdir%/ap
-\%[\-form\ formatfile]
-.br
-\%[\-format\ string]
-\%[\-normalize] \%[\-nonormalize]
-.br
-\%[\-width\ columns]
-addrs\ ...
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B %libdir%/ap
+.RB [ \-form
+.IR formatfile ]
+.RB [ \-format
+.IR string ]
+.RB [ \-normalize " | " \-nonormalize ]
+.RB [ \-width
+.IR columns ]
+.RB [ \-version ]
+.RB [ \-help ]
+.IR addrs " ..."
.SH DESCRIPTION
-\fIAp\fR is a program that parses addresses according to the ARPA
+.B Ap
+is a program that parses addresses according to the ARPA
Internet standard. It also understands many non\-standard formats.
-It is useful for seeing how \fInmh\fR will interpret an address.
-
-The \fIap\fR program treats each argument as one or more addresses, and
+It is useful for seeing how
+.B nmh
+will interpret an address.
+.PP
+The
+.B ap
+program treats each argument as one or more addresses, and
prints those addresses out in the official 822\-format. Hence, it is
usually best to enclose each argument in double\-quotes for the shell.
-
-To override the output format used by \fIap\fR, the `\-format\ string' or
-`\-format\ file' switches are used. This permits individual fields of
+.PP
+To override the output format used by
+.BR ap ,
+the
+.BI \-format " string"
+or
+.BI \-format " file"
+switches are used. This permits individual fields of
the address to be extracted with ease. The string is simply a format
-string, and the file is simply a format file. See \fImh\-format\fR\0(5)
+string, and the file is simply a format file. See
+.BR mh\-format (5)
for the details.
-
+.PP
In addition to the standard escapes,
-\fIap\fR also recognizes the following additional escape:
-.sp 1
+.B ap
+also recognizes the following additional escape:
+.PP
+.RS 5
+.fc ^ ~
.nf
.ta \w'Escape 'u +\w'Returns 'u
-\fIEscape\fR \fIReturns\fR \fIDescription\fR
+.I Escape Returns Description
error string A diagnostic if the parse failed
-.re
+.RE
.fi
-
-If the `\-normalize' switch is given, \fIap\fR will try to track down
+.PP
+If the
+.B \-normalize
+switch is given,
+.B ap
+will try to track down
the official hostname of the address.
-
-Here is the default format string used by \fIap\fR:
-
-.ti +.5i
+.PP
+Here is the default format string used by
+.BR ap :
+.PP
+.RS 5
%<{error}%{error}: %{text}%|%(putstr(proper{text}))%>
-
+.RE
+.PP
which says that if an error was detected, print the error, a `:', and
the address in error. Otherwise, output the 822\-proper format of
the address.
-.Fi
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
^%etcdir%/mts.conf~^nmh mts configuration file
-.Pr
+
+.SH "PROFILE COMPONENTS"
None
-.Sa
+
+.SH "SEE ALSO"
dp(8),
-.br
-\fIStandard for the Format of ARPA Internet Text Messages\fR (RFC\-822)
-.De
-`\-format' defaults as described above
-.Ds
-`\-normalize'
-.Ds
-`\-width' defaults to the width of the terminal
-.Co
+.IR "Standard for the Format of ARPA Internet Text Messages" " (RFC\-822)"
+
+.SH "DEFAULTS"
+.nf
+.RB ` \-format "' defaults as described above"
+.RB ` \-normalize '
+.RB ` \-width "' defaults to the width of the terminal"
+
+.SH CONTEXT
None
-.Bu
-The argument to the `\-format' switch must be interpreted as a single token
-by the shell that invokes \fIap\fR.
+
+.SH BUGS
+The argument to the
+.B \-format
+switch must be interpreted as a single token
+by the shell that invokes
+.BR ap .
Therefore,
one must usually place the argument to this switch inside double\-quotes.
-.En
.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH BURST %manext1% MH.6.8 [%nmhversion%]
+.TH BURST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
burst \- explode digests into messages
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-burst
-\%[+folder] \%[msgs]
-\%[\-inplace] \%[\-noinplace]
-\%[\-quiet]
-.br
-\%[\-noquiet]
-\%[\-verbose] \%[\-noverbose]
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B burst
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-inplace " | " \-noinplace ]
+.RB [ \-quiet " | " \-noquiet ]
+.RB [ \-verbose " | " \-noverbose ]
+.RB [ \-version ]
+.RB [ \-help ]
.SH DESCRIPTION
-\fIBurst\fR considers the specified messages in the named folder to be
+.B Burst
+considers the specified messages in the named folder to be
Internet digests, and explodes them in that folder.
-
-If `\-inplace' is given, each digest is replaced by the \*(lqtable
+.PP
+If
+.B \-inplace
+is given, each digest is replaced by the \*(lqtable
of contents\*(rq for the digest (the original digest is removed).
-\fIBurst\fR then renumbers all of the messages following the digest in the
+.B Burst
+then renumbers all of the messages following the digest in the
folder to make room for each of the messages contained within the digest.
These messages are placed immediately after the digest.
-
-If `\-noinplace' is given, each digest is preserved, no table of contents
+.PP
+If
+.B \-noinplace
+is given, each digest is preserved, no table of contents
is produced, and the messages contained within the digest are placed at
the end of the folder. Other messages are not tampered with in any way.
-
-The `\-quiet' switch directs \fIburst\fR to be silent about reporting
+.PP
+The
+.B \-quiet
+switch directs
+.B burst
+to be silent about reporting
messages that are not in digest format.
-
-The `\-verbose' switch directs \fIburst\fR to tell the user the general
+.PP
+The
+.B \-verbose
+switch directs
+.B burst
+to tell the user the general
actions that it is taking to explode the digest.
-
-It turns out that \fIburst\fR works equally well on forwarded messages
+.PP
+It turns out that
+.B burst
+works equally well on forwarded messages
and blind\-carbon\-copies as on Internet digests, provided that the
-former two were generated by \fIforw\fR or \fIsend\fR.
-.Fi
+former two were generated by
+.B forw
+or
+.BR send .
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+
+.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
^Msg\-Protect:~^To set mode when creating a new message
-.Sa
-\fIProposed Standard for Message Encapsulation\fR (RFC\-934),
-.br
-inc(1), msh(1), pack(1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to cur
-.Ds
-`\-noinplace'
-.Ds
-`\-noquiet'
-.Ds
-`\-noverbose'
-.Co
-If a folder is given, it will become the current folder. If `\-inplace'
+
+.SH "SEE ALSO"
+inc(1), msh(1), pack(1),
+.IR "Proposed Standard for Message Encapsulation" " (RFC\-934)"
+
+.SH "DEFAULTS"
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msgs "' defaults to cur"
+.RB ` \-noinplace '
+.RB ` \-noquiet '
+.RB ` \-noverbose '
+
+.SH CONTEXT
+If a folder is given, it will become the current folder. If
+.B \-inplace
is given, then the first message burst becomes the current message.
-This leaves the context ready for a \fIshow\fR of the table of contents
-of the digest, and a \fInext\fR to see the first message of the digest.
-If `\-noinplace' is given, then the first message extracted from the
+This leaves the context ready for a
+.B show
+of the table of contents
+of the digest, and a
+.B next
+to see the first message of the digest. If
+.B \-noinplace
+is given, then the first message extracted from the
first digest burst becomes the current message. This leaves the context
in a similar, but not identical, state to the context achieved when using
-`\-inplace'.
-.Bu
-The \fIburst\fR program enforces a limit on the number of messages which
-may be \fIburst\fR from a single message. This number is on the order
-of 1000 messages. There is usually no limit on the number of messages
-which may reside in the folder after the \fIburst\fRing.
+.BR \-inplace .
-Although \fIburst\fR uses a sophisticated algorithm to determine where
+.SH BUGS
+The
+.B burst
+program enforces a limit on the number of messages which
+may be
+.B burst
+from a single message. This number is on the order
+of 1000 messages. There is usually no limit on the number of messages
+which may reside in the folder after the
+.BR burst ing.
+.PP
+Although
+.B burst
+uses a sophisticated algorithm to determine where
one encapsulated message ends and another begins, not all digestifying
programs use an encapsulation algorithm. In degenerate cases, this
-usually results in \fIburst\fR finding an encapsulation boundary
+usually results in
+.B burst
+finding an encapsulation boundary
prematurely and splitting a single encapsulated message into two or
more messages. These erroneous digestifying programs should be fixed.
-
+.PP
Furthermore, any text which appears after the last encapsulated message
-is not placed in a separate message by \fIburst\fR. In the case of
+is not placed in a separate message by
+.BR burst .
+In the case of
digestified messages, this text is usually an \*(lqEnd of digest\*(rq
string. As a result of this possibly un\-friendly behavior on the
-part of \fIburst\fR, note that when the `\-inplace' option is used,
+part of
+.BR burst ,
+note that when the
+.B \-inplace
+option is used,
this trailing information is lost. In practice, this is not a problem
since correspondents usually place remarks in text prior to the first
encapsulated message, and this information is not lost.
-.En
projects / mmh / commitdiff