(comint-quote-filename): Correctly handle backslash
[emacs.git] / lispref / keymaps.texi
blob9098266a54abe2efd67103d6e49f5685dc54d5b9
1 @c -*-texinfo-*-
2 @c This is part of the GNU Emacs Lisp Reference Manual.
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1998, 1999, 2000
4 @c   Free Software Foundation, Inc.
5 @c See the file elisp.texi for copying conditions.
6 @setfilename ../info/keymaps
7 @node Keymaps, Modes, Command Loop, Top
8 @chapter Keymaps
9 @cindex keymap
11   The bindings between input events and commands are recorded in data
12 structures called @dfn{keymaps}.  Each binding in a keymap associates
13 (or @dfn{binds}) an individual event type either to another keymap or to
14 a command.  When an event type is bound to a keymap, that keymap is used
15 to look up the next input event; this continues until a command is
16 found.  The whole process is called @dfn{key lookup}.
18 @menu
19 * Keymap Terminology::          Definitions of terms pertaining to keymaps.
20 * Format of Keymaps::           What a keymap looks like as a Lisp object.
21 * Creating Keymaps::            Functions to create and copy keymaps.
22 * Inheritance and Keymaps::     How one keymap can inherit the bindings
23                                    of another keymap.
24 * Prefix Keys::                 Defining a key with a keymap as its definition.
25 * Active Keymaps::              Each buffer has a local keymap
26                                    to override the standard (global) bindings.
27                                    A minor mode can also override them.
28 * Key Lookup::                  How extracting elements from keymaps works.
29 * Functions for Key Lookup::    How to request key lookup.
30 * Changing Key Bindings::       Redefining a key in a keymap.
31 * Remapping Commands::          Bindings that translate one command to another.
32 * Key Binding Commands::        Interactive interfaces for redefining keys.
33 * Scanning Keymaps::            Looking through all keymaps, for printing help.
34 * Menu Keymaps::                Defining a menu as a keymap.
35 @end menu
37 @node Keymap Terminology
38 @section Keymap Terminology
39 @cindex key
40 @cindex keystroke
41 @cindex key binding
42 @cindex binding of a key
43 @cindex complete key
44 @cindex undefined key
46   A @dfn{keymap} is a table mapping event types to definitions (which
47 can be any Lisp objects, though only certain types are meaningful for
48 execution by the command loop).  Given an event (or an event type) and a
49 keymap, Emacs can get the event's definition.  Events include
50 characters, function keys, and mouse actions (@pxref{Input Events}).
52   A sequence of input events that form a unit is called a
53 @dfn{key sequence}, or @dfn{key} for short.  A sequence of one event
54 is always a key sequence, and so are some multi-event sequences.
56   A keymap determines a binding or definition for any key sequence.  If
57 the key sequence is a single event, its binding is the definition of the
58 event in the keymap.  The binding of a key sequence of more than one
59 event is found by an iterative process: the binding of the first event
60 is found, and must be a keymap; then the second event's binding is found
61 in that keymap, and so on until all the events in the key sequence are
62 used up.
64   If the binding of a key sequence is a keymap, we call the key sequence
65 a @dfn{prefix key}.  Otherwise, we call it a @dfn{complete key} (because
66 no more events can be added to it).  If the binding is @code{nil},
67 we call the key @dfn{undefined}.  Examples of prefix keys are @kbd{C-c},
68 @kbd{C-x}, and @kbd{C-x 4}.  Examples of defined complete keys are
69 @kbd{X}, @key{RET}, and @kbd{C-x 4 C-f}.  Examples of undefined complete
70 keys are @kbd{C-x C-g}, and @kbd{C-c 3}.  @xref{Prefix Keys}, for more
71 details.
73   The rule for finding the binding of a key sequence assumes that the
74 intermediate bindings (found for the events before the last) are all
75 keymaps; if this is not so, the sequence of events does not form a
76 unit---it is not really one key sequence.  In other words, removing one
77 or more events from the end of any valid key sequence must always yield
78 a prefix key.  For example, @kbd{C-f C-n} is not a key sequence;
79 @kbd{C-f} is not a prefix key, so a longer sequence starting with
80 @kbd{C-f} cannot be a key sequence.
82   The set of possible multi-event key sequences depends on the bindings
83 for prefix keys; therefore, it can be different for different keymaps,
84 and can change when bindings are changed.  However, a one-event sequence
85 is always a key sequence, because it does not depend on any prefix keys
86 for its well-formedness.
88   At any time, several primary keymaps are @dfn{active}---that is, in
89 use for finding key bindings.  These are the @dfn{global map}, which is
90 shared by all buffers; the @dfn{local keymap}, which is usually
91 associated with a specific major mode; and zero or more @dfn{minor mode
92 keymaps}, which belong to currently enabled minor modes.  (Not all minor
93 modes have keymaps.)  The local keymap bindings shadow (i.e., take
94 precedence over) the corresponding global bindings.  The minor mode
95 keymaps shadow both local and global keymaps.  @xref{Active Keymaps},
96 for details.
98 @node Format of Keymaps
99 @section Format of Keymaps
100 @cindex format of keymaps
101 @cindex keymap format
102 @cindex full keymap
103 @cindex sparse keymap
105   A keymap is a list whose @sc{car} is the symbol @code{keymap}.  The
106 remaining elements of the list define the key bindings of the keymap.
107 A symbol whose function definition is a keymap is also a keymap.  Use
108 the function @code{keymapp} (see below) to test whether an object is a
109 keymap.
111   Several kinds of elements may appear in a keymap, after the symbol
112 @code{keymap} that begins it:
114 @table @code
115 @item (@var{type} .@: @var{binding})
116 This specifies one binding, for events of type @var{type}.  Each
117 ordinary binding applies to events of a particular @dfn{event type},
118 which is always a character or a symbol.  @xref{Classifying Events}.
120 @item (t .@: @var{binding})
121 @cindex default key binding
122 This specifies a @dfn{default key binding}; any event not bound by other
123 elements of the keymap is given @var{binding} as its binding.  Default
124 bindings allow a keymap to bind all possible event types without having
125 to enumerate all of them.  A keymap that has a default binding
126 completely masks any lower-precedence keymap.
128 @item @var{char-table}
129 If an element of a keymap is a char-table, it counts as holding
130 bindings for all character events with no modifier bits
131 (@pxref{modifier bits}): element @var{n} is the binding for the
132 character with code @var{n}.  This is a compact way to record lots of
133 bindings.  A keymap with such a char-table is called a @dfn{full
134 keymap}.  Other keymaps are called @dfn{sparse keymaps}.
136 When a keymap contains a char-table vector, it always defines a
137 binding for each character without modifiers.  However, if the binding
138 is @code{nil}, it doesn't constitute a definition.  @code{nil} takes
139 precedence over a default binding or a binding in the parent keymap.
140 So in a full keymap, default bindings are not meaningful for
141 characters without modifiers.  They can still apply to characters with
142 modifier bits and to non-character events.  A binding of @code{nil}
143 does @emph{not} override lower-precedence keymaps; thus, if the local
144 map gives a binding of @code{nil}, Emacs uses the binding from the
145 global map.
147 @item @var{string}
148 @cindex keymap prompt string
149 @cindex overall prompt string
150 @cindex prompt string of keymap
151 Aside from bindings, a keymap can also have a string as an element.
152 This is called the @dfn{overall prompt string} and makes it possible to
153 use the keymap as a menu.  @xref{Defining Menus}.
154 @end table
156 @cindex meta characters lookup
157   Keymaps do not directly record bindings for the meta characters.
158 Instead, meta characters are regarded for purposes of key lookup as
159 sequences of two characters, the first of which is @key{ESC} (or
160 whatever is currently the value of @code{meta-prefix-char}).  Thus, the
161 key @kbd{M-a} is internally represented as @kbd{@key{ESC} a}, and its
162 global binding is found at the slot for @kbd{a} in @code{esc-map}
163 (@pxref{Prefix Keys}).
165   This conversion applies only to characters, not to function keys or
166 other input events; thus, @kbd{M-@key{end}} has nothing to do with
167 @kbd{@key{ESC} @key{end}}.
169   Here as an example is the local keymap for Lisp mode, a sparse
170 keymap.  It defines bindings for @key{DEL} and @key{TAB}, plus @kbd{C-c
171 C-l}, @kbd{M-C-q}, and @kbd{M-C-x}.
173 @example
174 @group
175 lisp-mode-map
176 @result{}
177 @end group
178 @group
179 (keymap
180  ;; @key{TAB}
181  (9 . lisp-indent-line)
182 @end group
183 @group
184  ;; @key{DEL}
185  (127 . backward-delete-char-untabify)
186 @end group
187 @group
188  (3 keymap
189     ;; @kbd{C-c C-l}
190     (12 . run-lisp))
191 @end group
192 @group
193  (27 keymap
194      ;; @r{@kbd{M-C-q}, treated as @kbd{@key{ESC} C-q}}
195      (17 . indent-sexp)
196      ;; @r{@kbd{M-C-x}, treated as @kbd{@key{ESC} C-x}}
197      (24 . lisp-send-defun)))
198 @end group
199 @end example
201 @defun keymapp object
202 This function returns @code{t} if @var{object} is a keymap, @code{nil}
203 otherwise.  More precisely, this function tests for a list whose
204 @sc{car} is @code{keymap}, or for a symbol whose function definition
205 satisfies @code{keymapp}.
207 @example
208 @group
209 (keymapp '(keymap))
210     @result{} t
211 @end group
212 @group
213 (fset 'foo '(keymap))
214 (keymapp 'foo)
215     @result{} t
216 @end group
217 @group
218 (keymapp (current-global-map))
219     @result{} t
220 @end group
221 @end example
222 @end defun
224 @node Creating Keymaps
225 @section Creating Keymaps
226 @cindex creating keymaps
228   Here we describe the functions for creating keymaps.
230 @c ??? This should come after make-sparse-keymap
231 @defun make-keymap &optional prompt
232 This function creates and returns a new full keymap.  That keymap
233 contains a char-table (@pxref{Char-Tables}) with 384 slots: the first
234 128 slots are for defining all the @acronym{ASCII} characters, the next 128
235 slots are for 8-bit European characters, and each one of the final 128
236 slots is for one character set of non-@acronym{ASCII} characters supported by
237 Emacs.  The new keymap initially binds all these characters to
238 @code{nil}, and does not bind any other kind of event.
240 @example
241 @group
242 (make-keymap)
243     @result{} (keymap [nil nil nil @dots{} nil nil])
244 @end group
245 @end example
247 If you specify @var{prompt}, that becomes the overall prompt string for
248 the keymap.  The prompt string should be provided for menu keymaps
249 (@pxref{Defining Menus}).
250 @end defun
252 @defun make-sparse-keymap &optional prompt
253 This function creates and returns a new sparse keymap with no entries.
254 The new keymap does not contain a char-table, unlike @code{make-keymap},
255 and does not bind any events.  The argument @var{prompt} specifies a
256 prompt string, as in @code{make-keymap}.
258 @example
259 @group
260 (make-sparse-keymap)
261     @result{} (keymap)
262 @end group
263 @end example
264 @end defun
266 @defun copy-keymap keymap
267 This function returns a copy of @var{keymap}.  Any keymaps that
268 appear directly as bindings in @var{keymap} are also copied recursively,
269 and so on to any number of levels.  However, recursive copying does not
270 take place when the definition of a character is a symbol whose function
271 definition is a keymap; the same symbol appears in the new copy.
272 @c Emacs 19 feature
274 @example
275 @group
276 (setq map (copy-keymap (current-local-map)))
277 @result{} (keymap
278 @end group
279 @group
280      ;; @r{(This implements meta characters.)}
281      (27 keymap
282          (83 . center-paragraph)
283          (115 . center-line))
284      (9 . tab-to-tab-stop))
285 @end group
287 @group
288 (eq map (current-local-map))
289     @result{} nil
290 @end group
291 @group
292 (equal map (current-local-map))
293     @result{} t
294 @end group
295 @end example
296 @end defun
298 @node Inheritance and Keymaps
299 @section Inheritance and Keymaps
300 @cindex keymap inheritance
301 @cindex inheriting a keymap's bindings
303   A keymap can inherit the bindings of another keymap, which we call the
304 @dfn{parent keymap}.  Such a keymap looks like this:
306 @example
307 (keymap @var{bindings}@dots{} . @var{parent-keymap})
308 @end example
310 @noindent
311 The effect is that this keymap inherits all the bindings of
312 @var{parent-keymap}, whatever they may be at the time a key is looked up,
313 but can add to them or override them with @var{bindings}.
315 If you change the bindings in @var{parent-keymap} using @code{define-key}
316 or other key-binding functions, these changes are visible in the
317 inheriting keymap unless shadowed by @var{bindings}.  The converse is
318 not true: if you use @code{define-key} to change the inheriting keymap,
319 that affects @var{bindings}, but has no effect on @var{parent-keymap}.
321 The proper way to construct a keymap with a parent is to use
322 @code{set-keymap-parent}; if you have code that directly constructs a
323 keymap with a parent, please convert the program to use
324 @code{set-keymap-parent} instead.
326 @defun keymap-parent keymap
327 This returns the parent keymap of @var{keymap}.  If @var{keymap}
328 has no parent, @code{keymap-parent} returns @code{nil}.
329 @end defun
331 @defun set-keymap-parent keymap parent
332 This sets the parent keymap of @var{keymap} to @var{parent}, and returns
333 @var{parent}.  If @var{parent} is @code{nil}, this function gives
334 @var{keymap} no parent at all.
336 If @var{keymap} has submaps (bindings for prefix keys), they too receive
337 new parent keymaps that reflect what @var{parent} specifies for those
338 prefix keys.
339 @end defun
341    Here is an example showing how to make a keymap that inherits
342 from @code{text-mode-map}:
344 @example
345 (let ((map (make-sparse-keymap)))
346   (set-keymap-parent map text-mode-map)
347   map)
348 @end example
350   A non-sparse keymap can have a parent too, but this is not very
351 useful.  A non-sparse keymap always specifies something as the binding
352 for every numeric character code without modifier bits, even if it is
353 @code{nil}, so these character's bindings are never inherited from
354 the parent keymap.
356 @node Prefix Keys
357 @section Prefix Keys
358 @cindex prefix key
360   A @dfn{prefix key} is a key sequence whose binding is a keymap.  The
361 keymap defines what to do with key sequences that extend the prefix key.
362 For example, @kbd{C-x} is a prefix key, and it uses a keymap that is
363 also stored in the variable @code{ctl-x-map}.  This keymap defines
364 bindings for key sequences starting with @kbd{C-x}.
366   Some of the standard Emacs prefix keys use keymaps that are
367 also found in Lisp variables:
369 @itemize @bullet
370 @item
371 @vindex esc-map
372 @findex ESC-prefix
373 @code{esc-map} is the global keymap for the @key{ESC} prefix key.  Thus,
374 the global definitions of all meta characters are actually found here.
375 This map is also the function definition of @code{ESC-prefix}.
377 @item
378 @cindex @kbd{C-h}
379 @code{help-map} is the global keymap for the @kbd{C-h} prefix key.
381 @item
382 @cindex @kbd{C-c}
383 @vindex mode-specific-map
384 @code{mode-specific-map} is the global keymap for the prefix key
385 @kbd{C-c}.  This map is actually global, not mode-specific, but its name
386 provides useful information about @kbd{C-c} in the output of @kbd{C-h b}
387 (@code{display-bindings}), since the main use of this prefix key is for
388 mode-specific bindings.
390 @item
391 @cindex @kbd{C-x}
392 @vindex ctl-x-map
393 @findex Control-X-prefix
394 @code{ctl-x-map} is the global keymap used for the @kbd{C-x} prefix key.
395 This map is found via the function cell of the symbol
396 @code{Control-X-prefix}.
398 @item
399 @cindex @kbd{C-x @key{RET}}
400 @vindex mule-keymap
401 @code{mule-keymap} is the global keymap used for the @kbd{C-x @key{RET}}
402 prefix key.
404 @item
405 @cindex @kbd{C-x 4}
406 @vindex ctl-x-4-map
407 @code{ctl-x-4-map} is the global keymap used for the @kbd{C-x 4} prefix
408 key.
410 @c Emacs 19 feature
411 @item
412 @cindex @kbd{C-x 5}
413 @vindex ctl-x-5-map
414 @code{ctl-x-5-map} is the global keymap used for the @kbd{C-x 5} prefix
415 key.
417 @c Emacs 19 feature
418 @item
419 @cindex @kbd{C-x 6}
420 @vindex 2C-mode-map
421 @code{2C-mode-map} is the global keymap used for the @kbd{C-x 6} prefix
422 key.
424 @item
425 @cindex @kbd{C-x v}
426 @vindex vc-prefix-map
427 @code{vc-prefix-map} is the global keymap used for the @kbd{C-x v} prefix
428 key.
430 @item
431 @cindex @kbd{M-g}
432 @vindex facemenu-keymap
433 @code{facemenu-keymap} is the global keymap used for the @kbd{M-g}
434 prefix key.
436 @c Emacs 19 feature
437 @item
438 The other Emacs prefix keys are @kbd{C-x @@}, @kbd{C-x a i}, @kbd{C-x
439 @key{ESC}} and @kbd{@key{ESC} @key{ESC}}.  They use keymaps that have no
440 special names.
441 @end itemize
443   The keymap binding of a prefix key is used for looking up the event
444 that follows the prefix key.  (It may instead be a symbol whose function
445 definition is a keymap.  The effect is the same, but the symbol serves
446 as a name for the prefix key.)  Thus, the binding of @kbd{C-x} is the
447 symbol @code{Control-X-prefix}, whose function cell holds the keymap
448 for @kbd{C-x} commands.  (The same keymap is also the value of
449 @code{ctl-x-map}.)
451   Prefix key definitions can appear in any active keymap.  The
452 definitions of @kbd{C-c}, @kbd{C-x}, @kbd{C-h} and @key{ESC} as prefix
453 keys appear in the global map, so these prefix keys are always
454 available.  Major and minor modes can redefine a key as a prefix by
455 putting a prefix key definition for it in the local map or the minor
456 mode's map.  @xref{Active Keymaps}.
458   If a key is defined as a prefix in more than one active map, then its
459 various definitions are in effect merged: the commands defined in the
460 minor mode keymaps come first, followed by those in the local map's
461 prefix definition, and then by those from the global map.
463   In the following example, we make @kbd{C-p} a prefix key in the local
464 keymap, in such a way that @kbd{C-p} is identical to @kbd{C-x}.  Then
465 the binding for @kbd{C-p C-f} is the function @code{find-file}, just
466 like @kbd{C-x C-f}.  The key sequence @kbd{C-p 6} is not found in any
467 active keymap.
469 @example
470 @group
471 (use-local-map (make-sparse-keymap))
472     @result{} nil
473 @end group
474 @group
475 (local-set-key "\C-p" ctl-x-map)
476     @result{} nil
477 @end group
478 @group
479 (key-binding "\C-p\C-f")
480     @result{} find-file
481 @end group
483 @group
484 (key-binding "\C-p6")
485     @result{} nil
486 @end group
487 @end example
489 @defun define-prefix-command symbol &optional mapvar prompt
490 @cindex prefix command
491 This function prepares @var{symbol} for use as a prefix key's binding:
492 it creates a sparse keymap and stores it as @var{symbol}'s function
493 definition.  Subsequently binding a key sequence to @var{symbol} will
494 make that key sequence into a prefix key.  The return value is @code{symbol}.
496 This function also sets @var{symbol} as a variable, with the keymap as
497 its value.  But if @var{mapvar} is non-@code{nil}, it sets @var{mapvar}
498 as a variable instead.
500 If @var{prompt} is non-@code{nil}, that becomes the overall prompt
501 string for the keymap.  The prompt string should be given for menu keymaps
502 (@pxref{Defining Menus}).
503 @end defun
505 @node Active Keymaps
506 @section Active Keymaps
507 @cindex active keymap
508 @cindex global keymap
509 @cindex local keymap
511   Emacs normally contains many keymaps; at any given time, just a few of
512 them are @dfn{active} in that they participate in the interpretation
513 of user input.  These are the global keymap, the current buffer's
514 local keymap, and the keymaps of any enabled minor modes.
516   The @dfn{global keymap} holds the bindings of keys that are defined
517 regardless of the current buffer, such as @kbd{C-f}.  The variable
518 @code{global-map} holds this keymap, which is always active.
520   Each buffer may have another keymap, its @dfn{local keymap}, which may
521 contain new or overriding definitions for keys.  The current buffer's
522 local keymap is always active except when @code{overriding-local-map}
523 overrides it.  Text properties can specify an alternative local map for
524 certain parts of the buffer; see @ref{Special Properties}.
526   Each minor mode can have a keymap; if it does, the keymap is active
527 when the minor mode is enabled.
529   The variable @code{overriding-local-map}, if non-@code{nil}, specifies
530 another local keymap that overrides the buffer's local map and all the
531 minor mode keymaps.  Modes for emulation can specify additional
532 active keymaps through the variable @code{emulation-mode-map-alists}.
534   All the active keymaps are used together to determine what command to
535 execute when a key is entered.  Emacs searches these maps one by one, in
536 order of decreasing precedence, until it finds a binding in one of the
537 maps.  The procedure for searching a single keymap is called @dfn{key
538 lookup}; see @ref{Key Lookup}.
540   Normally, Emacs first searches for the key in the minor mode maps, in
541 the order specified by @code{minor-mode-map-alist}; if they do not
542 supply a binding for the key, Emacs searches the local map; if that too
543 has no binding, Emacs then searches the global map.  However, if
544 @code{overriding-local-map} is non-@code{nil}, Emacs searches that map
545 first, before the global map.
547 @cindex major mode keymap
548   Since every buffer that uses the same major mode normally uses the
549 same local keymap, you can think of the keymap as local to the mode.  A
550 change to the local keymap of a buffer (using @code{local-set-key}, for
551 example) is seen also in the other buffers that share that keymap.
553   The local keymaps that are used for Lisp mode and some other major
554 modes exist even if they have not yet been used.  These local maps are
555 the values of variables such as @code{lisp-mode-map}.  For most major
556 modes, which are less frequently used, the local keymap is constructed
557 only when the mode is used for the first time in a session.
559   The minibuffer has local keymaps, too; they contain various completion
560 and exit commands.  @xref{Intro to Minibuffers}.
562   Emacs has other keymaps that are used in a different way---translating
563 events within @code{read-key-sequence}.  @xref{Translating Input}.
565   @xref{Standard Keymaps}, for a list of standard keymaps.
567 @defvar global-map
568 This variable contains the default global keymap that maps Emacs
569 keyboard input to commands.  The global keymap is normally this keymap.
570 The default global keymap is a full keymap that binds
571 @code{self-insert-command} to all of the printing characters.
573 It is normal practice to change the bindings in the global map, but you
574 should not assign this variable any value other than the keymap it starts
575 out with.
576 @end defvar
578 @defun current-global-map
579 This function returns the current global keymap.  This is the
580 same as the value of @code{global-map} unless you change one or the
581 other.
583 @example
584 @group
585 (current-global-map)
586 @result{} (keymap [set-mark-command beginning-of-line @dots{}
587             delete-backward-char])
588 @end group
589 @end example
590 @end defun
592 @defun current-local-map
593 This function returns the current buffer's local keymap, or @code{nil}
594 if it has none.  In the following example, the keymap for the
595 @samp{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap
596 in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse
597 keymap.
599 @example
600 @group
601 (current-local-map)
602 @result{} (keymap
603     (10 . eval-print-last-sexp)
604     (9 . lisp-indent-line)
605     (127 . backward-delete-char-untabify)
606 @end group
607 @group
608     (27 keymap
609         (24 . eval-defun)
610         (17 . indent-sexp)))
611 @end group
612 @end example
613 @end defun
615 @defun current-minor-mode-maps
616 This function returns a list of the keymaps of currently enabled minor modes.
617 @end defun
619 @defun use-global-map keymap
620 This function makes @var{keymap} the new current global keymap.  It
621 returns @code{nil}.
623 It is very unusual to change the global keymap.
624 @end defun
626 @defun use-local-map keymap
627 This function makes @var{keymap} the new local keymap of the current
628 buffer.  If @var{keymap} is @code{nil}, then the buffer has no local
629 keymap.  @code{use-local-map} returns @code{nil}.  Most major mode
630 commands use this function.
631 @end defun
633 @c Emacs 19 feature
634 @defvar minor-mode-map-alist
635 This variable is an alist describing keymaps that may or may not be
636 active according to the values of certain variables.  Its elements look
637 like this:
639 @example
640 (@var{variable} . @var{keymap})
641 @end example
643 The keymap @var{keymap} is active whenever @var{variable} has a
644 non-@code{nil} value.  Typically @var{variable} is the variable that
645 enables or disables a minor mode.  @xref{Keymaps and Minor Modes}.
647 Note that elements of @code{minor-mode-map-alist} do not have the same
648 structure as elements of @code{minor-mode-alist}.  The map must be the
649 @sc{cdr} of the element; a list with the map as the second element will
650 not do.  The @sc{cdr} can be either a keymap (a list) or a symbol whose
651 function definition is a keymap.
653 When more than one minor mode keymap is active, their order of priority
654 is the order of @code{minor-mode-map-alist}.  But you should design
655 minor modes so that they don't interfere with each other.  If you do
656 this properly, the order will not matter.
658 See @ref{Keymaps and Minor Modes}, for more information about minor
659 modes.  See also @code{minor-mode-key-binding} (@pxref{Functions for Key
660 Lookup}).
661 @end defvar
663 @defvar minor-mode-overriding-map-alist
664 This variable allows major modes to override the key bindings for
665 particular minor modes.  The elements of this alist look like the
666 elements of @code{minor-mode-map-alist}: @code{(@var{variable}
667 . @var{keymap})}.
669 If a variable appears as an element of
670 @code{minor-mode-overriding-map-alist}, the map specified by that
671 element totally replaces any map specified for the same variable in
672 @code{minor-mode-map-alist}.
674 @code{minor-mode-overriding-map-alist} is automatically buffer-local in
675 all buffers.
676 @end defvar
678 @defvar overriding-local-map
679 If non-@code{nil}, this variable holds a keymap to use instead of the
680 buffer's local keymap and instead of all the minor mode keymaps.  This
681 keymap, if any, overrides all other maps that would have been active,
682 except for the current global map.
683 @end defvar
685 @defvar overriding-terminal-local-map
686 If non-@code{nil}, this variable holds a keymap to use instead of
687 @code{overriding-local-map}, the buffer's local keymap and all the minor
688 mode keymaps.
690 This variable is always local to the current terminal and cannot be
691 buffer-local.  @xref{Multiple Displays}.  It is used to implement
692 incremental search mode.
693 @end defvar
695 @defvar overriding-local-map-menu-flag
696 If this variable is non-@code{nil}, the value of
697 @code{overriding-local-map} or @code{overriding-terminal-local-map} can
698 affect the display of the menu bar.  The default value is @code{nil}, so
699 those map variables have no effect on the menu bar.
701 Note that these two map variables do affect the execution of key
702 sequences entered using the menu bar, even if they do not affect the
703 menu bar display.  So if a menu bar key sequence comes in, you should
704 clear the variables before looking up and executing that key sequence.
705 Modes that use the variables would typically do this anyway; normally
706 they respond to events that they do not handle by ``unreading'' them and
707 exiting.
708 @end defvar
710 @defvar special-event-map
711 This variable holds a keymap for special events.  If an event type has a
712 binding in this keymap, then it is special, and the binding for the
713 event is run directly by @code{read-event}.  @xref{Special Events}.
714 @end defvar
716 @defvar emulation-mode-map-alists
717 This variable holds a list of keymap alists to use for emulations
718 modes.  It is intended for modes or packages using multiple minor-mode
719 keymaps.  Each element is a keymap alist which has the same format and
720 meaning as @code{minor-mode-map-alist}, or a symbol with a variable
721 binding which is such an alist.  The ``active'' keymaps in each alist
722 are used before @code{minor-mode-map-alist} and
723 @code{minor-mode-overriding-map-alist}.
724 @end defvar
726 @node Key Lookup
727 @section Key Lookup
728 @cindex key lookup
729 @cindex keymap entry
731   @dfn{Key lookup} is the process of finding the binding of a key
732 sequence from a given keymap.  Actual execution of the binding is not
733 part of key lookup.
735   Key lookup uses just the event type of each event in the key sequence;
736 the rest of the event is ignored.  In fact, a key sequence used for key
737 lookup may designate mouse events with just their types (symbols)
738 instead of with entire mouse events (lists).  @xref{Input Events}.  Such
739 a ``key-sequence'' is insufficient for @code{command-execute} to run,
740 but it is sufficient for looking up or rebinding a key.
742   When the key sequence consists of multiple events, key lookup
743 processes the events sequentially: the binding of the first event is
744 found, and must be a keymap; then the second event's binding is found in
745 that keymap, and so on until all the events in the key sequence are used
746 up.  (The binding thus found for the last event may or may not be a
747 keymap.)  Thus, the process of key lookup is defined in terms of a
748 simpler process for looking up a single event in a keymap.  How that is
749 done depends on the type of object associated with the event in that
750 keymap.
752   Let's use the term @dfn{keymap entry} to describe the value found by
753 looking up an event type in a keymap.  (This doesn't include the item
754 string and other extra elements in menu key bindings, because
755 @code{lookup-key} and other key lookup functions don't include them in
756 the returned value.)  While any Lisp object may be stored in a keymap as
757 a keymap entry, not all make sense for key lookup.  Here is a table of
758 the meaningful kinds of keymap entries:
760 @table @asis
761 @item @code{nil}
762 @cindex @code{nil} in keymap
763 @code{nil} means that the events used so far in the lookup form an
764 undefined key.  When a keymap fails to mention an event type at all, and
765 has no default binding, that is equivalent to a binding of @code{nil}
766 for that event type.
768 @item @var{command}
769 @cindex command in keymap
770 The events used so far in the lookup form a complete key,
771 and @var{command} is its binding.  @xref{What Is a Function}.
773 @item @var{array}
774 @cindex string in keymap
775 The array (either a string or a vector) is a keyboard macro.  The events
776 used so far in the lookup form a complete key, and the array is its
777 binding.  See @ref{Keyboard Macros}, for more information.
779 @item @var{keymap}
780 @cindex keymap in keymap
781 The events used so far in the lookup form a prefix key.  The next
782 event of the key sequence is looked up in @var{keymap}.
784 @item @var{list}
785 @cindex list in keymap
786 The meaning of a list depends on the types of the elements of the list.
788 @itemize @bullet
789 @item
790 If the @sc{car} of @var{list} is the symbol @code{keymap}, then the list
791 is a keymap, and is treated as a keymap (see above).
793 @item
794 @cindex @code{lambda} in keymap
795 If the @sc{car} of @var{list} is @code{lambda}, then the list is a
796 lambda expression.  This is presumed to be a command, and is treated as
797 such (see above).
799 @item
800 If the @sc{car} of @var{list} is a keymap and the @sc{cdr} is an event
801 type, then this is an @dfn{indirect entry}:
803 @example
804 (@var{othermap} . @var{othertype})
805 @end example
807 When key lookup encounters an indirect entry, it looks up instead the
808 binding of @var{othertype} in @var{othermap} and uses that.
810 This feature permits you to define one key as an alias for another key.
811 For example, an entry whose @sc{car} is the keymap called @code{esc-map}
812 and whose @sc{cdr} is 32 (the code for @key{SPC}) means, ``Use the global
813 binding of @kbd{Meta-@key{SPC}}, whatever that may be.''
814 @end itemize
816 @item @var{symbol}
817 @cindex symbol in keymap
818 The function definition of @var{symbol} is used in place of
819 @var{symbol}.  If that too is a symbol, then this process is repeated,
820 any number of times.  Ultimately this should lead to an object that is
821 a keymap, a command, or a keyboard macro.  A list is allowed if it is a
822 keymap or a command, but indirect entries are not understood when found
823 via symbols.
825 Note that keymaps and keyboard macros (strings and vectors) are not
826 valid functions, so a symbol with a keymap, string, or vector as its
827 function definition is invalid as a function.  It is, however, valid as
828 a key binding.  If the definition is a keyboard macro, then the symbol
829 is also valid as an argument to @code{command-execute}
830 (@pxref{Interactive Call}).
832 @cindex @code{undefined} in keymap
833 The symbol @code{undefined} is worth special mention: it means to treat
834 the key as undefined.  Strictly speaking, the key is defined, and its
835 binding is the command @code{undefined}; but that command does the same
836 thing that is done automatically for an undefined key: it rings the bell
837 (by calling @code{ding}) but does not signal an error.
839 @cindex preventing prefix key
840 @code{undefined} is used in local keymaps to override a global key
841 binding and make the key ``undefined'' locally.  A local binding of
842 @code{nil} would fail to do this because it would not override the
843 global binding.
845 @item @var{anything else}
846 If any other type of object is found, the events used so far in the
847 lookup form a complete key, and the object is its binding, but the
848 binding is not executable as a command.
849 @end table
851   In short, a keymap entry may be a keymap, a command, a keyboard macro,
852 a symbol that leads to one of them, or an indirection or @code{nil}.
853 Here is an example of a sparse keymap with two characters bound to
854 commands and one bound to another keymap.  This map is the normal value
855 of @code{emacs-lisp-mode-map}.  Note that 9 is the code for @key{TAB},
856 127 for @key{DEL}, 27 for @key{ESC}, 17 for @kbd{C-q} and 24 for
857 @kbd{C-x}.
859 @example
860 @group
861 (keymap (9 . lisp-indent-line)
862         (127 . backward-delete-char-untabify)
863         (27 keymap (17 . indent-sexp) (24 . eval-defun)))
864 @end group
865 @end example
867 @node Functions for Key Lookup
868 @section Functions for Key Lookup
870   Here are the functions and variables pertaining to key lookup.
872 @defun lookup-key keymap key &optional accept-defaults
873 This function returns the definition of @var{key} in @var{keymap}.  All
874 the other functions described in this chapter that look up keys use
875 @code{lookup-key}.  Here are examples:
877 @example
878 @group
879 (lookup-key (current-global-map) "\C-x\C-f")
880     @result{} find-file
881 @end group
882 @group
883 (lookup-key (current-global-map) "\C-x\C-f12345")
884     @result{} 2
885 @end group
886 @end example
888 If the string or vector @var{key} is not a valid key sequence according
889 to the prefix keys specified in @var{keymap}, it must be ``too long''
890 and have extra events at the end that do not fit into a single key
891 sequence.  Then the value is a number, the number of events at the front
892 of @var{key} that compose a complete key.
894 @c Emacs 19 feature
895 If @var{accept-defaults} is non-@code{nil}, then @code{lookup-key}
896 considers default bindings as well as bindings for the specific events
897 in @var{key}.  Otherwise, @code{lookup-key} reports only bindings for
898 the specific sequence @var{key}, ignoring default bindings except when
899 you explicitly ask about them.  (To do this, supply @code{t} as an
900 element of @var{key}; see @ref{Format of Keymaps}.)
902 If @var{key} contains a meta character (not a function key), that
903 character is implicitly replaced by a two-character sequence: the value
904 of @code{meta-prefix-char}, followed by the corresponding non-meta
905 character.  Thus, the first example below is handled by conversion into
906 the second example.
908 @example
909 @group
910 (lookup-key (current-global-map) "\M-f")
911     @result{} forward-word
912 @end group
913 @group
914 (lookup-key (current-global-map) "\ef")
915     @result{} forward-word
916 @end group
917 @end example
919 Unlike @code{read-key-sequence}, this function does not modify the
920 specified events in ways that discard information (@pxref{Key Sequence
921 Input}).  In particular, it does not convert letters to lower case and
922 it does not change drag events to clicks.
923 @end defun
925 @deffn Command undefined
926 Used in keymaps to undefine keys.  It calls @code{ding}, but does
927 not cause an error.
928 @end deffn
930 @defun key-binding key &optional accept-defaults no-remap
931 This function returns the binding for @var{key} in the current
932 keymaps, trying all the active keymaps.  The result is @code{nil} if
933 @var{key} is undefined in the keymaps.
935 @c Emacs 19 feature
936 The argument @var{accept-defaults} controls checking for default
937 bindings, as in @code{lookup-key} (above).
939 When commands are remapped (@pxref{Remapping Commands}),
940 @code{key-binding} normally processes command remappings so as to
941 returns the remapped command that will actually be executed.  However,
942 if @var{no-remap} is non-@code{nil}, @code{key-binding} ignores
943 remappings and returns the binding directly specified for @var{key}.
945 An error is signaled if @var{key} is not a string or a vector.
947 @example
948 @group
949 (key-binding "\C-x\C-f")
950     @result{} find-file
951 @end group
952 @end example
953 @end defun
955 @defun current-active-maps
956 This returns the list of keymaps that would be used by the command
957 loop in the current circumstances to look up a key sequence.
958 @end defun
960 @defun local-key-binding key &optional accept-defaults
961 This function returns the binding for @var{key} in the current
962 local keymap, or @code{nil} if it is undefined there.
964 @c Emacs 19 feature
965 The argument @var{accept-defaults} controls checking for default bindings,
966 as in @code{lookup-key} (above).
967 @end defun
969 @defun global-key-binding key &optional accept-defaults
970 This function returns the binding for command @var{key} in the
971 current global keymap, or @code{nil} if it is undefined there.
973 @c Emacs 19 feature
974 The argument @var{accept-defaults} controls checking for default bindings,
975 as in @code{lookup-key} (above).
976 @end defun
978 @c Emacs 19 feature
979 @defun minor-mode-key-binding key &optional accept-defaults
980 This function returns a list of all the active minor mode bindings of
981 @var{key}.  More precisely, it returns an alist of pairs
982 @code{(@var{modename} . @var{binding})}, where @var{modename} is the
983 variable that enables the minor mode, and @var{binding} is @var{key}'s
984 binding in that mode.  If @var{key} has no minor-mode bindings, the
985 value is @code{nil}.
987 If the first binding found is not a prefix definition (a keymap or a
988 symbol defined as a keymap), all subsequent bindings from other minor
989 modes are omitted, since they would be completely shadowed.  Similarly,
990 the list omits non-prefix bindings that follow prefix bindings.
992 The argument @var{accept-defaults} controls checking for default
993 bindings, as in @code{lookup-key} (above).
994 @end defun
996 @defvar meta-prefix-char
997 @cindex @key{ESC}
998 This variable is the meta-prefix character code.  It is used when
999 translating a meta character to a two-character sequence so it can be
1000 looked up in a keymap.  For useful results, the value should be a prefix
1001 event (@pxref{Prefix Keys}).  The default value is 27, which is the
1002 @acronym{ASCII} code for @key{ESC}.
1004 As long as the value of @code{meta-prefix-char} remains 27, key lookup
1005 translates @kbd{M-b} into @kbd{@key{ESC} b}, which is normally defined
1006 as the @code{backward-word} command.  However, if you were to set
1007 @code{meta-prefix-char} to 24, the code for @kbd{C-x}, then Emacs will
1008 translate @kbd{M-b} into @kbd{C-x b}, whose standard binding is the
1009 @code{switch-to-buffer} command.  (Don't actually do this!)  Here is an
1010 illustration of what would happen:
1012 @smallexample
1013 @group
1014 meta-prefix-char                    ; @r{The default value.}
1015      @result{} 27
1016 @end group
1017 @group
1018 (key-binding "\M-b")
1019      @result{} backward-word
1020 @end group
1021 @group
1022 ?\C-x                               ; @r{The print representation}
1023      @result{} 24                          ;   @r{of a character.}
1024 @end group
1025 @group
1026 (setq meta-prefix-char 24)
1027      @result{} 24
1028 @end group
1029 @group
1030 (key-binding "\M-b")
1031      @result{} switch-to-buffer            ; @r{Now, typing @kbd{M-b} is}
1032                                     ;   @r{like typing @kbd{C-x b}.}
1034 (setq meta-prefix-char 27)          ; @r{Avoid confusion!}
1035      @result{} 27                          ; @r{Restore the default value!}
1036 @end group
1037 @end smallexample
1039 This translation of one event into two happens only for characters, not
1040 for other kinds of input events.  Thus, @kbd{M-@key{F1}}, a function
1041 key, is not converted into @kbd{@key{ESC} @key{F1}}.
1042 @end defvar
1044 @node Changing Key Bindings
1045 @section Changing Key Bindings
1046 @cindex changing key bindings
1047 @cindex rebinding
1049   The way to rebind a key is to change its entry in a keymap.  If you
1050 change a binding in the global keymap, the change is effective in all
1051 buffers (though it has no direct effect in buffers that shadow the
1052 global binding with a local one).  If you change the current buffer's
1053 local map, that usually affects all buffers using the same major mode.
1054 The @code{global-set-key} and @code{local-set-key} functions are
1055 convenient interfaces for these operations (@pxref{Key Binding
1056 Commands}).  You can also use @code{define-key}, a more general
1057 function; then you must specify explicitly the map to change.
1059 @cindex meta character key constants
1060 @cindex control character key constants
1061   In writing the key sequence to rebind, it is good to use the special
1062 escape sequences for control and meta characters (@pxref{String Type}).
1063 The syntax @samp{\C-} means that the following character is a control
1064 character and @samp{\M-} means that the following character is a meta
1065 character.  Thus, the string @code{"\M-x"} is read as containing a
1066 single @kbd{M-x}, @code{"\C-f"} is read as containing a single
1067 @kbd{C-f}, and @code{"\M-\C-x"} and @code{"\C-\M-x"} are both read as
1068 containing a single @kbd{C-M-x}.  You can also use this escape syntax in
1069 vectors, as well as others that aren't allowed in strings; one example
1070 is @samp{[?\C-\H-x home]}.  @xref{Character Type}.
1072   The key definition and lookup functions accept an alternate syntax for
1073 event types in a key sequence that is a vector: you can use a list
1074 containing modifier names plus one base event (a character or function
1075 key name).  For example, @code{(control ?a)} is equivalent to
1076 @code{?\C-a} and @code{(hyper control left)} is equivalent to
1077 @code{C-H-left}.  One advantage of such lists is that the precise
1078 numeric codes for the modifier bits don't appear in compiled files.
1080   For the functions below, an error is signaled if @var{keymap} is not a
1081 keymap or if @var{key} is not a string or vector representing a key
1082 sequence.  You can use event types (symbols) as shorthand for events
1083 that are lists.
1085 @defun define-key keymap key binding
1086 This function sets the binding for @var{key} in @var{keymap}.  (If
1087 @var{key} is more than one event long, the change is actually made
1088 in another keymap reached from @var{keymap}.)  The argument
1089 @var{binding} can be any Lisp object, but only certain types are
1090 meaningful.  (For a list of meaningful types, see @ref{Key Lookup}.)
1091 The value returned by @code{define-key} is @var{binding}.
1093 If @var{key} is @code{[t]}, this sets the default binding in
1094 @var{keymap}.  When an event has no binding of its own, the Emacs
1095 command loop uses the keymap's default binding, if there is one.
1097 @cindex invalid prefix key error
1098 @cindex key sequence error
1099 Every prefix of @var{key} must be a prefix key (i.e., bound to a keymap)
1100 or undefined; otherwise an error is signaled.  If some prefix of
1101 @var{key} is undefined, then @code{define-key} defines it as a prefix
1102 key so that the rest of @var{key} can be defined as specified.
1104 If there was previously no binding for @var{key} in @var{keymap}, the
1105 new binding is added at the beginning of @var{keymap}.  The order of
1106 bindings in a keymap makes no difference for keyboard input, but it
1107 does matter for menu keymaps (@pxref{Menu Keymaps}).
1108 @end defun
1110   Here is an example that creates a sparse keymap and makes a number of
1111 bindings in it:
1113 @smallexample
1114 @group
1115 (setq map (make-sparse-keymap))
1116     @result{} (keymap)
1117 @end group
1118 @group
1119 (define-key map "\C-f" 'forward-char)
1120     @result{} forward-char
1121 @end group
1122 @group
1124     @result{} (keymap (6 . forward-char))
1125 @end group
1127 @group
1128 ;; @r{Build sparse submap for @kbd{C-x} and bind @kbd{f} in that.}
1129 (define-key map "\C-xf" 'forward-word)
1130     @result{} forward-word
1131 @end group
1132 @group
1134 @result{} (keymap
1135     (24 keymap                ; @kbd{C-x}
1136         (102 . forward-word)) ;      @kbd{f}
1137     (6 . forward-char))       ; @kbd{C-f}
1138 @end group
1140 @group
1141 ;; @r{Bind @kbd{C-p} to the @code{ctl-x-map}.}
1142 (define-key map "\C-p" ctl-x-map)
1143 ;; @code{ctl-x-map}
1144 @result{} [nil @dots{} find-file @dots{} backward-kill-sentence]
1145 @end group
1147 @group
1148 ;; @r{Bind @kbd{C-f} to @code{foo} in the @code{ctl-x-map}.}
1149 (define-key map "\C-p\C-f" 'foo)
1150 @result{} 'foo
1151 @end group
1152 @group
1154 @result{} (keymap     ; @r{Note @code{foo} in @code{ctl-x-map}.}
1155     (16 keymap [nil @dots{} foo @dots{} backward-kill-sentence])
1156     (24 keymap
1157         (102 . forward-word))
1158     (6 . forward-char))
1159 @end group
1160 @end smallexample
1162 @noindent
1163 Note that storing a new binding for @kbd{C-p C-f} actually works by
1164 changing an entry in @code{ctl-x-map}, and this has the effect of
1165 changing the bindings of both @kbd{C-p C-f} and @kbd{C-x C-f} in the
1166 default global map.
1168   The function @code{substitute-key-definition} scans a keymap for
1169 keys that have a certain binding and rebind them with a different
1170 binding.  Another feature you can use for similar effects, but which
1171 is often cleaner, is to add a binding that remaps a command
1172 (@pxref{Remapping Commands}).
1174 @defun substitute-key-definition olddef newdef keymap &optional oldmap
1175 @cindex replace bindings
1176 This function replaces @var{olddef} with @var{newdef} for any keys in
1177 @var{keymap} that were bound to @var{olddef}.  In other words,
1178 @var{olddef} is replaced with @var{newdef} wherever it appears.  The
1179 function returns @code{nil}.
1181 For example, this redefines @kbd{C-x C-f}, if you do it in an Emacs with
1182 standard bindings:
1184 @smallexample
1185 @group
1186 (substitute-key-definition
1187  'find-file 'find-file-read-only (current-global-map))
1188 @end group
1189 @end smallexample
1191 @c Emacs 19 feature
1192 If @var{oldmap} is non-@code{nil}, that changes the behavior of
1193 @code{substitute-key-definition}: the bindings in @var{oldmap} determine
1194 which keys to rebind.  The rebindings still happen in @var{keymap}, not
1195 in @var{oldmap}.  Thus, you can change one map under the control of the
1196 bindings in another.  For example,
1198 @smallexample
1199 (substitute-key-definition
1200   'delete-backward-char 'my-funny-delete
1201   my-map global-map)
1202 @end smallexample
1204 @noindent
1205 puts the special deletion command in @code{my-map} for whichever keys
1206 are globally bound to the standard deletion command.
1208 Here is an example showing a keymap before and after substitution:
1210 @smallexample
1211 @group
1212 (setq map '(keymap
1213             (?1 . olddef-1)
1214             (?2 . olddef-2)
1215             (?3 . olddef-1)))
1216 @result{} (keymap (49 . olddef-1) (50 . olddef-2) (51 . olddef-1))
1217 @end group
1219 @group
1220 (substitute-key-definition 'olddef-1 'newdef map)
1221 @result{} nil
1222 @end group
1223 @group
1225 @result{} (keymap (49 . newdef) (50 . olddef-2) (51 . newdef))
1226 @end group
1227 @end smallexample
1228 @end defun
1230 @defun suppress-keymap keymap &optional nodigits
1231 @cindex @code{self-insert-command} override
1232 This function changes the contents of the full keymap @var{keymap} by
1233 making all the printing characters undefined.  More precisely, it binds
1234 them to the command @code{undefined}.  This makes ordinary insertion of
1235 text impossible.  @code{suppress-keymap} returns @code{nil}.
1237 If @var{nodigits} is @code{nil}, then @code{suppress-keymap} defines
1238 digits to run @code{digit-argument}, and @kbd{-} to run
1239 @code{negative-argument}.  Otherwise it makes them undefined like the
1240 rest of the printing characters.
1242 @cindex yank suppression
1243 @cindex @code{quoted-insert} suppression
1244 The @code{suppress-keymap} function does not make it impossible to
1245 modify a buffer, as it does not suppress commands such as @code{yank}
1246 and @code{quoted-insert}.  To prevent any modification of a buffer, make
1247 it read-only (@pxref{Read Only Buffers}).
1249 Since this function modifies @var{keymap}, you would normally use it
1250 on a newly created keymap.  Operating on an existing keymap
1251 that is used for some other purpose is likely to cause trouble; for
1252 example, suppressing @code{global-map} would make it impossible to use
1253 most of Emacs.
1255 Most often, @code{suppress-keymap} is used to initialize local
1256 keymaps of modes such as Rmail and Dired where insertion of text is not
1257 desirable and the buffer is read-only.  Here is an example taken from
1258 the file @file{emacs/lisp/dired.el}, showing how the local keymap for
1259 Dired mode is set up:
1261 @smallexample
1262 @group
1263 (setq dired-mode-map (make-keymap))
1264 (suppress-keymap dired-mode-map)
1265 (define-key dired-mode-map "r" 'dired-rename-file)
1266 (define-key dired-mode-map "\C-d" 'dired-flag-file-deleted)
1267 (define-key dired-mode-map "d" 'dired-flag-file-deleted)
1268 (define-key dired-mode-map "v" 'dired-view-file)
1269 (define-key dired-mode-map "e" 'dired-find-file)
1270 (define-key dired-mode-map "f" 'dired-find-file)
1271 @dots{}
1272 @end group
1273 @end smallexample
1274 @end defun
1276 @node Remapping Commands
1277 @section Remapping Commands
1278 @cindex remapping commands
1280   A special kind of key binding, using a special ``key sequence''
1281 which includes a command name, has the effect of @dfn{remapping} that
1282 command into another.  Here's how it works.  You make a key binding
1283 for a key sequence that starts with the dummy event @code{remap},
1284 followed by the command name you want to remap.  Specify the remapped
1285 definition as the definition in this binding.  The remapped definition
1286 is usually a command name, but it can be any valid definition for
1287 a key binding.
1289   Here's an example.  Suppose that My mode uses special commands
1290 @code{my-kill-line} and @code{my-kill-word}, which should be invoked
1291 instead of @code{kill-line} and @code{kill-word}.  It can establish
1292 this by making these two command-remapping bindings in its keymap:
1294 @example
1295 (define-key my-mode-map [remap kill-line] 'my-kill-line)
1296 (define-key my-mode-map [remap kill-word] 'my-kill-word)
1297 @end example
1299 Whenever @code{my-mode-map} is an active keymap, if the user types
1300 @kbd{C-k}, Emacs will find the standard global binding of
1301 @code{kill-line} (assuming nobody has changed it).  But
1302 @code{my-mode-map} remaps @code{kill-line} to @code{my-mode-map},
1303 so instead of running @code{kill-line}, Emacs runs
1304 @code{my-kill-line}.
1306 Remapping only works through a single level.  In other words,
1308 @example
1309 (define-key my-mode-map [remap kill-line] 'my-kill-line)
1310 (define-key my-mode-map [remap my-kill-line] 'my-other-kill-line)
1311 @end example
1313 @noindent
1314 does not have the effect of remapping @code{kill-line} into
1315 @code{my-other-kill-line}.  If an ordinary key binding specifies 
1316 @code{kill-line}, this keymap will remap it to @code{my-kill-line};
1317 if an ordinary binding specifies @code{my-kill-line}, this keymap will
1318 remap it to @code{my-other-kill-line}.
1320 @defun command-remapping command
1321 This function returns the remapping for @var{command}, given the
1322 current active keymaps.  If @var{command} is not remapped (which is
1323 the usual situation), the function returns @code{nil}.
1324 @end defun
1326 @node Key Binding Commands
1327 @section Commands for Binding Keys
1329   This section describes some convenient interactive interfaces for
1330 changing key bindings.  They work by calling @code{define-key}.
1332   People often use @code{global-set-key} in their init files
1333 (@pxref{Init File}) for simple customization.  For example,
1335 @smallexample
1336 (global-set-key "\C-x\C-\\" 'next-line)
1337 @end smallexample
1339 @noindent
1342 @smallexample
1343 (global-set-key [?\C-x ?\C-\\] 'next-line)
1344 @end smallexample
1346 @noindent
1349 @smallexample
1350 (global-set-key [(control ?x) (control ?\\)] 'next-line)
1351 @end smallexample
1353 @noindent
1354 redefines @kbd{C-x C-\} to move down a line.
1356 @smallexample
1357 (global-set-key [M-mouse-1] 'mouse-set-point)
1358 @end smallexample
1360 @noindent
1361 redefines the first (leftmost) mouse button, typed with the Meta key, to
1362 set point where you click.
1364 @cindex non-@acronym{ASCII} text in keybindings
1365   Be careful when using non-@acronym{ASCII} text characters in Lisp
1366 specifications of keys to bind.  If these are read as multibyte text, as
1367 they usually will be in a Lisp file (@pxref{Loading Non-ASCII}), you
1368 must type the keys as multibyte too.  For instance, if you use this:
1370 @smallexample
1371 (global-set-key "@"o" 'my-function) ; bind o-umlaut
1372 @end smallexample
1374 @noindent
1377 @smallexample
1378 (global-set-key ?@"o 'my-function) ; bind o-umlaut
1379 @end smallexample
1381 @noindent
1382 and your language environment is multibyte Latin-1, these commands
1383 actually bind the multibyte character with code 2294, not the unibyte
1384 Latin-1 character with code 246 (@kbd{M-v}).  In order to use this
1385 binding, you need to enter the multibyte Latin-1 character as keyboard
1386 input.  One way to do this is by using an appropriate input method
1387 (@pxref{Input Methods, , Input Methods, emacs,The GNU Emacs Manual}).
1389   If you want to use a unibyte character in the key binding, you can
1390 construct the key sequence string using @code{multibyte-char-to-unibyte}
1391 or @code{string-make-unibyte} (@pxref{Converting Representations}).
1393 @deffn Command global-set-key key definition
1394 This function sets the binding of @var{key} in the current global map
1395 to @var{definition}.
1397 @smallexample
1398 @group
1399 (global-set-key @var{key} @var{definition})
1400 @equiv{}
1401 (define-key (current-global-map) @var{key} @var{definition})
1402 @end group
1403 @end smallexample
1404 @end deffn
1406 @deffn Command global-unset-key key
1407 @cindex unbinding keys
1408 This function removes the binding of @var{key} from the current
1409 global map.
1411 One use of this function is in preparation for defining a longer key
1412 that uses @var{key} as a prefix---which would not be allowed if
1413 @var{key} has a non-prefix binding.  For example:
1415 @smallexample
1416 @group
1417 (global-unset-key "\C-l")
1418     @result{} nil
1419 @end group
1420 @group
1421 (global-set-key "\C-l\C-l" 'redraw-display)
1422     @result{} nil
1423 @end group
1424 @end smallexample
1426 This function is implemented simply using @code{define-key}:
1428 @smallexample
1429 @group
1430 (global-unset-key @var{key})
1431 @equiv{}
1432 (define-key (current-global-map) @var{key} nil)
1433 @end group
1434 @end smallexample
1435 @end deffn
1437 @deffn Command local-set-key key definition
1438 This function sets the binding of @var{key} in the current local
1439 keymap to @var{definition}.
1441 @smallexample
1442 @group
1443 (local-set-key @var{key} @var{definition})
1444 @equiv{}
1445 (define-key (current-local-map) @var{key} @var{definition})
1446 @end group
1447 @end smallexample
1448 @end deffn
1450 @deffn Command local-unset-key key
1451 This function removes the binding of @var{key} from the current
1452 local map.
1454 @smallexample
1455 @group
1456 (local-unset-key @var{key})
1457 @equiv{}
1458 (define-key (current-local-map) @var{key} nil)
1459 @end group
1460 @end smallexample
1461 @end deffn
1463 @node Scanning Keymaps
1464 @section Scanning Keymaps
1466   This section describes functions used to scan all the current keymaps
1467 for the sake of printing help information.
1469 @defun accessible-keymaps keymap &optional prefix
1470 This function returns a list of all the keymaps that can be reached (via
1471 zero or more prefix keys) from @var{keymap}.  The value is an
1472 association list with elements of the form @code{(@var{key} .@:
1473 @var{map})}, where @var{key} is a prefix key whose definition in
1474 @var{keymap} is @var{map}.
1476 The elements of the alist are ordered so that the @var{key} increases
1477 in length.  The first element is always @code{("" .@: @var{keymap})},
1478 because the specified keymap is accessible from itself with a prefix of
1479 no events.
1481 If @var{prefix} is given, it should be a prefix key sequence; then
1482 @code{accessible-keymaps} includes only the submaps whose prefixes start
1483 with @var{prefix}.  These elements look just as they do in the value of
1484 @code{(accessible-keymaps)}; the only difference is that some elements
1485 are omitted.
1487 In the example below, the returned alist indicates that the key
1488 @key{ESC}, which is displayed as @samp{^[}, is a prefix key whose
1489 definition is the sparse keymap @code{(keymap (83 .@: center-paragraph)
1490 (115 .@: foo))}.
1492 @smallexample
1493 @group
1494 (accessible-keymaps (current-local-map))
1495 @result{}(("" keymap
1496       (27 keymap   ; @r{Note this keymap for @key{ESC} is repeated below.}
1497           (83 . center-paragraph)
1498           (115 . center-line))
1499       (9 . tab-to-tab-stop))
1500 @end group
1502 @group
1503    ("^[" keymap
1504     (83 . center-paragraph)
1505     (115 . foo)))
1506 @end group
1507 @end smallexample
1509 In the following example, @kbd{C-h} is a prefix key that uses a sparse
1510 keymap starting with @code{(keymap (118 . describe-variable)@dots{})}.
1511 Another prefix, @kbd{C-x 4}, uses a keymap which is also the value of
1512 the variable @code{ctl-x-4-map}.  The event @code{mode-line} is one of
1513 several dummy events used as prefixes for mouse actions in special parts
1514 of a window.
1516 @smallexample
1517 @group
1518 (accessible-keymaps (current-global-map))
1519 @result{} (("" keymap [set-mark-command beginning-of-line @dots{}
1520                    delete-backward-char])
1521 @end group
1522 @group
1523     ("^H" keymap (118 . describe-variable) @dots{}
1524      (8 . help-for-help))
1525 @end group
1526 @group
1527     ("^X" keymap [x-flush-mouse-queue @dots{}
1528      backward-kill-sentence])
1529 @end group
1530 @group
1531     ("^[" keymap [mark-sexp backward-sexp @dots{}
1532      backward-kill-word])
1533 @end group
1534     ("^X4" keymap (15 . display-buffer) @dots{})
1535 @group
1536     ([mode-line] keymap
1537      (S-mouse-2 . mouse-split-window-horizontally) @dots{}))
1538 @end group
1539 @end smallexample
1541 @noindent
1542 These are not all the keymaps you would see in actuality.
1543 @end defun
1545 @defun map-keymap function keymap
1546 The function @code{map-keymap} calls @var{function} once
1547 for each binding in @var{keymap}.  It passes two arguments,
1548 the event type and the value of the binding.  If @var{keymap}
1549 has a parent, the parent's bindings are included as well.
1551 This function is the cleanest way to examine all the bindings
1552 in a keymap.
1553 @end defun
1555 @defun where-is-internal command &optional keymap firstonly noindirect no-remap
1556 This function is a subroutine used by the @code{where-is} command
1557 (@pxref{Help, , Help, emacs,The GNU Emacs Manual}).  It returns a list
1558 of key sequences (of any length) that are bound to @var{command} in a
1559 set of keymaps.
1561 The argument @var{command} can be any object; it is compared with all
1562 keymap entries using @code{eq}.
1564 If @var{keymap} is @code{nil}, then the maps used are the current active
1565 keymaps, disregarding @code{overriding-local-map} (that is, pretending
1566 its value is @code{nil}).  If @var{keymap} is non-@code{nil}, then the
1567 maps searched are @var{keymap} and the global keymap.  If @var{keymap}
1568 is a list of keymaps, only those keymaps are searched.
1570 Usually it's best to use @code{overriding-local-map} as the expression
1571 for @var{keymap}.  Then @code{where-is-internal} searches precisely the
1572 keymaps that are active.  To search only the global map, pass
1573 @code{(keymap)} (an empty keymap) as @var{keymap}.
1575 If @var{firstonly} is @code{non-ascii}, then the value is a single
1576 string representing the first key sequence found, rather than a list of
1577 all possible key sequences.  If @var{firstonly} is @code{t}, then the
1578 value is the first key sequence, except that key sequences consisting
1579 entirely of @acronym{ASCII} characters (or meta variants of @acronym{ASCII}
1580 characters) are preferred to all other key sequences.
1582 If @var{noindirect} is non-@code{nil}, @code{where-is-internal} doesn't
1583 follow indirect keymap bindings.  This makes it possible to search for
1584 an indirect definition itself.
1586 When command remapping is in effect (@pxref{Remapping Commands}),
1587 @code{where-is-internal} figures out when a command will be run due to
1588 remapping and reports keys accordingly.  It also returns @code{nil} if
1589 @var{command} won't really be run because it has been remapped to some
1590 other command.  However, if @var{no-remap} is non-@code{nil}.
1591 @code{where-is-internal} ignores remappings.
1593 @smallexample
1594 @group
1595 (where-is-internal 'describe-function)
1596     @result{} ("\^hf" "\^hd")
1597 @end group
1598 @end smallexample
1599 @end defun
1601 @deffn Command describe-bindings &optional prefix
1602 This function creates a listing of all current key bindings, and
1603 displays it in a buffer named @samp{*Help*}.  The text is grouped by
1604 modes---minor modes first, then the major mode, then global bindings.
1606 If @var{prefix} is non-@code{nil}, it should be a prefix key; then the
1607 listing includes only keys that start with @var{prefix}.
1609 The listing describes meta characters as @key{ESC} followed by the
1610 corresponding non-meta character.
1612 When several characters with consecutive @acronym{ASCII} codes have the
1613 same definition, they are shown together, as
1614 @samp{@var{firstchar}..@var{lastchar}}.  In this instance, you need to
1615 know the @acronym{ASCII} codes to understand which characters this means.
1616 For example, in the default global map, the characters @samp{@key{SPC}
1617 ..@: ~} are described by a single line.  @key{SPC} is @acronym{ASCII} 32,
1618 @kbd{~} is @acronym{ASCII} 126, and the characters between them include all
1619 the normal printing characters, (e.g., letters, digits, punctuation,
1620 etc.@:); all these characters are bound to @code{self-insert-command}.
1621 @end deffn
1623 @node Menu Keymaps
1624 @section Menu Keymaps
1625 @cindex menu keymaps
1627 @c Emacs 19 feature
1628 A keymap can define a menu as well as bindings for keyboard keys and
1629 mouse button.  Menus are usually actuated with the mouse, but they can
1630 work with the keyboard also.
1632 @menu
1633 * Defining Menus::              How to make a keymap that defines a menu.
1634 * Mouse Menus::                 How users actuate the menu with the mouse.
1635 * Keyboard Menus::              How they actuate it with the keyboard.
1636 * Menu Example::                Making a simple menu.
1637 * Menu Bar::                    How to customize the menu bar.
1638 * Tool Bar::                    A tool bar is a row of images.
1639 * Modifying Menus::             How to add new items to a menu.
1640 @end menu
1642 @node Defining Menus
1643 @subsection Defining Menus
1644 @cindex defining menus
1645 @cindex menu prompt string
1646 @cindex prompt string (of menu)
1648 A keymap is suitable for menu use if it has an @dfn{overall prompt
1649 string}, which is a string that appears as an element of the keymap.
1650 (@xref{Format of Keymaps}.)  The string should describe the purpose of
1651 the menu's commands.  Emacs displays the overall prompt string as the
1652 menu title in some cases, depending on the toolkit (if any) used for
1653 displaying menus.@footnote{It is required for menus which do not use a
1654 toolkit, e.g.@: under MS-DOS.}  Keyboard menus also display the overall
1655 prompt string.
1657 The easiest way to construct a keymap with a prompt string is to specify
1658 the string as an argument when you call @code{make-keymap},
1659 @code{make-sparse-keymap} or @code{define-prefix-command}
1660 (@pxref{Creating Keymaps}).
1662 @defun keymap-prompt keymap
1663 This function returns the overall prompt string of @var{keymap},
1664 or @code{nil} if it has none.
1665 @end defun
1667 The order of items in the menu is the same as the order of bindings in
1668 the keymap.  Since @code{define-key} puts new bindings at the front, you
1669 should define the menu items starting at the bottom of the menu and
1670 moving to the top, if you care about the order.  When you add an item to
1671 an existing menu, you can specify its position in the menu using
1672 @code{define-key-after} (@pxref{Modifying Menus}).
1674 @menu
1675 * Simple Menu Items::       A simple kind of menu key binding,
1676                               limited in capabilities.
1677 * Extended Menu Items::     More powerful menu item definitions
1678                               let you specify keywords to enable
1679                               various features.
1680 * Menu Separators::         Drawing a horizontal line through a menu.
1681 * Alias Menu Items::        Using command aliases in menu items.
1682 @end menu
1684 @node Simple Menu Items
1685 @subsubsection Simple Menu Items
1687   The simpler and older way to define a menu keymap binding
1688 looks like this:
1690 @example
1691 (@var{item-string} . @var{real-binding})
1692 @end example
1694 @noindent
1695 The @sc{car}, @var{item-string}, is the string to be displayed in the
1696 menu.  It should be short---preferably one to three words.  It should
1697 describe the action of the command it corresponds to.  Note that it is
1698 not generally possible to display non-@acronym{ASCII} text in menus.  It will
1699 work for keyboard menus and will work to a large extent when Emacs is
1700 built with Gtk+ support.@footnote{In this case, the text is first
1701 encoded using the @code{utf-8} coding system and then rendered by the
1702 toolkit as it sees fit.}
1704 You can also supply a second string, called the help string, as follows:
1706 @example
1707 (@var{item-string} @var{help} . @var{real-binding})
1708 @end example
1710 @var{help} specifies a ``help-echo'' string to display while the mouse
1711 is on that item in the same way as @code{help-echo} text properties
1712 (@pxref{Help display}).
1714 As far as @code{define-key} is concerned, @var{item-string} and
1715 @var{help-string} are part of the event's binding.  However,
1716 @code{lookup-key} returns just @var{real-binding}, and only
1717 @var{real-binding} is used for executing the key.
1719 If @var{real-binding} is @code{nil}, then @var{item-string} appears in
1720 the menu but cannot be selected.
1722 If @var{real-binding} is a symbol and has a non-@code{nil}
1723 @code{menu-enable} property, that property is an expression that
1724 controls whether the menu item is enabled.  Every time the keymap is
1725 used to display a menu, Emacs evaluates the expression, and it enables
1726 the menu item only if the expression's value is non-@code{nil}.  When a
1727 menu item is disabled, it is displayed in a ``fuzzy'' fashion, and
1728 cannot be selected.
1730 The menu bar does not recalculate which items are enabled every time you
1731 look at a menu.  This is because the X toolkit requires the whole tree
1732 of menus in advance.  To force recalculation of the menu bar, call
1733 @code{force-mode-line-update} (@pxref{Mode Line Format}).
1735 You've probably noticed that menu items show the equivalent keyboard key
1736 sequence (if any) to invoke the same command.  To save time on
1737 recalculation, menu display caches this information in a sublist in the
1738 binding, like this:
1740 @c This line is not too long--rms.
1741 @example
1742 (@var{item-string} @r{[}@var{help-string}@r{]} (@var{key-binding-data}) . @var{real-binding})
1743 @end example
1745 @noindent
1746 Don't put these sublists in the menu item yourself; menu display
1747 calculates them automatically.  Don't mention keyboard equivalents in
1748 the item strings themselves, since that is redundant.
1750 @node Extended Menu Items
1751 @subsubsection Extended Menu Items
1752 @kindex menu-item
1754   An extended-format menu item is a more flexible and also cleaner
1755 alternative to the simple format.  It consists of a list that starts
1756 with the symbol @code{menu-item}.  To define a non-selectable string,
1757 the item looks like this:
1759 @example
1760 (menu-item @var{item-name})
1761 @end example
1763 @noindent
1764 A string starting with two or more dashes specifies a separator line;
1765 see @ref{Menu Separators}.
1767   To define a real menu item which can be selected, the extended format
1768 item looks like this:
1770 @example
1771 (menu-item @var{item-name} @var{real-binding}
1772     . @var{item-property-list})
1773 @end example
1775 @noindent
1776 Here, @var{item-name} is an expression which evaluates to the menu item
1777 string.  Thus, the string need not be a constant.  The third element,
1778 @var{real-binding}, is the command to execute.  The tail of the list,
1779 @var{item-property-list}, has the form of a property list which contains
1780 other information.  Here is a table of the properties that are supported:
1782 @table @code
1783 @item :enable @var{form}
1784 The result of evaluating @var{form} determines whether the item is
1785 enabled (non-@code{nil} means yes).  If the item is not enabled,
1786 you can't really click on it.
1788 @item :visible @var{form}
1789 The result of evaluating @var{form} determines whether the item should
1790 actually appear in the menu (non-@code{nil} means yes).  If the item
1791 does not appear, then the menu is displayed as if this item were
1792 not defined at all.
1794 @item :help @var{help}
1795 The value of this property, @var{help}, specifies a ``help-echo'' string
1796 to display while the mouse is on that item.  This is displayed in the
1797 same way as @code{help-echo} text properties (@pxref{Help display}).
1798 Note that this must be a constant string, unlike the @code{help-echo}
1799 property for text and overlays.
1801 @item :button (@var{type} . @var{selected})
1802 This property provides a way to define radio buttons and toggle buttons.
1803 The @sc{car}, @var{type}, says which: it should be @code{:toggle} or
1804 @code{:radio}.  The @sc{cdr}, @var{selected}, should be a form; the
1805 result of evaluating it says whether this button is currently selected.
1807 A @dfn{toggle} is a menu item which is labeled as either ``on'' or ``off''
1808 according to the value of @var{selected}.  The command itself should
1809 toggle @var{selected}, setting it to @code{t} if it is @code{nil},
1810 and to @code{nil} if it is @code{t}.  Here is how the menu item
1811 to toggle the @code{debug-on-error} flag is defined:
1813 @example
1814 (menu-item "Debug on Error" toggle-debug-on-error
1815            :button (:toggle
1816                     . (and (boundp 'debug-on-error)
1817                            debug-on-error)))
1818 @end example
1820 @noindent
1821 This works because @code{toggle-debug-on-error} is defined as a command
1822 which toggles the variable @code{debug-on-error}.
1824 @dfn{Radio buttons} are a group of menu items, in which at any time one
1825 and only one is ``selected.''  There should be a variable whose value
1826 says which one is selected at any time.  The @var{selected} form for
1827 each radio button in the group should check whether the variable has the
1828 right value for selecting that button.  Clicking on the button should
1829 set the variable so that the button you clicked on becomes selected.
1831 @item :key-sequence @var{key-sequence}
1832 This property specifies which key sequence is likely to be bound to the
1833 same command invoked by this menu item.  If you specify the right key
1834 sequence, that makes preparing the menu for display run much faster.
1836 If you specify the wrong key sequence, it has no effect; before Emacs
1837 displays @var{key-sequence} in the menu, it verifies that
1838 @var{key-sequence} is really equivalent to this menu item.
1840 @item :key-sequence nil
1841 This property indicates that there is normally no key binding which is
1842 equivalent to this menu item.  Using this property saves time in
1843 preparing the menu for display, because Emacs does not need to search
1844 the keymaps for a keyboard equivalent for this menu item.
1846 However, if the user has rebound this item's definition to a key
1847 sequence, Emacs ignores the @code{:keys} property and finds the keyboard
1848 equivalent anyway.
1850 @item :keys @var{string}
1851 This property specifies that @var{string} is the string to display
1852 as the keyboard equivalent for this menu item.  You can use
1853 the @samp{\\[...]} documentation construct in @var{string}.
1855 @item :filter @var{filter-fn}
1856 This property provides a way to compute the menu item dynamically.
1857 The property value @var{filter-fn} should be a function of one argument;
1858 when it is called, its argument will be @var{real-binding}.  The
1859 function should return the binding to use instead.
1860 @end table
1862 @node Menu Separators
1863 @subsubsection Menu Separators
1864 @cindex menu separators
1866   A menu separator is a kind of menu item that doesn't display any
1867 text--instead, it divides the menu into subparts with a horizontal line.
1868 A separator looks like this in the menu keymap:
1870 @example
1871 (menu-item @var{separator-type})
1872 @end example
1874 @noindent
1875 where @var{separator-type} is a string starting with two or more dashes.
1877   In the simplest case, @var{separator-type} consists of only dashes.
1878 That specifies the default kind of separator.  (For compatibility,
1879 @code{""} and @code{-} also count as separators.)
1881   Starting in Emacs 21, certain other values of @var{separator-type}
1882 specify a different style of separator.  Here is a table of them:
1884 @table @code
1885 @item "--no-line"
1886 @itemx "--space"
1887 An extra vertical space, with no actual line.
1889 @item "--single-line"
1890 A single line in the menu's foreground color.
1892 @item "--double-line"
1893 A double line in the menu's foreground color.
1895 @item "--single-dashed-line"
1896 A single dashed line in the menu's foreground color.
1898 @item "--double-dashed-line"
1899 A double dashed line in the menu's foreground color.
1901 @item "--shadow-etched-in"
1902 A single line with a 3D sunken appearance.  This is the default,
1903 used separators consisting of dashes only.
1905 @item "--shadow-etched-out"
1906 A single line with a 3D raised appearance.
1908 @item "--shadow-etched-in-dash"
1909 A single dashed line with a 3D sunken appearance.
1911 @item "--shadow-etched-out-dash"
1912 A single dashed line with a 3D raised appearance.
1914 @item "--shadow-double-etched-in"
1915 Two lines with a 3D sunken appearance.
1917 @item "--shadow-double-etched-out"
1918 Two lines with a 3D raised appearance.
1920 @item "--shadow-double-etched-in-dash"
1921 Two dashed lines with a 3D sunken appearance.
1923 @item "--shadow-double-etched-out-dash"
1924 Two dashed lines with a 3D raised appearance.
1925 @end table
1927   You can also give these names in another style, adding a colon after
1928 the double-dash and replacing each single dash with capitalization of
1929 the following word.  Thus, @code{"--:singleLine"}, is equivalent to
1930 @code{"--single-line"}.
1932   Some systems and display toolkits don't really handle all of these
1933 separator types.  If you use a type that isn't supported, the menu
1934 displays a similar kind of separator that is supported.
1936 @node Alias Menu Items
1937 @subsubsection Alias Menu Items
1939   Sometimes it is useful to make menu items that use the ``same''
1940 command but with different enable conditions.  The best way to do this
1941 in Emacs now is with extended menu items; before that feature existed,
1942 it could be done by defining alias commands and using them in menu
1943 items.  Here's an example that makes two aliases for
1944 @code{toggle-read-only} and gives them different enable conditions:
1946 @example
1947 (defalias 'make-read-only 'toggle-read-only)
1948 (put 'make-read-only 'menu-enable '(not buffer-read-only))
1949 (defalias 'make-writable 'toggle-read-only)
1950 (put 'make-writable 'menu-enable 'buffer-read-only)
1951 @end example
1953 When using aliases in menus, often it is useful to display the
1954 equivalent key bindings for the ``real'' command name, not the aliases
1955 (which typically don't have any key bindings except for the menu
1956 itself).  To request this, give the alias symbol a non-@code{nil}
1957 @code{menu-alias} property.  Thus,
1959 @example
1960 (put 'make-read-only 'menu-alias t)
1961 (put 'make-writable 'menu-alias t)
1962 @end example
1964 @noindent
1965 causes menu items for @code{make-read-only} and @code{make-writable} to
1966 show the keyboard bindings for @code{toggle-read-only}.
1968 @node Mouse Menus
1969 @subsection Menus and the Mouse
1971   The usual way to make a menu keymap produce a menu is to make it the
1972 definition of a prefix key.  (A Lisp program can explicitly pop up a
1973 menu and receive the user's choice---see @ref{Pop-Up Menus}.)
1975   If the prefix key ends with a mouse event, Emacs handles the menu keymap
1976 by popping up a visible menu, so that the user can select a choice with
1977 the mouse.  When the user clicks on a menu item, the event generated is
1978 whatever character or symbol has the binding that brought about that
1979 menu item.  (A menu item may generate a series of events if the menu has
1980 multiple levels or comes from the menu bar.)
1982   It's often best to use a button-down event to trigger the menu.  Then
1983 the user can select a menu item by releasing the button.
1985   A single keymap can appear as multiple menu panes, if you explicitly
1986 arrange for this.  The way to do this is to make a keymap for each pane,
1987 then create a binding for each of those maps in the main keymap of the
1988 menu.  Give each of these bindings an item string that starts with
1989 @samp{@@}.  The rest of the item string becomes the name of the pane.
1990 See the file @file{lisp/mouse.el} for an example of this.  Any ordinary
1991 bindings with @samp{@@}-less item strings are grouped into one pane,
1992 which appears along with the other panes explicitly created for the
1993 submaps.
1995   X toolkit menus don't have panes; instead, they can have submenus.
1996 Every nested keymap becomes a submenu, whether the item string starts
1997 with @samp{@@} or not.  In a toolkit version of Emacs, the only thing
1998 special about @samp{@@} at the beginning of an item string is that the
1999 @samp{@@} doesn't appear in the menu item.
2001   You can also produce multiple panes or submenus from separate keymaps.
2002 The full definition of a prefix key always comes from merging the
2003 definitions supplied by the various active keymaps (minor mode, local,
2004 and global).  When more than one of these keymaps is a menu, each of
2005 them makes a separate pane or panes (when Emacs does not use an
2006 X-toolkit) or a separate submenu (when using an X-toolkit).
2007 @xref{Active Keymaps}.
2009 @node Keyboard Menus
2010 @subsection Menus and the Keyboard
2012 When a prefix key ending with a keyboard event (a character or function
2013 key) has a definition that is a menu keymap, the user can use the
2014 keyboard to choose a menu item.
2016 Emacs displays the menu's overall prompt string followed by the
2017 alternatives (the item strings of the bindings) in the echo area.  If
2018 the bindings don't all fit at once, the user can type @key{SPC} to see
2019 the next line of alternatives.  Successive uses of @key{SPC} eventually
2020 get to the end of the menu and then cycle around to the beginning.  (The
2021 variable @code{menu-prompt-more-char} specifies which character is used
2022 for this; @key{SPC} is the default.)
2024 When the user has found the desired alternative from the menu, he or she
2025 should type the corresponding character---the one whose binding is that
2026 alternative.
2028 @ignore
2029 In a menu intended for keyboard use, each menu item must clearly
2030 indicate what character to type.  The best convention to use is to make
2031 the character the first letter of the item string---that is something
2032 users will understand without being told.  We plan to change this; by
2033 the time you read this manual, keyboard menus may explicitly name the
2034 key for each alternative.
2035 @end ignore
2037 This way of using menus in an Emacs-like editor was inspired by the
2038 Hierarkey system.
2040 @defvar menu-prompt-more-char
2041 This variable specifies the character to use to ask to see
2042 the next line of a menu.  Its initial value is 32, the code
2043 for @key{SPC}.
2044 @end defvar
2046 @node Menu Example
2047 @subsection Menu Example
2048 @cindex menu definition example
2050   Here is a complete example of defining a menu keymap.  It is the
2051 definition of the @samp{Print} submenu in the @samp{Tools} menu in the
2052 menu bar, and it uses the simple menu item format (@pxref{Simple Menu
2053 Items}).  First we create the keymap, and give it a name:
2055 @example
2056 (defvar menu-bar-print-menu (make-sparse-keymap "Print"))
2057 @end example
2059 @noindent
2060 Next we define the menu items:
2062 @example
2063 (define-key menu-bar-print-menu [ps-print-region]
2064   '("Postscript Print Region" . ps-print-region-with-faces))
2065 (define-key menu-bar-print-menu [ps-print-buffer]
2066   '("Postscript Print Buffer" . ps-print-buffer-with-faces))
2067 (define-key menu-bar-print-menu [separator-ps-print]
2068   '("--"))
2069 (define-key menu-bar-print-menu [print-region]
2070   '("Print Region" . print-region))
2071 (define-key menu-bar-print-menu [print-buffer]
2072   '("Print Buffer" . print-buffer))
2073 @end example
2075 @noindent
2076 Note the symbols which the bindings are ``made for''; these appear
2077 inside square brackets, in the key sequence being defined.  In some
2078 cases, this symbol is the same as the command name; sometimes it is
2079 different.  These symbols are treated as ``function keys'', but they are
2080 not real function keys on the keyboard.  They do not affect the
2081 functioning of the menu itself, but they are ``echoed'' in the echo area
2082 when the user selects from the menu, and they appear in the output of
2083 @code{where-is} and @code{apropos}.
2085   The binding whose definition is @code{("--")} is a separator line.
2086 Like a real menu item, the separator has a key symbol, in this case
2087 @code{separator-ps-print}.  If one menu has two separators, they must
2088 have two different key symbols.
2090   Here is code to define enable conditions for two of the commands in
2091 the menu:
2093 @example
2094 (put 'print-region 'menu-enable 'mark-active)
2095 (put 'ps-print-region-with-faces 'menu-enable 'mark-active)
2096 @end example
2098   Here is how we make this menu appear as an item in the parent menu:
2100 @example
2101 (define-key menu-bar-tools-menu [print]
2102   (cons "Print" menu-bar-print-menu))
2103 @end example
2105 @noindent
2106 Note that this incorporates the submenu keymap, which is the value of
2107 the variable @code{menu-bar-print-menu}, rather than the symbol
2108 @code{menu-bar-print-menu} itself.  Using that symbol in the parent menu
2109 item would be meaningless because @code{menu-bar-print-menu} is not a
2110 command.
2112   If you wanted to attach the same print menu to a mouse click, you
2113 can do it this way:
2115 @example
2116 (define-key global-map [C-S-down-mouse-1]
2117    menu-bar-print-menu)
2118 @end example
2120   We could equally well use an extended menu item (@pxref{Extended Menu
2121 Items}) for @code{print-region}, like this:
2123 @example
2124 (define-key menu-bar-print-menu [print-region]
2125   '(menu-item "Print Region" print-region
2126               :enable mark-active))
2127 @end example
2129 @noindent
2130 With the extended menu item, the enable condition is specified
2131 inside the menu item itself.  If we wanted to make this
2132 item disappear from the menu entirely when the mark is inactive,
2133 we could do it this way:
2135 @example
2136 (define-key menu-bar-print-menu [print-region]
2137   '(menu-item "Print Region" print-region
2138               :visible mark-active))
2139 @end example
2141 @node Menu Bar
2142 @subsection The Menu Bar
2143 @cindex menu bar
2145   Most window systems allow each frame to have a @dfn{menu bar}---a
2146 permanently displayed menu stretching horizontally across the top of the
2147 frame.  The items of the menu bar are the subcommands of the fake
2148 ``function key'' @code{menu-bar}, as defined by all the active keymaps.
2150   To add an item to the menu bar, invent a fake ``function key'' of your
2151 own (let's call it @var{key}), and make a binding for the key sequence
2152 @code{[menu-bar @var{key}]}.  Most often, the binding is a menu keymap,
2153 so that pressing a button on the menu bar item leads to another menu.
2155   When more than one active keymap defines the same fake function key
2156 for the menu bar, the item appears just once.  If the user clicks on
2157 that menu bar item, it brings up a single, combined menu containing
2158 all the subcommands of that item---the global subcommands, the local
2159 subcommands, and the minor mode subcommands.
2161   The variable @code{overriding-local-map} is normally ignored when
2162 determining the menu bar contents.  That is, the menu bar is computed
2163 from the keymaps that would be active if @code{overriding-local-map}
2164 were @code{nil}.  @xref{Active Keymaps}.
2166   In order for a frame to display a menu bar, its @code{menu-bar-lines}
2167 parameter must be greater than zero.  Emacs uses just one line for the
2168 menu bar itself; if you specify more than one line, the other lines
2169 serve to separate the menu bar from the windows in the frame.  We
2170 recommend 1 or 2 as the value of @code{menu-bar-lines}.  @xref{Window Frame
2171 Parameters}.
2173   Here's an example of setting up a menu bar item:
2175 @example
2176 @group
2177 (modify-frame-parameters (selected-frame)
2178                          '((menu-bar-lines . 2)))
2179 @end group
2181 @group
2182 ;; @r{Make a menu keymap (with a prompt string)}
2183 ;; @r{and make it the menu bar item's definition.}
2184 (define-key global-map [menu-bar words]
2185   (cons "Words" (make-sparse-keymap "Words")))
2186 @end group
2188 @group
2189 ;; @r{Define specific subcommands in this menu.}
2190 (define-key global-map
2191   [menu-bar words forward]
2192   '("Forward word" . forward-word))
2193 @end group
2194 @group
2195 (define-key global-map
2196   [menu-bar words backward]
2197   '("Backward word" . backward-word))
2198 @end group
2199 @end example
2201   A local keymap can cancel a menu bar item made by the global keymap by
2202 rebinding the same fake function key with @code{undefined} as the
2203 binding.  For example, this is how Dired suppresses the @samp{Edit} menu
2204 bar item:
2206 @example
2207 (define-key dired-mode-map [menu-bar edit] 'undefined)
2208 @end example
2210 @noindent
2211 @code{edit} is the fake function key used by the global map for the
2212 @samp{Edit} menu bar item.  The main reason to suppress a global
2213 menu bar item is to regain space for mode-specific items.
2215 @defvar menu-bar-final-items
2216 Normally the menu bar shows global items followed by items defined by the
2217 local maps.
2219 This variable holds a list of fake function keys for items to display at
2220 the end of the menu bar rather than in normal sequence.  The default
2221 value is @code{(help-menu)}; thus, the @samp{Help} menu item normally appears
2222 at the end of the menu bar, following local menu items.
2223 @end defvar
2225 @defvar menu-bar-update-hook
2226 This normal hook is run whenever the user clicks on the menu bar, before
2227 displaying a submenu.  You can use it to update submenus whose contents
2228 should vary.
2229 @end defvar
2231 @node Tool Bar
2232 @subsection Tool bars
2233 @cindex tool bar
2235   A @dfn{tool bar} is a row of icons at the top of a frame, that execute
2236 commands when you click on them---in effect, a kind of graphical menu
2237 bar.  Emacs supports tool bars starting with version 21.
2239   The frame parameter @code{tool-bar-lines} (X resource @samp{toolBar})
2240 controls how many lines' worth of height to reserve for the tool bar.  A
2241 zero value suppresses the tool bar.  If the value is nonzero, and
2242 @code{auto-resize-tool-bars} is non-@code{nil}, the tool bar expands and
2243 contracts automatically as needed to hold the specified contents.
2245   The tool bar contents are controlled by a menu keymap attached to a
2246 fake ``function key'' called @code{tool-bar} (much like the way the menu
2247 bar is controlled).  So you define a tool bar item using
2248 @code{define-key}, like this:
2250 @example
2251 (define-key global-map [tool-bar @var{key}] @var{item})
2252 @end example
2254 @noindent
2255 where @var{key} is a fake ``function key'' to distinguish this item from
2256 other items, and @var{item} is a menu item key binding (@pxref{Extended
2257 Menu Items}), which says how to display this item and how it behaves.
2259   The usual menu keymap item properties, @code{:visible},
2260 @code{:enable}, @code{:button}, and @code{:filter}, are useful in
2261 tool bar bindings and have their normal meanings.  The @var{real-binding}
2262 in the item must be a command, not a keymap; in other words, it does not
2263 work to define a tool bar icon as a prefix key.
2265   The @code{:help} property specifies a ``help-echo'' string to display
2266 while the mouse is on that item.  This is displayed in the same way as
2267 @code{help-echo} text properties (@pxref{Help display}).
2269   In addition, you should use the @code{:image} property;
2270 this is how you specify the image to display in the tool bar:
2272 @table @code
2273 @item :image @var{image}
2274 @var{images} is either a single image specification or a vector of four
2275 image specifications.  If you use a vector of four,
2276 one of them is used, depending on circumstances:
2278 @table @asis
2279 @item item 0
2280 Used when the item is enabled and selected.
2281 @item item 1
2282 Used when the item is enabled and deselected.
2283 @item item 2
2284 Used when the item is disabled and selected.
2285 @item item 3
2286 Used when the item is disabled and deselected.
2287 @end table
2288 @end table
2290 If @var{image} is a single image specification, Emacs draws the tool bar
2291 button in disabled state by applying an edge-detection algorithm to the
2292 image.
2294 The default tool bar is defined so that items specific to editing do not
2295 appear for major modes whose command symbol has a @code{mode-class}
2296 property of @code{special} (@pxref{Major Mode Conventions}).  Major
2297 modes may add items to the global bar by binding @code{[tool-bar
2298 @var{foo}]} in their local map.  It makes sense for some major modes to
2299 replace the default tool bar items completely, since not many can be
2300 accommodated conveniently, and the default bindings make this easy by
2301 using an indirection through @code{tool-bar-map}.
2303 @defvar tool-bar-map
2304 @tindex tool-bar-map
2305 By default, the global map binds @code{[tool-bar]} as follows:
2306 @example
2307 (global-set-key [tool-bar]
2308                 '(menu-item "tool bar" ignore
2309                             :filter (lambda (ignore) tool-bar-map)))
2310 @end example
2311 @noindent
2312 Thus the tool bar map is derived dynamically from the value of variable
2313 @code{tool-bar-map} and you should normally adjust the default (global)
2314 tool bar by changing that map.  Major modes may replace the global bar
2315 completely by making @code{tool-bar-map} buffer-local and set to a
2316 keymap containing only the desired items.  Info mode provides an
2317 example.
2318 @end defvar
2320 There are two convenience functions for defining tool bar items, as
2321 follows.
2323 @defun tool-bar-add-item icon def key &rest props
2324 @tindex tool-bar-add-item
2325 This function adds an item to the tool bar by modifying
2326 @code{tool-bar-map}.  The image to use is defined by @var{icon}, which
2327 is the base name of an XPM, XBM or PBM image file to located by
2328 @code{find-image}.  Given a value @samp{"exit"}, say, @file{exit.xpm},
2329 @file{exit.pbm} and @file{exit.xbm} would be searched for in that order
2330 on a color display.  On a monochrome display, the search order is
2331 @samp{.pbm}, @samp{.xbm} and @samp{.xpm}.  The binding to use is the
2332 command @var{def}, and @var{key} is the fake function key symbol in the
2333 prefix keymap.  The remaining arguments @var{props} are additional
2334 property list elements to add to the menu item specification.
2336 To define items in some local map, bind @code{`tool-bar-map} with
2337 @code{let} around calls of this function:
2338 @example
2339 (defvar foo-tool-bar-map
2340   (let ((tool-bar-map (make-sparse-keymap)))
2341     (tool-bar-add-item @dots{})
2342     @dots{}
2343     tool-bar-map))
2344 @end example
2345 @end defun
2347 @defun tool-bar-add-item-from-menu command icon &optional map &rest props
2348 @tindex tool-bar-add-item-from-menu
2349 This function is a convenience for defining tool bar items which are
2350 consistent with existing menu bar bindings.  The binding of
2351 @var{command} is looked up in the menu bar in @var{map} (default
2352 @code{global-map}) and modified to add an image specification for
2353 @var{icon}, which is found in the same way as by
2354 @code{tool-bar-add-item}.  The resulting binding is then placed in
2355 @code{tool-bar-map}, so use this function only for global tool bar
2356 items.
2358 @var{map} must contain an appropriate keymap bound to
2359 @code{[menu-bar]}.  The remaining arguments @var{props} are additional
2360 property list elements to add to the menu item specification.
2361 @end defun
2363 @defun tool-bar-local-item-from-menu command icon in-map &optional from-map &rest props
2364 This function is used for making non-global tool bar items.  Use it
2365 like @code{tool-bar-add-item-from-menu} except that @var{in-map}
2366 specifies the local map to make the definition in.  The argument
2367 @var{from-map} si like the @var{map} argument of
2368 @code{tool-bar-add-item-from-menu}.
2369 @end defun
2371 @tindex auto-resize-tool-bar
2372 @defvar auto-resize-tool-bar
2373 If this variable is non-@code{nil}, the tool bar automatically resizes to
2374 show all defined tool bar items---but not larger than a quarter of the
2375 frame's height.
2376 @end defvar
2378 @tindex auto-raise-tool-bar-items
2379 @defvar auto-raise-tool-bar-items
2380 If this variable is non-@code{nil}, tool bar items display
2381 in raised form when the mouse moves over them.
2382 @end defvar
2384 @tindex tool-bar-item-margin
2385 @defvar tool-bar-item-margin
2386 This variable specifies an extra margin to add around tool bar items.
2387 The value is an integer, a number of pixels.  The default is 1.
2388 @end defvar
2390 @tindex tool-bar-item-relief
2391 @defvar tool-bar-item-relief
2392 This variable specifies the shadow width for tool bar items.
2393 The value is an integer, a number of pixels.  The default is 3.
2394 @end defvar
2396   You can define a special meaning for clicking on a tool bar item with
2397 the shift, control, meta, etc., modifiers.  You do this by setting up
2398 additional items that relate to the original item through the fake
2399 function keys.  Specifically, the additional items should use the
2400 modified versions of the same fake function key used to name the
2401 original item.
2403   Thus, if the original item was defined this way,
2405 @example
2406 (define-key global-map [tool-bar shell]
2407   '(menu-item "Shell" shell
2408               :image (image :type xpm :file "shell.xpm")))
2409 @end example
2411 @noindent
2412 then here is how you can define clicking on the same tool bar image with
2413 the shift modifier:
2415 @example
2416 (define-key global-map [tool-bar S-shell] 'some-command)
2417 @end example
2419 @xref{Function Keys}, for more information about how to add modifiers to
2420 function keys.
2422 @node Modifying Menus
2423 @subsection Modifying Menus
2425   When you insert a new item in an existing menu, you probably want to
2426 put it in a particular place among the menu's existing items.  If you
2427 use @code{define-key} to add the item, it normally goes at the front of
2428 the menu.  To put it elsewhere in the menu, use @code{define-key-after}:
2430 @defun define-key-after map key binding &optional after
2431 Define a binding in @var{map} for @var{key}, with value @var{binding},
2432 just like @code{define-key}, but position the binding in @var{map} after
2433 the binding for the event @var{after}.  The argument @var{key} should be
2434 of length one---a vector or string with just one element.  But
2435 @var{after} should be a single event type---a symbol or a character, not
2436 a sequence.  The new binding goes after the binding for @var{after}.  If
2437 @var{after} is @code{t} or is omitted, then the new binding goes last, at
2438 the end of the keymap.  However, new bindings are added before any
2439 inherited keymap.
2441 Here is an example:
2443 @example
2444 (define-key-after my-menu [drink]
2445   '("Drink" . drink-command) 'eat)
2446 @end example
2448 @noindent
2449 makes a binding for the fake function key @key{DRINK} and puts it
2450 right after the binding for @key{EAT}.
2452 Here is how to insert an item called @samp{Work} in the @samp{Signals}
2453 menu of Shell mode, after the item @code{break}:
2455 @example
2456 (define-key-after
2457   (lookup-key shell-mode-map [menu-bar signals])
2458   [work] '("Work" . work-command) 'break)
2459 @end example
2460 @end defun
2462 @ignore
2463    arch-tag: cfb87287-9364-4e46-9e93-6c2f7f6ae794
2464 @end ignore