Cleanup uses of "-hooks".
[bpt/emacs.git] / doc / misc / mh-e.texi
index 77c774c..e59b312 100644 (file)
@@ -8,12 +8,12 @@
 @c %**end of header
 
 @c Version of the software and manual.
-@set VERSION 8.1
+@set VERSION 8.3
 @c Edition of the manual. It is either empty for the first edition or
 @c has the form ", nth Edition" (without the quotes).
 @set EDITION
-@set UPDATED 2008-08-18
-@set UPDATE-MONTH August, 2008
+@set UPDATED 2011-09-20
+@set UPDATE-MONTH September, 2011
 
 @c Other variables.
 @set MH-BOOK-HOME http://rand-mh.sourceforge.net/book/mh
 This is version @value{VERSION}@value{EDITION} of @cite{The MH-E
 Manual}, last updated @value{UPDATED}.
 
-Copyright @copyright{} 1995, 2001, 2002, 2003, 2005, 2006, 2007, 2008
-Free Software Foundation, Inc.
+Copyright @copyright{} 1995, 2001-2003, 2005-2012  Free Software Foundation, Inc.
+
+@c This dual license has been agreed upon by the FSF.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 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 Back-Cover Texts as in (a) below.  A copy of the license
-is included in the section entitled ``GNU Free Documentation License.''
+under the terms of either:
+
+@enumerate a
+@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
+Back-Cover Texts as in (a) below. A copy of the license is included in
+the section entitled ``GNU Free Documentation License.''
 
 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual.  Buying copies from the FSF supports it in
+modify this GNU manual. Buying copies from the FSF supports it in
 developing GNU and promoting software freedom.''
+
+@item
+the GNU General Public License as published by the Free Software
+Foundation; either version 3, or (at your option) any later version. A
+copy of the license is included in the section entitled ``GNU General
+Public License.''
+@end enumerate
+
 @end quotation
 @end copying
 
 @c Info Directory Entry
-@dircategory Emacs
+@dircategory Emacs network features
 @direntry
-* MH-E: (mh-e).                Emacs interface to the MH mail system.
+* MH-E: (mh-e).                 Emacs interface to the MH mail system.
 @end direntry
 
 @c Title Page
-@setchapternewpage odd
 @titlepage
 @title The MH-E Manual
 @subtitle Version @value{VERSION}@value{EDITION}
@@ -107,6 +119,7 @@ developing GNU and promoting software freedom.''
 * Odds and Ends::               Odds and Ends
 * History::                     History of MH-E
 * GFDL::                        GNU Free Documentation License
+* GPL::                         GNU General Public License
 * Key Index::                   Key (Character) Index
 * Command Index::               Command Index
 * Option Index::                Option (Variable) Index
@@ -198,11 +211,12 @@ However, MH-E was the tip of the iceberg, and I discovered more and
 more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of
 them.
 
-The MH-E package is distributed with GNU Emacs@footnote{Version
-@value{VERSION} of MH-E will appear in GNU Emacs 23.1. It is supported
-in GNU Emacs 21 and 22, as well as XEmacs 21 (except for versions
-21.5.9-21.5.16). It is compatible with MH versions 6.8.4 and higher,
-all versions of nmh, and GNU mailutils 1.0 and higher.}, so you
+The MH-E package is distributed with Emacs@footnote{Version
+@value{VERSION} of MH-E appeared in Emacs 24.1. It is supported in GNU
+Emacs 23 and higher, as well as XEmacs 21.4.22 and 21.5.31. MH-E is
+known not to work with GNU Emacs versions 20 and below, and XEmacs
+version 21.5.9 - 21.5.16. It is compatible with MH versions 6.8.4 and
+higher, all versions of nmh, and GNU mailutils 1.0 and higher}, so you
 shouldn't have to do anything special to use it. Gnus is also
 required; version 5.10 or higher is recommended. This manual covers
 MH-E version @value{VERSION}. To help you decide which version you
@@ -415,7 +429,7 @@ for a description about @dfn{normal hooks} and @dfn{abnormal hooks}.
 MH-E uses normal hooks in nearly all cases, so you can assume that we
 are talking about normal hooks unless we explicitly mention that a
 hook is abnormal. We also follow the conventions described in that
-section: the name of the abnormal hooks end in @code{-hooks} and all
+section: the name of the abnormal hooks end in @code{-functions} and all
 the rest of the MH-E hooks end in @code{-hook}. You can add hooks with
 either @code{customize-option} or @code{add-hook}.
 
@@ -563,7 +577,8 @@ the more you can leverage its power. See the
 @cindex MH profile component, @samp{Path:}
 
 Your MH environment includes your @dfn{MH profile} which is found in
-the file @file{~/.mh_profile}. This file contains a number of @dfn{MH
+the file @file{~/.mh_profile}, or the file named in the environment
+variable @samp{$MH}. This file contains a number of @dfn{MH
 profile components}. For example, the @samp{Path:} MH profile
 component contains the path to your mail directory, which is
 @file{~/Mail} by default.
@@ -2651,7 +2666,7 @@ documentation for the Gnus command @kbd{W h} (see section
 @findex browse-url-at-mouse
 @kindex S-Mouse-2
 
-A useful key binding that you can add to to @file{~/.emacs} is the
+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
 browser when clicked with @kbd{S-mouse-2}. This binding works in any
 buffer, including HTML buffers.
@@ -3397,6 +3412,10 @@ Hook run by @code{mh-folder-mode} when visiting a new folder (default:
 Abnormal hook run at the beginning of @code{mh-kill-folder} (default:
 @code{'mh-search-p}).
 @c -------------------------
+@item mh-pack-folder-hook
+Hook run by @code{mh-pack-folder} after renumbering the messages
+(default: @code{nil}).
+@c -------------------------
 @item mh-quit-hook
 Hook run by q after quitting MH-E (default: @code{nil}).
 @c -------------------------
@@ -3713,6 +3732,13 @@ to rescan the folder, which is useful to grab all messages in your
 you don't want to rescan the entire folder, the commands @kbd{F r} or
 @kbd{F p} will accept a range (@pxref{Ranges}).
 
+@kindex F p
+@vindex mh-pack-folder-hook
+
+The command @kbd{F p} runs @code{mh-pack-folder-hook} after
+renumbering the messages. A variable that is useful with this hook
+is @code{mh-current-folder}.
+
 @kindex @key{TAB}
 @vindex mh-recursive-folders-flag
 
@@ -3723,9 +3749,9 @@ when you press @key{TAB} when prompted for a folder name.
 
 @findex mh-search-p
 @kindex k
-@vindex mh-kill-folder-suppress-prompt-hooks
+@vindex mh-kill-folder-suppress-prompt-functions
 
-The hook @code{mh-kill-folder-suppress-prompt-hooks} is an abnormal
+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
 suppress the normal prompt when you remove a folder. This is useful
@@ -6955,8 +6981,8 @@ base=/home/user/Mail
 # are subfolders within the folder
 mh=archive...:inbox:drafts:news:sent:trash
 
-vfolder_format=raw
-database=/home/user/Mail/mairix/database
+vfolder_format=mh
+database=/home/user/Mail/.mairix/database
 @end group
 @end smallexample
 
@@ -6997,7 +7023,7 @@ daily from cron:
 
 @smallexample
 mknmz -f /home/user/Mail/.namazu/mknmzrc -O /home/user/Mail/.namazu \
-         /home/user/Mail
+      -q /home/user/Mail
 @end smallexample
 
 @subsection pick
@@ -7741,7 +7767,7 @@ will need to run @samp{sa-learn --rebuild} periodically. This can be
 done by adding the following to your @file{crontab}:
 
 @smallexample
-0 * * * *      sa-learn --rebuild > /dev/null 2>&1
+0 * * * *       sa-learn --rebuild > /dev/null 2>&1
 @end smallexample
 
 @subheading Bogofilter
@@ -7875,7 +7901,7 @@ PATH=$PATH:/usr/bin/mh
 MAILDIR=$HOME/`mhparam Path`
 
 #
-# Filter messages with win32 executables/virii.
+# Filter messages with w32 executables/virii.
 #
 # These attachments are base64 and have a TVqQAAMAAAAEAAAA//8AALg
 # pattern. The string "this program cannot be run in MS-DOS mode"
@@ -8025,8 +8051,11 @@ Program used to scan messages (default: @code{"scan"}).
 There are a couple of caveats when creating your own scan format file.
 First, MH-E will not work if your scan lines do not include message
 numbers. It will work poorly if you don't dedicate a column for
-showing the current message and notations. You won't be able to use
-the option @code{mh-adaptive-cmd-note-flag} or the threading features
+showing the current message and notations. It is also best to keep the
+first column empty to make room for the cursor and so that text isn't
+obscured by the current message's overlay arrow when running in a
+terminal. You won't be able to use the option
+@code{mh-adaptive-cmd-note-flag} or the threading features
 (@pxref{Threading}).
 
 @cindex message numbers
@@ -8928,11 +8957,15 @@ new features and several bug fixes.
 
 Bill Wohler, August 2008
 
-@node GFDL, Key Index, History, Top
-@appendix GNU FREE DOCUMENTATION LICENSE
+@node GFDL, GPL, History, Top
+@appendix GNU Free Documentation License
 @include doclicense.texi
 
-@node Key Index, Command Index, GFDL, Top
+@node GPL, Key Index, GFDL, Top
+@appendix GNU General Public License
+@include gpl.texi
+
+@node Key Index, Command Index, GPL, Top
 @unnumbered Key (Character) Index
 @printindex ky
 
@@ -9027,7 +9060,3 @@ Bill Wohler, August 2008
 @c Local Variables:
 @c sentence-end-double-space: nil
 @c End:
-
-@ignore
-   arch-tag: b778477d-1a10-4a99-84de-f877a2ea6bef
-@end ignore