Mercurial > emacs
annotate man/custom.texi @ 53283:019243f7a304
(vc-dired-purge): Avoid error from `kill-line'.
author | Markus Rost <rost@math.uni-bielefeld.de> |
---|---|
date | Wed, 24 Dec 2003 23:18:10 +0000 |
parents | 3649390c0f91 |
children | 326aa7651bd6 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
44278
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
2 @c Copyright (C) 1985,86,87,93,94,95,97,2000,2001,2002 |
28126 | 3 @c Free Software Foundation, Inc. |
25829 | 4 @c See file emacs.texi for copying conditions. |
5 @node Customization, Quitting, Amusements, Top | |
6 @chapter Customization | |
7 @cindex customization | |
8 | |
9 This chapter talks about various topics relevant to adapting the | |
10 behavior of Emacs in minor ways. See @cite{The Emacs Lisp Reference | |
40519
9b9cd5d7c886
Add xref to X Resources.
Richard M. Stallman <rms@gnu.org>
parents:
39544
diff
changeset
|
11 Manual} for how to make more far-reaching changes. @xref{X Resources}, |
9b9cd5d7c886
Add xref to X Resources.
Richard M. Stallman <rms@gnu.org>
parents:
39544
diff
changeset
|
12 for information on using X resources to customize Emacs. |
25829 | 13 |
38322
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
14 Customization that you do within Emacs normally affects only the |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
15 particular Emacs session that you do it in--it does not persist |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
16 between sessions unless you save the customization in a file such as |
38744
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
17 @file{.emacs} or @file{.Xdefaults} that will affect future sessions. |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
18 @xref{Init File}. In the customization buffer, when you save |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
19 customizations for future sessions, this actually works by editing |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
20 @file{.emacs} for you. |
25829 | 21 |
52227
fd6d7ba60ecf
(Customization): Add xref to Keyboard Macros chapter.
Kim F. Storm <storm@cua.dk>
parents:
51448
diff
changeset
|
22 Another means of customization is the keyboard macro, which is a |
fd6d7ba60ecf
(Customization): Add xref to Keyboard Macros chapter.
Kim F. Storm <storm@cua.dk>
parents:
51448
diff
changeset
|
23 sequence of keystrokes to be replayed with a single command. |
fd6d7ba60ecf
(Customization): Add xref to Keyboard Macros chapter.
Kim F. Storm <storm@cua.dk>
parents:
51448
diff
changeset
|
24 @xref{Keyboard Macros}, for full instruction how to record, manage, and |
fd6d7ba60ecf
(Customization): Add xref to Keyboard Macros chapter.
Kim F. Storm <storm@cua.dk>
parents:
51448
diff
changeset
|
25 replay sequences of keys. |
fd6d7ba60ecf
(Customization): Add xref to Keyboard Macros chapter.
Kim F. Storm <storm@cua.dk>
parents:
51448
diff
changeset
|
26 |
25829 | 27 @menu |
28 * Minor Modes:: Each minor mode is one feature you can turn on | |
29 independently of any others. | |
30 * Variables:: Many Emacs commands examine Emacs variables | |
31 to decide what to do; by setting variables, | |
32 you can control their functioning. | |
33 * Key Bindings:: The keymaps say what command each key runs. | |
34 By changing them, you can "redefine keys". | |
35 * Keyboard Translations:: | |
36 If your keyboard passes an undesired code | |
37 for a key, you can tell Emacs to | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47535
diff
changeset
|
38 substitute another code. |
25829 | 39 * Syntax:: The syntax table controls how words and |
40 expressions are parsed. | |
41 * Init File:: How to write common customizations in the | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47535
diff
changeset
|
42 @file{.emacs} file. |
25829 | 43 @end menu |
44 | |
45 @node Minor Modes | |
46 @section Minor Modes | |
47 @cindex minor modes | |
48 @cindex mode, minor | |
49 | |
50 Minor modes are optional features which you can turn on or off. For | |
51 example, Auto Fill mode is a minor mode in which @key{SPC} breaks lines | |
52 between words as you type. All the minor modes are independent of each | |
53 other and of the selected major mode. Most minor modes say in the mode | |
54 line when they are on; for example, @samp{Fill} in the mode line means | |
55 that Auto Fill mode is on. | |
56 | |
57 Append @code{-mode} to the name of a minor mode to get the name of a | |
58 command function that turns the mode on or off. Thus, the command to | |
59 enable or disable Auto Fill mode is called @kbd{M-x auto-fill-mode}. These | |
60 commands are usually invoked with @kbd{M-x}, but you can bind keys to them | |
61 if you wish. With no argument, the function turns the mode on if it was | |
62 off and off if it was on. This is known as @dfn{toggling}. A positive | |
63 argument always turns the mode on, and an explicit zero argument or a | |
64 negative argument always turns it off. | |
65 | |
38322
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
66 Some minor modes are global: while enabled, they affect everything |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
67 you do in the Emacs session, in all buffers. Other minor modes are |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
68 buffer-local; they apply only to the current buffer, so you can enable |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
69 the mode in certain buffers and not others. |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
70 |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
71 For most minor modes, the command name is also the name of a |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
72 variable which directly controls the mode. The mode is enabled |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
73 whenever this variable's value is non-@code{nil}, and the minor-mode |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
74 command works by setting the variable. For example, the command |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
75 @code{outline-minor-mode} works by setting the value of |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
76 @code{outline-minor-mode} as a variable; it is this variable that |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
77 directly turns Outline minor mode on and off. To check whether a |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
78 given minor mode works this way, use @kbd{C-h v} to ask for |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
79 documentation on the variable name. |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
80 |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
81 These minor-mode variables provide a good way for Lisp programs to turn |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
82 minor modes on and off; they are also useful in a file's local variables |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
83 list. But please think twice before setting minor modes with a local |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
84 variables list, because most minor modes are matter of user |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
85 preference---other users editing the same file might not want the same |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
86 minor modes you prefer. |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
87 |
245114062ee0
Explain more clearly what it takes to make a customization permanent.
Richard M. Stallman <rms@gnu.org>
parents:
38114
diff
changeset
|
88 The buffer-local minor modes include Abbrev mode, Auto Fill mode, |
38870
d44abb4e68b2
Don't use "print" for displaying a message.
Richard M. Stallman <rms@gnu.org>
parents:
38791
diff
changeset
|
89 Auto Save mode, Font-Lock mode, Glasses mode, ISO Accents mode, |
d44abb4e68b2
Don't use "print" for displaying a message.
Richard M. Stallman <rms@gnu.org>
parents:
38791
diff
changeset
|
90 Outline minor mode, Overwrite mode, and Binary Overwrite mode. |
25829 | 91 |
92 Abbrev mode allows you to define abbreviations that automatically expand | |
93 as you type them. For example, @samp{amd} might expand to @samp{abbrev | |
94 mode}. @xref{Abbrevs}, for full information. | |
95 | |
96 Auto Fill mode allows you to enter filled text without breaking lines | |
97 explicitly. Emacs inserts newlines as necessary to prevent lines from | |
98 becoming too long. @xref{Filling}. | |
99 | |
100 Auto Save mode causes the contents of a buffer to be saved | |
101 periodically to reduce the amount of work you can lose in case of a | |
102 system crash. @xref{Auto Save}. | |
103 | |
104 Enriched mode enables editing and saving of formatted text. | |
105 @xref{Formatted Text}. | |
106 | |
107 Flyspell mode automatically highlights misspelled words. | |
108 @xref{Spelling}. | |
109 | |
110 Font-Lock mode automatically highlights certain textual units found in | |
111 programs, such as comments, strings, and function names being defined. | |
112 This requires a window system that can display multiple fonts. | |
113 @xref{Faces}. | |
114 | |
115 ISO Accents mode makes the characters @samp{`}, @samp{'}, @samp{"}, | |
116 @samp{^}, @samp{/} and @samp{~} combine with the following letter, to | |
38744
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
117 produce an accented letter in the ISO Latin-1 character set. The |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
118 newer and more general feature of input methods more or less |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
119 supersedes ISO Accents mode. @xref{Single-Byte Character Support}. |
25829 | 120 |
121 Outline minor mode provides the same facilities as the major mode | |
122 called Outline mode; but since it is a minor mode instead, you can | |
123 combine it with any major mode. @xref{Outline Mode}. | |
124 | |
125 @cindex Overwrite mode | |
126 @cindex mode, Overwrite | |
127 Overwrite mode causes ordinary printing characters to replace existing | |
128 text instead of shoving it to the right. For example, if point is in | |
129 front of the @samp{B} in @samp{FOOBAR}, then in Overwrite mode typing a | |
130 @kbd{G} changes it to @samp{FOOGAR}, instead of producing @samp{FOOGBAR} | |
131 as usual. In Overwrite mode, the command @kbd{C-q} inserts the next | |
132 character whatever it may be, even if it is a digit---this gives you a | |
133 way to insert a character instead of replacing an existing character. | |
134 | |
37571
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
135 @findex overwrite-mode |
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
136 @kindex INSERT |
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
137 The command @code{overwrite-mode} is an exception to the rule that |
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
138 commands which toggle minor modes are normally not bound to keys: it is |
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
139 bound to the @key{INSERT} function key. This is because many other |
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
140 programs bind @key{INSERT} to similar functions. |
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
141 |
9628e53b601d
Document that overwrite-mode is bound to INSERT and add @kindex for INSERT.
Eli Zaretskii <eliz@gnu.org>
parents:
37419
diff
changeset
|
142 @findex binary-overwrite-mode |
25829 | 143 Binary Overwrite mode is a variant of Overwrite mode for editing |
144 binary files; it treats newlines and tabs like other characters, so that | |
145 they overwrite other characters and can be overwritten by them. | |
37843
e8365cfcb741
Explain how Binary Overwrite mode affects C-q.
Richard M. Stallman <rms@gnu.org>
parents:
37618
diff
changeset
|
146 In Binary Overwrite mode, digits after @kbd{C-q} specify an |
e8365cfcb741
Explain how Binary Overwrite mode affects C-q.
Richard M. Stallman <rms@gnu.org>
parents:
37618
diff
changeset
|
147 octal character code, as usual. |
25829 | 148 |
149 The following minor modes normally apply to all buffers at once. | |
150 Since each is enabled or disabled by the value of a variable, you | |
151 @emph{can} set them differently for particular buffers, by explicitly | |
152 making the corresponding variables local in those buffers. | |
153 @xref{Locals}. | |
154 | |
155 Icomplete mode displays an indication of available completions when | |
156 you are in the minibuffer and completion is active. @xref{Completion | |
157 Options}. | |
158 | |
159 Line Number mode enables continuous display in the mode line of the | |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
160 line number of point, and Column Number mode enables display of the |
28126 | 161 column number. @xref{Mode Line}. |
25829 | 162 |
163 Scroll Bar mode gives each window a scroll bar (@pxref{Scroll Bars}). | |
164 Menu Bar mode gives each frame a menu bar (@pxref{Menu Bars}). Both of | |
165 these modes are enabled by default when you use the X Window System. | |
166 | |
167 In Transient Mark mode, every change in the buffer contents | |
168 ``deactivates'' the mark, so that commands that operate on the region | |
169 will get an error. This means you must either set the mark, or | |
170 explicitly ``reactivate'' it, before each command that uses the region. | |
171 The advantage of Transient Mark mode is that Emacs can display the | |
28126 | 172 region highlighted (currently only when using X). @xref{Mark}. |
25829 | 173 |
174 @node Variables | |
175 @section Variables | |
176 @cindex variable | |
177 @cindex option, user | |
178 @cindex user option | |
179 | |
180 A @dfn{variable} is a Lisp symbol which has a value. The symbol's | |
181 name is also called the name of the variable. A variable name can | |
182 contain any characters that can appear in a file, but conventionally | |
183 variable names consist of words separated by hyphens. A variable can | |
184 have a documentation string which describes what kind of value it should | |
185 have and how the value will be used. | |
186 | |
187 Lisp allows any variable to have any kind of value, but most variables | |
188 that Emacs uses require a value of a certain type. Often the value should | |
189 always be a string, or should always be a number. Sometimes we say that a | |
190 certain feature is turned on if a variable is ``non-@code{nil},'' meaning | |
191 that if the variable's value is @code{nil}, the feature is off, but the | |
192 feature is on for @emph{any} other value. The conventional value to use to | |
193 turn on the feature---since you have to pick one particular value when you | |
194 set the variable---is @code{t}. | |
195 | |
196 Emacs uses many Lisp variables for internal record keeping, as any | |
197 Lisp program must, but the most interesting variables for you are the | |
198 ones that exist for the sake of customization. Emacs does not (usually) | |
199 change the values of these variables; instead, you set the values, and | |
200 thereby alter and control the behavior of certain Emacs commands. These | |
201 variables are called @dfn{user options}. Most user options are | |
202 documented in this manual, and appear in the Variable Index | |
203 (@pxref{Variable Index}). | |
204 | |
205 One example of a variable which is a user option is @code{fill-column}, which | |
206 specifies the position of the right margin (as a number of characters from | |
207 the left margin) to be used by the fill commands (@pxref{Filling}). | |
208 | |
209 @menu | |
210 * Examining:: Examining or setting one variable's value. | |
211 * Easy Customization:: | |
212 Convenient and easy customization of variables. | |
213 * Hooks:: Hook variables let you specify programs for parts | |
214 of Emacs to run on particular occasions. | |
215 * Locals:: Per-buffer values of variables. | |
216 * File Variables:: How files can specify variable values. | |
217 @end menu | |
218 | |
219 @node Examining | |
220 @subsection Examining and Setting Variables | |
221 @cindex setting variables | |
222 | |
223 @table @kbd | |
224 @item C-h v @var{var} @key{RET} | |
225 Display the value and documentation of variable @var{var} | |
226 (@code{describe-variable}). | |
227 @item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET} | |
228 Change the value of variable @var{var} to @var{value}. | |
229 @end table | |
230 | |
231 To examine the value of a single variable, use @kbd{C-h v} | |
232 (@code{describe-variable}), which reads a variable name using the | |
233 minibuffer, with completion. It displays both the value and the | |
234 documentation of the variable. For example, | |
235 | |
236 @example | |
237 C-h v fill-column @key{RET} | |
238 @end example | |
239 | |
240 @noindent | |
241 displays something like this: | |
242 | |
243 @smallexample | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
244 fill-column's value is 70 |
25829 | 245 |
246 Documentation: | |
247 *Column beyond which automatic line-wrapping should happen. | |
248 Automatically becomes buffer-local when set in any fashion. | |
249 @end smallexample | |
250 | |
251 @noindent | |
252 The star at the beginning of the documentation indicates that this | |
253 variable is a user option. @kbd{C-h v} is not restricted to user | |
254 options; it allows any variable name. | |
255 | |
256 @findex set-variable | |
257 The most convenient way to set a specific user option is with @kbd{M-x | |
258 set-variable}. This reads the variable name with the minibuffer (with | |
259 completion), and then reads a Lisp expression for the new value using | |
260 the minibuffer a second time. For example, | |
261 | |
262 @example | |
263 M-x set-variable @key{RET} fill-column @key{RET} 75 @key{RET} | |
264 @end example | |
265 | |
266 @noindent | |
267 sets @code{fill-column} to 75. | |
268 | |
269 @kbd{M-x set-variable} is limited to user option variables, but you can | |
270 set any variable with a Lisp expression, using the function @code{setq}. | |
271 Here is a @code{setq} expression to set @code{fill-column}: | |
272 | |
273 @example | |
274 (setq fill-column 75) | |
275 @end example | |
276 | |
277 To execute an expression like this one, go to the @samp{*scratch*} | |
278 buffer, type in the expression, and then type @kbd{C-j}. @xref{Lisp | |
279 Interaction}. | |
280 | |
281 Setting variables, like all means of customizing Emacs except where | |
282 otherwise stated, affects only the current Emacs session. | |
283 | |
284 @node Easy Customization | |
285 @subsection Easy Customization Interface | |
286 | |
287 @findex customize | |
288 @cindex customization buffer | |
289 A convenient way to find the user option variables that you want to | |
43038 | 290 change, and then change them, is with @kbd{M-x customize}. This |
291 command creates a @dfn{customization buffer} with which you can browse | |
292 through the Emacs user options in a logically organized structure, | |
293 then edit and set their values. You can also use the customization | |
294 buffer to save settings permanently in your @file{~/.emacs} file | |
295 (@pxref{Init File}). | |
25829 | 296 |
31075
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
297 The appearance of the example buffers in the following is typically |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
298 different under a window system where faces can be used to indicate the |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
299 active fields and other features. |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
300 |
25829 | 301 @menu |
302 * Groups: Customization Groups. | |
303 How options are classified in a structure. | |
304 * Changing an Option:: How to edit a value and set an option. | |
47535
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
305 * Saving Customizations:: Details of saving customizations. |
25829 | 306 * Face Customization:: How to edit the attributes of a face. |
307 * Specific Customization:: Making a customization buffer for specific | |
308 options, faces, or groups. | |
309 @end menu | |
310 | |
311 @node Customization Groups | |
312 @subsubsection Customization Groups | |
313 @cindex customization groups | |
314 | |
315 For customization purposes, user options are organized into | |
316 @dfn{groups} to help you find them. Groups are collected into bigger | |
317 groups, all the way up to a master group called @code{Emacs}. | |
318 | |
319 @kbd{M-x customize} creates a customization buffer that shows the | |
320 top-level @code{Emacs} group and the second-level groups immediately | |
321 under it. It looks like this, in part: | |
322 | |
323 @smallexample | |
324 /- Emacs group: ---------------------------------------------------\ | |
325 [State]: visible group members are all at standard settings. | |
326 Customization of the One True Editor. | |
327 See also [Manual]. | |
328 | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
329 Confirm Kill Emacs: [Hide] [Value Menu] Don't confirm |
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
330 [State]: this option is unchanged from its standard setting. |
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
331 How to ask for confirmation when leaving Emacs. [More] |
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
332 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47535
diff
changeset
|
333 Editing group: [Go to Group] |
25829 | 334 Basic text editing facilities. |
335 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47535
diff
changeset
|
336 External group: [Go to Group] |
25829 | 337 Interfacing to external utilities. |
338 | |
339 @var{more second-level groups} | |
340 | |
341 \- Emacs group end ------------------------------------------------/ | |
342 | |
343 @end smallexample | |
344 | |
345 @noindent | |
346 This says that the buffer displays the contents of the @code{Emacs} | |
347 group. The other groups are listed because they are its contents. But | |
348 they are listed differently, without indentation and dashes, because | |
349 @emph{their} contents are not included. Each group has a single-line | |
350 documentation string; the @code{Emacs} group also has a @samp{[State]} | |
351 line. | |
352 | |
353 @cindex editable fields (customization buffer) | |
354 @cindex active fields (customization buffer) | |
355 Most of the text in the customization buffer is read-only, but it | |
356 typically includes some @dfn{editable fields} that you can edit. There | |
357 are also @dfn{active fields}; this means a field that does something | |
358 when you @dfn{invoke} it. To invoke an active field, either click on it | |
359 with @kbd{Mouse-1}, or move point to it and type @key{RET}. | |
360 | |
361 For example, the phrase @samp{[Go to Group]} that appears in a | |
362 second-level group is an active field. Invoking the @samp{[Go to | |
363 Group]} field for a group creates a new customization buffer, which | |
364 shows that group and its contents. This field is a kind of hypertext | |
365 link to another group. | |
366 | |
38744
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
367 The @code{Emacs} group includes a few user options itself, but |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
368 mainly it contains other groups, which contain more groups, which |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
369 contain the user options. By browsing the hierarchy of groups, you |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
370 will eventually find the feature you are interested in customizing. |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
371 Then you can use the customization buffer to set the options and faces |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
372 pertaining to that feature. You can also go straight to a particular |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
373 group by name, using the command @kbd{M-x customize-group}. |
25829 | 374 |
375 @findex customize-browse | |
376 You can view the structure of customization groups on a larger scale | |
377 with @kbd{M-x customize-browse}. This command creates a special kind of | |
378 customization buffer which shows only the names of the groups (and | |
379 options and faces), and their structure. | |
380 | |
381 In this buffer, you can show the contents of a group by invoking | |
382 @samp{[+]}. When the group contents are visible, this button changes to | |
383 @samp{[-]}; invoking that hides the group contents. | |
384 | |
385 Each group, option or face name in this buffer has an active field | |
386 which says @samp{[Group]}, @samp{[Option]} or @samp{[Face]}. Invoking | |
387 that active field creates an ordinary customization buffer showing just | |
388 that group and its contents, just that option, or just that face. | |
389 This is the way to set values in it. | |
390 | |
391 @node Changing an Option | |
392 @subsubsection Changing an Option | |
393 | |
394 Here is an example of what a user option looks like in the | |
395 customization buffer: | |
396 | |
397 @smallexample | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
398 Kill Ring Max: [Hide] 60 |
25829 | 399 [State]: this option is unchanged from its standard setting. |
400 Maximum length of kill ring before oldest elements are thrown away. | |
401 @end smallexample | |
402 | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
403 The text following @samp{[Hide]}, @samp{60} in this case, indicates |
25829 | 404 the current value of the option. If you see @samp{[Show]} instead of |
405 @samp{[Hide]}, it means that the value is hidden; the customization | |
406 buffer initially hides values that take up several lines. Invoke | |
407 @samp{[Show]} to show the value. | |
408 | |
409 The line after the option name indicates the @dfn{customization state} | |
410 of the option: in the example above, it says you have not changed the | |
411 option yet. The word @samp{[State]} at the beginning of this line is | |
412 active; you can get a menu of various operations by invoking it with | |
413 @kbd{Mouse-1} or @key{RET}. These operations are essential for | |
414 customizing the variable. | |
415 | |
416 The line after the @samp{[State]} line displays the beginning of the | |
417 option's documentation string. If there are more lines of | |
418 documentation, this line ends with @samp{[More]}; invoke this to show | |
419 the full documentation string. | |
420 | |
421 To enter a new value for @samp{Kill Ring Max}, move point to the value | |
422 and edit it textually. For example, you can type @kbd{M-d}, then insert | |
423 another number. | |
424 | |
425 When you begin to alter the text, you will see the @samp{[State]} line | |
426 change to say that you have edited the value: | |
427 | |
428 @smallexample | |
429 [State]: you have edited the value as text, but not set the option. | |
430 @end smallexample | |
431 | |
432 @cindex setting option value | |
433 Editing the value does not actually set the option variable. To do | |
434 that, you must @dfn{set} the option. To do this, invoke the word | |
435 @samp{[State]} and choose @samp{Set for Current Session}. | |
436 | |
437 The state of the option changes visibly when you set it: | |
438 | |
439 @smallexample | |
440 [State]: you have set this option, but not saved it for future sessions. | |
441 @end smallexample | |
442 | |
443 You don't have to worry about specifying a value that is not valid; | |
444 setting the option checks for validity and will not really install an | |
445 unacceptable value. | |
446 | |
447 @kindex M-TAB @r{(customization buffer)} | |
448 @findex widget-complete | |
449 While editing a value or field that is a file name, directory name, | |
450 command name, or anything else for which completion is defined, you can | |
451 type @kbd{M-@key{TAB}} (@code{widget-complete}) to do completion. | |
452 | |
453 Some options have a small fixed set of possible legitimate values. | |
454 These options don't let you edit the value textually. Instead, an | |
455 active field @samp{[Value Menu]} appears before the value; invoke this | |
456 field to edit the value. For a boolean ``on or off'' value, the active | |
457 field says @samp{[Toggle]}, and it changes to the other value. | |
458 @samp{[Value Menu]} and @samp{[Toggle]} edit the buffer; the changes | |
459 take effect when you use the @samp{Set for Current Session} operation. | |
460 | |
461 Some options have values with complex structure. For example, the | |
31075
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
462 value of @code{file-coding-system-alist} is an association list. Here |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
463 is how it appears in the customization buffer: |
25829 | 464 |
465 @smallexample | |
31075
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
466 File Coding System Alist: [Hide] |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
467 [INS] [DEL] File regexp: \.elc\' |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
468 Choice: [Value Menu] Encoding/decoding pair: |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
469 Decoding: emacs-mule |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
470 Encoding: emacs-mule |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
471 [INS] [DEL] File regexp: \(\`\|/\)loaddefs.el\' |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
472 Choice: [Value Menu] Encoding/decoding pair: |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
473 Decoding: raw-text |
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
474 Encoding: raw-text-unix |
31075
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
475 [INS] [DEL] File regexp: \.tar\' |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
476 Choice: [Value Menu] Encoding/decoding pair: |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
477 Decoding: no-conversion |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
478 Encoding: no-conversion |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
479 [INS] [DEL] File regexp: |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
480 Choice: [Value Menu] Encoding/decoding pair: |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
481 Decoding: undecided |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
482 Encoding: nil |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
483 [INS] |
31075
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
484 [State]: this option is unchanged from its standard setting. |
9c560a17ef4a
(Changing an Option): Change load-path example.
Dave Love <fx@gnu.org>
parents:
29107
diff
changeset
|
485 Alist to decide a coding system to use for a file I/O operation. [Hide] |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
486 The format is ((PATTERN . VAL) ...), |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
487 where PATTERN is a regular expression matching a file name, |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
488 @r{[@dots{}more lines of documentation@dots{}]} |
25829 | 489 @end smallexample |
490 | |
491 @noindent | |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
492 Each association in the list appears on four lines, with several |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
493 editable or ``active'' fields. You can edit the regexps and coding |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
494 systems using ordinary editing commands. You can also invoke |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
495 @samp{[Value Menu]} to switch to a kind of value---for instance, to |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
496 specify a function instead of a pair of coding systems. |
25829 | 497 |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
498 To delete an association from the list, invoke the @samp{[DEL]} button |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
499 for that item. To add an association, invoke @samp{[INS]} at the |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
500 position where you want to add it. There is an @samp{[INS]} button |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
501 between each pair of association, another at the beginning and another |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
502 at the end, so you can add the new association at any position in the |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
503 list. |
25829 | 504 |
505 @kindex TAB @r{(customization buffer)} | |
506 @kindex S-TAB @r{(customization buffer)} | |
507 @findex widget-forward | |
508 @findex widget-backward | |
509 Two special commands, @key{TAB} and @kbd{S-@key{TAB}}, are useful for | |
510 moving through the customization buffer. @key{TAB} | |
511 (@code{widget-forward}) moves forward to the next active or editable | |
512 field; @kbd{S-@key{TAB}} (@code{widget-backward}) moves backward to the | |
513 previous active or editable field. | |
514 | |
515 Typing @key{RET} on an editable field also moves forward, just like | |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
516 @key{TAB}. We set it up this way because people often type @key{RET} |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
517 when they are finished editing a field. To insert a newline within an |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
518 editable field, use @kbd{C-o} or @kbd{C-q C-j}. |
25829 | 519 |
520 @cindex saving option value | |
37618
764853859fbc
(Changing an Option): Document that "emacs -q" cannot save customizations.
Eli Zaretskii <eliz@gnu.org>
parents:
37596
diff
changeset
|
521 @cindex customized options, saving |
25829 | 522 Setting the option changes its value in the current Emacs session; |
47535
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
523 @dfn{saving} the value changes it for future sessions as well. To |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
524 save the option, invoke @samp{[State]} and select the @samp{Save for |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
525 Future Sessions} operation. This works by writing code so as to set |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
526 the option variable again each time you start Emacs (@pxref{Saving |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
527 Customizations}). |
37618
764853859fbc
(Changing an Option): Document that "emacs -q" cannot save customizations.
Eli Zaretskii <eliz@gnu.org>
parents:
37596
diff
changeset
|
528 |
25829 | 529 You can also restore the option to its standard value by invoking |
47535
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
530 @samp{[State]} and selecting the @samp{Erase Customization} operation. |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
531 There are actually three reset operations: |
25829 | 532 |
533 @table @samp | |
534 @item Reset | |
535 If you have made some modifications and not yet set the option, | |
536 this restores the text in the customization buffer to match | |
537 the actual value. | |
538 | |
539 @item Reset to Saved | |
540 This restores the value of the option to the last saved value, | |
541 and updates the text accordingly. | |
542 | |
27218 | 543 @item Erase Customization |
25829 | 544 This sets the option to its standard value, and updates the text |
545 accordingly. This also eliminates any saved value for the option, | |
546 so that you will get the standard value in future Emacs sessions. | |
47535
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
547 |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
548 @item Use Backup Value |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
549 This sets the option to a previous value that was set in the |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
550 customization buffer in this session. If you customize a variable |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
551 and then reset the variable, which discards the customized value, |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
552 you can get the customized value back again with this operation. |
25829 | 553 @end table |
554 | |
27218 | 555 @cindex comments on customized options |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
556 Sometimes it is useful to record a comment about a specific |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
557 customization. Use the @samp{Add Comment} item from the |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
558 @samp{[State]} menu to create a field for entering the comment. The |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
559 comment you enter will be saved, and displayed again if you again view |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
560 the same option in a customization buffer, even in another session. |
27218 | 561 |
25829 | 562 The state of a group indicates whether anything in that group has been |
563 edited, set or saved. You can select @samp{Set for Current Session}, | |
564 @samp{Save for Future Sessions} and the various kinds of @samp{Reset} | |
565 operation for the group; these operations on the group apply to all | |
566 options in the group and its subgroups. | |
567 | |
568 Near the top of the customization buffer there are two lines | |
569 containing several active fields: | |
570 | |
571 @smallexample | |
572 [Set for Current Session] [Save for Future Sessions] | |
27218 | 573 [Reset] [Reset to Saved] [Erase Customization] [Finish] |
25829 | 574 @end smallexample |
575 | |
36593
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
576 @vindex custom-buffer-done-function |
25829 | 577 @noindent |
27218 | 578 Invoking @samp{[Finish]} either buries or kills this customization |
36593
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
579 buffer according to the setting of the option |
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
580 @code{custom-buffer-done-function}; the default is to bury the buffer. |
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
581 Each of the other fields performs an operation---set, save or |
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
582 reset---on each of the items in the buffer that could meaningfully be |
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
583 set, saved or reset. |
25829 | 584 |
47535
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
585 @node Saving Customizations |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
586 @subsubsection Saving Customizations |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
587 |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
588 @vindex custom-file |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
589 The customization buffer normally saves customizations in |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
590 @file{~/.emacs}. If you wish, you can save customizations in another |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
591 file instead. To make this work, your @file{~/.emacs} should set |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
592 @code{custom-file} to the name of that file. Emacs loads the file |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
593 right after your @file{.emacs} if you did not load it already. For |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
594 example: |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
595 |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
596 @example |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
597 (setq custom-file "~/.emacs-custom") |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
598 @end example |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
599 |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
600 The variable @code{custom-file} is useful if you want to have |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
601 different customizations for different Emacs versions: |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
602 |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
603 @example |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
604 (if (< emacs-major-version 21) |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
605 ;; @r{Emacs 20 customization.} |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
606 (setq custom-file "~/.custom-20.el") |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
607 ;; @r{Emacs 21 customization.} |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
608 (setq custom-file "~/.custom-21.el")) |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
609 @end example |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
610 |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
611 If Emacs was invoked with the @option{-q} or @option{--no-init-file} |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
612 options (@pxref{Initial Options}), it will not let you save your |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
613 customizations in your @file{~/.emacs} init file. This is because |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
614 saving customizations from such a session would wipe out all the other |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
615 customizations you might have on your init file. |
761358848235
(Saving Customizations): New node has the info on custom-file.
Richard M. Stallman <rms@gnu.org>
parents:
46890
diff
changeset
|
616 |
25829 | 617 @node Face Customization |
618 @subsubsection Customizing Faces | |
619 @cindex customizing faces | |
620 @cindex bold font | |
621 @cindex italic font | |
622 @cindex fonts and faces | |
623 | |
624 In addition to user options, some customization groups also include | |
625 faces. When you show the contents of a group, both the user options and | |
626 the faces in the group appear in the customization buffer. Here is an | |
627 example of how a face looks: | |
628 | |
629 @smallexample | |
44278
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
630 Custom Changed Face:(sample) [Hide] |
25829 | 631 [State]: this face is unchanged from its standard setting. |
44278
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
632 Face used when the customize item has been changed. |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
633 Parent groups: => Custom Magic Faces |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
634 Attributes: [ ] Font Family: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
635 [ ] Width: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
636 [ ] Height: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
637 [ ] Weight: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
638 [ ] Slant: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
639 [ ] Underline: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
640 [ ] Overline: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
641 [ ] Strike-through: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
642 [ ] Box around text: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
643 [ ] Inverse-video: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
644 [X] Foreground: white (sample) |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
645 [X] Background: blue (sample) |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
646 [ ] Stipple: * |
2f0122b0b947
Update the `customize-face' example to reflect current reality.
Miles Bader <miles@gnu.org>
parents:
43062
diff
changeset
|
647 [ ] Inherit: * |
25829 | 648 @end smallexample |
649 | |
650 Each face attribute has its own line. The @samp{[@var{x}]} field | |
651 before the attribute name indicates whether the attribute is | |
652 @dfn{enabled}; @samp{X} means that it is. You can enable or disable the | |
653 attribute by invoking that field. When the attribute is enabled, you | |
654 can change the attribute value in the usual ways. | |
655 | |
656 On a black-and-white display, the colors you can use for the | |
657 background are @samp{black}, @samp{white}, @samp{gray}, @samp{gray1}, | |
658 and @samp{gray3}. Emacs supports these shades of gray by using | |
659 background stipple patterns instead of a color. | |
660 | |
661 Setting, saving and resetting a face work like the same operations for | |
662 options (@pxref{Changing an Option}). | |
663 | |
664 A face can specify different appearances for different types of | |
665 display. For example, a face can make text red on a color display, but | |
666 use a bold font on a monochrome display. To specify multiple | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
667 appearances for a face, select @samp{Show all display specs} in the menu you |
25829 | 668 get from invoking @samp{[State]}. |
669 | |
670 @findex modify-face | |
671 Another more basic way to set the attributes of a specific face is | |
672 with @kbd{M-x modify-face}. This command reads the name of a face, then | |
673 reads the attributes one by one. For the color and stipple attributes, | |
674 the attribute's current value is the default---type just @key{RET} if | |
675 you don't want to change that attribute. Type @samp{none} if you want | |
676 to clear out the attribute. | |
677 | |
678 @node Specific Customization | |
679 @subsubsection Customizing Specific Items | |
680 | |
681 Instead of finding the options you want to change by moving down | |
682 through the structure of groups, you can specify the particular option, | |
683 face or group that you want to customize. | |
684 | |
685 @table @kbd | |
686 @item M-x customize-option @key{RET} @var{option} @key{RET} | |
687 Set up a customization buffer with just one option, @var{option}. | |
688 @item M-x customize-face @key{RET} @var{face} @key{RET} | |
689 Set up a customization buffer with just one face, @var{face}. | |
690 @item M-x customize-group @key{RET} @var{group} @key{RET} | |
691 Set up a customization buffer with just one group, @var{group}. | |
692 @item M-x customize-apropos @key{RET} @var{regexp} @key{RET} | |
693 Set up a customization buffer with all the options, faces and groups | |
694 that match @var{regexp}. | |
695 @item M-x customize-changed-options @key{RET} @var{version} @key{RET} | |
696 Set up a customization buffer with all the options, faces and groups | |
697 whose meaning has changed since Emacs version @var{version}. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47535
diff
changeset
|
698 @item M-x customize-saved |
25829 | 699 Set up a customization buffer containing all options and faces that you |
700 have saved with customization buffers. | |
701 @item M-x customize-customized | |
702 Set up a customization buffer containing all options and faces that you | |
703 have customized but not saved. | |
704 @end table | |
705 | |
706 @findex customize-option | |
707 If you want to alter a particular user option variable with the | |
708 customization buffer, and you know its name, you can use the command | |
709 @kbd{M-x customize-option} and specify the option name. This sets up | |
710 the customization buffer with just one option---the one that you asked | |
711 for. Editing, setting and saving the value work as described above, but | |
712 only for the specified option. | |
713 | |
714 @findex customize-face | |
715 Likewise, you can modify a specific face, chosen by name, using | |
46039
3c5d96a2d05f
Doc default arg for customize-face.
Richard M. Stallman <rms@gnu.org>
parents:
45979
diff
changeset
|
716 @kbd{M-x customize-face}. By default it operates on the face used |
3c5d96a2d05f
Doc default arg for customize-face.
Richard M. Stallman <rms@gnu.org>
parents:
45979
diff
changeset
|
717 on the character after point. |
25829 | 718 |
719 @findex customize-group | |
720 You can also set up the customization buffer with a specific group, | |
721 using @kbd{M-x customize-group}. The immediate contents of the chosen | |
722 group, including option variables, faces, and other groups, all appear | |
723 as well. However, these subgroups' own contents start out hidden. You | |
724 can show their contents in the usual way, by invoking @samp{[Show]}. | |
725 | |
726 @findex customize-apropos | |
727 To control more precisely what to customize, you can use @kbd{M-x | |
728 customize-apropos}. You specify a regular expression as argument; then | |
729 all options, faces and groups whose names match this regular expression | |
730 are set up in the customization buffer. If you specify an empty regular | |
731 expression, this includes @emph{all} groups, options and faces in the | |
732 customization buffer (but that takes a long time). | |
733 | |
734 @findex customize-changed-options | |
735 When you upgrade to a new Emacs version, you might want to customize | |
736 new options and options whose meanings or default values have changed. | |
737 To do this, use @kbd{M-x customize-changed-options} and specify a | |
738 previous Emacs version number using the minibuffer. It creates a | |
739 customization buffer which shows all the options (and groups) whose | |
740 definitions have been changed since the specified version. | |
741 | |
742 @findex customize-saved | |
743 @findex customize-customized | |
744 If you change option values and then decide the change was a mistake, | |
745 you can use two special commands to revisit your previous changes. Use | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
746 @kbd{M-x customize-saved} to look at the options and faces that you have |
25829 | 747 saved. Use @kbd{M-x customize-customized} to look at the options and |
748 faces that you have set but not saved. | |
749 | |
750 @node Hooks | |
751 @subsection Hooks | |
752 @cindex hook | |
753 @cindex running a hook | |
754 | |
755 @dfn{Hooks} are an important mechanism for customization of Emacs. A | |
756 hook is a Lisp variable which holds a list of functions, to be called on | |
757 some well-defined occasion. (This is called @dfn{running the hook}.) | |
758 The individual functions in the list are called the @dfn{hook functions} | |
759 of the hook. With rare exceptions, hooks in Emacs are empty when Emacs | |
760 starts up, so the only hook functions in any given hook are the ones you | |
761 explicitly put there as customization. | |
762 | |
763 Most major modes run one or more @dfn{mode hooks} as the last step of | |
764 initialization. This makes it easy for you to customize the behavior of | |
765 the mode, by setting up a hook function to override the local variable | |
766 assignments already made by the mode. But hooks are also used in other | |
767 contexts. For example, the hook @code{suspend-hook} runs just before | |
768 Emacs suspends itself (@pxref{Exiting}). | |
769 | |
770 @cindex normal hook | |
771 Most Emacs hooks are @dfn{normal hooks}. This means that running the | |
772 hook operates by calling all the hook functions, unconditionally, with | |
773 no arguments. We have made an effort to keep most hooks normal so that | |
774 you can use them in a uniform way. Every variable in Emacs whose name | |
775 ends in @samp{-hook} is a normal hook. | |
776 | |
777 @cindex abnormal hook | |
778 There are also a few @dfn{abnormal hooks}. These variables' names end | |
779 in @samp{-hooks} or @samp{-functions}, instead of @samp{-hook}. What | |
780 makes these hooks abnormal is that there is something peculiar about the | |
781 way its functions are called---perhaps they are given arguments, or | |
782 perhaps the values they return are used in some way. For example, | |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44783
diff
changeset
|
783 @code{find-file-not-found-functions} (@pxref{Visiting}) is abnormal because |
25829 | 784 as soon as one hook function returns a non-@code{nil} value, the rest |
785 are not called at all. The documentation of each abnormal hook variable | |
786 explains in detail what is peculiar about it. | |
787 | |
788 The recommended way to add a hook function to a hook (either normal or | |
789 abnormal) is by calling @code{add-hook}. You can use any valid Lisp | |
790 function as the hook function, provided it can handle the proper number | |
791 of arguments (zero arguments, in the case of a normal hook). Of course, | |
792 not every Lisp function is @emph{useful} in any particular hook. | |
793 | |
794 For example, here's how to set up a hook to turn on Auto Fill mode | |
795 when entering Text mode and other modes based on Text mode: | |
796 | |
797 @example | |
798 (add-hook 'text-mode-hook 'turn-on-auto-fill) | |
799 @end example | |
800 | |
801 The next example shows how to use a hook to customize the indentation | |
802 of C code. (People often have strong personal preferences for one | |
803 format compared to another.) Here the hook function is an anonymous | |
804 lambda expression. | |
805 | |
806 @example | |
807 @group | |
808 (setq my-c-style | |
809 '((c-comment-only-line-offset . 4) | |
810 @end group | |
811 @group | |
812 (c-cleanup-list . (scope-operator | |
813 empty-defun-braces | |
814 defun-close-semi)) | |
815 @end group | |
816 @group | |
817 (c-offsets-alist . ((arglist-close . c-lineup-arglist) | |
818 (substatement-open . 0))))) | |
819 @end group | |
820 | |
821 @group | |
822 (add-hook 'c-mode-common-hook | |
36593
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
823 '(lambda () |
4567e1729217
custom-buffer-done-function <- Custom-buffer-done
Dave Love <fx@gnu.org>
parents:
36292
diff
changeset
|
824 (c-add-style "my-style" my-c-style t))) |
25829 | 825 @end group |
826 @end example | |
827 | |
828 It is best to design your hook functions so that the order in which | |
829 they are executed does not matter. Any dependence on the order is | |
830 ``asking for trouble.'' However, the order is predictable: the most | |
831 recently added hook functions are executed first. | |
832 | |
833 @node Locals | |
834 @subsection Local Variables | |
835 | |
836 @table @kbd | |
837 @item M-x make-local-variable @key{RET} @var{var} @key{RET} | |
838 Make variable @var{var} have a local value in the current buffer. | |
839 @item M-x kill-local-variable @key{RET} @var{var} @key{RET} | |
840 Make variable @var{var} use its global value in the current buffer. | |
841 @item M-x make-variable-buffer-local @key{RET} @var{var} @key{RET} | |
842 Mark variable @var{var} so that setting it will make it local to the | |
843 buffer that is current at that time. | |
844 @end table | |
845 | |
846 @cindex local variables | |
847 Almost any variable can be made @dfn{local} to a specific Emacs | |
848 buffer. This means that its value in that buffer is independent of its | |
849 value in other buffers. A few variables are always local in every | |
850 buffer. Every other Emacs variable has a @dfn{global} value which is in | |
851 effect in all buffers that have not made the variable local. | |
852 | |
853 @findex make-local-variable | |
854 @kbd{M-x make-local-variable} reads the name of a variable and makes it | |
855 local to the current buffer. Further changes in this buffer will not | |
856 affect others, and further changes in the global value will not affect this | |
857 buffer. | |
858 | |
859 @findex make-variable-buffer-local | |
860 @cindex per-buffer variables | |
861 @kbd{M-x make-variable-buffer-local} reads the name of a variable and | |
862 changes the future behavior of the variable so that it will become local | |
863 automatically when it is set. More precisely, once a variable has been | |
864 marked in this way, the usual ways of setting the variable automatically | |
865 do @code{make-local-variable} first. We call such variables | |
866 @dfn{per-buffer} variables. | |
867 | |
868 Major modes (@pxref{Major Modes}) always make variables local to the | |
869 buffer before setting the variables. This is why changing major modes | |
870 in one buffer has no effect on other buffers. Minor modes also work by | |
871 setting variables---normally, each minor mode has one controlling | |
872 variable which is non-@code{nil} when the mode is enabled (@pxref{Minor | |
873 Modes}). For most minor modes, the controlling variable is per buffer. | |
874 | |
875 Emacs contains a number of variables that are always per-buffer. | |
876 These include @code{abbrev-mode}, @code{auto-fill-function}, | |
877 @code{case-fold-search}, @code{comment-column}, @code{ctl-arrow}, | |
878 @code{fill-column}, @code{fill-prefix}, @code{indent-tabs-mode}, | |
879 @code{left-margin}, @code{mode-line-format}, @code{overwrite-mode}, | |
880 @code{selective-display-ellipses}, @code{selective-display}, | |
881 @code{tab-width}, and @code{truncate-lines}. Some other variables are | |
882 always local in every buffer, but they are used for internal | |
883 purposes.@refill | |
884 | |
885 A few variables cannot be local to a buffer because they are always | |
886 local to each display instead (@pxref{Multiple Displays}). If you try to | |
887 make one of these variables buffer-local, you'll get an error message. | |
888 | |
889 @findex kill-local-variable | |
890 @kbd{M-x kill-local-variable} reads the name of a variable and makes | |
891 it cease to be local to the current buffer. The global value of the | |
892 variable henceforth is in effect in this buffer. Setting the major mode | |
893 kills all the local variables of the buffer except for a few variables | |
894 specially marked as @dfn{permanent locals}. | |
895 | |
896 @findex setq-default | |
897 To set the global value of a variable, regardless of whether the | |
898 variable has a local value in the current buffer, you can use the Lisp | |
899 construct @code{setq-default}. This construct is used just like | |
900 @code{setq}, but it sets variables' global values instead of their local | |
901 values (if any). When the current buffer does have a local value, the | |
902 new global value may not be visible until you switch to another buffer. | |
903 Here is an example: | |
904 | |
905 @example | |
906 (setq-default fill-column 75) | |
907 @end example | |
908 | |
909 @noindent | |
910 @code{setq-default} is the only way to set the global value of a variable | |
911 that has been marked with @code{make-variable-buffer-local}. | |
912 | |
913 @findex default-value | |
914 Lisp programs can use @code{default-value} to look at a variable's | |
915 default value. This function takes a symbol as argument and returns its | |
916 default value. The argument is evaluated; usually you must quote it | |
917 explicitly. For example, here's how to obtain the default value of | |
918 @code{fill-column}: | |
919 | |
920 @example | |
921 (default-value 'fill-column) | |
922 @end example | |
923 | |
924 @node File Variables | |
925 @subsection Local Variables in Files | |
926 @cindex local variables in files | |
927 @cindex file local variables | |
928 | |
929 A file can specify local variable values for use when you edit the | |
930 file with Emacs. Visiting the file checks for local variable | |
931 specifications; it automatically makes these variables local to the | |
932 buffer, and sets them to the values specified in the file. | |
933 | |
934 There are two ways to specify local variable values: in the first | |
935 line, or with a local variables list. Here's how to specify them in the | |
936 first line: | |
937 | |
938 @example | |
939 -*- mode: @var{modename}; @var{var}: @var{value}; @dots{} -*- | |
940 @end example | |
941 | |
942 @noindent | |
943 You can specify any number of variables/value pairs in this way, each | |
944 pair with a colon and semicolon as shown above. @code{mode: | |
945 @var{modename};} specifies the major mode; this should come first in the | |
946 line. The @var{value}s are not evaluated; they are used literally. | |
947 Here is an example that specifies Lisp mode and sets two variables with | |
948 numeric values: | |
949 | |
950 @smallexample | |
36632
1bfc2fad762a
(File Variables): Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents:
36593
diff
changeset
|
951 ;; -*- mode: Lisp; fill-column: 75; comment-column: 50; -*- |
25829 | 952 @end smallexample |
953 | |
954 You can also specify the coding system for a file in this way: just | |
955 specify a value for the ``variable'' named @code{coding}. The ``value'' | |
956 must be a coding system name that Emacs recognizes. @xref{Coding | |
957 Systems}. | |
958 | |
34116
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
959 The @code{eval} pseudo-variable, described below, can be specified in |
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
960 the first line as well. |
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
961 |
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
962 @cindex shell scripts, and local file variables |
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
963 In shell scripts, the first line is used to identify the script |
39263 | 964 interpreter, so you cannot put any local variables there. To accommodate |
34116
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
965 for this, when Emacs visits a shell script, it looks for local variable |
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
966 specifications in the @emph{second} line. |
1c497211a58d
Docment that `eval' can be used with local variables in the first
Eli Zaretskii <eliz@gnu.org>
parents:
31075
diff
changeset
|
967 |
25829 | 968 A @dfn{local variables list} goes near the end of the file, in the |
969 last page. (It is often best to put it on a page by itself.) The local | |
970 variables list starts with a line containing the string @samp{Local | |
971 Variables:}, and ends with a line containing the string @samp{End:}. In | |
972 between come the variable names and values, one set per line, as | |
973 @samp{@var{variable}:@: @var{value}}. The @var{value}s are not | |
974 evaluated; they are used literally. If a file has both a local | |
975 variables list and a @samp{-*-} line, Emacs processes @emph{everything} | |
976 in the @samp{-*-} line first, and @emph{everything} in the local | |
977 variables list afterward. | |
978 | |
979 Here is an example of a local variables list: | |
980 | |
981 @example | |
982 ;;; Local Variables: *** | |
983 ;;; mode:lisp *** | |
984 ;;; comment-column:0 *** | |
985 ;;; comment-start: ";;; " *** | |
986 ;;; comment-end:"***" *** | |
987 ;;; End: *** | |
988 @end example | |
989 | |
990 As you see, each line starts with the prefix @samp{;;; } and each line | |
991 ends with the suffix @samp{ ***}. Emacs recognizes these as the prefix | |
992 and suffix based on the first line of the list, by finding them | |
993 surrounding the magic string @samp{Local Variables:}; then it | |
994 automatically discards them from the other lines of the list. | |
995 | |
996 The usual reason for using a prefix and/or suffix is to embed the | |
997 local variables list in a comment, so it won't confuse other programs | |
998 that the file is intended as input for. The example above is for a | |
999 language where comment lines start with @samp{;;; } and end with | |
1000 @samp{***}; the local values for @code{comment-start} and | |
1001 @code{comment-end} customize the rest of Emacs for this unusual syntax. | |
1002 Don't use a prefix (or a suffix) if you don't need one. | |
1003 | |
1004 Two ``variable names'' have special meanings in a local variables | |
1005 list: a value for the variable @code{mode} really sets the major mode, | |
1006 and a value for the variable @code{eval} is simply evaluated as an | |
1007 expression and the value is ignored. @code{mode} and @code{eval} are | |
1008 not real variables; setting variables named @code{mode} and @code{eval} | |
39544
f991379a000a
(File Variables): Emphasize the importance of having the `mode' variable
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
1009 in any other context has no special meaning. @emph{If @code{mode} is |
f991379a000a
(File Variables): Emphasize the importance of having the `mode' variable
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
1010 used to set a major mode, it should be the first ``variable'' in the |
f991379a000a
(File Variables): Emphasize the importance of having the `mode' variable
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
1011 list.} Otherwise, the entries that precede it in the list of the local |
f991379a000a
(File Variables): Emphasize the importance of having the `mode' variable
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
1012 variables are likely to be ignored, since most modes kill all local |
f991379a000a
(File Variables): Emphasize the importance of having the `mode' variable
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
1013 variables as part of their initialization. |
25829 | 1014 |
1015 You can use the @code{mode} ``variable'' to set minor modes as well as | |
1016 major modes; in fact, you can use it more than once, first to set the | |
1017 major mode and then to set minor modes which are specific to particular | |
1018 buffers. But most minor modes should not be specified in the file in | |
1019 any fashion, because they represent user preferences. | |
1020 | |
1021 For example, you may be tempted to try to turn on Auto Fill mode with | |
1022 a local variable list. That is a mistake. The choice of Auto Fill mode | |
1023 or not is a matter of individual taste, not a matter of the contents of | |
1024 particular files. If you want to use Auto Fill, set up major mode hooks | |
1025 with your @file{.emacs} file to turn it on (when appropriate) for you | |
1026 alone (@pxref{Init File}). Don't use a local variable list to impose | |
1027 your taste on everyone. | |
1028 | |
1029 The start of the local variables list must be no more than 3000 | |
1030 characters from the end of the file, and must be in the last page if the | |
1031 file is divided into pages. Otherwise, Emacs will not notice it is | |
1032 there. The purpose of this rule is so that a stray @samp{Local | |
1033 Variables:}@: not in the last page does not confuse Emacs, and so that | |
1034 visiting a long file that is all one page and has no local variables | |
1035 list need not take the time to search the whole file. | |
1036 | |
1037 Use the command @code{normal-mode} to reset the local variables and | |
1038 major mode of a buffer according to the file name and contents, | |
1039 including the local variables list if any. @xref{Choosing Modes}. | |
1040 | |
1041 @findex enable-local-variables | |
1042 The variable @code{enable-local-variables} controls whether to process | |
1043 local variables in files, and thus gives you a chance to override them. | |
1044 Its default value is @code{t}, which means do process local variables in | |
1045 files. If you set the value to @code{nil}, Emacs simply ignores local | |
1046 variables in files. Any other value says to query you about each file | |
1047 that has local variables, showing you the local variable specifications | |
1048 so you can judge. | |
1049 | |
1050 @findex enable-local-eval | |
1051 The @code{eval} ``variable,'' and certain actual variables, create a | |
1052 special risk; when you visit someone else's file, local variable | |
1053 specifications for these could affect your Emacs in arbitrary ways. | |
1054 Therefore, the option @code{enable-local-eval} controls whether Emacs | |
1055 processes @code{eval} variables, as well variables with names that end | |
1056 in @samp{-hook}, @samp{-hooks}, @samp{-function} or @samp{-functions}, | |
1057 and certain other variables. The three possibilities for the option's | |
1058 value are @code{t}, @code{nil}, and anything else, just as for | |
1059 @code{enable-local-variables}. The default is @code{maybe}, which is | |
1060 neither @code{t} nor @code{nil}, so normally Emacs does ask for | |
1061 confirmation about file settings for these variables. | |
1062 | |
1063 @node Key Bindings | |
1064 @section Customizing Key Bindings | |
1065 @cindex key bindings | |
1066 | |
1067 This section describes @dfn{key bindings}, which map keys to commands, | |
1068 and @dfn{keymaps}, which record key bindings. It also explains how | |
1069 to customize key bindings. | |
1070 | |
1071 Recall that a command is a Lisp function whose definition provides for | |
1072 interactive use. Like every Lisp function, a command has a function | |
1073 name which usually consists of lower-case letters and hyphens. | |
1074 | |
1075 @menu | |
1076 * Keymaps:: Generalities. The global keymap. | |
1077 * Prefix Keymaps:: Keymaps for prefix keys. | |
1078 * Local Keymaps:: Major and minor modes have their own keymaps. | |
1079 * Minibuffer Maps:: The minibuffer uses its own local keymaps. | |
1080 * Rebinding:: How to redefine one key's meaning conveniently. | |
1081 * Init Rebinding:: Rebinding keys with your init file, @file{.emacs}. | |
1082 * Function Keys:: Rebinding terminal function keys. | |
1083 * Named ASCII Chars:: Distinguishing @key{TAB} from @kbd{C-i}, and so on. | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1084 * Non-ASCII Rebinding:: Rebinding non-@acronym{ASCII} characters such as Latin-1. |
25829 | 1085 * Mouse Buttons:: Rebinding mouse buttons in Emacs. |
1086 * Disabling:: Disabling a command means confirmation is required | |
1087 before it can be executed. This is done to protect | |
1088 beginners from surprises. | |
1089 @end menu | |
1090 | |
1091 @node Keymaps | |
1092 @subsection Keymaps | |
1093 @cindex keymap | |
1094 | |
1095 The bindings between key sequences and command functions are recorded | |
1096 in data structures called @dfn{keymaps}. Emacs has many of these, each | |
1097 used on particular occasions. | |
1098 | |
1099 Recall that a @dfn{key sequence} (@dfn{key}, for short) is a sequence | |
1100 of @dfn{input events} that have a meaning as a unit. Input events | |
1101 include characters, function keys and mouse buttons---all the inputs | |
1102 that you can send to the computer with your terminal. A key sequence | |
1103 gets its meaning from its @dfn{binding}, which says what command it | |
1104 runs. The function of keymaps is to record these bindings. | |
1105 | |
1106 @cindex global keymap | |
1107 The @dfn{global} keymap is the most important keymap because it is | |
1108 always in effect. The global keymap defines keys for Fundamental mode; | |
1109 most of these definitions are common to most or all major modes. Each | |
1110 major or minor mode can have its own keymap which overrides the global | |
1111 definitions of some keys. | |
1112 | |
1113 For example, a self-inserting character such as @kbd{g} is | |
1114 self-inserting because the global keymap binds it to the command | |
1115 @code{self-insert-command}. The standard Emacs editing characters such | |
1116 as @kbd{C-a} also get their standard meanings from the global keymap. | |
1117 Commands to rebind keys, such as @kbd{M-x global-set-key}, actually work | |
1118 by storing the new binding in the proper place in the global map. | |
1119 @xref{Rebinding}. | |
1120 | |
1121 Meta characters work differently; Emacs translates each Meta | |
1122 character into a pair of characters starting with @key{ESC}. When you | |
1123 type the character @kbd{M-a} in a key sequence, Emacs replaces it with | |
1124 @kbd{@key{ESC} a}. A meta key comes in as a single input event, but | |
1125 becomes two events for purposes of key bindings. The reason for this is | |
1126 historical, and we might change it someday. | |
1127 | |
1128 @cindex function key | |
1129 Most modern keyboards have function keys as well as character keys. | |
1130 Function keys send input events just as character keys do, and keymaps | |
1131 can have bindings for them. | |
1132 | |
1133 On many terminals, typing a function key actually sends the computer a | |
1134 sequence of characters; the precise details of the sequence depends on | |
1135 which function key and on the model of terminal you are using. (Often | |
1136 the sequence starts with @kbd{@key{ESC} [}.) If Emacs understands your | |
1137 terminal type properly, it recognizes the character sequences forming | |
1138 function keys wherever they occur in a key sequence (not just at the | |
1139 beginning). Thus, for most purposes, you can pretend the function keys | |
1140 reach Emacs directly and ignore their encoding as character sequences. | |
1141 | |
1142 @cindex mouse | |
1143 Mouse buttons also produce input events. These events come with other | |
1144 data---the window and position where you pressed or released the button, | |
1145 and a time stamp. But only the choice of button matters for key | |
1146 bindings; the other data matters only if a command looks at it. | |
1147 (Commands designed for mouse invocation usually do look at the other | |
1148 data.) | |
1149 | |
1150 A keymap records definitions for single events. Interpreting a key | |
1151 sequence of multiple events involves a chain of keymaps. The first | |
1152 keymap gives a definition for the first event; this definition is | |
1153 another keymap, which is used to look up the second event in the | |
1154 sequence, and so on. | |
1155 | |
1156 Key sequences can mix function keys and characters. For example, | |
1157 @kbd{C-x @key{SELECT}} is meaningful. If you make @key{SELECT} a prefix | |
1158 key, then @kbd{@key{SELECT} C-n} makes sense. You can even mix mouse | |
1159 events with keyboard events, but we recommend against it, because such | |
37419
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1160 key sequences are inconvenient to use. |
25829 | 1161 |
37419
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1162 As a user, you can redefine any key; but it is usually best to stick |
44783
c00838d6756f
Explain C-c LETTER better.
Richard M. Stallman <rms@gnu.org>
parents:
44278
diff
changeset
|
1163 to key sequences that consist of @kbd{C-c} followed by a letter (upper |
c00838d6756f
Explain C-c LETTER better.
Richard M. Stallman <rms@gnu.org>
parents:
44278
diff
changeset
|
1164 or lower case). These keys are ``reserved for users,'' so they won't |
c00838d6756f
Explain C-c LETTER better.
Richard M. Stallman <rms@gnu.org>
parents:
44278
diff
changeset
|
1165 conflict with any properly designed Emacs extension. The function |
c00838d6756f
Explain C-c LETTER better.
Richard M. Stallman <rms@gnu.org>
parents:
44278
diff
changeset
|
1166 keys @key{F5} through @key{F9} are also reserved for users. If you |
c00838d6756f
Explain C-c LETTER better.
Richard M. Stallman <rms@gnu.org>
parents:
44278
diff
changeset
|
1167 redefine some other key, your definition may be overridden by certain |
c00838d6756f
Explain C-c LETTER better.
Richard M. Stallman <rms@gnu.org>
parents:
44278
diff
changeset
|
1168 extensions or major modes which redefine the same key. |
25829 | 1169 |
1170 @node Prefix Keymaps | |
1171 @subsection Prefix Keymaps | |
1172 | |
1173 A prefix key such as @kbd{C-x} or @key{ESC} has its own keymap, | |
1174 which holds the definition for the event that immediately follows | |
1175 that prefix. | |
1176 | |
1177 The definition of a prefix key is usually the keymap to use for | |
1178 looking up the following event. The definition can also be a Lisp | |
1179 symbol whose function definition is the following keymap; the effect is | |
1180 the same, but it provides a command name for the prefix key that can be | |
1181 used as a description of what the prefix key is for. Thus, the binding | |
1182 of @kbd{C-x} is the symbol @code{Ctl-X-Prefix}, whose function | |
1183 definition is the keymap for @kbd{C-x} commands. The definitions of | |
1184 @kbd{C-c}, @kbd{C-x}, @kbd{C-h} and @key{ESC} as prefix keys appear in | |
1185 the global map, so these prefix keys are always available. | |
1186 | |
1187 Aside from ordinary prefix keys, there is a fictitious ``prefix key'' | |
1188 which represents the menu bar; see @ref{Menu Bar,,,elisp, The Emacs Lisp | |
1189 Reference Manual}, for special information about menu bar key bindings. | |
1190 Mouse button events that invoke pop-up menus are also prefix keys; see | |
1191 @ref{Menu Keymaps,,,elisp, The Emacs Lisp Reference Manual}, for more | |
1192 details. | |
1193 | |
1194 Some prefix keymaps are stored in variables with names: | |
1195 | |
1196 @itemize @bullet | |
1197 @item | |
1198 @vindex ctl-x-map | |
1199 @code{ctl-x-map} is the variable name for the map used for characters that | |
1200 follow @kbd{C-x}. | |
1201 @item | |
1202 @vindex help-map | |
1203 @code{help-map} is for characters that follow @kbd{C-h}. | |
1204 @item | |
1205 @vindex esc-map | |
1206 @code{esc-map} is for characters that follow @key{ESC}. Thus, all Meta | |
1207 characters are actually defined by this map. | |
1208 @item | |
1209 @vindex ctl-x-4-map | |
1210 @code{ctl-x-4-map} is for characters that follow @kbd{C-x 4}. | |
1211 @item | |
1212 @vindex mode-specific-map | |
1213 @code{mode-specific-map} is for characters that follow @kbd{C-c}. | |
1214 @end itemize | |
1215 | |
1216 @node Local Keymaps | |
1217 @subsection Local Keymaps | |
1218 | |
1219 @cindex local keymap | |
1220 So far we have explained the ins and outs of the global map. Major | |
1221 modes customize Emacs by providing their own key bindings in @dfn{local | |
1222 keymaps}. For example, C mode overrides @key{TAB} to make it indent the | |
1223 current line for C code. Portions of text in the buffer can specify | |
1224 their own keymaps to substitute for the keymap of the buffer's major | |
1225 mode. | |
1226 | |
1227 @cindex minor mode keymap | |
1228 Minor modes can also have local keymaps. Whenever a minor mode is | |
1229 in effect, the definitions in its keymap override both the major | |
1230 mode's local keymap and the global keymap. | |
1231 | |
1232 @vindex c-mode-map | |
1233 @vindex lisp-mode-map | |
1234 The local keymaps for Lisp mode and several other major modes always | |
1235 exist even when not in use. These are kept in variables named | |
1236 @code{lisp-mode-map} and so on. For major modes less often used, the | |
1237 local keymap is normally constructed only when the mode is used for the | |
1238 first time in a session. This is to save space. If you wish to change | |
1239 one of these keymaps, you must use the major mode's @dfn{mode | |
1240 hook}---see below. | |
1241 | |
1242 All minor mode keymaps are created in advance. There is no way to | |
1243 defer their creation until the first time the minor mode is enabled. | |
1244 | |
1245 A local keymap can locally redefine a key as a prefix key by defining | |
1246 it as a prefix keymap. If the key is also defined globally as a prefix, | |
1247 then its local and global definitions (both keymaps) effectively | |
1248 combine: both of them are used to look up the event that follows the | |
1249 prefix key. Thus, if the mode's local keymap defines @kbd{C-c} as | |
1250 another keymap, and that keymap defines @kbd{C-z} as a command, this | |
1251 provides a local meaning for @kbd{C-c C-z}. This does not affect other | |
1252 sequences that start with @kbd{C-c}; if those sequences don't have their | |
1253 own local bindings, their global bindings remain in effect. | |
1254 | |
1255 Another way to think of this is that Emacs handles a multi-event key | |
1256 sequence by looking in several keymaps, one by one, for a binding of the | |
1257 whole key sequence. First it checks the minor mode keymaps for minor | |
1258 modes that are enabled, then it checks the major mode's keymap, and then | |
1259 it checks the global keymap. This is not precisely how key lookup | |
1260 works, but it's good enough for understanding ordinary circumstances. | |
1261 | |
1262 @cindex rebinding major mode keys | |
26392
b3d3ff9a7a2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25829
diff
changeset
|
1263 @findex define-key |
25829 | 1264 To change the local bindings of a major mode, you must change the |
1265 mode's local keymap. Normally you must wait until the first time the | |
1266 mode is used, because most major modes don't create their keymaps until | |
1267 then. If you want to specify something in your @file{~/.emacs} file to | |
1268 change a major mode's bindings, you must use the mode's mode hook to | |
1269 delay the change until the mode is first used. | |
1270 | |
1271 For example, the command @code{texinfo-mode} to select Texinfo mode | |
1272 runs the hook @code{texinfo-mode-hook}. Here's how you can use the hook | |
1273 to add local bindings (not very useful, we admit) for @kbd{C-c n} and | |
1274 @kbd{C-c p} in Texinfo mode: | |
1275 | |
1276 @example | |
1277 (add-hook 'texinfo-mode-hook | |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1278 '(lambda () |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1279 (define-key texinfo-mode-map "\C-cp" |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1280 'backward-paragraph) |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1281 (define-key texinfo-mode-map "\C-cn" |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1282 'forward-paragraph))) |
25829 | 1283 @end example |
1284 | |
1285 @xref{Hooks}. | |
1286 | |
1287 @node Minibuffer Maps | |
1288 @subsection Minibuffer Keymaps | |
1289 | |
1290 @cindex minibuffer keymaps | |
1291 @vindex minibuffer-local-map | |
1292 @vindex minibuffer-local-ns-map | |
1293 @vindex minibuffer-local-completion-map | |
1294 @vindex minibuffer-local-must-match-map | |
1295 The minibuffer has its own set of local keymaps; they contain various | |
1296 completion and exit commands. | |
1297 | |
1298 @itemize @bullet | |
1299 @item | |
1300 @code{minibuffer-local-map} is used for ordinary input (no completion). | |
1301 @item | |
1302 @code{minibuffer-local-ns-map} is similar, except that @key{SPC} exits | |
1303 just like @key{RET}. This is used mainly for Mocklisp compatibility. | |
1304 @item | |
1305 @code{minibuffer-local-completion-map} is for permissive completion. | |
1306 @item | |
1307 @code{minibuffer-local-must-match-map} is for strict completion and | |
1308 for cautious completion. | |
1309 @end itemize | |
1310 | |
1311 @node Rebinding | |
1312 @subsection Changing Key Bindings Interactively | |
1313 @cindex key rebinding, this session | |
36263
11db0318031d
Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36148
diff
changeset
|
1314 @cindex redefining keys, this session |
25829 | 1315 |
1316 The way to redefine an Emacs key is to change its entry in a keymap. | |
1317 You can change the global keymap, in which case the change is effective in | |
1318 all major modes (except those that have their own overriding local | |
1319 definitions for the same key). Or you can change the current buffer's | |
1320 local map, which affects all buffers using the same major mode. | |
1321 | |
1322 @findex global-set-key | |
1323 @findex local-set-key | |
1324 @findex global-unset-key | |
1325 @findex local-unset-key | |
1326 @table @kbd | |
1327 @item M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET} | |
1328 Define @var{key} globally to run @var{cmd}. | |
1329 @item M-x local-set-key @key{RET} @var{key} @var{cmd} @key{RET} | |
1330 Define @var{key} locally (in the major mode now in effect) to run | |
1331 @var{cmd}. | |
1332 @item M-x global-unset-key @key{RET} @var{key} | |
1333 Make @var{key} undefined in the global map. | |
1334 @item M-x local-unset-key @key{RET} @var{key} | |
1335 Make @var{key} undefined locally (in the major mode now in effect). | |
1336 @end table | |
1337 | |
1338 For example, suppose you like to execute commands in a subshell within | |
1339 an Emacs buffer, instead of suspending Emacs and executing commands in | |
1340 your login shell. Normally, @kbd{C-z} is bound to the function | |
1341 @code{suspend-emacs} (when not using the X Window System), but you can | |
1342 change @kbd{C-z} to invoke an interactive subshell within Emacs, by | |
1343 binding it to @code{shell} as follows: | |
1344 | |
1345 @example | |
1346 M-x global-set-key @key{RET} C-z shell @key{RET} | |
1347 @end example | |
1348 | |
1349 @noindent | |
1350 @code{global-set-key} reads the command name after the key. After you | |
1351 press the key, a message like this appears so that you can confirm that | |
1352 you are binding the key you want: | |
1353 | |
1354 @example | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47535
diff
changeset
|
1355 Set key C-z to command: |
25829 | 1356 @end example |
1357 | |
1358 You can redefine function keys and mouse events in the same way; just | |
1359 type the function key or click the mouse when it's time to specify the | |
1360 key to rebind. | |
1361 | |
1362 You can rebind a key that contains more than one event in the same | |
1363 way. Emacs keeps reading the key to rebind until it is a complete key | |
1364 (that is, not a prefix key). Thus, if you type @kbd{C-f} for | |
1365 @var{key}, that's the end; the minibuffer is entered immediately to | |
1366 read @var{cmd}. But if you type @kbd{C-x}, another character is read; | |
1367 if that is @kbd{4}, another character is read, and so on. For | |
1368 example, | |
1369 | |
1370 @example | |
1371 M-x global-set-key @key{RET} C-x 4 $ spell-other-window @key{RET} | |
1372 @end example | |
1373 | |
1374 @noindent | |
1375 redefines @kbd{C-x 4 $} to run the (fictitious) command | |
1376 @code{spell-other-window}. | |
1377 | |
1378 The two-character keys consisting of @kbd{C-c} followed by a letter | |
1379 are reserved for user customizations. Lisp programs are not supposed to | |
1380 define these keys, so the bindings you make for them will be available | |
1381 in all major modes and will never get in the way of anything. | |
1382 | |
1383 You can remove the global definition of a key with | |
1384 @code{global-unset-key}. This makes the key @dfn{undefined}; if you | |
1385 type it, Emacs will just beep. Similarly, @code{local-unset-key} makes | |
1386 a key undefined in the current major mode keymap, which makes the global | |
1387 definition (or lack of one) come back into effect in that major mode. | |
1388 | |
1389 If you have redefined (or undefined) a key and you subsequently wish | |
1390 to retract the change, undefining the key will not do the job---you need | |
1391 to redefine the key with its standard definition. To find the name of | |
1392 the standard definition of a key, go to a Fundamental mode buffer and | |
1393 use @kbd{C-h c}. The documentation of keys in this manual also lists | |
1394 their command names. | |
1395 | |
1396 If you want to prevent yourself from invoking a command by mistake, it | |
1397 is better to disable the command than to undefine the key. A disabled | |
1398 command is less work to invoke when you really want to. | |
1399 @xref{Disabling}. | |
1400 | |
1401 @node Init Rebinding | |
1402 @subsection Rebinding Keys in Your Init File | |
1403 | |
1404 If you have a set of key bindings that you like to use all the time, | |
1405 you can specify them in your @file{.emacs} file by using their Lisp | |
26392
b3d3ff9a7a2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25829
diff
changeset
|
1406 syntax. (@xref{Init File}.) |
25829 | 1407 |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1408 The simplest method for doing this works for @acronym{ASCII} characters and |
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1409 Meta-modified @acronym{ASCII} characters only. This method uses a string to |
25829 | 1410 represent the key sequence you want to rebind. For example, here's how |
1411 to bind @kbd{C-z} to @code{shell}: | |
1412 | |
1413 @example | |
1414 (global-set-key "\C-z" 'shell) | |
1415 @end example | |
1416 | |
1417 @noindent | |
1418 This example uses a string constant containing one character, @kbd{C-z}. | |
1419 The single-quote before the command name, @code{shell}, marks it as a | |
1420 constant symbol rather than a variable. If you omit the quote, Emacs | |
1421 would try to evaluate @code{shell} immediately as a variable. This | |
1422 probably causes an error; it certainly isn't what you want. | |
1423 | |
1424 Here is another example that binds a key sequence two characters long: | |
1425 | |
1426 @example | |
1427 (global-set-key "\C-xl" 'make-symbolic-link) | |
1428 @end example | |
1429 | |
37419
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1430 To put @key{TAB}, @key{RET}, @key{ESC}, or @key{DEL} in the |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1431 string, you can use the Emacs Lisp escape sequences, @samp{\t}, |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1432 @samp{\r}, @samp{\e}, and @samp{\d}. Here is an example which binds |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1433 @kbd{C-x @key{TAB}}: |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1434 |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1435 @example |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1436 (global-set-key "\C-x\t" 'indent-rigidly) |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1437 @end example |
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1438 |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1439 These examples show how to write some other special @acronym{ASCII} characters |
39161
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1440 in strings for key bindings: |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1441 |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1442 @example |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1443 (global-set-key "\r" 'newline) ;; @key{RET} |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1444 (global-set-key "\d" 'delete-backward-char) ;; @key{DEL} |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1445 (global-set-key "\C-x\e\e" 'repeat-complex-command) ;; @key{ESC} |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1446 @end example |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1447 |
25829 | 1448 When the key sequence includes function keys or mouse button events, |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1449 or non-@acronym{ASCII} characters such as @code{C-=} or @code{H-a}, you must use |
25829 | 1450 the more general method of rebinding, which uses a vector to specify the |
1451 key sequence. | |
1452 | |
1453 The way to write a vector in Emacs Lisp is with square brackets around | |
1454 the vector elements. Use spaces to separate the elements. If an | |
1455 element is a symbol, simply write the symbol's name---no other | |
1456 delimiters or punctuation are needed. If a vector element is a | |
1457 character, write it as a Lisp character constant: @samp{?} followed by | |
1458 the character as it would appear in a string. | |
1459 | |
1460 Here are examples of using vectors to rebind @kbd{C-=} (a control | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1461 character not in @acronym{ASCII}), @kbd{C-M-=} (not in @acronym{ASCII} because @kbd{C-=} |
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1462 is not), @kbd{H-a} (a Hyper character; @acronym{ASCII} doesn't have Hyper at |
38744
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
1463 all), @key{F7} (a function key), and @kbd{C-Mouse-1} (a |
25829 | 1464 keyboard-modified mouse button): |
1465 | |
1466 @example | |
1467 (global-set-key [?\C-=] 'make-symbolic-link) | |
38744
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
1468 (global-set-key [?\M-\C-=] 'make-symbolic-link) |
25829 | 1469 (global-set-key [?\H-a] 'make-symbolic-link) |
1470 (global-set-key [f7] 'make-symbolic-link) | |
1471 (global-set-key [C-mouse-1] 'make-symbolic-link) | |
1472 @end example | |
1473 | |
39161
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1474 You can use a vector for the simple cases too. Here's how to |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1475 rewrite the first three examples above, using vectors to bind |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1476 @kbd{C-z}, @kbd{C-x l}, and @kbd{C-x @key{TAB}}: |
25829 | 1477 |
1478 @example | |
1479 (global-set-key [?\C-z] 'shell) | |
1480 (global-set-key [?\C-x ?l] 'make-symbolic-link) | |
37419
201fa171a6e2
Explain binding TAB etc using \t etc.
Richard M. Stallman <rms@gnu.org>
parents:
37354
diff
changeset
|
1481 (global-set-key [?\C-x ?\t] 'indent-rigidly) |
39161
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1482 (global-set-key [?\r] 'newline) |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1483 (global-set-key [?\d] 'delete-backward-char) |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1484 (global-set-key [?\C-x ?\e ?\e] 'repeat-complex-command) |
25829 | 1485 @end example |
1486 | |
39161
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1487 @noindent |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1488 As you see, you represent a multi-character key sequence with a vector |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1489 by listing each of the characters within the square brackets that |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1490 delimit the vector. |
10b97dddcb68
Show how to put more special ASCII characters
Richard M. Stallman <rms@gnu.org>
parents:
39060
diff
changeset
|
1491 |
51448
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1492 Language and coding systems can cause problems with key bindings |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1493 for non-@acronym{ASCII} characters. @xref{Non-ASCII Rebinding}. |
51274
78a8be5d896c
(Init Rebinding): Xref Non-ASCII Rebinding, for
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50696
diff
changeset
|
1494 |
25829 | 1495 @node Function Keys |
1496 @subsection Rebinding Function Keys | |
1497 | |
1498 Key sequences can contain function keys as well as ordinary | |
1499 characters. Just as Lisp characters (actually integers) represent | |
1500 keyboard characters, Lisp symbols represent function keys. If the | |
1501 function key has a word as its label, then that word is also the name of | |
1502 the corresponding Lisp symbol. Here are the conventional Lisp names for | |
1503 common function keys: | |
1504 | |
1505 @table @asis | |
1506 @item @code{left}, @code{up}, @code{right}, @code{down} | |
1507 Cursor arrow keys. | |
1508 | |
1509 @item @code{begin}, @code{end}, @code{home}, @code{next}, @code{prior} | |
1510 Other cursor repositioning keys. | |
1511 | |
1512 @item @code{select}, @code{print}, @code{execute}, @code{backtab} | |
1513 @itemx @code{insert}, @code{undo}, @code{redo}, @code{clearline} | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
1514 @itemx @code{insertline}, @code{deleteline}, @code{insertchar}, @code{deletechar} |
25829 | 1515 Miscellaneous function keys. |
1516 | |
1517 @item @code{f1}, @code{f2}, @dots{} @code{f35} | |
1518 Numbered function keys (across the top of the keyboard). | |
1519 | |
1520 @item @code{kp-add}, @code{kp-subtract}, @code{kp-multiply}, @code{kp-divide} | |
1521 @itemx @code{kp-backtab}, @code{kp-space}, @code{kp-tab}, @code{kp-enter} | |
1522 @itemx @code{kp-separator}, @code{kp-decimal}, @code{kp-equal} | |
1523 Keypad keys (to the right of the regular keyboard), with names or punctuation. | |
1524 | |
1525 @item @code{kp-0}, @code{kp-1}, @dots{} @code{kp-9} | |
1526 Keypad keys with digits. | |
1527 | |
1528 @item @code{kp-f1}, @code{kp-f2}, @code{kp-f3}, @code{kp-f4} | |
1529 Keypad PF keys. | |
1530 @end table | |
1531 | |
1532 These names are conventional, but some systems (especially when using | |
35188
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
34151
diff
changeset
|
1533 X) may use different names. To make certain what symbol is used for a |
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
34151
diff
changeset
|
1534 given function key on your terminal, type @kbd{C-h c} followed by that |
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
34151
diff
changeset
|
1535 key. |
25829 | 1536 |
1537 A key sequence which contains function key symbols (or anything but | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1538 @acronym{ASCII} characters) must be a vector rather than a string. The vector |
25829 | 1539 syntax uses spaces between the elements, and square brackets around the |
1540 whole vector. Thus, to bind function key @samp{f1} to the command | |
1541 @code{rmail}, write the following: | |
1542 | |
1543 @example | |
1544 (global-set-key [f1] 'rmail) | |
1545 @end example | |
1546 | |
1547 @noindent | |
1548 To bind the right-arrow key to the command @code{forward-char}, you can | |
1549 use this expression: | |
1550 | |
1551 @example | |
1552 (global-set-key [right] 'forward-char) | |
1553 @end example | |
1554 | |
1555 @noindent | |
1556 This uses the Lisp syntax for a vector containing the symbol | |
1557 @code{right}. (This binding is present in Emacs by default.) | |
1558 | |
1559 @xref{Init Rebinding}, for more information about using vectors for | |
1560 rebinding. | |
1561 | |
1562 You can mix function keys and characters in a key sequence. This | |
1563 example binds @kbd{C-x @key{NEXT}} to the command @code{forward-page}. | |
1564 | |
1565 @example | |
1566 (global-set-key [?\C-x next] 'forward-page) | |
1567 @end example | |
1568 | |
1569 @noindent | |
1570 where @code{?\C-x} is the Lisp character constant for the character | |
1571 @kbd{C-x}. The vector element @code{next} is a symbol and therefore | |
1572 does not take a question mark. | |
1573 | |
1574 You can use the modifier keys @key{CTRL}, @key{META}, @key{HYPER}, | |
1575 @key{SUPER}, @key{ALT} and @key{SHIFT} with function keys. To represent | |
1576 these modifiers, add the strings @samp{C-}, @samp{M-}, @samp{H-}, | |
1577 @samp{s-}, @samp{A-} and @samp{S-} at the front of the symbol name. | |
1578 Thus, here is how to make @kbd{Hyper-Meta-@key{RIGHT}} move forward a | |
1579 word: | |
1580 | |
1581 @example | |
1582 (global-set-key [H-M-right] 'forward-word) | |
1583 @end example | |
1584 | |
1585 @node Named ASCII Chars | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1586 @subsection Named @acronym{ASCII} Control Characters |
25829 | 1587 |
1588 @key{TAB}, @key{RET}, @key{BS}, @key{LFD}, @key{ESC} and @key{DEL} | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1589 started out as names for certain @acronym{ASCII} control characters, used so often |
25829 | 1590 that they have special keys of their own. Later, users found it |
1591 convenient to distinguish in Emacs between these keys and the ``same'' | |
1592 control characters typed with the @key{CTRL} key. | |
1593 | |
36656
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1594 Emacs distinguishes these two kinds of input, when the keyboard |
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1595 reports these keys to Emacs. It treats the ``special'' keys as function |
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1596 keys named @code{tab}, @code{return}, @code{backspace}, @code{linefeed}, |
25829 | 1597 @code{escape}, and @code{delete}. These function keys translate |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1598 automatically into the corresponding @acronym{ASCII} characters @emph{if} they |
25829 | 1599 have no bindings of their own. As a result, neither users nor Lisp |
1600 programs need to pay attention to the distinction unless they care to. | |
1601 | |
1602 If you do not want to distinguish between (for example) @key{TAB} and | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1603 @kbd{C-i}, make just one binding, for the @acronym{ASCII} character @key{TAB} |
25829 | 1604 (octal code 011). If you do want to distinguish, make one binding for |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1605 this @acronym{ASCII} character, and another for the ``function key'' @code{tab}. |
25829 | 1606 |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1607 With an ordinary @acronym{ASCII} terminal, there is no way to distinguish |
25829 | 1608 between @key{TAB} and @kbd{C-i} (and likewise for other such pairs), |
1609 because the terminal sends the same character in both cases. | |
1610 | |
1611 @node Non-ASCII Rebinding | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1612 @subsection Non-@acronym{ASCII} Characters on the Keyboard |
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1613 @cindex rebinding non-@acronym{ASCII} keys |
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1614 @cindex non-@acronym{ASCII} keys, binding |
25829 | 1615 |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1616 If your keyboard has keys that send non-@acronym{ASCII} characters, such as |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1617 accented letters, rebinding these keys is a bit tricky. There are two |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1618 solutions you can use. One is to specify a keyboard coding system, |
25829 | 1619 using @code{set-keyboard-coding-system} (@pxref{Specify Coding}). |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1620 Then you can bind these keys in the usual way@footnote{Note that you |
27218 | 1621 should avoid the string syntax for binding 8-bit characters, since |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1622 they will be interpreted as meta keys. @xref{Strings of |
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
1623 Events,,,elisp, The Emacs Lisp Reference Manual}.}, like this: |
25829 | 1624 |
1625 @example | |
1626 (global-set-key [?@var{char}] 'some-function) | |
1627 @end example | |
1628 | |
1629 @noindent | |
36632
1bfc2fad762a
(File Variables): Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents:
36593
diff
changeset
|
1630 Type @kbd{C-q} followed by the key you want to bind, to insert @var{char}. |
25829 | 1631 |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1632 Since this puts a non-@acronym{ASCII} character in the @file{.emacs}, you should |
51448
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1633 specify the proper coding system for that file. @xref{Init Syntax}. |
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1634 Specify the same coding system for the file that you use for your |
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1635 keyboard. |
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1636 |
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1637 If you don't specify a keyboard coding system, that approach won't |
25829 | 1638 work. Instead, you need to find out the actual code that the terminal |
51448
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1639 sends. The easiest way to do this in Emacs is to create an empty |
596b12c24475
(Init Rebinding): Replace previous change with xref.
Richard M. Stallman <rms@gnu.org>
parents:
51274
diff
changeset
|
1640 buffer with @kbd{C-x b temp @key{RET}}, make it unibyte with @kbd{M-x |
25829 | 1641 toggle-enable-multibyte-characters @key{RET}}, then type the key to |
1642 insert the character into this buffer. | |
1643 | |
1644 Move point before the character, then type @kbd{C-x =}. This | |
1645 displays a message in the minibuffer, showing the character code in | |
1646 three ways, octal, decimal and hexadecimal, all within a set of | |
1647 parentheses. Use the second of the three numbers, the decimal one, | |
1648 inside the vector to bind: | |
1649 | |
1650 @example | |
1651 (global-set-key [@var{decimal-code}] 'some-function) | |
1652 @end example | |
1653 | |
38376
c7b0f62e4dc5
(Non-ASCII Rebinding): Fix a typo. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
38322
diff
changeset
|
1654 If you bind 8-bit characters like this in your init file, you may find it |
27218 | 1655 convenient to specify that it is unibyte. @xref{Enabling Multibyte}. |
1656 | |
25829 | 1657 @node Mouse Buttons |
1658 @subsection Rebinding Mouse Buttons | |
1659 @cindex mouse button events | |
1660 @cindex rebinding mouse buttons | |
1661 @cindex click events | |
1662 @cindex drag events | |
1663 @cindex down events | |
1664 @cindex button down events | |
1665 | |
1666 Emacs uses Lisp symbols to designate mouse buttons, too. The ordinary | |
1667 mouse events in Emacs are @dfn{click} events; these happen when you | |
1668 press a button and release it without moving the mouse. You can also | |
1669 get @dfn{drag} events, when you move the mouse while holding the button | |
1670 down. Drag events happen when you finally let go of the button. | |
1671 | |
1672 The symbols for basic click events are @code{mouse-1} for the leftmost | |
1673 button, @code{mouse-2} for the next, and so on. Here is how you can | |
1674 redefine the second mouse button to split the current window: | |
1675 | |
1676 @example | |
1677 (global-set-key [mouse-2] 'split-window-vertically) | |
1678 @end example | |
1679 | |
1680 The symbols for drag events are similar, but have the prefix | |
1681 @samp{drag-} before the word @samp{mouse}. For example, dragging the | |
1682 first button generates a @code{drag-mouse-1} event. | |
1683 | |
1684 You can also define bindings for events that occur when a mouse button | |
1685 is pressed down. These events start with @samp{down-} instead of | |
1686 @samp{drag-}. Such events are generated only if they have key bindings. | |
1687 When you get a button-down event, a corresponding click or drag event | |
1688 will always follow. | |
1689 | |
1690 @cindex double clicks | |
1691 @cindex triple clicks | |
1692 If you wish, you can distinguish single, double, and triple clicks. A | |
1693 double click means clicking a mouse button twice in approximately the | |
1694 same place. The first click generates an ordinary click event. The | |
1695 second click, if it comes soon enough, generates a double-click event | |
1696 instead. The event type for a double-click event starts with | |
1697 @samp{double-}: for example, @code{double-mouse-3}. | |
1698 | |
1699 This means that you can give a special meaning to the second click at | |
1700 the same place, but it must act on the assumption that the ordinary | |
1701 single click definition has run when the first click was received. | |
1702 | |
1703 This constrains what you can do with double clicks, but user interface | |
1704 designers say that this constraint ought to be followed in any case. A | |
1705 double click should do something similar to the single click, only | |
1706 ``more so.'' The command for the double-click event should perform the | |
1707 extra work for the double click. | |
1708 | |
1709 If a double-click event has no binding, it changes to the | |
1710 corresponding single-click event. Thus, if you don't define a | |
1711 particular double click specially, it executes the single-click command | |
1712 twice. | |
1713 | |
1714 Emacs also supports triple-click events whose names start with | |
1715 @samp{triple-}. Emacs does not distinguish quadruple clicks as event | |
1716 types; clicks beyond the third generate additional triple-click events. | |
1717 However, the full number of clicks is recorded in the event list, so you | |
1718 can distinguish if you really want to. We don't recommend distinct | |
1719 meanings for more than three clicks, but sometimes it is useful for | |
1720 subsequent clicks to cycle through the same set of three meanings, so | |
1721 that four clicks are equivalent to one click, five are equivalent to | |
1722 two, and six are equivalent to three. | |
1723 | |
1724 Emacs also records multiple presses in drag and button-down events. | |
1725 For example, when you press a button twice, then move the mouse while | |
1726 holding the button, Emacs gets a @samp{double-drag-} event. And at the | |
1727 moment when you press it down for the second time, Emacs gets a | |
1728 @samp{double-down-} event (which is ignored, like all button-down | |
1729 events, if it has no binding). | |
1730 | |
1731 @vindex double-click-time | |
38744
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
1732 The variable @code{double-click-time} specifies how much time can |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
1733 elapse between clicks and still allow them to be grouped as a multiple |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
1734 click. Its value is in units of milliseconds. If the value is |
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
1735 @code{nil}, double clicks are not detected at all. If the value is |
38771
3e5c99acf21a
(Mouse Buttons): Document the default values for double-click-time
Eli Zaretskii <eliz@gnu.org>
parents:
38744
diff
changeset
|
1736 @code{t}, then there is no time limit. The default is 500. |
25829 | 1737 |
38605
f99d2e5ee830
Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
38376
diff
changeset
|
1738 @vindex double-click-fuzz |
f99d2e5ee830
Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
38376
diff
changeset
|
1739 The variable @code{double-click-fuzz} specifies how much the mouse |
38744
d7121931b3ba
Show example of specifying C-M-= in Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
38605
diff
changeset
|
1740 can move between clicks still allow them to be grouped as a multiple |
39060
07afb71a874e
(Mouse Buttons): Document the different units of double-click-fuzz
Eli Zaretskii <eliz@gnu.org>
parents:
38870
diff
changeset
|
1741 click. Its value is in units of pixels on windowed displays and in |
07afb71a874e
(Mouse Buttons): Document the different units of double-click-fuzz
Eli Zaretskii <eliz@gnu.org>
parents:
38870
diff
changeset
|
1742 units of 1/8 of a character cell on text-mode terminals; the default is |
07afb71a874e
(Mouse Buttons): Document the different units of double-click-fuzz
Eli Zaretskii <eliz@gnu.org>
parents:
38870
diff
changeset
|
1743 3. |
38605
f99d2e5ee830
Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
38376
diff
changeset
|
1744 |
25829 | 1745 The symbols for mouse events also indicate the status of the modifier |
1746 keys, with the usual prefixes @samp{C-}, @samp{M-}, @samp{H-}, | |
1747 @samp{s-}, @samp{A-} and @samp{S-}. These always precede @samp{double-} | |
1748 or @samp{triple-}, which always precede @samp{drag-} or @samp{down-}. | |
1749 | |
1750 A frame includes areas that don't show text from the buffer, such as | |
1751 the mode line and the scroll bar. You can tell whether a mouse button | |
1752 comes from a special area of the screen by means of dummy ``prefix | |
1753 keys.'' For example, if you click the mouse in the mode line, you get | |
1754 the prefix key @code{mode-line} before the ordinary mouse-button symbol. | |
1755 Thus, here is how to define the command for clicking the first button in | |
1756 a mode line to run @code{scroll-up}: | |
1757 | |
1758 @example | |
1759 (global-set-key [mode-line mouse-1] 'scroll-up) | |
1760 @end example | |
1761 | |
1762 Here is the complete list of these dummy prefix keys and their | |
1763 meanings: | |
1764 | |
1765 @table @code | |
1766 @item mode-line | |
1767 The mouse was in the mode line of a window. | |
1768 @item vertical-line | |
1769 The mouse was in the vertical line separating side-by-side windows. (If | |
1770 you use scroll bars, they appear in place of these vertical lines.) | |
1771 @item vertical-scroll-bar | |
1772 The mouse was in a vertical scroll bar. (This is the only kind of | |
1773 scroll bar Emacs currently supports.) | |
1774 @ignore | |
1775 @item horizontal-scroll-bar | |
1776 The mouse was in a horizontal scroll bar. Horizontal scroll bars do | |
1777 horizontal scrolling, and people don't use them often. | |
1778 @end ignore | |
1779 @end table | |
1780 | |
1781 You can put more than one mouse button in a key sequence, but it isn't | |
1782 usual to do so. | |
1783 | |
1784 @node Disabling | |
1785 @subsection Disabling Commands | |
1786 @cindex disabled command | |
1787 | |
1788 Disabling a command marks the command as requiring confirmation before it | |
1789 can be executed. The purpose of disabling a command is to prevent | |
1790 beginning users from executing it by accident and being confused. | |
1791 | |
1792 An attempt to invoke a disabled command interactively in Emacs | |
1793 displays a window containing the command's name, its documentation, and | |
1794 some instructions on what to do immediately; then Emacs asks for input | |
1795 saying whether to execute the command as requested, enable it and | |
1796 execute it, or cancel. If you decide to enable the command, you are | |
1797 asked whether to do this permanently or just for the current session. | |
37977
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
1798 (Enabling permanently works by automatically editing your @file{.emacs} |
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
1799 file.) You can also type @kbd{!} to enable @emph{all} commands, |
5ff6cac52888
Update Customization buffer examples
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
1800 for the current session only. |
25829 | 1801 |
1802 The direct mechanism for disabling a command is to put a | |
1803 non-@code{nil} @code{disabled} property on the Lisp symbol for the | |
1804 command. Here is the Lisp program to do this: | |
1805 | |
1806 @example | |
1807 (put 'delete-region 'disabled t) | |
1808 @end example | |
1809 | |
1810 If the value of the @code{disabled} property is a string, that string | |
38870
d44abb4e68b2
Don't use "print" for displaying a message.
Richard M. Stallman <rms@gnu.org>
parents:
38791
diff
changeset
|
1811 is included in the message displayed when the command is used: |
25829 | 1812 |
1813 @example | |
1814 (put 'delete-region 'disabled | |
1815 "It's better to use `kill-region' instead.\n") | |
1816 @end example | |
1817 | |
1818 @findex disable-command | |
1819 @findex enable-command | |
1820 You can make a command disabled either by editing the @file{.emacs} | |
1821 file directly or with the command @kbd{M-x disable-command}, which edits | |
1822 the @file{.emacs} file for you. Likewise, @kbd{M-x enable-command} | |
1823 edits @file{.emacs} to enable a command permanently. @xref{Init File}. | |
1824 | |
43062
c9d1c7655c9f
(Disabling): Document that .emacs is not edited from "emacs -q".
Eli Zaretskii <eliz@gnu.org>
parents:
43038
diff
changeset
|
1825 If Emacs was invoked with the @option{-q} or @option{--no-init-file} |
c9d1c7655c9f
(Disabling): Document that .emacs is not edited from "emacs -q".
Eli Zaretskii <eliz@gnu.org>
parents:
43038
diff
changeset
|
1826 options (@pxref{Initial Options}), it will not edit your |
c9d1c7655c9f
(Disabling): Document that .emacs is not edited from "emacs -q".
Eli Zaretskii <eliz@gnu.org>
parents:
43038
diff
changeset
|
1827 @file{~/.emacs} init file. This is because editing the init file from |
c9d1c7655c9f
(Disabling): Document that .emacs is not edited from "emacs -q".
Eli Zaretskii <eliz@gnu.org>
parents:
43038
diff
changeset
|
1828 such a session might overwrite the lines you might have on your init |
c9d1c7655c9f
(Disabling): Document that .emacs is not edited from "emacs -q".
Eli Zaretskii <eliz@gnu.org>
parents:
43038
diff
changeset
|
1829 file which enable and disable commands. |
c9d1c7655c9f
(Disabling): Document that .emacs is not edited from "emacs -q".
Eli Zaretskii <eliz@gnu.org>
parents:
43038
diff
changeset
|
1830 |
25829 | 1831 Whether a command is disabled is independent of what key is used to |
1832 invoke it; disabling also applies if the command is invoked using | |
1833 @kbd{M-x}. Disabling a command has no effect on calling it as a | |
1834 function from Lisp programs. | |
1835 | |
1836 @node Keyboard Translations | |
1837 @section Keyboard Translations | |
1838 | |
1839 Some keyboards do not make it convenient to send all the special | |
1840 characters that Emacs uses. The most common problem case is the | |
1841 @key{DEL} character. Some keyboards provide no convenient way to type | |
1842 this very important character---usually because they were designed to | |
1843 expect the character @kbd{C-h} to be used for deletion. On these | |
1844 keyboards, if you press the key normally used for deletion, Emacs handles | |
1845 the @kbd{C-h} as a prefix character and offers you a list of help | |
1846 options, which is not what you want. | |
1847 | |
1848 @cindex keyboard translations | |
1849 @findex keyboard-translate | |
1850 You can work around this problem within Emacs by setting up keyboard | |
1851 translations to turn @kbd{C-h} into @key{DEL} and @key{DEL} into | |
1852 @kbd{C-h}, as follows: | |
1853 | |
1854 @example | |
1855 ;; @r{Translate @kbd{C-h} to @key{DEL}.} | |
1856 (keyboard-translate ?\C-h ?\C-?) | |
1857 | |
1858 ;; @r{Translate @key{DEL} to @kbd{C-h}.} | |
1859 (keyboard-translate ?\C-? ?\C-h) | |
1860 @end example | |
1861 | |
1862 Keyboard translations are not the same as key bindings in keymaps | |
1863 (@pxref{Keymaps}). Emacs contains numerous keymaps that apply in | |
1864 different situations, but there is only one set of keyboard | |
1865 translations, and it applies to every character that Emacs reads from | |
1866 the terminal. Keyboard translations take place at the lowest level of | |
1867 input processing; the keys that are looked up in keymaps contain the | |
1868 characters that result from keyboard translation. | |
1869 | |
36656
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1870 On a window system, the keyboard key named @key{DELETE} is a function |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1871 key and is distinct from the @acronym{ASCII} character named @key{DEL}. |
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
1872 @xref{Named ASCII Chars}. Keyboard translations affect only @acronym{ASCII} |
36656
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1873 character input, not function keys; thus, the above example used on a |
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1874 window system does not affect the @key{DELETE} key. However, the |
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1875 translation above isn't necessary on window systems, because Emacs can |
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1876 also distinguish between the @key{BACKSPACE} key and @kbd{C-h}; and it |
e562b27b8afd
DELETE and BACSKPACE are supported on any window system, not only X.
Eli Zaretskii <eliz@gnu.org>
parents:
36632
diff
changeset
|
1877 normally treats @key{BACKSPACE} as @key{DEL}. |
25829 | 1878 |
1879 For full information about how to use keyboard translations, see | |
1880 @ref{Translating Input,,,elisp, The Emacs Lisp Reference Manual}. | |
1881 | |
1882 @node Syntax | |
1883 @section The Syntax Table | |
1884 @cindex syntax table | |
1885 | |
1886 All the Emacs commands which parse words or balance parentheses are | |
1887 controlled by the @dfn{syntax table}. The syntax table says which | |
1888 characters are opening delimiters, which are parts of words, which are | |
37122
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1889 string quotes, and so on. It does this by assigning each character to |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1890 one of fifteen-odd @dfn{syntax classes}. In some cases it specifies |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1891 some additional information also. |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1892 |
38114 | 1893 Each major mode has its own syntax table (though related major modes |
1894 sometimes share one syntax table) which it installs in each buffer | |
37122
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1895 that uses the mode. The syntax table installed in the current buffer |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1896 is the one that all commands use, so we call it ``the'' syntax table. |
25829 | 1897 |
1898 @kindex C-h s | |
1899 @findex describe-syntax | |
37122
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1900 To display a description of the contents of the current syntax |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1901 table, type @kbd{C-h s} (@code{describe-syntax}). The description of |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1902 each character includes both the string you would have to give to |
25829 | 1903 @code{modify-syntax-entry} to set up that character's current syntax, |
37122
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1904 starting with the character which designates its syntax class, plus |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1905 some English text to explain its meaning. |
25829 | 1906 |
37122
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1907 A syntax table is actually a Lisp object, a char-table, whose |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1908 elements are cons cells. For full information on the syntax table, |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1909 see @ref{Syntax Tables,, Syntax Tables, elisp, The Emacs Lisp |
a34d1e2a580f
Correct syntax table data structure. Other clarifications about
Richard M. Stallman <rms@gnu.org>
parents:
36656
diff
changeset
|
1910 Reference Manual}. |
25829 | 1911 |
1912 @node Init File | |
1913 @section The Init File, @file{~/.emacs} | |
1914 @cindex init file | |
1915 @cindex Emacs initialization file | |
1916 @cindex key rebinding, permanent | |
1917 @cindex rebinding keys, permanently | |
1918 @cindex startup (init file) | |
1919 | |
1920 When Emacs is started, it normally loads a Lisp program from the file | |
1921 @file{.emacs} or @file{.emacs.el} in your home directory. We call this | |
1922 file your @dfn{init file} because it specifies how to initialize Emacs | |
1923 for you. You can use the command line switch @samp{-q} to prevent | |
1924 loading your init file, and @samp{-u} (or @samp{--user}) to specify a | |
50696 | 1925 different user's init file (@pxref{Initial Options}). |
25829 | 1926 |
37596
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1927 @cindex @file{default.el}, the default init file |
25829 | 1928 There can also be a @dfn{default init file}, which is the library |
1929 named @file{default.el}, found via the standard search path for | |
1930 libraries. The Emacs distribution contains no such library; your site | |
1931 may create one for local customizations. If this library exists, it is | |
1932 loaded whenever you start Emacs (except when you specify @samp{-q}). | |
1933 But your init file, if any, is loaded first; if it sets | |
1934 @code{inhibit-default-init} non-@code{nil}, then @file{default} is not | |
1935 loaded. | |
1936 | |
37596
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1937 @cindex site init file |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1938 @cindex @file{site-start.el}, the site startup file |
25829 | 1939 Your site may also have a @dfn{site startup file}; this is named |
37596
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1940 @file{site-start.el}, if it exists. Like @file{default.el}, Emacs |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1941 finds this file via the standard search path for Lisp libraries. |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1942 Emacs loads this library before it loads your init file. To inhibit |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1943 loading of this library, use the option @samp{-no-site-file}. |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1944 @xref{Initial Options}. |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1945 |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1946 You can place @file{default.el} and @file{site-start.el} in any of |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1947 the directories which Emacs searches for Lisp libraries. The variable |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1948 @code{load-path} (@pxref{Lisp Libraries}) specifies these directories. |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1949 Many sites put these files in the @file{site-lisp} subdirectory of the |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1950 Emacs installation directory, typically |
47f8d088e385
(Init File): Say explicitly that site-start.el is also searched along
Eli Zaretskii <eliz@gnu.org>
parents:
37581
diff
changeset
|
1951 @file{/usr/local/share/emacs/site-lisp}. |
25829 | 1952 |
1953 If you have a large amount of code in your @file{.emacs} file, you | |
1954 should rename it to @file{~/.emacs.el}, and byte-compile it. @xref{Byte | |
1955 Compilation,, Byte Compilation, elisp, the Emacs Lisp Reference Manual}, | |
1956 for more information about compiling Emacs Lisp programs. | |
1957 | |
1958 If you are going to write actual Emacs Lisp programs that go beyond | |
1959 minor customization, you should read the @cite{Emacs Lisp Reference Manual}. | |
1960 @ifinfo | |
1961 @xref{Top, Emacs Lisp, Emacs Lisp, elisp, the Emacs Lisp Reference | |
1962 Manual}. | |
1963 @end ifinfo | |
1964 | |
1965 @menu | |
1966 * Init Syntax:: Syntax of constants in Emacs Lisp. | |
1967 * Init Examples:: How to do some things with an init file. | |
1968 * Terminal Init:: Each terminal type can have an init file. | |
1969 * Find Init:: How Emacs finds the init file. | |
1970 @end menu | |
1971 | |
1972 @node Init Syntax | |
1973 @subsection Init File Syntax | |
1974 | |
1975 The @file{.emacs} file contains one or more Lisp function call | |
1976 expressions. Each of these consists of a function name followed by | |
1977 arguments, all surrounded by parentheses. For example, @code{(setq | |
1978 fill-column 60)} calls the function @code{setq} to set the variable | |
1979 @code{fill-column} (@pxref{Filling}) to 60. | |
1980 | |
1981 The second argument to @code{setq} is an expression for the new value of | |
1982 the variable. This can be a constant, a variable, or a function call | |
1983 expression. In @file{.emacs}, constants are used most of the time. They can be: | |
1984 | |
1985 @table @asis | |
1986 @item Numbers: | |
1987 Numbers are written in decimal, with an optional initial minus sign. | |
1988 | |
1989 @item Strings: | |
1990 @cindex Lisp string syntax | |
1991 @cindex string syntax | |
1992 Lisp string syntax is the same as C string syntax with a few extra | |
1993 features. Use a double-quote character to begin and end a string constant. | |
1994 | |
1995 In a string, you can include newlines and special characters literally. | |
1996 But often it is cleaner to use backslash sequences for them: @samp{\n} | |
1997 for newline, @samp{\b} for backspace, @samp{\r} for carriage return, | |
1998 @samp{\t} for tab, @samp{\f} for formfeed (control-L), @samp{\e} for | |
1999 escape, @samp{\\} for a backslash, @samp{\"} for a double-quote, or | |
2000 @samp{\@var{ooo}} for the character whose octal code is @var{ooo}. | |
2001 Backslash and double-quote are the only characters for which backslash | |
2002 sequences are mandatory. | |
2003 | |
2004 @samp{\C-} can be used as a prefix for a control character, as in | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
2005 @samp{\C-s} for @acronym{ASCII} control-S, and @samp{\M-} can be used as a prefix for |
25829 | 2006 a Meta character, as in @samp{\M-a} for @kbd{Meta-A} or @samp{\M-\C-a} for |
2007 @kbd{Control-Meta-A}.@refill | |
2008 | |
37198
12c496043cb0
(Init Syntax): Mention the -*-coding:-*- tag if .emacs uses non-ASCII
Eli Zaretskii <eliz@gnu.org>
parents:
37122
diff
changeset
|
2009 @cindex international characters in @file{.emacs} |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
2010 @cindex non-@acronym{ASCII} characters in @file{.emacs} |
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
2011 If you want to include non-@acronym{ASCII} characters in strings in your init |
37354
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2012 file, you should consider putting a @w{@samp{-*-coding: |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2013 @var{coding-system}-*-}} tag on the first line which states the coding |
37265
d2c4a8eb274a
(Init Syntax): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents:
37198
diff
changeset
|
2014 system used to save your @file{.emacs}, as explained in @ref{Recognize |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
2015 Coding}. This is because the defaults for decoding non-@acronym{ASCII} text might |
37265
d2c4a8eb274a
(Init Syntax): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents:
37198
diff
changeset
|
2016 not yet be set up by the time Emacs reads those parts of your init file |
d2c4a8eb274a
(Init Syntax): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents:
37198
diff
changeset
|
2017 which use such strings, possibly leading Emacs to decode those strings |
d2c4a8eb274a
(Init Syntax): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents:
37198
diff
changeset
|
2018 incorrectly. |
37198
12c496043cb0
(Init Syntax): Mention the -*-coding:-*- tag if .emacs uses non-ASCII
Eli Zaretskii <eliz@gnu.org>
parents:
37122
diff
changeset
|
2019 |
25829 | 2020 @item Characters: |
2021 Lisp character constant syntax consists of a @samp{?} followed by | |
2022 either a character or an escape sequence starting with @samp{\}. | |
2023 Examples: @code{?x}, @code{?\n}, @code{?\"}, @code{?\)}. Note that | |
2024 strings and characters are not interchangeable in Lisp; some contexts | |
2025 require one and some contexts require the other. | |
2026 | |
37354
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2027 @xref{Non-ASCII Rebinding}, for information about binding commands to |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
2028 keys which send non-@acronym{ASCII} characters. |
37354
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2029 |
25829 | 2030 @item True: |
2031 @code{t} stands for `true'. | |
2032 | |
2033 @item False: | |
2034 @code{nil} stands for `false'. | |
2035 | |
2036 @item Other Lisp objects: | |
37976
23dc2eca0bd3
Proofreading changes from Tim Goodwin <tjg@star.le.ac.uk>.
Eli Zaretskii <eliz@gnu.org>
parents:
37843
diff
changeset
|
2037 Write a single-quote (@code{'}) followed by the Lisp object you want. |
25829 | 2038 @end table |
2039 | |
2040 @node Init Examples | |
2041 @subsection Init File Examples | |
2042 | |
2043 Here are some examples of doing certain commonly desired things with | |
2044 Lisp expressions: | |
2045 | |
2046 @itemize @bullet | |
2047 @item | |
2048 Make @key{TAB} in C mode just insert a tab if point is in the middle of a | |
2049 line. | |
2050 | |
2051 @example | |
2052 (setq c-tab-always-indent nil) | |
2053 @end example | |
2054 | |
2055 Here we have a variable whose value is normally @code{t} for `true' | |
2056 and the alternative is @code{nil} for `false'. | |
2057 | |
2058 @item | |
2059 Make searches case sensitive by default (in all buffers that do not | |
2060 override this). | |
2061 | |
2062 @example | |
2063 (setq-default case-fold-search nil) | |
2064 @end example | |
2065 | |
2066 This sets the default value, which is effective in all buffers that do | |
2067 not have local values for the variable. Setting @code{case-fold-search} | |
2068 with @code{setq} affects only the current buffer's local value, which | |
2069 is not what you probably want to do in an init file. | |
2070 | |
2071 @item | |
2072 @vindex user-mail-address | |
2073 Specify your own email address, if Emacs can't figure it out correctly. | |
2074 | |
2075 @example | |
2076 (setq user-mail-address "coon@@yoyodyne.com") | |
2077 @end example | |
2078 | |
2079 Various Emacs packages that need your own email address use the value of | |
2080 @code{user-mail-address}. | |
2081 | |
2082 @item | |
2083 Make Text mode the default mode for new buffers. | |
2084 | |
2085 @example | |
2086 (setq default-major-mode 'text-mode) | |
2087 @end example | |
2088 | |
2089 Note that @code{text-mode} is used because it is the command for | |
2090 entering Text mode. The single-quote before it makes the symbol a | |
2091 constant; otherwise, @code{text-mode} would be treated as a variable | |
2092 name. | |
2093 | |
2094 @need 1500 | |
2095 @item | |
2096 Set up defaults for the Latin-1 character set | |
2097 which supports most of the languages of Western Europe. | |
2098 | |
2099 @example | |
2100 (set-language-environment "Latin-1") | |
2101 @end example | |
2102 | |
2103 @need 1500 | |
2104 @item | |
2105 Turn on Auto Fill mode automatically in Text mode and related modes. | |
2106 | |
2107 @example | |
2108 (add-hook 'text-mode-hook | |
36148
a2719b6e7a2f
Don't use naked lambdas in examples. Fix bad @xref usage.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
2109 '(lambda () (auto-fill-mode 1))) |
25829 | 2110 @end example |
2111 | |
2112 This shows how to add a hook function to a normal hook variable | |
2113 (@pxref{Hooks}). The function we supply is a list starting with | |
2114 @code{lambda}, with a single-quote in front of it to make it a list | |
2115 constant rather than an expression. | |
2116 | |
2117 It's beyond the scope of this manual to explain Lisp functions, but for | |
2118 this example it is enough to know that the effect is to execute | |
2119 @code{(auto-fill-mode 1)} when Text mode is entered. You can replace | |
2120 that with any other expression that you like, or with several | |
2121 expressions in a row. | |
2122 | |
2123 Emacs comes with a function named @code{turn-on-auto-fill} whose | |
2124 definition is @code{(lambda () (auto-fill-mode 1))}. Thus, a simpler | |
2125 way to write the above example is as follows: | |
2126 | |
2127 @example | |
2128 (add-hook 'text-mode-hook 'turn-on-auto-fill) | |
2129 @end example | |
2130 | |
2131 @item | |
2132 Load the installed Lisp library named @file{foo} (actually a file | |
2133 @file{foo.elc} or @file{foo.el} in a standard Emacs directory). | |
2134 | |
2135 @example | |
2136 (load "foo") | |
2137 @end example | |
2138 | |
2139 When the argument to @code{load} is a relative file name, not starting | |
2140 with @samp{/} or @samp{~}, @code{load} searches the directories in | |
2141 @code{load-path} (@pxref{Lisp Libraries}). | |
2142 | |
2143 @item | |
2144 Load the compiled Lisp file @file{foo.elc} from your home directory. | |
2145 | |
2146 @example | |
2147 (load "~/foo.elc") | |
2148 @end example | |
2149 | |
2150 Here an absolute file name is used, so no searching is done. | |
2151 | |
2152 @item | |
37354
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2153 @cindex loading Lisp libraries automatically |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2154 @cindex autoload Lisp libraries |
38114 | 2155 Tell Emacs to find the definition for the function @code{myfunction} |
2156 by loading a Lisp library named @file{mypackage} (i.e.@: a file | |
2157 @file{mypackage.elc} or @file{mypackage.el}): | |
37354
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2158 |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2159 @example |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2160 (autoload 'myfunction "mypackage" "Do what I say." t) |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2161 @end example |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2162 |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2163 @noindent |
38114 | 2164 Here the string @code{"Do what I say."} is the function's |
2165 documentation string. You specify it in the @code{autoload} | |
2166 definition so it will be available for help commands even when the | |
2167 package is not loaded. The last argument, @code{t}, indicates that | |
2168 this function is interactive; that is, it can be invoked interactively | |
2169 by typing @kbd{M-x myfunction @key{RET}} or by binding it to a key. | |
2170 If the function is not interactive, omit the @code{t} or use | |
2171 @code{nil}. | |
37354
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2172 |
39aa69a68098
(Init Syntax): Add a cross reference to "Non-ASCII Rebinding".
Eli Zaretskii <eliz@gnu.org>
parents:
37265
diff
changeset
|
2173 @item |
25829 | 2174 Rebind the key @kbd{C-x l} to run the function @code{make-symbolic-link}. |
2175 | |
2176 @example | |
2177 (global-set-key "\C-xl" 'make-symbolic-link) | |
2178 @end example | |
2179 | |
2180 or | |
2181 | |
2182 @example | |
2183 (define-key global-map "\C-xl" 'make-symbolic-link) | |
2184 @end example | |
2185 | |
2186 Note once again the single-quote used to refer to the symbol | |
2187 @code{make-symbolic-link} instead of its value as a variable. | |
2188 | |
2189 @item | |
2190 Do the same thing for Lisp mode only. | |
2191 | |
2192 @example | |
2193 (define-key lisp-mode-map "\C-xl" 'make-symbolic-link) | |
2194 @end example | |
2195 | |
2196 @item | |
2197 Redefine all keys which now run @code{next-line} in Fundamental mode | |
2198 so that they run @code{forward-line} instead. | |
2199 | |
26392
b3d3ff9a7a2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25829
diff
changeset
|
2200 @findex substitute-key-definition |
25829 | 2201 @example |
2202 (substitute-key-definition 'next-line 'forward-line | |
2203 global-map) | |
2204 @end example | |
2205 | |
2206 @item | |
2207 Make @kbd{C-x C-v} undefined. | |
2208 | |
2209 @example | |
2210 (global-unset-key "\C-x\C-v") | |
2211 @end example | |
2212 | |
2213 One reason to undefine a key is so that you can make it a prefix. | |
2214 Simply defining @kbd{C-x C-v @var{anything}} will make @kbd{C-x C-v} a | |
2215 prefix, but @kbd{C-x C-v} must first be freed of its usual non-prefix | |
2216 definition. | |
2217 | |
2218 @item | |
2219 Make @samp{$} have the syntax of punctuation in Text mode. | |
2220 Note the use of a character constant for @samp{$}. | |
2221 | |
2222 @example | |
2223 (modify-syntax-entry ?\$ "." text-mode-syntax-table) | |
2224 @end example | |
2225 | |
2226 @item | |
2227 Enable the use of the command @code{narrow-to-region} without confirmation. | |
2228 | |
2229 @example | |
2230 (put 'narrow-to-region 'disabled nil) | |
2231 @end example | |
2232 @end itemize | |
2233 | |
2234 @node Terminal Init | |
2235 @subsection Terminal-specific Initialization | |
2236 | |
2237 Each terminal type can have a Lisp library to be loaded into Emacs when | |
2238 it is run on that type of terminal. For a terminal type named | |
2239 @var{termtype}, the library is called @file{term/@var{termtype}} and it is | |
2240 found by searching the directories @code{load-path} as usual and trying the | |
2241 suffixes @samp{.elc} and @samp{.el}. Normally it appears in the | |
2242 subdirectory @file{term} of the directory where most Emacs libraries are | |
2243 kept.@refill | |
2244 | |
2245 The usual purpose of the terminal-specific library is to map the | |
2246 escape sequences used by the terminal's function keys onto more | |
2247 meaningful names, using @code{function-key-map}. See the file | |
2248 @file{term/lk201.el} for an example of how this is done. Many function | |
2249 keys are mapped automatically according to the information in the | |
2250 Termcap data base; the terminal-specific library needs to map only the | |
2251 function keys that Termcap does not specify. | |
2252 | |
2253 When the terminal type contains a hyphen, only the part of the name | |
2254 before the first hyphen is significant in choosing the library name. | |
2255 Thus, terminal types @samp{aaa-48} and @samp{aaa-30-rv} both use | |
2256 the library @file{term/aaa}. The code in the library can use | |
2257 @code{(getenv "TERM")} to find the full terminal type name.@refill | |
2258 | |
2259 @vindex term-file-prefix | |
2260 The library's name is constructed by concatenating the value of the | |
2261 variable @code{term-file-prefix} and the terminal type. Your @file{.emacs} | |
2262 file can prevent the loading of the terminal-specific library by setting | |
2263 @code{term-file-prefix} to @code{nil}. | |
2264 | |
2265 @vindex term-setup-hook | |
2266 Emacs runs the hook @code{term-setup-hook} at the end of | |
2267 initialization, after both your @file{.emacs} file and any | |
2268 terminal-specific library have been read in. Add hook functions to this | |
2269 hook if you wish to override part of any of the terminal-specific | |
2270 libraries and to define initializations for terminals that do not have a | |
2271 library. @xref{Hooks}. | |
2272 | |
2273 @node Find Init | |
2274 @subsection How Emacs Finds Your Init File | |
2275 | |
29107 | 2276 Normally Emacs uses the environment variable @env{HOME} to find |
25829 | 2277 @file{.emacs}; that's what @samp{~} means in a file name. But if you |
38114 | 2278 run Emacs from a shell started by @code{su}, Emacs tries to find your |
2279 own @file{.emacs}, not that of the user you are currently pretending | |
2280 to be. The idea is that you should get your own editor customizations | |
2281 even if you are running as the super user. | |
25829 | 2282 |
2283 More precisely, Emacs first determines which user's init file to use. | |
29107 | 2284 It gets the user name from the environment variables @env{LOGNAME} and |
2285 @env{USER}; if neither of those exists, it uses effective user-ID. | |
2286 If that user name matches the real user-ID, then Emacs uses @env{HOME}; | |
25829 | 2287 otherwise, it looks up the home directory corresponding to that user |
2288 name in the system's data base of users. | |
2289 @c LocalWords: backtab | |
52401 | 2290 |
2291 @ignore | |
2292 arch-tag: c68abddb-4410-4fb5-925f-63394e971d93 | |
2293 @end ignore |