annotate man/custom.texi @ 88155:d7ddb3e565de

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