X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d1cb667bddf8d1c5c0721fc7ab642c22946baf1f..2b383bf8c8afa623bd84cc69284a632c71e78e94:/man/nmh.man diff --git a/man/nmh.man b/man/nmh.man index cc62145d..111efeee 100644 --- a/man/nmh.man +++ b/man/nmh.man @@ -1,16 +1,13 @@ -.TH NMH %manext7% "September 11, 2012" "%nmhversion%" -.\" +.TH NMH %manext7% 2016-09-26 "%nmhversion%" +. .\" %nmhwarning% -.\" -.\" Register 'tt' contains the indent for .TP in the COMMANDS section: -.nr tt \w'\fImh-sequence\fR(5)\0\0'u -.\" +. .SH NAME nmh \- new MH message system -.SH SYNOPSIS -any -.B nmh -command +. +.\" Register 'tt' contains the indent for .TP in the COMMANDS section: +.nr tt \w'\fImh-sequence\fR(5)\0\0'u +. .SH DESCRIPTION .B nmh is the name of a powerful message handling system. Rather than @@ -20,7 +17,7 @@ consists of a collection of fairly simple single-purpose programs to send, retrieve, save, and manipulate messages. .PP -Unlike most mail clients in UNIX, +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. @@ -34,8 +31,10 @@ to find the answer to someone's question before answering their mail. The rest of this manual entry is a quick tutorial which will teach you the basics of .BR nmh . -You should read the manual entries for the -individual programs for complete documentation. +You should read the manual entries for the individual programs for +complete documentation (see the section on +.I COMMANDS +below). .PP To get started using .BR nmh , @@ -43,9 +42,7 @@ put the directory \*(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 @@ -53,14 +50,14 @@ before, it will create the necessary default files and directories after asking you if you wish it to do so. .PP .B inc -moves mail from your system maildrop into your +moves mail from your system mail drop 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 +format. 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 it processes as your current message. You'll need to run .B inc @@ -80,10 +77,8 @@ and 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 -number, which you pass as an argument to -.BR show . +displays the current message, or a specific message specified by its +number which is passed as an argument. .B next and .B prev @@ -98,7 +93,7 @@ may be used to advance to the first message. .PP .B rmm -(remove message) deletes the current message. It may be called +(remove message) deletes the current message. It may be called, with message numbers passed as arguments, to delete specific messages. .PP .B repl @@ -123,21 +118,33 @@ 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 +also supports easy-to-use management of MIME attachments via 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 @@ -151,6 +158,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). +As a shorthand, \*(lq.\*(rq is equivalent to \*(lqcur\*(rq. .PP Commands which take a range of message numbers .RB ( rmm , @@ -162,13 +170,20 @@ Commands which take a range of message numbers Indicates all messages in the range to , inclusive. The range must be nonempty. .TP +all +Indicates all messages, i.e., +.IR first - last . +.TP .IR :+ N .PD 0 .TP .IR :\-N Up to +.IR N , +where .I N -messages beginning with (or ending with) message +must be a positive number, messages beginning with (or ending with) +message .IR num . .I Num may be any of the pre-defined symbols @@ -178,6 +193,7 @@ may be any of the pre-defined symbols .B next or .BR last . +The + can be omitted. .PD .TP .RI first: N @@ -188,8 +204,55 @@ or .RI next: N .TP .RI last: N -The first, previous, next or last -messages, if they exist. +As many of the first, previous, next, or last N messages that exist. +As above, N can be preceded with - to end the listing at the specified +message, or with an optional +. +.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 @@ -298,7 +361,7 @@ show the next message show the previous message .TP .IR show (1) -show(display) messages +show (display) messages .TP .IR scan (1) produce a one line per message scan listing @@ -344,7 +407,7 @@ Across folders: list folders with new messages .TP .IR unseen (1) -list new messages in a give set of folders +list new messages in a given set of folders .TP .IR flist (1) list folders with messages in given sequence(s) @@ -385,15 +448,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 @@ -415,13 +478,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 @@ -442,23 +502,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 @@ -468,33 +536,41 @@ contains .B nmh commands .TP -%etcdir% +%nmhetcdir% contains .B nmh format files .TP -%libdir% +%nmhlibexecdir% contains .B nmh library commands .TP -$HOME/\&.mh\-profile +$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-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 @@ -507,5 +583,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/