crawl_folders.h: Rename to be alongside implementation.

[nmh] / man / mhpath.man

diff --git a/man/mhpath.man b/man/mhpath.man
index 74b539d950cd89014e5a3a4b1e54fa2459e57f10..b867485783254f11406a011c818e9212dcdd128d 100644 (file)
--- a/man/mhpath.man
+++ b/man/mhpath.man
@@ -1,41 +1,40 @@
-.TH MHPATH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
-.\"
+.TH MHPATH %manext1% 2012-02-18 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\"
+.

 .SH NAME
 mhpath \- print full pathnames of nmh messages and folders
 .SH SYNOPSIS
 .HP 5
 .na
 .B mhpath
 .SH NAME
 mhpath \- print full pathnames of nmh messages and folders
 .SH SYNOPSIS
 .HP 5
 .na
 .B mhpath

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ msgs ]
 .RI [ +folder ]
 .RI [ msgs ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .B mhpath
 expands and sorts the message list `msgs' and writes the full
 .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
 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
 .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:
 .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
 .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.
 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
 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
 .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


@@ -62,64 +61,91 @@ Cur is 4.
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-% mhpath
+$ mhpath

 /r/phyl/Mail/foo
 
 /r/phyl/Mail/foo
 

-% mhpath all
+$ mhpath all

 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 /r/phyl/Mail/foo/6
 
 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 /r/phyl/Mail/foo/6
 

-% mhpath 2001
+$ mhpath 2001

 mhpath: message 2001 out of range 1-6
 
 mhpath: message 2001 out of range 1-6
 

-% mhpath 1\-2001
+$ mhpath 1\-2001

 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 /r/phyl/Mail/foo/6
 
 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 /r/phyl/Mail/foo/6
 

-% mhpath new
+$ mhpath new

 /r/phyl/Mail/foo/7
 
 /r/phyl/Mail/foo/7
 

-% mhpath last new
+$ mhpath last new

 /r/phyl/Mail/foo/6
 /r/phyl/Mail/foo/7
 
 /r/phyl/Mail/foo/6
 /r/phyl/Mail/foo/7
 

-% mhpath last\-new
+$ mhpath last\-new

 mhpath: bad message list last\-new
 
 mhpath: bad message list last\-new
 

-% mhpath cur
+$ mhpath cur

 /r/phyl/Mail/foo/4
 
 /r/phyl/Mail/foo/4
 

-% mhpath 1\-2
+$ mhpath 1\-2

 mhpath: no messages in range 1\-2
 
 mhpath: no messages in range 1\-2
 

-% mhpath first:2
+$ mhpath first:2

 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 
 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 

-% mhpath 1 2
+$ mhpath 1 2

 /r/phyl/Mail/foo/1
 /r/phyl/Mail/foo/2
 .fi
 .RE
 .PP
 .B mhpath
 /r/phyl/Mail/foo/1
 /r/phyl/Mail/foo/2
 .fi
 .RE
 .PP
 .B mhpath

-is also useful in back\-quoted operations:
+is also useful in backquoted operations:

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-% cd `mhpath +inbox`
+$ cd \`mhpath +inbox\`

 
 

-% echo `mhpath +`
+$ echo \`mhpath +\`

 /r/phyl/Mail
 .fi
 .RE
 /r/phyl/Mail
 .fi
 .RE

+.PP
+Because
+.B mhpath
+expands and sorts
+.RI [ msgs ].
+the command
+.PP
+.RS 5
+.nf
+mv \`mhpath 501 500\`
+.fi
+.RE
+.PP
+to will not move 501 to 500; quite the reverse.  But
+.PP
+.RS 5
+.nf
+mv \`mhpath 501\` \`mhpath 500\`
+.fi
+.RE
+.PP
+will do the trick.
+.PP
+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
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'ExtraBigProfileName  'u
+^$HOME/.mh_profile~^The user profile

 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~


@@ -130,7 +156,7 @@ is also useful in back\-quoted operations:
 ^Current\-Folder:~^To find the default current folder
 .fi
 .SH "SEE ALSO"
 ^Current\-Folder:~^To find the default current folder
 .fi
 .SH "SEE ALSO"

-folder(1)
+.IR folder (1)

 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"


@@ -138,32 +164,3 @@ folder(1)
 .fi
 .SH CONTEXT
 None
 .fi
 .SH CONTEXT
 None

-.SH BUGS
-Like all
-.B nmh
-commands,
-.B mhpath
-expands and sorts
-.RI [ msgs ].
-So don't
-expect
-.PP
-.RS 5
-.nf
-mv `mhpath 501 500`
-.fi
-.RE
-.PP
-to move 501 to 500.
-Quite the reverse.  But
-.PP
-.RS 5
-.nf
-mv `mhpath 501` `mhpath 500`
-.fi
-.RE
-.PP
-will do the trick.
-.PP
-Out of range message 0 is treated far more severely than large out of
-range message numbers.