Removed entire docs/historical/mh-6.8.5/local/ tree. It had a pair of
[mmh] / docs / historical / mh-6.8.5 / conf / doc / RCS / mh-intro.rf,v
1 head    1.12;
2 access;
3 symbols;
4 locks; strict;
5
6
7 1.12
8 date    92.10.28.17.00.27;      author jromine; state Exp;
9 branches;
10 next    1.11;
11
12 1.11
13 date    92.02.09.20.55.28;      author jromine; state Exp;
14 branches;
15 next    1.10;
16
17 1.10
18 date    91.01.07.16.56.36;      author mh;      state Exp;
19 branches;
20 next    1.9;
21
22 1.9
23 date    90.04.05.15.08.50;      author sources; state Exp;
24 branches;
25 next    1.8;
26
27 1.8
28 date    90.04.02.14.29.43;      author sources; state Exp;
29 branches;
30 next    1.7;
31
32 1.7
33 date    90.03.22.23.18.13;      author sources; state Exp;
34 branches;
35 next    1.6;
36
37 1.6
38 date    90.03.22.11.31.23;      author sources; state Exp;
39 branches;
40 next    1.5;
41
42 1.5
43 date    90.03.21.10.20.31;      author sources; state Exp;
44 branches;
45 next    1.4;
46
47 1.4
48 date    90.03.20.19.42.02;      author sources; state Exp;
49 branches;
50 next    1.3;
51
52 1.3
53 date    90.03.20.17.36.18;      author sources; state Exp;
54 branches;
55 next    1.2;
56
57 1.2
58 date    90.03.15.20.28.32;      author sources; state Exp;
59 branches;
60 next    1.1;
61
62 1.1
63 date    90.03.15.20.24.55;      author sources; state Exp;
64 branches;
65 next    ;
66
67
68 desc
69 @@
70
71
72 1.12
73 log
74 @include slocal(1)
75 move mhparam to (1)
76 @
77 text
78 @.\"    @@(MHWARNING)
79 .\" @@(#)$Id: mh.rf,v 1.11 1992/02/09 20:55:28 jromine Exp jromine $
80 .if '\*(ZZ'-man' \{\
81 .SC MH 1
82 .NA
83 mh \- Message Handler
84 .SY
85 any \fIMH\fR command
86 .DE
87 \fIMH\fR is the name of a powerful message handling system.
88 Rather then being a single comprehensive program,
89 \fIMH\fR consists of a collection of fairly simple 
90 single-purpose programs to send, receive, save, 
91 and retrieve messages.  The user should refer
92 to the \fIMH User's Manual\fR
93 and the pages for the \fIMH\fR
94 programs in the Unix Programmers Manual.
95
96 Unlike \fImail\fR, the standard UNIX mail user interface program,
97 \fIMH\fR is not a closed system which must be explicitly run,
98 then exited when you wish to return to the shell.
99 You may freely intersperse \fIMH\fR commands with other shell commands,
100 allowing you to read and answer your mail while you have (for example)
101 a compilation running,
102 or search for a file or run programs as needed to find the answer to
103 someone's question before answering their mail.
104
105 The rest of this manual entry is a quick tutorial which will teach you the
106 basics of \fIMH\fR.
107 You should read the manual entries for the individual programs for complete
108 documentation.
109
110 To get started using \fIMH\fR, put the directory
111 \fB@@(MHBINPATH)\fR on your \fB$PATH\fR.
112 This is best done in one of the files:
113 \fB\&.profile\fR, \fB\&.login\fR, or \fB\&.cshrc\fR
114 in your home directory.
115 (Check the manual entry for the shell you use,
116 in case you don't know how to do this.)
117 Run the \fIinc\fR command.
118 If you've never used \fIMH\fR before,
119 it will create the necessary default files and directories after
120 asking you if you wish it to do so.
121
122 \fIinc\fR moves mail from your system maildrop
123 into your \fIMH\fR `+inbox' folder,
124 breaking it up into separate files
125 and converting it to \fIMH\fR format as it goes.
126 It prints one line for each message it processes,
127 containing the from field, the subject field
128 and as much of the first line of the message as will fit.
129 It leaves the first message it processes as your current message.
130 You'll need to run \fIinc\fR each time you wish to incorporate new mail
131 into your \fIMH\fR file.
132
133 \fIscan\fR prints a list of the messages in your current folder.
134
135 The commands:
136 \fIshow\fR, \fInext\fR, and \fIprev\fR
137 are used to read specific messages from the current folder.
138 \fIshow\fR displays the current message,
139 or a specific message, which may be specified by its number,
140 which you pass as an argument to \fIshow\fR.
141 \fInext\fR and \fIprev\fR display, respectively,
142 the message numerically after or before the current message.
143 In all cases, the message displayed becomes the current message.
144 If there is no current message,
145 \fIshow\fR may be called with an argument,
146 or \fInext\fR may be used to advance to the first message.
147
148 \fIrmm\fR (remove message) deletes the current message.
149 It may be called with message numbers passed as arguments,
150 to delete specific messages.
151
152 \fIrepl\fR is used to respond to the current message (by default).
153 It places you in the editor with a prototype response form.
154 While you're in the editor,
155 you may peruse the item you're responding to by reading the file \fB@@\fR.
156 After completing your response,
157 type \fBl\fR to review it,
158 or \fBs\fR to send it.
159
160 \fIcomp\fR allows you to compose a message by putting you in the editor on
161 a prototype message form,
162 and then lets you send it.
163
164 All the \fIMH\fR commands may be run with the single argument: `\-help',
165 which causes them to print a list of the arguments they may be invoked with.
166
167 Commands which take a message number as an argument
168 (\fIscan\fR, \fIshow\fR, \fIrepl\fR, ...)
169 also take one of the words:
170 \fIfirst\fR, \fIprev\fR, \fIcur\fR, \fInext\fR, or \fIlast\fR
171 to indicate (respectively) the first, previous, current, next, or last
172 message in the current folder (assuming they are defined).
173
174 Commands which take a range of message numbers
175 (\fIrmm\fR, \fIscan\fR, \fIshow\fR, ...)
176 also take any of the abbreviations:
177 .sp
178 .in +5
179 .ti -3
180 .I <num1>-<num2>
181 - Indicates all messages in the range <num1> to <num2>, inclusive. The range
182 .B must
183 be nonempty.
184 .sp
185 .ti -3
186 .I <num>:+N
187 .ti -3
188 .I <num>:-N
189 - Up to
190 .I N
191 messages beginning with (or ending with) message
192 .I num.
193 .I Num
194 may be any of the pre-defined symbols:
195 .I first, prev, cur, next
196 or
197 .I last.
198 .sp
199 .ti -3
200 .I first:N
201 .ti -3
202 .I prev:N
203 .ti -3
204 .I next:N
205 .ti -3
206 .I last:N
207 - The first, previous, next or last
208 .I N
209 messages, if they exist.
210 .in -5
211
212 There are many other possibilities such as creating multiple folders for
213 different topics, and automatically refiling messages according to subject,
214 source, destination, or content.
215 These are beyond the scope of this manual entry.
216
217 Following is a list of all the \fIMH\fR commands:
218 .\}
219
220 .nf
221 .in .5i
222 .ta 1.5i
223 ^ali (1)~^\- list mail aliases
224 ^anno (1)~^\- annotate messages
225 @@BEGIN: BBOARDS
226 ^bbc (1)~^\- check on BBoards
227 @@BEGIN: BBSERVER
228 ^bbl (1)~^\- manage a BBoard
229 ^bbleader (1)~^\- responsiblities of a BBoard\-leader
230 @@END: BBSERVER
231 ^bboards (1)~^\- the UCI BBoards facility
232 @@END: BBOARDS
233 ^burst (1)~^\- explode digests into messages
234 @@BEGIN: TMA
235 ^cipher (1)~^\- en/de\-cipher txt
236 @@END: TMA
237 ^comp (1)~^\- compose a message 
238 @@BEGIN: TMA
239 ^decipher (1)~^\- decipher messages
240 @@END: TMA
241 ^dist (1)~^\- redistribute a message to additional addresses
242 ^folder (1)~^\- set/list current folder/message
243 ^folders (1)~^\- list all folders
244 ^forw (1)~^\- forward messages
245 ^inc (1)~^\- incorporate new mail
246 ^mark (1)~^\- mark messages
247 ^mhl (1)~^\- produce formatted listings of MH messages
248 ^mhmail (1)~^\- send or read mail
249 ^mhook (1)~^\- MH receive\-mail hooks
250 ^mhparam (1)~^\- print MH profile components
251 ^mhpath (1)~^\- print full pathnames of MH messages and folders
252 ^msgchk (1)~^\- check for messages
253 ^msh (1)~^\- MH shell (and BBoard reader)
254 ^next (1)~^\- show the next message
255 ^packf (1)~^\- compress a folder into a single file
256 ^pick (1)~^\- select messages by content
257 ^prev (1)~^\- show the previous message
258 ^prompter (1)~^\- prompting editor front end
259 ^rcvstore (1)~^\- incorporate new mail asynchronously
260 ^refile (1)~^\- file messages in other folders
261 ^repl (1)~^\- reply to a message
262 ^rmf (1)~^\- remove folder
263 ^rmm (1)~^\- remove messages
264 ^scan (1)~^\- produce a one line per message scan listing
265 ^send (1)~^\- send a message
266 ^show (1)~^\- show (list) messages
267 ^slocal (1)~^\- special local mail delivery
268 ^sortm (1)~^\- sort messages
269 @@BEGIN: TMA
270 ^tma (1)~^\- manipulate the TTI Trusted Mail Agent (TMA)
271 @@END: TMA
272 ^vmh (1)~^\- visual front\-end to MH
273 ^whatnow (1)~^\- prompting front\-end for send
274 ^whom (1)~^\- report to whom a message would go
275 .if '\*(ZZ'-man' \{\
276 .sp 1
277 ^mh\-alias (5)~^\- alias file for MH message system
278 ^mh\-format (5)~^\- format file for MH message system
279 ^mh\-mail (5)~^\- message format for MH message system
280 ^mh\-profile (5)~^\- user customization for MH message system
281 ^mh\-sequence (5)~^\- sequence specification for MH message system
282 .sp 1
283 ^ap (8)~^\- parse addresses 822\-style
284 ^conflict (8)~^\- search for alias/password conflicts
285 ^dp (8)~^\- parse dates 822\-style
286 ^fmtdump (8)~^\- decode \fIMH\fP format files
287 ^install\-mh (8)~^\- initialize the MH environment
288 ^post (8)~^\- deliver a message
289 .\}
290 .fi
291 .re
292
293 .if '\*(ZZ'-man' \{\
294 .Fi
295 ^@@(MHBINPATH)~^directory containing \fIMH\fR commands
296 ^@@(MHETCPATH)~^\fIMH\fR library
297 .Sa
298 \fIThe RAND \fIMH\fR Message Handling System: User's Manual\fR,
299 .br
300 \fIThe RAND \fIMH\fR Message Handling System: Tutorial\fR,
301 .br
302 \fIThe RAND \fIMH\fR Message Handling System: The UCI BBoards Facility\fR,
303 .br
304 \fIMH.5: How to process 200 messages a day and still get some real work
305 done\fR
306 .br
307 .Bu
308 If problems are encountered with an \fIMH\fR program,
309 the problems should be reported to the local maintainers of \fIMH\fR.
310 When doing this,
311 the name of the program should be reported,
312 along with the version information for the program.
313 .br
314 To find out what version of an \fIMH\fR program is being run,
315 invoke the program with the `\-help' switch.
316 In addition to listing the syntax of the command,
317 the program will list information pertaining to its version.
318 This information includes the version of \fIMH\fR,
319 the host it was generated on,
320 and the date the program was loaded.
321 A second line of information,
322 found on versions of \fIMH\fR after #5.380 include \fIMH\fR configuration
323 options.
324 For example,
325
326 .nf
327 .in +.5i
328 version: MH 6.1 #1[UCI] (glacier) of Wed Nov  6 01:13:53 PST 1985
329 options: [BSD42] [MHE] [NETWORK] [SENDMTS] [MMDFII] [SMTP] [POP]
330 .in -.5i
331 .fi
332
333 The `6.1 #1[UCI]' indicates that the program is from the UCI \fIMH.6.1\fR
334 version of \fIMH\fR.
335 The program was generated on the host `glacier' on
336 `Wed Nov  6 01:13:53 PST 1985'.
337 It's usually a good idea to send the output of the `\-help' switch along
338 with your report.
339
340 If there is no local \fIMH\fR maintainer,
341 try the address \fBBug-MH\fR.
342 If that fails, use the Internet mailbox \fBBug-MH@@ICS.UCI.EDU\fR.
343 .Fi
344 ^$HOME/\&.mh\(ruprofile~^The user profile
345 .Pr
346 ^Path:~^To determine the user's MH directory
347 .\" .Ps
348 .\" for each additional profile entry
349 .\" .Sa
350 .\" the see\-also's go here
351 .\" .De
352 .\" the first default goes here
353 .\" .Ds
354 .\" for each additional default
355 .\" .Co
356 .\" context changes go here
357 .\" You can also have
358 .\" .Hh \- the helpful hints section
359 .\" .Hi \- the history section
360 .\" .Bu \- the bugs section
361 .En
362 .\}
363 @
364
365
366 1.11
367 log
368 @add mhparam/fmtdump
369 @
370 text
371 @d2 1
372 a2 1
373 .\" @@(#)$Id: mh.rf,v 1.10 1991/01/07 16:56:36 mh Exp jromine $
374 d173 1
375 d190 1
376 a210 1
377 ^mhparam (8)~^\- print MH profile components
378 @
379
380
381 1.10
382 log
383 @add mh-sequence
384 @
385 text
386 @d2 1
387 a2 1
388 .\" @@(#)$Id: mh.rf,v 1.9 90/04/05 15:08:50 sources Exp Locker: mh $
389 d207 1
390 d209 1
391 @
392
393
394 1.9
395 log
396 @add ID
397 @
398 text
399 @d2 1
400 a2 1
401 .\" @@(#)$Id:$
402 d202 1
403 @
404
405
406 1.8
407 log
408 @RAND fixes
409 @
410 text
411 @d2 1
412 @
413
414
415 1.7
416 log
417 @typo
418 @
419 text
420 @d216 1
421 a216 1
422 \fIThe Rand \fIMH\fR Message Handling System: User's Manual\fR,
423 d218 1
424 a218 1
425 \fIThe Rand \fIMH\fR Message Handling System: Tutorial\fR,
426 d220 1
427 a220 1
428 \fIThe Rand \fIMH\fR Message Handling System: The UCI BBoards Facility\fR,
429 @
430
431
432 1.6
433 log
434 @put things back, do .NA stuff another way
435 @
436 text
437 @a279 1
438 .En
439 @
440
441
442 1.5
443 log
444 @changes for "bbhome: none"
445 @
446 text
447 @d3 2
448 a4 2
449 .TH MH 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
450 .SH .NA
451 d6 1
452 a6 1
453 .SH .SY
454 @
455
456
457 1.4
458 log
459 @typo
460 @
461 text
462 @d149 1
463 d152 1
464 @
465
466
467 1.3
468 log
469 @fixup for makewhatis
470 @
471 text
472 @d3 1
473 a3 1
474 .TH MH 1 [mh.6] MH
475 @
476
477
478 1.2
479 log
480 @add bug reporting section
481 @
482 text
483 @d3 2
484 a4 2
485 .SC MH 1
486 .NA
487 d6 1
488 a6 1
489 .SY
490 @
491
492
493 1.1
494 log
495 @Initial revision
496 @
497 text
498 @d223 55
499 @