.\"
.\" %nmhwarning%
.\"
.TH MHPATH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
mhpath \- print full pathnames of mh messages and folders
.SH SYNOPSIS
.HP 5
.na
.B mhpath
.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.
If no `msgs' are specified,
.B mhpath
outputs the current mail folder's pathname
instead.  If the only argument is `+', your mail storage location
(`Path') is output; this can be useful in shell scripts.
.PP
Contrasted with other
.B mmh
commands, a message argument to
.B mhpath
may often be intended for writing.  Because of this:
.PP
.IP 1) 4
the name `b' has been added to
.BR mhpath 's
list of
reserved message names (the others are `f', `l',
`p', `n', `c', and `a').
The `b' (beyond) message is equivalent to the message after the last message
in a folder (and equivalent to 1 in a folder without messages).
The `b' message may not be used as part of a message range.
.IP 2) 4
Within a message list, the following designations may refer to messages
that do not exist: a single numeric message name, the single message name
`c', and (obviously) the single message name `b'.
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.
.PP
Message numbers greater than the highest existing message in a folder
as part of a range designation are replaced with the next free message
number.
.PP
Examples: The current folder foo contains messages 3 5 6.
Cur is 4.
.PP
.RS 5
.nf
% mhpath
/r/phyl/Mail/foo

% mhpath a
/r/phyl/Mail/foo/3
/r/phyl/Mail/foo/5
/r/phyl/Mail/foo/6

% mhpath 2001
/r/phyl/Mail/foo/7

% mhpath 1\-2001
/r/phyl/Mail/foo/3
/r/phyl/Mail/foo/5
/r/phyl/Mail/foo/6

% mhpath b
/r/phyl/Mail/foo/7

% mhpath l b
/r/phyl/Mail/foo/6
/r/phyl/Mail/foo/7

% mhpath l\-b
bad message list `l\-b'.

% mhpath c
/r/phyl/Mail/foo/4

% mhpath 1\-2
no messages in range `1\-2'.

% mhpath f:2
/r/phyl/Mail/foo/3
/r/phyl/Mail/foo/5

% mhpath 1 2
/r/phyl/Mail/foo/1
/r/phyl/Mail/foo/2
.fi
.RE
.PP
.B mhpath
is also useful in back\-quoted operations:
.PP
.RS 5
.nf
% cd `mhpath +inbox`

% echo `mhpath +`
/r/phyl/Mail
.fi
.RE
.PP

.SH FILES
.fc ^ ~
.nf
.ta \w'%etcdir%/ExtraBigFileName  'u
^$HOME/.mmh/profile~^The user profile
.fi

.SH "PROFILE COMPONENTS"
.fc ^ ~
.nf
.ta 2.4i
.ta \w'ExtraBigProfileName  'u
^Path:~^To determine the user's mail storage
^Current\-Folder:~^To find the default current folder
.fi

.SH "SEE ALSO"
folder(1)

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

.SH CONTEXT
None

.SH BUGS
Like all
.B mmh
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.