X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/5e5e8b753acc7ff1e16c7fca172a2151a6c01353..0328f2c528b4a07c27cac8f3acfc39ebc873cbdd:/man/mhpath.man diff --git a/man/mhpath.man b/man/mhpath.man index 4ecb614e..f07b521b 100644 --- a/man/mhpath.man +++ b/man/mhpath.man @@ -1,4 +1,4 @@ -.TH MHPATH %manext1% "November 6, 2012" "%nmhversion%" +.TH MHPATH %manext1% "March 23 2017" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -8,34 +8,33 @@ mhpath \- print full pathnames of nmh messages and folders .HP 5 .na .B mhpath +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] .RI [ msgs ] -.RB [ \-version ] -.RB [ \-help ] .ad .SH DESCRIPTION .B mhpath expands and sorts the message list `msgs' and writes the full -pathnames of the messages to the standard output separated by newlines. +pathnames of the messages to the standard output, separated by newlines. If no `msgs' are specified, .B mhpath -outputs the current mail folder's pathname -instead. If the only argument is `+', your +outputs the current mail folder's pathname instead. +If the only argument is `+', your .B nmh \*(lqPath\*(rq is output; this can be useful in shell scripts. .PP -Contrasted with other +In contrast with other .B nmh commands, a message argument to .B mhpath may often be intended for writing. Because of this: -.PP .IP 1) 4 the name \*(lqnew\*(rq has been added to .BR mhpath 's -list of -reserved message names (the others are \*(lqfirst\*(rq, \*(lqlast\*(rq, -\*(lqprev\*(rq, \*(lqnext\*(rq, \*(lqcur\*(rq, and \*(lqall\*(rq). +list of reserved message names (the others are \*(lqfirst\*(rq, +\*(lqlast\*(rq, \*(lqprev\*(rq, \*(lqnext\*(rq, \*(lqcur\*(rq, +and \*(lqall\*(rq). The new message is equivalent to the message after the last message in a folder (and equivalent to 1 in a folder without messages). The \*(lqnew\*(rq message may not be used as part of a message range. @@ -46,7 +45,7 @@ that do not exist: a single numeric message name, the single message name All other message designations must refer to at least one existing message, if the folder contains messages. .IP 3) 4 -An empty folder is not in itself an error. +An empty folder is not, in itself, an error. .PP A message number less than that of the smallest existing message in a folder is treated as if the message already exists. A message number @@ -115,6 +114,7 @@ is also useful in backquoted operations: /r/phyl/Mail .fi .RE +.PP Because .B mhpath expands and sorts @@ -127,8 +127,7 @@ mv `mhpath 501 500` .fi .RE .PP -to will not move 501 to 500. -Quite the reverse. But +to will not move 501 to 500; quite the reverse. But .PP .RS 5 .nf @@ -138,12 +137,14 @@ mv `mhpath 501` `mhpath 500` .PP will do the trick. .PP -Out of range message 0 is treated far more severely than large out of -range message numbers. +Out-of-range message 0 produces a different error message than large +out-of-range message numbers. But both cause +.B mhpath +to exit with non-zero status. .SH FILES .fc ^ ~ .nf -.ta \w'%etcdir%/ExtraBigFileName 'u +.ta \w'ExtraBigProfileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile .fi .SH "PROFILE COMPONENTS"