Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / doc / mh.me
1 .\"     This file is automatically generated.  Do not edit!
2 .\" @(#)$Id: mh.rf,v 1.12 1992/10/28 17:00:27 jromine Exp $
3 .if '\*(ZZ'-man' \{\
4 .SC MH 1
5 .NA
6 mh \- Message Handler
7 .SY
8 any \fIMH\fR command
9 .DE
10 \fIMH\fR is the name of a powerful message handling system.
11 Rather then being a single comprehensive program,
12 \fIMH\fR consists of a collection of fairly simple 
13 single-purpose programs to send, receive, save, 
14 and retrieve messages.  The user should refer
15 to the \fIMH User's Manual\fR
16 and the pages for the \fIMH\fR
17 programs in the Unix Programmers Manual.
18
19 Unlike \fImail\fR, the standard UNIX mail user interface program,
20 \fIMH\fR is not a closed system which must be explicitly run,
21 then exited when you wish to return to the shell.
22 You may freely intersperse \fIMH\fR commands with other shell commands,
23 allowing you to read and answer your mail while you have (for example)
24 a compilation running,
25 or search for a file or run programs as needed to find the answer to
26 someone's question before answering their mail.
27
28 The rest of this manual entry is a quick tutorial which will teach you the
29 basics of \fIMH\fR.
30 You should read the manual entries for the individual programs for complete
31 documentation.
32
33 To get started using \fIMH\fR, put the directory
34 \fB/opt/mh-6.8.5/bin\fR on your \fB$PATH\fR.
35 This is best done in one of the files:
36 \fB\&.profile\fR, \fB\&.login\fR, or \fB\&.cshrc\fR
37 in your home directory.
38 (Check the manual entry for the shell you use,
39 in case you don't know how to do this.)
40 Run the \fIinc\fR command.
41 If you've never used \fIMH\fR before,
42 it will create the necessary default files and directories after
43 asking you if you wish it to do so.
44
45 \fIinc\fR moves mail from your system maildrop
46 into your \fIMH\fR `+inbox' folder,
47 breaking it up into separate files
48 and converting it to \fIMH\fR format as it goes.
49 It prints one line for each message it processes,
50 containing the from field, the subject field
51 and as much of the first line of the message as will fit.
52 It leaves the first message it processes as your current message.
53 You'll need to run \fIinc\fR each time you wish to incorporate new mail
54 into your \fIMH\fR file.
55
56 \fIscan\fR prints a list of the messages in your current folder.
57
58 The commands:
59 \fIshow\fR, \fInext\fR, and \fIprev\fR
60 are used to read specific messages from the current folder.
61 \fIshow\fR displays the current message,
62 or a specific message, which may be specified by its number,
63 which you pass as an argument to \fIshow\fR.
64 \fInext\fR and \fIprev\fR display, respectively,
65 the message numerically after or before the current message.
66 In all cases, the message displayed becomes the current message.
67 If there is no current message,
68 \fIshow\fR may be called with an argument,
69 or \fInext\fR may be used to advance to the first message.
70
71 \fIrmm\fR (remove message) deletes the current message.
72 It may be called with message numbers passed as arguments,
73 to delete specific messages.
74
75 \fIrepl\fR is used to respond to the current message (by default).
76 It places you in the editor with a prototype response form.
77 While you're in the editor,
78 you may peruse the item you're responding to by reading the file \fB@\fR.
79 After completing your response,
80 type \fBl\fR to review it,
81 or \fBs\fR to send it.
82
83 \fIcomp\fR allows you to compose a message by putting you in the editor on
84 a prototype message form,
85 and then lets you send it.
86
87 All the \fIMH\fR commands may be run with the single argument: `\-help',
88 which causes them to print a list of the arguments they may be invoked with.
89
90 Commands which take a message number as an argument
91 (\fIscan\fR, \fIshow\fR, \fIrepl\fR, ...)
92 also take one of the words:
93 \fIfirst\fR, \fIprev\fR, \fIcur\fR, \fInext\fR, or \fIlast\fR
94 to indicate (respectively) the first, previous, current, next, or last
95 message in the current folder (assuming they are defined).
96
97 Commands which take a range of message numbers
98 (\fIrmm\fR, \fIscan\fR, \fIshow\fR, ...)
99 also take any of the abbreviations:
100 .sp
101 .in +5
102 .ti -3
103 .I <num1>-<num2>
104 - Indicates all messages in the range <num1> to <num2>, inclusive. The range
105 .B must
106 be nonempty.
107 .sp
108 .ti -3
109 .I <num>:+N
110 .ti -3
111 .I <num>:-N
112 - Up to
113 .I N
114 messages beginning with (or ending with) message
115 .I num.
116 .I Num
117 may be any of the pre-defined symbols:
118 .I first, prev, cur, next
119 or
120 .I last.
121 .sp
122 .ti -3
123 .I first:N
124 .ti -3
125 .I prev:N
126 .ti -3
127 .I next:N
128 .ti -3
129 .I last:N
130 - The first, previous, next or last
131 .I N
132 messages, if they exist.
133 .in -5
134
135 There are many other possibilities such as creating multiple folders for
136 different topics, and automatically refiling messages according to subject,
137 source, destination, or content.
138 These are beyond the scope of this manual entry.
139
140 Following is a list of all the \fIMH\fR commands:
141 .\}
142
143 .nf
144 .in .5i
145 .ta 1.5i
146 ^ali (1)~^\- list mail aliases
147 ^anno (1)~^\- annotate messages
148 ^burst (1)~^\- explode digests into messages
149 ^comp (1)~^\- compose a message 
150 ^dist (1)~^\- redistribute a message to additional addresses
151 ^folder (1)~^\- set/list current folder/message
152 ^folders (1)~^\- list all folders
153 ^forw (1)~^\- forward messages
154 ^inc (1)~^\- incorporate new mail
155 ^mark (1)~^\- mark messages
156 ^mhl (1)~^\- produce formatted listings of MH messages
157 ^mhmail (1)~^\- send or read mail
158 ^mhook (1)~^\- MH receive\-mail hooks
159 ^mhparam (1)~^\- print MH profile components
160 ^mhpath (1)~^\- print full pathnames of MH messages and folders
161 ^msgchk (1)~^\- check for messages
162 ^msh (1)~^\- MH shell (and BBoard reader)
163 ^next (1)~^\- show the next message
164 ^packf (1)~^\- compress a folder into a single file
165 ^pick (1)~^\- select messages by content
166 ^prev (1)~^\- show the previous message
167 ^prompter (1)~^\- prompting editor front end
168 ^rcvstore (1)~^\- incorporate new mail asynchronously
169 ^refile (1)~^\- file messages in other folders
170 ^repl (1)~^\- reply to a message
171 ^rmf (1)~^\- remove folder
172 ^rmm (1)~^\- remove messages
173 ^scan (1)~^\- produce a one line per message scan listing
174 ^send (1)~^\- send a message
175 ^show (1)~^\- show (list) messages
176 ^slocal (1)~^\- special local mail delivery
177 ^sortm (1)~^\- sort messages
178 ^vmh (1)~^\- visual front\-end to MH
179 ^whatnow (1)~^\- prompting front\-end for send
180 ^whom (1)~^\- report to whom a message would go
181 .if '\*(ZZ'-man' \{\
182 .sp 1
183 ^mh\-alias (5)~^\- alias file for MH message system
184 ^mh\-format (5)~^\- format file for MH message system
185 ^mh\-mail (5)~^\- message format for MH message system
186 ^mh\-profile (5)~^\- user customization for MH message system
187 ^mh\-sequence (5)~^\- sequence specification for MH message system
188 .sp 1
189 ^ap (8)~^\- parse addresses 822\-style
190 ^conflict (8)~^\- search for alias/password conflicts
191 ^dp (8)~^\- parse dates 822\-style
192 ^fmtdump (8)~^\- decode \fIMH\fP format files
193 ^install\-mh (8)~^\- initialize the MH environment
194 ^post (8)~^\- deliver a message
195 .\}
196 .fi
197 .re
198
199 .if '\*(ZZ'-man' \{\
200 .Fi
201 ^/opt/mh-6.8.5/bin~^directory containing \fIMH\fR commands
202 ^/opt/mh-6.8.5/lib~^\fIMH\fR library
203 .Sa
204 \fIThe RAND \fIMH\fR Message Handling System: User's Manual\fR,
205 .br
206 \fIThe RAND \fIMH\fR Message Handling System: Tutorial\fR,
207 .br
208 \fIThe RAND \fIMH\fR Message Handling System: The UCI BBoards Facility\fR,
209 .br
210 \fIMH.5: How to process 200 messages a day and still get some real work
211 done\fR
212 .br
213 .Bu
214 If problems are encountered with an \fIMH\fR program,
215 the problems should be reported to the local maintainers of \fIMH\fR.
216 When doing this,
217 the name of the program should be reported,
218 along with the version information for the program.
219 .br
220 To find out what version of an \fIMH\fR program is being run,
221 invoke the program with the `\-help' switch.
222 In addition to listing the syntax of the command,
223 the program will list information pertaining to its version.
224 This information includes the version of \fIMH\fR,
225 the host it was generated on,
226 and the date the program was loaded.
227 A second line of information,
228 found on versions of \fIMH\fR after #5.380 include \fIMH\fR configuration
229 options.
230 For example,
231
232 .nf
233 .in +.5i
234 version: MH 6.1 #1[UCI] (glacier) of Wed Nov  6 01:13:53 PST 1985
235 options: [BSD42] [MHE] [NETWORK] [SENDMTS] [MMDFII] [SMTP] [POP]
236 .in -.5i
237 .fi
238
239 The `6.1 #1[UCI]' indicates that the program is from the UCI \fIMH.6.1\fR
240 version of \fIMH\fR.
241 The program was generated on the host `glacier' on
242 `Wed Nov  6 01:13:53 PST 1985'.
243 It's usually a good idea to send the output of the `\-help' switch along
244 with your report.
245
246 If there is no local \fIMH\fR maintainer,
247 try the address \fBBug-MH\fR.
248 If that fails, use the Internet mailbox \fBBug-MH@ICS.UCI.EDU\fR.
249 .Fi
250 ^$HOME/\&.mh\(ruprofile~^The user profile
251 .Pr
252 ^Path:~^To determine the user's MH directory
253 .\" .Ps
254 .\" for each additional profile entry
255 .\" .Sa
256 .\" the see\-also's go here
257 .\" .De
258 .\" the first default goes here
259 .\" .Ds
260 .\" for each additional default
261 .\" .Co
262 .\" context changes go here
263 .\" You can also have
264 .\" .Hh \- the helpful hints section
265 .\" .Hi \- the history section
266 .\" .Bu \- the bugs section
267 .En
268 .\}