scansbr: Removed the ``performance hack'' for inc as it wasn't faster.
[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.)  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.  While you're
106 in the editor, you may peruse the item you're responding to by reading
107 the file
108 .IR @ .
109 After completing your response, type
110 .B l
111 to
112 .B list
113 (review) it, or
114 .B s
115 to
116 .B send
117 it.
118 .PP
119 .B comp
120 allows you to compose a message by putting you in the editor
121 on a prototype message form, and then lets you send it.
122 .PP
123 All the
124 .B mmh
125 commands may be run with the single argument:
126 .BR \-help ,
127 which causes them to print a list of the arguments they may be invoked
128 with and then exit.
129 .PP
130 Commands which take a message number as an argument (
131 .BR scan ,
132 .BR show ,
133 .BR repl ,
134 \&...)  also take one of the words: \*(lqfirst\*(rq,
135 \*(lqprev\*(rq, \*(lqcur\*(rq, \*(lqnext\*(rq, or \*(lqlast\*(rq to indicate
136 (respectively) the first, previous, current, next, or last message in
137 the current folder (assuming they are defined).
138
139 Commands which take a range of message numbers (
140 .BR rmm ,
141 .BR scan ,
142 .BR show ,
143 \&...)  also take any of the abbreviations:
144 .PP
145 .RS 5
146 .IP \fI<num1>\fR\-\fI<num2>\fR 15
147 Indicates all messages in the range <num1> to <num2>, inclusive. The range must be nonempty.
148 .IP \fI<num>\fR:+\fIN\fR 15
149 .IP \fI<num>\fR:\-\fIN\fR 15
150 Up to
151 .I N
152 messages beginning with (or ending with) message
153 .IR num .
154 .I Num
155 may be any of the pre-defined symbols:
156 .IR first ,
157 .IR prev ,
158 .IR cur ,
159 .I next
160 or
161 .IR last .
162 .IP first:\fIN\fR 15
163 .IP prev:\fIN\fR 15
164 .IP next:\fIN\fR 15
165 .IP last:\fIN\fR 15
166 The first, previous, next or last
167 messages, if they exist.
168 .RE
169 .PP
170 There are many other possibilities such as creating multiple folders
171 for different topics, and automatically refiling messages according to
172 subject, source, destination, or content.  These are beyond the scope
173 of this manual entry.
174 .PP
175 Following is a list of all the
176 .B mmh
177 commands:
178 .PP
179 .RS 5
180 .fc ^ ~
181 .nf
182 .ta 1.5i
183 ^ali(1)~^\- list mail aliases
184 ^anno(1)~^\- annotate messages
185 ^burst(1)~^\- explode digests into messages
186 ^comp(1)~^\- compose a message
187 ^dist(1)~^\- redistribute a message to additional addresses
188 ^flist(1)~^\- list folders with messages in given sequence(s)
189 ^flists(1)~^\- list all folders with messages in given sequence(s)
190 ^folder(1)~^\- set/list current folder/message
191 ^folders(1)~^\- list all folders
192 ^forw(1)~^\- forward messages
193 ^inc(1)~^\- incorporate new mail
194 ^mark(1)~^\- mark messages
195 ^mhbuild(1)~^\- translate MIME composition draft
196 ^mhl(1)~^\- produce formatted listings of mmh messages
197 ^mhlist(1)~^\- list information about content of MIME messages
198 ^mhmail(1)~^\- send or read mail
199 ^mhparam(1)~^\- print mmh profile components
200 ^mhpath(1)~^\- print full pathnames of mmh messages and folders
201 ^mhshow(1)~^\- display MIME messages
202 ^mhstore(1)~^\- store contents of MIME messages into files
203 ^mmh(1)~^\- initialize the mmh environment
204 ^msgchk(1)~^\- check for messages
205 ^next(1)~^\- show the next message
206 ^packf(1)~^\- pack a folder into mbox format
207 ^pick(1)~^\- select messages by content
208 ^prev(1)~^\- show the previous message
209 ^prompter(1)~^\- prompting editor front end
210 ^rcvdist(1)~^\- asynchronously redistribute new mail
211 ^rcvpack(1)~^\- asynchronously append a message to an mbox file
212 ^rcvstore(1)~^\- asynchronously incorporate new mail
213 ^refile(1)~^\- file messages in other folders
214 ^repl(1)~^\- reply to a message
215 ^rmf(1)~^\- remove folder
216 ^rmm(1)~^\- remove messages
217 ^scan(1)~^\- produce a one line per message scan listing
218 ^send(1)~^\- send a message
219 ^sendfiles(1)~^\- send multiple files and directories in MIME message
220 ^show(1)~^\- show(display) messages
221 ^slocal(1)~^\- asynchronously filter and deliver new mail
222 ^sortm(1)~^\- sort messages
223 ^whatnow(1)~^\- prompting front\-end for send
224 .sp
225 ^ap(8)~^\- parse addresses 822\-style
226 ^conflict(8)~^\- search for alias/password conflicts
227 ^dp(8)~^\- parse dates 822\-style
228 ^fmtdump(8)~^\- decode \fImmh\fP format files
229 ^post(8)~^\- deliver a message
230 .fi
231 .RE
232 .PP
233 Theses are descriptions of files and concepts:
234 .PP
235 .RS 5
236 .fc ^ ~
237 .nf
238 .ta 1.5i
239 ^mh\-alias(5)~^\- alias file for mmh message system
240 ^mh\-format(5)~^\- format file for mmh message system
241 ^mh\-mail(5)~^\- message format for mmh message system
242 ^mh\-profile(5)~^\- user customization for mmh message system
243 ^mh\-tailor(5)~^\- mail transport customization for mmh message system
244 .sp
245 ^mmh(7)~^\- introduction to the mmh message system
246 ^mh\-draft(7)~^\- draft folder facility
247 ^mh\-sequence(7)~^\- sequence specification for mmh message system
248 .RE
249
250 .SH FILES
251 .fc ^ ~
252 .nf
253 .ta \w'%etcdir%/ExtraBigFileName  'u
254 ^%bindir%~^contains \fImmh\fR commands
255 ^%etcdir%~^contains \fImmh\fR format files
256 ^%libdir%~^contains \fImmh\fR library commands
257 ^$HOME/.mmh~^The user's mmh directory
258 ^$HOME/.mmh/profile~^The user's profile
259 ^$HOME/.mmh/context~^The user's context
260 ^$HOME/Mail~^The user's mail storage
261 .fi
262
263 .SH "PROFILE COMPONENTS"
264 .fc ^ ~
265 .nf
266 .ta 2.4i
267 .ta \w'LongName  'u
268 ^Path:~^To determine the user's mail storage
269 .fi
270
271 .SH HISTORY
272 .B mmh
273 is an experimental version of
274 .BR nmh ,
275 the New Mail Handler.
276 Its name ``mmh'' stands primarily for ``meillo's MH'',
277 but also for modern, minimalistic, and non-compatible Mail Handler.
278
279 .SH BUGS
280 If you encounter problems with an
281 .B mmh
282 program, please report them.
283 When doing this, include the version information, which you can obtain
284 by invoking the program with the
285 .B \-version
286 switch.
287 .PP
288 Send bug reports and suggestions to
289 .IR "markus schnalke <meillo@marmaro.de>" ,
290 or (as a fall-back) to
291 .IR nmh-workers@nongnu.org .
292 .SH "SEE ALSO"
293 mh-chart(1)