Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / conf / doc / RCS / mhpath.rf,v
1 head    1.7;
2 access;
3 symbols;
4 locks; strict;
5
6
7 1.7
8 date    92.02.11.22.40.23;      author jromine; state Exp;
9 branches;
10 next    1.6;
11
12 1.6
13 date    90.04.05.15.08.26;      author sources; state Exp;
14 branches;
15 next    1.5;
16
17 1.5
18 date    90.03.22.11.31.28;      author sources; state Exp;
19 branches;
20 next    1.4;
21
22 1.4
23 date    90.03.20.19.42.07;      author sources; state Exp;
24 branches;
25 next    1.3;
26
27 1.3
28 date    90.03.20.17.36.23;      author sources; state Exp;
29 branches;
30 next    1.2;
31
32 1.2
33 date    89.11.17.16.25.35;      author sources; state Exp;
34 branches;
35 next    1.1;
36
37 1.1
38 date    89.11.17.16.23.44;      author sources; state Exp;
39 branches;
40 next    ;
41
42
43 desc
44 @@
45
46
47 1.7
48 log
49 @minor re-format
50 @
51 text
52 @.\"    @@(MHWARNING)
53 .\" @@(#)$Id: mhpath.rf,v 1.6 1990/04/05 15:08:26 sources Exp jromine $
54 .SC MHPATH 1
55 .NA
56 mhpath \- print full pathnames of MH messages and folders
57 .SY
58 mhpath
59 \%[+folder] \%[msgs]
60 \%[\-help]
61 .DE
62 \fIMhpath\fR expands and sorts the message list `msgs' and writes
63 the full pathnames of the messages to the standard output
64 separated by newlines.
65 If no `msgs' are specified,
66 \fImhpath\fR outputs the folder pathname instead.
67 If the only argument is `+', your MH \fIPath\fR is output;
68 this can be useful is shell scripts.
69
70 Contrasted with other MH commands, a message argument to \fImhpath\fR
71 may often be intended for \fIwriting\fR.
72 Because of this:
73 .sp
74 1) the name \*(lqnew\*(rq has been added to \fImhpath\fR's list of
75 reserved message names
76 (the others are \*(lqfirst\*(rq, \*(lqlast\*(rq, \*(lqprev\*(rq,
77 \*(lqnext\*(rq, \*(lqcur\*(rq, and \*(lqall\*(rq).
78 The new message is equivalent to the message after the
79 last message in a folder
80 (and equivalent to 1 in a folder without messages).
81 The \*(lqnew\*(rq message may not be used as part of a message range.
82 .sp
83 2) Within a message list,
84 the following designations may refer to messages that do not exist:
85 a single numeric message name,
86 the single message name \*(lqcur\*(rq,
87 and (obviously) the single message name \*(lqnew\*(rq.
88 All other message designations must refer to at least one existing message.
89 .sp
90 3) An empty folder is not in itself an error.
91
92 Message numbers greater than the highest existing message in a folder as
93 part of a range designation are replaced with the next free message number.
94
95 Examples: The current folder foo contains messages 3 5 6.
96 Cur is 4.
97
98 .nf
99 .in +.5i
100 % mhpath
101 /r/phyl/Mail/foo
102
103 % mhpath all
104 /r/phyl/Mail/foo/3
105 /r/phyl/Mail/foo/5
106 /r/phyl/Mail/foo/6
107
108 % mhpath 2001
109 /r/phyl/Mail/foo/7
110
111 % mhpath 1\-2001
112 /r/phyl/Mail/foo/3
113 /r/phyl/Mail/foo/5
114 /r/phyl/Mail/foo/6
115
116 % mhpath new
117 /r/phyl/Mail/foo/7
118
119 % mhpath last new
120 /r/phyl/Mail/foo/6
121 /r/phyl/Mail/foo/7
122
123 % mhpath last\-new
124 bad message list \*(lqlast\-new\*(rq.
125
126 % mhpath cur
127 /r/phyl/Mail/foo/4
128
129 % mhpath 1\-2
130 no messages in range \*(lq1\-2\*(rq.
131
132 % mhpath first:2
133 /r/phyl/Mail/foo/3
134 /r/phyl/Mail/foo/5
135
136 % mhpath 1 2
137 /r/phyl/Mail/foo/1
138 /r/phyl/Mail/foo/2
139 .in -.5i
140 .fi
141
142 \fIMHpath\fR is also useful in back\-quoted operations:
143
144 .nf
145 .in +.5i
146 % cd `mhpath +inbox`
147
148 % echo `mhpath +`
149 /r/phyl/Mail
150 .in -.5i
151 .fi
152 .Fi
153 ^$HOME/\&.mh\(ruprofile~^The user profile
154 .Pr
155 ^Path:~^To determine the user's MH directory
156 .Ps
157 ^Current\-Folder:~^To find the default current folder
158 .Sa
159 folder(1)
160 .De
161 `+folder' defaults to the current folder
162 .Ds
163 `msgs' defaults to none
164 .Co
165 None
166 .Bu
167 Like all MH commands, \fImhpath\fR expands and sorts \%[msgs].
168 So don't expect
169
170 .ti +.5i
171 mv `mhpath 501 500`
172
173 to move 501 to 500.
174 Quite the reverse.  But
175
176 .ti +.5i
177 mv `mhpath 501` `mhpath 500`
178
179 will do the trick.
180
181 Out of range message 0 is treated far more severely than large out of
182 range message numbers.
183 .En
184 @
185
186
187 1.6
188 log
189 @add ID
190 @
191 text
192 @d2 1
193 a2 1
194 .\" @@(#)$Id:$
195 d22 1
196 d31 1
197 d38 1
198 @
199
200
201 1.5
202 log
203 @put things back, do .NA stuff another way
204 @
205 text
206 @d2 1
207 @
208
209
210 1.4
211 log
212 @typo
213 @
214 text
215 @d2 2
216 a3 2
217 .TH MHPATH 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
218 .SH .NA
219 d5 1
220 a5 1
221 .SH .SY
222 @
223
224
225 1.3
226 log
227 @fixup for makewhatis
228 @
229 text
230 @d2 1
231 a2 1
232 .TH MHPATH 1 [mh.6] MH
233 @
234
235
236 1.2
237 log
238 @document 'mhpath +'
239 @
240 text
241 @d2 2
242 a3 2
243 .SC MHPATH 1
244 .NA
245 d5 1
246 a5 1
247 .SY
248 @
249
250
251 1.1
252 log
253 @Initial revision
254 @
255 text
256 @d15 2
257 @