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