1 .TH FOLDER %manext1% 2016-08-29 "%nmhversion%"
6 folder, folders \- set/list current nmh folder/message
15 .RB [ \-all " | " \-noall ]
16 .RB [ \-create " | " \-nocreate ]
17 .RB [ \-fast " | " \-nofast ]
18 .RB [ \-header " | " \-noheader ]
19 .RB [ \-recurse " | " \-norecurse ]
20 .RB [ \-total " | " \-nototal ]
21 .RB [ \-list " | " \-nolist ]
22 .RB [ \-push " | " \-pop ]
23 .RB [ \-pack " | " \-nopack ]
24 .RB [ \-print " | " \-noprint ]
25 .RB [ \-verbose " | " \-noverbose ]
37 switch (the default), it lists: the current folder, the number
38 of messages in it and their range (low-high), the folder's
39 current message, and an indication of extra files, if any.
44 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
45 inbox+ has \016 messages (\0\03\-\022); cur=\0\05.
53 are specified, they will become the current folder and/or message.
56 argument is given, this corresponds to a \*(lqcd\*(rq operation
59 argument is given, this corresponds roughly to a \*(lqpwd\*(rq
60 operation in the shell.) If
66 may still be specified to set the current folder and/or message,
67 but the folder summary will not be printed.
69 If the specified (or default) folder doesn't exist,
71 will ask the user if the folder should be created; when
72 standard input is not a tty, the answer is assumed to be
78 to create new folders without query.
79 (This is an easy way to create an empty folder for later use.)
84 to print an error message and exit without creating a folder.
85 .SS "Multiple Folders"
88 will produce a summary line for each top-level folder in the user's
90 directory, sorted alphabetically. (If
92 is invoked by a name ending with \*(lqs\*(rq (e.g.
95 is assumed.) Specifying
99 will include a line for all sub-folders.
100 These folders are all preceded by any read-only folders, which occur as
101 .RI \*(lq atr\-cur\- \*(rq
102 entries in the user's
104 context. For example:
108 .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
109 FOLDER \0\0\0\0\0\0# MESSAGES RANGE CUR (OTHERS)
110 /var/work/folder has \035 messages (\01\-\035); cur=23.
111 /usr/bugs/Mail has \082 messages (\01\-108); cur=82.
112 ff has \0no messages.
113 inbox+ has \016 messages (\03\-\022); cur=\05.
114 mh has \076 messages (15\-\076); cur=70.
115 notes has \0\02 messages (\01\-\0\02); cur=\01.
116 ucom has 124 messages (\01\-124); cur=\06; (others).
117 .ta \w'/rnd/phyl/Mail/EP has 'u
118 TOTAL = 339 messages in 7 folders
122 The \*(lq+\*(rq after
124 indicates that it is the current folder.
125 The \*(lq(others)\*(rq indicates that the folder
127 contains files which aren't messages;
128 these may either be sub-folders, or files that
129 don't belong under the
133 The header is output if either the
137 switches are specified. It is suppressed by
140 The folder and message totals are output if either the
144 switches are specified. They are suppressed by
149 is given, only the folder name (or names, in the case of
152 (This is faster because the folders need not be read.)
160 will, in addition to setting the current folder, list the top-level
161 sub-folders for the current folder (with
163 or list all sub-folders under the current folder recursively (with
168 is supplied, together with
172 it will become the current message of
174 (if it had been supplied)
175 or the current folder.
179 switch lists each folder recursively, so its use effectively
180 defeats the speed enhancement of
182 since each folder must be searched for sub-folders.
183 Nevertheless, the combination of these options is useful.
184 .SS "Compacting a Folder"
187 switch will compress the message names in the designated folders,
188 removing holes in message numbering. The
192 to tell the user the general actions it is 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
225 switches are mutually exclusive: the last occurrence of either one
226 overrides any previous occurrence of the other.
227 The use of either of these switches also sets
239 argument is allowed. After a successful
245 action is taken, unless a
247 switch follows them on the command line. This corresponds
248 to the \*(lqdirs\*(rq operation in the shell. The
253 switches disable the default
260 .SH "PROFILE COMPONENTS"
264 To determine the user's nmh directory.
267 To find the default current folder.
270 To set mode when creating a new folder.
273 To determine the folder stack.
274 .\" ^lsproc:~^Program to list the contents of a folder
302 is the default if none of
321 are given, they will become the current folder and/or message.
323 There is no way to restore the default behavior
324 (to ask the user whether to create a non-existent folder)
projects / nmh / blob