8 date 93.08.27.18.13.47; author jromine; state Exp;
13 date 93.08.26.22.59.29; author jromine; state Exp;
18 date 93.08.26.22.56.45; author jromine; state Exp;
23 date 93.08.19.21.20.51; author jromine; state Exp;
28 date 92.10.29.21.50.27; author jromine; state Exp;
33 date 92.02.18.17.47.49; author jromine; state Exp;
38 date 92.02.07.23.57.18; author jromine; state Exp;
43 date 92.02.07.20.16.07; author jromine; state Exp;
48 date 92.02.06.22.01.06; author jromine; state Exp;
53 date 90.12.18.14.28.05; author mh; state Exp;
58 date 90.04.05.15.12.37; author sources; state Exp;
63 date 90.03.22.11.31.06; author sources; state Exp;
68 date 90.03.20.19.41.43; author sources; state Exp;
73 date 90.03.20.17.36.00; author sources; state Exp;
78 date 90.03.20.17.20.48; author sources; state Exp;
89 @use -[no]create instead of -create policy
93 .\" @@(#)$Id: folder.rf,v 1.14 1993/08/26 22:59:29 jromine Exp jromine $
96 folder, folders \- set/list current folder/message
101 \%[\-create] \%[\-nocreate]
104 \%[\-fast] \%[\-nofast]
105 \%[\-header] \%[\-noheader]
106 \%[\-recurse] \%[\-norecurse]
107 \%[\-total] \%[\-nototal]
108 \%[\-list] \%[\-nolist]
110 \%[\-pack] \%[\-nopack]
111 \%[\-verbose] \%[\-noverbose]
117 Since the \fIMH\fR environment is the shell, it is easy to lose
118 track of the current folder from day to day.
119 When \fIfolder\fR is given the `\-print' switch (the default),
121 list the current folder, the number of messages in it, the
122 range of the messages (low\-high), and the current message within
123 the folder, and will flag extra files if they exist.
124 An example of this summary is:
128 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
129 inbox+ has \016 messages (\0\03\-\022); cur=\0\05.
134 If a `+folder' and/or `msg' are specified, they will
135 become the current folder and/or message.
137 when a `+folder' argument is given,
138 this corresponds to a \*(lqcd\*(rq operation in the \fIshell\fR;
139 when no `+folder' argument is given,
140 this corresponds roughly to a \*(lqpwd\*(rq operation in the \fIshell\fR.
142 If the specified (or default) folder doesn't exist,
143 the default action is to query the user
144 as to whether the folder should be created;
145 when standard input is not a tty, the answer to
146 the query is assumed to be \*(lqyes\*(rq.
148 Specifying `\-create' will cause \fIfolder\fP to create
149 new folders without any query.
150 (This is the easy way to create an empty folder for use later.)
151 Specifying `\-nocreate' will
152 cause \fIfolder\fP to exit without creating a non-existant folder.
154 .\" note - this doesn't work at present
155 .\" If `\-noprint' is specified,
156 .\" a `+folder' and/or `msg' may still be specified
157 .\" to set the current folder and/or message,
158 .\" but the folder summary will not be printed.
159 .Uh "Multiple Folders"
161 will produce a summary line for each top-level
162 folder in the user's MH directory, sorted alphabetically.
164 is invoked by a name ending with \*(lqs\*(rq (e.g., \fIfolders\fR\0),
166 Specifying `\-recurse' with `\-all' will also
167 produce a line for all sub-folders.
168 These folders are all preceded by the read\-only folders,
169 which occur as \*(lqatr\-cur\-\*(rq entries in the user's \fIMH\fR context.
175 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
176 Folder \0\0\0# of messages (\0range\0) cur msg (other files)
177 /fsd/rs/m/tacc has \035 messages (\0\01\-\035); cur=\023.
178 /rnd/phyl/Mail/EP has \082 messages (\0\01\-108); cur=\082.
179 ff has \0no messages.
180 inbox+ has \016 messages (\0\03\-\022); cur=\0\05.
181 mh has \076 messages (\0\01\-\076); cur=\070.
182 notes has \0\02 messages (\0\01\-\0\02); cur=\0\01.
183 ucom has 124 messages (\0\01\-124); cur=\0\06; (others).
184 .ta \w'/rnd/phyl/Mail/EP has 'u
185 \0\0\0\0\0\0\0\0\0\0TOTAL= 339 messages in 7 folders
190 The \*(lq+\*(rq after inbox indicates that it is the current folder.
191 The \*(lq(others)\*(rq indicates that the folder `ucom' has files
192 which aren't messages.
193 These files may either be sub\-folders,
194 or files that don't belong under the MH file naming scheme.
196 The header is output if either a `\-all' or a `\-header' switch
197 is specified; it is suppressed by `\-noheader'.
198 A `\-total' switch will produce only the
201 If `\-fast' is given, only the folder name (or names in the
202 case of `\-all') will be listed.
203 (This is faster because the
204 folders need not be read.)
207 is given along with the `\-all' switch,
209 in addition to setting the current folder,
210 list the top\-level folders for the current folder (with `\-norecurse')
211 or list all sub-folders under the current folder recursively (with `\-recurse').
212 In this case, if a `msg' is also supplied,
213 it will become the current message of `+folder'.
215 The `\-recurse' switch lists each folder recursively, so
216 use of this option effectively defeats the speed enhancement of the `\-fast'
218 since each folder must be searched for subfolders.
219 Nevertheless, the combination of these options is useful.
221 .Uh "Compacting a Folder"
222 The `\-pack' switch will compress the message names in the
223 designated folders, removing holes in message numbering.
224 The `\-verbose' switch directs \fIfolder\fR to tell the user the general
225 actions that it is taking to compress the folder.
227 .Uh "The Folder Stack"
228 The `\-push' switch directs \fIfolder\fR to push the current folder onto the
230 and make the `+folder' argument the current folder.
231 If `+folder' is not given,
232 the current folder and the top of the \fIfolder\-stack\fR are exchanged.
233 This corresponds to the \*(lqpushd\*(rq operation in the \fICShell\fR.
235 The `\-pop' switch directs \fIfolder\fR to discard the top of the
237 after setting the current folder to that value.
238 No `+folder' argument is allowed.
239 This corresponds to the \*(lqpopd\*(rq operation in the \fICShell\fR.
240 The `\-push' switch and the `\-pop' switch are mutually exclusive:
241 the last occurrence of either one overrides any previous occurrence of the
242 other. Both of these switches also set `\-list' by default.
244 The `\-list' switch directs \fIfolder\fR to list the contents of the
246 No `+folder' argument is allowed.
247 After a successful `\-push' or `\-pop', the `\-list' action is taken,
248 unless a `\-nolist' switch follows them on the command line.
249 This corresponds to the \*(lqdirs\*(rq operation in the \fICShell\fR.
250 The `\-push', `\-pop', and `\-list' switches turn
253 ^$HOME/\&.mh\(ruprofile~^The user profile
255 ^Path:~^To determine the user's MH directory
257 ^Current\-Folder:~^To find the default current folder
259 ^Folder\-Protect:~^To set mode when creating a new folder
261 ^Folder\-Stack:~^To determine the folder stack
263 .\" ^lsproc:~^Program to list the contents of a folder
267 `+folder' defaults to the current folder
269 `msg' defaults to none
283 `\-print' is the default if no `\-list', `\-push', or `\-pop' is specified
285 `\-list' is the default if `\-push', or `\-pop' is specified
287 If `+folder' and/or `msg' are given, they will become the
288 current folder and/or message.
290 In previous versions of \fIMH\fR,
291 the `\-fast' switch prevented context changes from
292 occurring for the current folder.
293 This is no longer the case: if `+folder' is given,
294 then \fIfolder\fR will always change the current folder to that.
296 `\-all' forces `\-header' and `\-total'.
298 There is no way to restore the default behavior
299 (to ask the user whether to create a non-existant folder)
300 after `\-create' or `\-nocreate' is given.
307 @note default: -create ask
312 .\" @@(#)$Id: folder.rf,v 1.13 1993/08/26 22:56:45 jromine Exp jromine $
318 the action taken is controlled with the `\-create' switch.
319 One of three arguments may be specified:
324 \fBalways\fP indicates that \fIfolder\fR should create the folder.
326 \fBask\fP indicates that \fIfolder\fR should ask the user.
327 (When standard input is not a tty, the folder is created without any query.)
329 \fBnever\fP indicates that \fIfolder\fR should not create the folder.
332 (Using \*(lqfolder -create always +folder\*(rq
333 is an easy way to create an empty folder for use later.)
346 @document folder -create policy
351 .\" @@(#)$Id: folder.rf,v 1.12 1993/08/19 21:20:51 jromine Exp jromine $
358 @note that -all forces -total
363 .\" @@(#)$Id: folder.rf,v 1.11 1992/10/29 21:50:27 jromine Exp jromine $
366 If the specified (or default) folder doesn't exist,
367 the user will be queried as to whether the folder should be created.
368 When standard input is not a tty, the folder is
369 created without any query.
370 (This is the easy way to create an empty folder for use later.)
383 .\" @@(#)$Id: folder.rf,v 1.10 1992/02/18 17:47:49 jromine Exp jromine $
386 `\-all' forces `\-header'.
397 .\" @@(#)$Id: folder.rf,v 1.9 1992/02/07 23:57:18 jromine Exp jromine $
401 ^lsproc:~^Program to list the contents of a folder
412 .\" @@(#)$Id: folder.rf,v 1.8 1992/02/07 20:16:07 jromine Exp jromine $
424 .\" @@(#)$Id: folder.rf,v 1.7 1992/02/06 22:01:06 jromine Exp jromine $
427 desginated folders, removing holes in message numbering.
438 .\" @@(#)$Id: folder.rf,v 1.6 1990/12/18 14:28:05 mh Exp jromine $
441 \%[\-print] \%[\-noprint]
444 The `\-push', `\-pop', and `\-list' switches set `\-noprint'.
450 @mention creating a folder when stdin is not a tty
456 .\" @@(#)$Id: folder.rf,v 1.5 90/04/05 15:12:37 sources Exp Locker: mh $
459 \%[\-pack] \%[\-nopack]
461 \%[\-print] \%[\-noprint]
467 the current folder and/or message may be set,
468 or all folders may be listed.
469 When a `+folder' argument is given,
470 this corresponds to a \*(lqcd\*(rq operation in the \fICShell\fR;
471 when no `+folder' argument is given,
472 this corresponds roughly to a \*(lqpwd\*(rq operation in the \fICShell\fR.
477 An example of the output is:
481 will produce a line for each folder in the user's MH directory,
482 sorted alphabetically.
483 These folders are preceded by the read\-only folders,
487 The header is output if either an `\-all' or a `\-header' switch
489 Also, if \fIfolder\fR
490 is invoked by a name ending with \*(lqs\*(rq (e.g., \fIfolders\fR\0),
493 If a `+folder' and/or `msg' is given along with the `\-all' switch,
495 in addition to setting the current folder and/or message,
496 list the top\-level folders for the current folder (with `\-norecurse')
497 or list all folders under the current folder recursively (with `\-recurse').
501 The `\-pack' switch will compress the message names in a folder, removing
502 holes in message numbering.
505 The `\-recurse' switch will list each folder recursively.
506 Use of this option effectively defeats the speed enhancement of the `\-fast'
509 If the specified (or default) folder doesn't exist,
510 the user will be queried as to whether the folder should be created.
511 When standard input is not a tty, the folder is
512 created without any query.
513 (This is the easy way to create an empty folder for use later.)
520 After a successful `\-push' or `\-pop', the `\-list' action is taken.
537 the user will be queried if the folder should be created.
543 @put things back, do .NA stuff another way
557 .TH FOLDER 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
567 @fixup for makewhatis
572 .TH FOLDER 1 [mh.6] MH