(emacs-version): Remove `%a' from the time format
[emacs.git] / man / mh-e.texi
blob89dff36a85a1dfec8596d5da0544da104bf79c2e
1 \input texinfo   @c -*-texinfo-*-
2 @c $Id: mh-e.texi,v 1.5 2000/10/04 01:04:41 miles Exp $
3 @c %**start of header
4 @setfilename ../info/mh-e
5 @settitle mh-e
6 @c %**end of header
8 @setchapternewpage odd
10 @dircategory Emacs
11 @direntry
12 * MH-E: (mh-e).         Emacs interface to the MH mail system.
13 @end direntry
15 @c Version variables.
16 @set EDITION 1.2
17 @set VERSION 5.0.2
18 @set UPDATED 22 August 1995
19 @set UPDATE-MONTH August 1995
21 @ifinfo
22 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
23 @cite{mh-e, The Emacs Interface to MH}, for mh-e, Version
24 @value{VERSION}.
26 Copyright 1995 Free Software Foundation, Inc.
28 Permission is granted to copy, distribute and/or modify this document
29 under the terms of the GNU Free Documentation License, Version 1.1 or
30 any later version published by the Free Software Foundation; with no
31 Invariant Sections, with the Front-Cover texts being ``A GNU
32 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
33 license is included in the section entitled ``GNU Free Documentation
34 License'' in the Emacs manual.
36 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
37 this GNU Manual, like GNU software.  Copies published by the Free
38 Software Foundation raise funds for GNU development.''
40 This document is part of a collection distributed under the GNU Free
41 Documentation License.  If you want to distribute this document
42 separately from the collection, you can do so by adding a copy of the
43 license to the document, as described in section 6 of the license.
44 @end ifinfo
46 @titlepage
47 @sp 10
48 @center @titlefont{mh-e}
49 @sp 2
50 @center The Emacs Interface to MH
51 @sp 2
52 @center by Bill Wohler
53 @sp 2
54 @center Edition @value{EDITION} for mh-e Version @value{VERSION}
55 @sp 2
56 @center @value{UPDATE-MONTH}
58 @page
59 @vskip 0pt plus 1filll
60 Copyright @copyright{} 1995, 2000 Free Software Foundation, Inc.
62 Permission is granted to copy, distribute and/or modify this document
63 under the terms of the GNU Free Documentation License, Version 1.1 or
64 any later version published by the Free Software Foundation; with no
65 Invariant Sections, with the Front-Cover texts being ``A GNU
66 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
67 license is included in the section entitled ``GNU Free Documentation
68 License'' in the Emacs manual.
70 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
71 this GNU Manual, like GNU software.  Copies published by the Free
72 Software Foundation raise funds for GNU development.''
74 This document is part of a collection distributed under the GNU Free
75 Documentation License.  If you want to distribute this document
76 separately from the collection, you can do so by adding a copy of the
77 license to the document, as described in section 6 of the license.
78 @end titlepage
80 @ifinfo
81 @node Top, Preface, (dir), (dir)
82 @top MH and Emacs
83 This is Edition @value{EDITION} of @cite{mh-e, The Emacs Interface to
84 MH}, last updated @value{UPDATED} for mh-e Version @value{VERSION}.
86 @menu
87 * Preface::                     Introduction to mh-e.
88 * Tour Through mh-e::           Use mh-e quickly!
89 * Using mh-e::                  Documentation for all commands.
90 * Customizing mh-e::            Documentation for all variables.
91 * Odds and Ends::               Getting mh-e, reporting bugs, mailing
92                                 list and FAQ.
93 * History::                     The authors speak up!
94 * Changes to mh-e::             Actual changes between Versions 3 and beyond.
95 * Copying::                     The GNU General Public License
96 * Command Index::              
97 * Variable Index::              
98 * Concept Index::               
99 @end menu
100 @end ifinfo
102 @node Preface, Tour Through mh-e, Top, Top
103 @unnumbered Preface
105 @cindex Emacs
106 @cindex Unix commands, Emacs
108 These chapters introduce another interface to MH that is accessible
109 through the GNU Emacs editor, namely, @emph{mh-e}.  mh-e is easy to use.
110 I don't assume that you know GNU Emacs or even MH at this point, since I
111 didn't know either of them when I discovered mh-e.  However, mh-e was
112 the tip of the iceberg, and I discovered more and more niceties about
113 GNU Emacs and MH@.  Now I'm fully hooked on both of them.
115 @cindex history
117 The mh-e package is distributed with GNU Emacs, @footnote{Note that mh-e
118 is supported with MH 6 and either @w{Emacs 18} or @w{Emacs 19}.
119 Reportedly, large parts of it work with @w{MH 5} and also with
120 Lucid/XEmacs and Epoch, but there are no guarantees.  It is also
121 distributed with Lucid/XEmacs, as well as with MH itself.} so you shouldn't
122 have to do anything special to use it.  But it's important to note a
123 brief history of mh-e.  @w{Version 3} was prevalent through the @w{Emacs
124 18} and early @w{Emacs 19} years.  Then @w{Version 4} came out (@w{Emacs
125 19.23}), which introduced several new and changed commands.  Finally,
126 @w{Version 5.0} was released, which fixed some bugs and
127 incompatibilities.  This is the version covered by this manual.
128 @ref{Getting Started} will help you decide which version you
129 have.
131 If you don't already use GNU Emacs but want to learn more, you can read
132 an online tutorial by starting GNU Emacs and typing @kbd{C-h t}
133 (@code{help-with-tutorial}).  (This notation is described in
134 @ref{Conventions}.)  If you want to take the plunge, consult the
135 @iftex
136 @cite{GNU Emacs Manual},
137 @end iftex
138 @ifinfo
139 @ref{top, , GNU Emacs Manual, emacs, The GNU Emacs Manual},
140 @end ifinfo
141 from the Free Software Foundation.
143 If more information is needed, you can go to the Unix manual pages of
144 the individual MH commands.  When the name is not obvious, I'll guide
145 you to a relevant MH manual page that describes the action more fully.
147 I hope you enjoy these chapters!  If you have any comments, or
148 suggestions for this document, please let me know.
150 @noindent
151 Bill Wohler <@i{wohler@@newt.com}>@*
152 8 February 1995
154 @node    Tour Through mh-e, Using mh-e, Preface, Top
155 @chapter Tour Through mh-e
157 This chapter introduces some of the terms you'll need to know and then
158 takes you on a tour of mh-e. @footnote{The keys mentioned in these
159 chapters refer to the default key bindings.  If you've changed the
160 bindings, refer to the command summaries at the beginning of each major
161 section in @ref{Using mh-e}, for a mapping between default key bindings
162 and function names.}  When you're done, you'll be able to send, read,
163 and file mail, which is all that a lot of people ever do.  But if you're
164 the curious type, you'll read @ref{Using mh-e} to be able to use all
165 the features of mh-e.  If you're the adventurous type, you'll read
166 @ref{Customizing mh-e} to make mh-e do what you want.  I suggest you
167 read this chapter first to get the big picture, and then you can read
168 the other two as you wish.
170 @menu
171 * Conventions::                 GNU Emacs Terms and Conventions
172 * Getting Started::             
173 * Sending Mail Tour::           
174 * Reading Mail Tour::           
175 * Processing Mail Tour::        
176 * Leaving mh-e::                
177 * More About mh-e::             
178 @end menu
180 @node Conventions, Getting Started, Tour Through mh-e, Tour Through mh-e
181 @section GNU Emacs Terms and Conventions
183 @cindex Emacs, terms and conventions
185 @cindex Emacs
186 @cindex Unix commands, Emacs
188 If you're an experienced Emacs user, you can skip the following
189 conventions and definition of terms and go directly to @ref{Getting
190 Started} below.  The conventions are as follows:
192 @table @kbd
193 @item C-x
194 Hold down the @key{CTRL} (Control) key and press the @kbd{x} key.
195 @item M-x
196 Hold down the @key{META} or @key{ALT} key and press the @kbd{x} key.
198 Since some keyboards don't have a @key{META} key, you can generate
199 @kbd{M-x}, for example, by pressing @key{ESC} (Escape), @emph{releasing
200 it}, @footnote{This is emphasized because pressing ESC twice or holding
201 it down a second too long so that it repeats gives you an error message.}
202 and then pressing the @kbd{x} key.
203 @item RET
204 Press the @key{RETURN} or @key{ENTER} key.  This is normally used to
205 complete a command.
206 @item SPC
207 Press the space bar.
208 @item TAB
209 Press the @key{TAB} key.
210 @item DEL
211 Press the @key{DELETE} key.  This may also be a Backspace key, depending
212 on your keyboard or Emacs configuration.
213 @end table
215 @cindex Emacs, prefix argument
216 @cindex prefix argument
218 A @dfn{prefix argument} allows you to pass an argument to any Emacs
219 function.  To pass an argument, type @kbd{C-u} before the Emacs command
220 or keystroke.  Numeric arguments can be passed as well.  For example, to
221 insert five f's, use @kbd{C-u 5 f}.  There is a default of four when
222 using @kbd{C-u}, and you can use multiple prefix arguments to provide
223 arguments of powers of four.  To continue our example, you could insert
224 four f's with @kbd{C-u f}, 16 f's with @kbd{C-u C-u f}, 64 f's with
225 @kbd{C-u C-u C-u f}, and so on.  Numeric and valueless negative
226 arguments can also be inserted with the @key{META} key.  Examples
227 include @kbd{M-5} to specify an argument of 5, or @kbd{M--} which
228 specifies a negative argument with no particular value.
230 @sp 2
231 @need 1000
232 @center @strong{NOTE}
234 @quotation
235 The prefix @kbd{C-u} or @kbd{M-} is not necessary in mh-e's MH-Folder
236 modes (@pxref{Reading Mail Tour}).  In these modes, simply enter the
237 numerical argument before entering the command.
238 @end quotation
240 @cindex point
241 @cindex Emacs, point
242 @cindex mark
243 @cindex Emacs, mark
244 @cindex region
245 @cindex Emacs, region
247 There are several other terms that are used in Emacs that you should
248 know.  The @dfn{point} is where the cursor currently is.  You can save
249 your current place in the file by setting a @dfn{mark}.  This operation
250 is useful in several ways.  The mark can be later used when defining a
251 @dfn{region}, which is the text between the point and mark.  Many
252 commands operate on regions, such as those for deleting text or filling
253 paragraphs.  A mark can be set with @kbd{C-@@} (or @kbd{C-SPC}).
255 @cindex minibuffer
256 @cindex Emacs, minibuffer
257 @cindex file completion
258 @cindex Emacs, file completion
260 The @dfn{minibuffer} is the bottom line of the Emacs window, where all
261 prompting and multiple-character input is directed.  If you are prompted
262 for information in the minibuffer, such as a filename, Emacs can help
263 you complete your answer if you type @key{SPC} or @key{TAB}.  A second
264 @key{SPC} or @key{TAB} will list all possibilities at that point.  The
265 minibuffer is also where you enter Emacs function names after typing
266 @kbd{M-x}.  For example, in the first paragraph, I mentioned that you
267 could obtain help with @kbd{C-h t} (@code{help-with-tutorial}).  What
268 this means is that you can get a tutorial by typing either @kbd{C-h t}
269 or @kbd{M-x help-with-tutorial}.  In the latter case, you are prompted
270 for @samp{help-with-tutorial} in the minibuffer after typing @kbd{M-x}.
272 @cindex interrupting
273 @cindex Emacs, interrupting
274 @cindex quitting
275 @cindex Emacs, quitting
277 @i{In case of trouble:} Emacs can be interrupted at any time with
278 @kbd{C-g}.  For example, if you've started a command that requests that
279 you enter something in the minibuffer, but then you change your mind,
280 type @kbd{C-g} and you'll be back where you started.  If you want to
281 exit Emacs entirely, use @kbd{C-x C-c}.
283 @node Getting Started, Sending Mail Tour, Conventions, Tour Through mh-e
284 @section Getting Started
286 Because there are many old versions of mh-e out there, it is important to
287 know which version you have.  I'll be talking about @w{Version 5} which
288 is similar to @w{Version 4} and vastly different from @w{Version 3}.
290 First, enter @kbd{M-x load-library @key{RET} mh-e
291 @key{RET}}. @footnote{You wouldn't ordinarily do this.}  The message,
292 @samp{Loading mh-e...done}, should be displayed in the minibuffer.  If
293 you get @samp{Cannot open load file: mh-e}, then your Emacs is very
294 badly configured, or mh-e is missing.  You may wish to have your system
295 administrator install a new Emacs or at least the latest mh-e files.
297 Having loaded mh-e successfully, enter @kbd{M-x mh-version @key{RET}}.
298 The version of mh-e should be displayed.  Hopefully it says that you're
299 running @w{Version @value{VERSION}} which is the latest version as of
300 this printing.  If instead Emacs beeps and says @samp{[No match]}, then
301 you're running an old version of mh-e.
303 If these tests reveal a non-existent or old version of mh-e, please
304 consider obtaining a new version.  You can have your system
305 administrator upgrade the system-wide version, or you can install your
306 own personal version.  It's really quite easy; instructions for getting
307 and installing mh-e are in @ref{Getting mh-e}.  In the meantime, see
308 @ref{Changes to mh-e}, which compares the old and new names of commands,
309 functions, variables, and buffers.
311 @cindex @code{install-mh}
312 @cindex MH commands, @code{install-mh}
314 Also, older versions of mh-e assumed that you had already set up your MH
315 environment.  Newer versions set up a new MH environment for you by
316 running @code{install-mh} and notifying you of this fact with the
317 message in a temporary buffer:
319 @example
320 I'm going to create the standard MH path for you.
321 @end example
323 Therefore, if you've never run MH before and you're using an old version
324 of mh-e, you need to run @code{install-mh} from the shell before you
325 continue the tour.  If you don't, you'll be greeted with the error
326 message: @samp{Can't find MH profile}.
328 @cindex @file{.emacs}
329 @cindex files, @file{.emacs}
331 If, during the tour described in this chapter, you see a message like:
332 @samp{Searching for program: no such file or directory,
333 /usr/local/bin/mhpath}, it means that the MH programs and files are kept
334 in a nonstandard directory.  In this case, simply add the following to
335 @file{~/.emacs} and restart @code{emacs}.
337 @vindex @code{mh-progs}, example
338 @vindex @code{mh-lib}, example
340 @c XXX Real example for really naive user?
341 @example
342 @group
343 (setq mh-progs "@var{/path/to/MH/binary/directory/}")
344 (setq mh-lib "@var{/path/to/MH/library/directory/}")
345 @end group
346 @end example
348 @cindex ~
350 The @samp{~} notation used by @file{~/.emacs} above represents your home
351 directory.  This is used by the @code{bash} and @code{csh} shells.  If
352 your shell does not support this feature, you could use the environment
353 variable @samp{$HOME} (such as @file{$HOME/.emacs}) or the absolute path
354 (as in @file{/home/wohler/.emacs}) instead.
356 At this point, you should see something like the screen in the
357 figure in @ref{Reading Mail Tour}.  We're now ready to move on.
359 @node Sending Mail Tour, Reading Mail Tour, Getting Started, Tour Through mh-e
360 @section Sending Mail
362 @cindex sending mail
363 @findex @code{mh-smail}
365 Let's start our tour by sending ourselves a message which we can later
366 read and process.  Enter @kbd{M-x mh-smail} to invoke the mh-e program
367 to send messages.  You will be prompted in the minibuffer by @samp{To:}.
368 Enter your login name.  The next prompt is @samp{cc:}.  Hit @key{RET} to
369 indicate that no carbon copies are to be sent.  At the @samp{Subject:}
370 prompt, enter @kbd{Test} or anything else that comes to mind.
372 @cindex MH-Letter mode
373 @cindex modes, MH-Letter
374 @cindex mode
376 Once you've specified the recipients and subject, your message appears
377 in an Emacs buffer whose mode @footnote{A @dfn{mode} changes Emacs to
378 make it easier to edit a particular type of text.} is MH-Letter.
379 Enter some text in the body of the message, using normal Emacs commands.
380 You should now have something like this: @footnote{If you're running Emacs
381 under the X Window System, then you would also see a menubar.  I've left
382 out the menubar in all of the example screens.}
384 @example
385 @group
386 @cartouche
393 -----Emacs: *scratch*         (Lisp Interaction)--All---------------------
394 To: wohler
396 Subject: Test
397 --------
398   This is a test message to get the wheels churning...#
401 --**-@{draft@}      (MH-Letter)--All----------------------------------------
403 @end cartouche
404 @i{mh-e message composition window}
405 @end group
406 @end example
408 @cindex MH-Letter mode
409 @cindex modes, MH-Letter
411 Note the line of dashes that separates the header and the body of the
412 message.  It is essential that these dashes (or a blank line) are
413 present or the body of your message will be considered to be part of
414 the header.
416 There are several commands specific to MH-Letter mode, but at
417 this time we'll only use @kbd{C-c C-c} to send your message.  Type
418 @kbd{C-c C-c} now.  That's all there is to it!
420 @node Reading Mail Tour, Processing Mail Tour, Sending Mail Tour, Tour Through mh-e
421 @section Receiving Mail
423 @cindex reading mail
424 @findex @code{mh-rmail}
425 @cindex @code{inc}
426 @cindex MH commands, @code{inc}
427 @cindex @code{scan}
428 @cindex MH commands, @code{scan}
429 @cindex MH-Folder mode
430 @cindex modes, MH-Folder
432 To read the mail you've just sent yourself, enter @kbd{M-x mh-rmail}.
433 This incorporates the new mail and put the output from @code{inc}
434 (called @dfn{scan lines} after the MH program @code{scan} which prints a
435 one-line summary of each message) into a buffer called @samp{+inbox}
436 whose major mode is MH-Folder.
438 @sp 2
439 @need 1000
440 @center @strong{NOTE}
442 @quotation
443 The @kbd{M-x mh-rmail} command will show you only new mail, not old
444 mail.  If you were to run this tour again, you would use @kbd{M-r} to
445 pull all your messages into mh-e.
446 @end quotation
448 You should see the scan line for your message, and perhaps others.  Use
449 @kbd{n} or @kbd{p} to move the cursor to your test message and type
450 @key{RET} to read your message.  You should see something like:
452 @example
453 @group
454 @cartouche
455    3  24Aug  root       received fax files on Wed Aug 24 11:00:13 PDT 1994
456 #  4+ 24Aug  To:wohler  Test<<This is a test message to get the wheels chu
458 --%%-@{+inbox@} 4 msgs (1-4)      (MH-Folder Show)--Bot---------------------
459 To: wohler
460 Subject: Test
461 Date: Wed, 24 Aug 1994 13:01:13 -0700
462 From: Bill Wohler <wohler@@newt.com>
464   This is a test message to get the wheels churning...
470 -----@{show-+inbox@} 4      (MH-Show)--Bot----------------------------------
472 @end cartouche
473 @i{After incorporating new messages}
474 @end group
475 @end example
477 If you typed a long message, you can view subsequent pages with @key{SPC}
478 and previous pages with @key{DEL}.
480 @node Processing Mail Tour, Leaving mh-e, Reading Mail Tour, Tour Through mh-e
481 @section Processing Mail
483 @cindex processing mail
485 The first thing we want to do is reply to the message that we sent
486 ourselves.  Ensure that the cursor is still on the same line as your
487 test message and type @kbd{r}.  You are prompted in the minibuffer with
488 @samp{Reply to whom:}.  Here mh-e is asking whether you'd like to reply
489 to the original sender only, to the sender and primary recipients, or to
490 the sender and all recipients.  If you simply hit @key{RET}, you'll
491 reply only to the sender.  Hit @key{RET} now.
493 You'll find yourself in an Emacs buffer similar to that when you were
494 sending the original message, like this:
496 @example
497 @group
498 @cartouche
499 To: wohler
500 Subject: Re: Test
501 In-reply-to: Bill Wohler's message of Wed, 24 Aug 1994 13:01:13 -0700
502              <199408242001.NAA00505@@newt.com>
503 --------
506 --**-@{draft@}      (MH-Letter)--All----------------------------------------
507 To: wohler
508 Subject: Test
509 Date: Wed, 24 Aug 1994 13:01:13 -0700
510 From: Bill Wohler <wohler@@newt.com>
512   This is a test message to get the wheels churning...
514 -----@{show-+inbox@} 4      (MH-Show)--Bot----------------------------------
515 Composing a reply...done
516 @end cartouche
517 @i{Composition window during reply}
518 @end group
519 @end example
521 By default, MH will not add you to the address list of your replies, so
522 if you find that the @samp{To:} header field is missing, don't worry.
523 In this case, type @kbd{C-c C-f C-t} to create and go to the @samp{To:}
524 field, where you can type your login name again.  You can move around
525 with the arrow keys or with @kbd{C-p} (@code{previous-line}), @kbd{C-n}
526 (@code{next-line}), @kbd{C-b} (@code{backward-char}), and @kbd{C-f}
527 (@code{forward-char}) and can delete the previous character with
528 @key{DEL}.  When you're finished editing your message, send it with
529 @kbd{C-c C-c} as before.
531 @cindex folder
533 You'll often want to save messages that were sent to you in an organized
534 fashion.  This is done with @dfn{folders}.  You can use folders to keep
535 messages from your friends, or messages related to a particular topic.
536 With your cursor in the MH-Folder buffer and positioned on the message
537 you sent to yourself, type @kbd{o} to output (@code{refile} in MH
538 parlance) that message to a folder.  Enter @kbd{test} at the
539 @samp{Destination:} prompt and type @kbd{y} (or @key{SPC}) when mh-e
540 asks to create the folder @samp{+test}.  Note that a @samp{^} (caret)
541 appears next to the message number, which means that the message has
542 been marked for refiling but has not yet been refiled.  We'll talk about
543 how the refile is actually carried out in a moment.
545 @cindex MH-Folder mode
546 @cindex modes, MH-Folder
548 Your previous reply is now waiting in the system mailbox.  You
549 incorporate this mail into your MH-Folder buffer named @samp{+inbox}
550 with the @kbd{i} command.  Do this now.  After the mail is incorporated,
551 use @kbd{n} or @kbd{p} to move the cursor to the new message, and read
552 it with @key{RET}.  Let's delete this message by typing @kbd{d}.  Note
553 that a @samp{D} appears next to the message number.  This means that the
554 message is marked for deletion but is not yet deleted.  To perform the
555 deletion (and the refile we did previously), use the @kbd{x} command.
557 @findex @code{mh-smail}
559 If you want to send another message you can use @kbd{m} instead of
560 @kbd{M-x mh-smail}.  So go ahead, send some mail to your friends!
562 @node Leaving mh-e, More About mh-e, Processing Mail Tour, Tour Through mh-e
563 @section Leaving mh-e
565 @cindex Emacs, quitting
566 @cindex quitting
568 You may now wish to exit @code{emacs} entirely.  Use @kbd{C-x C-c} to
569 exit @code{emacs}.  If you exited without running @kbd{x} in the
570 @samp{+inbox} buffer, Emacs will offer to save it for you.  Type @kbd{y}
571 or @key{SPC} to save @samp{+inbox} changes, which means to perform any refiles
572 and deletes that you did there.
574 If you don't want to leave Emacs, you can type @kbd{q} to bury (hide)
575 the mh-e folder or delete them entirely with @kbd{C-x k}.  You can then
576 later recall them with @kbd{C-x b} or @kbd{M-x mh-rmail}.
578 @node More About mh-e,  , Leaving mh-e, Tour Through mh-e
579 @section More About mh-e
581 These are the basic commands to get you going, but there are plenty
582 more.  If you think that mh-e is for you, read @ref{Using mh-e} and
583 @ref{Customizing mh-e} to find out how you can:
585 @itemize @bullet
586 @item
587 Print your messages.  (@ref{Printing} and @ref{Customizing Printing}.)
588 @item
589 Edit messages and include your signature.  (@ref{Draft Editing}
590 and @ref{Customizing Draft Editing}.)
591 @item
592 Forward messages.  (@ref{Forwarding} and @ref{Customizing Forwarding}.)
593 @item
594 Read digests.  (@ref{Viewing}.)
595 @item
596 Edit bounced messages.  (@ref{Old Drafts} and @ref{Customizing Old Drafts}.)
597 @item
598 Send multimedia messages.  (@ref{Editing MIME} and @ref{Customizing Editing MIME}.)
599 @item
600 Process mail that was sent with @code{shar} or @code{uuencode}.
601 (@ref{Files and Pipes}.)
602 @item
603 Use sequences conveniently.  (@ref{Sequences}.)
604 @item
605 Show header fields in different fonts.  (@ref{Customizing Viewing}.)
606 @item
607 Find previously refiled messages.  (@ref{Searching}.)
608 @item
609 Place messages in a file.  (@ref{Files and Pipes}.)
610 @end itemize
612 Remember that you can also use MH commands when you're not running mh-e
613 (and when you are!).
615 @node    Using mh-e, Customizing mh-e, Tour Through mh-e, Top
616 @chapter Using mh-e
618 This chapter leaves the tutorial style and goes into more detail about
619 every mh-e command.  The default, or "out of the box," behavior is
620 documented.  If this is not to your liking (for instance, you print with
621 something other than @code{lpr)}, see the associated section in
622 @ref{Customizing mh-e} which is organized exactly like this chapter.
624 @cindex Emacs, functions; describe-mode
625 @cindex Emacs, online help
626 @cindex online help
628 There are many commands, but don't get intimidated.  There are command
629 summaries at the beginning of each section.  In case you have or would
630 like to rebind the keys, the command summaries also list the associated
631 Emacs Lisp function.  Furthermore, even if you're stranded on a desert
632 island with a laptop and are without your manuals, you can get a summary
633 of all these commands with GNU Emacs online help: use @kbd{C-h m}
634 (@code{describe-mode}) for a brief summary of commands or @kbd{C-h i} to
635 read this manual via Info.  The online help is quite good; try running
636 @kbd{C-h C-h C-h}.  This brings up a list of available help topics, one
637 of which displays the documentation for a given key (like @kbd{C-h k
638 C-n}).  In addition, review @ref{Conventions}, if any of the GNU Emacs
639 conventions are strange to you.
641 Let's get started!
643 @menu
644 * Reading Mail::                
645 * Sending Mail::                
646 * Draft Editing::               
647 * Moving Mail::                 
648 * Searching::                   
649 * Sequences::                   
650 * Miscellaneous::               
651 @end menu
653 @node Reading Mail, Sending Mail, Using mh-e, Using mh-e
654 @section Reading Your Mail
656 @cindex reading mail
657 @findex @code{mh-rmail}
658 @cindex MH-Folder mode
659 @cindex modes, MH-Folder
661 The mh-e entry point for reading mail is @kbd{M-x mh-rmail}.  This
662 command incorporates your mail and creates a buffer called @samp{+inbox}
663 in MH-Folder mode.  The @kbd{M-x mh-rmail} command shows you only new
664 mail, not old mail. @footnote{If you want to see your old mail as well,
665 use @kbd{M-r} to pull all your messages into mh-e.  Or, give a prefix
666 argument to @code{mh-rmail} so it will prompt you for folder to visit
667 like @kbd{M-f} (for example, @kbd{C-u M-x mh-rmail @key{RET} bob
668 @key{RET}}).  Both @kbd{M-r} and @kbd{M-f} are described in
669 @ref{Organizing}.}  The @samp{+inbox} buffer contains @dfn{scan lines},
670 which are one-line summaries of each incorporated message.  You can
671 perform most MH commands on these messages via one-letter commands
672 discussed in this chapter.  See @code{scan}(1) for a description of the
673 contents of the scan lines, and see the Figure in @ref{Reading Mail
674 Tour}, for an example.
676 @table @kbd
677 @item RET
678 Display a message (@code{mh-show}).
680 @item SPC
681 Go to next page in message (@code{mh-page-msg}).
683 @item DEL
684 Go to previous page in message (@code{mh-previous-page}).
686 @item , (comma)
687 Display a message with all header fields (@code{mh-header-display}).
689 @item M-SPC
690 Go to next message in digest (@code{mh-page-digest}).
692 @item M-DEL
693 Go to previous message in digest (@code{mh-page-digest-backwards}).
695 @item M-b
696 Break up digest into separate messages (@code{mh-burst-digest}).
698 @item n
699 Display next message (@code{mh-next-undeleted-msg}).
701 @item p
702 Display previous message (@code{mh-previous-undeleted-msg}).
704 @item g
705 Go to a message (@code{mh-goto-msg}).
707 @item M-<
708 Go to first message (@code{mh-first-msg}).
710 @item M->
711 Go to last message (@code{mh-last-msg}).
713 @item t
714 Toggle between MH-Folder and MH-Folder Show modes (@code{mh-toggle-showing}).
715 @end table
717 @menu
718 * Viewing::                     
719 * Moving Around::               
720 @end menu
722 @node Viewing, Moving Around, Reading Mail, Reading Mail
723 @subsection Viewing Your Mail
725 @findex @code{mh-show}
726 @findex @code{mh-page-msg}
727 @findex @code{mh-previous-page}
729 The @kbd{RET} (@code{mh-show}) command displays the message that the
730 cursor is on.  If the message is already displayed, it scrolls to the
731 beginning of the message.  Use @key{SPC} (@code{mh-page-msg}) and
732 @key{DEL} (@code{mh-previous-page}) to move forwards and backwards one
733 page at a time through the message.  You can give either of these
734 commands a prefix argument that specifies the number of lines to scroll
735 (such as @kbd{10 SPC}).  mh-e normally hides a lot of the
736 superfluous header fields that mailers add to a message, but if you wish
737 to see all of them, use the @kbd{,} (comma; @code{mh-header-display})
738 command.
740 @menu
741 * Reading Digests::             
742 * Reading MIME::                
743 @end menu
745 @node Reading Digests, Reading MIME, Viewing, Viewing
746 @subsubsection Reading Digests
748 @cindex digests
749 @findex @code{mh-page-digest}
750 @findex @code{mh-page-digest-backwards}
752 A digest is a message that contains other messages.  Special mh-e
753 commands let you read digests conveniently.  You can use @key{SPC} and
754 @key{DEL} to page through the digest as if it were a normal message, but
755 if you wish to skip to the next message in the digest, use @kbd{M-SPC}
756 (@code{mh-page-digest}).  To return to a previous message, use
757 @kbd{M-DEL} (@code{mh-page-digest-backwards}).
759 @cindex @code{burst}
760 @cindex MH commands, @code{burst}
761 @cindex MH-Folder Show mode
762 @cindex modes, MH-Folder Show
763 @findex @code{mh-burst-digest}
765 @c There was a page break at the colon in the following paragraph which
766 @c broke the transition to the example.
767 @need 2000
769 Another handy command is @kbd{M-b} (@code{mh-burst-digest}).  This
770 command uses the MH command @code{burst} to break out each message in
771 the digest into its own message.  Using this command, you can quickly
772 delete unwanted messages, like this: Once the digest is split up, toggle
773 out of MH-Folder Show mode with @kbd{t} (@pxref{Moving Around}) so that
774 the scan lines fill the screen and messages aren't displayed.  Then use
775 @kbd{d} (@pxref{Deleting}) to quickly delete messages that you don't
776 want to read (based on the @samp{Subject:} header field).  You can also
777 burst the digest to reply directly to the people who posted the messages
778 in the digest.  One problem you may encounter is that the @samp{From:}
779 header fields are preceded with a @samp{>} so that your reply can't
780 create the @samp{To:} field correctly.  In this case, you must correct
781 the @samp{To:} field yourself.  This is described later in @ref{Editing
782 Textual}.
784 @node Reading MIME,  , Reading Digests, Viewing
785 @subsubsection Reading Multimedia Mail
787 @cindex multimedia mail
788 @cindex MIME
789 @cindex @code{show}
790 @cindex MH commands, @code{show}
791 @cindex @code{mhn}
792 @cindex MH commands, @code{mhn}
794 MH has the ability to read @dfn{@sc{mime}} (Multipurpose Internet Mail
795 Extensions) messages.  Unfortunately, mh-e does not yet have this
796 ability, so you have to use the MH commands @code{show} or @code{mhn}
797 from the shell to read @sc{mime} messages.  @footnote{You can call them
798 directly from Emacs if you're running the X Window System: type @kbd{M-!
799 xterm -e mhn @var{message-number}}.  You can leave out the @code{xterm
800 -e} if you use @code{mhn -list} or @code{mhn -store}.}
802 @node Moving Around,  , Viewing, Reading Mail
803 @subsection Moving Around
805 @cindex moving between messages
806 @findex @code{mh-next-undeleted-msg}
807 @findex @code{mh-previous-undeleted-msg}
808 @findex @code{mh-goto-msg}
809 @findex @code{mh-last-msg}
810 @findex @code{mh-first-msg}
812 To move on to the next message, use the @kbd{n}
813 (@code{mh-next-undeleted-msg}) command; use the @kbd{p}
814 (@code{mh-previous-undeleted-msg}) command to read the previous message.
815 Both of these commands can be given a prefix argument to specify how
816 many messages to skip (for example, @kbd{5 n}).  You can also move to a
817 specific message with @kbd{g} (@code{mh-goto-msg}).  You can enter the
818 message number either before or after typing @kbd{g}.  In the latter
819 case, Emacs prompts you.  Finally, you can go to the first or last
820 message with @kbd{M-<} (@code{mh-first-msg}) and @kbd{M->}
821 (@code{mh-last-msg}) respectively.
823 @cindex MH-Folder mode
824 @cindex modes, MH-Folder
826 You can also use the Emacs commands @kbd{C-p} (@code{previous-line}) and
827 @kbd{C-n} (@code{next-line}) to move up and down the scan lines in the
828 MH-Folder window.  These commands can be used in conjunction with
829 @kbd{RET} to look at deleted or refiled messages.
831 @cindex MH-Folder mode
832 @cindex modes, MH-Folder
833 @cindex MH-Folder Show mode
834 @cindex modes, MH-Folder Show
835 @cindex junk mail
836 @findex @code{mh-toggle-showing}
838 The command @kbd{t} (@code{mh-toggle-showing}) switches between
839 MH-Folder mode and MH-Folder Show mode.  @footnote{For you Emacs
840 wizards, this is implemented as an Emacs minor mode.} MH-Folder mode
841 turns off the associated show buffer so that you can perform operations
842 on the messages quickly without reading them.  This is an excellent way
843 to prune out your junk mail or to refile a group of messages to another
844 folder for later examination.
846 @node Sending Mail, Draft Editing, Reading Mail, Using mh-e
847 @section Sending Mail
849 @cindex sending mail
850 @findex @code{mh-smail}
852 You can send a mail message in several ways.  You can call @kbd{M-x
853 mh-smail} directly, or from the command line like this:
855 @cindex starting from command line
857 @example
858 % @kbd{emacs -f mh-smail}
859 @end example
861 From within mh-e's MH-Folder mode, other methods of sending mail
862 are available as well:
864 @table @kbd
865 @item m
866 Compose a message (@code{mh-send}).
868 @item r
869 Reply to a message (@code{mh-reply}).
871 @item f
872 Forward message(s) (@code{mh-forward}).
874 @item M-d
875 Redistribute a message (@code{mh-redistribute}).
877 @item M-e
878 Edit a message that was bounced by mailer (@code{mh-extract-rejected-mail}).
880 @item M-a
881 Edit a message to send it again (@code{mh-edit-again}).
882 @end table
884 @cindex MH-Folder mode
885 @cindex modes, MH-Folder
886 @cindex MH-Letter mode
887 @cindex modes, MH-Letter
888 @findex @code{mh-send}
890 From within a MH-Folder buffer, you can simply use the command @kbd{m}
891 (@code{mh-send}).  However you invoke @code{mh-send}, you are prompted
892 for the @samp{To:}, @samp{cc:}, and @samp{Subject:} header fields.  Once
893 you've specified the recipients and subject, your message appears in an
894 Emacs buffer whose mode is MH-Letter (see the Figure in @ref{Sending
895 Mail} to see what the buffer looks like).  MH-Letter mode allows you to
896 edit your message, to check the validity of the recipients, to insert
897 other messages into your message, and to send the message.  We'll go
898 more into depth about editing a @dfn{draft} @footnote{I highly recommend
899 that you use a @dfn{draft folder} so that you can edit several drafts in
900 parallel.  To do so, create a folder (e.g., @file{+drafts}), and add a
901 profile component called @samp{Draft-Folder:} which contains
902 @file{+drafts} (see @code{mh-profile}(5)).} (a message you're composing)
903 in just a moment.
905 @findex @code{mh-smail}
906 @findex @code{mh-smail-other-window}
908 @code{mh-smail} always creates a two-window layout with the current
909 buffer on top and the draft on the bottom.  If you would rather preserve
910 the window layout, use @kbd{M-x mh-smail-other-window}.
912 @menu
913 * Replying::                    
914 * Forwarding::                  
915 * Redistributing::              
916 * Old Drafts::                  
917 @end menu
919 @node Replying, Forwarding, Sending Mail, Sending Mail
920 @subsection Replying to Mail
922 @cindex replying
923 @cindex @code{mhl}
924 @cindex MH commands, @code{mhl}
925 @cindex @file{mhl.reply}
926 @cindex files, @file{mhl.reply}
927 @findex @code{mh-reply}
929 To compose a reply to a message, use the @kbd{r} (@code{mh-reply})
930 command.  If you supply a prefix argument (as in @kbd{C-u r}), the
931 message you are replying to is inserted in your reply after having first
932 been run through @code{mhl} with the format file @file{mhl.reply}.  See
933 @code{mhl}(1) to see how you can modify the default @file{mhl.reply}
934 file.
936 When you reply to a message, you are first prompted with @samp{Reply to
937 whom?}.  You have several choices here.
939 @example
940 @group
941 @b{Response}     @b{Reply Goes To}
943 @kbd{from}         @r{The person who sent the message.  This is the default,}
944              @r{so @key{RET} is sufficient.}
946 @kbd{to}           @r{Replies to the sender, plus all recipients in the}
947              @r{@samp{To:} header field.}
949 @kbd{all}
950 @kbd{cc}           @r{Forms a reply to the sender, plus all recipients.}
951 @end group
952 @end example
954 @cindex @code{repl}
955 @cindex MH commands, @code{repl}
957 Depending on your answer, @code{repl} is given a different argument to
958 form your reply.  Specifically, a choice of @kbd{from} or none at all
959 runs @code{repl -nocc all}, and a choice of @kbd{to} runs @code{repl -cc
960 to}.  Finally, either @kbd{cc} or @kbd{all} runs @code{repl -cc all
961 -nocc me}.
963 @cindex MH-Letter mode
964 @cindex modes, MH-Letter
966 Two windows are then created.  One window contains the message to which
967 you are replying.  Your draft, in MH-Letter mode (described in
968 @ref{Draft Editing}), is in the other window.
970 If you wish to customize the header or other parts of the reply draft,
971 please see @code{repl}(1) and @code{mh-format}(5).
973 @node Forwarding, Redistributing, Replying, Sending Mail
974 @subsection Forwarding Mail
976 @cindex forwarding
977 @cindex @code{forw}
978 @cindex MH commands, @code{forw}
979 @findex @code{mh-forward}
981 To forward a message, use the @kbd{f} (@code{mh-forward}) command.  You
982 are given a draft to edit that looks like it would if you had run the MH
983 command @code{forw}.  You are given a chance to add some text (see
984 @ref{Draft Editing}).
986 You can forward several messages by using a prefix argument; in this
987 case, you are prompted for the name of a @dfn{sequence}, a symbolic name
988 that represents a list or range of message numbers (for example,
989 @kbd{C-u f forbob @key{RET}}).  All of the messages in the sequence are
990 inserted into your draft.  By the way, although sequences are often
991 mentioned in this chapter, you don't have to worry about them for now;
992 the full description of sequences in mh-e is at the end in
993 @ref{Sequences}.  To learn more about sequences in general, please see
994 @code{mh-sequence}(5).
996 @node Redistributing, Old Drafts, Forwarding, Sending Mail
997 @subsection Redistributing Your Mail
999 @cindex redistributing
1000 @findex @code{mh-redistribute}
1002 The command @kbd{M-d} (@code{mh-redistribute}) is similar in function to
1003 forwarding mail, but it does not allow you to edit the message, nor does
1004 it add your name to the @samp{From:} header field.  It appears to the
1005 recipient as if the message had come from the original sender.  For more
1006 information on redistributing messages, see @code{dist}(1).  Also
1007 investigate the @kbd{M-a} (@code{mh-edit-again}) command in @ref{Old
1008 Drafts}, for another way to redistribute messages.
1010 @node Old Drafts,  , Redistributing, Sending Mail
1011 @subsection Editing Old Drafts and Bounced Messages
1013 @cindex re-editing drafts
1014 @cindex @file{draft}
1015 @cindex files, @file{draft}
1016 @findex @code{mh-edit-again}
1018 If you don't complete a draft for one reason or another, and if the
1019 draft buffer is no longer available, you can pick your draft up again
1020 with @kbd{M-a} (@code{mh-edit-again}).  If you don't use a draft folder,
1021 your last @file{draft} file will be used.  If you use draft folders,
1022 you'll need to visit the draft folder with @kbd{M-f drafts @key{RET}},
1023 use @kbd{n} to move to the appropriate message, and then use @kbd{M-a}
1024 to prepare the message for editing.
1026 The @kbd{M-a} command can also be used to take messages that were sent
1027 to you and to send them to more people.
1029 @cindex Mailer-Daemon
1030 @findex @code{mh-extract-rejected-mail}
1032 Don't use @kbd{M-a} to re-edit a message from a @i{Mailer-Daemon} who
1033 complained that your mail wasn't posted for some reason or another.  In
1034 this case, use @kbd{M-e} (@code{mh-extract-rejected-mail}) to prepare
1035 the message for editing by removing the @i{Mailer-Daemon} envelope and
1036 unneeded header fields.  Fix whatever addressing problem you had, and
1037 send the message again with @kbd{C-c C-c}.
1039 @node Draft Editing, Moving Mail, Sending Mail, Using mh-e
1040 @section Editing a Draft
1042 @cindex editing draft
1043 @cindex MH-Letter mode
1044 @cindex modes, MH-Letter
1046 When you edit a message that you want to send (called a @dfn{draft} in
1047 this case), the mode used is MH-Letter.  This mode provides
1048 several commands in addition to the normal Emacs editing commands to
1049 help you edit your draft.
1051 @table @kbd
1052 @item C-c C-y
1053 Insert contents of message to which you're replying (@code{mh-yank-cur-msg}).
1055 @item C-c C-i
1056 Insert a message from a folder (@code{mh-insert-letter}).
1058 @item C-c C-f C-t
1059 Move to @samp{To:} header field (@code{mh-to-field}).
1061 @item C-c C-f C-c
1062 Move to @samp{cc:} header field (@code{mh-to-field}).
1064 @item C-c C-f C-s
1065 Move to @samp{Subject:} header field (@code{mh-to-field}).
1067 @item C-c C-f C-f
1068 Move to @samp{From:} header field (@code{mh-to-field}).
1070 @item C-c C-f C-b
1071 Move to @samp{Bcc:} header field (@code{mh-to-field}).
1073 @item C-c C-f C-f
1074 Move to @samp{Fcc:} header field (@code{mh-to-fcc}).
1076 @item C-c C-f C-d
1077 Move to @samp{Dcc:} header field (@code{mh-to-field}).
1079 @item C-c C-w
1080 Display expanded recipient list (@code{mh-check-whom}).
1082 @item C-c C-s
1083 Insert signature in message (@code{mh-insert-signature}).
1085 @item C-c C-m C-f
1086 Include forwarded message (@sc{mime}) (@code{mh-mhn-compose-forw}).
1088 @item C-c C-m C-e
1089 Include anonymous ftp reference (@sc{mime}) (@code{mh-mhn-compose-anon-ftp}).
1091 @item C-c C-m C-t
1092 Include anonymous ftp reference to compressed tar file (@sc{mime})
1093 (@code{mh-mhn-compose-external-compressed-tar}).
1095 @item C-c C-m C-i
1096 Include binary, image, sound, etc. (@sc{mime})
1097 (@code{mh-mhn-compose-insertion}).
1099 @item C-c C-e
1100 Run through @code{mhn} before sending (@code{mh-edit-mhn}).
1102 @item C-c C-m C-u
1103 Undo effects of @code{mhn} (@code{mh-revert-mhn-edit}).
1105 @item C-c C-c
1106 Save draft and send message (@code{mh-send-letter}).
1108 @item C-c C-q
1109 Quit editing and delete draft message (@code{mh-fully-kill-draft}).
1110 @end table
1112 @menu
1113 * Editing Textual::             
1114 * Editing MIME::                
1115 * Sending Message::             
1116 * Killing Draft::               
1117 @end menu
1119 @node Editing Textual, Editing MIME, Draft Editing, Draft Editing
1120 @subsection Editing Textual Messages
1122 The following sections show you how to edit a draft.
1123 The commands described here are also applicable to messages that have
1124 multimedia components.
1126 @menu
1127 * Inserting Letter::            
1128 * Inserting Messages::          
1129 * Header::                      
1130 * Recipients::                  
1131 * Signature::                   
1132 @end menu
1134 @node Inserting Letter, Inserting Messages, Editing Textual, Editing Textual
1135 @subsubsection Inserting letter to which you're replying
1137 @cindex inserting messages
1138 @findex @code{mh-yank-cur-msg}
1140 It is often useful to insert a snippet of text from a letter that
1141 someone mailed to provide some context for your reply.  The command
1142 @kbd{C-c C-y} (@code{mh-yank-cur-msg}) does this by yanking a portion of
1143 text from the message to which you're replying and inserting @samp{> }
1144 before each line.
1146 @cindex mark
1147 @cindex Emacs, mark
1148 @cindex point
1149 @cindex Emacs, point
1150 @cindex region
1151 @cindex Emacs, region
1153 You can control how much text is included when you run this command.  If
1154 you run this command right away, without entering the buffer containing
1155 the message to you, this command will yank the entire message, as is,
1156 into your reply. @footnote{If you'd rather have the header cleaned up,
1157 use @kbd{C-u r} instead of @kbd{r} when replying (see @ref{Replying}).}
1158 If you enter the buffer containing the message sent to you and move the
1159 cursor to a certain point and return to your reply and run @kbd{C-c
1160 C-y}, then the text yanked will range from that point to the end of the
1161 message.  Finally, the most common action you'll perform is to enter the
1162 message sent to you, move the cursor to the beginning of a paragraph or
1163 phrase, set the @dfn{mark} with @kbd{C-SPC} or @kbd{C-@@}, and move the
1164 cursor to the end of the paragraph or phrase.  The cursor position is
1165 called the @dfn{point}, and the space between the mark and point is
1166 called the @dfn{region}.  Having done that, @kbd{C-c C-y} will insert
1167 the region you selected.
1169 @node Inserting Messages, Header, Inserting Letter, Editing Textual
1170 @subsubsection Inserting messages
1172 @cindex inserting messages
1173 @findex @code{mh-insert-letter}
1175 Messages can be inserted with @kbd{C-c C-i} (@code{mh-insert-letter}).
1176 This command prompts you for the folder and message number and inserts
1177 the message, indented by @samp{> }.  Certain undesirable header fields
1178 are removed before insertion.  If given a prefix argument (like @kbd{C-u
1179 C-c C-i}), the header is left intact, the message is not indented, and
1180 @samp{> } is not inserted before each line.
1182 @node Header, Recipients, Inserting Messages, Editing Textual
1183 @subsubsection Editing the header
1185 @cindex editing header
1186 @findex @code{mh-to-field}
1188 Because the header is part of the message, you can edit the header
1189 fields as you wish.  However, several convenience functions exist to
1190 help you create and edit them.  For example, the command @kbd{C-c C-f
1191 C-t} (@code{mh-to-field}; alternatively, @kbd{C-c C-f t}) moves the
1192 cursor to the @samp{To:} header field, creating it if necessary.  The
1193 functions to move to the @samp{cc:}, @samp{Subject:}, @samp{From:},
1194 @samp{Bcc:}, and @samp{Dcc:} header fields are similar.
1196 @findex @code{mh-to-fcc}
1198 One function behaves differently from the others, namely, @kbd{C-c C-f
1199 C-f} (@code{mh-to-fcc}; alternatively, @kbd{C-c C-f f}).  This function
1200 will prompt you for the folder name in which to file a copy of the draft.
1202 Be sure to leave a row of dashes or a blank line between the header and
1203 the body of the message.
1205 @node Recipients, Signature, Header, Editing Textual
1206 @subsubsection Checking recipients
1208 @cindex checking recipients
1209 @cindex @code{whom}
1210 @cindex MH commands, @code{whom}
1211 @findex @code{mh-check-whom}
1213 The @kbd{C-c C-w} (@code{mh-check-whom}) command expands aliases so you
1214 can check the actual address(es) in the alias.  A new buffer is created
1215 with the output of @code{whom}.
1217 @node Signature,  , Recipients, Editing Textual
1218 @subsubsection Inserting your signature
1220 @cindex inserting signature
1221 @cindex signature
1222 @cindex @file{.signature}
1223 @cindex files, @file{.signature}
1224 @findex @code{mh-insert-signature}
1226 You can insert your signature at the current cursor location with the
1227 @kbd{C-c C-s} (@code{mh-insert-signature}) command.  The text of your
1228 signature is taken from the file @file{~/.signature}.
1230 @node Editing MIME, Sending Message, Editing Textual, Draft Editing
1231 @subsection Editing Multimedia Messages
1233 @cindex MIME
1234 @cindex multimedia mail
1235 @cindex @code{mhn}
1236 @cindex MH commands, @code{mhn}
1238 mh-e has the capability to create multimedia messages.  It uses the
1239 @sc{mime} (Multipurpose Internet Mail Extensions) protocol.  The
1240 @sc{mime} protocol allows you to incorporate images, sound, video,
1241 binary files, and even commands that fetch a file with @samp{ftp} when
1242 your recipient reads the message!  If you were to create a multimedia
1243 message with plain MH commands, you would use @code{mhn}.  Indeed, the
1244 mh-e @sc{mime} commands merely insert @code{mhn} directives which are
1245 later expanded by @code{mhn}.
1247 Each of the mh-e commands for editing multimedia messages or for
1248 incorporating multimedia objects is prefixed with @kbd{C-c C-m} .
1250 @cindex content types
1251 @cindex MIME, content types
1253 Several @sc{mime} objects are defined.  They are called @dfn{content
1254 types}.  The table in @ref{Customizing Draft Editing} contains a list of
1255 the content types that mh-e currently knows about.  Several of the mh-e
1256 commands fill in the content type for you, whereas others require you to
1257 enter one.  Most of the time, it should be obvious which one to use
1258 (e.g., use @kbd{image/jpeg} to include a @sc{jpeg} image).  If not, you
1259 can refer to @sc{rfc} 1521, 
1260 @c Footnotes are very fragile.  Hence the duplication.
1261 @c The line break in the footnote was necessary since TeX wasn't creating one.
1262 @ifclear html
1263 @footnote{This @sc{rfc} (Request For Comments) is
1264 available via the @sc{url} @*
1265 @file{ftp://ds.internic.net/rfc/rfc1521.txt}.}
1266 @end ifclear
1267 @ifset html
1268 @footnote{This @sc{rfc} (Request For Comments) is
1269 available via the @sc{url} @*
1270 @file{<A HREF="ftp://ds.internic.net/rfc/rfc1521.txt">ftp://ds.internic.net/rfc/rfc1521.txt</A>}.}
1271 @end ifset
1272 which defines the @sc{mime} protocol, for a list of valid content types.
1274 @cindex content description
1275 @cindex MIME, content description
1277 You are also sometimes asked for a @dfn{content description}.  This is
1278 simply an optional brief phrase, in your own words, that describes the
1279 object.  If you don't care to enter a content description, just press
1280 return and none will be included; however, a reader may skip over
1281 multimedia fields unless the content description is compelling.
1283 Remember: you can always add @code{mhn} directives by hand.
1285 @menu
1286 * Forwarding MIME::             
1287 * FTP::                         
1288 * Tar::                         
1289 * Other MIME Objects::          
1290 * Sending MIME::                
1291 @end menu
1293 @node Forwarding MIME, FTP, Editing MIME, Editing MIME
1294 @subsubsection Forwarding multimedia messages
1296 @findex @code{mh-mhn-compose-forw}
1298 Mail may be forwarded with @sc{mime} using the command @kbd{C-c C-m C-f}
1299 (@code{mh-mhn-compose-forw}).  You are prompted for a content
1300 description, the name of the folder in which the messages to forward are
1301 located, and the messages' numbers.
1303 @node FTP, Tar, Forwarding MIME, Editing MIME
1304 @subsubsection Including an ftp reference
1306 @cindex @code{ftp}
1307 @cindex Unix commands, @code{ftp}
1308 @cindex MIME, @code{ftp}
1309 @findex @code{mh-mhn-compose-anon-ftp}
1311 You can even have your message initiate an @code{ftp} transfer when the
1312 recipient reads the message.  To do this, use the @kbd{C-c C-m C-e}
1313 (@code{mh-mhn-compose-anon-ftp}) command.  You are prompted for the
1314 remote host and pathname, the content type, and the content description.
1316 @node Tar, Other MIME Objects, FTP, Editing MIME
1317 @subsubsection Including tar files
1319 @cindex @code{tar}
1320 @cindex Unix commands, @code{tar}
1321 @cindex MIME, @code{tar}
1322 @cindex @code{ftp}
1323 @cindex Unix commands, @code{ftp}
1324 @cindex MIME, @code{ftp}
1325 @findex @code{mh-mhn-compose-external-compressed-tar}
1327 If the remote file (@pxref{FTP}) is a compressed tar file, you can use
1328 @kbd{C-c C-m C-t} (@code{mh-mhn-compose-external-compressed-tar}).
1329 Then, in addition to retrieving the file via anonymous @emph{ftp}, the
1330 file will also be uncompressed and untarred.  You are prompted for the
1331 remote host and pathname and the content description.  The pathname
1332 should contain at least one @samp{/} (slash), because the pathname is
1333 broken up into directory and name components.
1335 @node Other MIME Objects, Sending MIME, Tar, Editing MIME
1336 @subsubsection Including other multimedia objects
1338 @cindex images
1339 @cindex MIME, images
1340 @cindex sound
1341 @cindex MIME, sound
1342 @cindex video
1343 @cindex MIME, video
1344 @findex @code{mh-mhn-compose-insertion}
1346 Images, sound, and video can be inserted in your message with the
1347 @kbd{C-c C-m C-i} (@code{mh-mhn-compose-insertion}) command.  You are
1348 prompted for the filename containing the object, the content type, and a
1349 content description of the object.
1351 @node Sending MIME,  , Other MIME Objects, Editing MIME
1352 @subsubsection Readying multimedia messages for sending
1354 When you are finished editing a @sc{mime} message, it might look like this:
1356 @example
1357 @group
1358 @cartouche
1359    3  24Aug  root               received fax files on Wed Aug 24 11:00:13
1360    4+ 24Aug  To:wohler          Test<<This is a test message to get the wh
1366 --%%-@{+inbox@} 4 msgs (1-4)      (MH-Folder Show)--Bot-------------------
1367 To: wohler
1369 Subject: Test of MIME
1370 --------
1371 #@@application/octet-stream [Nonexistent ftp test file] \
1372 access-type=anon-ftp; site=berzerk.com; name=panacea.tar.gz; \
1373 directory="/pub/"
1374 #audio/basic [Test sound bite] /tmp/noise.au
1375 --**-@{draft@}      (MH-Letter)--All--------------------------------------
1377 @end cartouche
1378 @i{mh-e @sc{mime} draft}
1379 @end group
1380 @end example
1382 @cindex @code{mhn}
1383 @cindex MH commands, @code{mhn}
1384 @findex @code{mh-edit-mhn}
1386 The lines added by the previous commands are @code{mhn} directives and
1387 need to be converted to @sc{mime} directives before sending.  This is
1388 accomplished by the command @kbd{C-c C-e} (@code{mh-edit-mhn}), which
1389 runs @code{mhn} on the message.  The following screen shows what those
1390 commands look like in full @sc{mime} format.  You can see why mail user
1391 agents are usually built to hide these details from the user.
1393 @example
1394 @group
1395 @cartouche
1396 To: wohler
1398 Subject: Test of MIME
1399 MIME-Version: 1.0
1400 Content-Type: multipart/mixed; boundary="----- =_aaaaaaaaaa0"
1401 Content-ID: <1623.777796162.0@@newt.com>
1403 ------- =_aaaaaaaaaa0
1404 Content-Type: message/external-body; access-type="anon-ftp";
1405         site="berzerk.com"; name="panacea.tar.gz"; directory="/pub/"
1407 Content-Type: application/octet-stream
1408 Content-ID: <1623.777796162.1@@newt.com>
1409 Content-Description: Nonexistent ftp test file
1411 ------- =_aaaaaaaaaa0
1412 Content-Type: audio/basic
1413 Content-ID: <1623.777796162.2@@newt.com>
1414 Content-Description: Test sound bite
1415 Content-Transfer-Encoding: base64
1417 Q3JlYXRpdmUgVm9pY2UgRmlsZRoaAAoBKREBQh8AgwCAgH9/f35+fn59fX5+fn5+f39/f39/f3
1418 f4B/f39/f39/f39/f39/f39+f39+f39/f39/f4B/f39/fn5/f39/f3+Af39/f39/gH9/f39/fn
1419 -----@{draft@}      (MH-Letter)--Top--------------------------------------
1421 @end cartouche
1422 @i{mh-e @sc{mime} draft ready to send}
1423 @end group
1424 @end example
1426 @findex @code{mh-revert-mhn-edit}
1428 This action can be undone by running @kbd{C-c C-m C-u}
1429 (@code{mh-revert-mhn-edit}).  It does this by reverting to a backup
1430 file.  You are prompted to confirm this action, but you can avoid the
1431 confirmation by adding an argument (for example, @kbd{C-u C-c C-m C-u}).
1433 @node Sending Message, Killing Draft, Editing MIME, Draft Editing
1434 @subsection Sending a Message
1436 @cindex sending mail
1437 @findex @code{mh-send-letter}
1439 When you are all through editing a message, you send it with the
1440 @kbd{C-c C-c} (@code{mh-send-letter}) command.  You can give an argument
1441 (as in @kbd{C-u C-c C-c}) to monitor the first stage of the delivery.
1443 @node Killing Draft,  , Sending Message, Draft Editing
1444 @subsection Killing the Draft
1446 @cindex killing draft
1447 @findex @code{mh-fully-kill-draft}
1449 If for some reason you are not happy with the draft, you can kill it
1450 instead with @kbd{C-c C-q} (@code{mh-fully-kill-draft}).  Emacs then
1451 kills the draft buffer and deletes the draft message.
1453 @node Moving Mail, Searching, Draft Editing, Using mh-e
1454 @section Moving Your Mail Around
1456 @cindex processing mail
1458 This section covers how messages and folders can be moved about or
1459 manipulated.  Messages may be incorporated into your @file{+inbox},
1460 deleted, and refiled.  Messages containing @code{shar} or
1461 @code{uuencode} output can be stored.  Folders can be visited, sorted,
1462 packed, or deleted.  Here's a list of the available commands to do these
1463 things:
1465 @c Stephen thinks that ? should be documented here, since it also shows
1466 @c which folders a message will be refiled to.
1468 @table @kbd
1469 @item i
1470 Incorporate new mail into folder (@code{mh-inc-folder}).
1472 @item d
1473 Delete message (@code{mh-delete-msg}).
1475 @item C-d
1476 Delete message, don't move to next message (@code{mh-delete-msg-no-motion}).
1478 @item M-s
1479 Find messages that meet search criteria (@code{mh-search-folder}).
1481 @item o
1482 Output (refile) message to folder (@code{mh-refile-msg}).
1484 @item c
1485 Copy message to folder (@code{mh-copy-msg}).
1487 @item C-o
1488 Output (write) message to file (@code{mh-write-msg-to-file}).
1490 @item !
1491 Repeat last output command (@code{mh-refile-or-write-again}).
1493 @item l
1494 Print message with @code{lpr} (@code{mh-print-msg}).
1496 @item |
1497 Pipe message through shell command (@code{mh-pipe-msg}).
1499 @item M-n
1500 Unpack message created with @code{uudecode} or @code{shar}
1501 (@code{mh-store-msg}).
1503 @item M-l
1504 List all folders (@code{mh-list-folders}).
1506 @item M-f
1507 Visit folder (@code{mh-visit-folder}).
1509 @item M-r
1510 Regenerate scan lines (@code{mh-rescan-folder}).
1512 @item M-x mh-sort-folder
1513 Sort folder.
1515 @item M-p
1516 Pack folder (@code{mh-pack-folder}).
1518 @item M-k
1519 Remove folder (@code{mh-kill-folder}).
1521 @item x
1522 Execute pending refiles and deletes (@code{mh-execute-commands}).
1524 @item u
1525 Undo pending refile or delete (@code{mh-undo}).
1527 @item M-u
1528 Undo all pending refiles and deletes (@code{mh-undo-folder}).
1530 @item q
1531 Quit (@code{mh-quit}).
1532 @end table
1534 @menu
1535 * Incorporating::               
1536 * Deleting::                    
1537 * Organizing::                  
1538 * Printing::                    
1539 * Files and Pipes::             
1540 * Finishing Up::                
1541 @end menu
1543 @node Incorporating, Deleting, Moving Mail, Moving Mail
1544 @subsection Incorporating Your Mail
1546 @cindex incorporating
1547 @findex @code{mh-inc-folder}
1549 If at any time you receive new mail, incorporate the new mail into your
1550 @samp{+inbox} buffer with @kbd{i} (@code{mh-inc-folder}).  Note that
1551 @kbd{i} will display the @samp{+inbox} buffer, even if there isn't any
1552 new mail.  You can incorporate mail from any file into the current
1553 folder by specifying a prefix argument; you'll be prompted for the name
1554 of the file to use (for example, @kbd{C-u i ~/mbox @key{RET}}).
1556 @cindex Emacs, notification of new mail
1557 @cindex notification of new mail
1558 @cindex new mail
1559 @cindex @file{.emacs}
1560 @cindex files, @file{.emacs}
1562 Emacs can notify you when you have new mail by displaying @samp{Mail} in
1563 the mode line.  To enable this behavior, and to have a clock in the mode
1564 line besides, add the following to @file{~/.emacs}:
1566 @findex @code{display-time}
1568 @lisp
1569 (display-time)
1570 @end lisp
1572 @node Deleting, Organizing, Incorporating, Moving Mail
1573 @subsection Deleting Your Mail
1575 @cindex deleting
1576 @findex @code{mh-delete-msg}
1577 @findex @code{mh-delete-msg-no-motion}
1579 To mark a message for deletion, use the @kbd{d} (@code{mh-delete-msg})
1580 command.  A @samp{D} is placed by the message in the scan window, and
1581 the next message is displayed.  If the previous command had been
1582 @kbd{p}, then the next message displayed is the message previous to the
1583 message just deleted.  If you specify a prefix argument, you will be
1584 prompted for a sequence (@pxref{Sequences}) to delete (for example,
1585 @kbd{C-u d frombob RET}).  The @kbd{x} command actually carries out the
1586 deletion (@pxref{Finishing Up}).  @kbd{C-d}
1587 (@code{mh-delete-msg-no-motion}) marks the message for deletion but
1588 leaves the cursor at the current message in case you wish to perform
1589 other operations on the message.
1591 @node Organizing, Printing, Deleting, Moving Mail
1592 @subsection Organizing Your Mail with Folders
1594 @cindex using folders
1595 @cindex @code{folder}
1596 @cindex MH commands, @code{folder}
1597 @cindex @code{refile}
1598 @cindex MH commands, @code{refile}
1599 @findex @code{mh-refile-msg}
1601 mh-e has analogies for each of the MH @code{folder} and @code{refile}
1602 commands.  To refile a message in another folder, use the @kbd{o}
1603 (@code{mh-refile-msg}) (mnemonic: ``output'') command.  You are prompted
1604 for the folder name.
1606 @findex @code{mh-refile-or-write-again}
1608 If you are refiling several messages into the same folder, you can use
1609 the @kbd{!} (@code{mh-refile-or-write-again}) command to repeat the last
1610 refile or write (see the description of @kbd{C-o} in @ref{Files and
1611 Pipes}).  Or, place the messages into a sequence (@ref{Sequences}) and
1612 specify a prefix argument to @kbd{o}, in which case you'll be prompted
1613 for the name of the sequence (for example, @kbd{C-u o search RET}).
1615 @findex @code{mh-copy-msg}
1617 If you wish to copy a message to another folder, you can use the @kbd{c}
1618 (@code{mh-copy-msg}) command (see the @code{-link} argument to
1619 @code{refile}(1)).  You are prompted for a folder, and you can specify a
1620 prefix argument if you want to copy a sequence into another folder.  In
1621 this case, you are then prompted for the sequence.  Note that unlike the
1622 @kbd{o} command, the copy takes place immediately.  The original copy
1623 remains in the current folder.
1625 @findex @code{mh-visit-folder}
1627 When you want to read the messages that you have refiled into folders,
1628 use the @kbd{M-f} (@code{mh-visit-folder}) command to visit the folder.
1629 You are prompted for the folder name.
1631 @findex @code{mh-list-folders}
1632 @findex @code{mh-visit-folder}
1633 @findex @code{mh-sort-folder}
1634 @findex @code{mh-pack-folder}
1635 @findex @code{mh-rescan-folder}
1637 Other commands you can perform on folders include: @kbd{M-l}
1638 (@code{mh-list-folders}), to list all the folders in your mail
1639 directory; @kbd{M-k} (@code{mh-kill-folder}), to remove a folder;
1640 @kbd{M-x mh-sort-folder}, to sort the messages by date (see
1641 @code{sortm}(1) to see how to sort by other criteria); @kbd{M-p}
1642 (@code{mh-pack-folder}), to pack a folder, removing gaps from the
1643 numbering sequence; and @kbd{M-r} (@code{mh-rescan-folder}), to rescan
1644 the folder, which is useful to grab all messages in your @file{+inbox}
1645 after processing your new mail for the first time.  If you don't want to
1646 rescan the entire folder, give @kbd{M-r} or @kbd{M-p} a prefix argument
1647 and you'll be prompted for a range of messages to display (for instance,
1648 @kbd{C-u M-r last:50 RET}).
1650 @node Printing, Files and Pipes, Organizing, Moving Mail
1651 @subsection Printing Your Mail
1653 @cindex printing
1654 @cindex @code{mhl}
1655 @cindex MH commands, @code{mhl}
1656 @cindex @code{lpr}
1657 @cindex Unix commands, @code{lpr}
1658 @findex @code{mh-print-msg}
1660 Printing mail is simple.  Enter @kbd{l} (@code{mh-print-msg}) (for
1661 @i{l}ine printer or @i{l}pr).  The message is formatted with @code{mhl}
1662 and printed with the @code{lpr} command.  You can print all the messages
1663 in a sequence by specifying a prefix argument, in which case you are
1664 prompted for the name of the sequence (as in @kbd{C-u l frombob RET}).
1666 @node Files and Pipes, Finishing Up, Printing, Moving Mail
1667 @subsection Files and Pipes
1669 @cindex using files
1670 @cindex using pipes
1671 @findex @code{mh-write-msg-to-file}
1673 mh-e does offer a couple of commands that are not a part of MH@.  The
1674 first one, @kbd{C-o} (@code{mh-write-msg-to-file}), writes a message to
1675 a file (think of the @kbd{o} as in "output").  You are prompted for the
1676 filename.  If the file already exists, the message is appended to it.
1677 You can also write the message to the file without the header by
1678 specifying a prefix argument (such as @kbd{C-u C-o /tmp/foobar RET}).
1679 Subsequent writes to the same file can be made with the @kbd{!}
1680 command.
1682 @findex @code{mh-pipe-msg}
1684 You can also pipe the message through a Unix shell command with the
1685 @kbd{|} (@code{mh-pipe-msg}) command.  You are prompted for the
1686 Unix command through which you wish to run your message.  If you
1687 give an argument to this command, the message header is included in the
1688 text passed to the command (the contrived example @kbd{C-u | lpr}
1689 would be done with the @kbd{l} command instead).
1691 @cindex @code{shar}
1692 @cindex Unix commands, @code{shar}
1693 @cindex @code{uuencode}
1694 @cindex Unix commands, @code{uuencode}
1695 @findex @code{mh-store-msg}
1697 If the message is a shell archive @code{shar} or has been run through
1698 @code{uuencode} use @kbd{M-n} (@code{mh-store-msg}) to extract the body
1699 of the message.  The default directory for extraction is the current
1700 directory, and you have a chance to specify a different extraction
1701 directory.  The next time you use this command, the default directory is
1702 the last directory you used.
1704 @node Finishing Up,  , Files and Pipes, Moving Mail
1705 @subsection Finishing Up
1707 @cindex expunging refiles and deletes
1708 @findex @code{mh-undo}
1709 @findex @code{mh-undo-folder}
1711 If you've deleted a message or refiled it, but changed your mind, you
1712 can cancel the action before you've executed it.  Use @kbd{u}
1713 (@code{mh-undo}) to undo a refile on or deletion of a single message.
1714 You can also undo refiles and deletes for messages that belong to a
1715 given sequence by specifying a prefix argument.  You'll be prompted for
1716 the name of the sequence (as in @kbd{C-u u frombob RET}).
1717 Alternatively, you can use @kbd{M-u} (@code{mh-undo-folder}) to undo all
1718 refiles or deletes in the current folder.
1720 @findex @code{mh-execute-commands}
1722 If you've marked messages to be deleted or refiled and you want to go
1723 ahead and delete or refile the messages, use @kbd{x}
1724 (@code{mh-execute-commands}).  Many mh-e commands that may affect the
1725 numbering of the messages (such as @kbd{M-r} or @kbd{M-p}) will ask if you
1726 want to process refiles or deletes first and then either run @kbd{x} for
1727 you or undo the pending refiles and deletes, which are lost.
1729 @findex @code{mh-rmail}
1730 @findex @code{mh-quit}
1732 When you want to quit using mh-e and go back to editing, you can use the
1733 @kbd{q} (@code{mh-quit}) command.  This buries the buffers of the
1734 current mh-e folder and restores the buffers that were present when you
1735 first ran @kbd{M-x mh-rmail}.  You can later restore your mh-e session
1736 by selecting the @samp{+inbox} buffer or by running @kbd{M-x mh-rmail}
1737 again.
1739 @node Searching, Sequences, Moving Mail, Using mh-e
1740 @section Searching Through Messages
1742 @cindex searching
1743 @findex @code{mh-search-folder}
1745 You can search a folder for messages to or from a particular person or
1746 about a particular subject.  In fact, you can also search for messages
1747 containing selected strings in any arbitrary header field or any string
1748 found within the messages.  Use the @kbd{M-s} (@code{mh-search-folder})
1749 command.  You are first prompted for the name of the folder to search
1750 and then placed in the following buffer in MH-Pick mode:
1752 @example
1753 @group
1754 @cartouche
1755 From: #
1758 Date:
1759 Subject:
1760 --------
1770 --**-Emacs: pick-pattern    (MH-Pick)------All----------------------------
1772 @end cartouche
1773 @i{Pick window}
1774 @end group
1775 @end example
1777 @cindex @code{pick}
1778 @cindex MH commands, @code{pick}
1780 Edit this template by entering your search criteria in an appropriate
1781 header field that is already there, or create a new field yourself.  If
1782 the string you're looking for could be anywhere in a message, then place
1783 the string underneath the row of dashes.  The @kbd{M-s} command uses the
1784 MH command @code{pick} to do the real work, so read @code{pick}(1) to
1785 find out more about how to enter the criteria.
1787 There are no semantics associated with the search criteria---they are
1788 simply treated as strings.  Case is ignored when all lowercase is used,
1789 and regular expressions (a la @code{ed}) are available.  It is all right
1790 to specify several search criteria.  What happens then is that a logical
1791 @emph{and} of the various fields is performed.  If you prefer a logical
1792 @emph{or} operation, run @kbd{M-s} multiple times.
1794 As an example, let's say that we want to find messages from Ginnean
1795 about horseback riding in the Kosciusko National Park (Australia) during
1796 January, 1994.  Normally we would start with a broad search and narrow
1797 it down if necessary to produce a manageable amount of data, but we'll
1798 cut to the chase and create a fairly restrictive set of criteria as
1799 follows:
1801 @example
1802 @group
1803 From: ginnean
1806 Date: Jan 1994
1807 Subject: horse.*kosciusko
1808 --------
1809 @end group
1810 @end example
1812 @findex @code{mh-to-field}
1814 As with MH-Letter mode, MH-Pick provides commands like
1815 @kbd{C-c C-f C-t} to help you fill in the blanks.
1817 @table @kbd
1818 @item C-c C-f C-t
1819 Move to @samp{To:} header field (@code{mh-to-field}).
1821 @item C-c C-f C-c
1822 Move to @samp{cc:} header field (@code{mh-to-field}).
1824 @item C-c C-f C-s
1825 Move to @samp{Subject:} header field (@code{mh-to-field}).
1827 @item C-c C-f C-f
1828 Move to @samp{From:} header field (@code{mh-to-field}).
1830 @item C-c C-f C-b
1831 Move to @samp{Bcc:} header field (@code{mh-to-field}).
1833 @item C-c C-f C-f
1834 Move to @samp{Fcc:} header field (@code{mh-to-field}).
1836 @item C-c C-f C-d
1837 Move to @samp{Dcc:} header field (@code{mh-to-field}).
1839 @item C-c C-c
1840 Execute the search (@code{mh-do-pick-search}).
1841 @end table
1843 @findex @code{mh-do-pick-search}
1845 To perform the search, type @kbd{C-c C-c} (@code{mh-do-pick-search}).
1846 The selected messages are placed in the @i{search} sequence, which you
1847 can use later in forwarding (@pxref{Forwarding}), printing
1848 (@pxref{Printing}), or narrowing your field of view (@pxref{Sequences}).
1849 Subsequent searches are appended to the @i{search} sequence.  If,
1850 however, you wish to start with a clean slate, first delete the
1851 @i{search} sequence (how to do this is discussed in @ref{Sequences}).
1853 @cindex MH-Folder mode
1854 @cindex modes, MH-Folder
1856 If you're searching in a folder that is already displayed in a
1857 MH-Folder buffer, only those messages contained in the buffer are
1858 used for the search.  Therefore, if you want to search in all messages,
1859 first kill the folder's buffer with @kbd{C-x k} or scan the entire
1860 folder with @kbd{M-r}.
1862 @node Sequences, Miscellaneous, Searching, Using mh-e
1863 @section Using Sequences
1865 @cindex sequences
1867 For the whole scoop on MH sequences, refer to @code{mh-sequence}(5).  As
1868 you've read, several of the mh-e commands can operate on a sequence,
1869 which is a shorthand for a range or group of messages.  For example, you
1870 might want to forward several messages to a friend or colleague.  Here's
1871 how to manipulate sequences.
1873 @table @kbd
1874 @item %
1875 Put message in a sequence (@code{mh-put-msg-in-seq}).
1877 @item ?
1878 Display sequences that message belongs to (@code{mh-msg-is-in-seq}).
1880 @item M-q
1881 List all sequences in folder (@code{mh-list-sequences}).
1883 @item M-%
1884 Remove message from sequence (@code{mh-delete-msg-from-seq}).
1886 @item M-#
1887 Delete sequence (@code{mh-delete-seq}).
1889 @item C-x n
1890 Restrict display to messages in sequence (@code{mh-narrow-to-seq}).
1892 @item C-x w
1893 Remove restriction; display all messages (@code{mh-widen}).
1895 @item M-x mh-update-sequences
1896 Push mh-e's state out to MH@.
1897 @end table
1899 @cindex @code{pick}
1900 @cindex MH commands, @code{pick}
1901 @findex @code{mh-put-msg-in-seq}
1903 To place a message in a sequence, use @kbd{%} (@code{mh-put-msg-in-seq})
1904 to do it manually, or use the MH command @code{pick} or the mh-e version
1905 of @code{pick} (@ref{Searching}) which create a sequence automatically.
1906 Give @kbd{%} a prefix argument and you can add all the messages in one
1907 sequence to another sequence (for example, @kbd{C-u % SourceSequence
1908 RET}).
1910 @cindex MH-Folder mode
1911 @cindex modes, MH-Folder
1912 @findex @code{mh-narrow-to-seq}
1913 @findex @code{mh-widen}
1915 Once you've placed some messages in a sequence, you may wish to narrow
1916 the field of view to just those messages in the sequence you've created.
1917 To do this, use @kbd{C-x n} (@code{mh-narrow-to-seq}).  You are prompted
1918 for the name of the sequence.  What this does is show only those
1919 messages that are in the selected sequence in the MH-Folder buffer.  In
1920 addition, it limits further mh-e searches to just those messages.  When
1921 you want to widen the view to all your messages again, use @kbd{C-x w}
1922 (@code{mh-widen}).
1924 @findex @code{mh-msg-is-in-seq}
1925 @findex @code{mh-list-sequences}
1927 You can see which sequences a message is in with the @kbd{?}
1928 (@code{mh-msg-is-in-seq}) command.
1929 @c Doesn't work:
1930 @c use a prefix argument to query a
1931 @c message other than the current one (as in @kbd{C-u ? 42 RET}).
1932 Or, you can list all sequences in a selected folder (default is current
1933 folder) with @kbd{M-q} (@code{mh-list-sequences}).
1935 @findex @code{mh-delete-msg-from-seq}
1936 @findex @code{mh-delete-seq}
1938 If you want to remove a message from a sequence, use @kbd{M-%}
1939 (@code{mh-delete-msg-from-seq}), and if you want to delete an entire
1940 sequence, use @kbd{M-#} (@code{mh-delete-seq}).  In the latter case you
1941 are prompted for the sequence to delete.  Note that this deletes only
1942 the sequence, not the messages in the sequence.  If you want to delete
1943 the messages, use @kbd{C-u d} (see @ref{Deleting} above).
1945 @cindex @code{mark}
1946 @cindex MH commands, @code{mark}
1948 @findex @code{mh-update-sequences}
1950 Two sequences are maintained internally by mh-e and pushed out to MH
1951 when you type either the @kbd{x} or @kbd{q} command.  They are the
1952 sequence specified by your @samp{Unseen-Sequence:} profile entry and
1953 @i{cur}.  However, you can also just update MH's state with the command
1954 @kbd{M-x mh-update-sequences}.  See @ref{Customizing Viewing} for an
1955 example of how this command might be used.
1957 With the exceptions of @kbd{C-x n} and @kbd{C-x w}, the underlying MH
1958 command dealing with sequences is @code{mark}.
1960 @node Miscellaneous,  , Sequences, Using mh-e
1961 @section Miscellaneous Commands
1963 @findex @code{mh-version}
1965 One other command worth noting is @kbd{M-x mh-version}.  Since there
1966 were a few changes in command letters between @w{Versions 3} and 4, use
1967 this command to see which version you are running.  This command didn't
1968 exist before @w{Version 4}, so the message @samp{[No match]}
1969 indicates that it's time to upgrade (@pxref{Getting mh-e}).  In the
1970 meantime, use the older commands that are listed in @ref{Changes to
1971 mh-e}.  The output of @kbd{M-x mh-version} should also be included with
1972 any bug report you send (@pxref{Bug Reports}).
1974 @node    Customizing mh-e, Odds and Ends, Using mh-e, Top
1975 @chapter Customizing mh-e
1977 Until now, we've talked about the mh-e commands as they work ``out of the
1978 box.''  Of course, it is also possible to reconfigure mh-e
1979 @c to fit the needs of even the most demanding user. ???
1980 beyond recognition.  The following sections describe all of the
1981 customization variables, show the defaults, and make recommendations for
1982 customization.  The outline of this chapter is identical to that of
1983 @ref{Using mh-e}, to make it easier to find the variables you'd need to
1984 modify to affect a particular command.
1986 However, when customizing your mail environment, first try to change
1987 what you want in MH, and only change mh-e if changing MH is not
1988 possible.  That way you will get the same behavior inside and outside
1989 GNU Emacs.  Note that mh-e does not provide hooks for customizations
1990 that can be done in MH; this omission is intentional.
1992 @cindex @file{.emacs}
1993 @cindex files, @file{.emacs}
1995 Many string or integer variables are easy enough to modify using Emacs
1996 Lisp.  Any such modifications should be placed in a file called
1997 @file{.emacs} in your home directory (that is, @file{~/.emacs}).  For
1998 example, to modify the variable that controls printing, you could add:
2000 @vindex @code{mh-lpr-command-format}, example
2002 @lisp
2003 (setq mh-lpr-command-format "nenscript -G -r -2 -i'%s'")
2004 @end lisp
2006 @ref{Customizing Printing} talks more about this variable.
2008 @cindex setting variables
2009 @cindex Emacs, setting variables
2011 Variables can also hold Boolean values.  In Emacs Lisp, the Boolean
2012 values are @code{nil}, which means false, and @code{t}, which means true.
2013 Usually, variables are turned off by setting their value to @code{nil}, as
2016 @vindex @code{mh-bury-show-buffer}, example
2018 @lisp
2019 (setq mh-bury-show-buffer nil)
2020 @end lisp
2022 which keeps the MH-Show buffer at the top of the buffer stack.
2023 To turn a variable on, you use
2025 @lisp
2026 (setq mh-bury-show-buffer t)
2027 @end lisp
2029 which places the MH-Show buffer at the bottom of the buffer
2030 stack.  However, the text says to turn on a variable by setting it to a
2031 @emph{non-@code{nil}} value, because sometimes values other than @code{t} are
2032 meaningful (for example, see @code{mhl-formfile}, described in
2033 @ref{Customizing Viewing}).  Other variables, such as hooks, involve a
2034 little more Emacs Lisp programming expertise.
2036 You can also ``preview'' the effects of changing variables before
2037 committing the changes to @file{~/.emacs}.  Variables can be changed in
2038 the current Emacs session by using @kbd{M-x set-variable}.
2040 @c XXX Stephen says: would be easier to just call them functions, which
2041 @c you mostly do.
2042 In general, @dfn{commands} in this text refer to Emacs Lisp functions.
2043 Programs outside of Emacs are specifically called MH commands, shell
2044 commands, or Unix commands.
2046 @cindex Emacs, Emacs Lisp manual
2047 @cindex Emacs, online help
2048 @cindex online help
2049 @cindex Emacs, info
2050 @cindex info
2052 I hope I've included enough examples here to get you well on your way.
2053 If you want to explore Emacs Lisp further, a programming manual does
2054 exist,
2055 @c Yes, some of the stuff in the following sections is redundant, but
2056 @c TeX barfs if the @ifs are inside the @footnote.
2057 @iftex
2058 @footnote{The @cite{GNU Emacs Lisp Reference Manual} may be available
2059 online in the Info system by typing @kbd{C-h i m Emacs Lisp RET}.  If
2060 not, you can order a printed manual, which has the desirable side-effect
2061 of helping to support the Free Software Foundation which made all this
2062 great software available.  You can find an order form by running
2063 @kbd{C-h C-d}, or you can request an order form from
2064 @i{gnu@@gnu.org}.}
2065 @end iftex
2066 @ifinfo
2067 @footnote{Perhaps you can find the online version of @ref{Top, The GNU
2068 Emacs Lisp Reference Manual, , elisp, GNU Emacs Lisp Reference Manual}.
2069 If not, you can order a printed manual, which has the desirable
2070 side-effect of helping to support the Free Software Foundation which
2071 made all this great software available.  You can find an order form by
2072 running @kbd{C-h C-d}, or you can request an order form from
2073 @i{gnu@@gnu.org}.}
2074 @end ifinfo
2075 and you can look at the code itself for examples.  Look in the Emacs
2076 Lisp directory on your system (such as @file{/usr/local/lib/emacs/lisp})
2077 and find all the @file{mh-*.el} files there.  When calling mh-e and
2078 other Emacs Lisp functions directly from Emacs Lisp code, you'll need to
2079 know the correct arguments.  Use the online help for this.  For example,
2080 try @kbd{C-h f mh-execute-commands RET}.  If you write your own
2081 functions, please do not prefix your symbols (variables and functions)
2082 with @code{mh-}.  This prefix is reserved for the mh-e package.  To
2083 avoid conflicts with existing mh-e symbols, use a prefix like @code{my-}
2084 or your initials.
2086 @menu
2087 * Customizing Reading::         
2088 * Customizing Sending::         
2089 * Customizing Draft Editing::   
2090 * Customizing Moving Mail::     
2091 * Customizing Searching::       
2092 @end menu
2094 @node Customizing Reading, Customizing Sending, Customizing mh-e, Customizing mh-e
2095 @section Reading Your Mail
2097 @cindex reading mail
2098 @cindex @file{.emacs}
2099 @cindex files, @file{.emacs}
2101 I'll start out by including a function that I use as a front end to
2102 mh-e.  @footnote{Stephen Gildea's favorite binding is
2103 @kbd{(global-set-key "\C-cr" 'mh-rmail)}.} It toggles between your
2104 working window configuration, which may be quite involved---windows
2105 filled with source, compilation output, man pages, and other
2106 documentation---and your mh-e window configuration.  Like the rest of
2107 the customization described in this chapter, simply add the following
2108 code to @file{~/.emacs}.  Don't be intimidated by the size of this
2109 example; most customizations are only one line.
2111 @iftex
2112 @filbreak
2113 @end iftex
2115 @findex @code{mh-rmail}, example
2117 @lisp
2118 @group
2119 @i{Starting mh-e}
2121 (defvar my-mh-screen-saved nil
2122   "Set to non-@code{nil} when mh-e window configuration shown.")
2123 (defvar my-normal-screen nil "Normal window configuration.")
2124 (defvar my-mh-screen nil "mh-e window configuration.")
2126 (defun my-mh-rmail (&optional arg)
2127   "Toggle between mh-e and normal screen configurations.
2128 With non-@code{nil} or prefix argument, @i{inc} mailbox as well
2129 when going into mail."
2130   (interactive "P")                 ; @r{user callable function, P=prefix arg}
2131   (setq my-mh-screen-saved          ; @r{save state}
2132         (cond
2133          ;; @r{Bring up mh-e screen if arg or normal window configuration.}
2134          ;; @r{If arg or +inbox buffer doesn't exist, run mh-rmail.}
2135          ((or arg (null my-mh-screen-saved))
2136           (setq my-normal-screen (current-window-configuration))
2137           (if (or arg (null (get-buffer "+inbox")))
2138               (mh-rmail)
2139             (set-window-configuration my-mh-screen))
2140           t)                        ; @r{set my-mh-screen-saved to @code{t}}
2141          ;; @r{Otherwise, save mh-e screen and restore normal screen.}
2142          (t
2143           (setq my-mh-screen (current-window-configuration))
2144           (set-window-configuration my-normal-screen)
2145           nil))))                   ; @r{set my-mh-screen-saved to nil}
2147 (global-set-key "\C-x\r" 'my-mh-rmail)  ;@r{ call with C-x RET}
2148 @end group
2149 @end lisp
2151 If you type an argument (@kbd{C-u}) or if @code{my-mh-screen-saved}
2152 is @code{nil} (meaning a non-mh-e window configuration), the current window
2153 configuration is saved, either +inbox is displayed or @code{mh-rmail} is
2154 run, and the mh-e window configuration is shown.  Otherwise, the mh-e
2155 window configuration is saved and the original configuration is
2156 displayed.
2158 Now to configure mh-e.  The following table lists general mh-e variables
2159 and variables that are used while reading mail.
2160 @c XXX Seth wishes the descriptions to be more parallel.  That is,
2161 @c some are actions, and some are objects. Hmmm.
2163 @table @code
2164 @item mh-progs
2165 Directory containing MH programs (default: dynamic).
2167 @item mh-lib
2168 Directory containing MH support files and programs (default: dynamic).
2170 @item mh-do-not-confirm
2171 Don't confirm on non-reversible commands (default: @code{nil}).
2173 @item mh-summary-height
2174 Number of scan lines to show (includes mode line) (default: 4).
2176 @item mh-folder-mode-hook
2177 Functions to run in MH-Folder mode (default: @code{nil}).
2179 @item mh-clean-message-header
2180 Remove extraneous headers (default: @code{nil}).
2182 @item mh-invisible-headers
2183 Headers to hide (default: @samp{"^Received: \\| ^Message-Id: \\|
2184 ^Remailed-\\| ^Via: \\| ^Mail-from: \\| ^Return-Path: \\| ^In-Reply-To:
2185 \\| ^Resent-"}).
2187 @item mh-visible-headers
2188 Headers to display (default: @code{nil}).
2190 @item mhl-formfile
2191 Format file for @code{mhl} (default: @code{nil}).
2193 @item mh-show-hook
2194 Functions to run when showing message (default: @code{nil}).
2196 @item mh-show-mode-hook
2197 Functions to run when showing message (default: @code{nil}).
2199 @item mh-bury-show-buffer
2200 Leave show buffer at bottom of stack (default: @code{t}).
2202 @item mh-show-buffer-mode-line-buffer-id
2203 Name of show buffer in mode line (default: @samp{"@{show-%s@} %d"}).
2204 @end table
2206 @vindex @code{mh-progs}
2207 @vindex @code{mh-lib}
2209 The two variables @code{mh-progs} and @code{mh-lib} are used to tell
2210 mh-e where the MH programs and supporting files are kept, respectively.
2211 mh-e does try to figure out where they are kept for itself by looking in
2212 common places and in the user's @samp{PATH} environment variable, but if
2213 it cannot find the directories, or finds the wrong ones, you should set
2214 these variables.  The name of the directory should be placed in double
2215 quotes, and there should be a
2216 trailing slash (@samp{/}).  See the example in @ref{Getting Started}.
2218 @vindex @code{mh-do-not-confirm}
2220 If you never make mistakes, and you do not like confirmations for your
2221 actions, you can set @code{mh-do-not-confirm} to a non-@code{nil} value to
2222 disable confirmation for unrecoverable commands such as @kbd{M-k}
2223 (@code{mh-kill-folder}) and @kbd{M-u} (@code{mh-undo-folder}).  Here's
2224 how you set boolean values:
2226 @lisp
2227 (setq mh-do-not-confirm t)
2228 @end lisp
2230 @vindex @code{mh-summary-height}
2231 @cindex MH-Folder mode
2232 @cindex modes, MH-Folder
2234 @c Prevent page break between paragraph and example.
2235 @need 2000
2236 The variable @code{mh-summary-height} controls the number of scan lines
2237 displayed in the MH-Folder window, including the mode line.  The
2238 default value of 4 means that 3 scan lines are displayed.  Here's how
2239 you set numerical values:
2241 @lisp
2242 (setq mh-summary-height 2)              ; @r{only show the current scan line}
2243 @end lisp
2245 @vindex @code{mh-bury-show-buffer}
2246 @cindex MH-Folder mode
2247 @cindex modes, MH-Folder
2249 Normally the buffer for displaying messages is buried at the bottom at
2250 the buffer stack.  You may wish to disable this feature by setting
2251 @code{mh-bury-show-buffer} to @code{nil}.  One advantage of not burying the
2252 show buffer is that one can delete the show buffer more easily in an
2253 electric buffer list because of its proximity to its associated
2254 MH-Folder buffer.  Try running @kbd{M-x electric-buffer-list} to
2255 see what I mean.
2257 @vindex @code{mh-folder-mode-hook}
2258 @cindex MH-Folder mode
2259 @cindex modes, MH-Folder
2261 The hook @code{mh-folder-mode-hook} is called when a new folder is
2262 created with MH-Folder mode.  This could be used to set your own
2263 key bindings, for example:
2265 @vindex @code{mh-folder-mode-hook}, example
2267 @lisp
2268 @group
2269 @i{Create additional key bindings via mh-folder-mode-hook}
2271 (defvar my-mh-init-done nil "Non-@code{nil} when one-time mh-e settings made.")
2273 (defun my-mh-folder-mode-hook ()
2274   "Hook to set key bindings in MH-Folder mode."
2275   (if (not my-mh-init-done)             ; @r{only need to bind the keys once }
2276       (progn
2277         (local-set-key "/" 'search-msg)
2278         (local-set-key "b" 'mh-burst-digest)    ; @r{better use of @kbd{b}}
2279         (setq my-mh-init-done t))))
2281 ;;; @r{Emacs 19}
2282 (add-hook 'mh-folder-mode-hook 'my-mh-folder-mode-hook)
2283 ;;; @r{Emacs 18}
2284 ;;;   @r{(setq mh-folder-mode-hook (cons 'my-mh-folder-mode-hook}
2285 ;;;                               @r{mh-folder-mode-hook))}
2287 (defun search-msg ()
2288   "Search for a regexp in the current message."
2289   (interactive)                         ; @r{user function}
2290   (save-window-excursion
2291     (other-window 1)                    ; @r{go to next window}
2292     (isearch-forward-regexp)))          ; @r{string search; hit return (ESC}
2293                                         ;   @r{in Emacs 18) when done}
2294 @end group
2295 @end lisp
2297 @menu
2298 * Customizing Viewing::         
2299 * Customizing Moving Around::   
2300 @end menu
2302 @node Customizing Viewing, Customizing Moving Around, Customizing Reading, Customizing Reading
2303 @subsection Viewing Your Mail
2305 @vindex @code{mh-clean-message-header}
2306 @vindex @code{mh-invisible-headers}
2307 @vindex @code{mh-visible-headers}
2309 Several variables control what displayed messages look like.  Normally
2310 messages are delivered with a handful of uninteresting header fields.
2311 You can make them go away by setting @code{mh-clean-message-header} to a
2312 non-@code{nil} value.  The header can then be cleaned up in two ways.  By
2313 default, the header fields in @code{mh-invisible-headers} are removed.
2314 On the other hand, you could set @code{mh-visible-headers} to the fields
2315 that you would like to see.  If this variable is set,
2316 @code{mh-invisible-headers} is ignored.  I suggest that you not set
2317 @code{mh-visible-headers} since if you use this variable, you might miss
2318 a lot of header fields that you'd rather not miss.  As an example of how
2319 to set a string variable, @code{mh-visible-headers} can be set to show a
2320 minimum set of header fields (see (@ref{Regexps, , Syntax of Regular
2321 Expressions, emacs, The GNU Emacs Manual}, for a description of the
2322 special characters in this string):
2324 @lisp
2325 (setq mh-visible-headers "^From: \\|^Subject: \\|^Date: ")
2326 @end lisp
2328 @cindex @code{mhl}
2329 @cindex MH commands, @code{mhl}
2330 @vindex @code{mhl-formfile}
2332 Normally mh-e takes care of displaying messages itself (rather than
2333 calling an MH program to do the work).  If you'd rather have @code{mhl}
2334 display the message (within mh-e), set the variable @code{mhl-formfile}
2335 to a non-@code{nil} value.  You can set this variable either to @code{t}
2336 to use the default format file or to a filename if you have your own
2337 format file (@code{mhl}(1) tells you how to write one).  When writing
2338 your own format file, use a nonzero value for @code{overflowoffset} to
2339 ensure the header is RFC 822 compliant and parsable by mh-e.
2340 @code{mhl} is always used for printing and forwarding; in this case, the
2341 value of @code{mhl-formfile} is consulted if it is a filename.
2343 @vindex @code{mh-show-mode-hook}
2345 Two hooks can be used to control how messages are displayed.  The first
2346 hook, @code{mh-show-mode-hook}, is called early on in the process of
2347 displaying of messages.  It is used to perform some actions on the
2348 contents of messages, such as highlighting the header fields.  If you're
2349 running Emacs 19 under the X Window System, the following example will
2350 highlight the @samp{From:} and @samp{Subject:} header fields.  This is a
2351 very nice feature indeed.
2353 @vindex @code{mh-show-mode-hook}, example
2355 @lisp
2356 @group
2357 @i{Emphasize header fields in different fonts via mh-show-mode-hook}
2359 (defvar my-mh-keywords
2360    '(("^From: \\(.*\\)" 1 'bold t)
2361      ("^Subject: \\(.*\\)" 1 'highlight t))
2362   "mh-e additions for font-lock-keywords.")
2364 (defun my-mh-show-mode-hook ()
2365   "Hook to turn on and customize fonts."
2366   (font-lock-add-keywords nil my-mh-keywords))
2368 (add-hook 'mh-show-mode-hook 'my-mh-show-mode-hook))
2369 @end group
2370 @end lisp
2372 @vindex @code{mh-show-hook}
2374 The second hook, @code{mh-show-hook}, is the last thing called after
2375 messages are displayed.  It's used to affect the behavior of mh-e in
2376 general or when @code{mh-show-mode-hook} is too early.  For example, if
2377 you wanted to keep mh-e in sync with MH, you could use
2378 @code{mh-show-hook} as follows:
2380 @vindex @code{mh-show-hook}, example
2382 @lisp
2383 (add-hook 'mh-show-hook 'mh-update-sequences)
2384 @end lisp
2386 @vindex @code{mh-show-buffer-mode-line-buffer-id}
2387 @cindex MH-Show mode
2388 @cindex modes, MH-Show
2390 The function @code{mh-update-sequences} is documented in @ref{Finishing
2391 Up}.  For those who like to modify their mode lines, use
2392 @code{mh-show-buffer-mode-line-buffer-id} to modify the mode line in the
2393 MH-Show buffers.  Place the two escape strings @samp{%s} and @samp{%d},
2394 which will display the folder name and the message number, respectively,
2395 somewhere in the string in that order.  The default value of
2396 @samp{"@{show-%s@} %d"} yields a mode line of
2398 @example
2399 -----@{show-+inbox@} 4      (MH-Show)--Bot----------------------------------
2400 @end example
2402 @node Customizing Moving Around,  , Customizing Viewing, Customizing Reading
2403 @subsection Moving Around
2405 @cindex moving between messages
2406 @cindex MH-Show mode
2407 @cindex modes, MH-Show
2408 @cindex MH-Folder mode
2409 @cindex modes, MH-Folder
2410 @vindex @code{mh-recenter-summary-p}
2412 When you use @kbd{t} (@code{mh-toggle-showing}) to toggle between show
2413 mode and scan mode, the MH-Show buffer is hidden and the
2414 MH-Folder buffer is left alone.  Setting
2415 @code{mh-recenter-summary-p} to a non-@code{nil} value causes the toggle to
2416 display as many scan lines as possible, with the cursor at the middle.
2417 The effect of @code{mh-recenter-summary-p} is rather useful, but it can
2418 be annoying on a slow network connection.
2420 @node Customizing Sending, Customizing Draft Editing, Customizing Reading, Customizing mh-e
2421 @section Sending Mail
2423 @cindex sending mail
2425 You may wish to start off by adding the following useful key bindings to
2426 your @file{.emacs} file:
2428 @lisp
2429 (global-set-key "\C-xm" 'mh-smail)
2430 (global-set-key "\C-x4m" 'mh-smail-other-window)
2431 @end lisp
2433 In addition, several variables are useful when sending mail or replying
2434 to mail.  They are summarized in the following table.
2436 @table @code
2437 @item mh-comp-formfile
2438 Format file for drafts (default: @samp{"components"}).
2440 @item mh-repl-formfile
2441 Format file for replies (default: @samp{"replcomps"}).
2443 @item mh-letter-mode-hook
2444 Functions to run in MH-Letter mode (default: @code{nil}).
2446 @item mh-compose-letter-function
2447 Functions to run when starting a new draft (default: @code{nil}).
2449 @item mh-reply-default-reply-to
2450 Whom reply goes to (default: @code{nil}).
2452 @item mh-forward-subject-format
2453 Format string for forwarded message subject (default: @samp{"%s: %s"}).
2455 @item mh-redist-full-contents
2456 @code{send} requires entire message (default: @code{nil}).
2458 @item mh-new-draft-cleaned-headers
2459 Remove these header fields from re-edited draft (default:
2460 @samp{"^Date:\\| ^Received:\\| ^Message-Id:\\| ^From:\\| ^Sender:\\|
2461 ^Delivery-Date:\\| ^Return-Path:"}).
2462 @end table
2464 @cindex @code{comp}
2465 @cindex MH commands, @code{comp}
2466 @vindex @code{mh-comp-formfile}
2467 @cindex @file{components}
2468 @cindex files, @file{components}
2469 @cindex @code{repl}
2470 @cindex MH commands, @code{repl}
2471 @cindex @file{replcomps}
2472 @cindex files, @file{replcomps}
2473 @vindex @code{mh-repl-formfile}
2475 Since mh-e does not use @code{comp} to create the initial draft, you
2476 need to set @code{mh-comp-formfile} to the name of your components file
2477 if it isn't @file{components}.  This is the name of the file that
2478 contains the form for composing messages.  If it does not contain an
2479 absolute pathname, mh-e searches for the file first in your MH directory
2480 and then in the system MH library directory (such as
2481 @file{/usr/local/lib/mh}).  Replies, on the other hand, are built using
2482 @code{repl}.  You can change the location of the field file from the
2483 default of @file{replcomps} by modifying @code{mh-repl-formfile}.
2485 @vindex @code{mh-letter-mode-hook}
2486 @cindex @code{repl}
2487 @cindex MH commands, @code{repl}
2488 @cindex @file{components}
2489 @cindex files, @file{components}
2491 Two hooks are provided to run commands on your freshly created draft.
2492 The first hook, @code{mh-letter-mode-hook}, allows you to do some
2493 processing before editing a letter.  For example, you may wish to modify
2494 the header after @code{repl} has done its work, or you may have a
2495 complicated @file{components} file and need to tell mh-e where the
2496 cursor should go.  Here's an example of how you would use this hook---all
2497 of the other hooks are set in this fashion as well.
2499 @findex @code{mh-insert-signature}, example
2501 @lisp
2502 @group
2503 @i{Prepare draft for editing via mh-letter-mode-hook}
2505 (defvar letter-mode-init-done nil
2506   "Non-@code{nil} when one-time mh-e settings have made.")
2508 (defun my-mh-letter-mode-hook ()
2509   "Hook to prepare letter for editing."
2510   (if (not letter-mode-init-done)    ; @r{only need to bind the keys once}
2511       (progn
2512         (local-set-key "\C-ctb" 'add-enriched-text)
2513         (local-set-key "\C-cti" 'add-enriched-text)
2514         (local-set-key "\C-ctf" 'add-enriched-text)
2515         (local-set-key "\C-cts" 'add-enriched-text)
2516         (local-set-key "\C-ctB" 'add-enriched-text)
2517         (local-set-key "\C-ctu" 'add-enriched-text)
2518         (local-set-key "\C-ctc" 'add-enriched-text)
2519         (setq letter-mode-init-done t)))
2520   (setq fill-prefix "  ")            ; @r{I find indented text easier to read}
2521   (save-excursion
2522     (goto-char (point-max))          ; @r{go to end of message to}
2523     (mh-insert-signature)))          ;   @r{insert signature}
2525 (add-hook 'mh-letter-mode-hook 'my-mh-letter-mode-hook)
2526 @end group
2527 @end lisp
2529 The function, @code{add-enriched-text} is defined in the example in
2530 @ref{Customizing Editing MIME}.
2532 @vindex @code{mh-compose-letter-function}
2534 The second hook, a function really, is
2535 @code{mh-compose-letter-function}.  Like @code{mh-letter-mode-hook}, it
2536 is called just before editing a new message; however, it is the last
2537 function called before you edit your message.  The consequence of this
2538 is that you can write a function to write and send the message for you.
2539 This function is passed three arguments: the contents of the @samp{To:},
2540 @samp{Subject:}, and @samp{cc:} header fields.
2542 @menu
2543 * Customizing Replying::        
2544 * Customizing Forwarding::      
2545 * Customizing Redistributing::  
2546 * Customizing Old Drafts::      
2547 @end menu
2549 @node Customizing Replying, Customizing Forwarding, Customizing Sending, Customizing Sending
2550 @subsection Replying to Mail
2552 @cindex replying
2553 @vindex @code{mh-reply-default-reply-to}
2555 If you find that most of the time that you specify @kbd{cc} when you
2556 reply to a message, set @code{mh-reply-default-reply-to} to @samp{cc}.
2557 This variable is normally set to @code{nil} so that you are prompted for
2558 the recipient of a reply.  It can be set to one of @samp{from},
2559 @samp{to}, or @samp{cc}; you are then no longer prompted for the
2560 recipient(s) of your reply.
2562 @node Customizing Forwarding, Customizing Redistributing, Customizing Replying, Customizing Sending
2563 @subsection Forwarding Mail
2565 @cindex forwarding
2566 @vindex @code{mh-forward-subject-format}
2568 When forwarding a message, the format of the @samp{Subject:} header
2569 field can be modified by the variable @code{mh-forward-subject-format}.
2570 This variable is a string which includes two escapes (@samp{%s}).  The
2571 first @samp{%s} is replaced with the sender of the original message, and
2572 the second one is replaced with the original @samp{Subject:}.  The
2573 default value of @samp{"%s: %s"} takes a message with the header:
2575 @example
2576 @group
2577 To: Bill Wohler <wohler@@newt.com>
2578 Subject: Re: 49er football
2579 From: Greg DesBrisay <gd@@cellnet.com>
2580 @end group
2581 @end example
2583 and creates a subject header field of:
2585 @example
2586 Subject: Greg DesBrisay: Re: 49er football
2587 @end example
2589 @node Customizing Redistributing, Customizing Old Drafts, Customizing Forwarding, Customizing Sending
2590 @subsection Redistributing Your Mail
2592 @cindex redistributing
2593 @vindex @code{mh-redist-full-contents}
2594 @cindex @code{dist}
2595 @cindex MH commands, @code{dist}
2596 @cindex @code{send}
2597 @cindex MH commands, @code{send}
2599 The variable @code{mh-redist-full-contents} must be set to non-@code{nil} if
2600 @code{dist} requires the whole letter for redistribution, which is the
2601 case if @code{send} is compiled with the @sc{berk} @footnote{To see which
2602 options your copy of MH was compiled with, use @kbd{M-x mh-version}
2603 (@ref{Miscellaneous}).}  option (which many people abhor).  If you find
2604 that MH will not allow you to redistribute a message that has been
2605 redistributed before, this variable should be set to @code{nil}.
2607 @node Customizing Old Drafts,  , Customizing Redistributing, Customizing Sending
2608 @subsection Editing Old Drafts and Bounced Messages
2610 @cindex re-editing drafts
2611 @vindex @code{mh-new-draft-cleaned-headers}
2613 The header fields specified by @code{mh-new-draft-cleaned-headers} are
2614 removed from an old draft that has been recreated with @kbd{M-e}
2615 (@code{mh-extract-rejected-mail}) or @kbd{M-a} (@code{mh-edit-again}).
2616 If when you edit an old draft with these commands you find that there
2617 are header fields that you don't want included, you can append them to
2618 this variable.  For example,
2620 @vindex @code{mh-new-draft-cleaned-headers}, example
2622 @lisp
2623 (setq mh-new-draft-cleaned-headers
2624       (concat mh-new-draft-cleaned-headers "\\|^Some-Field:"))
2625 @end lisp
2627 @cindex regular expressions
2629 This appends the regular expression @samp{\\|^Some-Field:} to the
2630 variable (@pxref{Regexps, , Syntax of Regular Expressions, emacs, The
2631 GNU Emacs Manual}).  The @samp{\\|} means @emph{or}, and the @samp{^}
2632 (caret) matches the beginning of the line.  This is done to be very
2633 specific about which fields match.  The literal @samp{:} is appended for
2634 the same reason.
2636 @node Customizing Draft Editing, Customizing Moving Mail, Customizing Sending, Customizing mh-e
2637 @section Editing a Draft
2639 @cindex editing draft
2641 There are several variables used during the draft editing phase.
2642 Examples include changing the name of the file that holds your signature
2643 or telling mh-e about new multimedia types.  They are:
2645 @table @code
2646 @item mh-yank-from-start-of-msg
2647 How to yank when region not set (default: @code{t}).
2649 @item mh-ins-buf-prefix
2650 Indent for yanked messages (default: @samp{"> "}).
2652 @item mail-citation-hook
2653 Functions to run on yanked messages (default: @code{nil}).
2655 @item mh-delete-yanked-msg-window
2656 Delete message window on yank (default: @code{nil}).
2658 @c Need the @* because otherwise TeX fills it wrong and complains
2659 @c about overfull hbox.
2660 @item mh-mime-content-types
2661 List of valid content types (default: @samp{'(("text/plain")@*
2662 ("text/richtext") ("multipart/mixed") ("multipart/alternative")@*
2663 ("multipart/digest") ("multipart/parallel") ("message/rfc822")@*
2664 ("message/partial") ("message/external-body")@*
2665 ("application/octet-stream") ("application/postscript")@*
2666 ("image/jpeg") ("image/gif") ("audio/basic") ("video/mpeg"))}).
2668 @item mh-mhn-args
2669 Additional arguments for @code{mhn} (default: @code{nil}).
2671 @item mh-signature-file-name
2672 File containing signature (default: @samp{"~/.signature"}).
2674 @item mh-before-send-letter-hook
2675 Functions to run before sending draft (default: @code{nil}).
2677 @item mh-send-prog
2678 MH program used to send messages (default: @samp{"send"}).
2679 @end table
2681 @menu
2682 * Customizing Editing Textual::  
2683 * Customizing Editing MIME::    
2684 * Customizing Sending Message::  
2685 @end menu
2687 @node Customizing Editing Textual, Customizing Editing MIME, Customizing Draft Editing, Customizing Draft Editing
2688 @subsection Editing Textual Messages
2690 The following two sections include variables that customize the way you
2691 edit a draft.  The discussion here applies to editing multimedia
2692 messages as well.
2694 @menu
2695 * Customizing Inserting Letter::  
2696 * Customizing Signature::       
2697 @end menu
2699 @node Customizing Inserting Letter, Customizing Signature, Customizing Editing Textual, Customizing Editing Textual
2700 @subsubsection Inserting letter to which you're replying
2702 @cindex inserting messages
2703 @vindex @code{mh-yank-from-start-of-msg}
2704 @vindex @code{mh-ins-buf-prefix}
2705 @vindex @code{mail-citation-hook}
2706 @vindex @code{mh-ins-buf-prefix}
2707 @vindex @code{mh-delete-yanked-msg-window}
2709 To control how much of the message to which you are replying is yanked
2710 by @kbd{C-c C-y} (@code{mh-yank-cur-msg}) into your reply, modify
2711 @code{mh-yank-from-start-of-msg}.  The default value of @code{t} means
2712 that the entire message is copied.  If it is set to @code{'body} (don't
2713 forget the apostrophe), then only the message body is copied.  If it is
2714 set to @code{nil}, only the part of the message following point (the
2715 current cursor position in the message's buffer) is copied.  In any
2716 case, this variable is ignored if a region is set in the message you are
2717 replying to.  The string contained in @code{mh-ins-buf-prefix} is
2718 inserted before each line of a message that is inserted into a draft
2719 with @kbd{C-c C-y} (@code{mh-yank-cur-msg}).  I suggest that you not
2720 modify this variable.  The default value of @samp{"> "} is the default
2721 string for many mailers and news readers: messages are far easier to
2722 read if several included messages have all been indented by the same
2723 string.  The variable @code{mail-citation-hook} is @code{nil} by
2724 default, which means that when a message is inserted into the letter,
2725 each line is prefixed by @code{mh-ins-buf-prefix}.  Otherwise, it can be
2726 set to a function that modifies an included
2727 @cindex Emacs, packages, supercite
2728 citation. 
2729 @c Footnotes are fragile; hence the redundancy.
2730 @c TeX not inserting a line break; hence the @*
2731 @ifclear html
2732 @footnote{@emph{Supercite} is an example of a full-bodied, full-featured
2733 citation package.  It is in Emacs versions 19.15 and later, and can be
2734 found via anonymous @code{ftp} on @samp{archive.cis.ohio-state.edu} in
2735 @* @file{/pub/gnu/emacs/elisp-archive/packages/sc3.1.tar.Z}}
2736 @end ifclear
2737 @ifset html
2738 @footnote{@emph{Supercite} is an example of a full-bodied,
2739 full-featured citation package.  It is in Emacs versions 19.15 and
2740 later, and its @sc{url} is @*
2741 @file{<A HREF="ftp://archive.cis.ohio-state.edu/pub/gnu/emacs/elisp-archive/packages/sc3.1.tar.Z">ftp://archive.cis.ohio-state.edu/pub/gnu/emacs/elisp-archive/packages/sc3.1.tar.Z</A>}}
2742 @end ifset
2743 If you like to yank all the text from the message you're replying to in
2744 one go, set @code{mh-delete-yanked-msg-window} to non-@code{nil} to delete
2745 the window containing the original message after yanking it to make more
2746 room on your screen for your reply.
2748 @node Customizing Signature,  , Customizing Inserting Letter, Customizing Editing Textual
2749 @subsubsection Inserting your signature
2751 @cindex inserting signature
2752 @cindex signature
2753 @vindex @code{mh-signature-file-name}
2754 @cindex @file{.signature}
2755 @cindex files, @file{.signature}
2757 You can change the name of the file inserted with @kbd{C-c C-s}
2758 (@code{mh-insert-signature}) by changing @code{mh-signature-file-name}
2759 (default: @file{"~/.signature"}).
2761 @node Customizing Editing MIME, Customizing Sending Message, Customizing Editing Textual, Customizing Draft Editing
2762 @subsection Editing Multimedia Messages
2764 @cindex MIME
2765 @cindex multimedia mail
2766 @vindex @code{mh-mime-content-types}
2768 The variable @code{mh-mime-content-types} contains a list of the
2769 currently valid content types.  They are listed in the table in
2770 @ref{Customizing Draft Editing}.  If you encounter a new content type,
2771 you can add it like this:
2773 @vindex @code{mh-mime-content-types}, example
2775 @lisp
2776 (setq mh-mime-content-types (append mh-mime-content-types
2777                                     '(("@var{new/type}"))))
2778 @end lisp
2780 Emacs macros can be used to insert enriched text directives like
2781 @samp{<bold>}.  The following code will make, for example, @kbd{C-c t
2782 b} insert the @samp{<bold>} directive.
2784 @lisp
2785 @group
2786 @i{Emacs macros for entering enriched text}
2788 (defvar enriched-text-types '(("b" . "bold") ("i" . "italic") ("f" . "fixed")
2789                               ("s" . "smaller") ("B" . "bigger")
2790                               ("u" . "underline") ("c" . "center"))
2791   "Alist of (final-character . directive) choices for add-enriched-text.
2792 Additional types can be found in RFC 1563.")
2794 (defun add-enriched-text (begin end)
2795   "Add enriched text directives around region.
2796 The directive used comes from the list enriched-text-types and is
2797 specified by the last keystroke of the command.  When called from Lisp,
2798 arguments are BEGIN and END@."
2799   (interactive "r")
2800   ;; @r{Set type to the directive indicated by the last keystroke.}
2801   (let ((type (cdr (assoc (char-to-string (logior last-input-char ?@w{`}))
2802                           enriched-text-types))))
2803     (save-restriction              ; @r{restores state from narrow-to-region}
2804       (narrow-to-region begin end) ; @r{narrow view to region}
2805       (goto-char (point-min))      ; @r{move to beginning of text}
2806       (insert "<" type ">")        ; @r{insert beginning directive}
2807       (goto-char (point-max))      ; @r{move to end of text}
2808       (insert "</" type ">"))))    ; @r{insert terminating directive}
2809 @end group
2810 @end lisp
2812 To use the function @code{add-enriched-text}, first create keybindings
2813 for it (@pxref{Customizing Sending}).  Then, set the mark with
2814 @kbd{C-@@} or @kbd{C-SPC}, type in the text to be highlighted, and type
2815 @kbd{C-c t b}.  This adds @samp{<bold>} where you set the mark and
2816 adds @samp{</bold>} at the location of your cursor, giving you something
2817 like: @samp{You should be <bold>very</bold>}.  You may also be
2818 interested in investigating @code{sgml-mode}.
2820 @menu
2821 * Customizing Sending MIME::    
2822 @end menu
2824 @node Customizing Sending MIME,  , Customizing Editing MIME, Customizing Editing MIME
2825 @subsubsection Readying multimedia messages for sending
2827 @vindex @code{mh-mhn-args}
2829 If you wish to pass additional arguments to @code{mhn} to affect how it
2830 builds your message, use the variable @code{mh-mhn-args}.  For example,
2831 you can build a consistency check into the message by setting
2832 @code{mh-mhn-args} to @code{-check}.  The recipient of your message can
2833 then run @code{mhn -check} on the message---@code{mhn} will complain if
2834 the message has been corrupted on the way.  The @kbd{C-c C-e}
2835 (@code{mh-mhn-edit}) command only consults this variable when given a
2836 prefix argument.
2838 @node Customizing Sending Message,  , Customizing Editing MIME, Customizing Draft Editing
2839 @subsection Sending a Message
2841 @cindex sending mail
2842 @cindex spell check
2843 @vindex @code{mh-before-send-letter-hook}
2845 If you want to check your spelling in your message before sending, use
2846 @code{mh-before-send-letter-hook} like this:
2848 @i{Spell-check message via mh-before-send-letter-hook}
2850 @vindex @code{mh-before-send-letter-hook}, example
2852 @lisp
2853 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2854 @end lisp
2856 @cindex @code{send}
2857 @cindex MH commands, @code{send}
2858 @vindex @code{mh-send-prog}
2860 In case the MH @code{send} program is installed under a different name,
2861 use @code{mh-send-prog} to tell mh-e the name.
2863 @node Customizing Moving Mail, Customizing Searching, Customizing Draft Editing, Customizing mh-e
2864 @section Moving Your Mail Around
2866 @cindex processing mail
2868 If you change the name of some of the MH programs or have your own
2869 printing programs, the following variables can help you.
2870 They are described in detail in the subsequent sections.
2872 @table @code
2873 @item mh-inc-prog
2874 Program to incorporate mail (default: @samp{"inc"}).
2876 @item mh-inc-folder-hook
2877 Functions to run when incorporating mail (default: @code{nil}).
2879 @item mh-delete-msg-hook
2880 Functions to run when deleting messages (default: @code{nil}).
2882 @item mh-print-background
2883 Print in foreground or background (default: @code{nil}).
2885 @item mh-lpr-command-format
2886 Command used to print (default: @samp{"lpr -J '%s'"}).
2888 @item mh-default-folder-for-message-function
2889 Function to generate a default folder (default: @code{nil}).
2891 @item mh-auto-folder-collect
2892 Collect folder names in background at startup (default: @code{t}).
2894 @item mh-recursive-folders
2895 Collect nested folders (default: @code{nil}).
2897 @item mh-refile-msg-hook
2898 Functions to run when refiling message (default: @code{nil}).
2900 @item mh-store-default-directory
2901 Default directory for storing files created by @code{uuencode} or @code{shar}
2902 (default: @code{nil}).
2904 @item mh-sortm-args
2905 Additional arguments for @code{sortm} (default: @code{nil}).
2907 @item mh-scan-prog
2908 Program to scan messages (default: @samp{"scan"}).
2910 @item mh-before-quit-hook
2911 Functions to run before quitting (default: @code{nil}).  See also
2912 @code{mh-quit-hook}. 
2914 @item mh-quit-hook
2915 Functions to run after quitting (default: @code{nil}). See also
2916 @code{mh-before-quit-hook}.
2917 @end table
2919 @menu
2920 * Customizing Incorporating::   
2921 * Customizing Deleting::        
2922 * Customizing Organizing::      
2923 * Customizing Printing::        
2924 * Customizing Files and Pipes::  
2925 * Customizing Finishing Up::    
2926 @end menu
2928 @node Customizing Incorporating, Customizing Deleting, Customizing Moving Mail, Customizing Moving Mail
2929 @subsection Incorporating Your Mail
2931 @cindex incorporating
2932 @vindex @code{mh-inc-prog}
2933 @cindex @code{inc}
2934 @cindex MH commands, @code{inc}
2935 @vindex @code{mh-progs}
2936 @vindex @code{mh-scan-prog}
2937 @vindex @code{mh-inc-folder-hook}
2939 The name of the program that incorporates new mail is stored in
2940 @code{mh-inc-prog}; it is @samp{"inc"} by default.  This program
2941 generates a one-line summary for each of the new messages.  Unless it is
2942 an absolute pathname, the file is assumed to be in the @code{mh-progs}
2943 directory.  You may also link a file to @code{inc} that uses a different
2944 format (see @code{mh-profile}(5)).  You'll then need to modify several
2945 variables appropriately; see @code{mh-scan-prog} below.  You can set the
2946 hook @code{mh-inc-folder-hook}, which is called after new mail is
2947 incorporated by the @kbd{i} (@code{mh-inc-folder}) command.  A good use
2948 of this hook is to rescan the whole folder either after running @kbd{M-x
2949 mh-rmail} the first time or when you've changed the message numbers from
2950 outside of mh-e.
2952 @findex @code{mh-execute-commands}
2953 @findex @code{mh-rescan-folder}, example
2954 @findex @code{mh-show}, example
2955 @vindex @code{mh-inc-folder-hook}, example
2957 @lisp
2958 @group
2959 @i{Rescan folder after incorporating new mail via mh-inc-folder-hook}
2961 (defun my-mh-inc-folder-hook ()
2962   "Hook to rescan folder after incorporating mail."
2963   (if (buffer-modified-p)            ; @r{if outstanding refiles and deletes,}
2964       (mh-execute-commands))         ;   @r{carry them out}
2965   (mh-rescan-folder)                 ; @r{synchronize with +inbox}
2966   (mh-show))                         ; @r{show the current message}
2968 (add-hook 'mh-inc-folder-hook 'my-mh-inc-folder-hook)
2969 @end group
2970 @end lisp
2972 @node Customizing Deleting, Customizing Organizing, Customizing Incorporating, Customizing Moving Mail
2973 @subsection Deleting Your Mail
2975 @cindex deleting
2976 @vindex @code{mh-delete-msg-hook}
2978 The hook @code{mh-delete-msg-hook} is called after you mark a message
2979 for deletion.  For example, the current maintainer of mh-e used this
2980 once when he kept statistics on his mail usage.
2982 @node Customizing Organizing, Customizing Printing, Customizing Deleting, Customizing Moving Mail
2983 @subsection Organizing Your Mail with Folders
2985 @cindex using folders
2986 @vindex @code{mh-recursive-folders}
2987 @vindex @code{mh-auto-folder-collect}
2989 By default, operations on folders work only one level at a time.  Set
2990 @code{mh-recursive-folders} to non-@code{nil} to operate on all folders.
2991 This mostly means that you'll be able to see all your folders when you
2992 press @key{TAB} when prompted for a folder name.  The variable
2993 @code{mh-auto-folder-collect} is normally turned on to generate a list
2994 of folder names in the background as soon as mh-e is loaded.  Otherwise,
2995 the list is generated when you need a folder name the first time (as
2996 with @kbd{o} (@code{mh-refile-msg})).  If you have a lot of folders and
2997 you have @code{mh-recursive-folders} set, this could take a while, which
2998 is why it's nice to do the folder collection in the background.
3000 @vindex @code{mh-default-folder-for-message-function}
3001 @findex @code{mh-refile-msg}
3002 @findex @code{mh-to-fcc}
3003 @cindex @file{.emacs}
3004 @cindex files, @file{.emacs}
3006 The function @code{mh-default-folder-for-message-function} is used by
3007 @kbd{o} (@code{mh-refile-msg}) and @kbd{C-c C-f C-f} (@code{mh-to-fcc})
3008 to generate a default folder.  The generated folder name should be a
3009 string with a @samp{+} before it.  For each of my correspondents, I use the
3010 same name for both an alias and a folder.  So, I wrote a function that
3011 takes the address in the @samp{From:} header field, finds it in my alias
3012 file, and returns the alias, which is used as a default folder name.
3013 This is the most complicated example given here, and it demonstrates
3014 several features of Emacs Lisp programming.  You should be able to drop
3015 this into @file{~/.emacs}, however.  If you use this to store messages
3016 in a subfolder of your Mail directory, you can modify the line that
3017 starts @samp{(format +%s...}  and insert your subfolder after the folder
3018 symbol @samp{+}.
3019 @c Note for me: if I insert a new version, don't forget to remove the
3020 @c "a/" from the folder name.
3022 @iftex
3023 @filbreak
3024 @end iftex
3026 @vindex @code{mh-default-folder-for-message-function}, example
3027 @vindex @code{mh-user-path}, example
3029 @lisp
3030 @group
3031 @i{Creating useful default folder for refiling via mh-default-folder-for-message-function}
3033 (defun my-mh-folder-from-address ()
3034   "Determine folder name from address.
3035 Takes the address in the From: header field, and returns its corresponding
3036 alias from the user's personal aliases file. Returns @code{nil} if the address
3037 was not found."
3038   (require 'rfc822)                         ; @r{for the rfc822 functions}
3039   (search-forward-regexp "^From: \\(.*\\)") ; @r{grab header field contents}
3040   (save-excursion                     ; @r{save state}
3041     (let ((addr (car (rfc822-addresses  ; @r{get address}
3042                       (buffer-substring (match-beginning 1)
3043                                         (match-end 1)))))
3044           (buffer (get-buffer-create " *temp*")) ; @r{set local variables}
3045           folder)
3046       (set-buffer buffer)             ; @r{jump to temporary buffer}
3047       (unwind-protect                 ; @r{run kill-buffer when done}
3048           (progn                      ; @r{function grouping construct}
3049             (insert-file-contents (expand-file-name "aliases"
3050                                                     mh-user-path))
3051             (goto-char (point-min))   ; @r{grab aliases file and go to start}
3052             (setq folder
3053                   ;; @r{Search for the given address, even commented-out}
3054                   ;; @r{addresses are found!}
3055                   ;; @r{The function search-forward-regexp sets values that are}
3056                   ;; @r{later used by match-beginning and match-end.}
3057                   (if (search-forward-regexp (format "^;*\\(.*\\):.*%s"
3058                                                      addr) nil t)
3059                       ;; @r{NOTE WELL: this is what the return value looks like.}
3060                       ;; @r{You can modify the format string to match your own}
3061                       ;; @r{Mail hierarchy.}
3062                       (format "+%s" (buffer-substring (match-beginning 1)
3063                                                       (match-end 1))))))
3064         (kill-buffer buffer))          ; @r{get rid of our temporary buffer}
3065       folder)))                        ; @r{function's return value}
3067 (setq mh-default-folder-for-message-function 'my-mh-folder-from-address)
3068 @end group
3069 @end lisp
3071 @vindex @code{mh-refile-msg-hook}
3073 The hook @code{mh-refile-msg-hook} is called after a message is marked
3074 to be refiled.
3076 @vindex @code{mh-sortm-args}
3077 @cindex @code{sortm}
3078 @cindex MH commands, @code{sortm}
3079 @findex @code{mh-sort-folder}
3080 @cindex MH profile components, @code{sortm}
3081 @cindex @file{.mh_profile}
3082 @cindex files, @file{.mh_profile}
3084 The variable @code{mh-sortm-args} holds extra arguments to pass on to
3085 the @code{sortm} command.  Note: this variable is only consulted when a
3086 prefix argument is given to @kbd{M-x mh-sort-folder}.  It is used to
3087 override any arguments given in a @code{sortm:} entry in your MH profile
3088 (@file{~/.mh_profile}).
3090 @menu
3091 * Customizing Scan Line Formats::  
3092 @end menu
3094 @node Customizing Scan Line Formats,  , Customizing Organizing, Customizing Organizing
3095 @subsubsection Scan line formatting
3097 @vindex @code{mh-scan-prog}
3098 @cindex @code{scan}
3099 @cindex MH commands, @code{scan}
3100 @vindex @code{mh-progs}
3102 The name of the program that generates a listing of one line per message
3103 is held in @code{mh-scan-prog} (default: @samp{"scan"}).  Unless this
3104 variable contains an absolute pathname, it is assumed to be in the
3105 @code{mh-progs} directory.  You may link another program to @code{scan}
3106 (see @code{mh-profile}(5)) to produce a different type of listing.
3108 If you change the format of the scan lines you'll need to tell mh-e how
3109 to parse the new format.  As you see, quite a lot of variables are
3110 involved to do that.  The first variable has to do with pruning out
3111 garbage.
3113 @table @code
3114 @item mh-valid-scan-line
3115 @vindex @code{mh-valid-scan-line}
3116 @cindex @code{inc}
3117 @cindex MH commands, @code{inc}
3118 @cindex @code{scan}
3119 @cindex MH commands, @code{scan}
3120 This regular expression describes a valid scan line.  This is used to
3121 eliminate error messages that are occasionally produced by @code{inc} or
3122 @code{scan} (default: @samp{"^ *[0-9]"}).
3123 @end table
3125 Next, two variables control how the message numbers are parsed.
3127 @table @code
3129 @item mh-msg-number-regexp
3130 @vindex @code{mh-msg-number-regexp}
3131 This regular expression is used to extract the message number from a
3132 scan line.  Note that the message number must be placed in quoted
3133 parentheses, (\\(...\\)), as in the default of @w{@samp{"^
3134 *\\([0-9]+\\)"}}.
3136 @item mh-msg-search-regexp
3137 @vindex @code{mh-msg-search-regexp}
3138 Given a message number (which is inserted in @samp{%d}), this regular
3139 expression will match the scan line that it represents (default:
3140 @samp{"^[^0-9]*%d[^0-9]"}).
3141 @end table
3143 Finally, there are a slew of variables that control how mh-e marks up
3144 the scan lines.
3146 @table @code
3147 @item mh-cmd-note
3148 @vindex @code{mh-cmd-note}
3149 Number of characters to skip over before inserting notation (default:
3150 4).  Note how it relates to the following regular expressions.
3152 @item mh-deleted-msg-regexp
3153 @vindex @code{mh-deleted-msg-regexp}
3154 This regular expression describes deleted messages (default:
3155 @samp{"^....D"}).  See also @code{mh-note-deleted}.
3157 @item mh-refiled-msg-regexp
3158 @vindex @code{mh-refiled-msg-regexp}
3159 This regular expression describes refiled messages (default:
3160 @samp{"^....\\^"}).  See also @code{mh-note-refiled}.
3162 @item mh-cur-scan-msg-regexp
3163 @vindex @code{mh-cur-scan-msg-regexp}
3164 This regular expression matches the current message (default:
3165 @samp{"^....\\+"}).  See also @code{mh-note-cur}.
3167 @item mh-good-msg-regexp
3168 @vindex @code{mh-good-msg-regexp}
3169 This regular expression describes which messages should be shown when
3170 mh-e goes to the next or previous message.  Normally, deleted or refiled
3171 messages are skipped over (default: @samp{"^....[^D^]"}).
3173 @item mh-note-deleted
3174 @vindex @code{mh-note-deleted}
3175 Messages that have been deleted to are marked by this string (default:
3176 @samp{"D"}).  See also @code{mh-deleted-msg-regexp}.
3178 @item mh-note-refiled
3179 @vindex @code{mh-note-refiled}
3180 Messages that have been refiled are marked by this string (default:
3181 @samp{"^"}).  See also @code{mh-refiled-msg-regexp}.
3183 @item mh-note-copied
3184 @vindex @code{mh-note-copied}
3185 Messages that have been copied are marked by this string (default:
3186 @samp{"C"}).
3188 @item mh-note-cur
3189 @vindex @code{mh-note-cur}
3190 The current message (in MH, not in mh-e) is marked by this string
3191 (default: @samp{"+"}).  See also @code{mh-cur-scan-msg-regexp}.
3193 @item mh-note-repl
3194 @vindex @code{mh-note-repl}
3195 Messages that have been replied to are marked by this string (default:
3196 @samp{"-"}).
3198 @item mh-note-forw
3199 @vindex @code{mh-note-forw}
3200 Messages that have been forwarded are marked by this string (default:
3201 @samp{"F"}).
3203 @item mh-note-dist
3204 @vindex @code{mh-note-dist}
3205 Messages that have been redistributed are marked by this string
3206 (default: @samp{"R"}).
3208 @item mh-note-printed
3209 @vindex @code{mh-note-printed}
3210 Messages that have been printed are marked by this string (default:
3211 @samp{"P"}).
3213 @item mh-note-seq
3214 @vindex @code{mh-note-seq}
3215 Messages in a sequence are marked by this string (default: @samp{"%"}).
3216 @end table
3218 @node Customizing Printing, Customizing Files and Pipes, Customizing Organizing, Customizing Moving Mail
3219 @subsection Printing Your Mail
3221 @cindex printing
3222 @vindex @code{mh-print-background}
3223 @vindex @code{mh-lpr-command-format}
3224 @cindex @code{lpr}
3225 @cindex Unix commands, @code{lpr}
3227 Normally messages are printed in the foreground.  If this is slow on
3228 your system, you may elect to set @code{mh-print-background} to
3229 non-@code{nil} to print in the background.  If you do this, do not delete
3230 the message until it is printed or else the output may be truncated.
3231 The variable @code{mh-lpr-command-format} controls how the printing is
3232 actually done.  The string can contain one escape, @samp{%s}, which is
3233 filled with the name of the folder and the message number and is useful
3234 for print job names.  As an example, the default is @samp{"lpr -J
3235 '%s'"}.
3237 @node Customizing Files and Pipes, Customizing Finishing Up, Customizing Printing, Customizing Moving Mail
3238 @subsection Files and Pipes
3240 @cindex using files
3241 @cindex using pipes
3242 @findex @code{mh-store-msg}
3243 @vindex @code{mh-store-default-directory}
3245 The initial directory for the @code{mh-store-msg} command is held in
3246 @code{mh-store-default-directory}.  Since I almost always run
3247 @code{mh-store-msg} on sources, I set it to my personal source directory
3248 like this:
3250 @vindex @code{mh-store-default-directory}, example
3252 @lisp
3253 (setq mh-store-default-directory (expand-file-name "~/src/"))
3254 @end lisp
3256 @findex @code{mh-store-buffer}
3257 @cindex @code{uuencode}
3258 @cindex Unix commands, @code{uuencode}
3259 @cindex @code{shar}
3260 @cindex Unix commands, @code{shar}
3262 Subsequent incarnations of @code{mh-store-msg} offer the last directory
3263 used as the default.  By the way, @code{mh-store-msg} calls the Emacs
3264 Lisp function @code{mh-store-buffer}.  I mention this because you can use
3265 it directly if you're editing a buffer that contains a file that has
3266 been run through @code{uuencode} or @code{shar}.  For example, you can
3267 extract the contents of the current buffer in your home directory by
3268 typing @kbd{M-x mh-store-buffer @key{RET} ~ @key{RET}}.
3270 @node Customizing Finishing Up,  , Customizing Files and Pipes, Customizing Moving Mail
3271 @subsection Finishing Up
3273 @cindex quitting
3274 @vindex @code{mh-before-quit-hook}
3275 @vindex @code{mh-quit-hook}
3276 @findex @code{mh-execute-commands}
3278 The two variables @code{mh-before-quit-hook} and @code{mh-quit-hook} are
3279 called by @kbd{q} (@code{mh-quit}).  The former one is called before the
3280 quit occurs, so you might use it to perform any mh-e operations; you
3281 could perform some query and abort the quit or call
3282 @code{mh-execute-commands}, for example.  The latter is not run in an
3283 mh-e context, so you might use it to modify the window setup.
3285 @node Customizing Searching,  , Customizing Moving Mail, Customizing mh-e
3286 @section Searching Through Messages
3287 @cindex searching
3289 @vindex @code{mh-pick-mode-hook}
3290 @vindex @code{mh-partial-folder-mode-line-annotation}
3292 If you find that you do the same thing over and over when editing the
3293 search template, you may wish to bind some shortcuts to keys.  This can
3294 be done with the variable @code{mh-pick-mode-hook}, which is called when
3295 @kbd{M-s} (@code{mh-search-folder}) is run on a new pattern.  
3297 The string
3298 @code{mh-partial-folder-mode-line-annotation} is used to annotate the
3299 mode line when only a portion of the folder is shown.  For example, this
3300 will be displayed after running @kbd{M-s} (@code{mh-search-folder}) to
3301 list messages based on some search criteria (see @ref{Searching}).  The
3302 default annotation of @samp{"select"} yields a mode line that looks
3303 like:
3305 @example
3306 --%%-@{+inbox/select@} 2 msgs (2-3)      (MH-Folder)--All-----------------
3307 @end example
3309 @node Odds and Ends, History, Customizing mh-e, Top
3310 @appendix Odds and Ends
3312 This appendix covers a few topics that don't fit elsewhere.  Here I tell
3313 you how to report bugs and how to get on the mh-e mailing list.  I also
3314 point out some additional sources of information.
3316 @menu
3317 * Bug Reports::                 
3318 * Mailing List::                
3319 * MH FAQ::                      
3320 * Getting mh-e::                
3321 @end menu
3323 @node Bug Reports, Mailing List, Odds and Ends, Odds and Ends
3324 @appendixsec Bug Reports
3326 @cindex bugs
3327 @cindex Gildea, Stephen
3329 The current maintainer of mh-e is Stephen Gildea
3330 <@i{gildea@@lcs.mit.edu}>.  Please mail bug reports directly to him, as
3331 well as any praise or suggestions.  Please include the output of
3332 @kbd{M-x mh-version} (@pxref{Miscellaneous}) in any bug report you send.
3334 @node Mailing List, MH FAQ, Bug Reports, Odds and Ends
3335 @appendixsec mh-e Mailing List
3337 @cindex mailing list
3339 There is a mailing list, @i{mh-e@@x.org}, for discussion of mh-e and
3340 announcements of new versions.  Send a ``subscribe'' message to
3341 @i{mh-e-request@@x.org} to be added.  Do not report bugs on this list;
3342 mail them directly to the maintainer (@pxref{Bug Reports}).
3344 @node MH FAQ, Getting mh-e, Mailing List, Odds and Ends
3345 @appendixsec MH FAQ
3347 @cindex MH FAQ
3348 @cindex FAQ
3350 An FAQ appears monthly in the newsgroup @samp{comp.mail.mh}.  While very
3351 little is there that deals with mh-e specifically, there is an
3352 incredible wealth of material about MH itself which you will find
3353 useful.  The subject of the FAQ is @cite{MH Frequently Asked Questions
3354 (FAQ) with Answers}.
3356 The FAQ can be also obtained by anonymous @code{ftp} or via the
3357 World Wide Web (WWW)@.  It is located at:
3359 @ifclear html
3360 @example
3361 ftp://rtfm.mit.edu/pub/usenet/news.answers/mail/mh-faq/part1
3362 http://www.cis.ohio-state.edu/hypertext/faq/usenet/mail/mh-faq/part1/faq.html
3363 @end example
3364 @end ifclear
3366 @ifset html
3367 @example
3368 <A HREF="ftp://rtfm.mit.edu/pub/usenet/news.answers/mail/mh-faq/part1">ftp://rtfm.mit.edu/pub/usenet/news.answers/mail/mh-faq/part1</A>
3369 <A HREF="http://www.cis.ohio-state.edu/hypertext/faq/usenet/mail/mh-faq/part1/faq.html">http://www.cis.ohio-state.edu/hypertext/faq/usenet/mail/mh-faq/part1/faq.html</A>
3370 @end example
3371 @end ifset
3373 Otherwise, you can use mail.  Send mail to @i{mail-server@@rtfm.mit.edu}
3374 containing the following:
3376 @example
3377 send usenet/news.answers/mail/mh-faq/part1
3378 @end example
3380 @node Getting mh-e,  , MH FAQ, Odds and Ends
3381 @appendixsec Getting mh-e
3383 @cindex obtaining mh-e
3385 If you're running a pre-4.0 version of mh-e, please consider upgrading.
3386 You can either have your system administrator upgrade your Emacs, or
3387 just the files for mh-e.
3389 The MH distribution contains a copy of mh-e in @file{miscellany/mh-e}.
3390 Make sure it is at least @w{Version 4.0}.
3392 The latest version of mh-e can be obtained via anonymous @code{ftp} from
3393 @samp{ftp.x.org}.  The file containing mh-e is currently
3394 @ifclear html
3395 @file{/misc/mh-e/mh-e-@value{VERSION}.tar.Z}.
3396 @end ifclear
3397 @ifset html
3398 @file{<A HREF="ftp://ftp.x.org/misc/mh-e/mh-e-@value{VERSION}.tar.Z">/misc/mh-e/mh-e-@value{VERSION}.tar.Z</A>}
3399 @end ifset
3400 I suggest that you
3401 extract the files from @file{mh-e-@value{VERSION}.tar.Z} in the
3402 following fashion:
3404 @example
3405 @group
3406 % @kbd{cd}                                  # @r{Start in your home directory}
3407 % @kbd{mkdir lib lib/emacs}                 # @r{Create directory for mh-e}
3408 % @kbd{cd lib/emacs}
3409 % @kbd{zcat @var{path/to/}mh-e-@value{VERSION}.tar.Z | tar xvf -}    # @r{Extract files}
3410 @end group
3411 @end example
3413 @cindex @file{.emacs}
3414 @cindex files, @file{.emacs}
3416 To use these new files, add the following to @file{~/.emacs}:
3418 @lisp
3419 (setq load-path (cons (expand-file-name "~/lib/emacs") load-path))
3420 @end lisp
3422 @cindex news
3423 @cindex files, @samp{MH-E-NEWS}
3425 That's it!  If you're already running Emacs, please quit that session
3426 and start again to load in the new mh-e.  Check that you're running the
3427 new version with the command @kbd{M-x mh-version} after running any mh-e
3428 command.  The distribution comes with a file called @file{MH-E-NEWS} so
3429 you can see what's new.
3431 @node    History, Changes to mh-e, Odds and Ends, Top
3432 @appendix History of mh-e
3434 @cindex history of mh-e
3436 mh-e was originally written by Brian Reid in 1983 and has changed hands
3437 twice since then.  Jim Larus wanted to do something similar for GNU
3438 Emacs, and ended up completely rewriting it that same year.  In 1989,
3439 Stephen Gildea picked it up and is now currently improving and
3440 maintaining it.
3442 @menu
3443 * From Brian Reid::             
3444 * From Jim Larus::              
3445 * From Stephen Gildea::         
3446 @end menu
3448 @node From Brian Reid, From Jim Larus, History, History
3449 @appendixsec From Brian Reid
3451 @cindex Reid, Brian
3453 One day in 1983 I got the flu and had to stay home from work for three
3454 days with nothing to do.  I used that time to write MHE@.  The
3455 fundamental idea behind MHE was that it was a ``puppeteer'' driving the MH
3456 programs underneath it.  MH had a model that the editor was supposed to
3457 run as a subprocess of the mailer, which seemed to me at the time to be
3458 the tail wagging the dog.  So I turned it around and made the editor
3459 drive the MH programs.  I made sure that the UCI people (who were
3460 maintaining MH at the time) took in my changes and made them stick.
3462 Today, I still use my own version of MHE because I don't at all like the
3463 way that GNU mh-e works and I've never gotten to be good enough at
3464 hacking Emacs Lisp to make GNU mh-e do what I want.  The Gosling-emacs
3465 version of MHE and the GNU Emacs version of mh-e have almost nothing in
3466 common except similar names.  They work differently, have different
3467 conceptual models, and have different key bindings.  @footnote{After
3468 reading this article, I questioned Brian about his version of MHE, and
3469 received some great ideas for improving mh-e such as a dired-like method
3470 of selecting folders; and removing the prompting when sending mail,
3471 filling in the blanks in the draft buffer instead.  I passed them on to
3472 Stephen Gildea, the current maintainer, and he was excited about the
3473 ideas as well.  Perhaps one day, mh-e will again resemble MHE, although
3474 none of these ideas are manifest in Version 5.0.}
3476 Brian Reid, June 1994
3478 @node From Jim Larus, From Stephen Gildea, From Brian Reid, History
3479 @appendixsec From Jim Larus
3481 @cindex Larus, Jim
3483 Brian Reid, while at CMU or shortly after going to Stanford wrote a mail
3484 reading program called MHE for Gosling Emacs.  It had much the same
3485 structure as mh-e (i.e., invoked MH programs), though it was simpler and
3486 the commands were slightly different.  Unfortunately, I no longer have a
3487 copy so the differences are lost in the mists of time.
3489 In '82-83, I was working at BBN and wrote a lot of mlisp code in Gosling
3490 Emacs to make it look more like Tennex Emacs.  One of the packages that
3491 I picked up and improved was Reid's mail system.  In '83, I went back to
3492 Berkeley.  About that time, Stallman's first version of GNU Emacs came
3493 out and people started to move to it from Gosling Emacs (as I recall,
3494 the transition took a year or two).  I decided to port Reid's MHE and
3495 used the mlisp to Emacs Lisp translator that came with GNU Emacs.  It
3496 did a lousy job and the resulting code didn't work, so I bit the bullet
3497 and rewrote the code by hand (it was a lot smaller and simpler then, so
3498 it took only a day or two).
3500 Soon after that, mh-e became part of the standard Emacs distribution and
3501 suggestions kept dribbling in for improvements.  mh-e soon reached
3502 sufficient functionality to keep me happy, but I kept on improving it
3503 because I was a graduate student with plenty of time on my hands and it
3504 was more fun than my dissertation.  In retrospect, the one thing that I
3505 regret is not writing any documentation, which seriously limited the use
3506 and appeal of the package.
3508 @cindex @code{xmh}, in mh-e history
3510 In '89, I came to Wisconsin as a professor and decided not to work on
3511 mh-e.  It was stable, except for minor bugs, and had enough
3512 functionality, so I let it be for a few years.  Stephen Gildea of BBN
3513 began to pester me about the bugs, but I ignored them.  In 1990, he went
3514 off to the X Consortium, said good bye, and said that he would now be
3515 using @code{xmh}.  A few months later, he came back and said that he
3516 couldn't stand @code{xmh} and could I put a few more bug fixes into
3517 mh-e.  At that point, I had no interest in fixing mh-e, so I gave the
3518 responsibility of maintenance to him and he has done a fine job since
3519 then.
3521 Jim Larus, June 1994
3523 @node From Stephen Gildea,  , From Jim Larus, History
3524 @appendixsec From Stephen Gildea
3526 @cindex Gildea, Stephen
3528 In 1987 I went to work for Bolt Beranek and Newman, as Jim had before
3529 me.  In my previous job, I had been using RMAIL, but as my folders tend
3530 to run large, I was frustrated with the speed of RMAIL@.  However, I
3531 stuck with it because I wanted the GNU Emacs interface.  I am very
3532 familiar and comfortable with the Emacs interface (with just a few
3533 modifications of my own) and dislike having to use applications with
3534 embedded editors; they never live up to Emacs.
3536 MH is the mail reader of choice at BBN, so I converted to it.  Since I
3537 didn't want to give up using an Emacs interface, I started using mh-e.
3538 As is my wont, I started hacking on it almost immediately.  I first used
3539 version 3.4m.  One of the first features I added was to treat the folder
3540 buffer as a file-visiting buffer: you could lock it, save it, and be
3541 warned of unsaved changes when killing it.  I also worked to bring its
3542 functionality a little closer to RMAIL@.  Jim Larus was very cooperative
3543 about merging in my changes, and my efforts first appeared in version
3544 3.6, distributed with Emacs 18.52 in 1988.  Next I decided mh-e was too
3545 slow and optimized it a lot.  Version, 3.7, distributed with Emacs 18.56
3546 in 1990, was noticeably faster.
3548 When I moved to the X Consortium I became the first person there to not
3549 use xmh.  (There is now one other engineer there using mh-e.)  About
3550 this point I took over maintenance of mh-e from Jim and was finally able
3551 to add some features Jim hadn't accepted, such as the backward searching
3552 undo.  My first release was 3.8 (Emacs 18.58) in 1992.
3554 Now, in 1994, we see a flurry of releases, with both 4.0 and 5.0.
3555 Version 4.0 added many new features, including background folder
3556 collection and support for composing @sc{mime} messages.  (Reading
3557 @sc{mime} messages remains to be done, alas.)  While writing this book,
3558 Bill Wohler gave mh-e its closest examination ever, uncovering bugs and
3559 inconsistencies that required a new major version to fix, and so version
3560 5 was released.
3562 Stephen Gildea, June 1994
3564 @node Changes to mh-e, Copying, History, Top
3565 @appendix Changes to mh-e
3567 @cindex @code{mh-e}: comparison between versions
3569 mh-e had a fairly major facelift between @w{Versions 3} and 4.  The
3570 differences between @w{Versions 4} and 5 from the user's viewpoint are
3571 relatively minor.  The prompting order for the folder and message number
3572 in a couple of functions had been switched inadvertently in @w{Version
3573 4}.  @w{Version 5} switches the order back.  The @file{+inbox} folder is
3574 no longer hard-coded, but rather uses the @samp{Inbox} MH Profile entry.
3575 See the file @file{etc/MH-E-NEWS} in the Emacs distribution for more
3576 details on the changes.
3578 This section documents the changes between @w{Version 3} and newer
3579 versions so that you'll know which commands to use (or which commands
3580 you won't have) in case you're stuck with an old version.
3582 The following tables summarize the changes to buffer names, commands
3583 and variables.
3585 @unnumberedsec Buffer Mode Names
3587 @example
3588 @group
3589 @b{Version 3}           @b{Version 4}
3591 mh-e folder        MH-Folder
3592 mh-e scan          MH-Folder
3593 mh-e show          MH-Folder Show
3594 Fundamental        MH-Show
3595 mh-e letter        MH-Letter
3596 mh-e letter        MH-Pick
3597 @end group
3598 @end example
3600 @page
3602 @unnumberedsec Commands
3604 @example
3605 @group
3606            @b{Version 3}                        @b{Version 4}
3608 @b{Function}               @b{Command}   @b{Command}          @b{Function}
3610 mh-first-msg           <          M-<               mh-first-msg
3611 -                      -          M->               mh-last-msg
3612 mh-show                .          RET               mh-show
3613 -                      -          ,                 mh-header-display
3614 mh-reply               a          r                 mh-reply
3615 mh-redistribute        r          M-d               mh-redistribute
3616 mh-unshar-msg          -          M-n               mh-store-msg
3617 mh-write-msg-to-file   M-o        C-o               mh-write-msg-to-file
3618 mh-delete-msg-from-seq C-u M-%    M-#               mh-delete-seq
3619 -                      -          M-q               mh-list-sequences
3620 mh-quit                b          q                 mh-quit
3621 -                      -          C-C C-f C-r       mh-to-field (@samp{From:})
3622 -                      -          C-C C-f C-d       mh-to-field (@samp{Dcc:})
3623 @end group
3624 @end example
3626 @unnumberedsec Variables
3628 @example
3629 @group
3630           @b{Version 3}                           @b{Version 4}
3632 @b{Variable}              @b{Value}             @b{Value}           @b{Variable}
3634 mh-show-buffer-      "@{%%b@}  %s/%d"    "@{show-%s@} %d"  mh-show-buffer-
3635 mode-line-buffer-id                                    mode-line-buffer-id
3636 mh-unshar-default-   ""                nil             mh-store-default-
3637 directory                                              directory
3638 @end group
3639 @end example
3642 @unnumberedsec New Variables
3644 @example
3645 @group
3646 mail-citation-hook                           mh-new-draft-cleaned-headers
3647 mail-header-separator                        mh-pick-mode-hook
3648 mh-auto-folder-collect                       mh-refile-msg-hook
3649 mh-comp-formfile                             mh-scan-prog
3650 mh-repl-formfile                             mh-send-prog
3651 mh-delete-msg-hook                           mh-show-hook
3652 mh-forward-subject-format                    mh-show-mode-hook
3653 mh-inc-prog                                  mh-signature-file-name
3654 mh-mime-content-types                        mh-sortm-args
3655 mh-default-folder-for-message-function       mh-repl-formfile
3656 mh-mhn-args
3657 @end group
3658 @end example
3660 @node Copying, Command Index, Changes to mh-e, Top
3661 @appendix GNU GENERAL PUBLIC LICENSE
3662 @center Version 2, June 1991
3664 @display
3665 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3666 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
3668 Everyone is permitted to copy and distribute verbatim copies
3669 of this license document, but changing it is not allowed.
3670 @end display
3672 @appendixsec Preamble
3674   The licenses for most software are designed to take away your
3675 freedom to share and change it.  By contrast, the GNU General Public
3676 License is intended to guarantee your freedom to share and change free
3677 software---to make sure the software is free for all its users.  This
3678 General Public License applies to most of the Free Software
3679 Foundation's software and to any other program whose authors commit to
3680 using it.  (Some other Free Software Foundation software is covered by
3681 the GNU Library General Public License instead.)  You can apply it to
3682 your programs, too.
3684   When we speak of free software, we are referring to freedom, not
3685 price.  Our General Public Licenses are designed to make sure that you
3686 have the freedom to distribute copies of free software (and charge for
3687 this service if you wish), that you receive source code or can get it
3688 if you want it, that you can change the software or use pieces of it
3689 in new free programs; and that you know you can do these things.
3691   To protect your rights, we need to make restrictions that forbid
3692 anyone to deny you these rights or to ask you to surrender the rights.
3693 These restrictions translate to certain responsibilities for you if you
3694 distribute copies of the software, or if you modify it.
3696   For example, if you distribute copies of such a program, whether
3697 gratis or for a fee, you must give the recipients all the rights that
3698 you have.  You must make sure that they, too, receive or can get the
3699 source code.  And you must show them these terms so they know their
3700 rights.
3702   We protect your rights with two steps: (1) copyright the software, and
3703 (2) offer you this license which gives you legal permission to copy,
3704 distribute and/or modify the software.
3706   Also, for each author's protection and ours, we want to make certain
3707 that everyone understands that there is no warranty for this free
3708 software.  If the software is modified by someone else and passed on, we
3709 want its recipients to know that what they have is not the original, so
3710 that any problems introduced by others will not reflect on the original
3711 authors' reputations.
3713   Finally, any free program is threatened constantly by software
3714 patents.  We wish to avoid the danger that redistributors of a free
3715 program will individually obtain patent licenses, in effect making the
3716 program proprietary.  To prevent this, we have made it clear that any
3717 patent must be licensed for everyone's free use or not licensed at all.
3719   The precise terms and conditions for copying, distribution and
3720 modification follow.
3722 @iftex
3723 @appendixsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3724 @end iftex
3725 @ifinfo
3726 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3727 @end ifinfo
3729 @enumerate 0
3730 @item
3731 This License applies to any program or other work which contains
3732 a notice placed by the copyright holder saying it may be distributed
3733 under the terms of this General Public License.  The ``Program'', below,
3734 refers to any such program or work, and a ``work based on the Program''
3735 means either the Program or any derivative work under copyright law:
3736 that is to say, a work containing the Program or a portion of it,
3737 either verbatim or with modifications and/or translated into another
3738 language.  (Hereinafter, translation is included without limitation in
3739 the term ``modification''.)  Each licensee is addressed as ``you''.
3741 Activities other than copying, distribution and modification are not
3742 covered by this License; they are outside its scope.  The act of
3743 running the Program is not restricted, and the output from the Program
3744 is covered only if its contents constitute a work based on the
3745 Program (independent of having been made by running the Program).
3746 Whether that is true depends on what the Program does.
3748 @item
3749 You may copy and distribute verbatim copies of the Program's
3750 source code as you receive it, in any medium, provided that you
3751 conspicuously and appropriately publish on each copy an appropriate
3752 copyright notice and disclaimer of warranty; keep intact all the
3753 notices that refer to this License and to the absence of any warranty;
3754 and give any other recipients of the Program a copy of this License
3755 along with the Program.
3757 You may charge a fee for the physical act of transferring a copy, and
3758 you may at your option offer warranty protection in exchange for a fee.
3760 @item
3761 You may modify your copy or copies of the Program or any portion
3762 of it, thus forming a work based on the Program, and copy and
3763 distribute such modifications or work under the terms of Section 1
3764 above, provided that you also meet all of these conditions:
3766 @enumerate a
3767 @item
3768 You must cause the modified files to carry prominent notices
3769 stating that you changed the files and the date of any change.
3771 @item
3772 You must cause any work that you distribute or publish, that in
3773 whole or in part contains or is derived from the Program or any
3774 part thereof, to be licensed as a whole at no charge to all third
3775 parties under the terms of this License.
3777 @item
3778 If the modified program normally reads commands interactively
3779 when run, you must cause it, when started running for such
3780 interactive use in the most ordinary way, to print or display an
3781 announcement including an appropriate copyright notice and a
3782 notice that there is no warranty (or else, saying that you provide
3783 a warranty) and that users may redistribute the program under
3784 these conditions, and telling the user how to view a copy of this
3785 License.  (Exception: if the Program itself is interactive but
3786 does not normally print such an announcement, your work based on
3787 the Program is not required to print an announcement.)
3788 @end enumerate
3790 These requirements apply to the modified work as a whole.  If
3791 identifiable sections of that work are not derived from the Program,
3792 and can be reasonably considered independent and separate works in
3793 themselves, then this License, and its terms, do not apply to those
3794 sections when you distribute them as separate works.  But when you
3795 distribute the same sections as part of a whole which is a work based
3796 on the Program, the distribution of the whole must be on the terms of
3797 this License, whose permissions for other licensees extend to the
3798 entire whole, and thus to each and every part regardless of who wrote it.
3800 Thus, it is not the intent of this section to claim rights or contest
3801 your rights to work written entirely by you; rather, the intent is to
3802 exercise the right to control the distribution of derivative or
3803 collective works based on the Program.
3805 In addition, mere aggregation of another work not based on the Program
3806 with the Program (or with a work based on the Program) on a volume of
3807 a storage or distribution medium does not bring the other work under
3808 the scope of this License.
3810 @item
3811 You may copy and distribute the Program (or a work based on it,
3812 under Section 2) in object code or executable form under the terms of
3813 Sections 1 and 2 above provided that you also do one of the following:
3815 @enumerate a
3816 @item
3817 Accompany it with the complete corresponding machine-readable
3818 source code, which must be distributed under the terms of Sections
3819 1 and 2 above on a medium customarily used for software interchange; or,
3821 @item
3822 Accompany it with a written offer, valid for at least three
3823 years, to give any third party, for a charge no more than your
3824 cost of physically performing source distribution, a complete
3825 machine-readable copy of the corresponding source code, to be
3826 distributed under the terms of Sections 1 and 2 above on a medium
3827 customarily used for software interchange; or,
3829 @item
3830 Accompany it with the information you received as to the offer
3831 to distribute corresponding source code.  (This alternative is
3832 allowed only for noncommercial distribution and only if you
3833 received the program in object code or executable form with such
3834 an offer, in accord with Subsection b above.)
3835 @end enumerate
3837 The source code for a work means the preferred form of the work for
3838 making modifications to it.  For an executable work, complete source
3839 code means all the source code for all modules it contains, plus any
3840 associated interface definition files, plus the scripts used to
3841 control compilation and installation of the executable.  However, as a
3842 special exception, the source code distributed need not include
3843 anything that is normally distributed (in either source or binary
3844 form) with the major components (compiler, kernel, and so on) of the
3845 operating system on which the executable runs, unless that component
3846 itself accompanies the executable.
3848 If distribution of executable or object code is made by offering
3849 access to copy from a designated place, then offering equivalent
3850 access to copy the source code from the same place counts as
3851 distribution of the source code, even though third parties are not
3852 compelled to copy the source along with the object code.
3854 @item
3855 You may not copy, modify, sublicense, or distribute the Program
3856 except as expressly provided under this License.  Any attempt
3857 otherwise to copy, modify, sublicense or distribute the Program is
3858 void, and will automatically terminate your rights under this License.
3859 However, parties who have received copies, or rights, from you under
3860 this License will not have their licenses terminated so long as such
3861 parties remain in full compliance.
3863 @item
3864 You are not required to accept this License, since you have not
3865 signed it.  However, nothing else grants you permission to modify or
3866 distribute the Program or its derivative works.  These actions are
3867 prohibited by law if you do not accept this License.  Therefore, by
3868 modifying or distributing the Program (or any work based on the
3869 Program), you indicate your acceptance of this License to do so, and
3870 all its terms and conditions for copying, distributing or modifying
3871 the Program or works based on it.
3873 @item
3874 Each time you redistribute the Program (or any work based on the
3875 Program), the recipient automatically receives a license from the
3876 original licensor to copy, distribute or modify the Program subject to
3877 these terms and conditions.  You may not impose any further
3878 restrictions on the recipients' exercise of the rights granted herein.
3879 You are not responsible for enforcing compliance by third parties to
3880 this License.
3882 @item
3883 If, as a consequence of a court judgment or allegation of patent
3884 infringement or for any other reason (not limited to patent issues),
3885 conditions are imposed on you (whether by court order, agreement or
3886 otherwise) that contradict the conditions of this License, they do not
3887 excuse you from the conditions of this License.  If you cannot
3888 distribute so as to satisfy simultaneously your obligations under this
3889 License and any other pertinent obligations, then as a consequence you
3890 may not distribute the Program at all.  For example, if a patent
3891 license would not permit royalty-free redistribution of the Program by
3892 all those who receive copies directly or indirectly through you, then
3893 the only way you could satisfy both it and this License would be to
3894 refrain entirely from distribution of the Program.
3896 If any portion of this section is held invalid or unenforceable under
3897 any particular circumstance, the balance of the section is intended to
3898 apply and the section as a whole is intended to apply in other
3899 circumstances.
3901 It is not the purpose of this section to induce you to infringe any
3902 patents or other property right claims or to contest validity of any
3903 such claims; this section has the sole purpose of protecting the
3904 integrity of the free software distribution system, which is
3905 implemented by public license practices.  Many people have made
3906 generous contributions to the wide range of software distributed
3907 through that system in reliance on consistent application of that
3908 system; it is up to the author/donor to decide if he or she is willing
3909 to distribute software through any other system and a licensee cannot
3910 impose that choice.
3912 This section is intended to make thoroughly clear what is believed to
3913 be a consequence of the rest of this License.
3915 @item
3916 If the distribution and/or use of the Program is restricted in
3917 certain countries either by patents or by copyrighted interfaces, the
3918 original copyright holder who places the Program under this License
3919 may add an explicit geographical distribution limitation excluding
3920 those countries, so that distribution is permitted only in or among
3921 countries not thus excluded.  In such case, this License incorporates
3922 the limitation as if written in the body of this License.
3924 @item
3925 The Free Software Foundation may publish revised and/or new versions
3926 of the General Public License from time to time.  Such new versions will
3927 be similar in spirit to the present version, but may differ in detail to
3928 address new problems or concerns.
3930 Each version is given a distinguishing version number.  If the Program
3931 specifies a version number of this License which applies to it and ``any
3932 later version'', you have the option of following the terms and conditions
3933 either of that version or of any later version published by the Free
3934 Software Foundation.  If the Program does not specify a version number of
3935 this License, you may choose any version ever published by the Free Software
3936 Foundation.
3938 @item
3939 If you wish to incorporate parts of the Program into other free
3940 programs whose distribution conditions are different, write to the author
3941 to ask for permission.  For software which is copyrighted by the Free
3942 Software Foundation, write to the Free Software Foundation; we sometimes
3943 make exceptions for this.  Our decision will be guided by the two goals
3944 of preserving the free status of all derivatives of our free software and
3945 of promoting the sharing and reuse of software generally.
3947 @iftex
3948 @heading NO WARRANTY
3949 @end iftex
3950 @ifinfo
3951 @center NO WARRANTY
3952 @end ifinfo
3954 @item
3955 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3956 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@.  EXCEPT WHEN
3957 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3958 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3959 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3960 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@.  THE ENTIRE RISK AS
3961 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@.  SHOULD THE
3962 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3963 REPAIR OR CORRECTION.
3965 @item
3966 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3967 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3968 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3969 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3970 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3971 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3972 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3973 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3974 POSSIBILITY OF SUCH DAMAGES.
3975 @end enumerate
3977 @iftex
3978 @heading END OF TERMS AND CONDITIONS
3979 @end iftex
3980 @ifinfo
3981 @center END OF TERMS AND CONDITIONS
3982 @end ifinfo
3984 @page
3985 @appendixsec How to Apply These Terms to Your New Programs
3987   If you develop a new program, and you want it to be of the greatest
3988 possible use to the public, the best way to achieve this is to make it
3989 free software which everyone can redistribute and change under these terms.
3991   To do so, attach the following notices to the program.  It is safest
3992 to attach them to the start of each source file to most effectively
3993 convey the exclusion of warranty; and each file should have at least
3994 the ``copyright'' line and a pointer to where the full notice is found.
3996 @smallexample
3997 @var{one line to give the program's name and an idea of what it does.}
3998 Copyright (C) 20@var{yy}  @var{name of author}
4000 This program is free software; you can redistribute it and/or
4001 modify it under the terms of the GNU General Public License
4002 as published by the Free Software Foundation; either version 2
4003 of the License, or (at your option) any later version.
4005 This program is distributed in the hope that it will be useful,
4006 but WITHOUT ANY WARRANTY; without even the implied warranty of
4007 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@.  See the
4008 GNU General Public License for more details.
4010 You should have received a copy of the GNU General Public License along
4011 with this program; if not, write to the Free Software Foundation, Inc.,
4012 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
4013 @end smallexample
4015 Also add information on how to contact you by electronic and paper mail.
4017 If the program is interactive, make it output a short notice like this
4018 when it starts in an interactive mode:
4020 @smallexample
4021 Gnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}
4022 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
4023 type `show w'.  This is free software, and you are welcome
4024 to redistribute it under certain conditions; type `show c' 
4025 for details.
4026 @end smallexample
4028 The hypothetical commands @samp{show w} and @samp{show c} should show
4029 the appropriate parts of the General Public License.  Of course, the
4030 commands you use may be called something other than @samp{show w} and
4031 @samp{show c}; they could even be mouse-clicks or menu items---whatever
4032 suits your program.
4034 You should also get your employer (if you work as a programmer) or your
4035 school, if any, to sign a ``copyright disclaimer'' for the program, if
4036 necessary.  Here is a sample; alter the names:
4038 @smallexample
4039 @group
4040 Yoyodyne, Inc., hereby disclaims all copyright
4041 interest in the program `Gnomovision'
4042 (which makes passes at compilers) written 
4043 by James Hacker.
4045 @var{signature of Ty Coon}, 1 April 1989
4046 Ty Coon, President of Vice
4047 @end group
4048 @end smallexample
4050 This General Public License does not permit incorporating your program into
4051 proprietary programs.  If your program is a subroutine library, you may
4052 consider it more useful to permit linking proprietary applications with the
4053 library.  If this is what you want to do, use the GNU Library General
4054 Public License instead of this License.
4056 @node    Command Index, Variable Index, Copying, Top
4057 @unnumbered Command Index
4059 @printindex fn
4061 @node    Variable Index, Concept Index, Command Index, Top
4062 @unnumbered Variable Index
4064 @printindex vr
4066 @node    Concept Index,  , Variable Index, Top
4067 @unnumbered Concept Index
4069 @printindex cp
4071 @contents
4072 @bye
4074 @c XXX In the sections on customizing mh-e, you can add cross-references
4075 @c to the Emacs manual and the Emacs Lisp manual wherever they are
4076 @c useful. @pxref{node, , section, emacs, The GNU Emacs Manual}