Fix spelling errors, including binaries ones
[mmh] / man / mmh-intro.man7
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH NMH %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 mmh \- Introduction to the Modern MH message system
7 .SH DESCRIPTION
8 .B mmh
9 is a powerful message handling system, based on
10 .BR nmh ,
11 which in turn bases on MH, the Rand Corporation's Message Handler.
12 .PP
13 Rather than
14 being a single comprehensive program,
15 .B mmh
16 consists of a collection
17 of fairly simple single-purpose programs to send, retrieve, organize,
18 and manipulate messages.
19 .PP
20 Unlike most other mail clients,
21 .B mmh
22 is not a closed system which
23 must be explicitly run, then exited when you wish to return to the shell.
24 Instead, you may freely intersperse
25 .B mmh
26 commands with other shell commands,
27 allowing you to read and answer your mail while you
28 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 mmh .
34 You should read the manual entries for the
35 individual programs for complete documentation.
36 .PP
37 To get started using
38 .BR mmh ,
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.) Then run the
52 .B mmh
53 command.  If you've never used
54 .B mmh
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 mmh
61 `+inbox' folder, converting it to the MH format (one file per message). 
62 It prints one line for each message it
63 processes, containing the date, from and subject fields.
64 It leaves the first message it processes as your current message.
65 You'll need to run
66 .B inc
67 each time you wish to incorporate new mail into your
68 .B mmh
69 mail storage.
70 .PP
71 .B scan
72 prints a list of the messages in your current folder.
73 .PP
74 The commands:
75 .BR show ,
76 .BR next ,
77 and
78 .B prev
79 are used to read
80 specific messages from the current folder.
81 .B show
82 displays the
83 current message, or a specific message, which may be specified by its
84 number, which you pass as an argument to
85 .BR show .
86 .B next
87 and
88 .B prev
89 display, respectively, the message numerically after or before
90 the current message.  In all cases, the message displayed becomes the
91 current message.  If there is no current message,
92 .B show
93 may be
94 called with an argument, or
95 .B next
96 may be used to advance to the
97 first message.
98 .PP
99 .B rmm
100 (remove message) deletes the current message.  It may be called
101 with message numbers passed as arguments, to delete specific messages.
102 .PP
103 .B repl
104 is used to respond to the current message (by default).
105 It places you in the editor with a prototype response form.
106 After completing your response, type
107 .B li
108 to
109 .B list
110 (review) it, or
111 .B s
112 to
113 .B send
114 it.
115 .PP
116 .B comp
117 allows you to compose a fresh message by putting you in the editor
118 on a prototype message form, and then lets you send it.
119 .PP
120 All the
121 .B mmh
122 commands may be run with the single argument:
123 .BR \-help ,
124 which causes them to print a list of the arguments they may be invoked
125 with and then exit.
126 .PP
127 Commands which take a message number as an argument
128 .RB ( scan ,
129 .BR show ,
130 .BR repl ,
131 \&...)  also take one of the letters: `f',
132 `p', `c', `n', or `l' to indicate
133 (respectively) the first, previous, current, next, or last message in
134 the current folder (assuming they are defined).
135
136 Commands which take a range of message numbers
137 .RB ( rmm ,
138 .BR scan ,
139 .BR show ,
140 \&...)  also take any of the abbreviations:
141 .PP
142 .RS 5
143 .IP \fI<num1>\fR\-\fI<num2>\fR 15
144 Indicates all messages in the range <num1> to <num2>, inclusive. The range must be nonempty.
145 .IP \fI<num>\fR:+\fIN\fR 15
146 .IP \fI<num>\fR:\-\fIN\fR 15
147 Up to
148 .I N
149 messages beginning with (or ending with) message
150 .IR num .
151 .I Num
152 may be any of the pre-defined symbols:
153 .IR f ,
154 .IR p ,
155 .IR c ,
156 .I n
157 or
158 .IR l .
159 .IP f:\fIN\fR 15
160 .IP p:\fIN\fR 15
161 .IP n:\fIN\fR 15
162 .IP l:\fIN\fR 15
163 The first, previous, next or last
164 messages, if they exist.
165 .RE
166 .PP
167 There are many other possibilities such as creating multiple folders
168 for different topics, and automatically refiling messages according to
169 subject, source, destination, or content.  These are beyond the scope
170 of this manual entry.
171 .PP
172 Following is a list of all the
173 .B mmh
174 commands:
175 .PP
176 .RS 5
177 .fc ^ ~
178 .nf
179 .ta 1.5i
180 ^ali(1)~^\- list mail aliases
181 ^anno(1)~^\- annotate messages
182 ^burst(1)~^\- explode digests into messages
183 ^comp(1)~^\- compose a message
184 ^dist(1)~^\- redistribute a message to additional addresses
185 ^flist(1)~^\- list folders with messages in given sequence(s)
186 ^flists(1)~^\- list all folders with messages in given sequence(s)
187 ^folder(1)~^\- set/list current folder/message
188 ^folders(1)~^\- list all folders
189 ^forw(1)~^\- forward messages
190 ^inc(1)~^\- incorporate new mail
191 ^mark(1)~^\- mark messages
192 ^mhbuild(1)~^\- translate MIME composition draft
193 ^mhl(1)~^\- produce formatted listings of mmh messages
194 ^mhlist(1)~^\- list information about content of MIME messages
195 ^mhmail(1)~^\- send mail (mailx replacement)
196 ^mhparam(1)~^\- print mmh profile components
197 ^mhpath(1)~^\- print full pathnames of mmh messages and folders
198 ^mhpgp(1)~^\- verify and decrypt a message with gnupg
199 ^mhsign(1)~^\- sign or encrypt a message with gnupg
200 ^mhstore(1)~^\- store contents of MIME messages into files
201 ^mmh(1)~^\- initialize the mmh environment
202 ^mmhwrap(1)~^\- invoke mmh commands if they are not in $PATH
203 ^next(1)~^\- show the next message
204 ^packf(1)~^\- pack a folder into mbox format
205 ^pick(1)~^\- select messages by content
206 ^prev(1)~^\- show the previous message
207 ^prompter(1)~^\- prompting editor front end
208 ^rcvdist(1)~^\- asynchronously redistribute new mail
209 ^rcvpack(1)~^\- asynchronously append a message to an mbox file
210 ^rcvstore(1)~^\- asynchronously incorporate new mail
211 ^refile(1)~^\- file messages in other folders
212 ^repl(1)~^\- reply to a message
213 ^rmf(1)~^\- remove folder
214 ^rmm(1)~^\- remove messages
215 ^scan(1)~^\- produce a one line per message scan listing
216 ^send(1)~^\- send a message
217 ^sendfiles(1)~^\- send multiple files and directories in MIME message
218 ^show(1)~^\- display MIME messages
219 ^slocal(1)~^\- asynchronously filter and deliver new mail
220 ^sortm(1)~^\- sort messages
221 ^whatnow(1)~^\- prompting front\-end for send
222 ^whom(1)~^\- list recipients of a message
223 .sp
224 ^ap(8)~^\- parse addresses 822\-style
225 ^dp(8)~^\- parse dates 822\-style
226 ^fmtdump(8)~^\- decode \fImmh\fP format files
227 ^spost(8)~^\- deliver a message
228 .fi
229 .RE
230 .PP
231 The following man pages describe file formats and concepts:
232 .PP
233 .RS 5
234 .fc ^ ~
235 .nf
236 .ta 1.5i
237 ^mh\-alias(5)~^\- alias file for mmh message system
238 ^mh\-format(5)~^\- format file for mmh message system
239 ^mh\-mail(5)~^\- message format for mmh message system
240 ^mh\-profile(5)~^\- user customization for mmh message system
241 .sp
242 ^mmh(7)~^\- introduction to the mmh message system
243 ^mh\-draft(7)~^\- draft folder facility
244 ^mh\-sequence(7)~^\- sequence specification for mmh message system
245 .RE
246
247 .SH FILES
248 .fc ^ ~
249 .nf
250 .ta \w'%etcdir%/ExtraBigFileName  'u
251 ^%bindir%~^contains \fImmh\fR commands
252 ^%etcdir%~^contains \fImmh\fR format files
253 ^%libdir%~^contains \fImmh\fR library commands
254 ^$HOME/.mmh~^The user's mmh directory
255 ^$HOME/.mmh/profile~^The user's profile
256 ^$HOME/.mmh/context~^The user's context
257 ^$HOME/Mail~^Default location of the user's mail storage
258 .fi
259
260 .SH "PROFILE COMPONENTS"
261 .fc ^ ~
262 .nf
263 .ta 2.4i
264 .ta \w'LongName  'u
265 ^Path:~^Location of the user's mail storage
266 .fi
267
268 .SH HISTORY
269 .B mmh
270 is an experimental version of
271 .BR nmh ,
272 the New Mail Handler.
273 Its name ``mmh'' stands for ``meillo's mail handler''.
274
275 .SH BUGS
276 If you encounter problems with an
277 .B mmh
278 program, please report them.
279 When doing this, include the version information, which you can obtain
280 by invoking the program with the
281 .B \-Version
282 switch.
283 .PP
284 Send bug reports, comments, and suggestions to
285 .I <mmh@marmaro.de>
286 or to
287 .IR "markus schnalke <meillo@marmaro.de>" .
288
289 .SH "SEE ALSO"
290 mmh(1)
291 mh-chart(1)