Expand the test of scan's -forma; fails on first attempt.

[nmh] / man / nmh.man

diff --git a/man/nmh.man b/man/nmh.man
index 0fccecedffa04b521db90da420b410554a11a185..0c32cde52f8511f247893457892fdc0a0dbff5e3 100644 (file)
--- a/man/nmh.man
+++ b/man/nmh.man
@@ -1,4 +1,4 @@
-.TH NMH %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH NMH %manext7% "September 26, 2016" "%nmhversion%"

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


@@ -7,10 +7,6 @@
 .\"
 .SH NAME
 nmh \- new MH message system
 .\"
 .SH NAME
 nmh \- new MH message system

-.SH SYNOPSIS
-any
-.B nmh
-command

 .SH DESCRIPTION
 .B nmh
 is the name of a powerful message handling system.  Rather than
 .SH DESCRIPTION
 .B nmh
 is the name of a powerful message handling system.  Rather than


@@ -43,9 +39,7 @@ put the directory
 \*(lq%bindir%\*(rq
 in your
 .BR $PATH .
 \*(lq%bindir%\*(rq
 in your
 .BR $PATH .

-(Check the
-manual entry for the shell you use if you don't know how to
-do this.)  Run the
+Run the

 .B install-mh
 command.  If you've never used
 .B nmh
 .B install-mh
 command.  If you've never used
 .B nmh


@@ -128,16 +122,28 @@ its
 .B attach
 and related responses, as described in its man page.
 .PP
 .B attach
 and related responses, as described in its man page.
 .PP

-All the

 .B nmh
 .B nmh

-commands may be run with the single argument
+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 ,
 .BR \-help ,

-which causes them to print a list of the arguments they may be invoked
-with and then exit.
+which causes it to print its available switches, along with any
+profile components that apply, and then exit.

 .PP
 All the
 .B nmh
 .PP
 All the
 .B nmh

-commands may be run with the single argument
+commands may be run with the single switch

 .BR \-version ,
 which causes them to print the version number of the
 .B nmh
 .BR \-version ,
 which causes them to print the version number of the
 .B nmh


@@ -151,6 +157,7 @@ Commands which take a message number as an argument
 \*(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).
 \*(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).

+As a shorthand, \*(lq\&.\*(rq is equivalent to \*(lqcur\*(rq.

 .PP
 Commands which take a range of message numbers
 .RB ( rmm ,
 .PP
 Commands which take a range of message numbers
 .RB ( rmm ,


@@ -162,6 +169,10 @@ Commands which take a range of message numbers
 Indicates all messages in the range <num1> to <num2>, inclusive.
 The range must be nonempty.
 .TP
 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
 .PD 0
 .TP


@@ -192,6 +203,52 @@ The first, previous, next or last
 messages, if they exist.
 .PD
 .PP
 messages, if they exist.
 .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
 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


@@ -385,15 +442,15 @@ Convenience Wrappers
 .PD 0
 .IR mhmail (1)
 send or read mail
 .PD 0
 .IR mhmail (1)
 send or read mail

-.TP
-.IR msh (1)
-nmh shell

 .PD
 .ne 4
 .SS
 Utilities
 .TP \n(ttu
 .PD 0
 .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 mhparam (1)
 print nmh profile components
 .TP


@@ -415,13 +472,10 @@ Indirectly Invoked Commands
 .TP \n(ttu
 .PD 0
 .IR ap (8)
 .TP \n(ttu
 .PD 0
 .IR ap (8)

-parse addresses 822\-style
-.TP
-.IR conflict (8)
-search for alias/password conflicts
+parse addresses RFC 822\-style

 .TP
 .IR dp (8)
 .TP
 .IR dp (8)

-parse dates 822\-style
+parse dates RFC 822\-style

 .TP
 .IR fmtdump (8)
 decode
 .TP
 .IR fmtdump (8)
 decode


@@ -442,23 +496,31 @@ Files Used by nmh Commands
 .IR mh\-alias (5)
 alias file for nmh message system
 .TP
 .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\-draft (5)
 draft folder facility
 .TP

-.IR mh\-format (5)
-format file for nmh message system
+.IR mh\-folders (5)
+nmh message storage format specification

 .TP
 .IR mh\-mail (5)
 message format for nmh message system
 .TP
 .TP
 .IR mh\-mail (5)
 message format for nmh message system
 .TP

-.IR mh\-profile (5)
-user customization for nmh message system
-.TP

 .IR mh\-sequence (5)
 sequence specification for nmh message system
 .IR mh\-sequence (5)
 sequence specification for nmh message system

-.TP
-.IR mh\-tailor (5)
-mail transport customization for nmh message system

 .PD
 .ne 4
 .SH FILES
 .PD
 .ne 4
 .SH FILES


@@ -468,12 +530,12 @@ contains
 .B nmh
 commands
 .TP
 .B nmh
 commands
 .TP

-%etcdir%
+%nmhetcdir%

 contains
 .B nmh
 format files
 .TP
 contains
 .B nmh
 format files
 .TP

-%libdir%
+%nmhlibexecdir%

 contains
 .B nmh
 library commands
 contains
 .B nmh
 library commands


@@ -484,17 +546,25 @@ The user's nmh profile
 .SH "SEE ALSO"
 .IR install-mh (1),
 .IR mh-profile (5),
 .SH "SEE ALSO"
 .IR install-mh (1),
 .IR mh-profile (5),

-.IR mh-chart (7)
+.IR mh-chart (7),
+.IR mh-mime (7)

 .ne 4
 .SH BUGS
 .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
 If problems are encountered with an
 .B nmh

-program, the problems should
+program, they should

 be reported to the local maintainers of
 be reported to the local maintainers of

-.BR nmh .
-When doing this, the
-name of the program should be reported, along with the version information
-for the program.
+.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
 .PP
 To find out what version of an
 .B nmh


@@ -507,5 +577,4 @@ the version of
 the host it was compiled on, and the date the
 program was linked.
 .PP
 the host it was compiled on, and the date the
 program was linked.
 .PP

-Send bug reports and suggestions to
-.IR nmh-workers@nongnu.org .
+New releases and other information of potential interest are announced at http://www.nongnu.org/nmh/ .