(gud-tooltip-dereference): Rename from toggle-gud-tooltip-dereference.
(gud-tooltip-print-command): Move concatenation of "*" to expr to...
(gud-tooltip-tips): ...here when dereferencing.
\input texinfo @c -*-texinfo-*-@c %**start of header@setfilename ../info/mh-e@settitle mh-e@c %**end of header@c Version variables.@set EDITION 1.3@set VERSION 5.0.2@set UPDATED 18 February 2001@set UPDATE-MONTH February 2001@copyingThis is Edition @value{EDITION}, last updated @value{UPDATED}, of@cite{mh-e, The Emacs Interface to MH}, for mh-e, Version@value{VERSION}.Copyright (C) 1995, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.@quotationPermission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.2 orany later version published by the Free Software Foundation; with noInvariant Sections, with the Front-Cover texts being ``A GNUManual'', and with the Back-Cover Texts as in (a) below. A copy of thelicense is included in the section entitled ``GNU Free DocumentationLicense'' in the Emacs manual.(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modifythis GNU Manual, like GNU software. Copies published by the FreeSoftware Foundation raise funds for GNU development.''This document is part of a collection distributed under the GNU FreeDocumentation License. If you want to distribute this documentseparately from the collection, you can do so by adding a copy of thelicense to the document, as described in section 6 of the license.@end quotation@end copying@setchapternewpage odd@dircategory Emacs@direntry* MH-E: (mh-e). Emacs interface to the MH mail system.@end direntry@titlepage@sp 10@center @titlefont{mh-e}@sp 2@center The Emacs Interface to MH@sp 2@center by Bill Wohler@sp 2@center Edition @value{EDITION} for mh-e Version @value{VERSION}@sp 2@center @value{UPDATE-MONTH}@page@vskip 0pt plus 1filllCopyright @copyright{} 1995, 2001, 2002 Free Software Foundation, Inc.@insertcopying@end titlepage@ifnottex@node Top, Preface, (dir), (dir)@top MH and EmacsThis is Edition @value{EDITION} of @cite{mh-e, The Emacs Interface toMH}, last updated @value{UPDATED} for mh-e Version @value{VERSION}.@menu* Preface:: Introduction to mh-e.* Tour Through mh-e:: Use mh-e quickly!* Using mh-e:: Documentation for all commands.* Customizing mh-e:: Documentation for all variables.* Odds and Ends:: Getting mh-e, reporting bugs, mailing list and FAQ.* History:: The authors speak up!* Copying:: The GNU General Public License* Command Index::* Variable Index::* Concept Index::@end menu@end ifnottex@node Preface, Tour Through mh-e, Top, Top@unnumbered Preface@cindex Emacs@cindex Unix commands, EmacsThese chapters introduce another interface to MH that is accessiblethrough the GNU Emacs editor, namely, @emph{mh-e}. mh-e is easy to use.I don't assume that you know GNU Emacs or even MH at this point, since Ididn't know either of them when I discovered mh-e. However, mh-e wasthe tip of the iceberg, and I discovered more and more niceties aboutGNU Emacs and MH@. Now I'm fully hooked on both of them.@cindex historyThe mh-e package is distributed with GNU Emacs, @footnote{Note thatmh-e is supported with MH 6 and @w{Emacs 18} and up.Reportedly, large parts of it work with @w{MH 5} and also withLucid/XEmacs and Epoch, but there are no guarantees. It is alsodistributed with Lucid/XEmacs, as well as with MH itself.} so youshouldn't have to do anything special to use it. But it's important tonote a brief history of mh-e. @w{Version 3} was prevalent through the@w{Emacs 18} and early @w{Emacs 19} years. Then @w{Version 4} came out(@w{Emacs 19.23}), which introduced several new and changed commands.Finally, @w{Version 5.0} was released, which fixed some bugs andincompatibilities, and was incorporated into @w{Emacs 19.29}. This isthe version covered by this manual. @ref{Getting Started} will helpyou decide which version you have.If you don't already use GNU Emacs but want to learn more, you can readan online tutorial by starting GNU Emacs and typing @kbd{C-h t}(@code{help-with-tutorial}). (This notation is described in@ref{Conventions}.) If you want to take the plunge, consult the@iftex@cite{GNU Emacs Manual},@end iftex@ifinfo@ref{top, , GNU Emacs Manual, emacs, The GNU Emacs Manual},@end ifinfofrom the Free Software Foundation.If more information is needed, you can go to the Unix manual pages ofthe individual MH commands. When the name is not obvious, I'll guideyou to a relevant MH manual page that describes the action more fully.I hope you enjoy these chapters! If you have any comments, orsuggestions for this document, please let me know.@noindentBill Wohler <@i{wohler@@newt.com}>@*8 February 1995@node Tour Through mh-e, Using mh-e, Preface, Top@chapter Tour Through mh-eThis chapter introduces some of the terms you'll need to know and thentakes you on a tour of mh-e. @footnote{The keys mentioned in thesechapters refer to the default key bindings. If you've changed thebindings, refer to the command summaries at the beginning of each majorsection in @ref{Using mh-e}, for a mapping between default key bindingsand function names.} When you're done, you'll be able to send, read,and file mail, which is all that a lot of people ever do. But if you'rethe curious type, you'll read @ref{Using mh-e} to be able to use allthe features of mh-e. If you're the adventurous type, you'll read@ref{Customizing mh-e} to make mh-e do what you want. I suggest youread this chapter first to get the big picture, and then you can readthe other two as you wish.@menu* Conventions:: GNU Emacs Terms and Conventions* Getting Started::* Sending Mail Tour::* Reading Mail Tour::* Processing Mail Tour::* Leaving mh-e::* More About mh-e::@end menu@node Conventions, Getting Started, Tour Through mh-e, Tour Through mh-e@section GNU Emacs Terms and Conventions@cindex Emacs, terms and conventions@cindex Emacs@cindex Unix commands, EmacsIf you're an experienced Emacs user, you can skip the followingconventions and definition of terms and go directly to @ref{GettingStarted} below. The conventions are as follows:@table @kbd@item C-xHold down the @key{CTRL} (Control) key and press the @kbd{x} key.@item M-xHold down the @key{META} or @key{ALT} key and press the @kbd{x} key.Since some keyboards don't have a @key{META} key, you can generate@kbd{M-x}, for example, by pressing @key{ESC} (Escape), @emph{releasingit}, @footnote{This is emphasized because pressing ESC twice or holdingit down a second too long so that it repeats gives you an error message.}and then pressing the @kbd{x} key.@item RETPress the @key{RETURN} or @key{ENTER} key. This is normally used tocomplete a command.@item SPCPress the space bar.@item TABPress the @key{TAB} key.@item DELPress the @key{DELETE} key.@item BSPress the @key{BACKSPACE} key. @footnote{If you are using Version 20or earlier of Emacs, you will need to use the @key{DEL} key.}@end table@cindex Emacs, prefix argument@cindex prefix argumentA @dfn{prefix argument} allows you to pass an argument to any Emacsfunction. To pass an argument, type @kbd{C-u} before the Emacs commandor keystroke. Numeric arguments can be passed as well. For example, toinsert five f's, use @kbd{C-u 5 f}. There is a default of four whenusing @kbd{C-u}, and you can use multiple prefix arguments to providearguments of powers of four. To continue our example, you could insertfour f's with @kbd{C-u f}, 16 f's with @kbd{C-u C-u f}, 64 f's with@kbd{C-u C-u C-u f}, and so on. Numeric and valueless negativearguments can also be inserted with the @key{META} key. Examplesinclude @kbd{M-5} to specify an argument of 5, or @kbd{M--} whichspecifies a negative argument with no particular value.@sp 2@need 1000@center @strong{NOTE}@quotationThe prefix @kbd{C-u} or @kbd{M-} is not necessary in mh-e's MH-Foldermodes (@pxref{Reading Mail Tour}). In these modes, simply enter thenumerical argument before entering the command.@end quotation@cindex point@cindex Emacs, point@cindex mark@cindex Emacs, mark@cindex region@cindex Emacs, regionThere are several other terms that are used in Emacs that you shouldknow. The @dfn{point} is where the cursor currently is. You can saveyour current place in the file by setting a @dfn{mark}. This operationis useful in several ways. The mark can be later used when defining a@dfn{region}, which is the text between the point and mark. Manycommands operate on regions, such as those for deleting text or fillingparagraphs. A mark can be set with @kbd{C-@@} (or @kbd{C-SPC}).@cindex minibuffer@cindex Emacs, minibuffer@cindex file completion@cindex Emacs, file completionThe @dfn{minibuffer} is the bottom line of the Emacs window, where allprompting and multiple-character input is directed. If you are promptedfor information in the minibuffer, such as a filename, Emacs can helpyou complete your answer if you type @key{SPC} or @key{TAB}. A second@key{SPC} or @key{TAB} will list all possibilities at that point. Theminibuffer is also where you enter Emacs function names after typing@kbd{M-x}. For example, in the first paragraph, I mentioned that youcould obtain help with @kbd{C-h t} (@code{help-with-tutorial}). Whatthis means is that you can get a tutorial by typing either @kbd{C-h t}or @kbd{M-x help-with-tutorial}. In the latter case, you are promptedfor @samp{help-with-tutorial} in the minibuffer after typing @kbd{M-x}.@cindex interrupting@cindex Emacs, interrupting@cindex quitting@cindex Emacs, quitting@i{In case of trouble:} Emacs can be interrupted at any time with@kbd{C-g}. For example, if you've started a command that requests thatyou enter something in the minibuffer, but then you change your mind,type @kbd{C-g} and you'll be back where you started. If you want toexit Emacs entirely, use @kbd{C-x C-c}.@node Getting Started, Sending Mail Tour, Conventions, Tour Through mh-e@section Getting StartedBecause there are many old versions of mh-e out there, it is important toknow which version you have. I'll be talking about @w{Version 5} whichis similar to @w{Version 4} and vastly different from @w{Version 3}.First, enter @kbd{M-x load-library @key{RET} mh-e@key{RET}}. @footnote{You wouldn't ordinarily do this.} The message,@samp{Loading mh-e...done}, should be displayed in the minibuffer. Ifyou get @samp{Cannot open load file: mh-e}, then your Emacs is verybadly configured, or mh-e is missing. You may wish to have your systemadministrator install a new Emacs or at least the latest mh-e files.Having loaded mh-e successfully, enter @kbd{M-x mh-version @key{RET}}.The version of mh-e should be displayed. Hopefully it says that you'rerunning @w{Version @value{VERSION}} which is the latest version as ofthis printing. If instead Emacs beeps and says @samp{[No match]}, thenyou're running an old version of mh-e.If these tests reveal a non-existent or old version of mh-e, pleaseconsider obtaining a new version. You can have your systemadministrator upgrade the system-wide version, or you can install yourown personal version. It's really quite easy; instructions for gettingand installing mh-e are in @ref{Getting mh-e}.@cindex @code{install-mh}@cindex MH commands, @code{install-mh}Also, older versions of mh-e assumed that you had already set up your MHenvironment. Newer versions set up a new MH environment for you byrunning @code{install-mh} and notifying you of this fact with themessage in a temporary buffer:@exampleI'm going to create the standard MH path for you.@end exampleTherefore, if you've never run MH before and you're using an old versionof mh-e, you need to run @code{install-mh} from the shell before youcontinue the tour. If you don't, you'll be greeted with the errormessage: @samp{Can't find MH profile}.@cindex @file{.emacs}@cindex files, @file{.emacs}If, during the tour described in this chapter, you see a message like:@samp{Searching for program: no such file or directory,/usr/local/bin/mhpath}, it means that the MH programs and files are keptin a nonstandard directory. In this case, simply add the following to@file{~/.emacs} and restart @code{emacs}.@vindex @code{mh-progs}, example@vindex @code{mh-lib}, example@c XXX Real example for really naive user?@example@group(setq mh-progs "@var{/path/to/MH/binary/directory/}")(setq mh-lib "@var{/path/to/MH/library/directory/}")@end group@end example@cindex ~The @samp{~} notation used by @file{~/.emacs} above represents your homedirectory. This is used by the @code{bash} and @code{csh} shells. Ifyour shell does not support this feature, you could use the environmentvariable @samp{$HOME} (such as @file{$HOME/.emacs}) or the absolute path(as in @file{/home/wohler/.emacs}) instead.At this point, you should see something like the screen in thefigure in @ref{Reading Mail Tour}. We're now ready to move on.@node Sending Mail Tour, Reading Mail Tour, Getting Started, Tour Through mh-e@section Sending Mail@cindex sending mail@findex @code{mh-smail}Let's start our tour by sending ourselves a message which we can laterread and process. Enter @kbd{M-x mh-smail} to invoke the mh-e programto send messages. You will be prompted in the minibuffer by @samp{To:}.Enter your login name. The next prompt is @samp{cc:}. Hit @key{RET} toindicate that no carbon copies are to be sent. At the @samp{Subject:}prompt, enter @kbd{Test} or anything else that comes to mind.@cindex MH-Letter mode@cindex modes, MH-Letter@cindex modeOnce you've specified the recipients and subject, your message appearsin an Emacs buffer whose mode @footnote{A @dfn{mode} changes Emacs tomake it easier to edit a particular type of text.} is MH-Letter.Enter some text in the body of the message, using normal Emacs commands.You should now have something like this: @footnote{If you're running Emacsunder the X Window System, then you would also see a menubar. I've leftout the menubar in all of the example screens.}@example@group@cartouche-----Emacs: *scratch* (Lisp Interaction)--All-------------------To: wohlercc:Subject: Test-------- This is a test message to get the wheels churning...#--**-@{draft@} (MH-Letter)--All-------------------------------------@end cartouche@i{mh-e message composition window}@end group@end example@cindex MH-Letter mode@cindex modes, MH-LetterNote the line of dashes that separates the header and the body of themessage. It is essential that these dashes (or a blank line) arepresent or the body of your message will be considered to be part ofthe header.There are several commands specific to MH-Letter mode, but atthis time we'll only use @kbd{C-c C-c} to send your message. Type@kbd{C-c C-c} now. That's all there is to it!@node Reading Mail Tour, Processing Mail Tour, Sending Mail Tour, Tour Through mh-e@section Receiving Mail@cindex reading mail@findex @code{mh-rmail}@cindex @code{inc}@cindex MH commands, @code{inc}@cindex @code{scan}@cindex MH commands, @code{scan}@cindex MH-Folder mode@cindex modes, MH-FolderTo read the mail you've just sent yourself, enter @kbd{M-x mh-rmail}.This incorporates the new mail and put the output from @code{inc}(called @dfn{scan lines} after the MH program @code{scan} which prints aone-line summary of each message) into a buffer called @samp{+inbox}whose major mode is MH-Folder.@sp 2@need 1000@center @strong{NOTE}@quotationThe @kbd{M-x mh-rmail} command will show you only new mail, not oldmail. If you were to run this tour again, you would use @kbd{M-r} topull all your messages into mh-e.@end quotationYou should see the scan line for your message, and perhaps others. Use@kbd{n} or @kbd{p} to move the cursor to your test message and type@key{RET} to read your message. You should see something like:@example@group@cartouche 3 24Aug root received fax files on Wed Aug 24 11:00:13 PDT 1994# 4+ 24Aug To:wohler Test<<This is a test message to get the wheels chu--%%-@{+inbox@} 4 msgs (1-4) (MH-Folder Show)--Bot------------------To: wohlerSubject: TestDate: Wed, 24 Aug 1994 13:01:13 -0700From: Bill Wohler <wohler@@newt.com> This is a test message to get the wheels churning...-----@{show-+inbox@} 4 (MH-Show)--Bot-------------------------------@end cartouche@i{After incorporating new messages}@end group@end exampleIf you typed a long message, you can view subsequent pages with @key{SPC}and previous pages with @key{DEL}.@node Processing Mail Tour, Leaving mh-e, Reading Mail Tour, Tour Through mh-e@section Processing Mail@cindex processing mailThe first thing we want to do is reply to the message that we sentourselves. Ensure that the cursor is still on the same line as yourtest message and type @kbd{r}. You are prompted in the minibuffer with@samp{Reply to whom:}. Here mh-e is asking whether you'd like to replyto the original sender only, to the sender and primary recipients, or tothe sender and all recipients. If you simply hit @key{RET}, you'llreply only to the sender. Hit @key{RET} now.You'll find yourself in an Emacs buffer similar to that when you weresending the original message, like this:@example@group@cartoucheTo: wohlerSubject: Re: TestIn-reply-to: Bill Wohler's message of Wed, 24 Aug 1994 13:01:13 -0700 <199408242001.NAA00505@@newt.com>--------#--**-@{draft@} (MH-Letter)--All-------------------------------------To: wohlerSubject: TestDate: Wed, 24 Aug 1994 13:01:13 -0700From: Bill Wohler <wohler@@newt.com> This is a test message to get the wheels churning...-----@{show-+inbox@} 4 (MH-Show)--Bot-------------------------------Composing a reply...done@end cartouche@i{Composition window during reply}@end group@end exampleBy default, MH will not add you to the address list of your replies, soif you find that the @samp{To:} header field is missing, don't worry.In this case, type @kbd{C-c C-f C-t} to create and go to the @samp{To:}field, where you can type your login name again. You can move aroundwith the arrow keys or with @kbd{C-p} (@code{previous-line}), @kbd{C-n}(@code{next-line}), @kbd{C-b} (@code{backward-char}), and @kbd{C-f}(@code{forward-char}) and can delete the previous character with@key{BS}. When you're finished editing your message, send it with@kbd{C-c C-c} as before.@cindex folderYou'll often want to save messages that were sent to you in an organizedfashion. This is done with @dfn{folders}. You can use folders to keepmessages from your friends, or messages related to a particular topic.With your cursor in the MH-Folder buffer and positioned on the messageyou sent to yourself, type @kbd{o} to output (@code{refile} in MHparlance) that message to a folder. Enter @kbd{test} at the@samp{Destination:} prompt and type @kbd{y} (or @key{SPC}) when mh-easks to create the folder @samp{+test}. Note that a @samp{^} (caret)appears next to the message number, which means that the message hasbeen marked for refiling but has not yet been refiled. We'll talk abouthow the refile is actually carried out in a moment.@cindex MH-Folder mode@cindex modes, MH-FolderYour previous reply is now waiting in the system mailbox. Youincorporate this mail into your MH-Folder buffer named @samp{+inbox}with the @kbd{i} command. Do this now. After the mail is incorporated,use @kbd{n} or @kbd{p} to move the cursor to the new message, and readit with @key{RET}. Let's delete this message by typing @kbd{d}. Notethat a @samp{D} appears next to the message number. This means that themessage is marked for deletion but is not yet deleted. To perform thedeletion (and the refile we did previously), use the @kbd{x} command.@findex @code{mh-smail}If you want to send another message you can use @kbd{m} instead of@kbd{M-x mh-smail}. So go ahead, send some mail to your friends!@node Leaving mh-e, More About mh-e, Processing Mail Tour, Tour Through mh-e@section Leaving mh-e@cindex Emacs, quitting@cindex quittingYou may now wish to exit @code{emacs} entirely. Use @kbd{C-x C-c} toexit @code{emacs}. If you exited without running @kbd{x} in the@samp{+inbox} buffer, Emacs will offer to save it for you. Type @kbd{y}or @key{SPC} to save @samp{+inbox} changes, which means to perform any refilesand deletes that you did there.If you don't want to leave Emacs, you can type @kbd{q} to bury (hide)the mh-e folder or delete them entirely with @kbd{C-x k}. You can thenlater recall them with @kbd{C-x b} or @kbd{M-x mh-rmail}.@node More About mh-e, , Leaving mh-e, Tour Through mh-e@section More About mh-eThese are the basic commands to get you going, but there are plentymore. If you think that mh-e is for you, read @ref{Using mh-e} and@ref{Customizing mh-e} to find out how you can:@itemize @bullet@itemPrint your messages. (@ref{Printing} and @ref{Customizing Printing}.)@itemEdit messages and include your signature. (@ref{Draft Editing}and @ref{Customizing Draft Editing}.)@itemForward messages. (@ref{Forwarding} and @ref{Customizing Forwarding}.)@itemRead digests. (@ref{Viewing}.)@itemEdit bounced messages. (@ref{Old Drafts} and @ref{Customizing Old Drafts}.)@itemSend multimedia messages. (@ref{Editing MIME} and @ref{Customizing Editing MIME}.)@itemProcess mail that was sent with @code{shar} or @code{uuencode}.(@ref{Files and Pipes}.)@itemUse sequences conveniently. (@ref{Sequences}.)@itemShow header fields in different fonts. (@ref{Customizing Viewing}.)@itemFind previously refiled messages. (@ref{Searching}.)@itemPlace messages in a file. (@ref{Files and Pipes}.)@end itemizeRemember that you can also use MH commands when you're not running mh-e(and when you are!).@node Using mh-e, Customizing mh-e, Tour Through mh-e, Top@chapter Using mh-eThis chapter leaves the tutorial style and goes into more detail aboutevery mh-e command. The default, or "out of the box," behavior isdocumented. If this is not to your liking (for instance, you print withsomething other than @code{lpr)}, see the associated section in@ref{Customizing mh-e} which is organized exactly like this chapter.@cindex Emacs, functions; describe-mode@cindex Emacs, online help@cindex online helpThere are many commands, but don't get intimidated. There are commandsummaries at the beginning of each section. In case you have or wouldlike to rebind the keys, the command summaries also list the associatedEmacs Lisp function. Furthermore, even if you're stranded on a desertisland with a laptop and are without your manuals, you can get a summaryof all these commands with GNU Emacs online help: use @kbd{C-h m}(@code{describe-mode}) for a brief summary of commands or @kbd{C-h i} toread this manual via Info. The online help is quite good; try running@kbd{C-h C-h C-h}. This brings up a list of available help topics, oneof which displays the documentation for a given key (like @kbd{C-h kC-n}). In addition, review @ref{Conventions}, if any of the GNU Emacsconventions are strange to you.Let's get started!@menu* Reading Mail::* Sending Mail::* Draft Editing::* Moving Mail::* Searching::* Sequences::* Miscellaneous::@end menu@node Reading Mail, Sending Mail, Using mh-e, Using mh-e@section Reading Your Mail@cindex reading mail@findex @code{mh-rmail}@cindex MH-Folder mode@cindex modes, MH-FolderThe mh-e entry point for reading mail is @kbd{M-x mh-rmail}. Thiscommand incorporates your mail and creates a buffer called @samp{+inbox}in MH-Folder mode. The @kbd{M-x mh-rmail} command shows you only newmail, not old mail. @footnote{If you want to see your old mail as well,use @kbd{M-r} to pull all your messages into mh-e. Or, give a prefixargument to @code{mh-rmail} so it will prompt you for folder to visitlike @kbd{M-f} (for example, @kbd{C-u M-x mh-rmail @key{RET} bob@key{RET}}). Both @kbd{M-r} and @kbd{M-f} are described in@ref{Organizing}.} The @samp{+inbox} buffer contains @dfn{scan lines},which are one-line summaries of each incorporated message. You canperform most MH commands on these messages via one-letter commandsdiscussed in this chapter. See @code{scan}(1) for a description of thecontents of the scan lines, and see the Figure in @ref{Reading MailTour}, for an example.@table @kbd@item RETDisplay a message (@code{mh-show}).@item SPCGo to next page in message (@code{mh-page-msg}).@item BSGo to previous page in message (@code{mh-previous-page}).@item , (comma)Display a message with all header fields (@code{mh-header-display}).@item M-SPCGo to next message in digest (@code{mh-page-digest}).@item M-BSGo to previous message in digest (@code{mh-page-digest-backwards}).@item M-bBreak up digest into separate messages (@code{mh-burst-digest}).@item nDisplay next message (@code{mh-next-undeleted-msg}).@item pDisplay previous message (@code{mh-previous-undeleted-msg}).@item gGo to a message (@code{mh-goto-msg}).@item M-<Go to first message (@code{mh-first-msg}).@item M->Go to last message (@code{mh-last-msg}).@item tToggle between MH-Folder and MH-Folder Show modes (@code{mh-toggle-showing}).@end table@menu* Viewing::* Moving Around::@end menu@node Viewing, Moving Around, Reading Mail, Reading Mail@subsection Viewing Your Mail@findex @code{mh-show}@findex @code{mh-page-msg}@findex @code{mh-previous-page}@findex @code{mh-header-display}The @kbd{RET} (@code{mh-show}) command displays the message that thecursor is on. If the message is already displayed, it scrolls to thebeginning of the message. Use @key{SPC} (@code{mh-page-msg}) and@key{BS} (@code{mh-previous-page}) to move forwards and backwards onepage at a time through the message. You can give either of thesecommands a prefix argument that specifies the number of lines to scroll(such as @kbd{10 SPC}). mh-e normally hides a lot of thesuperfluous header fields that mailers add to a message, but if you wishto see all of them, use the @kbd{,} (comma; @code{mh-header-display})command.@menu* Reading Digests::* Reading MIME::@end menu@node Reading Digests, Reading MIME, Viewing, Viewing@subsubsection Reading Digests@cindex digests@findex @code{mh-page-digest}@findex @code{mh-page-digest-backwards}A digest is a message that contains other messages. Special mh-ecommands let you read digests conveniently. You can use @key{SPC} and@key{BS} to page through the digest as if it were a normal message, butif you wish to skip to the next message in the digest, use @kbd{M-SPC}(@code{mh-page-digest}). To return to a previous message, use@kbd{M-BS} (@code{mh-page-digest-backwards}).@cindex @code{burst}@cindex MH commands, @code{burst}@cindex MH-Folder Show mode@cindex modes, MH-Folder Show@findex @code{mh-burst-digest}@c There was a page break at the colon in the following paragraph which@c broke the transition to the example.@need 2000Another handy command is @kbd{M-b} (@code{mh-burst-digest}). Thiscommand uses the MH command @code{burst} to break out each message inthe digest into its own message. Using this command, you can quicklydelete unwanted messages, like this: Once the digest is split up, toggleout of MH-Folder Show mode with @kbd{t} (@pxref{Moving Around}) so thatthe scan lines fill the screen and messages aren't displayed. Then use@kbd{d} (@pxref{Deleting}) to quickly delete messages that you don'twant to read (based on the @samp{Subject:} header field). You can alsoburst the digest to reply directly to the people who posted the messagesin the digest. One problem you may encounter is that the @samp{From:}header fields are preceded with a @samp{>} so that your reply can'tcreate the @samp{To:} field correctly. In this case, you must correctthe @samp{To:} field yourself. This is described later in @ref{EditingTextual}.@node Reading MIME, , Reading Digests, Viewing@subsubsection Reading Multimedia Mail@cindex multimedia mail@cindex MIME@cindex @code{show}@cindex MH commands, @code{show}@cindex @code{mhshow}@cindex MH commands, @code{mhshow}MH has the ability to read @dfn{@sc{mime}} (Multipurpose Internet MailExtensions) messages. Unfortunately, mh-e does not yet have thisability, so you have to use the MH commands @code{show} or @code{mhshow}from the shell to read @sc{mime} messages. @footnote{You can call themdirectly from Emacs if you're running the X Window System: type @kbd{M-!xterm -e mhshow @var{message-number}}. You can leave out the @code{xterm-e} if you use @code{mhlist} or @code{mhstore}.}@node Moving Around, , Viewing, Reading Mail@subsection Moving Around@cindex moving between messages@findex @code{mh-next-undeleted-msg}@findex @code{mh-previous-undeleted-msg}@findex @code{mh-goto-msg}@findex @code{mh-last-msg}@findex @code{mh-first-msg}To move on to the next message, use the @kbd{n}(@code{mh-next-undeleted-msg}) command; use the @kbd{p}(@code{mh-previous-undeleted-msg}) command to read the previous message.Both of these commands can be given a prefix argument to specify howmany messages to skip (for example, @kbd{5 n}). You can also move to aspecific message with @kbd{g} (@code{mh-goto-msg}). You can enter themessage number either before or after typing @kbd{g}. In the lattercase, Emacs prompts you. Finally, you can go to the first or lastmessage with @kbd{M-<} (@code{mh-first-msg}) and @kbd{M->}(@code{mh-last-msg}) respectively.@cindex MH-Folder mode@cindex modes, MH-FolderYou can also use the Emacs commands @kbd{C-p} (@code{previous-line}) and@kbd{C-n} (@code{next-line}) to move up and down the scan lines in theMH-Folder window. These commands can be used in conjunction with@kbd{RET} to look at deleted or refiled messages.@cindex MH-Folder mode@cindex modes, MH-Folder@cindex MH-Folder Show mode@cindex modes, MH-Folder Show@cindex junk mail@findex @code{mh-toggle-showing}The command @kbd{t} (@code{mh-toggle-showing}) switches betweenMH-Folder mode and MH-Folder Show mode. @footnote{For you Emacswizards, this is implemented as an Emacs minor mode.} MH-Folder modeturns off the associated show buffer so that you can perform operationson the messages quickly without reading them. This is an excellent wayto prune out your junk mail or to refile a group of messages to anotherfolder for later examination.@node Sending Mail, Draft Editing, Reading Mail, Using mh-e@section Sending Mail@cindex sending mail@findex @code{mh-smail}You can send a mail message in several ways. You can call @kbd{M-xmh-smail} directly, or from the command line like this:@cindex starting from command line@example% @kbd{emacs -f mh-smail}@end exampleFrom within mh-e's MH-Folder mode, other methods of sending mailare available as well:@table @kbd@item mCompose a message (@code{mh-send}).@item rReply to a message (@code{mh-reply}).@item fForward message(s) (@code{mh-forward}).@item M-dRedistribute a message (@code{mh-redistribute}).@item M-eEdit a message that was bounced by mailer (@code{mh-extract-rejected-mail}).@item M-aEdit a message to send it again (@code{mh-edit-again}).@end table@cindex MH-Folder mode@cindex modes, MH-Folder@cindex MH-Letter mode@cindex modes, MH-Letter@findex @code{mh-send}From within a MH-Folder buffer, you can simply use the command @kbd{m}(@code{mh-send}). However you invoke @code{mh-send}, you are promptedfor the @samp{To:}, @samp{cc:}, and @samp{Subject:} header fields. Onceyou've specified the recipients and subject, your message appears in anEmacs buffer whose mode is MH-Letter (see the Figure in @ref{SendingMail} to see what the buffer looks like). MH-Letter mode allows you toedit your message, to check the validity of the recipients, to insertother messages into your message, and to send the message. We'll gomore into depth about editing a @dfn{draft} @footnote{I highly recommendthat you use a @dfn{draft folder} so that you can edit several drafts inparallel. To do so, create a folder (e.g., @file{+drafts}), and add aprofile component called @samp{Draft-Folder:} which contains@file{+drafts} (see @code{mh-profile}(5)).} (a message you're composing)in just a moment.@findex @code{mh-smail}@findex @code{mh-smail-other-window}@code{mh-smail} always creates a two-window layout with the currentbuffer on top and the draft on the bottom. If you would rather preservethe window layout, use @kbd{M-x mh-smail-other-window}.@menu* Replying::* Forwarding::* Redistributing::* Old Drafts::@end menu@node Replying, Forwarding, Sending Mail, Sending Mail@subsection Replying to Mail@cindex replying@cindex @code{mhl}@cindex MH commands, @code{mhl}@cindex @file{mhl.reply}@cindex files, @file{mhl.reply}@findex @code{mh-reply}To compose a reply to a message, use the @kbd{r} (@code{mh-reply})command. If you supply a prefix argument (as in @kbd{C-u r}), themessage you are replying to is inserted in your reply after having firstbeen run through @code{mhl} with the format file @file{mhl.reply}. See@code{mhl}(1) to see how you can modify the default @file{mhl.reply}file.When you reply to a message, you are first prompted with @samp{Reply towhom?}. You have several choices here.@example@group@b{Response} @b{Reply Goes To}@kbd{from} @r{The person who sent the message. This is the default,} @r{so @key{RET} is sufficient.}@kbd{to} @r{Replies to the sender, plus all recipients in the} @r{@samp{To:} header field.}@kbd{all}@kbd{cc} @r{Forms a reply to the sender, plus all recipients.}@end group@end example@cindex @code{repl}@cindex MH commands, @code{repl}Depending on your answer, @code{repl} is given a different argument toform your reply. Specifically, a choice of @kbd{from} or none at allruns @code{repl -nocc all}, and a choice of @kbd{to} runs @code{repl -ccto}. Finally, either @kbd{cc} or @kbd{all} runs @code{repl -cc all-nocc me}.@cindex MH-Letter mode@cindex modes, MH-LetterTwo windows are then created. One window contains the message to whichyou are replying. Your draft, in MH-Letter mode (described in@ref{Draft Editing}), is in the other window.If you wish to customize the header or other parts of the reply draft,please see @code{repl}(1) and @code{mh-format}(5).@node Forwarding, Redistributing, Replying, Sending Mail@subsection Forwarding Mail@cindex forwarding@cindex @code{forw}@cindex MH commands, @code{forw}@findex @code{mh-forward}To forward a message, use the @kbd{f} (@code{mh-forward}) command. Youare given a draft to edit that looks like it would if you had run the MHcommand @code{forw}. You are given a chance to add some text (see@ref{Draft Editing}).You can forward several messages by using a prefix argument; in thiscase, you are prompted for the name of a @dfn{sequence}, a symbolic namethat represents a list or range of message numbers (for example,@kbd{C-u f forbob @key{RET}}). All of the messages in the sequence areinserted into your draft. By the way, although sequences are oftenmentioned in this chapter, you don't have to worry about them for now;the full description of sequences in mh-e is at the end in@ref{Sequences}. To learn more about sequences in general, please see@code{mh-sequence}(5).@node Redistributing, Old Drafts, Forwarding, Sending Mail@subsection Redistributing Your Mail@cindex redistributing@findex @code{mh-redistribute}The command @kbd{M-d} (@code{mh-redistribute}) is similar in function toforwarding mail, but it does not allow you to edit the message, nor doesit add your name to the @samp{From:} header field. It appears to therecipient as if the message had come from the original sender. For moreinformation on redistributing messages, see @code{dist}(1). Alsoinvestigate the @kbd{M-a} (@code{mh-edit-again}) command in @ref{OldDrafts}, for another way to redistribute messages.@node Old Drafts, , Redistributing, Sending Mail@subsection Editing Old Drafts and Bounced Messages@cindex re-editing drafts@cindex @file{draft}@cindex files, @file{draft}@findex @code{mh-edit-again}If you don't complete a draft for one reason or another, and if thedraft buffer is no longer available, you can pick your draft up againwith @kbd{M-a} (@code{mh-edit-again}). If you don't use a draft folder,your last @file{draft} file will be used. If you use draft folders,you'll need to visit the draft folder with @kbd{M-f drafts @key{RET}},use @kbd{n} to move to the appropriate message, and then use @kbd{M-a}to prepare the message for editing.The @kbd{M-a} command can also be used to take messages that were sentto you and to send them to more people.@cindex Mailer-Daemon@findex @code{mh-extract-rejected-mail}Don't use @kbd{M-a} to re-edit a message from a @i{Mailer-Daemon} whocomplained that your mail wasn't posted for some reason or another. Inthis case, use @kbd{M-e} (@code{mh-extract-rejected-mail}) to preparethe message for editing by removing the @i{Mailer-Daemon} envelope andunneeded header fields. Fix whatever addressing problem you had, andsend the message again with @kbd{C-c C-c}.@node Draft Editing, Moving Mail, Sending Mail, Using mh-e@section Editing a Draft@cindex editing draft@cindex MH-Letter mode@cindex modes, MH-LetterWhen you edit a message that you want to send (called a @dfn{draft} inthis case), the mode used is MH-Letter. This mode providesseveral commands in addition to the normal Emacs editing commands tohelp you edit your draft.@table @kbd@item C-c C-yInsert contents of message to which you're replying (@code{mh-yank-cur-msg}).@item C-c C-iInsert a message from a folder (@code{mh-insert-letter}).@item C-c C-f C-tMove to @samp{To:} header field (@code{mh-to-field}).@item C-c C-f C-cMove to @samp{cc:} header field (@code{mh-to-field}).@item C-c C-f C-sMove to @samp{Subject:} header field (@code{mh-to-field}).@item C-c C-f C-fMove to @samp{From:} header field (@code{mh-to-field}).@item C-c C-f C-bMove to @samp{Bcc:} header field (@code{mh-to-field}).@item C-c C-f C-fMove to @samp{Fcc:} header field (@code{mh-to-fcc}).@item C-c C-f C-dMove to @samp{Dcc:} header field (@code{mh-to-field}).@item C-c C-wDisplay expanded recipient list (@code{mh-check-whom}).@item C-c C-sInsert signature in message (@code{mh-insert-signature}).@item C-c C-m C-fInclude forwarded message (@sc{mime}) (@code{mh-mhn-compose-forw}).@item C-c C-m C-eInclude anonymous ftp reference (@sc{mime}) (@code{mh-mhn-compose-anon-ftp}).@item C-c C-m C-tInclude anonymous ftp reference to compressed tar file (@sc{mime})(@code{mh-mhn-compose-external-compressed-tar}).@item C-c C-m C-iInclude binary, image, sound, etc. (@sc{mime})(@code{mh-mhn-compose-insertion}).@item C-c C-eRun through @code{mhn} before sending (@code{mh-edit-mhn}).@item C-c C-m C-uUndo effects of @code{mhn} (@code{mh-revert-mhn-edit}).@item C-c C-cSave draft and send message (@code{mh-send-letter}).@item C-c C-qQuit editing and delete draft message (@code{mh-fully-kill-draft}).@end table@menu* Editing Textual::* Editing MIME::* Sending Message::* Killing Draft::@end menu@node Editing Textual, Editing MIME, Draft Editing, Draft Editing@subsection Editing Textual MessagesThe following sections show you how to edit a draft.The commands described here are also applicable to messages that havemultimedia components.@menu* Inserting Letter::* Inserting Messages::* Header::* Recipients::* Signature::@end menu@node Inserting Letter, Inserting Messages, Editing Textual, Editing Textual@subsubsection Inserting letter to which you're replying@cindex inserting messages@findex @code{mh-yank-cur-msg}It is often useful to insert a snippet of text from a letter thatsomeone mailed to provide some context for your reply. The command@kbd{C-c C-y} (@code{mh-yank-cur-msg}) does this by yanking a portion oftext from the message to which you're replying and inserting @samp{> }before each line.@cindex mark@cindex Emacs, mark@cindex point@cindex Emacs, point@cindex region@cindex Emacs, regionYou can control how much text is included when you run this command. Ifyou run this command right away, without entering the buffer containingthe message to you, this command will yank the entire message, as is,into your reply. @footnote{If you'd rather have the header cleaned up,use @kbd{C-u r} instead of @kbd{r} when replying (see @ref{Replying}).}If you enter the buffer containing the message sent to you and move thecursor to a certain point and return to your reply and run @kbd{C-cC-y}, then the text yanked will range from that point to the end of themessage. Finally, the most common action you'll perform is to enter themessage sent to you, move the cursor to the beginning of a paragraph orphrase, set the @dfn{mark} with @kbd{C-SPC} or @kbd{C-@@}, and move thecursor to the end of the paragraph or phrase. The cursor position iscalled the @dfn{point}, and the space between the mark and point iscalled the @dfn{region}. Having done that, @kbd{C-c C-y} will insertthe region you selected.@node Inserting Messages, Header, Inserting Letter, Editing Textual@subsubsection Inserting messages@cindex inserting messages@findex @code{mh-insert-letter}Messages can be inserted with @kbd{C-c C-i} (@code{mh-insert-letter}).This command prompts you for the folder and message number and insertsthe message, indented by @samp{> }. Certain undesirable header fieldsare removed before insertion. If given a prefix argument (like @kbd{C-uC-c C-i}), the header is left intact, the message is not indented, and@samp{> } is not inserted before each line.@node Header, Recipients, Inserting Messages, Editing Textual@subsubsection Editing the header@cindex editing header@findex @code{mh-to-field}Because the header is part of the message, you can edit the headerfields as you wish. However, several convenience functions exist tohelp you create and edit them. For example, the command @kbd{C-c C-fC-t} (@code{mh-to-field}; alternatively, @kbd{C-c C-f t}) moves thecursor to the @samp{To:} header field, creating it if necessary. Thefunctions to move to the @samp{cc:}, @samp{Subject:}, @samp{From:},@samp{Bcc:}, and @samp{Dcc:} header fields are similar.@findex @code{mh-to-fcc}One function behaves differently from the others, namely, @kbd{C-c C-fC-f} (@code{mh-to-fcc}; alternatively, @kbd{C-c C-f f}). This functionwill prompt you for the folder name in which to file a copy of the draft.Be sure to leave a row of dashes or a blank line between the header andthe body of the message.@node Recipients, Signature, Header, Editing Textual@subsubsection Checking recipients@cindex checking recipients@cindex @code{whom}@cindex MH commands, @code{whom}@findex @code{mh-check-whom}The @kbd{C-c C-w} (@code{mh-check-whom}) command expands aliases so youcan check the actual address(es) in the alias. A new buffer is createdwith the output of @code{whom}.@node Signature, , Recipients, Editing Textual@subsubsection Inserting your signature@cindex inserting signature@cindex signature@cindex @file{.signature}@cindex files, @file{.signature}@findex @code{mh-insert-signature}You can insert your signature at the current cursor location with the@kbd{C-c C-s} (@code{mh-insert-signature}) command. The text of yoursignature is taken from the file @file{~/.signature}.@node Editing MIME, Sending Message, Editing Textual, Draft Editing@subsection Editing Multimedia Messages@cindex MIME@cindex multimedia mail@cindex @code{mhn}@cindex MH commands, @code{mhn}mh-e has the capability to create multimedia messages. It uses the@sc{mime} (Multipurpose Internet Mail Extensions) protocol. The@sc{mime} protocol allows you to incorporate images, sound, video,binary files, and even commands that fetch a file with @samp{ftp} whenyour recipient reads the message! If you were to create a multimediamessage with plain MH commands, you would use @code{mhn}. Indeed, themh-e @sc{mime} commands merely insert @code{mhn} directives which arelater expanded by @code{mhn}.Each of the mh-e commands for editing multimedia messages or forincorporating multimedia objects is prefixed with @kbd{C-c C-m} .@cindex content types@cindex MIME, content typesSeveral @sc{mime} objects are defined. They are called @dfn{contenttypes}. The table in @ref{Customizing Draft Editing} contains a list ofthe content types that mh-e currently knows about. Several of the mh-ecommands fill in the content type for you, whereas others require you toenter one. Most of the time, it should be obvious which one to use(e.g., use @kbd{image/jpeg} to include a @sc{jpeg} image). If not, youcan refer to @sc{rfc} 1521,@c Footnotes are very fragile. Hence the duplication.@c The line break in the footnote was necessary since TeX wasn't creating one.@ifclear html@footnote{This @sc{rfc} (Request For Comments) isavailable via the @sc{url} @*@file{ftp://ds.internic.net/rfc/rfc1521.txt}.}@end ifclear@ifset html@footnote{This @sc{rfc} (Request For Comments) isavailable via the @sc{url} @*@file{<A HREF="ftp://ds.internic.net/rfc/rfc1521.txt">ftp://ds.internic.net/rfc/rfc1521.txt</A>}.}@end ifsetwhich defines the @sc{mime} protocol, for a list of valid content types.@cindex content description@cindex MIME, content descriptionYou are also sometimes asked for a @dfn{content description}. This issimply an optional brief phrase, in your own words, that describes theobject. If you don't care to enter a content description, just pressreturn and none will be included; however, a reader may skip overmultimedia fields unless the content description is compelling.Remember: you can always add @code{mhn} directives by hand.@menu* Forwarding MIME::* FTP::* Tar::* Other MIME Objects::* Sending MIME::@end menu@node Forwarding MIME, FTP, Editing MIME, Editing MIME@subsubsection Forwarding multimedia messages@findex @code{mh-mhn-compose-forw}Mail may be forwarded with @sc{mime} using the command @kbd{C-c C-m C-f}(@code{mh-mhn-compose-forw}). You are prompted for a contentdescription, the name of the folder in which the messages to forward arelocated, and the messages' numbers.@node FTP, Tar, Forwarding MIME, Editing MIME@subsubsection Including an ftp reference@cindex @code{ftp}@cindex Unix commands, @code{ftp}@cindex MIME, @code{ftp}@findex @code{mh-mhn-compose-anon-ftp}You can even have your message initiate an @code{ftp} transfer when therecipient reads the message. To do this, use the @kbd{C-c C-m C-e}(@code{mh-mhn-compose-anon-ftp}) command. You are prompted for theremote host and pathname, the content type, and the content description.@node Tar, Other MIME Objects, FTP, Editing MIME@subsubsection Including tar files@cindex @code{tar}@cindex Unix commands, @code{tar}@cindex MIME, @code{tar}@cindex @code{ftp}@cindex Unix commands, @code{ftp}@cindex MIME, @code{ftp}@findex @code{mh-mhn-compose-external-compressed-tar}If the remote file (@pxref{FTP}) is a compressed tar file, you can use@kbd{C-c C-m C-t} (@code{mh-mhn-compose-external-compressed-tar}).Then, in addition to retrieving the file via anonymous @emph{ftp}, thefile will also be uncompressed and untarred. You are prompted for theremote host and pathname and the content description. The pathnameshould contain at least one @samp{/} (slash), because the pathname isbroken up into directory and name components.@node Other MIME Objects, Sending MIME, Tar, Editing MIME@subsubsection Including other multimedia objects@cindex images@cindex MIME, images@cindex sound@cindex MIME, sound@cindex video@cindex MIME, video@findex @code{mh-mhn-compose-insertion}Images, sound, and video can be inserted in your message with the@kbd{C-c C-m C-i} (@code{mh-mhn-compose-insertion}) command. You areprompted for the filename containing the object, the content type, and acontent description of the object.@node Sending MIME, , Other MIME Objects, Editing MIME@subsubsection Readying multimedia messages for sendingWhen you are finished editing a @sc{mime} message, it might look like this:@example@group@cartouche 3 24Aug root received fax files on Wed Aug 24 11:00:13 4+ 24Aug To:wohler Test<<This is a test message to get the wh--%%-@{+inbox@} 4 msgs (1-4) (MH-Folder Show)--Bot-------------------To: wohlercc:Subject: Test of MIME--------#@@application/octet-stream [Nonexistent ftp test file] \access-type=anon-ftp; site=berzerk.com; name=panacea.tar.gz; \directory="/pub/"#audio/basic [Test sound bite] /tmp/noise.au--**-@{draft@} (MH-Letter)--All--------------------------------------@end cartouche@i{mh-e @sc{mime} draft}@end group@end example@cindex @code{mhn}@cindex MH commands, @code{mhn}@findex @code{mh-edit-mhn}The lines added by the previous commands are @code{mhn} directives andneed to be converted to @sc{mime} directives before sending. This isaccomplished by the command @kbd{C-c C-e} (@code{mh-edit-mhn}), whichruns @code{mhn} on the message. The following screen shows what thosecommands look like in full @sc{mime} format. You can see why mail useragents are usually built to hide these details from the user.@example@group@cartoucheTo: wohlercc:Subject: Test of MIMEMIME-Version: 1.0Content-Type: multipart/mixed; boundary="----- =_aaaaaaaaaa0"Content-ID: <1623.777796162.0@@newt.com>------- =_aaaaaaaaaa0Content-Type: message/external-body; access-type="anon-ftp"; site="berzerk.com"; name="panacea.tar.gz"; directory="/pub/"Content-Type: application/octet-streamContent-ID: <1623.777796162.1@@newt.com>Content-Description: Nonexistent ftp test file------- =_aaaaaaaaaa0Content-Type: audio/basicContent-ID: <1623.777796162.2@@newt.com>Content-Description: Test sound biteContent-Transfer-Encoding: base64Q3JlYXRpdmUgVm9pY2UgRmlsZRoaAAoBKREBQh8AgwCAgH9/f35+fn59fX5+fn5+f39/f39/f3f4B/f39/f39/f39/f39/f39+f39+f39/f39/f4B/f39/fn5/f39/f3+Af39/f39/gH9/f39/fn-----@{draft@} (MH-Letter)--Top--------------------------------------@end cartouche@i{mh-e @sc{mime} draft ready to send}@end group@end example@findex @code{mh-revert-mhn-edit}This action can be undone by running @kbd{C-c C-m C-u}(@code{mh-revert-mhn-edit}). It does this by reverting to a backupfile. You are prompted to confirm this action, but you can avoid theconfirmation by adding an argument (for example, @kbd{C-u C-c C-m C-u}).@node Sending Message, Killing Draft, Editing MIME, Draft Editing@subsection Sending a Message@cindex sending mail@findex @code{mh-send-letter}When you are all through editing a message, you send it with the@kbd{C-c C-c} (@code{mh-send-letter}) command. You can give an argument(as in @kbd{C-u C-c C-c}) to monitor the first stage of the delivery.@node Killing Draft, , Sending Message, Draft Editing@subsection Killing the Draft@cindex killing draft@findex @code{mh-fully-kill-draft}If for some reason you are not happy with the draft, you can kill itinstead with @kbd{C-c C-q} (@code{mh-fully-kill-draft}). Emacs thenkills the draft buffer and deletes the draft message.@node Moving Mail, Searching, Draft Editing, Using mh-e@section Moving Your Mail Around@cindex processing mailThis section covers how messages and folders can be moved about ormanipulated. Messages may be incorporated into your @file{+inbox},deleted, and refiled. Messages containing @code{shar} or@code{uuencode} output can be stored. Folders can be visited, sorted,packed, or deleted. Here's a list of the available commands to do thesethings:@c Stephen thinks that ? should be documented here, since it also shows@c which folders a message will be refiled to. XXX@table @kbd@item iIncorporate new mail into folder (@code{mh-inc-folder}).@item dDelete message (@code{mh-delete-msg}).@item C-dDelete message, don't move to next message (@code{mh-delete-msg-no-motion}).@item M-sFind messages that meet search criteria (@code{mh-search-folder}).@item oOutput (refile) message to folder (@code{mh-refile-msg}).@item cCopy message to folder (@code{mh-copy-msg}).@item C-oOutput (write) message to file (@code{mh-write-msg-to-file}).@item !Repeat last output command (@code{mh-refile-or-write-again}).@item lPrint message with @code{lpr} (@code{mh-print-msg}).@item |Pipe message through shell command (@code{mh-pipe-msg}).@item M-nUnpack message created with @code{uudecode} or @code{shar}(@code{mh-store-msg}).@item M-lList all folders (@code{mh-list-folders}).@item M-fVisit folder (@code{mh-visit-folder}).@item M-rRegenerate scan lines (@code{mh-rescan-folder}).@item M-x mh-sort-folderSort folder.@item M-pPack folder (@code{mh-pack-folder}).@item M-kRemove folder (@code{mh-kill-folder}).@item xExecute pending refiles and deletes (@code{mh-execute-commands}).@item uUndo pending refile or delete (@code{mh-undo}).@item M-uUndo all pending refiles and deletes (@code{mh-undo-folder}).@item qQuit (@code{mh-quit}).@end table@menu* Incorporating::* Deleting::* Organizing::* Printing::* Files and Pipes::* Finishing Up::@end menu@node Incorporating, Deleting, Moving Mail, Moving Mail@subsection Incorporating Your Mail@cindex incorporating@findex @code{mh-inc-folder}If at any time you receive new mail, incorporate the new mail into your@samp{+inbox} buffer with @kbd{i} (@code{mh-inc-folder}). Note that@kbd{i} will display the @samp{+inbox} buffer, even if there isn't anynew mail. You can incorporate mail from any file into the currentfolder by specifying a prefix argument; you'll be prompted for the nameof the file to use (for example, @kbd{C-u i ~/mbox @key{RET}}).@cindex Emacs, notification of new mail@cindex notification of new mail@cindex new mail@cindex @file{.emacs}@cindex files, @file{.emacs}Emacs can notify you when you have new mail by displaying @samp{Mail} inthe mode line. To enable this behavior, and to have a clock in the modeline besides, add the following to @file{~/.emacs}:@findex @code{display-time}@lisp(display-time)@end lisp@node Deleting, Organizing, Incorporating, Moving Mail@subsection Deleting Your Mail@cindex deleting@findex @code{mh-delete-msg}@findex @code{mh-delete-msg-no-motion}To mark a message for deletion, use the @kbd{d} (@code{mh-delete-msg})command. A @samp{D} is placed by the message in the scan window, andthe next message is displayed. If the previous command had been@kbd{p}, then the next message displayed is the message previous to themessage just deleted. If you specify a prefix argument, you will beprompted for a sequence (@pxref{Sequences}) to delete (for example,@kbd{C-u d frombob RET}). The @kbd{x} command actually carries out thedeletion (@pxref{Finishing Up}). @kbd{C-d}(@code{mh-delete-msg-no-motion}) marks the message for deletion butleaves the cursor at the current message in case you wish to performother operations on the message.@node Organizing, Printing, Deleting, Moving Mail@subsection Organizing Your Mail with Folders@cindex using folders@cindex @code{folder}@cindex MH commands, @code{folder}@cindex @code{refile}@cindex MH commands, @code{refile}@findex @code{mh-refile-msg}mh-e has analogies for each of the MH @code{folder} and @code{refile}commands. To refile a message in another folder, use the @kbd{o}(@code{mh-refile-msg}) (mnemonic: ``output'') command. You are promptedfor the folder name.@findex @code{mh-refile-or-write-again}If you are refiling several messages into the same folder, you can usethe @kbd{!} (@code{mh-refile-or-write-again}) command to repeat the lastrefile or write (see the description of @kbd{C-o} in @ref{Files andPipes}). Or, place the messages into a sequence (@ref{Sequences}) andspecify a prefix argument to @kbd{o}, in which case you'll be promptedfor the name of the sequence (for example, @kbd{C-u o search RET}).@findex @code{mh-copy-msg}If you wish to copy a message to another folder, you can use the @kbd{c}(@code{mh-copy-msg}) command (see the @code{-link} argument to@code{refile}(1)). You are prompted for a folder, and you can specify aprefix argument if you want to copy a sequence into another folder. Inthis case, you are then prompted for the sequence. Note that unlike the@kbd{o} command, the copy takes place immediately. The original copyremains in the current folder.@findex @code{mh-visit-folder}When you want to read the messages that you have refiled into folders,use the @kbd{M-f} (@code{mh-visit-folder}) command to visit the folder.You are prompted for the folder name.@findex @code{mh-list-folders}@findex @code{mh-kill-folder}@findex @code{mh-visit-folder}@findex @code{mh-sort-folder}@findex @code{mh-pack-folder}@findex @code{mh-rescan-folder}Other commands you can perform on folders include: @kbd{M-l}(@code{mh-list-folders}), to list all the folders in your maildirectory; @kbd{M-k} (@code{mh-kill-folder}), to remove a folder;@kbd{M-x mh-sort-folder}, to sort the messages by date (see@code{sortm}(1) to see how to sort by other criteria); @kbd{M-p}(@code{mh-pack-folder}), to pack a folder, removing gaps from thenumbering sequence; and @kbd{M-r} (@code{mh-rescan-folder}), to rescanthe folder, which is useful to grab all messages in your @file{+inbox}after processing your new mail for the first time. If you don't want torescan the entire folder, give @kbd{M-r} or @kbd{M-p} a prefix argumentand you'll be prompted for a range of messages to display (for instance,@kbd{C-u M-r last:50 RET}).@node Printing, Files and Pipes, Organizing, Moving Mail@subsection Printing Your Mail@cindex printing@cindex @code{mhl}@cindex MH commands, @code{mhl}@cindex @code{lpr}@cindex Unix commands, @code{lpr}@findex @code{mh-print-msg}Printing mail is simple. Enter @kbd{l} (@code{mh-print-msg}) (for@i{l}ine printer or @i{l}pr). The message is formatted with @code{mhl}and printed with the @code{lpr} command. You can print all the messagesin a sequence by specifying a prefix argument, in which case you areprompted for the name of the sequence (as in @kbd{C-u l frombob RET}).@node Files and Pipes, Finishing Up, Printing, Moving Mail@subsection Files and Pipes@cindex using files@cindex using pipes@findex @code{mh-write-msg-to-file}mh-e does offer a couple of commands that are not a part of MH@. Thefirst one, @kbd{C-o} (@code{mh-write-msg-to-file}), writes a message toa file (think of the @kbd{o} as in "output"). You are prompted for thefilename. If the file already exists, the message is appended to it.You can also write the message to the file without the header byspecifying a prefix argument (such as @kbd{C-u C-o /tmp/foobar RET}).Subsequent writes to the same file can be made with the @kbd{!}command.@findex @code{mh-pipe-msg}You can also pipe the message through a Unix shell command with the@kbd{|} (@code{mh-pipe-msg}) command. You are prompted for theUnix command through which you wish to run your message. If yougive an argument to this command, the message header is included in thetext passed to the command (the contrived example @kbd{C-u | lpr}would be done with the @kbd{l} command instead).@cindex @code{shar}@cindex Unix commands, @code{shar}@cindex @code{uuencode}@cindex Unix commands, @code{uuencode}@findex @code{mh-store-msg}If the message is a shell archive @code{shar} or has been run through@code{uuencode} use @kbd{M-n} (@code{mh-store-msg}) to extract the bodyof the message. The default directory for extraction is the currentdirectory, and you have a chance to specify a different extractiondirectory. The next time you use this command, the default directory isthe last directory you used.@node Finishing Up, , Files and Pipes, Moving Mail@subsection Finishing Up@cindex expunging refiles and deletes@findex @code{mh-undo}@findex @code{mh-undo-folder}If you've deleted a message or refiled it, but changed your mind, youcan cancel the action before you've executed it. Use @kbd{u}(@code{mh-undo}) to undo a refile on or deletion of a single message.You can also undo refiles and deletes for messages that belong to agiven sequence by specifying a prefix argument. You'll be prompted forthe name of the sequence (as in @kbd{C-u u frombob RET}).Alternatively, you can use @kbd{M-u} (@code{mh-undo-folder}) to undo allrefiles or deletes in the current folder.@findex @code{mh-execute-commands}If you've marked messages to be deleted or refiled and you want to goahead and delete or refile the messages, use @kbd{x}(@code{mh-execute-commands}). Many mh-e commands that may affect thenumbering of the messages (such as @kbd{M-r} or @kbd{M-p}) will ask if youwant to process refiles or deletes first and then either run @kbd{x} foryou or undo the pending refiles and deletes, which are lost.@findex @code{mh-rmail}@findex @code{mh-quit}When you want to quit using mh-e and go back to editing, you can use the@kbd{q} (@code{mh-quit}) command. This buries the buffers of thecurrent mh-e folder and restores the buffers that were present when youfirst ran @kbd{M-x mh-rmail}. You can later restore your mh-e sessionby selecting the @samp{+inbox} buffer or by running @kbd{M-x mh-rmail}again.@node Searching, Sequences, Moving Mail, Using mh-e@section Searching Through Messages@cindex searching@findex @code{mh-search-folder}You can search a folder for messages to or from a particular person orabout a particular subject. In fact, you can also search for messagescontaining selected strings in any arbitrary header field or any stringfound within the messages. Use the @kbd{M-s} (@code{mh-search-folder})command. You are first prompted for the name of the folder to searchand then placed in the following buffer in MH-Pick mode:@example@group@cartoucheFrom: #To:Cc:Date:Subject:----------**-Emacs: pick-pattern (MH-Pick)------All--------------------------@end cartouche@i{Pick window}@end group@end example@cindex @code{pick}@cindex MH commands, @code{pick}Edit this template by entering your search criteria in an appropriateheader field that is already there, or create a new field yourself. Ifthe string you're looking for could be anywhere in a message, then placethe string underneath the row of dashes. The @kbd{M-s} command uses theMH command @code{pick} to do the real work, so read @code{pick}(1) tofind out more about how to enter the criteria.There are no semantics associated with the search criteria---they aresimply treated as strings. Case is ignored when all lowercase is used,and regular expressions (a la @code{ed}) are available. It is all rightto specify several search criteria. What happens then is that a logical@emph{and} of the various fields is performed. If you prefer a logical@emph{or} operation, run @kbd{M-s} multiple times.As an example, let's say that we want to find messages from Ginneanabout horseback riding in the Kosciusko National Park (Australia) duringJanuary, 1994. Normally we would start with a broad search and narrowit down if necessary to produce a manageable amount of data, but we'llcut to the chase and create a fairly restrictive set of criteria asfollows:@example@groupFrom: ginneanTo:Cc:Date: Jan 1994Subject: horse.*kosciusko--------@end group@end example@findex @code{mh-to-field}As with MH-Letter mode, MH-Pick provides commands like@kbd{C-c C-f C-t} to help you fill in the blanks.@table @kbd@item C-c C-f C-tMove to @samp{To:} header field (@code{mh-to-field}).@item C-c C-f C-cMove to @samp{cc:} header field (@code{mh-to-field}).@item C-c C-f C-sMove to @samp{Subject:} header field (@code{mh-to-field}).@item C-c C-f C-fMove to @samp{From:} header field (@code{mh-to-field}).@item C-c C-f C-bMove to @samp{Bcc:} header field (@code{mh-to-field}).@item C-c C-f C-fMove to @samp{Fcc:} header field (@code{mh-to-field}).@item C-c C-f C-dMove to @samp{Dcc:} header field (@code{mh-to-field}).@item C-c C-cExecute the search (@code{mh-do-pick-search}).@end table@findex @code{mh-do-pick-search}To perform the search, type @kbd{C-c C-c} (@code{mh-do-pick-search}).The selected messages are placed in the @i{search} sequence, which youcan use later in forwarding (@pxref{Forwarding}), printing(@pxref{Printing}), or narrowing your field of view (@pxref{Sequences}).Subsequent searches are appended to the @i{search} sequence. If,however, you wish to start with a clean slate, first delete the@i{search} sequence (how to do this is discussed in @ref{Sequences}).@cindex MH-Folder mode@cindex modes, MH-FolderIf you're searching in a folder that is already displayed in aMH-Folder buffer, only those messages contained in the buffer areused for the search. Therefore, if you want to search in all messages,first kill the folder's buffer with @kbd{C-x k} or scan the entirefolder with @kbd{M-r}.@node Sequences, Miscellaneous, Searching, Using mh-e@section Using Sequences@cindex sequencesFor the whole scoop on MH sequences, refer to @code{mh-sequence}(5). Asyou've read, several of the mh-e commands can operate on a sequence,which is a shorthand for a range or group of messages. For example, youmight want to forward several messages to a friend or colleague. Here'show to manipulate sequences.@table @kbd@item %Put message in a sequence (@code{mh-put-msg-in-seq}).@item ?Display sequences that message belongs to (@code{mh-msg-is-in-seq}).@item M-qList all sequences in folder (@code{mh-list-sequences}).@item M-%Remove message from sequence (@code{mh-delete-msg-from-seq}).@item M-#Delete sequence (@code{mh-delete-seq}).@item C-x nRestrict display to messages in sequence (@code{mh-narrow-to-seq}).@item C-x wRemove restriction; display all messages (@code{mh-widen}).@item M-x mh-update-sequencesPush mh-e's state out to MH@.@end table@cindex @code{pick}@cindex MH commands, @code{pick}@findex @code{mh-put-msg-in-seq}To place a message in a sequence, use @kbd{%} (@code{mh-put-msg-in-seq})to do it manually, or use the MH command @code{pick} or the mh-e versionof @code{pick} (@ref{Searching}) which create a sequence automatically.Give @kbd{%} a prefix argument and you can add all the messages in onesequence to another sequence (for example, @kbd{C-u % SourceSequenceRET}).@cindex MH-Folder mode@cindex modes, MH-Folder@findex @code{mh-narrow-to-seq}@findex @code{mh-widen}Once you've placed some messages in a sequence, you may wish to narrowthe field of view to just those messages in the sequence you've created.To do this, use @kbd{C-x n} (@code{mh-narrow-to-seq}). You are promptedfor the name of the sequence. What this does is show only thosemessages that are in the selected sequence in the MH-Folder buffer. Inaddition, it limits further mh-e searches to just those messages. Whenyou want to widen the view to all your messages again, use @kbd{C-x w}(@code{mh-widen}).@findex @code{mh-msg-is-in-seq}@findex @code{mh-list-sequences}You can see which sequences a message is in with the @kbd{?}(@code{mh-msg-is-in-seq}) command.@c Doesn't work:@c use a prefix argument to query a@c message other than the current one (as in @kbd{C-u ? 42 RET}). XXXOr, you can list all sequences in a selected folder (default is currentfolder) with @kbd{M-q} (@code{mh-list-sequences}).@findex @code{mh-delete-msg-from-seq}@findex @code{mh-delete-seq}If you want to remove a message from a sequence, use @kbd{M-%}(@code{mh-delete-msg-from-seq}), and if you want to delete an entiresequence, use @kbd{M-#} (@code{mh-delete-seq}). In the latter case youare prompted for the sequence to delete. Note that this deletes onlythe sequence, not the messages in the sequence. If you want to deletethe messages, use @kbd{C-u d} (see @ref{Deleting} above).@cindex @code{mark}@cindex MH commands, @code{mark}@findex @code{mh-update-sequences}Two sequences are maintained internally by mh-e and pushed out to MHwhen you type either the @kbd{x} or @kbd{q} command. They are thesequence specified by your @samp{Unseen-Sequence:} profile entry and@i{cur}. However, you can also just update MH's state with the command@kbd{M-x mh-update-sequences}. See @ref{Customizing Viewing} for anexample of how this command might be used.With the exceptions of @kbd{C-x n} and @kbd{C-x w}, the underlying MHcommand dealing with sequences is @code{mark}.@node Miscellaneous, , Sequences, Using mh-e@section Miscellaneous Commands@findex @code{mh-version}One other command worth noting is @kbd{M-x mh-version}. You cancompare the version this command prints to the latest release(@pxref{Getting mh-e}). The output of @kbd{M-x mh-version} shouldalways be included with any bug report you submit (@pxref{Bug Reports}).@node Customizing mh-e, Odds and Ends, Using mh-e, Top@chapter Customizing mh-eUntil now, we've talked about the mh-e commands as they work ``out of thebox.'' Of course, it is also possible to reconfigure mh-eto fit the needs of even the most demanding user.The following sections describe all of thecustomization variables, show the defaults, and make recommendations forcustomization. The outline of this chapter is identical to that of@ref{Using mh-e}, to make it easier to find the variables you'd need tomodify to affect a particular command.However, when customizing your mail environment, first try to changewhat you want in MH, and only change mh-e if changing MH is notpossible. That way you will get the same behavior inside and outsideGNU Emacs. Note that mh-e does not provide hooks for customizationsthat can be done in MH; this omission is intentional.@cindex @file{.emacs}@cindex files, @file{.emacs}Many string or integer variables are easy enough to modify using EmacsLisp. Any such modifications should be placed in a file called@file{.emacs} in your home directory (that is, @file{~/.emacs}). Forexample, to modify the variable that controls printing, you could add:@vindex @code{mh-lpr-command-format}, example@lisp(setq mh-lpr-command-format "nenscript -G -r -2 -i'%s'")@end lisp@ref{Customizing Printing} talks more about this variable.@cindex setting variables@cindex Emacs, setting variablesVariables can also hold Boolean values. In Emacs Lisp, the Booleanvalues are @code{nil}, which means false, and @code{t}, which means true.Usually, variables are turned off by setting their value to @code{nil}, asin@vindex @code{mh-bury-show-buffer}, example@lisp(setq mh-bury-show-buffer nil)@end lispwhich keeps the MH-Show buffer at the top of the buffer stack.To turn a variable on, you use@lisp(setq mh-bury-show-buffer t)@end lispwhich places the MH-Show buffer at the bottom of the bufferstack. However, the text says to turn on a variable by setting it to a@emph{non-@code{nil}} value, because sometimes values other than @code{t} aremeaningful (for example, see @code{mhl-formfile}, described in@ref{Customizing Viewing}). Other variables, such as hooks, involve alittle more Emacs Lisp programming expertise.You can also ``preview'' the effects of changing variables beforecommitting the changes to @file{~/.emacs}. Variables can be changed inthe current Emacs session by using @kbd{M-x set-variable}.@c XXX Stephen says: would be easier to just call them functions, which@c you mostly do.In general, @dfn{commands} in this text refer to Emacs Lisp functions.Programs outside of Emacs are specifically called MH commands, shellcommands, or Unix commands.@cindex Emacs, Emacs Lisp manual@cindex Emacs, online help@cindex online help@cindex Emacs, info@cindex infoI hope I've included enough examples here to get you well on your way.If you want to explore Emacs Lisp further, a programming manual doesexist,@c Yes, some of the stuff in the following sections is redundant, but@c TeX barfs if the @ifs are inside the @footnote.@iftex@footnote{The @cite{GNU Emacs Lisp Reference Manual} may be availableonline in the Info system by typing @kbd{C-h i m Emacs Lisp RET}. Ifnot, you can order a printed manual, which has the desirable side-effectof helping to support the Free Software Foundation which made all thisgreat software available. You can find an order form by running@kbd{C-h C-d}, or you can request an order form from@i{gnu@@gnu.org}.}@end iftex@ifinfo@footnote{Perhaps you can find the online version of @ref{Top, The GNUEmacs Lisp Reference Manual, , elisp, GNU Emacs Lisp Reference Manual}.If not, you can order a printed manual, which has the desirableside-effect of helping to support the Free Software Foundation whichmade all this great software available. You can find an order form byrunning @kbd{C-h C-d}, or you can request an order form from@i{gnu@@gnu.org}.}@end ifinfoand you can look at the code itself for examples. Look in the EmacsLisp directory on your system (such as @file{/usr/local/lib/emacs/lisp})and find all the @file{mh-*.el} files there. When calling mh-e andother Emacs Lisp functions directly from Emacs Lisp code, you'll need toknow the correct arguments. Use the online help for this. For example,try @kbd{C-h f mh-execute-commands RET}. If you write your ownfunctions, please do not prefix your symbols (variables and functions)with @code{mh-}. This prefix is reserved for the mh-e package. Toavoid conflicts with existing mh-e symbols, use a prefix like @code{my-}or your initials.@menu* Customizing Reading::* Customizing Sending::* Customizing Draft Editing::* Customizing Moving Mail::* Customizing Searching::@end menu@node Customizing Reading, Customizing Sending, Customizing mh-e, Customizing mh-e@section Reading Your Mail@cindex reading mail@cindex @file{.emacs}@cindex files, @file{.emacs}I'll start out by including a function that I use as a front end tomh-e. @footnote{Stephen Gildea's favorite binding is@kbd{(global-set-key "\C-cr" 'mh-rmail)}.} It toggles between yourworking window configuration, which may be quite involved---windowsfilled with source, compilation output, man pages, and otherdocumentation---and your mh-e window configuration. Like the rest ofthe customization described in this chapter, simply add the followingcode to @file{~/.emacs}. Don't be intimidated by the size of thisexample; most customizations are only one line.@iftex@filbreak@end iftex@findex @code{mh-rmail}, example@lisp@group@i{Starting mh-e}(defvar my-mh-screen-saved nil "Set to non-@code{nil} when mh-e window configuration shown.")(defvar my-normal-screen nil "Normal window configuration.")(defvar my-mh-screen nil "mh-e window configuration.")(defun my-mh-rmail (&optional arg) "Toggle between mh-e and normal screen configurations.With non-@code{nil} or prefix argument, @i{inc} mailbox as wellwhen going into mail." (interactive "P") ; @r{user callable function, P=prefix arg} (setq my-mh-screen-saved ; @r{save state} (cond ;; @r{Bring up mh-e screen if arg or normal window configuration.} ;; @r{If arg or +inbox buffer doesn't exist, run mh-rmail.} ((or arg (null my-mh-screen-saved)) (setq my-normal-screen (current-window-configuration)) (if (or arg (null (get-buffer "+inbox"))) (mh-rmail) (set-window-configuration my-mh-screen)) t) ; @r{set my-mh-screen-saved to @code{t}} ;; @r{Otherwise, save mh-e screen and restore normal screen.} (t (setq my-mh-screen (current-window-configuration)) (set-window-configuration my-normal-screen) nil)))) ; @r{set my-mh-screen-saved to nil}(global-set-key "\C-x\r" 'my-mh-rmail) ;@r{ call with C-x RET}@end group@end lispIf you type an argument (@kbd{C-u}) or if @code{my-mh-screen-saved}is @code{nil} (meaning a non-mh-e window configuration), the current windowconfiguration is saved, either +inbox is displayed or @code{mh-rmail} isrun, and the mh-e window configuration is shown. Otherwise, the mh-ewindow configuration is saved and the original configuration isdisplayed.Now to configure mh-e. The following table lists general mh-e variablesand variables that are used while reading mail.@c XXX Seth wishes the descriptions to be more parallel. That is,@c some are actions, and some are objects. Hmmm.@table @code@item mh-progsDirectory containing MH programs (default: dynamic).@item mh-libDirectory containing MH support files and programs (default: dynamic).@item mh-do-not-confirmDon't confirm on non-reversible commands (default: @code{nil}).@item mh-summary-heightNumber of scan lines to show (includes mode line) (default: 4).@item mh-folder-mode-hookFunctions to run in MH-Folder mode (default: @code{nil}).@item mh-clean-message-headerRemove extraneous headers (default: @code{nil}).@item mh-invisible-headersHeaders to hide (default: @samp{"^Received: \\| ^Message-Id: \\|^Remailed-\\| ^Via: \\| ^Mail-from: \\| ^Return-Path: \\| ^In-Reply-To:\\| ^Resent-"}).@item mh-visible-headersHeaders to display (default: @code{nil}).@item mhl-formfileFormat file for @code{mhl} (default: @code{nil}).@item mh-show-hookFunctions to run when showing message (default: @code{nil}).@item mh-show-mode-hookFunctions to run when showing message (default: @code{nil}).@item mh-bury-show-bufferLeave show buffer at bottom of stack (default: @code{t}).@item mh-show-buffer-mode-line-buffer-idName of show buffer in mode line (default: @samp{"@{show-%s@} %d"}).@end table@vindex @code{mh-progs}@vindex @code{mh-lib}The two variables @code{mh-progs} and @code{mh-lib} are used to tellmh-e where the MH programs and supporting files are kept, respectively.mh-e does try to figure out where they are kept for itself by looking incommon places and in the user's @samp{PATH} environment variable, but ifit cannot find the directories, or finds the wrong ones, you should setthese variables. The name of the directory should be placed in doublequotes, and there should be atrailing slash (@samp{/}). See the example in @ref{Getting Started}.@vindex @code{mh-do-not-confirm}@findex @code{mh-kill-folder}If you never make mistakes, and you do not like confirmations for youractions, you can set @code{mh-do-not-confirm} to a non-@code{nil} value todisable confirmation for unrecoverable commands such as @kbd{M-k}(@code{mh-kill-folder}) and @kbd{M-u} (@code{mh-undo-folder}). Here'show you set boolean values:@lisp(setq mh-do-not-confirm t)@end lisp@vindex @code{mh-summary-height}@cindex MH-Folder mode@cindex modes, MH-Folder@c Prevent page break between paragraph and example.@need 2000The variable @code{mh-summary-height} controls the number of scan linesdisplayed in the MH-Folder window, including the mode line. Thedefault value of 4 means that 3 scan lines are displayed. Here's howyou set numerical values:@lisp(setq mh-summary-height 2) ; @r{only show the current scan line}@end lisp@vindex @code{mh-bury-show-buffer}@cindex MH-Folder mode@cindex modes, MH-FolderNormally the buffer for displaying messages is buried at the bottom atthe buffer stack. You may wish to disable this feature by setting@code{mh-bury-show-buffer} to @code{nil}. One advantage of not burying theshow buffer is that one can delete the show buffer more easily in anelectric buffer list because of its proximity to its associatedMH-Folder buffer. Try running @kbd{M-x electric-buffer-list} tosee what I mean.@vindex @code{mh-folder-mode-hook}@cindex MH-Folder mode@cindex modes, MH-FolderThe hook @code{mh-folder-mode-hook} is called when a new folder iscreated with MH-Folder mode. This could be used to set your ownkey bindings, for example:@vindex @code{mh-folder-mode-hook}, example@lisp@group@i{Create additional key bindings via mh-folder-mode-hook}(defvar my-mh-init-done nil "Non-@code{nil} when one-time mh-e settings made.")(defun my-mh-folder-mode-hook () "Hook to set key bindings in MH-Folder mode." (if (not my-mh-init-done) ; @r{only need to bind the keys once } (progn (local-set-key "/" 'search-msg) (local-set-key "b" 'mh-burst-digest) ; @r{better use of @kbd{b}} (setq my-mh-init-done t))));;; @r{Emacs 19}(add-hook 'mh-folder-mode-hook 'my-mh-folder-mode-hook);;; @r{Emacs 18};;; @r{(setq mh-folder-mode-hook (cons 'my-mh-folder-mode-hook};;; @r{mh-folder-mode-hook))}(defun search-msg () "Search for a regexp in the current message." (interactive) ; @r{user function} (save-window-excursion (other-window 1) ; @r{go to next window} (isearch-forward-regexp))) ; @r{string search; hit return (ESC} ; @r{in Emacs 18) when done}@end group@end lisp@menu* Customizing Viewing::* Customizing Moving Around::@end menu@node Customizing Viewing, Customizing Moving Around, Customizing Reading, Customizing Reading@subsection Viewing Your Mail@vindex @code{mh-clean-message-header}@vindex @code{mh-invisible-headers}@vindex @code{mh-visible-headers}Several variables control what displayed messages look like. Normallymessages are delivered with a handful of uninteresting header fields.You can make them go away by setting @code{mh-clean-message-header} to anon-@code{nil} value. The header can then be cleaned up in two ways. Bydefault, the header fields in @code{mh-invisible-headers} are removed.On the other hand, you could set @code{mh-visible-headers} to the fieldsthat you would like to see. If this variable is set,@code{mh-invisible-headers} is ignored. I suggest that you not set@code{mh-visible-headers} since if you use this variable, you might missa lot of header fields that you'd rather not miss. As an example of howto set a string variable, @code{mh-visible-headers} can be set to show aminimum set of header fields (see (@ref{Regexps, , Syntax of RegularExpressions, emacs, The GNU Emacs Manual}, for a description of thespecial characters in this string):@lisp(setq mh-visible-headers "^From: \\|^Subject: \\|^Date: ")@end lisp@cindex @code{mhl}@cindex MH commands, @code{mhl}@vindex @code{mhl-formfile}Normally mh-e takes care of displaying messages itself (rather thancalling an MH program to do the work). If you'd rather have @code{mhl}display the message (within mh-e), set the variable @code{mhl-formfile}to a non-@code{nil} value. You can set this variable either to @code{t}to use the default format file or to a filename if you have your ownformat file (@code{mhl}(1) tells you how to write one). When writingyour own format file, use a nonzero value for @code{overflowoffset} toensure the header is RFC 822 compliant and parsable by mh-e.@code{mhl} is always used for printing and forwarding; in this case, thevalue of @code{mhl-formfile} is consulted if it is a filename.@vindex @code{mh-show-mode-hook}Two hooks can be used to control how messages are displayed. The firsthook, @code{mh-show-mode-hook}, is called early on in the process ofdisplaying of messages. It is used to perform some actions on thecontents of messages, such as highlighting the header fields. If you'rerunning Emacs 19 under the X Window System, the following example willhighlight the @samp{From:} and @samp{Subject:} header fields. This is avery nice feature indeed.@vindex @code{mh-show-mode-hook}, example@lisp@group@i{Emphasize header fields in different fonts via mh-show-mode-hook}(defvar my-mh-keywords '(("^From: \\(.*\\)" 1 'bold t) ("^Subject: \\(.*\\)" 1 'highlight t)) "mh-e additions for font-lock-keywords.")(defun my-mh-show-mode-hook () "Hook to turn on and customize fonts." (font-lock-add-keywords nil my-mh-keywords))(add-hook 'mh-show-mode-hook 'my-mh-show-mode-hook))@end group@end lisp@vindex @code{mh-show-hook}The second hook, @code{mh-show-hook}, is the last thing called aftermessages are displayed. It's used to affect the behavior of mh-e ingeneral or when @code{mh-show-mode-hook} is too early. For example, ifyou wanted to keep mh-e in sync with MH, you could use@code{mh-show-hook} as follows:@vindex @code{mh-show-hook}, example@lisp(add-hook 'mh-show-hook 'mh-update-sequences)@end lisp@vindex @code{mh-show-buffer-mode-line-buffer-id}@cindex MH-Show mode@cindex modes, MH-ShowThe function @code{mh-update-sequences} is documented in @ref{FinishingUp}. For those who like to modify their mode lines, use@code{mh-show-buffer-mode-line-buffer-id} to modify the mode line in theMH-Show buffers. Place the two escape strings @samp{%s} and @samp{%d},which will display the folder name and the message number, respectively,somewhere in the string in that order. The default value of@samp{"@{show-%s@} %d"} yields a mode line of@example-----@{show-+inbox@} 4 (MH-Show)--Bot--------------------------------@end example@node Customizing Moving Around, , Customizing Viewing, Customizing Reading@subsection Moving Around@cindex moving between messages@cindex MH-Show mode@cindex modes, MH-Show@cindex MH-Folder mode@cindex modes, MH-Folder@vindex @code{mh-recenter-summary-p}When you use @kbd{t} (@code{mh-toggle-showing}) to toggle between showmode and scan mode, the MH-Show buffer is hidden and theMH-Folder buffer is left alone. Setting@code{mh-recenter-summary-p} to a non-@code{nil} value causes the toggle todisplay as many scan lines as possible, with the cursor at the middle.The effect of @code{mh-recenter-summary-p} is rather useful, but it canbe annoying on a slow network connection.@node Customizing Sending, Customizing Draft Editing, Customizing Reading, Customizing mh-e@section Sending Mail@cindex sending mailYou may wish to start off by adding the following useful key bindings toyour @file{.emacs} file:@lisp(global-set-key "\C-xm" 'mh-smail)(global-set-key "\C-x4m" 'mh-smail-other-window)@end lispIn addition, several variables are useful when sending mail or replyingto mail. They are summarized in the following table.@table @code@item mh-comp-formfileFormat file for drafts (default: @samp{"components"}).@item mh-repl-formfileFormat file for replies (default: @samp{"replcomps"}).@item mh-letter-mode-hookFunctions to run in MH-Letter mode (default: @code{nil}).@item mh-compose-letter-functionFunctions to run when starting a new draft (default: @code{nil}).@item mh-reply-default-reply-toWhom reply goes to (default: @code{nil}).@item mh-forward-subject-formatFormat string for forwarded message subject (default: @samp{"%s: %s"}).@item mh-redist-full-contents@code{send} requires entire message (default: @code{nil}).@item mh-new-draft-cleaned-headersRemove these header fields from re-edited draft. The default is:@example"^Date:\\| ^Received:\\| ^Message-Id:\\| ^From:\\|^Sender:\\| ^Delivery-Date:\\| ^Return-Path:".@end example@end table@cindex @code{comp}@cindex MH commands, @code{comp}@vindex @code{mh-comp-formfile}@cindex @file{components}@cindex files, @file{components}@cindex @code{repl}@cindex MH commands, @code{repl}@cindex @file{replcomps}@cindex files, @file{replcomps}@vindex @code{mh-repl-formfile}Since mh-e does not use @code{comp} to create the initial draft, youneed to set @code{mh-comp-formfile} to the name of your components fileif it isn't @file{components}. This is the name of the file thatcontains the form for composing messages. If it does not contain anabsolute pathname, mh-e searches for the file first in your MH directoryand then in the system MH library directory (such as@file{/usr/local/lib/mh}). Replies, on the other hand, are built using@code{repl}. You can change the location of the field file from thedefault of @file{replcomps} by modifying @code{mh-repl-formfile}.@vindex @code{mh-letter-mode-hook}@cindex @code{repl}@cindex MH commands, @code{repl}@cindex @file{components}@cindex files, @file{components}Two hooks are provided to run commands on your freshly created draft.The first hook, @code{mh-letter-mode-hook}, allows you to do someprocessing before editing a letter. For example, you may wish to modifythe header after @code{repl} has done its work, or you may have acomplicated @file{components} file and need to tell mh-e where thecursor should go. Here's an example of how you would use this hook---allof the other hooks are set in this fashion as well.@findex @code{mh-insert-signature}, example@lisp@group@i{Prepare draft for editing via mh-letter-mode-hook}(defvar letter-mode-init-done nil "Non-@code{nil} when one-time mh-e settings have made.")(defun my-mh-letter-mode-hook () "Hook to prepare letter for editing." (if (not letter-mode-init-done) ; @r{only need to bind the keys once} (progn (local-set-key "\C-ctb" 'add-enriched-text) (local-set-key "\C-cti" 'add-enriched-text) (local-set-key "\C-ctf" 'add-enriched-text) (local-set-key "\C-cts" 'add-enriched-text) (local-set-key "\C-ctB" 'add-enriched-text) (local-set-key "\C-ctu" 'add-enriched-text) (local-set-key "\C-ctc" 'add-enriched-text) (setq letter-mode-init-done t))) (setq fill-prefix " ") ; @r{I find indented text easier to read} (save-excursion (goto-char (point-max)) ; @r{go to end of message to} (mh-insert-signature))) ; @r{insert signature}(add-hook 'mh-letter-mode-hook 'my-mh-letter-mode-hook)@end group@end lispThe function, @code{add-enriched-text} is defined in the example in@ref{Customizing Editing MIME}.@vindex @code{mh-compose-letter-function}The second hook, a function really, is@code{mh-compose-letter-function}. Like @code{mh-letter-mode-hook}, itis called just before editing a new message; however, it is the lastfunction called before you edit your message. The consequence of thisis that you can write a function to write and send the message for you.This function is passed three arguments: the contents of the @samp{To:},@samp{Subject:}, and @samp{cc:} header fields.@menu* Customizing Replying::* Customizing Forwarding::* Customizing Redistributing::* Customizing Old Drafts::@end menu@node Customizing Replying, Customizing Forwarding, Customizing Sending, Customizing Sending@subsection Replying to Mail@cindex replying@vindex @code{mh-reply-default-reply-to}If you find that most of the time that you specify @kbd{cc} when youreply to a message, set @code{mh-reply-default-reply-to} to @samp{cc}.This variable is normally set to @code{nil} so that you are prompted forthe recipient of a reply. It can be set to one of @samp{from},@samp{to}, or @samp{cc}; you are then no longer prompted for therecipient(s) of your reply.@node Customizing Forwarding, Customizing Redistributing, Customizing Replying, Customizing Sending@subsection Forwarding Mail@cindex forwarding@vindex @code{mh-forward-subject-format}When forwarding a message, the format of the @samp{Subject:} headerfield can be modified by the variable @code{mh-forward-subject-format}.This variable is a string which includes two escapes (@samp{%s}). Thefirst @samp{%s} is replaced with the sender of the original message, andthe second one is replaced with the original @samp{Subject:}. Thedefault value of @samp{"%s: %s"} takes a message with the header:@example@groupTo: Bill Wohler <wohler@@newt.com>Subject: Re: 49er footballFrom: Greg DesBrisay <gd@@cellnet.com>@end group@end exampleand creates a subject header field of:@exampleSubject: Greg DesBrisay: Re: 49er football@end example@node Customizing Redistributing, Customizing Old Drafts, Customizing Forwarding, Customizing Sending@subsection Redistributing Your Mail@cindex redistributing@vindex @code{mh-redist-full-contents}@cindex @code{dist}@cindex MH commands, @code{dist}@cindex @code{send}@cindex MH commands, @code{send}The variable @code{mh-redist-full-contents} must be set to non-@code{nil} if@code{dist} requires the whole letter for redistribution, which is thecase if @code{send} is compiled with the @sc{berk} @footnote{To see whichoptions your copy of MH was compiled with, use @kbd{M-x mh-version}(@ref{Miscellaneous}).} option (which many people abhor). If you findthat MH will not allow you to redistribute a message that has beenredistributed before, this variable should be set to @code{nil}.@node Customizing Old Drafts, , Customizing Redistributing, Customizing Sending@subsection Editing Old Drafts and Bounced Messages@cindex re-editing drafts@vindex @code{mh-new-draft-cleaned-headers}The header fields specified by @code{mh-new-draft-cleaned-headers} areremoved from an old draft that has been recreated with @kbd{M-e}(@code{mh-extract-rejected-mail}) or @kbd{M-a} (@code{mh-edit-again}).If when you edit an old draft with these commands you find that thereare header fields that you don't want included, you can append them tothis variable. For example,@vindex @code{mh-new-draft-cleaned-headers}, example@lisp(setq mh-new-draft-cleaned-headers (concat mh-new-draft-cleaned-headers "\\|^Some-Field:"))@end lisp@cindex regular expressionsThis appends the regular expression @samp{\\|^Some-Field:} to thevariable (@pxref{Regexps, , Syntax of Regular Expressions, emacs, TheGNU Emacs Manual}). The @samp{\\|} means @emph{or}, and the @samp{^}(caret) matches the beginning of the line. This is done to be veryspecific about which fields match. The literal @samp{:} is appended forthe same reason.@node Customizing Draft Editing, Customizing Moving Mail, Customizing Sending, Customizing mh-e@section Editing a Draft@cindex editing draftThere are several variables used during the draft editing phase.Examples include changing the name of the file that holds your signatureor telling mh-e about new multimedia types. They are:@table @code@item mh-yank-from-start-of-msgHow to yank when region not set (default: @code{t}).@item mh-ins-buf-prefixIndent for yanked messages (default: @samp{"> "}).@item mail-citation-hookFunctions to run on yanked messages (default: @code{nil}).@item mh-delete-yanked-msg-windowDelete message window on yank (default: @code{nil}).@c Need the @* because otherwise TeX fills it wrong and complains@c about overfull hbox.@item mh-mime-content-typesList of valid content types (default: @samp{'(("text/plain")@*("text/richtext") ("multipart/mixed") ("multipart/alternative")@*("multipart/digest") ("multipart/parallel") ("message/rfc822")@*("message/partial") ("message/external-body")@*("application/octet-stream") ("application/postscript")@*("image/jpeg") ("image/gif") ("audio/basic") ("video/mpeg"))}).@item mh-mhn-argsAdditional arguments for @code{mhn} (default: @code{nil}).@item mh-signature-file-nameFile containing signature (default: @samp{"~/.signature"}).@item mh-before-send-letter-hookFunctions to run before sending draft (default: @code{nil}).@item mh-send-progMH program used to send messages (default: @samp{"send"}).@end table@menu* Customizing Editing Textual::* Customizing Editing MIME::* Customizing Sending Message::@end menu@node Customizing Editing Textual, Customizing Editing MIME, Customizing Draft Editing, Customizing Draft Editing@subsection Editing Textual MessagesThe following two sections include variables that customize the way youedit a draft. The discussion here applies to editing multimediamessages as well.@menu* Customizing Inserting Letter::* Customizing Signature::@end menu@node Customizing Inserting Letter, Customizing Signature, Customizing Editing Textual, Customizing Editing Textual@subsubsection Inserting letter to which you're replying@cindex inserting messages@vindex @code{mh-yank-from-start-of-msg}@vindex @code{mh-ins-buf-prefix}@vindex @code{mail-citation-hook}@vindex @code{mh-ins-buf-prefix}@vindex @code{mh-delete-yanked-msg-window}To control how much of the message to which you are replying is yankedby @kbd{C-c C-y} (@code{mh-yank-cur-msg}) into your reply, modify@code{mh-yank-from-start-of-msg}. The default value of @code{t} meansthat the entire message is copied. If it is set to @code{'body} (don'tforget the apostrophe), then only the message body is copied. If it isset to @code{nil}, only the part of the message following point (thecurrent cursor position in the message's buffer) is copied. In anycase, this variable is ignored if a region is set in the message you arereplying to. The string contained in @code{mh-ins-buf-prefix} isinserted before each line of a message that is inserted into a draftwith @kbd{C-c C-y} (@code{mh-yank-cur-msg}). I suggest that you notmodify this variable. The default value of @samp{"> "} is the defaultstring for many mailers and news readers: messages are far easier toread if several included messages have all been indented by the samestring. The variable @code{mail-citation-hook} is @code{nil} bydefault, which means that when a message is inserted into the letter,each line is prefixed by @code{mh-ins-buf-prefix}. Otherwise, it can beset to a function that modifies an included@cindex Emacs, packages, supercitecitation.@c Footnotes are fragile; hence the redundancy.@c TeX not inserting a line break; hence the @*@ifclear html@footnote{@emph{Supercite} is an example of a full-bodied, full-featuredcitation package. It is in Emacs versions 19.15 and later, and can befound via anonymous @code{ftp} on @samp{archive.cis.ohio-state.edu} in@* @file{/pub/gnu/emacs/elisp-archive/packages/sc3.1.tar.Z}}@end ifclear@ifset html@footnote{@emph{Supercite} is an example of a full-bodied,full-featured citation package. It is in Emacs versions 19.15 andlater, and its @sc{url} is @*@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>}}@end ifsetIf you like to yank all the text from the message you're replying to inone go, set @code{mh-delete-yanked-msg-window} to non-@code{nil} to deletethe window containing the original message after yanking it to make moreroom on your screen for your reply.@node Customizing Signature, , Customizing Inserting Letter, Customizing Editing Textual@subsubsection Inserting your signature@cindex inserting signature@cindex signature@vindex @code{mh-signature-file-name}@cindex @file{.signature}@cindex files, @file{.signature}You can change the name of the file inserted with @kbd{C-c C-s}(@code{mh-insert-signature}) by changing @code{mh-signature-file-name}(default: @file{"~/.signature"}).@node Customizing Editing MIME, Customizing Sending Message, Customizing Editing Textual, Customizing Draft Editing@subsection Editing Multimedia Messages@cindex MIME@cindex multimedia mail@vindex @code{mh-mime-content-types}The variable @code{mh-mime-content-types} contains a list of thecurrently valid content types. They are listed in the table in@ref{Customizing Draft Editing}. If you encounter a new content type,you can add it like this:@vindex @code{mh-mime-content-types}, example@lisp(setq mh-mime-content-types (append mh-mime-content-types '(("@var{new/type}"))))@end lispEmacs macros can be used to insert enriched text directives like@samp{<bold>}. The following code will make, for example, @kbd{C-c tb} insert the @samp{<bold>} directive.@smallexample@group@i{Emacs macros for entering enriched text}(defvar enriched-text-types '(("b" . "bold") ("i" . "italic") ("f" . "fixed") ("s" . "smaller") ("B" . "bigger") ("u" . "underline") ("c" . "center")) "Alist of (final-character . directive) choices for add-enriched-text.Additional types can be found in RFC 1563.")(defun add-enriched-text (begin end) "Add enriched text directives around region.The directive used comes from the list enriched-text-types and isspecified by the last keystroke of the command. When called from Lisp,arguments are BEGIN and END@." (interactive "r") ;; @r{Set type to the directive indicated by the last keystroke.} (let ((type (cdr (assoc (char-to-string (logior last-input-char ?@w{`})) enriched-text-types)))) (save-restriction ; @r{restores state from narrow-to-region} (narrow-to-region begin end) ; @r{narrow view to region} (goto-char (point-min)) ; @r{move to beginning of text} (insert "<" type ">") ; @r{insert beginning directive} (goto-char (point-max)) ; @r{move to end of text} (insert "</" type ">")))) ; @r{insert terminating directive}@end group@end smallexampleTo use the function @code{add-enriched-text}, first create key bindingsfor it (@pxref{Customizing Sending}). Then, set the mark with@kbd{C-@@} or @kbd{C-SPC}, type in the text to be highlighted, and type@kbd{C-c t b}. This adds @samp{<bold>} where you set the mark andadds @samp{</bold>} at the location of your cursor, giving you somethinglike: @samp{You should be <bold>very</bold>}. You may also beinterested in investigating @code{sgml-mode}.@menu* Customizing Sending MIME::@end menu@node Customizing Sending MIME, , Customizing Editing MIME, Customizing Editing MIME@subsubsection Readying multimedia messages for sending@vindex @code{mh-mhn-args}If you wish to pass additional arguments to @code{mhn} to affect how itbuilds your message, use the variable @code{mh-mhn-args}. For example,you can build a consistency check into the message by setting@code{mh-mhn-args} to @code{-check}. The recipient of your message canthen run @code{mhn -check} on the message---@code{mhn} will complain ifthe message has been corrupted on the way. The @kbd{C-c C-e}(@code{mh-mhn-edit}) command only consults this variable when given aprefix argument.@node Customizing Sending Message, , Customizing Editing MIME, Customizing Draft Editing@subsection Sending a Message@cindex sending mail@cindex spell check@vindex @code{mh-before-send-letter-hook}If you want to check your spelling in your message before sending, use@code{mh-before-send-letter-hook} like this:@i{Spell-check message via mh-before-send-letter-hook}@vindex @code{mh-before-send-letter-hook}, example@lisp(add-hook 'mh-before-send-letter-hook 'ispell-message)@end lisp@cindex @code{send}@cindex MH commands, @code{send}@vindex @code{mh-send-prog}In case the MH @code{send} program is installed under a different name,use @code{mh-send-prog} to tell mh-e the name.@node Customizing Moving Mail, Customizing Searching, Customizing Draft Editing, Customizing mh-e@section Moving Your Mail Around@cindex processing mailIf you change the name of some of the MH programs or have your ownprinting programs, the following variables can help you.They are described in detail in the subsequent sections.@table @code@item mh-inc-progProgram to incorporate mail (default: @samp{"inc"}).@item mh-inc-folder-hookFunctions to run when incorporating mail (default: @code{nil}).@item mh-delete-msg-hookFunctions to run when deleting messages (default: @code{nil}).@item mh-print-backgroundPrint in foreground or background (default: @code{nil}).@item mh-lpr-command-formatCommand used to print (default: @samp{"lpr -J '%s'"}).@item mh-default-folder-for-message-functionFunction to generate a default folder (default: @code{nil}).@item mh-auto-folder-collectCollect folder names in background at startup (default: @code{t}).@item mh-recursive-foldersCollect nested folders (default: @code{nil}).@item mh-refile-msg-hookFunctions to run when refiling message (default: @code{nil}).@item mh-store-default-directoryDefault directory for storing files created by @code{uuencode} or @code{shar}(default: @code{nil}).@item mh-sortm-argsAdditional arguments for @code{sortm} (default: @code{nil}).@item mh-scan-progProgram to scan messages (default: @samp{"scan"}).@item mh-before-quit-hookFunctions to run before quitting (default: @code{nil}). See also@code{mh-quit-hook}.@item mh-quit-hookFunctions to run after quitting (default: @code{nil}). See also@code{mh-before-quit-hook}.@end table@menu* Customizing Incorporating::* Customizing Deleting::* Customizing Organizing::* Customizing Printing::* Customizing Files and Pipes::* Customizing Finishing Up::@end menu@node Customizing Incorporating, Customizing Deleting, Customizing Moving Mail, Customizing Moving Mail@subsection Incorporating Your Mail@cindex incorporating@vindex @code{mh-inc-prog}@cindex @code{inc}@cindex MH commands, @code{inc}@vindex @code{mh-progs}@vindex @code{mh-scan-prog}@vindex @code{mh-inc-folder-hook}The name of the program that incorporates new mail is stored in@code{mh-inc-prog}; it is @samp{"inc"} by default. This programgenerates a one-line summary for each of the new messages. Unless it isan absolute pathname, the file is assumed to be in the @code{mh-progs}directory. You may also link a file to @code{inc} that uses a differentformat (see @code{mh-profile}(5)). You'll then need to modify severalvariables appropriately; see @code{mh-scan-prog} below. You can set thehook @code{mh-inc-folder-hook}, which is called after new mail isincorporated by the @kbd{i} (@code{mh-inc-folder}) command. A good useof this hook is to rescan the whole folder either after running @kbd{M-xmh-rmail} the first time or when you've changed the message numbers fromoutside of mh-e.@findex @code{mh-execute-commands}@findex @code{mh-rescan-folder}, example@findex @code{mh-show}, example@vindex @code{mh-inc-folder-hook}, example@lisp@group@i{Rescan folder after incorporating new mail via mh-inc-folder-hook}(defun my-mh-inc-folder-hook () "Hook to rescan folder after incorporating mail." (if (buffer-modified-p) ; @r{if outstanding refiles and deletes,} (mh-execute-commands)) ; @r{carry them out} (mh-rescan-folder) ; @r{synchronize with +inbox} (mh-show)) ; @r{show the current message}(add-hook 'mh-inc-folder-hook 'my-mh-inc-folder-hook)@end group@end lisp@node Customizing Deleting, Customizing Organizing, Customizing Incorporating, Customizing Moving Mail@subsection Deleting Your Mail@cindex deleting@vindex @code{mh-delete-msg-hook}The hook @code{mh-delete-msg-hook} is called after you mark a messagefor deletion. For example, the current maintainer of mh-e used thisonce when he kept statistics on his mail usage.@node Customizing Organizing, Customizing Printing, Customizing Deleting, Customizing Moving Mail@subsection Organizing Your Mail with Folders@cindex using folders@vindex @code{mh-recursive-folders}@vindex @code{mh-auto-folder-collect}By default, operations on folders work only one level at a time. Set@code{mh-recursive-folders} to non-@code{nil} to operate on all folders.This mostly means that you'll be able to see all your folders when youpress @key{TAB} when prompted for a folder name. The variable@code{mh-auto-folder-collect} is normally turned on to generate a listof folder names in the background as soon as mh-e is loaded. Otherwise,the list is generated when you need a folder name the first time (aswith @kbd{o} (@code{mh-refile-msg})). If you have a lot of folders andyou have @code{mh-recursive-folders} set, this could take a while, whichis why it's nice to do the folder collection in the background.@vindex @code{mh-default-folder-for-message-function}@findex @code{mh-refile-msg}@findex @code{mh-to-fcc}@cindex @file{.emacs}@cindex files, @file{.emacs}The function @code{mh-default-folder-for-message-function} is used by@kbd{o} (@code{mh-refile-msg}) and @kbd{C-c C-f C-f} (@code{mh-to-fcc})to generate a default folder. The generated folder name should be astring with a @samp{+} before it. For each of my correspondents, I use thesame name for both an alias and a folder. So, I wrote a function thattakes the address in the @samp{From:} header field, finds it in my aliasfile, and returns the alias, which is used as a default folder name.This is the most complicated example given here, and it demonstratesseveral features of Emacs Lisp programming. You should be able to dropthis into @file{~/.emacs}, however. If you use this to store messagesin a subfolder of your Mail directory, you can modify the line thatstarts @samp{(format +%s...} and insert your subfolder after the foldersymbol @samp{+}.@c Note for me: if I insert a new version, don't forget to remove the@c "a/" from the folder name.@iftex@filbreak@end iftex@vindex @code{mh-default-folder-for-message-function}, example@vindex @code{mh-user-path}, example@smallexample@group@i{Creating useful default folder for refiling via mh-default-folder-for-message-function}(defun my-mh-folder-from-address () "Determine folder name from address.Takes the address in the From: header field, and returns itscorresponding alias from the user's personal aliases file. Returns@code{nil} if the address was not found." (require 'rfc822) ; @r{for the rfc822 functions} (search-forward-regexp "^From: \\(.*\\)") ; @r{grab header field contents} (save-excursion ; @r{save state} (let ((addr (car (rfc822-addresses ; @r{get address} (buffer-substring (match-beginning 1) (match-end 1))))) (buffer (get-buffer-create " *temp*")) ; @r{set local variables} folder) (set-buffer buffer) ; @r{jump to temporary buffer} (unwind-protect ; @r{run kill-buffer when done} (progn ; @r{function grouping construct} (insert-file-contents (expand-file-name "aliases" mh-user-path)) (goto-char (point-min)) ; @r{grab aliases file and go to start} (setq folder ;; @r{Search for the given address, even commented-out} ;; @r{addresses are found!} ;; @r{The function search-forward-regexp sets values that} ;; @r{are later used by match-beginning and match-end.} (if (search-forward-regexp (format "^;*\\(.*\\):.*%s" addr) nil t) ;; @r{NOTE WELL: this is what the return value looks} ;; @r{like. You can modify the format string to match} ;; @r{your own Mail hierarchy.} (format "+%s" (buffer-substring (match-beginning 1) (match-end 1)))))) (kill-buffer buffer)) ; @r{get rid of our temporary buffer} folder))) ; @r{function's return value}(setq mh-default-folder-for-message-function 'my-mh-folder-from-address)@end group@end smallexample@vindex @code{mh-refile-msg-hook}The hook @code{mh-refile-msg-hook} is called after a message is markedto be refiled.@vindex @code{mh-sortm-args}@cindex @code{sortm}@cindex MH commands, @code{sortm}@findex @code{mh-sort-folder}@cindex MH profile components, @code{sortm}@cindex @file{.mh_profile}@cindex files, @file{.mh_profile}The variable @code{mh-sortm-args} holds extra arguments to pass on tothe @code{sortm} command. Note: this variable is only consulted when aprefix argument is given to @kbd{M-x mh-sort-folder}. It is used tooverride any arguments given in a @code{sortm:} entry in your MH profile(@file{~/.mh_profile}).@menu* Customizing Scan Line Formats::@end menu@node Customizing Scan Line Formats, , Customizing Organizing, Customizing Organizing@subsubsection Scan line formatting@vindex @code{mh-scan-prog}@cindex @code{scan}@cindex MH commands, @code{scan}@vindex @code{mh-progs}The name of the program that generates a listing of one line per messageis held in @code{mh-scan-prog} (default: @samp{"scan"}). Unless thisvariable contains an absolute pathname, it is assumed to be in the@code{mh-progs} directory. You may link another program to @code{scan}(see @code{mh-profile}(5)) to produce a different type of listing.If you change the format of the scan lines you'll need to tell mh-e howto parse the new format. As you see, quite a lot of variables areinvolved to do that. The first variable has to do with pruning outgarbage.@table @code@item mh-valid-scan-line@vindex @code{mh-valid-scan-line}@cindex @code{inc}@cindex MH commands, @code{inc}@cindex @code{scan}@cindex MH commands, @code{scan}This regular expression describes a valid scan line. This is used toeliminate error messages that are occasionally produced by @code{inc} or@code{scan} (default: @samp{"^ *[0-9]"}).@end tableNext, two variables control how the message numbers are parsed.@table @code@item mh-msg-number-regexp@vindex @code{mh-msg-number-regexp}This regular expression is used to extract the message number from ascan line. Note that the message number must be placed in quotedparentheses, (\\(...\\)), as in the default of @w{@samp{"^*\\([0-9]+\\)"}}.@item mh-msg-search-regexp@vindex @code{mh-msg-search-regexp}Given a message number (which is inserted in @samp{%d}), this regularexpression will match the scan line that it represents (default:@samp{"^[^0-9]*%d[^0-9]"}).@end tableFinally, there are a slew of variables that control how mh-e marks upthe scan lines.@table @code@item mh-cmd-note@vindex @code{mh-cmd-note}Number of characters to skip over before inserting notation (default:4). Note how it relates to the following regular expressions.@item mh-deleted-msg-regexp@vindex @code{mh-deleted-msg-regexp}This regular expression describes deleted messages (default:@samp{"^....D"}). See also @code{mh-note-deleted}.@item mh-refiled-msg-regexp@vindex @code{mh-refiled-msg-regexp}This regular expression describes refiled messages (default:@samp{"^....\\^"}). See also @code{mh-note-refiled}.@item mh-cur-scan-msg-regexp@vindex @code{mh-cur-scan-msg-regexp}This regular expression matches the current message (default:@samp{"^....\\+"}). See also @code{mh-note-cur}.@item mh-good-msg-regexp@vindex @code{mh-good-msg-regexp}This regular expression describes which messages should be shown whenmh-e goes to the next or previous message. Normally, deleted or refiledmessages are skipped over (default: @samp{"^....[^D^]"}).@item mh-note-deleted@vindex @code{mh-note-deleted}Messages that have been deleted to are marked by this string (default:@samp{"D"}). See also @code{mh-deleted-msg-regexp}.@item mh-note-refiled@vindex @code{mh-note-refiled}Messages that have been refiled are marked by this string (default:@samp{"^"}). See also @code{mh-refiled-msg-regexp}.@item mh-note-copied@vindex @code{mh-note-copied}Messages that have been copied are marked by this string (default:@samp{"C"}).@item mh-note-cur@vindex @code{mh-note-cur}The current message (in MH, not in mh-e) is marked by this string(default: @samp{"+"}). See also @code{mh-cur-scan-msg-regexp}.@item mh-note-repl@vindex @code{mh-note-repl}Messages that have been replied to are marked by this string (default:@samp{"-"}).@item mh-note-forw@vindex @code{mh-note-forw}Messages that have been forwarded are marked by this string (default:@samp{"F"}).@item mh-note-dist@vindex @code{mh-note-dist}Messages that have been redistributed are marked by this string(default: @samp{"R"}).@item mh-note-printed@vindex @code{mh-note-printed}Messages that have been printed are marked by this string (default:@samp{"P"}).@item mh-note-seq@vindex @code{mh-note-seq}Messages in a sequence are marked by this string (default: @samp{"%"}).@end table@node Customizing Printing, Customizing Files and Pipes, Customizing Organizing, Customizing Moving Mail@subsection Printing Your Mail@cindex printing@vindex @code{mh-print-background}@vindex @code{mh-lpr-command-format}@cindex @code{lpr}@cindex Unix commands, @code{lpr}Normally messages are printed in the foreground. If this is slow onyour system, you may elect to set @code{mh-print-background} tonon-@code{nil} to print in the background. If you do this, do not deletethe message until it is printed or else the output may be truncated.The variable @code{mh-lpr-command-format} controls how the printing isactually done. The string can contain one escape, @samp{%s}, which isfilled with the name of the folder and the message number and is usefulfor print job names. As an example, the default is @samp{"lpr -J'%s'"}.@node Customizing Files and Pipes, Customizing Finishing Up, Customizing Printing, Customizing Moving Mail@subsection Files and Pipes@cindex using files@cindex using pipes@findex @code{mh-store-msg}@vindex @code{mh-store-default-directory}The initial directory for the @code{mh-store-msg} command is held in@code{mh-store-default-directory}. Since I almost always run@code{mh-store-msg} on sources, I set it to my personal source directorylike this:@vindex @code{mh-store-default-directory}, example@lisp(setq mh-store-default-directory (expand-file-name "~/src/"))@end lisp@findex @code{mh-store-buffer}@cindex @code{uuencode}@cindex Unix commands, @code{uuencode}@cindex @code{shar}@cindex Unix commands, @code{shar}Subsequent incarnations of @code{mh-store-msg} offer the last directoryused as the default. By the way, @code{mh-store-msg} calls the EmacsLisp function @code{mh-store-buffer}. I mention this because you can useit directly if you're editing a buffer that contains a file that hasbeen run through @code{uuencode} or @code{shar}. For example, you canextract the contents of the current buffer in your home directory bytyping @kbd{M-x mh-store-buffer @key{RET} ~ @key{RET}}.@node Customizing Finishing Up, , Customizing Files and Pipes, Customizing Moving Mail@subsection Finishing Up@cindex quitting@vindex @code{mh-before-quit-hook}@vindex @code{mh-quit-hook}@findex @code{mh-execute-commands}The two variables @code{mh-before-quit-hook} and @code{mh-quit-hook} arecalled by @kbd{q} (@code{mh-quit}). The former one is called before thequit occurs, so you might use it to perform any mh-e operations; youcould perform some query and abort the quit or call@code{mh-execute-commands}, for example. The latter is not run in anmh-e context, so you might use it to modify the window setup.@node Customizing Searching, , Customizing Moving Mail, Customizing mh-e@section Searching Through Messages@cindex searching@vindex @code{mh-pick-mode-hook}@vindex @code{mh-partial-folder-mode-line-annotation}If you find that you do the same thing over and over when editing thesearch template, you may wish to bind some shortcuts to keys. This canbe done with the variable @code{mh-pick-mode-hook}, which is called when@kbd{M-s} (@code{mh-search-folder}) is run on a new pattern.The string@code{mh-partial-folder-mode-line-annotation} is used to annotate themode line when only a portion of the folder is shown. For example, thiswill be displayed after running @kbd{M-s} (@code{mh-search-folder}) tolist messages based on some search criteria (see @ref{Searching}). Thedefault annotation of @samp{"select"} yields a mode line that lookslike:@example--%%-@{+inbox/select@} 2 msgs (2-3) (MH-Folder)--All-----------------@end example@node Odds and Ends, History, Customizing mh-e, Top@appendix Odds and EndsThis appendix covers a few topics that don't fit elsewhere. Here I tellyou how to report bugs and how to get on the mh-e mailing list. I alsopoint out some additional sources of information.@menu* Bug Reports::* Mailing List::* MH FAQ::* Getting mh-e::@end menu@node Bug Reports, Mailing List, Odds and Ends, Odds and Ends@appendixsec Bug Reports@cindex bugs@cindex Wohler, Bill@cindex SourceForgeThe current maintainer of mh-e is Bill Wohler<@i{wohler@@newt.com}>. Bug reports should be filed at@uref{https://sourceforge.net/bugs/?group_id=13357, SourceForge}.Please include the output of@kbd{M-x mh-version} (@pxref{Miscellaneous}) in any bug report you send.@node Mailing List, MH FAQ, Bug Reports, Odds and Ends@appendixsec mh-e Mailing List@cindex mailing list@cindex SourceForgeThere are actually several mailing lists for mh-e. They are@i{mh-e-users@@lists.sourceforge.net},@i{mh-e-announce@@lists.sourceforge.net}, and@i{mh-e-devel@@lists.sourceforge.net}. You can subscribe or view thearchives at @uref{https://sourceforge.net/mail/?group_id=13357,SourceForge}. Do not report bugs on these lists; please submit themvia SourceForge (@pxref{Bug Reports}).@node MH FAQ, Getting mh-e, Mailing List, Odds and Ends@appendixsec MH FAQ@cindex MH FAQ@cindex FAQAn FAQ appears monthly in the newsgroup @samp{comp.mail.mh}. While verylittle is there that deals with mh-e specifically, there is anincredible wealth of material about MH itself which you will finduseful. The subject of the FAQ is @cite{MH Frequently Asked Questions(FAQ) with Answers}.The FAQ is available via the World Wide Web (WWW) at@uref{http://www.faqs.org/faqs/mail/mh-faq/part1/preamble.html, faqs.org}.@node Getting mh-e, , MH FAQ, Odds and Ends@appendixsec Getting mh-e@cindex obtaining mh-eThe version of mh-e in the current version of Emacs should be up todate. It is most likely to be more up to date than the copy that comeswith the MH distribution in @file{miscellany/mh-e}.@c intentionally wordy to avoid overfull hboxNew mh-e releases are always available for downloading at@uref{https://sourceforge.net/project/showfiles.php?group_id=13357,SourceForge} before they appear in an Emacs release. You can read therelease notes on that page to determine if the given release of mh-eis already installed in your version of Emacs.If you go this route, I suggest that you extract the files from@file{mh-e-@var{m.n}.tgz} in the following fashion:@smallexample@group% @kbd{cd} # @r{Start in your home directory}% @kbd{mkdir lib lib/emacs} # @r{Create directory for mh-e}% @kbd{cd lib/emacs}% @kbd{zcat @var{path/to/}mh-e-@var{m.n}.tgz | tar xvf -} # @r{Extract files}@end group@end smallexample@cindex @file{.emacs}@cindex files, @file{.emacs}To use these new files, add the following to @file{~/.emacs}:@lisp(setq load-path (cons (expand-file-name "~/lib/emacs") load-path))@end lisp@cindex news@cindex files, @samp{MH-E-NEWS}That's it! If you're already running Emacs, please quit that sessionand start again to load in the new mh-e. Check that you're running thenew version with the command @kbd{M-x mh-version} after running any mh-ecommand. The distribution comes with a file called @file{MH-E-NEWS} soyou can see what's new.@node History, Copying, Odds and Ends, Top@appendix History of mh-e@cindex Gildea, Stephen@cindex Larus, Jim@cindex Reid, Brian@cindex SourceForge@cindex history of mh-emh-e was originally written by Brian Reid in 1983 and has changedhands several times since then. Jim Larus wanted to do somethingsimilar for GNU Emacs, and ended up completely rewriting it that sameyear. In 1989, Stephen Gildea picked it up and added many improvements.Bill Wohler then took over in 2000 and moved its development to@uref{http://sourceforge.net/, SourceForge}.@menu* From Brian Reid::* From Jim Larus::* From Stephen Gildea::@end menu@node From Brian Reid, From Jim Larus, History, History@appendixsec From Brian Reid@cindex Reid, BrianOne day in 1983 I got the flu and had to stay home from work for threedays with nothing to do. I used that time to write MHE@. Thefundamental idea behind MHE was that it was a ``puppeteer'' driving the MHprograms underneath it. MH had a model that the editor was supposed torun as a subprocess of the mailer, which seemed to me at the time to bethe tail wagging the dog. So I turned it around and made the editordrive the MH programs. I made sure that the UCI people (who weremaintaining MH at the time) took in my changes and made them stick.Today, I still use my own version of MHE because I don't at all like theway that GNU mh-e works and I've never gotten to be good enough athacking Emacs Lisp to make GNU mh-e do what I want. The Gosling-emacsversion of MHE and the GNU Emacs version of mh-e have almost nothing incommon except similar names. They work differently, have differentconceptual models, and have different key bindings. @footnote{Afterreading this article, I questioned Brian about his version of MHE, andreceived some great ideas for improving mh-e such as a dired-like methodof selecting folders; and removing the prompting when sending mail,filling in the blanks in the draft buffer instead. I passed them on toStephen Gildea, the current maintainer, and he was excited about theideas as well. Perhaps one day, mh-e will again resemble MHE, althoughnone of these ideas are manifest in Version 5.0.}Brian Reid, June 1994@node From Jim Larus, From Stephen Gildea, From Brian Reid, History@appendixsec From Jim Larus@cindex Larus, JimBrian Reid, while at CMU or shortly after going to Stanford wrote a mailreading program called MHE for Gosling Emacs. It had much the samestructure as mh-e (i.e., invoked MH programs), though it was simpler andthe commands were slightly different. Unfortunately, I no longer have acopy so the differences are lost in the mists of time.In '82-83, I was working at BBN and wrote a lot of mlisp code in GoslingEmacs to make it look more like Tennex Emacs. One of the packages thatI picked up and improved was Reid's mail system. In '83, I went back toBerkeley. About that time, Stallman's first version of GNU Emacs cameout and people started to move to it from Gosling Emacs (as I recall,the transition took a year or two). I decided to port Reid's MHE andused the mlisp to Emacs Lisp translator that came with GNU Emacs. Itdid a lousy job and the resulting code didn't work, so I bit the bulletand rewrote the code by hand (it was a lot smaller and simpler then, soit took only a day or two).Soon after that, mh-e became part of the standard Emacs distribution andsuggestions kept dribbling in for improvements. mh-e soon reachedsufficient functionality to keep me happy, but I kept on improving itbecause I was a graduate student with plenty of time on my hands and itwas more fun than my dissertation. In retrospect, the one thing that Iregret is not writing any documentation, which seriously limited the useand appeal of the package.@cindex @code{xmh}, in mh-e historyIn '89, I came to Wisconsin as a professor and decided not to work onmh-e. It was stable, except for minor bugs, and had enoughfunctionality, so I let it be for a few years. Stephen Gildea of BBNbegan to pester me about the bugs, but I ignored them. In 1990, he wentoff to the X Consortium, said good bye, and said that he would now beusing @code{xmh}. A few months later, he came back and said that hecouldn't stand @code{xmh} and could I put a few more bug fixes intomh-e. At that point, I had no interest in fixing mh-e, so I gave theresponsibility of maintenance to him and he has done a fine job sincethen.Jim Larus, June 1994@node From Stephen Gildea, , From Jim Larus, History@appendixsec From Stephen Gildea@cindex Gildea, StephenIn 1987 I went to work for Bolt Beranek and Newman, as Jim had beforeme. In my previous job, I had been using RMAIL, but as my folders tendto run large, I was frustrated with the speed of RMAIL@. However, Istuck with it because I wanted the GNU Emacs interface. I am veryfamiliar and comfortable with the Emacs interface (with just a fewmodifications of my own) and dislike having to use applications withembedded editors; they never live up to Emacs.MH is the mail reader of choice at BBN, so I converted to it. Since Ididn't want to give up using an Emacs interface, I started using mh-e.As is my wont, I started hacking on it almost immediately. I first usedversion 3.4m. One of the first features I added was to treat the folderbuffer as a file-visiting buffer: you could lock it, save it, and bewarned of unsaved changes when killing it. I also worked to bring itsfunctionality a little closer to RMAIL@. Jim Larus was very cooperativeabout merging in my changes, and my efforts first appeared in version3.6, distributed with Emacs 18.52 in 1988. Next I decided mh-e was tooslow and optimized it a lot. Version, 3.7, distributed with Emacs 18.56in 1990, was noticeably faster.When I moved to the X Consortium I became the first person there to notuse xmh. (There is now one other engineer there using mh-e.) Aboutthis point I took over maintenance of mh-e from Jim and was finally ableto add some features Jim hadn't accepted, such as the backward searchingundo. My first release was 3.8 (Emacs 18.58) in 1992.Now, in 1994, we see a flurry of releases, with both 4.0 and 5.0.Version 4.0 added many new features, including background foldercollection and support for composing @sc{mime} messages. (Reading@sc{mime} messages remains to be done, alas.) While writing this book,Bill Wohler gave mh-e its closest examination ever, uncovering bugs andinconsistencies that required a new major version to fix, and so version5 was released.Stephen Gildea, June 1994@node Copying, Command Index, History, Top@appendix GNU GENERAL PUBLIC LICENSE@center Version 2, June 1991@displayCopyright @copyright{} 1989, 1991 Free Software Foundation, Inc.51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USAEveryone is permitted to copy and distribute verbatim copiesof this license document, but changing it is not allowed.@end display@appendixsec Preamble The licenses for most software are designed to take away yourfreedom to share and change it. By contrast, the GNU General PublicLicense is intended to guarantee your freedom to share and change freesoftware---to make sure the software is free for all its users. ThisGeneral Public License applies to most of the Free SoftwareFoundation's software and to any other program whose authors commit tousing it. (Some other Free Software Foundation software is covered bythe GNU Library General Public License instead.) You can apply it toyour programs, too. When we speak of free software, we are referring to freedom, notprice. Our General Public Licenses are designed to make sure that youhave the freedom to distribute copies of free software (and charge forthis service if you wish), that you receive source code or can get itif you want it, that you can change the software or use pieces of itin new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbidanyone to deny you these rights or to ask you to surrender the rights.These restrictions translate to certain responsibilities for you if youdistribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whethergratis or for a fee, you must give the recipients all the rights thatyou have. You must make sure that they, too, receive or can get thesource code. And you must show them these terms so they know theirrights. We protect your rights with two steps: (1) copyright the software, and(2) offer you this license which gives you legal permission to copy,distribute and/or modify the software. Also, for each author's protection and ours, we want to make certainthat everyone understands that there is no warranty for this freesoftware. If the software is modified by someone else and passed on, wewant its recipients to know that what they have is not the original, sothat any problems introduced by others will not reflect on the originalauthors' reputations. Finally, any free program is threatened constantly by softwarepatents. We wish to avoid the danger that redistributors of a freeprogram will individually obtain patent licenses, in effect making theprogram proprietary. To prevent this, we have made it clear that anypatent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution andmodification follow.@iftex@appendixsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION@end iftex@ifinfo@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION@end ifinfo@enumerate 0@itemThis License applies to any program or other work which containsa notice placed by the copyright holder saying it may be distributedunder the terms of this General Public License. The ``Program,'' below,refers to any such program or work, and a ``work based on the Program''means either the Program or any derivative work under copyright law:that is to say, a work containing the Program or a portion of it,either verbatim or with modifications and/or translated into anotherlanguage. (Hereinafter, translation is included without limitation inthe term ``modification.'') Each licensee is addressed as ``you.''Activities other than copying, distribution and modification are notcovered by this License; they are outside its scope. The act ofrunning the Program is not restricted, and the output from the Programis covered only if its contents constitute a work based on theProgram (independent of having been made by running the Program).Whether that is true depends on what the Program does.@itemYou may copy and distribute verbatim copies of the Program'ssource code as you receive it, in any medium, provided that youconspicuously and appropriately publish on each copy an appropriatecopyright notice and disclaimer of warranty; keep intact all thenotices that refer to this License and to the absence of any warranty;and give any other recipients of the Program a copy of this Licensealong with the Program.You may charge a fee for the physical act of transferring a copy, andyou may at your option offer warranty protection in exchange for a fee.@itemYou may modify your copy or copies of the Program or any portionof it, thus forming a work based on the Program, and copy anddistribute such modifications or work under the terms of Section 1above, provided that you also meet all of these conditions:@enumerate a@itemYou must cause the modified files to carry prominent noticesstating that you changed the files and the date of any change.@itemYou must cause any work that you distribute or publish, that inwhole or in part contains or is derived from the Program or anypart thereof, to be licensed as a whole at no charge to all thirdparties under the terms of this License.@itemIf the modified program normally reads commands interactivelywhen run, you must cause it, when started running for suchinteractive use in the most ordinary way, to print or display anannouncement including an appropriate copyright notice and anotice that there is no warranty (or else, saying that you providea warranty) and that users may redistribute the program underthese conditions, and telling the user how to view a copy of thisLicense. (Exception: if the Program itself is interactive butdoes not normally print such an announcement, your work based onthe Program is not required to print an announcement.)@end enumerateThese requirements apply to the modified work as a whole. Ifidentifiable sections of that work are not derived from the Program,and can be reasonably considered independent and separate works inthemselves, then this License, and its terms, do not apply to thosesections when you distribute them as separate works. But when youdistribute the same sections as part of a whole which is a work basedon the Program, the distribution of the whole must be on the terms ofthis License, whose permissions for other licensees extend to theentire whole, and thus to each and every part regardless of who wrote it.Thus, it is not the intent of this section to claim rights or contestyour rights to work written entirely by you; rather, the intent is toexercise the right to control the distribution of derivative orcollective works based on the Program.In addition, mere aggregation of another work not based on the Programwith the Program (or with a work based on the Program) on a volume ofa storage or distribution medium does not bring the other work underthe scope of this License.@itemYou may copy and distribute the Program (or a work based on it,under Section 2) in object code or executable form under the terms ofSections 1 and 2 above provided that you also do one of the following:@enumerate a@itemAccompany it with the complete corresponding machine-readablesource code, which must be distributed under the terms of Sections1 and 2 above on a medium customarily used for software interchange; or,@itemAccompany it with a written offer, valid for at least threeyears, to give any third party, for a charge no more than yourcost of physically performing source distribution, a completemachine-readable copy of the corresponding source code, to bedistributed under the terms of Sections 1 and 2 above on a mediumcustomarily used for software interchange; or,@itemAccompany it with the information you received as to the offerto distribute corresponding source code. (This alternative isallowed only for noncommercial distribution and only if youreceived the program in object code or executable form with suchan offer, in accord with Subsection b above.)@end enumerateThe source code for a work means the preferred form of the work formaking modifications to it. For an executable work, complete sourcecode means all the source code for all modules it contains, plus anyassociated interface definition files, plus the scripts used tocontrol compilation and installation of the executable. However, as aspecial exception, the source code distributed need not includeanything that is normally distributed (in either source or binaryform) with the major components (compiler, kernel, and so on) of theoperating system on which the executable runs, unless that componentitself accompanies the executable.If distribution of executable or object code is made by offeringaccess to copy from a designated place, then offering equivalentaccess to copy the source code from the same place counts asdistribution of the source code, even though third parties are notcompelled to copy the source along with the object code.@itemYou may not copy, modify, sublicense, or distribute the Programexcept as expressly provided under this License. Any attemptotherwise to copy, modify, sublicense or distribute the Program isvoid, and will automatically terminate your rights under this License.However, parties who have received copies, or rights, from you underthis License will not have their licenses terminated so long as suchparties remain in full compliance.@itemYou are not required to accept this License, since you have notsigned it. However, nothing else grants you permission to modify ordistribute the Program or its derivative works. These actions areprohibited by law if you do not accept this License. Therefore, bymodifying or distributing the Program (or any work based on theProgram), you indicate your acceptance of this License to do so, andall its terms and conditions for copying, distributing or modifyingthe Program or works based on it.@itemEach time you redistribute the Program (or any work based on theProgram), the recipient automatically receives a license from theoriginal licensor to copy, distribute or modify the Program subject tothese terms and conditions. You may not impose any furtherrestrictions on the recipients' exercise of the rights granted herein.You are not responsible for enforcing compliance by third parties tothis License.@itemIf, as a consequence of a court judgment or allegation of patentinfringement or for any other reason (not limited to patent issues),conditions are imposed on you (whether by court order, agreement orotherwise) that contradict the conditions of this License, they do notexcuse you from the conditions of this License. If you cannotdistribute so as to satisfy simultaneously your obligations under thisLicense and any other pertinent obligations, then as a consequence youmay not distribute the Program at all. For example, if a patentlicense would not permit royalty-free redistribution of the Program byall those who receive copies directly or indirectly through you, thenthe only way you could satisfy both it and this License would be torefrain entirely from distribution of the Program.If any portion of this section is held invalid or unenforceable underany particular circumstance, the balance of the section is intended toapply and the section as a whole is intended to apply in othercircumstances.It is not the purpose of this section to induce you to infringe anypatents or other property right claims or to contest validity of anysuch claims; this section has the sole purpose of protecting theintegrity of the free software distribution system, which isimplemented by public license practices. Many people have madegenerous contributions to the wide range of software distributedthrough that system in reliance on consistent application of thatsystem; it is up to the author/donor to decide if he or she is willingto distribute software through any other system and a licensee cannotimpose that choice.This section is intended to make thoroughly clear what is believed tobe a consequence of the rest of this License.@itemIf the distribution and/or use of the Program is restricted incertain countries either by patents or by copyrighted interfaces, theoriginal copyright holder who places the Program under this Licensemay add an explicit geographical distribution limitation excludingthose countries, so that distribution is permitted only in or amongcountries not thus excluded. In such case, this License incorporatesthe limitation as if written in the body of this License.@itemThe Free Software Foundation may publish revised and/or new versionsof the General Public License from time to time. Such new versions willbe similar in spirit to the present version, but may differ in detail toaddress new problems or concerns.Each version is given a distinguishing version number. If the Programspecifies a version number of this License which applies to it and ``anylater version,'' you have the option of following the terms and conditionseither of that version or of any later version published by the FreeSoftware Foundation. If the Program does not specify a version number ofthis License, you may choose any version ever published by the Free SoftwareFoundation.@itemIf you wish to incorporate parts of the Program into other freeprograms whose distribution conditions are different, write to the authorto ask for permission. For software which is copyrighted by the FreeSoftware Foundation, write to the Free Software Foundation; we sometimesmake exceptions for this. Our decision will be guided by the two goalsof preserving the free status of all derivatives of our free software andof promoting the sharing and reuse of software generally.@iftex@heading NO WARRANTY@end iftex@ifinfo@center NO WARRANTY@end ifinfo@itemBECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTYFOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHENOTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIESPROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSEDOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK ASTO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THEPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,REPAIR OR CORRECTION.@itemIN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITINGWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/ORREDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISINGOUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITEDTO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BYYOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHERPROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES.@end enumerate@iftex@heading END OF TERMS AND CONDITIONS@end iftex@ifinfo@center END OF TERMS AND CONDITIONS@end ifinfo@page@appendixsec How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatestpossible use to the public, the best way to achieve this is to make itfree software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safestto attach them to the start of each source file to most effectivelyconvey the exclusion of warranty; and each file should have at leastthe ``copyright'' line and a pointer to where the full notice is found.@smallexample@var{one line to give the program's name and an idea of what it does.}Copyright (C) 20@var{yy} @var{name of author}This program is free software; you can redistribute it and/ormodify it under the terms of the GNU General Public Licenseas published by the Free Software Foundation; either version 2of the License, or (at your option) any later version.This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See theGNU General Public License for more details.You should have received a copy of the GNU General Public License alongwith this program; if not, write to the Free Software Foundation, Inc.,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.@end smallexampleAlso add information on how to contact you by electronic and paper mail.If the program is interactive, make it output a short notice like thiswhen it starts in an interactive mode:@smallexampleGnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}Gnomovision comes with ABSOLUTELY NO WARRANTY; for detailstype `show w'. This is free software, and you are welcometo redistribute it under certain conditions; type `show c'for details.@end smallexampleThe hypothetical commands @samp{show w} and @samp{show c} should showthe appropriate parts of the General Public License. Of course, thecommands you use may be called something other than @samp{show w} and@samp{show c}; they could even be mouse-clicks or menu items---whateversuits your program.You should also get your employer (if you work as a programmer) or yourschool, if any, to sign a ``copyright disclaimer'' for the program, ifnecessary. Here is a sample; alter the names:@smallexample@groupYoyodyne, Inc., hereby disclaims all copyrightinterest in the program `Gnomovision'(which makes passes at compilers) writtenby James Hacker.@var{signature of Ty Coon}, 1 April 1989Ty Coon, President of Vice@end group@end smallexampleThis General Public License does not permit incorporating your program intoproprietary programs. If your program is a subroutine library, you mayconsider it more useful to permit linking proprietary applications with thelibrary. If this is what you want to do, use the GNU Library GeneralPublic License instead of this License.@node Command Index, Variable Index, Copying, Top@unnumbered Command Index@printindex fn@node Variable Index, Concept Index, Command Index, Top@unnumbered Variable Index@printindex vr@node Concept Index, , Variable Index, Top@unnumbered Concept Index@printindex cp@contents@bye@c XXX In the sections on customizing mh-e, you can add cross-references@c to the Emacs manual and the Emacs Lisp manual wherever they are@c useful. @pxref{node, , section, emacs, The GNU Emacs Manual}@ignore arch-tag: b778477d-1a10-4a99-84de-f877a2ea6bef@end ignore