@c Note: This document requires makeinfo version 4.6 or greater to build.
@c
@c %**start of header
-@setfilename ../../info/mh-e
+@setfilename ../../info/mh-e.info
@settitle The MH-E Manual
-@documentencoding UTF-8
+@include docstyle.texi
@c %**end of header
@c Version of the software and manual.
This is version @value{VERSION}@value{EDITION} of @cite{The MH-E
Manual}, last updated @value{UPDATED}.
-Copyright @copyright{} 1995, 2001--2003, 2005--2014 Free Software
+Copyright @copyright{} 1995, 2001--2003, 2005--2016 Free Software
Foundation, Inc.
@c This dual license has been agreed upon by the FSF.
@item
the GNU Free Documentation License, Version 1.3 or any later version
published by the Free Software Foundation; with no Invariant Sections,
-with the Front-Cover texts being ``A GNU Manual,'' and with the
+with the Front-Cover Texts being ``A GNU Manual,'' and with the
Back-Cover Texts as in (a) below. A copy of the license is included in
the section entitled ``GNU Free Documentation License.''
@kindex C-h t
If you don't already use GNU Emacs but want to learn more, you can
-read an online tutorial by starting GNU Emacs and typing @kbd{C-h t}
+read a built-in tutorial by starting GNU Emacs and typing @kbd{C-h t}
(@code{help-with-tutorial}). (To learn about this notation, see
@ref{Conventions}.) If you want to take the plunge, consult the
@iftex
about every MH-E command and option.
@cindex Emacs, info
-@cindex Emacs, online help
+@cindex Emacs, built-in help
@cindex info
-@cindex online help
+@cindex built-in help
@findex describe-mode
@findex mh-help
@kindex ?
like to rebind the keys, the command summaries also list the
associated Emacs Lisp function. Furthermore, even if you're stranded
on a desert island with a laptop and are without your manuals, you can
-get a summary of all these commands with GNU Emacs online help: use
+get a summary of all these commands with GNU Emacs built-in help: use
@kbd{C-h m} (@code{describe-mode}) for a brief summary of commands,
@kbd{?} (@code{mh-help}) for an even briefer summary@footnote{This
help appears in a buffer called @file{*MH-E Help*}
(@pxref{Miscellaneous}).} (@kbd{C-c ?} in MH-Letter mode), or @kbd{C-h
-i} to read this manual via Info. The online help is quite good; try
+i} to read this manual via Info. The built-in help is quite good; try
running @kbd{C-h C-h}. This brings up a list of available help topics,
one of which displays the documentation for a given key (like @kbd{C-h
k C-n}). Another useful help feature is to view the manual section
@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 available
-online in the Info system by typing @kbd{C-h i m Emacs Lisp
+@footnote{The @cite{GNU Emacs Lisp Reference Manual} should be available
+via the Info system by typing @kbd{C-h i m Emacs Lisp
@key{RET}}. It is also available online at @*
@uref{http://www.gnu.org/software/emacs/manual/elisp.html}.}
@end iftex
@ifinfo
@footnote{@xref{Top, The GNU Emacs Lisp Reference Manual, , elisp, GNU
-Emacs Lisp Reference Manual}, which may be available online in the
+Emacs Lisp Reference Manual}, which should be available via the
Info system. It is also available online at
@uref{http://www.gnu.org/software/emacs/manual/elisp.html}.}
@end ifinfo
@ifhtml
@footnote{The
@uref{http://www.gnu.org/software/emacs/manual/elisp.html,
-The GNU Emacs Lisp Reference Manual} may also be available online in
+The GNU Emacs Lisp Reference Manual} should be available via
the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}.}
@end ifhtml
and you can look at the code itself for examples. Look in the Emacs
@file{/usr/local/share/emacs/lisp/mh-e}) and find all the @file{mh-*.el}
files there. When calling MH-E and other Emacs Lisp functions directly
from Emacs Lisp code, you'll need to know the correct arguments. Use
-the online help for this. For example, try @kbd{C-h f
+the built-in help for this. For example, try @kbd{C-h f
mh-execute-commands @key{RET}}. If you write your own functions,
please do not prefix your symbols (variables and functions) with
@samp{mh-}. This prefix is reserved for the MH-E package. To avoid
@findex display-time
@vindex read-mail-command
-There are some commands that need to read mail, such as @kbd{Mouse-2}
+There are some commands that need to read mail, such as @kbd{mouse-2}
over the @samp{Mail} button that @code{display-time} adds to the mode
line. You can configure Emacs to have these commands use MH-E by
setting the option @code{read-mail-command} to @samp{mh-rmail}.
Unpack message created with @command{uudecode} or @command{shar}
(@code{mh-store-msg}).
@c -------------------------
-@kindex Mouse-2
+@kindex mouse-2
@findex mh-show-mouse
-@item Mouse-2
+@item mouse-2
Move point to mouse event and show message (@code{mh-show-mouse}).
@end table
@table @kbd
@kindex @key{RET}
-@kindex Mouse-1
-@kindex Mouse-2
+@kindex mouse-1
+@kindex mouse-2
@findex mh-press-button
@item @key{RET}
-@itemx Mouse-1
-@itemx Mouse-2
+@itemx mouse-1
+@itemx mouse-2
View contents of button (@code{mh-press-button}).
@end table
@kindex @key{BS}
@kindex @key{RET}
@kindex @key{SPC}
-@kindex Mouse-2
+@kindex mouse-2
The command @key{RET} (@code{mh-show}) displays the message that the
-cursor is on while @kbd{Mouse-2} (@code{mh-show-mouse}) displays the
+cursor is on while @kbd{mouse-2} (@code{mh-show-mouse}) displays the
message that the mouse cursor is on. If the message is already
displayed, it scrolls to the beginning of the message. Use @key{SPC}
(@code{mh-page-msg}) and @key{BS} (@code{mh-previous-page}) to move
@cindex links, following
@findex goto-address-at-point
@kindex C-c @key{RET}
-@kindex Mouse-2
+@kindex mouse-2
@vindex goto-address-highlight-p
Email addresses and URLs in the message are highlighted if the option
@code{goto-address-highlight-p} is on, which it is by default. To view
the web page for a highlighted URL or to send a message using a
-highlighted email address, use @kbd{Mouse-2} or @kbd{C-c @key{RET}}
+highlighted email address, use @kbd{mouse-2} or @kbd{C-c @key{RET}}
(@code{goto-address-at-point}). @xref{Sending Mail}, to see how to
configure Emacs to send the message using MH-E.
@kindex @key{RET}
@kindex K @key{TAB}
@kindex K S-@key{TAB}
-@kindex Mouse-1
-@kindex Mouse-2
+@kindex mouse-1
+@kindex mouse-2
-To view the contents of the button, use either @kbd{Mouse-1} or
-@kbd{Mouse-2} on the button or @key{RET} (@code{mh-press-button}) when
+To view the contents of the button, use either @kbd{mouse-1} or
+@kbd{mouse-2} on the button or @key{RET} (@code{mh-press-button}) when
the cursor is over the button. This command is a toggle so if you use
it again on the same attachment, it is hidden. If Emacs does not know
how to display the attachment, then Emacs offers to save the
@table @asis
@cindex browser, @samp{w3m}
@cindex @samp{w3m}
-@kindex Mouse-2
+@kindex mouse-2
@item @samp{w3m} 7
The @samp{w3m} browser requires an external program. It's quick,
produces pretty nice output, and best of all, it's the only browser
-that highlights links. These can be clicked with @kbd{Mouse-2} to view
+that highlights links. These can be clicked with @kbd{mouse-2} to view
the content of the link in @samp{w3m}. The @samp{w3m} browser handles
tables well and actually respects the table's width parameter (which
can cause text to wrap if the author didn't anticipate that the page
@cindex @file{.emacs}
@cindex files, @file{.emacs}
@findex browse-url-at-mouse
-@kindex S-Mouse-2
+@kindex S-mouse-2
A useful key binding that you can add to @file{~/.emacs} is the
following which displays an HTML link or textual URL in an external
@smalllisp
@group
(defvar my-mh-screen-saved nil
- "Set to non-@code{nil} when MH-E window configuration shown.")
+ "Set to non-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 well
+With non-nil or prefix argument, include mailbox as well
when going into mail."
(interactive "P") ; @r{user callable function, P=prefix arg}
(setq my-mh-screen-saved ; @r{save state}
@smalllisp
@group
(defvar my-mh-init-done nil
- "Non-@code{nil} when one-time MH-E settings made.")
+ "Non-nil when one-time MH-E settings made.")
(defun my-mh-folder-mode-hook ()
"Hook to set key bindings in MH-Folder mode."
The hook @code{mh-kill-folder-suppress-prompt-functions} is an abnormal
hook run at the beginning of the command @kbd{k}. The hook functions
-are called with no arguments and should return a non-nil value to
+are called with no arguments and should return a non-@code{nil} value to
suppress the normal prompt when you remove a folder. This is useful
for folders that are easily regenerated. The default value of
@code{mh-search-p} suppresses the prompt on folders generated by
@findex mh-visit-folder
@kindex F v
@kindex M-x speedbar
-@kindex Mouse-2
+@kindex mouse-2
You can also use the speedbar
@ifnothtml
to view your folders. To bring up the speedbar, run @kbd{M-x speedbar
@key{RET}}. You will see a new frame appear with all of your MH
folders. Folders with unseen messages appear in boldface. Click on a
-folder name with @kbd{Mouse-2} to visit that folder in a similar
+folder name with @kbd{mouse-2} to visit that folder in a similar
fashion to the command @kbd{F v} (@code{mh-visit-folder})
(@pxref{Folders}). Click on the @samp{+} icon to expand and view the
sub-folders of that folder.
@findex delete-frame
@kindex C-x 5 0
-@kindex Mouse-3
+@kindex mouse-3
-You can click on @kbd{Mouse-3} to bring up a context menu that
+You can click on @kbd{mouse-3} to bring up a context menu that
contains these items. Dismiss the speedbar with @kbd{C-x 5 0}
(@code{delete-frame}).
The Menu Bar} in @cite{The GNU Emacs Manual}.
@end ifhtml
-The Emacs manual describes how to get online help for a particular
+The Emacs manual describes how to get help for a particular
menu item. You can also look up a menu item in the index of this
manual in two ways: all of the menu items are listed alphabetically,
and you can also browse all of the items under the index entry