Fix some typos in the comments.

[nmh] / man / nmh.man

diff --git a/man/nmh.man b/man/nmh.man
index 6b1dfc0510e5aa40c11ec5fab81f5e90e3ec20f6..fd1870892012a8e69b6a31d88fbf725ceb5e7807 100644 (file)
--- a/man/nmh.man
+++ b/man/nmh.man
@@ -1,235 +1,580 @@
+.TH NMH %manext7% "September 26, 2016" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.\" include the -mh macro file
-.so %etcdir%/tmac.h
+.\" Register 'tt' contains the indent for .TP in the COMMANDS section:
+.nr tt \w'\fImh-sequence\fR(5)\0\0'u

 .\"
 .\"

-.if '\*(ZZ'-man' \{\
-.TH NMH %manext1% MH.6.8 [%nmhversion%]

 .SH NAME
 nmh \- new MH message system
 .SH NAME
 nmh \- new MH message system

-.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-any \fInmh\fR command
-.in -.5i

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fInmh\fR is the name of a powerful message handling system.  Rather than
-being a single comprehensive program, \fInmh\fR consists of a collection
+.B nmh
+is the name of a powerful message handling system.  Rather than
+being a single comprehensive program,
+.B nmh
+consists of a collection

 of fairly simple single-purpose programs to send, retrieve, save,
 and manipulate messages.
 of fairly simple single-purpose programs to send, retrieve, save,
 and manipulate messages.

-
-Unlike most mail clients in UNIX, \fInmh\fR is not a closed system which
+.PP
+Unlike most mail clients in UNIX,
+.B nmh
+is not a closed system which

 must be explicitly run, then exited when you wish to return to the shell.
 must be explicitly run, then exited when you wish to return to the shell.

-You may freely intersperse \fInmh\fR commands with other shell commands,
+You may freely intersperse
+.B nmh
+commands with other shell commands,

 allowing you to read and answer your mail while you have (for example)
 a compilation running, or search for a file or run programs as needed
 to find the answer to someone's question before answering their mail.
 allowing you to read and answer your mail while you have (for example)
 a compilation running, or search for a file or run programs as needed
 to find the answer to someone's question before answering their mail.

-
+.PP

 The rest of this manual entry is a quick tutorial which will teach you
 The rest of this manual entry is a quick tutorial which will teach you

-the basics of \fInmh\fR.  You should read the manual entries for the
+the basics of
+.BR nmh .
+You should read the manual entries for the

 individual programs for complete documentation.
 individual programs for complete documentation.

-
-To get started using \fInmh\fR, put the directory \fB%bindir%\fR on your
-\fB$PATH\fR.  This is best done in one of the files: \fB\&.profile\fR,
-\fB\&.login\fR, or \fB\&.cshrc\fR in your home directory.  (Check the
-manual entry for the shell you use, in case you don't know how to
-do this.)  Run the \fIinc\fR command.  If you've never used \fInmh\fR
+.PP
+To get started using
+.BR nmh ,
+put the directory
+\*(lq%bindir%\*(rq
+in your
+.BR $PATH .
+Run the
+.B install-mh
+command.  If you've never used
+.B nmh

 before, it will create the necessary default files and directories after
 asking you if you wish it to do so.
 before, it will create the necessary default files and directories after
 asking you if you wish it to do so.

-
-\fIinc\fR moves mail from your system maildrop into your \fInmh\fR
-`+inbox' folder, breaking it up into separate files and converting it
-to \fInmh\fR format as it goes.  It prints one line for each message it
+.PP
+.B inc
+moves mail from your system maildrop into your
+.B nmh
+\*(lq+inbox\*(rq
+folder, breaking it up into separate files and converting it
+to
+.B nmh
+format as it goes.  It prints one line for each message it

 processes, containing the from field, the subject field and as much of
 the first line of the message as will fit.  It leaves the first message
 processes, containing the from field, the subject field and as much of
 the first line of the message as will fit.  It leaves the first message

-it processes as your current message.  You'll need to run \fIinc\fR each
-time you wish to incorporate new mail into your \fInmh\fR file.
-
-\fIscan\fR prints a list of the messages in your current folder.
-
-The commands: \fIshow\fR, \fInext\fR, and \fIprev\fR are used to read
-specific messages from the current folder.  \fIshow\fR displays the
+it processes as your current message.  You'll need to run
+.B inc
+each
+time you wish to incorporate new mail into your
+.B nmh
+file.
+.PP
+.B scan
+prints a list of the messages in your current folder.
+.PP
+The commands
+.BR show ,
+.BR next ,
+and
+.B prev
+are used to read
+specific messages from the current folder.
+.B show
+displays the

 current message, or a specific message, which may be specified by its
 current message, or a specific message, which may be specified by its

-number, which you pass as an argument to \fIshow\fR.  \fInext\fR and
-\fIprev\fR display, respectively, the message numerically after or before
+number, which you pass as an argument to
+.BR show .
+.B next
+and
+.B prev
+display, respectively, the message numerically after or before

 the current message.  In all cases, the message displayed becomes the
 the current message.  In all cases, the message displayed becomes the

-current message.  If there is no current message, \fIshow\fR may be
-called with an argument, or \fInext\fR may be used to advance to the
+current message.  If there is no current message,
+.B show
+may be
+called with an argument, or
+.B next
+may be used to advance to the

 first message.
 first message.

-
-\fIrmm\fR (remove message) deletes the current message.  It may be called
+.PP
+.B rmm
+(remove message) deletes the current message.  It may be called

 with message numbers passed as arguments, to delete specific messages.
 with message numbers passed as arguments, to delete specific messages.

-
-\fIrepl\fR is used to respond to the current message (by default).
+.PP
+.B repl
+is used to respond to the current message (by default).

 It places you in the editor with a prototype response form.  While you're
 in the editor, you may peruse the item you're responding to by reading
 It places you in the editor with a prototype response form.  While you're
 in the editor, you may peruse the item you're responding to by reading

-the file \fB@\fR.  After completing your response, type \fBl\fR to list
-(review) it, or \fBs\fR to send it.
-
-\fIcomp\fR allows you to compose a message by putting you in the editor
-on a prototype message form, and then lets you send it.
-
-All the \fInmh\fR commands may be run with the single argument: `\-help',
-which causes them to print a list of the arguments they may be invoked
-with and then exit.
-
-All the \fInmh\fR commands may be run with the single argument:
-`\-version', which cause them to print the version number of the \fInmh\fR
+the file
+.BR @ .
+After completing your response, type
+\*(lql\*(rq
+to
+.B list
+(review) it, or
+\*(lqs\*(rq
+to
+.B send
+it.
+.PP
+.B comp
+allows you to compose a message by putting you in the editor
+on a prototype message form, and then lets you send it via the
+.B whatnow
+command.
+.B whatnow
+also supports easy\-to\-use management of MIME attachments via
+its
+.B attach
+and related responses, as described in its man page.
+.PP
+.B nmh
+command arguments are usually called
+.IR switches .
+Some switches have a corresponding \*(lq\-no\*(rq switch, which
+negates all previous occurrences of that switch on the command line.
+This allows a user to conveniently override, on the command line, a
+switch in their profile.  Switches may be abbreviated as long as there
+is no ambiguity with another switch of the same command.  To avoid
+ambiguity with any switches that may be added in the future, it is
+recommended that full switch names be used in durable code such as
+shell scripts, functions, and aliases.
+.PP
+Each
+.B nmh
+command may be run with the single switch
+.BR \-help ,
+which causes it to print its available switches, along with any
+profile components that apply, and then exit.
+.PP
+All the
+.B nmh
+commands may be run with the single switch
+.BR \-version ,
+which causes them to print the version number of the
+.B nmh

 distribution, and then exit.
 distribution, and then exit.

-
-Commands which take a message number as an argument (\fIscan\fR,
-\fIshow\fR, \fIrepl\fR, ...)  also take one of the words: \fIfirst\fR,
-\fIprev\fR, \fIcur\fR, \fInext\fR, or \fIlast\fR to indicate
+.PP
+Commands which take a message number as an argument
+.RB ( scan ,
+.BR show ,
+.BR repl ,
+\&...)  also take one of the words \*(lqfirst\*(rq,
+\*(lqprev\*(rq, \*(lqcur\*(rq, \*(lqnext\*(rq, or \*(lqlast\*(rq to indicate

 (respectively) the first, previous, current, next, or last message in
 the current folder (assuming they are defined).
 (respectively) the first, previous, current, next, or last message in
 the current folder (assuming they are defined).

-
-Commands which take a range of message numbers (\fIrmm\fR, \fIscan\fR,
-\fIshow\fR, ...)  also take any of the abbreviations:
-.sp
-.in +5
-.ti -3
-.I <num1>-<num2>
-- Indicates all messages in the range <num1> to <num2>, inclusive. The range
-.B must
-be nonempty.
-.sp
-.ti -3
-.I <num>:+N
-.ti -3
-.I <num>:-N
-- Up to
+As a shorthand, \*(lq\&.\*(rq is equivalent to \*(lqcur\*(rq.
+.PP
+Commands which take a range of message numbers
+.RB ( rmm ,
+.BR scan ,
+.BR show ,
+\&...)  also take any of the abbreviations:
+.TP \n(ttu
+.IR <num1> - <num2>
+Indicates all messages in the range <num1> to <num2>, inclusive.
+The range must be nonempty.
+.TP
+.RI all
+Indicates all messages, i.e.,
+.IR first - last .
+.TP
+.IR <num> :+ N
+.PD 0
+.TP
+.IR <num> :\-N
+Up to

 .I N
 messages beginning with (or ending with) message
 .I N
 messages beginning with (or ending with) message

-.I num.
+.IR num .

 .I Num
 .I Num

-may be any of the pre-defined symbols:
-.I first, prev, cur, next
+may be any of the pre-defined symbols
+.BR first ,
+.BR prev ,
+.BR cur ,
+.B next

 or
 or

-.I last.
-.sp
-.ti -3
-.I first:N
-.ti -3
-.I prev:N
-.ti -3
-.I next:N
-.ti -3
-.I last:N
-- The first, previous, next or last
-.I N
+.BR last .
+.PD
+.TP
+.RI first: N
+.PD 0
+.TP
+.RI prev: N
+.TP
+.RI next: N
+.TP
+.RI last: N
+The first, previous, next or last

 messages, if they exist.
 messages, if they exist.

-.in -5
-
+.PD
+.PP
+Commands that take a folder name
+.RB ( inc ,
+.BR refile ,
+.BR scan,
+\&...) accept the folder name in two formats:  \*(lq+folder\*(rq or
+\*(lq@folder\*(rq.  In both cases, \*(lqfolder\*(rq can be a
+\*(lq/\*(rq-separated path, e.g. \*(lqfoo/bar\*(rq.  \*(lq+folder\*(rq
+specifies a directory path to a folder.  If \*(lqfolder\*(rq starts
+with \*(lq/\*(rq then it's an absolute path from the root directory.
+If it is \*(lq.\*(rq or \*(lq..\*(rq, or starts with \*(lq./\*(rq or
+\*(lq../\*(rq, then it's relative to the current working directory.
+Otherwise it's relative to mh-profile(5)'s
+.RI \*(lq Path \*(rq,
+i.e. as given by
+.RB ` "mhpath +" `.
+\*(lq@folder\*(rq is a shorthand for \*(lq+curfolder/folder\*(rq; it's
+a relative path from the current folder.  \*(lqcurfolder\*(rq is given
+by
+.RB ` mhpath `.
+For example, assuming a
+.B Path
+profile component of Mail,
+.TP \n(ttu
+.PD 0
+.BI "scan " +inbox
+scans $HOME/Mail/inbox
+.TP
+.BI "scan " +work/todo
+scans $HOME/Mail/work/todo
+.TP
+.BI "scan " @todo
+scans $HOME/Mail/work/todo, if current folder is +work
+.TP
+.BI "refile " @../done
+refiles to $HOME/Mail/work/done, if the current folder is +work/todo
+.TP
+.BI "scan " +/tmp
+scans /tmp
+.TP
+.BI "scan " +.
+scans the current directory
+.TP
+.BI "refile " @.
+refiles current message to end of current folder.
+.PD
+.PP

 There are many other possibilities such as creating multiple folders
 for different topics, and automatically refiling messages according to
 subject, source, destination, or content.  These are beyond the scope
 of this manual entry.
 There are many other possibilities such as creating multiple folders
 for different topics, and automatically refiling messages according to
 subject, source, destination, or content.  These are beyond the scope
 of this manual entry.

-
-Following is a list of all the \fInmh\fR commands:
-.\}
-
-.nf
-.in .5i
-.ta 1.5i
-^ali (1)~^\- list mail aliases
-^anno (1)~^\- annotate messages
-^burst (1)~^\- explode digests into messages
-^comp (1)~^\- compose a message 
-^dist (1)~^\- redistribute a message to additional addresses
-^flist (1)~^\- list folders that contain messages in given sequence(s)
-^flists (1)~^\- list all folders that contain messages in given sequence(s)
-^folder (1)~^\- set/list current folder/message
-^folders (1)~^\- list all folders
-^forw (1)~^\- forward messages
-^inc (1)~^\- incorporate new mail
-^mark (1)~^\- mark messages
-^mhbuild (1)~^\- translate MIME composition draft
-^mhl (1)~^\- produce formatted listings of nmh messages
-^mhlist (1)~^\- list information about content of MIME messages
-^mhmail (1)~^\- send or read mail
-^mhn (1)~^\- display/list/store/cache MIME messages
-^mhparam (1)~^\- print nmh profile components
-^mhpath (1)~^\- print full pathnames of nmh messages and folders
-^mhshow (1)~^\- display MIME messages
-^mhstore (1)~^\- store contents of MIME messages into files
-^msgchk (1)~^\- check for messages
-^msh (1)~^\- nmh shell (and BBoard reader)
-^next (1)~^\- show the next message
-^packf (1)~^\- compress a folder into a single file
-^pick (1)~^\- select messages by content
-^prev (1)~^\- show the previous message
-^prompter (1)~^\- prompting editor front end
-^rcvdist (1)~^\- asynchronously redistribute new mail
-^rcvpack (1)~^\- append message to file
-^rcvstore (1)~^\- asynchronously incorporate new mail
-^rcvtty  (1)~^\- report new mail
-^refile (1)~^\- file messages in other folders
-^repl (1)~^\- reply to a message
-^rmf (1)~^\- remove folder
-^rmm (1)~^\- remove messages
-^scan (1)~^\- produce a one line per message scan listing
-^send (1)~^\- send a message
-^sendfiles (1)~^\- send multiple files and directories in MIME message
-^show (1)~^\- show (display) messages
-^slocal (1)~^\- asynchronously filter and deliver new mail
-^sortm (1)~^\- sort messages
-^whatnow (1)~^\- prompting front\-end for send
-^whom (1)~^\- report to whom a message would go
-.if '\*(ZZ'-man' \{\
-.sp 1
-^mh\-alias (5)~^\- alias file for nmh message system
-^mh\-draft (5)~^\- draft folder facility
-^mh\-format (5)~^\- format file for nmh message system
-^mh\-mail (5)~^\- message format for nmh message system
-^mh\-profile (5)~^\- user customization for nmh message system
-^mh\-sequence (5)~^\- sequence specification for nmh message system
-.sp 1
-^ap (8)~^\- parse addresses 822\-style
-^conflict (8)~^\- search for alias/password conflicts
-^dp (8)~^\- parse dates 822\-style
-^fmtdump (8)~^\- decode \fInmh\fP format files
-^install\-mh (8)~^\- initialize the nmh environment
-^post (8)~^\- deliver a message
-.\}
-.fi
-.re
-
-.if '\*(ZZ'-man' \{\
-.Fi
-^%bindir%~^directory containing \fInmh\fR commands
-^%etcdir%~^directory containing \fInmh\fR format files
-^%libdir%~^\fInmh\fR library commands
-.Bu
-If problems are encountered with an \fInmh\fR program, the problems should
-be reported to the local maintainers of \fInmh\fR.  When doing this, the
-name of the program should be reported, along with the version information
-for the program.
-.br
-To find out what version of an \fInmh\fR program is being run, invoke
-the program with the `\-version' switch.  This information includes
-the version of \fInmh\fR, the host it was generated on, and the date the
-program was loaded.
-
-Send bug reports and suggestions to \fBnmh-workers@mhost.com\fR.
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
-^Path:~^To determine the user's nmh directory
-.\" .Ps
-.\" for each additional profile entry
-.\" .Sa
-.\" the see\-also's go here
-.\" .De
-.\" the first default goes here
-.\" .Ds
-.\" for each additional default
-.\" .Co
-.\" context changes go here
-.\" You can also have
-.\" .Hh \- the helpful hints section
-.\" .Hi \- the history section
-.\" .Bu \- the bugs section
-.En
-.\}
+.ne 4
+.SH COMMANDS
+.PP
+Following is a list of all the
+.B nmh
+commands, grouped loosely according to their role.
+.ne 4
+.SS
+Sending
+.TP \n(ttu
+.PD 0
+.IR comp (1)
+compose a message
+.TP
+.IR forw (1)
+forward messages
+.TP
+.IR repl (1)
+reply to a message
+.TP
+.IR whatnow (1)
+prompting front-end for send
+.PD
+.PP
+Note that although
+.B whatnow
+provides much of the primary
+.B nmh
+user interface for sending mail, it is almost never invoked manually,
+but rather is invoked indirectly by one of the above commands, after
+you've composed a message in your editor, and before you've decided to
+send it.  Here you can add attachments, check the recipient
+list, decide to quit and send it later, etc.
+.PP
+Related utilities:
+.TP \n(ttu
+.PD 0
+.IR ali (1)
+list mail aliases
+.TP
+.IR anno (1)
+annotate messages
+.TP
+.IR whom (1)
+report to whom a message would go
+.TP
+.IR dist (1)
+redistribute a message to additional addresses
+.PD
+.PP
+Advanced commands, only sometimes invoked directly:
+.TP \n(ttu
+.PD 0
+.IR mhbuild (1)
+translate MIME composition draft
+.TP
+.IR send (1)
+send a message
+.TP
+.IR sendfiles (1)
+send multiple files in a MIME message
+.PD
+.ne 4
+.SS
+Incorporating
+.TP \n(ttu
+.IR inc (1)
+incorporate new mail
+.PP
+Related utilities:
+.TP \n(ttu
+.PD 0
+.IR burst (1)
+explode digests into messages
+.TP
+.IR msgchk (1)
+check for messages
+.TP
+.IR rcvdist (1)
+asynchronously redistribute new mail
+.TP
+.IR rcvpack (1)
+append message to file
+.TP
+.IR rcvstore (1)
+asynchronously incorporate new mail
+.TP
+.IR slocal (1)
+asynchronously filter and deliver new mail
+.PD
+.ne 4
+.SS
+Viewing
+.TP \n(ttu
+.PD 0
+.IR next (1)
+show the next message
+.TP
+.IR prev (1)
+show the previous message
+.TP
+.IR show (1)
+show(display) messages
+.TP
+.IR scan (1)
+produce a one line per message scan listing
+.TP
+.IR fnext (1)
+select the next folder with new messages
+.TP
+.IR fprev (1)
+select the previous folder with new messages
+.PD
+.PP
+Related utilities, only sometimes invoked directly:
+.TP \n(ttu
+.PD 0
+.IR mhl (1)
+produce formatted listings of nmh messages
+.TP
+.IR mhlist (1)
+list information about content of MIME messages
+.TP
+.IR mhn (1)
+display/list/store/cache MIME messages
+.TP
+.IR mhshow (1)
+display MIME messages
+.TP
+.IR mhstore (1)
+store contents of MIME messages into files
+.PD
+.ne 4
+.SS
+Searching
+.PP
+Within a folder:
+.TP \n(ttu
+.IR pick (1)
+select messages by content
+.PP
+Across folders:
+.TP \n(ttu
+.PD 0
+.IR new (1)
+list folders with new messages
+.TP
+.IR unseen (1)
+list new messages in a give set of folders
+.TP
+.IR flist (1)
+list folders with messages in given sequence(s)
+.TP
+.IR flists (1)
+list all folders with messages in given sequence(s)
+.TP
+.IR folder (1)
+set/list current folder/message
+.TP
+.IR folders (1)
+list all folders
+.PD
+.ne 4
+.SS
+Organizing
+.TP \n(ttu
+.PD 0
+.IR mark (1)
+mark messages
+.TP
+.IR refile (1)
+file messages in other folders
+.TP
+.IR rmf (1)
+remove folder
+.TP
+.IR rmm (1)
+remove messages
+.TP
+.IR sortm (1)
+sort messages
+.PD
+.ne 4
+.SS
+Convenience Wrappers
+.TP \n(ttu
+.PD 0
+.IR mhmail (1)
+send or read mail
+.PD
+.ne 4
+.SS
+Utilities
+.TP \n(ttu
+.PD 0
+.IR mhfixmsg (1)
+rewrite MIME messages with various transformations
+.TP
+.IR mhparam (1)
+print nmh profile components
+.TP
+.IR mhpath (1)
+print full pathnames of nmh messages and folders
+.TP
+.IR packf (1)
+compress a folder into a single file
+.TP
+.IR prompter (1)
+prompting editor front end
+.TP
+.IR rcvtty (1)
+report new mail
+.PD
+.ne 4
+.SS
+Indirectly Invoked Commands
+.TP \n(ttu
+.PD 0
+.IR ap (8)
+parse addresses RFC 822\-style
+.TP
+.IR dp (8)
+parse dates RFC 822\-style
+.TP
+.IR fmtdump (8)
+decode
+.IR mh-format (5)
+files
+.TP
+.IR install\-mh (8)
+initialize the nmh environment
+.TP
+.IR post (8)
+deliver a message
+.PD
+.ne 4
+.SS
+Files Used by nmh Commands
+.TP \n(ttu
+.PD 0
+.IR mh\-alias (5)
+alias file for nmh message system
+.TP
+.IR mh\-format (5)
+format file for nmh message system
+.TP
+.IR mh\-profile (5)
+user customization for nmh message system
+.TP
+.IR mh\-tailor (5)
+mail transport customization for nmh message system
+.PD
+.ne 4
+.SS
+Formats
+.TP \n(ttu
+.PD 0
+.IR mh\-draft (5)
+draft folder facility
+.TP
+.IR mh\-folders (5)
+nmh message storage format specification
+.TP
+.IR mh\-mail (5)
+message format for nmh message system
+.TP
+.IR mh\-sequence (5)
+sequence specification for nmh message system
+.PD
+.ne 4
+.SH FILES
+.TP
+%bindir%
+contains
+.B nmh
+commands
+.TP
+%nmhetcdir%
+contains
+.B nmh
+format files
+.TP
+%nmhlibexecdir%
+contains
+.B nmh
+library commands
+.TP
+$HOME/\&.mh\-profile
+The user's nmh profile
+.ne 4
+.SH "SEE ALSO"
+.IR install-mh (1),
+.IR mh-profile (5),
+.IR mh-chart (7),
+.IR mh-mime (7)
+.ne 4
+.SH BUGS
+\" The contents of this section also appear in sbr/print_help.c .
+Send bug reports, questions, suggestions, and patches to
+.IR nmh-workers@nongnu.org .
+That mailing list is relatively quiet, so user questions are encouraged.
+Users are also encouraged to subscribe, and view the archives, at
+https://lists.gnu.org/mailman/listinfo/nmh-workers .
+.PP
+If problems are encountered with an
+.B nmh
+program, they should
+be reported to the local maintainers of
+.BR nmh ,
+if any, or to the mailing list noted above.
+When doing this, the name of the program should be reported, along
+with the version information for the program.
+.PP
+To find out what version of an
+.B nmh
+program is being run, invoke
+the program with the
+.B \-version
+switch.  This prints
+the version of
+.BR nmh ,
+the host it was compiled on, and the date the
+program was linked.
+.PP
+New releases and other information of potential interest are announced at http://www.nongnu.org/nmh/ .