annotate conf/doc/mhpath.rf @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children 441a2190cfae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" @(MHWARNING)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .\" @(#)$Id$
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC MHPATH 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 mhpath \- print full pathnames of MH messages and folders
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 mhpath
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[+folder] \%[msgs]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \fIMhpath\fR expands and sorts the message list `msgs' and writes
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 the full pathnames of the messages to the standard output
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 separated by newlines.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 If no `msgs' are specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \fImhpath\fR outputs the folder pathname instead.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 If the only argument is `+', your MH \fIPath\fR is output;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 this can be useful is shell scripts.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 Contrasted with other MH commands, a message argument to \fImhpath\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 may often be intended for \fIwriting\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 Because of this:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 1) the name \*(lqnew\*(rq has been added to \fImhpath\fR's list of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 reserved message names
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 (the others are \*(lqfirst\*(rq, \*(lqlast\*(rq, \*(lqprev\*(rq,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 \*(lqnext\*(rq, \*(lqcur\*(rq, and \*(lqall\*(rq).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 The new message is equivalent to the message after the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 last message in a folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 (and equivalent to 1 in a folder without messages).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 The \*(lqnew\*(rq message may not be used as part of a message range.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 2) Within a message list,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 the following designations may refer to messages that do not exist:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 a single numeric message name,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 the single message name \*(lqcur\*(rq,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 and (obviously) the single message name \*(lqnew\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 All other message designations must refer to at least one existing message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 3) An empty folder is not in itself an error.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 Message numbers greater than the highest existing message in a folder as
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 part of a range designation are replaced with the next free message number.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 Examples: The current folder foo contains messages 3 5 6.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 Cur is 4.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 .in +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 % mhpath
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 /r/phyl/Mail/foo
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 % mhpath all
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 /r/phyl/Mail/foo/3
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 /r/phyl/Mail/foo/5
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 /r/phyl/Mail/foo/6
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 % mhpath 2001
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 /r/phyl/Mail/foo/7
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 % mhpath 1\-2001
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 /r/phyl/Mail/foo/3
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 /r/phyl/Mail/foo/5
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 /r/phyl/Mail/foo/6
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 % mhpath new
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 /r/phyl/Mail/foo/7
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 % mhpath last new
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 /r/phyl/Mail/foo/6
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 /r/phyl/Mail/foo/7
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 % mhpath last\-new
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 bad message list \*(lqlast\-new\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 % mhpath cur
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 /r/phyl/Mail/foo/4
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 % mhpath 1\-2
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 no messages in range \*(lq1\-2\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 % mhpath first:2
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 /r/phyl/Mail/foo/3
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 /r/phyl/Mail/foo/5
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 % mhpath 1 2
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 /r/phyl/Mail/foo/1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 /r/phyl/Mail/foo/2
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 .in -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 \fIMHpath\fR is also useful in back\-quoted operations:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 .in +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 % cd `mhpath +inbox`
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 % echo `mhpath +`
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 /r/phyl/Mail
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 .in -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106 ^Current\-Folder:~^To find the default current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 folder(1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 `+folder' defaults to the current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 `msgs' defaults to none
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
116 Like all MH commands, \fImhpath\fR expands and sorts \%[msgs].
bce86c4163a3 Initial revision
kono
parents:
diff changeset
117 So don't expect
bce86c4163a3 Initial revision
kono
parents:
diff changeset
118
bce86c4163a3 Initial revision
kono
parents:
diff changeset
119 .ti +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
120 mv `mhpath 501 500`
bce86c4163a3 Initial revision
kono
parents:
diff changeset
121
bce86c4163a3 Initial revision
kono
parents:
diff changeset
122 to move 501 to 500.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
123 Quite the reverse. But
bce86c4163a3 Initial revision
kono
parents:
diff changeset
124
bce86c4163a3 Initial revision
kono
parents:
diff changeset
125 .ti +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
126 mv `mhpath 501` `mhpath 500`
bce86c4163a3 Initial revision
kono
parents:
diff changeset
127
bce86c4163a3 Initial revision
kono
parents:
diff changeset
128 will do the trick.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
129
bce86c4163a3 Initial revision
kono
parents:
diff changeset
130 Out of range message 0 is treated far more severely than large out of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
131 range message numbers.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
132 .En