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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<html lang="en">
<head>
<title>Conventions - 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="Preface.html#Preface" title="Preface">
<link rel="next" href="Getting-Started.html#Getting-Started" title="Getting Started">
<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="Conventions"></a>
Next: <a rel="next" accesskey="n" href="Getting-Started.html#Getting-Started">Getting Started</a>,
Previous: <a rel="previous" accesskey="p" href="Preface.html#Preface">Preface</a>,
Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">1 GNU Emacs Terms and Conventions</h2>
<p><a name="index-Emacs-12"></a><a name="index-Emacs_002c-conventions-13"></a><a name="index-Emacs_002c-terms-14"></a><a name="index-Unix-commands_002c-Emacs-15"></a><a name="index-conventions_002c-Emacs-16"></a><a name="index-terms_002c-Emacs-17"></a>
If you're an experienced Emacs user, you can skip the following
conventions and definition of terms and go directly to the next
section (see <a href="Getting-Started.html#Getting-Started">Getting Started</a>).
<p><a name="index-Emacs-commands-18"></a><a name="index-MH-commands-19"></a><a name="index-Unix-commands-20"></a><a name="index-commands-21"></a><a name="index-commands_002c-MH-22"></a><a name="index-commands_002c-Unix-23"></a><a name="index-commands_002c-shell-24"></a><a name="index-functions-25"></a><a name="index-shell-commands-26"></a>
In general, <dfn>functions</dfn> in this text refer to Emacs Lisp functions
that one would call from within Emacs Lisp programs (for example,
<code>(mh-inc-folder)</code>). On the other hand, <dfn>commands</dfn> are those
things that are run by the user, such as <kbd>i</kbd> or <kbd>M-x
mh-inc-folder</kbd>. Programs outside of Emacs are specifically called MH
commands, shell commands, or Unix commands.
<p><a name="index-conventions_002c-key-names-27"></a><a name="index-key-names-28"></a>
The conventions for key names are as follows:
<dl>
<dt><kbd>C-x</kbd><dd>Hold down the <CTRL> (Control) key and press the <kbd>x</kbd> key.
<!-- -->
<br><dt><kbd>M-x</kbd><dd>Hold down the <META> or <ALT> key and press the <kbd>x</kbd> key.
<p>Since some keyboards don't have a <META> key, you can generate
<kbd>M-x</kbd>, for example, by pressing <ESC> (Escape),
<em>releasing it</em>, and then pressing the <kbd>x</kbd> key.
<!-- -->
<br><dt><kbd><RET></kbd><dd>Press the <RETURN> or <ENTER> key. This is normally used to
complete a command.
<!-- -->
<br><dt><kbd><SPC></kbd><dd>Press the space bar.
<!-- -->
<br><dt><kbd><TAB></kbd><dd>Press the <TAB> key.
<!-- -->
<br><dt><kbd><DEL></kbd><dd>Press the <DELETE> key.
<!-- -->
<br><dt><kbd><BS></kbd><dd>Press the <BACKSPACE> key<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>.
</dl>
<p><a name="index-Emacs_002c-prefix-argument-29"></a><a name="index-prefix-argument-30"></a><a name="index-C_002du-31"></a>
A <dfn>prefix argument</dfn> allows you to pass an argument to any Emacs
function. To pass an argument, type <kbd>C-u</kbd> before the Emacs command
or keystroke. Numeric arguments can be passed as well. For example, to
insert five f's, use <kbd>C-u 5 f</kbd>. There is a default of four when
using <kbd>C-u</kbd>, and you can use multiple prefix arguments to provide
arguments of powers of four. To continue our example, you could insert
four f's with <kbd>C-u f</kbd>, 16 f's with <kbd>C-u C-u f</kbd>, 64 f's with
<kbd>C-u C-u C-u f</kbd>, and so on. Numeric and valueless negative
arguments can also be inserted with the <META> key. Examples
include <kbd>M-5</kbd> to specify an argument of 5, or <kbd>M--</kbd> which
specifies a negative argument with no particular value.
<pre class="sp">
</pre>
<div align="center"><strong>NOTE</strong></div>
<blockquote>
The prefix <kbd>C-u</kbd> or <kbd>M-</kbd> is not necessary in MH-E's MH-Folder
mode (see <a href="Reading-Mail-Tour.html#Reading-Mail-Tour">Reading Mail Tour</a>). In this mode, simply enter the
numerical argument before entering the command.
</blockquote>
<pre class="sp">
</pre>
<a name="index-g_t_0040file_007b_002eemacs_007d-32"></a><a name="index-Emacs_002c-variables-33"></a><a name="index-files_002c-_0040file_007b_002eemacs_007d-34"></a><a name="index-variables-35"></a><a name="index-setq-36"></a>
Emacs uses <dfn>variables</dfn> to hold values. These can be changed via
calls to the function <code>setq</code> in <samp><span class="file">~/.emacs</span></samp>.
<p><a name="index-Emacs_002c-options-37"></a><a name="index-options-38"></a><a name="index-customize_002dgroup-39"></a><a name="index-customize_002doption-40"></a>
Variables in MH-E that are normally modified by the user are called
<dfn>options</dfn> and are modified through the customize functions (such
as <kbd>M-x customize-option</kbd> or <kbd>M-x customize-group</kbd>).
See section
<a href="http://www.gnu.org/software/emacs/manual/html_node/Easy-Customization.html">Easy Customization</a> in <cite>The GNU Emacs Manual</cite>.
See <a href="Options.html#Options">Options</a>.
<p><a name="index-Emacs_002c-faces-41"></a><a name="index-faces-42"></a><a name="index-highlighting-43"></a><a name="index-customize_002dface-44"></a>
You can specify various styles for displaying text using <dfn>faces</dfn>.
MH-E provides a set of faces that you can use to personalize the look
of your MH-E buffers. Use the command <kbd>M-x customize-face</kbd> to do
this.
See section
<a href="http://www.gnu.org/software/emacs/manual/html_node/Face-Customization.html">Face Customization</a> in <cite>The GNU Emacs Manual</cite>.
<p><a name="index-abnormal-hooks-45"></a><a name="index-hooks-46"></a><a name="index-normal-hooks-47"></a><a name="index-add_002dhook-48"></a><a name="index-customize_002doption-49"></a>
Commands often offer <dfn>hooks</dfn> which enable you to extend or modify
the way a command works.
See section
<a href="http://www.gnu.org/software/emacs/manual/html_node/Hooks.html">Hooks</a> in <cite>The GNU Emacs Manual</cite>
for a description about <dfn>normal hooks</dfn> and <dfn>abnormal hooks</dfn>.
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</code> and all
the rest of the MH-E hooks end in <code>-hook</code>. You can add hooks with
either <code>customize-option</code> or <code>add-hook</code>.
<p><a name="index-Emacs_002c-mark-50"></a><a name="index-Emacs_002c-point-51"></a><a name="index-Emacs_002c-region-52"></a><a name="index-mark-53"></a><a name="index-point-54"></a><a name="index-region-55"></a><a name="index-C_002d_0040_0040-56"></a><a name="index-C_002d_0040key_007bSPC_007d-57"></a>
There are several other terms that are used in Emacs that you should
know. The <dfn>point</dfn> is where the cursor currently is. You can save
your current place in the file by setting a <dfn>mark</dfn>. This operation
is useful in several ways. The mark can be later used when defining a
<dfn>region</dfn>, which is the text between the point and mark. Many
commands operate on regions, such as those for deleting text or
filling paragraphs. A mark can be set with <kbd>C-@</kbd> (or
<kbd>C-<SPC></kbd>).
<p><a name="index-completion-58"></a><a name="index-Emacs_002c-completion-59"></a><a name="index-Emacs_002c-file-completion-60"></a><a name="index-Emacs_002c-folder-completion-61"></a><a name="index-Emacs_002c-minibuffer-62"></a><a name="index-file-completion-63"></a><a name="index-folder-completion-64"></a><a name="index-minibuffer-65"></a><a name="index-SPC-66"></a><a name="index-TAB-67"></a>
The <dfn>minibuffer</dfn> is the bottom line of the Emacs window, where all
prompting and multiple-character input is directed. You can use
<dfn>completion</dfn> to enter values such as folders. Completion means
that Emacs fills in text for you when you type <SPC> or <TAB>.
A second <SPC> or <TAB> will list all possibilities at that
point.
See the section
<a href="http://www.gnu.org/software/emacs/manual/html_node/Completion.html">Completion</a> in <cite>The GNU Emacs Manual</cite>.
Note that <SPC> cannot be used for completing filenames and
folders.
<p><a name="index-help_002dwith_002dtutorial-68"></a><a name="index-C_002dh-t-69"></a><a name="index-M_002dx-70"></a>
The minibuffer is also where you enter Emacs function names after
typing <kbd>M-x</kbd>. For example, in the preface, I mentioned that you
could obtain help with <kbd>C-h t</kbd> (<code>help-with-tutorial</code>). What
this means is that you can get a tutorial by typing either <kbd>C-h t</kbd>
or <kbd>M-x help-with-tutorial</kbd>. In the latter case, you are prompted
for `<samp><span class="samp">help-with-tutorial</span></samp>' in the minibuffer after typing
<kbd>M-x</kbd>.
<p><a name="index-g_t_007e-71"></a>
The `<samp><span class="samp">~</span></samp>' notation in filenames represents your home directory.
This notation is used by many shells including <samp><span class="command">bash</span></samp>,
<code>tcsh</code>, and <samp><span class="command">csh</span></samp>. It is analogous to the environment
variable `<samp><span class="samp">$HOME</span></samp>'. For example, <samp><span class="file">~/.emacs</span></samp> can be written
<samp><span class="file">$HOME/.emacs</span></samp> or using the absolute path as in
<samp><span class="file">/home/wohler/.emacs</span></samp> instead.
<p><a name="index-Emacs_002c-interrupting-72"></a><a name="index-Emacs_002c-quitting-73"></a><a name="index-interrupting-74"></a><a name="index-quitting-75"></a>
<i>In case of trouble:</i> Emacs can be interrupted at any time with
<kbd>C-g</kbd>. For example, if you've started a command that requests that
you enter something in the minibuffer, but then you change your mind,
type <kbd>C-g</kbd> and you'll be back where you started. If you want to
exit Emacs entirely, use <kbd>C-x C-c</kbd>.
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> If you are using Version 20 or
earlier of Emacs, you will need to use the <DEL> key.</p>
<p><hr></div>
</body></html>
|
