]> diplodocus.org Git - nmh/blobdiff - man/nmh.man
In whatnow help, don't show that detached can be abbreviated
[nmh] / man / nmh.man
index d1dd9453b15b11c83d8ea31242977da3743f3b81..f17325890266d04692e7f3c916d4518c986c7447 100644 (file)
@@ -1,4 +1,4 @@
-.TH NMH %manext7% "November 3, 2012" "%nmhversion%"
+.TH NMH %manext7% "November 30, 2012" "%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
@@ -151,6 +145,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 ,
@@ -196,6 +191,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
@@ -419,13 +460,13 @@ Indirectly Invoked Commands
 .TP \n(ttu
 .PD 0
 .IR ap (8)
 .TP \n(ttu
 .PD 0
 .IR ap (8)
-parse addresses 822\-style
+parse addresses RFC 822\-style
 .TP
 .IR conflict (8)
 search for alias/password conflicts
 .TP
 .IR dp (8)
 .TP
 .IR conflict (8)
 search for alias/password conflicts
 .TP
 .IR dp (8)
-parse dates 822\-style
+parse dates RFC 822\-style
 .TP
 .IR fmtdump (8)
 decode
 .TP
 .IR fmtdump (8)
 decode