cc62145df88690d180b6b93b3672c419ea4f8541
[mmh] / man / nmh.man
1 .TH NMH %manext7% "September 11, 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 .IR <num> :+ N
166 .PD 0
167 .TP
168 .IR <num> :\-N
169 Up to
170 .I N
171 messages beginning with (or ending with) message
172 .IR num .
173 .I Num
174 may be any of the pre-defined symbols
175 .BR first ,
176 .BR prev ,
177 .BR cur ,
178 .B next
179 or
180 .BR last .
181 .PD
182 .TP
183 .RI first: N
184 .PD 0
185 .TP
186 .RI prev: N
187 .TP
188 .RI next: N
189 .TP
190 .RI last: N
191 The first, previous, next or last
192 messages, if they exist.
193 .PD
194 .PP
195 There are many other possibilities such as creating multiple folders
196 for different topics, and automatically refiling messages according to
197 subject, source, destination, or content.  These are beyond the scope
198 of this manual entry.
199 .ne 4
200 .SH COMMANDS
201 .PP
202 Following is a list of all the
203 .B nmh
204 commands, grouped loosely according to their role.
205 .ne 4
206 .SS
207 Sending
208 .TP \n(ttu
209 .PD 0
210 .IR comp (1)
211 compose a message
212 .TP
213 .IR forw (1)
214 forward messages
215 .TP
216 .IR repl (1)
217 reply to a message
218 .TP
219 .IR whatnow (1)
220 prompting front-end for send
221 .PD
222 .PP
223 Note that although
224 .B whatnow
225 provides much of the primary
226 .B nmh
227 user interface for sending mail, it is almost never invoked manually,
228 but rather is invoked indirectly by one of the above commands, after
229 you've composed a message in your editor, and before you've decided to
230 send it.  Here you can add attachments, check the recipient
231 list, decide to quit and send it later, etc.
232 .PP
233 Related utilities:
234 .TP \n(ttu
235 .PD 0
236 .IR ali (1)
237 list mail aliases
238 .TP
239 .IR anno (1)
240 annotate messages
241 .TP
242 .IR whom (1)
243 report to whom a message would go
244 .TP
245 .IR dist (1)
246 redistribute a message to additional addresses
247 .PD
248 .PP
249 Advanced commands, only sometimes invoked directly:
250 .TP \n(ttu
251 .PD 0
252 .IR mhbuild (1)
253 translate MIME composition draft
254 .TP
255 .IR send (1)
256 send a message
257 .TP
258 .IR sendfiles (1)
259 send multiple files in a MIME message
260 .PD
261 .ne 4
262 .SS
263 Incorporating
264 .TP \n(ttu
265 .IR inc (1)
266 incorporate new mail
267 .PP
268 Related utilities:
269 .TP \n(ttu
270 .PD 0
271 .IR burst (1)
272 explode digests into messages
273 .TP
274 .IR msgchk (1)
275 check for messages
276 .TP
277 .IR rcvdist (1)
278 asynchronously redistribute new mail
279 .TP
280 .IR rcvpack (1)
281 append message to file
282 .TP
283 .IR rcvstore (1)
284 asynchronously incorporate new mail
285 .TP
286 .IR slocal (1)
287 asynchronously filter and deliver new mail
288 .PD
289 .ne 4
290 .SS
291 Viewing
292 .TP \n(ttu
293 .PD 0
294 .IR next (1)
295 show the next message
296 .TP
297 .IR prev (1)
298 show the previous message
299 .TP
300 .IR show (1)
301 show(display) messages
302 .TP
303 .IR scan (1)
304 produce a one line per message scan listing
305 .TP
306 .IR fnext (1)
307 select the next folder with new messages
308 .TP
309 .IR fprev (1)
310 select the previous folder with new messages
311 .PD
312 .PP
313 Related utilities, only sometimes invoked directly:
314 .TP \n(ttu
315 .PD 0
316 .IR mhl (1)
317 produce formatted listings of nmh messages
318 .TP
319 .IR mhlist (1)
320 list information about content of MIME messages
321 .TP
322 .IR mhn (1)
323 display/list/store/cache MIME messages
324 .TP
325 .IR mhshow (1)
326 display MIME messages
327 .TP
328 .IR mhstore (1)
329 store contents of MIME messages into files
330 .PD
331 .ne 4
332 .SS
333 Searching
334 .PP
335 Within a folder:
336 .TP \n(ttu
337 .IR pick (1)
338 select messages by content
339 .PP
340 Across folders:
341 .TP \n(ttu
342 .PD 0
343 .IR new (1)
344 list folders with new messages
345 .TP
346 .IR unseen (1)
347 list new messages in a give set of folders
348 .TP
349 .IR flist (1)
350 list folders with messages in given sequence(s)
351 .TP
352 .IR flists (1)
353 list all folders with messages in given sequence(s)
354 .TP
355 .IR folder (1)
356 set/list current folder/message
357 .TP
358 .IR folders (1)
359 list all folders
360 .PD
361 .ne 4
362 .SS
363 Organizing
364 .TP \n(ttu
365 .PD 0
366 .IR mark (1)
367 mark messages
368 .TP
369 .IR refile (1)
370 file messages in other folders
371 .TP
372 .IR rmf (1)
373 remove folder
374 .TP
375 .IR rmm (1)
376 remove messages
377 .TP
378 .IR sortm (1)
379 sort messages
380 .PD
381 .ne 4
382 .SS
383 Convenience Wrappers
384 .TP \n(ttu
385 .PD 0
386 .IR mhmail (1)
387 send or read mail
388 .TP
389 .IR msh (1)
390 nmh shell
391 .PD
392 .ne 4
393 .SS
394 Utilities
395 .TP \n(ttu
396 .PD 0
397 .IR mhparam (1)
398 print nmh profile components
399 .TP
400 .IR mhpath (1)
401 print full pathnames of nmh messages and folders
402 .TP
403 .IR packf (1)
404 compress a folder into a single file
405 .TP
406 .IR prompter (1)
407 prompting editor front end
408 .TP
409 .IR rcvtty (1)
410 report new mail
411 .PD
412 .ne 4
413 .SS
414 Indirectly Invoked Commands
415 .TP \n(ttu
416 .PD 0
417 .IR ap (8)
418 parse addresses 822\-style
419 .TP
420 .IR conflict (8)
421 search for alias/password conflicts
422 .TP
423 .IR dp (8)
424 parse dates 822\-style
425 .TP
426 .IR fmtdump (8)
427 decode
428 .IR mh-format (5)
429 files
430 .TP
431 .IR install\-mh (8)
432 initialize the nmh environment
433 .TP
434 .IR post (8)
435 deliver a message
436 .PD
437 .ne 4
438 .SS
439 Files Used by nmh Commands
440 .TP \n(ttu
441 .PD 0
442 .IR mh\-alias (5)
443 alias file for nmh message system
444 .TP
445 .IR mh\-draft (5)
446 draft folder facility
447 .TP
448 .IR mh\-format (5)
449 format file for nmh message system
450 .TP
451 .IR mh\-mail (5)
452 message format for nmh message system
453 .TP
454 .IR mh\-profile (5)
455 user customization for nmh message system
456 .TP
457 .IR mh\-sequence (5)
458 sequence specification for nmh message system
459 .TP
460 .IR mh\-tailor (5)
461 mail transport customization for nmh message system
462 .PD
463 .ne 4
464 .SH FILES
465 .TP
466 %bindir%
467 contains
468 .B nmh
469 commands
470 .TP
471 %etcdir%
472 contains
473 .B nmh
474 format files
475 .TP
476 %libdir%
477 contains
478 .B nmh
479 library commands
480 .TP
481 $HOME/\&.mh\-profile
482 The user's nmh profile
483 .ne 4
484 .SH "SEE ALSO"
485 .IR install-mh (1),
486 .IR mh-profile (5),
487 .IR mh-chart (7)
488 .ne 4
489 .SH BUGS
490 If problems are encountered with an
491 .B nmh
492 program, the problems should
493 be reported to the local maintainers of
494 .BR nmh .
495 When doing this, the
496 name of the program should be reported, along with the version information
497 for the program.
498 .PP
499 To find out what version of an
500 .B nmh
501 program is being run, invoke
502 the program with the
503 .B \-version
504 switch.  This prints
505 the version of
506 .BR nmh ,
507 the host it was compiled on, and the date the
508 program was linked.
509 .PP
510 Send bug reports and suggestions to
511 .IR nmh-workers@nongnu.org .