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