1 .TH FOLDER %manext1% "January 1, 2001" "%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..SS "Multiple Folders"
93 will produce a summary line for each top-level folder
94 in the user's nmh directory, sorted alphabetically. (If
96 is invoked by a name ending with \*(lqs\*(rq (e.g.
99 is assumed). Specifying
104 produce a line for all sub-folders. These folders are all preceded by
105 the read\-only folders, which occur as
106 .RI \*(lq atr\-cur\- \*(rq
107 entries in the user's
109 context. For example:
113 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
114 FOLDER \0\0\0\0\0\0# MESSAGES RANGE CUR (OTHERS)
115 /var/work/folder has \035 messages (\01\-\035); cur=23.
116 /usr/bugs/Mail has \082 messages (\01\-108); cur=82.
117 ff has \0no messages.
118 inbox+ has \016 messages (\03\-\022); cur=\05.
119 mh has \076 messages (15\-\076); cur=70.
120 notes has \0\02 messages (\01\-\0\02); cur=\01.
121 ucom has 124 messages (\01\-124); cur=\06; (others).
122 .ta \w'/rnd/phyl/Mail/EP has 'u
123 TOTAL = 339 messages in 7 folders
127 The \*(lq+\*(rq after
129 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
171 is supplied, together with
175 it will become the current message of
177 (if it had been supplied)
178 or the current folder.
182 switch lists each folder recursively, so use of this
183 option effectively defeats the speed enhancement of the
186 since each folder must be searched for subfolders. Nevertheless, the
187 combination of these options is useful.
189 .SS "Compacting a Folder"
192 switch will compress the message names in the designated
193 folders, removing holes in message numbering. The
197 to tell the user the general actions that it is
198 taking to compress the folder.
200 .SS "The Folder Stack"
205 to push the current folder
210 argument the current folder. If
212 is not given, the current folder and the
215 are exchanged. This corresponds to the
216 \*(lqpushd\*(rq operation in the shell.
222 to discard the top of the
224 after setting the current folder to that value.
227 argument is allowed. This corresponds to the \*(lqpopd\*(rq
228 operation in the shell. The
233 are mutually exclusive: the last occurrence of either one overrides
234 any previous occurrence of the other. Both of these switches also set
242 to list the contents of
247 argument is allowed. After a successful
253 action is taken, unless a
255 switch follows them on the command line. This corresponds
256 to the \*(lqdirs\*(rq operation in the shell. The
266 .ta \w'%etcdir%/ExtraBigFileName 'u
267 ^$HOME/\&.mh\(ruprofile~^The user profile
269 .SH "PROFILE COMPONENTS"
273 .ta \w'ExtraBigProfileName 'u
274 ^Path:~^To determine the user's nmh directory
275 ^Current\-Folder:~^To find the default current folder
276 ^Folder\-Protect:~^To set mode when creating a new folder
277 ^Folder\-Stack:~^To determine the folder stack
278 .\" ^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"
301 are given, they will become the current folder and/or message.
303 There is no way to restore the default behavior
304 (to ask the user whether to create a non-existant folder)