Allow $PAGER to override the compiled-in default pager command.
[mmh] / man / nmh.man
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH NMH %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 nmh \- new MH message system
7 .SH SYNOPSIS
8 any
9 .B nmh
10 command
11 .SH DESCRIPTION
12 .B nmh
13 is the name of a powerful message handling system.  Rather than
14 being a single comprehensive program,
15 .B nmh
16 consists of a collection
17 of fairly simple single-purpose programs to send, retrieve, save,
18 and manipulate messages.
19 .PP
20 Unlike most mail clients in UNIX,
21 .B nmh
22 is not a closed system which
23 must be explicitly run, then exited when you wish to return to the shell.
24 You may freely intersperse
25 .B nmh
26 commands with other shell commands,
27 allowing you to read and answer your mail while you have (for example)
28 a compilation running, or search for a file or run programs as needed
29 to find the answer to someone's question before answering their mail.
30 .PP
31 The rest of this manual entry is a quick tutorial which will teach you
32 the basics of
33 .BR nmh .
34 You should read the manual entries for the
35 individual programs for complete documentation.
36 .PP
37 To get started using
38 .BR nmh ,
39 put the directory
40 .I %bindir%
41 on your
42 .BR $PATH .
43 This is best done in one of the files:
44 .IR \&.profile ,
45 .IR \&.login ,
46 .IR \&.bashrc ,
47 or
48 .I \&.cshrc
49 in your home directory.  (Check the
50 manual entry for the shell you use, in case you don't know how to
51 do this.)  Run the
52 .B install-mh
53 command.  If you've never used
54 .B nmh
55 before, it will create the necessary default files and directories after
56 asking you if you wish it to do so.
57 .PP
58 .B inc
59 moves mail from your system maildrop into your
60 .B nmh
61 `+inbox' folder, breaking it up into separate files and converting it
62 to
63 .B nmh
64 format as it goes.  It prints one line for each message it
65 processes, containing the from field, the subject field and as much of
66 the first line of the message as will fit.  It leaves the first message
67 it processes as your current message.  You'll need to run
68 .B inc
69 each
70 time you wish to incorporate new mail into your
71 .B nmh
72 file.
73 .PP
74 .B scan
75 .B prints a list of the messages in your current folder.
76 .PP
77 The commands:
78 .BR show ,
79 .BR next ,
80 and
81 .B prev
82 are used to read
83 specific messages from the current folder.
84 .B show
85 displays the
86 current message, or a specific message, which may be specified by its
87 number, which you pass as an argument to
88 .BR show .
89 .B next
90 and
91 .B prev
92 display, respectively, the message numerically after or before
93 the current message.  In all cases, the message displayed becomes the
94 current message.  If there is no current message,
95 .B show
96 may be
97 called with an argument, or
98 .B next
99 may be used to advance to the
100 first message.
101 .PP
102 .B rmm
103 (remove message) deletes the current message.  It may be called
104 with message numbers passed as arguments, to delete specific messages.
105 .PP
106 .B repl
107 is used to respond to the current message (by default).
108 It places you in the editor with a prototype response form.  While you're
109 in the editor, you may peruse the item you're responding to by reading
110 the file
111 .IR @ .
112 After completing your response, type
113 .B l
114 to
115 .B list
116 (review) it, or
117 .B s
118 to
119 .B send
120 it.
121 .PP
122 .B comp
123 allows you to compose a message by putting you in the editor
124 on a prototype message form, and then lets you send it via the
125 .B whatnow
126 command.
127 .B whatnow
128 also supports easy\-to\-use management of MIME attachments via
129 its
130 .B attach
131 and related responses, as described in its man page.
132 .PP
133 All the
134 .B nmh
135 commands may be run with the single argument:
136 .BR \-help ,
137 which causes them to print a list of the arguments they may be invoked
138 with and then exit.
139 .PP
140 All the
141 .B nmh
142 commands may be run with the single argument:
143 .BR \-version ,
144 which cause them to print the version number of the
145 .B nmh
146 distribution, and then exit.
147 .PP
148 Commands which take a message number as an argument (
149 .BR scan ,
150 .BR show ,
151 .BR repl ,
152 \&...)  also take one of the words: \*(lqfirst\*(rq,
153 \*(lqprev\*(rq, \*(lqcur\*(rq, \*(lqnext\*(rq, or \*(lqlast\*(rq to indicate
154 (respectively) the first, previous, current, next, or last message in
155 the current folder (assuming they are defined).
156
157 Commands which take a range of message numbers (
158 .BR rmm ,
159 .BR scan ,
160 .BR show ,
161 \&...)  also take any of the abbreviations:
162 .PP
163 .RS 5
164 .IP \fI<num1>\fR\-\fI<num2>\fR 15
165 Indicates all messages in the range <num1> to <num2>, inclusive. The range must be nonempty.
166 .IP \fI<num>\fR:+\fIN\fR 15
167 .IP \fI<num>\fR:\-\fIN\fR 15
168 Up to
169 .I N
170 messages beginning with (or ending with) message
171 .IR num .
172 .I Num
173 may be any of the pre-defined symbols:
174 .IR first ,
175 .IR prev ,
176 .IR cur ,
177 .I next
178 or
179 .IR last .
180 .IP first:\fIN\fR 15
181 .IP prev:\fIN\fR 15
182 .IP next:\fIN\fR 15
183 .IP last:\fIN\fR 15
184 The first, previous, next or last
185 messages, if they exist.
186 .RE
187 .PP
188 There are many other possibilities such as creating multiple folders
189 for different topics, and automatically refiling messages according to
190 subject, source, destination, or content.  These are beyond the scope
191 of this manual entry.
192 .PP
193 Following is a list of all the
194 .B nmh
195 commands:
196 .PP
197 .RS 5
198 .fc ^ ~
199 .nf
200 .ta 1.5i
201 ^ali(1)~^\- list mail aliases
202 ^anno(1)~^\- annotate messages
203 ^burst(1)~^\- explode digests into messages
204 ^comp(1)~^\- compose a message
205 ^dist(1)~^\- redistribute a message to additional addresses
206 ^flist(1)~^\- list folders with messages in given sequence(s)
207 ^flists(1)~^\- list all folders with messages in given sequence(s)
208 ^folder(1)~^\- set/list current folder/message
209 ^folders(1)~^\- list all folders
210 ^forw(1)~^\- forward messages
211 ^inc(1)~^\- incorporate new mail
212 ^mark(1)~^\- mark messages
213 ^mhbuild(1)~^\- translate MIME composition draft
214 ^mhl(1)~^\- produce formatted listings of nmh messages
215 ^mhlist(1)~^\- list information about content of MIME messages
216 ^mhmail(1)~^\- send or read mail
217 ^mhn(1)~^\- display/list/store/cache MIME messages
218 ^mhparam(1)~^\- print nmh profile components
219 ^mhpath(1)~^\- print full pathnames of nmh messages and folders
220 ^mhshow(1)~^\- display MIME messages
221 ^mhstore(1)~^\- store contents of MIME messages into files
222 ^msgchk(1)~^\- check for messages
223 ^msh(1)~^\- nmh shell(and BBoard reader)
224 ^next(1)~^\- show the next message
225 ^packf(1)~^\- compress a folder into a single file
226 ^pick(1)~^\- select messages by content
227 ^prev(1)~^\- show the previous message
228 ^prompter(1)~^\- prompting editor front end
229 ^rcvdist(1)~^\- asynchronously redistribute new mail
230 ^rcvpack(1)~^\- append message to file
231 ^rcvstore(1)~^\- asynchronously incorporate new mail
232 ^rcvtty(1)~^\- report new mail
233 ^refile(1)~^\- file messages in other folders
234 ^repl(1)~^\- reply to a message
235 ^rmf(1)~^\- remove folder
236 ^rmm(1)~^\- remove messages
237 ^scan(1)~^\- produce a one line per message scan listing
238 ^send(1)~^\- send a message
239 ^sendfiles(1)~^\- send multiple files and directories in MIME message
240 ^show(1)~^\- show(display) messages
241 ^slocal(1)~^\- asynchronously filter and deliver new mail
242 ^sortm(1)~^\- sort messages
243 ^whatnow(1)~^\- prompting front\-end for send
244 ^whom(1)~^\- report to whom a message would go
245 .sp
246 ^mh\-alias(5)~^\- alias file for nmh message system
247 ^mh\-draft(5)~^\- draft folder facility
248 ^mh\-format(5)~^\- format file for nmh message system
249 ^mh\-mail(5)~^\- message format for nmh message system
250 ^mh\-profile(5)~^\- user customization for nmh message system
251 ^mh\-sequence(5)~^\- sequence specification for nmh message system
252 ^mh\-tailor(5)~^\- mail transport configuration for nmh message system
253 .sp
254 ^ap(8)~^\- parse addresses 822\-style
255 ^conflict(8)~^\- search for alias/password conflicts
256 ^dp(8)~^\- parse dates 822\-style
257 ^fmtdump(8)~^\- decode \fInmh\fP format files
258 ^install\-mh(8)~^\- initialize the nmh environment
259 ^post(8)~^\- deliver a message
260 .fi
261 .RE
262
263 .SH FILES
264 .fc ^ ~
265 .nf
266 .ta \w'%etcdir%/ExtraBigFileName  'u
267 ^%bindir%~^contains \fInmh\fR commands
268 ^%etcdir%~^contains \fInmh\fR format files
269 ^%libdir%~^contains \fInmh\fR library commands
270 ^$HOME/\&.mh\(ruprofile~^The user profile
271 .fi
272
273 .SH "PROFILE COMPONENTS"
274 .fc ^ ~
275 .nf
276 .ta 2.4i
277 .ta \w'ExtraBigProfileName  'u
278 ^Path:~^To determine the user's nmh directory
279 .fi
280
281 .SH BUGS
282 If problems are encountered with an
283 .B nmh
284 program, the problems should
285 be reported to the local maintainers of
286 .BR nmh .
287 When doing this, the
288 name of the program should be reported, along with the version information
289 for the program.
290 .br
291 To find out what version of an
292 .B nmh
293 program is being run, invoke
294 the program with the
295 .B \-version
296 switch.  This information includes
297 the version of
298 .BR nmh ,
299 the host it was generated on, and the date the
300 program was loaded.
301 .PP
302 Send bug reports and suggestions to
303 .IR nmh-workers@nongnu.org .
304 .SH "SEE ALSO"
305 mh-chart(7)