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