5 .TH FOLDER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
7 folder, folders \- set/list current folder/message
14 .RB [ \-all " | " \-noall ]
15 .RB [ \-create " | " \-nocreate ]
16 .RB [ \-fast " | " \-nofast ]
17 .RB [ \-header " | " \-noheader ]
18 .RB [ \-recurse " | " \-norecurse ]
19 .RB [ \-total " | " \-nototal ]
20 .RB [ \-list " | " \-nolist ]
21 .RB [ \-push " | " \-pop ]
22 .RB [ \-pack " | " \-nopack ]
24 .RB [ \-verbose " | " \-noverbose ]
37 environment is the shell, it is easy to lose track
38 of the current folder from day to day. When
44 will list the current folder,
45 the number of messages in it, the range of the messages (low\-high),
46 and the current message within the folder, and will flag extra files if
47 they exist. An example of this summary is:
51 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
52 inbox+ has \016 messages (\0\03\-\022); cur=\0\05.
60 are specified, they will become the current
61 folder and/or message. By comparison, when a
63 argument is given, this corresponds to a \*(lqcd\*(rq operation
66 argument is given, this corresponds roughly to a \*(lqpwd\*(rq
67 operation in the shell.
69 If the specified (or default) folder doesn't exist, the default action
70 is to query the user as to whether the folder should be created; when
71 standard input is not a tty, the answer to the query is assumed to be
79 without any query. (This is the easy way to create an empty folder for
80 use later.) Specifying
85 without creating a non-existant folder.
87 .\" note - this doesn't work at present
88 .\" If `\-noprint' is specified,
89 .\" a `+folder' and/or `msg' may still be specified
90 .\" to set the current folder and/or message,
91 .\" but the folder summary will not be printed.
93 .SS "Multiple Folders"
96 will produce a summary line for each top-level folder
97 in the user's nmh directory, sorted alphabetically. (If
99 is invoked by a name ending with \*(lqs\*(rq (e.g.
102 is assumed). Specifying
107 produce a line for all sub-folders. These folders are all preceded by
108 the read\-only folders, which occur as
109 .RI \*(lq atr\-cur\- \*(rq
110 entries in the user's
112 context. For example:
116 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
117 FOLDER \0\0\0\0\0\0# MESSAGES RANGE CUR (OTHERS)
118 /var/work/folder has \035 messages (\01\-\035); cur=23.
119 /usr/bugs/Mail has \082 messages (\01\-108); cur=82.
120 ff has \0no messages.
121 inbox+ has \016 messages (\03\-\022); cur=\05.
122 mh has \076 messages (15\-\076); cur=70.
123 notes has \0\02 messages (\01\-\0\02); cur=\01.
124 ucom has 124 messages (\01\-124); cur=\06; (others).
125 .ta \w'/rnd/phyl/Mail/EP has 'u
127 TOTAL = 339 messages in 7 folders
131 The \*(lq+\*(rq after
133 indicates that it is the current folder.
134 The \*(lq(others)\*(rq indicates that the folder
137 aren't messages. These files may either be sub\-folders, or files that
138 don't belong under the nmh file naming scheme.
140 The header is output if either a
144 switch is specified. It is suppressed by
147 The folder and message totals are output if either a
151 switch is specified. It is suppressed by
156 is given, only the folder name (or names in the case of
158 will be listed. (This is faster because the folders need not
163 is given along with the
167 will, in addition to setting the current folder, list the top\-level subfolders
168 for the current folder (with
170 or list all sub-folders under the current folder recursively (with
174 is also supplied, it will become the current message of
179 switch lists each folder recursively, so use of this
180 option effectively defeats the speed enhancement of the
183 since each folder must be searched for subfolders. Nevertheless, the
184 combination of these options is useful.
186 .SS "Compacting a Folder"
189 switch will compress the message names in the designated
190 folders, removing holes in message numbering. The
194 to tell the user the general actions that it is
195 taking to compress the folder.
197 .SS "The Folder Stack"
202 to push the current folder
207 argument the current folder. If
209 is not given, the current folder and the
212 are exchanged. This corresponds to the
213 \*(lqpushd\*(rq operation in the shell.
219 to discard the top of the
221 after setting the current folder to that value.
224 argument is allowed. This corresponds to the \*(lqpopd\*(rq
225 operation in the shell. The
230 are mutually exclusive: the last occurrence of either one overrides
231 any previous occurrence of the other. Both of these switches also set
239 to list the contents of
244 argument is allowed. After a successful
250 action is taken, unless a
252 switch follows them on the command line. This corresponds
253 to the \*(lqdirs\*(rq operation in the shell. The
264 .ta \w'%etcdir%/ExtraBigFileName 'u
265 ^$HOME/\&.mh\(ruprofile~^The user profile
268 .SH "PROFILE COMPONENTS"
272 .ta \w'ExtraBigProfileName 'u
273 ^Path:~^To determine the user's nmh directory
274 ^Current\-Folder:~^To find the default current folder
275 ^Folder\-Protect:~^To set mode when creating a new folder
276 ^Folder\-Stack:~^To determine the folder stack
277 .\" ^lsproc:~^Program to list the contents of a folder
285 .RB ` +folder "' defaults to the current folder"
286 .RB ` msg "' defaults to none"
293 .RB ` \-print "' is the default if no " \-list ", " \-push ", or " \-pop " is specified"
294 .RB ` \-list "' is the default if " \-push ", or " \-pop " is specified"
302 are given, they will become the current folder and/or message.
305 There is no way to restore the default behavior
306 (to ask the user whether to create a non-existant folder)