X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/9c6b9968baa6313051ea2eb2d69e220186004e1c..b0aa8cdb1c264e42d4931ca24968689c73381278:/man/nmh.man diff --git a/man/nmh.man b/man/nmh.man index c8414b94..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% .\" @@ -7,10 +7,6 @@ .\" .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 @@ -126,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 @@ -195,36 +203,50 @@ The first, previous, next or last messages, if they exist. .PD .PP -Commands which take a folder name +Commands that take a folder name .RB ( inc , .BR refile , -.BR scan , -.BR sortm , -\&...) accept the folder name in two formats: \*(lq+folder\*(rq or -\*(lq@folder\*(rq. \*(lq+folder\*(rq specifies a folder underneath -the Path defined in your profile; e.g., with the usual -.RI \*(lq "Path: Mail" \*(rq, -\*(lq+folder\*(rq tells nmh to use -\*(lqMail/folder\*(rq. \*(lq@folder\*(rq specifies a path -relative to the current folder specified in your \*(lqcontext\*(rq -file; e.g., with -.RI \*(lq "Current-Folder: inbox" \*(rq, -and the same profile, \*(lq@folder\*(rq tells nmh to use -\*(lqMail/inbox/folder\*(rq. If folder begins with \*(lq.\*(rq or -\*(lq/\*(rq when using \*(lq+folder\*(rq, the folder is interpreted as -a specific path to a directory on the filesystem rather than a -relative folder location. -For example, +.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 +" . -scans the current directory +.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 named sibling directory +.BI "scan " +. +scans the current directory .TP -.BI "refile +" /tmp -refiles into the /tmp directory +.BI "refile " @. +refiles current message to end of current folder. .PD .PP There are many other possibilities such as creating multiple folders @@ -420,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 @@ -450,13 +472,10 @@ Indirectly Invoked Commands .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) -parse dates 822\-style +parse dates RFC 822\-style .TP .IR fmtdump (8) decode @@ -477,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 @@ -503,12 +530,12 @@ contains .B nmh commands .TP -%etcdir% +%nmhetcdir% contains .B nmh format files .TP -%libdir% +%nmhlibexecdir% contains .B nmh library commands @@ -519,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 @@ -542,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/ .