Added description of "all" range abbreviation.
[mmh] / man / nmh.man
1 .TH NMH %manext7% "November 3, 2012" "%nmhversion%"
2 .\"
3 .\" %nmhwarning%
4 .\"
5 .\" Register 'tt' contains the indent for .TP in the COMMANDS section:
6 .nr tt \w'\fImh-sequence\fR(5)\0\0'u
7 .\"
8 .SH NAME
9 nmh \- new MH message system
10 .SH SYNOPSIS
11 any
12 .B nmh
13 command
14 .SH DESCRIPTION
15 .B nmh
16 is the name of a powerful message handling system.  Rather than
17 being a single comprehensive program,
18 .B nmh
19 consists of a collection
20 of fairly simple single-purpose programs to send, retrieve, save,
21 and manipulate messages.
22 .PP
23 Unlike most mail clients in UNIX,
24 .B nmh
25 is not a closed system which
26 must be explicitly run, then exited when you wish to return to the shell.
27 You may freely intersperse
28 .B nmh
29 commands with other shell commands,
30 allowing you to read and answer your mail while you have (for example)
31 a compilation running, or search for a file or run programs as needed
32 to find the answer to someone's question before answering their mail.
33 .PP
34 The rest of this manual entry is a quick tutorial which will teach you
35 the basics of
36 .BR nmh .
37 You should read the manual entries for the
38 individual programs for complete documentation.
39 .PP
40 To get started using
41 .BR nmh ,
42 put the directory
43 \*(lq%bindir%\*(rq
44 in your
45 .BR $PATH .
46 (Check the
47 manual entry for the shell you use if you don't know how to
48 do this.)  Run the
49 .B install-mh
50 command.  If you've never used
51 .B nmh
52 before, it will create the necessary default files and directories after
53 asking you if you wish it to do so.
54 .PP
55 .B inc
56 moves mail from your system maildrop into your
57 .B nmh
58 \*(lq+inbox\*(rq
59 folder, breaking it up into separate files and converting it
60 to
61 .B nmh
62 format as it goes.  It prints one line for each message it
63 processes, containing the from field, the subject field and as much of
64 the first line of the message as will fit.  It leaves the first message
65 it processes as your current message.  You'll need to run
66 .B inc
67 each
68 time you wish to incorporate new mail into your
69 .B nmh
70 file.
71 .PP
72 .B scan
73 prints a list of the messages in your current folder.
74 .PP
75 The commands
76 .BR show ,
77 .BR next ,
78 and
79 .B prev
80 are used to read
81 specific messages from the current folder.
82 .B show
83 displays the
84 current message, or a specific message, which may be specified by its
85 number, which you pass as an argument to
86 .BR show .
87 .B next
88 and
89 .B prev
90 display, respectively, the message numerically after or before
91 the current message.  In all cases, the message displayed becomes the
92 current message.  If there is no current message,
93 .B show
94 may be
95 called with an argument, or
96 .B next
97 may be used to advance to the
98 first message.
99 .PP
100 .B rmm
101 (remove message) deletes the current message.  It may be called
102 with message numbers passed as arguments, to delete specific messages.
103 .PP
104 .B repl
105 is used to respond to the current message (by default).
106 It places you in the editor with a prototype response form.  While you're
107 in the editor, you may peruse the item you're responding to by reading
108 the file
109 .BR @ .
110 After completing your response, type
111 \*(lql\*(rq
112 to
113 .B list
114 (review) it, or
115 \*(lqs\*(rq
116 to
117 .B send
118 it.
119 .PP
120 .B comp
121 allows you to compose a message by putting you in the editor
122 on a prototype message form, and then lets you send it via the
123 .B whatnow
124 command.
125 .B whatnow
126 also supports easy\-to\-use management of MIME attachments via
127 its
128 .B attach
129 and related responses, as described in its man page.
130 .PP
131 All the
132 .B nmh
133 commands may be run with the single argument
134 .BR \-help ,
135 which causes them to print a list of the arguments they may be invoked
136 with and then exit.
137 .PP
138 All the
139 .B nmh
140 commands may be run with the single argument
141 .BR \-version ,
142 which causes them to print the version number of the
143 .B nmh
144 distribution, and then exit.
145 .PP
146 Commands which take a message number as an argument
147 .RB ( scan ,
148 .BR show ,
149 .BR repl ,
150 \&...)  also take one of the words \*(lqfirst\*(rq,
151 \*(lqprev\*(rq, \*(lqcur\*(rq, \*(lqnext\*(rq, or \*(lqlast\*(rq to indicate
152 (respectively) the first, previous, current, next, or last message in
153 the current folder (assuming they are defined).
154 .PP
155 Commands which take a range of message numbers
156 .RB ( rmm ,
157 .BR scan ,
158 .BR show ,
159 \&...)  also take any of the abbreviations:
160 .TP \n(ttu
161 .IR <num1> - <num2>
162 Indicates all messages in the range <num1> to <num2>, inclusive.
163 The range must be nonempty.
164 .TP
165 .RI all
166 Indicates all messages, i.e.,
167 .IR first - last .
168 .TP
169 .IR <num> :+ N
170 .PD 0
171 .TP
172 .IR <num> :\-N
173 Up to
174 .I N
175 messages beginning with (or ending with) message
176 .IR num .
177 .I Num
178 may be any of the pre-defined symbols
179 .BR first ,
180 .BR prev ,
181 .BR cur ,
182 .B next
183 or
184 .BR last .
185 .PD
186 .TP
187 .RI first: N
188 .PD 0
189 .TP
190 .RI prev: N
191 .TP
192 .RI next: N
193 .TP
194 .RI last: N
195 The first, previous, next or last
196 messages, if they exist.
197 .PD
198 .PP
199 There are many other possibilities such as creating multiple folders
200 for different topics, and automatically refiling messages according to
201 subject, source, destination, or content.  These are beyond the scope
202 of this manual entry.
203 .ne 4
204 .SH COMMANDS
205 .PP
206 Following is a list of all the
207 .B nmh
208 commands, grouped loosely according to their role.
209 .ne 4
210 .SS
211 Sending
212 .TP \n(ttu
213 .PD 0
214 .IR comp (1)
215 compose a message
216 .TP
217 .IR forw (1)
218 forward messages
219 .TP
220 .IR repl (1)
221 reply to a message
222 .TP
223 .IR whatnow (1)
224 prompting front-end for send
225 .PD
226 .PP
227 Note that although
228 .B whatnow
229 provides much of the primary
230 .B nmh
231 user interface for sending mail, it is almost never invoked manually,
232 but rather is invoked indirectly by one of the above commands, after
233 you've composed a message in your editor, and before you've decided to
234 send it.  Here you can add attachments, check the recipient
235 list, decide to quit and send it later, etc.
236 .PP
237 Related utilities:
238 .TP \n(ttu
239 .PD 0
240 .IR ali (1)
241 list mail aliases
242 .TP
243 .IR anno (1)
244 annotate messages
245 .TP
246 .IR whom (1)
247 report to whom a message would go
248 .TP
249 .IR dist (1)
250 redistribute a message to additional addresses
251 .PD
252 .PP
253 Advanced commands, only sometimes invoked directly:
254 .TP \n(ttu
255 .PD 0
256 .IR mhbuild (1)
257 translate MIME composition draft
258 .TP
259 .IR send (1)
260 send a message
261 .TP
262 .IR sendfiles (1)
263 send multiple files in a MIME message
264 .PD
265 .ne 4
266 .SS
267 Incorporating
268 .TP \n(ttu
269 .IR inc (1)
270 incorporate new mail
271 .PP
272 Related utilities:
273 .TP \n(ttu
274 .PD 0
275 .IR burst (1)
276 explode digests into messages
277 .TP
278 .IR msgchk (1)
279 check for messages
280 .TP
281 .IR rcvdist (1)
282 asynchronously redistribute new mail
283 .TP
284 .IR rcvpack (1)
285 append message to file
286 .TP
287 .IR rcvstore (1)
288 asynchronously incorporate new mail
289 .TP
290 .IR slocal (1)
291 asynchronously filter and deliver new mail
292 .PD
293 .ne 4
294 .SS
295 Viewing
296 .TP \n(ttu
297 .PD 0
298 .IR next (1)
299 show the next message
300 .TP
301 .IR prev (1)
302 show the previous message
303 .TP
304 .IR show (1)
305 show(display) messages
306 .TP
307 .IR scan (1)
308 produce a one line per message scan listing
309 .TP
310 .IR fnext (1)
311 select the next folder with new messages
312 .TP
313 .IR fprev (1)
314 select the previous folder with new messages
315 .PD
316 .PP
317 Related utilities, only sometimes invoked directly:
318 .TP \n(ttu
319 .PD 0
320 .IR mhl (1)
321 produce formatted listings of nmh messages
322 .TP
323 .IR mhlist (1)
324 list information about content of MIME messages
325 .TP
326 .IR mhn (1)
327 display/list/store/cache MIME messages
328 .TP
329 .IR mhshow (1)
330 display MIME messages
331 .TP
332 .IR mhstore (1)
333 store contents of MIME messages into files
334 .PD
335 .ne 4
336 .SS
337 Searching
338 .PP
339 Within a folder:
340 .TP \n(ttu
341 .IR pick (1)
342 select messages by content
343 .PP
344 Across folders:
345 .TP \n(ttu
346 .PD 0
347 .IR new (1)
348 list folders with new messages
349 .TP
350 .IR unseen (1)
351 list new messages in a give set of folders
352 .TP
353 .IR flist (1)
354 list folders with messages in given sequence(s)
355 .TP
356 .IR flists (1)
357 list all folders with messages in given sequence(s)
358 .TP
359 .IR folder (1)
360 set/list current folder/message
361 .TP
362 .IR folders (1)
363 list all folders
364 .PD
365 .ne 4
366 .SS
367 Organizing
368 .TP \n(ttu
369 .PD 0
370 .IR mark (1)
371 mark messages
372 .TP
373 .IR refile (1)
374 file messages in other folders
375 .TP
376 .IR rmf (1)
377 remove folder
378 .TP
379 .IR rmm (1)
380 remove messages
381 .TP
382 .IR sortm (1)
383 sort messages
384 .PD
385 .ne 4
386 .SS
387 Convenience Wrappers
388 .TP \n(ttu
389 .PD 0
390 .IR mhmail (1)
391 send or read mail
392 .TP
393 .IR msh (1)
394 nmh shell
395 .PD
396 .ne 4
397 .SS
398 Utilities
399 .TP \n(ttu
400 .PD 0
401 .IR mhparam (1)
402 print nmh profile components
403 .TP
404 .IR mhpath (1)
405 print full pathnames of nmh messages and folders
406 .TP
407 .IR packf (1)
408 compress a folder into a single file
409 .TP
410 .IR prompter (1)
411 prompting editor front end
412 .TP
413 .IR rcvtty (1)
414 report new mail
415 .PD
416 .ne 4
417 .SS
418 Indirectly Invoked Commands
419 .TP \n(ttu
420 .PD 0
421 .IR ap (8)
422 parse addresses 822\-style
423 .TP
424 .IR conflict (8)
425 search for alias/password conflicts
426 .TP
427 .IR dp (8)
428 parse dates 822\-style
429 .TP
430 .IR fmtdump (8)
431 decode
432 .IR mh-format (5)
433 files
434 .TP
435 .IR install\-mh (8)
436 initialize the nmh environment
437 .TP
438 .IR post (8)
439 deliver a message
440 .PD
441 .ne 4
442 .SS
443 Files Used by nmh Commands
444 .TP \n(ttu
445 .PD 0
446 .IR mh\-alias (5)
447 alias file for nmh message system
448 .TP
449 .IR mh\-draft (5)
450 draft folder facility
451 .TP
452 .IR mh\-format (5)
453 format file for nmh message system
454 .TP
455 .IR mh\-mail (5)
456 message format for nmh message system
457 .TP
458 .IR mh\-profile (5)
459 user customization for nmh message system
460 .TP
461 .IR mh\-sequence (5)
462 sequence specification for nmh message system
463 .TP
464 .IR mh\-tailor (5)
465 mail transport customization for nmh message system
466 .PD
467 .ne 4
468 .SH FILES
469 .TP
470 %bindir%
471 contains
472 .B nmh
473 commands
474 .TP
475 %etcdir%
476 contains
477 .B nmh
478 format files
479 .TP
480 %libdir%
481 contains
482 .B nmh
483 library commands
484 .TP
485 $HOME/\&.mh\-profile
486 The user's nmh profile
487 .ne 4
488 .SH "SEE ALSO"
489 .IR install-mh (1),
490 .IR mh-profile (5),
491 .IR mh-chart (7)
492 .ne 4
493 .SH BUGS
494 If problems are encountered with an
495 .B nmh
496 program, the problems should
497 be reported to the local maintainers of
498 .BR nmh .
499 When doing this, the
500 name of the program should be reported, along with the version information
501 for the program.
502 .PP
503 To find out what version of an
504 .B nmh
505 program is being run, invoke
506 the program with the
507 .B \-version
508 switch.  This prints
509 the version of
510 .BR nmh ,
511 the host it was compiled on, and the date the
512 program was linked.
513 .PP
514 Send bug reports and suggestions to
515 .IR nmh-workers@nongnu.org .