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 [ \-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 ]
36 environment is the shell, it is easy to lose track
37 of the current folder from day to day. When
43 will list the current folder,
44 the number of messages in it, the range of the messages (low\-high),
45 and the current message within the folder, and will flag extra files if
46 they exist. An example of this summary is:
50 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
51 inbox+ has \016 messages (\0\03\-\022); cur=\0\05.
59 are specified, they will become the current
60 folder and/or message. By comparison, when a
62 argument is given, this corresponds to a \*(lqcd\*(rq operation
65 argument is given, this corresponds roughly to a \*(lqpwd\*(rq
66 operation in the shell.
68 If the specified (or default) folder doesn't exist, the default action
69 is to query the user as to whether the folder should be created; when
70 standard input is not a tty, the answer to the query is assumed to be
78 without any query. (This is the easy way to create an empty folder for
79 use later.) Specifying
84 without creating a non-existant folder.
86 .\" note - this doesn't work at present
87 .\" If `\-noprint' is specified,
88 .\" a `+folder' and/or `msg' may still be specified
89 .\" to set the current folder and/or message,
90 .\" but the folder summary will not be printed.
92 .SS "Multiple Folders"
95 will produce a summary line for each top-level folder
96 in the user's nmh directory, sorted alphabetically. (If
98 is invoked by a name ending with \*(lqs\*(rq (e.g.
101 is assumed). Specifying
106 produce a line for all sub-folders. These folders are all preceded by
107 the read\-only folders, which occur as
108 .RI \*(lq atr\-cur\- \*(rq
109 entries in the user's
111 context. For example:
115 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
116 FOLDER \0\0\0\0\0\0# MESSAGES RANGE CUR (OTHERS)
117 /var/work/folder has \035 messages (\01\-\035); cur=23.
118 /usr/bugs/Mail has \082 messages (\01\-108); cur=82.
119 ff has \0no messages.
120 inbox+ has \016 messages (\03\-\022); cur=\05.
121 mh has \076 messages (15\-\076); cur=70.
122 notes has \0\02 messages (\01\-\0\02); cur=\01.
123 ucom has 124 messages (\01\-124); cur=\06; (others).
124 .ta \w'/rnd/phyl/Mail/EP has 'u
126 TOTAL = 339 messages in 7 folders
130 The \*(lq+\*(rq after
132 indicates that it is the current folder.
133 The \*(lq(others)\*(rq indicates that the folder
136 aren't messages. These files may either be sub\-folders, or files that
137 don't belong under the nmh file naming scheme.
139 The header is output if either a
143 switch is specified. It is suppressed by
146 The folder and message totals are output if either a
150 switch is specified. It is suppressed by
155 is given, only the folder name (or names in the case of
157 will be listed. (This is faster because the folders need not
162 is given along with the
166 will, in addition to setting the current folder, list the top\-level subfolders
167 for the current folder (with
169 or list all sub-folders under the current folder recursively (with
173 is also supplied, it will become the current message of
178 switch lists each folder recursively, so use of this
179 option effectively defeats the speed enhancement of the
182 since each folder must be searched for subfolders. Nevertheless, the
183 combination of these options is useful.
185 .SS "Compacting a Folder"
188 switch will compress the message names in the designated
189 folders, removing holes in message numbering. The
193 to tell the user the general actions that it is
194 taking to compress the folder.
196 .SS "The Folder Stack"
201 to push the current folder
206 argument the current folder. If
208 is not given, the current folder and the
211 are exchanged. This corresponds to the
212 \*(lqpushd\*(rq operation in the shell.
218 to discard the top of the
220 after setting the current folder to that value.
223 argument is allowed. This corresponds to the \*(lqpopd\*(rq
224 operation in the shell. The
229 are mutually exclusive: the last occurrence of either one overrides
230 any previous occurrence of the other. Both of these switches also set
238 to list the contents of
243 argument is allowed. After a successful
249 action is taken, unless a
251 switch follows them on the command line. This corresponds
252 to the \*(lqdirs\*(rq operation in the shell. The
263 .ta \w'%etcdir%/ExtraBigFileName 'u
264 ^$HOME/\&.mh\(ruprofile~^The user profile
267 .SH "PROFILE COMPONENTS"
271 .ta \w'ExtraBigProfileName 'u
272 ^Path:~^To determine the user's nmh directory
273 ^Current\-Folder:~^To find the default current folder
274 ^Folder\-Protect:~^To set mode when creating a new folder
275 ^Folder\-Stack:~^To determine the folder stack
276 .\" ^lsproc:~^Program to list the contents of a folder
284 .RB ` +folder "' defaults to the current folder"
285 .RB ` msg "' defaults to none"
292 .RB ` \-print "' is the default if no " \-list ", " \-push ", or " \-pop " is specified"
293 .RB ` \-list "' is the default if " \-push ", or " \-pop " is specified"
301 are given, they will become the current folder and/or message.
304 There is no way to restore the default behavior
305 (to ask the user whether to create a non-existant folder)