X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/ab3b58c74f970f3755eaa8e876cdc6c3fcd0a147..9f8418e870a70c264eda1598f2d470e5428c216d:/man/nmh.man diff --git a/man/nmh.man b/man/nmh.man index f1732589..0c32cde5 100644 --- a/man/nmh.man +++ b/man/nmh.man @@ -1,4 +1,4 @@ -.TH NMH %manext7% "November 30, 2012" "%nmhversion%" +.TH NMH %manext7% "September 26, 2016" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -122,16 +122,28 @@ its .B attach and related responses, as described in its man page. .PP -All the .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 , -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 -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 @@ -194,17 +206,17 @@ messages, if they exist. Commands that take a folder name .RB ( inc , .BR refile , -.BR scan, +.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 +\*(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 +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 @@ -430,15 +442,15 @@ Convenience Wrappers .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 +.IR mhfixmsg (1) +rewrite MIME messages with various transformations +.TP .IR mhparam (1) print nmh profile components .TP @@ -462,9 +474,6 @@ Indirectly Invoked Commands .IR ap (8) parse addresses RFC 822\-style .TP -.IR conflict (8) -search for alias/password conflicts -.TP .IR dp (8) parse dates RFC 822\-style .TP @@ -487,23 +496,31 @@ Files Used by nmh Commands .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\-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 -.IR mh\-profile (5) -user customization for nmh message system -.TP .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 @@ -513,12 +530,12 @@ contains .B nmh commands .TP -%etcdir% +%nmhetcdir% contains .B nmh format files .TP -%libdir% +%nmhlibexecdir% contains .B nmh library commands @@ -529,17 +546,25 @@ The user's nmh profile .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 +\" 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, the problems should +program, they should 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 @@ -552,5 +577,4 @@ the version of 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/ .