4 .TH FOLDER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 folder, folders \- set/list current folder/message
13 .RB [ \-all " | " \-noall ]
14 .RB [ \-create " | " \-nocreate ]
15 .RB [ \-fast " | " \-nofast ]
16 .RB [ \-recurse " | " \-norecurse ]
17 .RB [ \-total " | " \-nototal ]
18 .RB [ \-list " | " \-nolist ]
19 .RB [ \-push " | " \-pop ]
20 .RB [ \-pack " | " \-nopack ]
22 .RB [ \-verbose " | " \-noverbose ]
35 environment is the shell, it is easy to lose track
36 of the current folder from day to day. When
42 will list the current folder,
43 the number of messages in it, the range of the messages (low\-high),
44 and the current message within the folder, and will flag extra files if
45 they exist. An example of this summary is:
49 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
50 inbox+ has \016 messages (\0\03\-\022); cur=\0\05
58 are specified, they will become the current
59 folder and/or message. By comparison, when a
61 argument is given, this corresponds to a `cd' operation
64 argument is given, this corresponds roughly to a `pwd'
65 operation in the shell.
67 If the specified (or default) folder doesn't exist, the default action
68 is to query the user as to whether the folder should be created; when
69 standard input is not a tty, the answer to the query is assumed to be
77 without any query. (This is the easy way to create an empty folder for
78 use later.) Specifying
83 without creating a non-existant folder.
85 .\" note - this doesn't work at present
86 .\" If `\-noprint' is specified,
87 .\" a `+folder' and/or `msg' may still be specified
88 .\" to set the current folder and/or message,
89 .\" but the folder summary will not be printed.
91 .SS "Multiple Folders"
94 will produce a summary line for each top-level folder
95 in the user's mmh directory, sorted alphabetically. (If
97 is invoked by a name ending with `s' (e.g.
100 is assumed). Specifying
105 produce a line for all sub-folders. These folders are all preceded by
106 the read\-only folders, which occur as
108 entries in the user's
110 context. For example:
114 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
115 FOLDER \0\0\0\0\0\0# MESSAGES RANGE CUR (OTHERS)
116 /var/work/folder has \035 messages (\01\-\035); cur=23
117 /usr/bugs/Mail has \082 messages (\01\-108); cur=82
119 inbox+ has \016 messages (\03\-\022); cur=\05
120 mh has \076 messages (15\-\076); cur=70
121 notes has \0\02 messages (\01\-\0\02); cur=\01
122 ucom has 124 messages (\01\-124); cur=\06; (others)
123 .ta \w'/rnd/phyl/Mail/EP has 'u
125 TOTAL = 339 messages in 7 folders
131 indicates that it is the current folder.
132 The `(others)' indicates that the folder
135 aren't messages. These files may either be sub\-folders, or files that
136 don't belong under the mh file naming scheme.
138 The folder and message totals are output if either a
142 switch is specified. It is suppressed by
147 is given, only the folder name (or names in the case of
149 will be listed. (This is faster because the folders need not
154 is given along with the
158 will, in addition to setting the current folder, list the top\-level subfolders
159 for the current folder (with
161 or list all sub-folders under the current folder recursively (with
166 is supplied, together with
170 it will become the current message of
172 (if it had been supplied)
173 or the current folder.
177 switch lists each folder recursively, so use of this
178 option effectively defeats the speed enhancement of the
181 since each folder must be searched for subfolders. Nevertheless, the
182 combination of these options is useful.
184 .SS "Compacting a Folder"
187 switch will compress the message names in the designated
188 folders, removing holes in message numbering. The
192 to tell the user the general actions that it is
193 taking to compress the folder.
195 .SS "The Folder Stack"
200 to push the current folder
205 argument the current folder. If
207 is not given, the current folder and the
210 are exchanged. This corresponds to the
211 `pushd' operation in the shell.
217 to discard the top of the
219 after setting the current folder to that value.
222 argument is allowed. This corresponds to the `popd'
223 operation in the shell. The
228 are mutually exclusive: the last occurrence of either one overrides
229 any previous occurrence of the other. Both of these switches also set
237 to list the contents of
242 argument is allowed. After a successful
248 action is taken, unless a
250 switch follows them on the command line. This corresponds
251 to the `dirs' operation in the shell. The
262 .ta \w'%etcdir%/ExtraBigFileName 'u
263 ^$HOME/.mmh/profile~^The user profile
266 .SH "PROFILE COMPONENTS"
270 .ta \w'ExtraBigProfileName 'u
271 ^Path:~^To determine the user's mail storage
272 ^Current\-Folder:~^To find the default current folder
273 ^Folder\-Protect:~^To set mode when creating a new folder
274 ^Folder\-Stack:~^To determine the folder stack
275 .\" ^lsproc:~^Program to list the contents of a folder
283 .RB ` +folder "' defaults to the current folder"
284 .RB ` msg "' defaults to none"
290 .RB ` \-print "' is the default if no " \-list ", " \-push ", or " \-pop " is specified"
291 .RB ` \-list "' is the default if " \-push ", or " \-pop " is specified"
299 are given, they will become the current folder and/or message.
302 There is no way to restore the default behavior
303 (to ask the user whether to create a non-existant folder)