5 .TH FOLDER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
7 folder, folders \- set/list current folder/message
13 .RB [ \-all " | " \-noall ]
14 .RB [ \-create " | " \-nocreate ]
15 .RB [ \-fast " | " \-nofast ]
16 .RB [ \-header " | " \-noheader ]
17 .RB [ \-recurse " | " \-norecurse ]
18 .RB [ \-total " | " \-nototal ]
19 .RB [ \-list " | " \-nolist ]
20 .RB [ \-push " | " \-pop ]
21 .RB [ \-pack " | " \-nopack ]
23 .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 \*(lqcd\*(rq operation
64 argument is given, this corresponds roughly to a \*(lqpwd\*(rq
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 nmh directory, sorted alphabetically. (If
97 is invoked by a name ending with \*(lqs\*(rq (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
107 .RI \*(lq atr\-cur\- \*(rq
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.
118 ff has \0no messages.
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
129 The \*(lq+\*(rq after inbox indicates that it is the current folder.
130 The \*(lq(others)\*(rq indicates that the folder
133 aren't messages. These files may either be sub\-folders, or files that
134 don't belong under the nmh file naming scheme.
136 The header is output if either a
140 switch is specified. It is suppressed by
143 The folder and message totals are output if either a
147 switch is specified. It is suppressed by
152 is given, only the folder name (or names in the case of
154 will be listed. (This is faster because the folders need not
159 is given along with the
163 will, in addition to setting the current folder, list the top\-level subfolders
164 for the current folder (with
166 or list all sub-folders under the current folder recursively (with
170 is also supplied, it will become the current message of
175 switch lists each folder recursively, so use of this
176 option effectively defeats the speed enhancement of the
179 since each folder must be searched for subfolders. Nevertheless, the
180 combination of these options is useful.
182 .SS "Compacting a Folder"
185 switch will compress the message names in the designated
186 folders, removing holes in message numbering. The
190 to tell the user the general actions that it is
191 taking to compress the folder.
193 .SS "The Folder Stack"
198 to push the current folder
203 argument the current folder. If
205 is not given, the current folder and the
208 are exchanged. This corresponds to the
209 \*(lqpushd\*(rq operation in the shell.
215 to discard the top of the
217 after setting the current folder to that value.
220 argument is allowed. This corresponds to the \*(lqpopd\*(rq
221 operation in the shell. The
226 are mutually exclusive: the last occurrence of either one overrides
227 any previous occurrence of the other. Both of these switches also set
235 to list the contents of
240 argument is allowed. After a successful
246 action is taken, unless a
248 switch follows them on the command line. This corresponds
249 to the \*(lqdirs\*(rq operation in the shell. The
260 .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
261 ^$HOME/\&.mh\(ruprofile~^The user profile
263 .SH "PROFILE COMPONENTS"
267 .ta \w'ExtraBigProfileName 'u
268 ^Path:~^To determine the user's nmh directory
269 ^Current\-Folder:~^To find the default current folder
270 ^Folder\-Protect:~^To set mode when creating a new folder
271 ^Folder\-Stack:~^To determine the folder stack
272 .\" ^lsproc:~^Program to list the contents of a folder
279 .RB ` +folder "' defaults to the current folder"
280 .RB ` msg "' defaults to none"
287 .RB ` \-print "' is the default if no " \-list ", " \-push ", or " \-pop " is specified"
288 .RB ` \-list "' is the default if " \-push ", or " \-pop " is specified"
295 are given, they will become the current folder and/or message.
298 There is no way to restore the default behavior
299 (to ask the user whether to create a non-existant folder)