File: Using-This-Manual.html

package info (click to toggle)
mh-e 8.0.3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 8,976 kB
  • ctags: 4,351
  • sloc: lisp: 18,183; makefile: 459; sh: 97
file content (139 lines) | stat: -rw-r--r-- 7,671 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<html lang="en">
<head>
<title>Using This Manual - The MH-E Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="The MH-E Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Tour-Through-MH_002dE.html#Tour-Through-MH_002dE" title="Tour Through MH-E">
<link rel="next" href="Incorporating-Mail.html#Incorporating-Mail" title="Incorporating Mail">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This is version 8.0.3 of `The MH-E
Manual', last updated 2006-11-12.

Copyright (C) 1995, 2001, 2002, 2003, 2005, 2006 Free
Software Foundation, Inc.

     The MH-E manual is free documentation; you can redistribute it
     and/or modify it under the terms of either:

       a. the GNU Free Documentation License, Version 1.2 or any later
          version published by the Free Software Foundation; with no
          Invariant Sections, no Front-Cover Texts, and no Back-Cover
          Texts.

       b. the GNU General Public License as published by the Free
          Software Foundation; either version 2, or (at your option)
          any later version.
     The MH-E manual is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     General Public License or GNU Free Documentation License for more
     details.

     The GNU General Public License and the GNU Free Documentation
     License appear as appendices to this document. You may also
     request copies by writing to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
   -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Using-This-Manual"></a>
Next:&nbsp;<a rel="next" accesskey="n" href="Incorporating-Mail.html#Incorporating-Mail">Incorporating Mail</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Tour-Through-MH_002dE.html#Tour-Through-MH_002dE">Tour Through MH-E</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>

<h2 class="chapter">4 Using This Manual</h2>

<p>This chapter begins the meat of the manual which goes into more detail
about every MH-E command and option.

   <p><a name="index-Emacs_002c-info-199"></a><a name="index-Emacs_002c-online-help-200"></a><a name="index-info-201"></a><a name="index-online-help-202"></a><a name="index-describe_002dmode-203"></a><a name="index-mh_002dhelp-204"></a><a name="index-g_t_003f-205"></a><a name="index-C_002dc-_003f-206"></a><a name="index-C_002dh-C_002dh-207"></a><a name="index-C_002dh-C_002dk-i-208"></a><a name="index-C_002dh-i-209"></a><a name="index-C_002dh-m-210"></a>
There are many commands, but don't get intimidated. There are command
summaries at the beginning of each chapter. In case you have or would
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
<kbd>C-h m</kbd> (<code>describe-mode</code>) for a brief summary of commands,
<kbd>?</kbd> (<code>mh-help</code>) for an even briefer summary<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> (<kbd>C-c ?</kbd> in MH-Letter mode), or <kbd>C-h
i</kbd> to read this manual via Info. The online help is quite good; try
running <kbd>C-h C-h</kbd>. 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</kbd>). Another useful help feature is to view the manual section
that describes a given key (such as <kbd>C-h K i</kbd>). In addition,
review <a href="Conventions.html#Conventions">Conventions</a>, if any of the GNU Emacs conventions are
strange to you.

   <p>In addition to all of the commands, it is also possible to reconfigure
MH-E to fit the needs of even the most demanding user. The following
chapters also describe all of the options, show the defaults, and make
recommendations for customization.

   <p>However, when customizing your mail environment, first try to change
what you want in MH, and only change MH-E if changing MH is not
possible. That way you will get the same behavior inside and outside
GNU Emacs. Note that MH-E does not provide hooks for customizations
that can be done in MH; this omission is intentional.

   <p><a name="index-Emacs-Lisp-Manual-211"></a><a name="index-Emacs_002c-Emacs-Lisp-Manual-212"></a><a name="index-Emacs_002c-info-213"></a><a name="index-Emacs_002c-online-help-214"></a><a name="index-info-215"></a><a name="index-online-help-216"></a>
I 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 does
exist,
<!-- Yes, some of the stuff in the following sections is redundant, but -->
<!-- TeX barfs if the @ifs are inside the @footnote. -->
<a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a>
and you can look at the code itself for examples. Look in the Emacs
Lisp directory on your system (such as
<samp><span class="file">/usr/local/lib/emacs/lisp/mh-e</span></samp>) and find all the <samp><span class="file">mh-*.el</span></samp>
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
mh-execute-commands &lt;RET&gt;</kbd>. If you write your own functions,
please do not prefix your symbols (variables and functions) with
`<samp><span class="samp">mh-</span></samp>'. This prefix is reserved for the MH-E package. To avoid
conflicts with existing MH-E symbols, use a prefix like `<samp><span class="samp">my-</span></samp>' or
your initials. (Unless, of course, your initials happen to be <em>mh</em>!)

<ul class="menu">
<li><a accesskey="1" href="Options.html#Options">Options</a>
<li><a accesskey="2" href="Ranges.html#Ranges">Ranges</a>
<li><a accesskey="3" href="Folder-Selection.html#Folder-Selection">Folder Selection</a>
</ul>

   <div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> This
help appears in a buffer called `<samp><span class="samp">*MH-E Help*</span></samp>'
(see <a href="Miscellaneous.html#Miscellaneous">Miscellaneous</a>).</p>

   <p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> The
<a href="http://www.gnu.org/software/emacs/elisp-manual/html_node/">The GNU Emacs Lisp Reference Manual</a> may also be available online in
the Info system by typing <kbd>C-h i m Emacs Lisp &lt;RET&gt;</kbd>. You can
also order a printed manual, which has the desirable side-effect of
helping to support the Free Software Foundation which made all this
great software available. You can find an order form by running
<kbd>C-h C-d</kbd>, or you can request an order form from <i>gnu at
gnu.org</i>.</p>

   <p><hr></div>

   </body></html>