X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/0ca80aec5c708a8964dcd9d74fb13894d3df97fe..de237d4dc2cafee55bd50a15fbeb2d7a880a87cf:/man/nmh.man?ds=sidebyside diff --git a/man/nmh.man b/man/nmh.man index f3e9ccbe..0afc64fc 100644 --- a/man/nmh.man +++ b/man/nmh.man @@ -1,7 +1,7 @@ -.TH NMH %manext7% "April 21, 2014" "%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 .\" @@ -16,7 +16,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. @@ -30,8 +30,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 , @@ -47,14 +49,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 @@ -74,10 +76,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 @@ -92,7 +92,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 @@ -117,7 +117,7 @@ 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. @@ -134,12 +134,12 @@ 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 -All the +Each .B nmh -commands may be run with the single switch +command may be run with the single switch .BR \-help , -which causes them to print a list of the switches 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 @@ -157,7 +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). -As a shorthand, \*(lq\&.\*(rq is equivalent to \*(lqcur\*(rq. +As a shorthand, \*(lq.\*(rq is equivalent to \*(lqcur\*(rq. .PP Commands which take a range of message numbers .RB ( rmm , @@ -178,8 +178,11 @@ Indicates all messages, i.e., .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 @@ -189,6 +192,7 @@ may be any of the pre-defined symbols .B next or .BR last . +The + can be omitted. .PD .TP .RI first: N @@ -199,8 +203,9 @@ 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 @@ -209,14 +214,14 @@ Commands that take a folder name .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 @@ -355,7 +360,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 @@ -401,7 +406,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) @@ -530,17 +535,17 @@ 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" @@ -550,14 +555,21 @@ The user's nmh profile .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 @@ -570,5 +582,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/