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