@c -*-texinfo-*-@c This is part of the GNU Emacs Lisp Reference Manual.@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1998, 1999, 2000@c Free Software Foundation, Inc. @c See the file elisp.texi for copying conditions.@setfilename ../info/keymaps@node Keymaps, Modes, Command Loop, Top@chapter Keymaps@cindex keymap The bindings between input events and commands are recorded in datastructures called @dfn{keymaps}. Each binding in a keymap associates(or @dfn{binds}) an individual event type either to another keymap or toa command. When an event type is bound to a keymap, that keymap is usedto look up the next input event; this continues until a command isfound. The whole process is called @dfn{key lookup}.@menu* Keymap Terminology:: Definitions of terms pertaining to keymaps.* Format of Keymaps:: What a keymap looks like as a Lisp object.* Creating Keymaps:: Functions to create and copy keymaps.* Inheritance and Keymaps:: How one keymap can inherit the bindings of another keymap.* Prefix Keys:: Defining a key with a keymap as its definition.* Active Keymaps:: Each buffer has a local keymap to override the standard (global) bindings. A minor mode can also override them.* Key Lookup:: How extracting elements from keymaps works.* Functions for Key Lookup:: How to request key lookup.* Changing Key Bindings:: Redefining a key in a keymap.* Key Binding Commands:: Interactive interfaces for redefining keys.* Scanning Keymaps:: Looking through all keymaps, for printing help.* Menu Keymaps:: Defining a menu as a keymap.@end menu@node Keymap Terminology@section Keymap Terminology@cindex key@cindex keystroke@cindex key binding@cindex binding of a key@cindex complete key@cindex undefined key A @dfn{keymap} is a table mapping event types to definitions (whichcan be any Lisp objects, though only certain types are meaningful forexecution by the command loop). Given an event (or an event type) and akeymap, Emacs can get the event's definition. Events includecharacters, function keys, and mouse actions (@pxref{Input Events}). A sequence of input events that form a unit is called a@dfn{key sequence}, or @dfn{key} for short. A sequence of one eventis always a key sequence, and so are some multi-event sequences. A keymap determines a binding or definition for any key sequence. Ifthe key sequence is a single event, its binding is the definition of theevent in the keymap. The binding of a key sequence of more than oneevent is found by an iterative process: the binding of the first eventis found, and must be a keymap; then the second event's binding is foundin that keymap, and so on until all the events in the key sequence areused up. If the binding of a key sequence is a keymap, we call the key sequencea @dfn{prefix key}. Otherwise, we call it a @dfn{complete key} (becauseno more events can be added to it). If the binding is @code{nil},we call the key @dfn{undefined}. Examples of prefix keys are @kbd{C-c},@kbd{C-x}, and @kbd{C-x 4}. Examples of defined complete keys are@kbd{X}, @key{RET}, and @kbd{C-x 4 C-f}. Examples of undefined completekeys are @kbd{C-x C-g}, and @kbd{C-c 3}. @xref{Prefix Keys}, for moredetails. The rule for finding the binding of a key sequence assumes that theintermediate bindings (found for the events before the last) are allkeymaps; if this is not so, the sequence of events does not form aunit---it is not really one key sequence. In other words, removing oneor more events from the end of any valid key sequence must always yielda prefix key. For example, @kbd{C-f C-n} is not a key sequence;@kbd{C-f} is not a prefix key, so a longer sequence starting with@kbd{C-f} cannot be a key sequence. The set of possible multi-event key sequences depends on the bindingsfor prefix keys; therefore, it can be different for different keymaps,and can change when bindings are changed. However, a one-event sequenceis always a key sequence, because it does not depend on any prefix keysfor its well-formedness. At any time, several primary keymaps are @dfn{active}---that is, inuse for finding key bindings. These are the @dfn{global map}, which isshared by all buffers; the @dfn{local keymap}, which is usuallyassociated with a specific major mode; and zero or more @dfn{minor modekeymaps}, which belong to currently enabled minor modes. (Not all minormodes have keymaps.) The local keymap bindings shadow (i.e., takeprecedence over) the corresponding global bindings. The minor modekeymaps shadow both local and global keymaps. @xref{Active Keymaps},for details.@node Format of Keymaps@section Format of Keymaps@cindex format of keymaps@cindex keymap format@cindex full keymap@cindex sparse keymap A keymap is a list whose @sc{car} is the symbol @code{keymap}. Theremaining elements of the list define the key bindings of the keymap.Use the function @code{keymapp} (see below) to test whether an object isa keymap. Several kinds of elements may appear in a keymap, after the symbol@code{keymap} that begins it:@table @code@item (@var{type} .@: @var{binding})This specifies one binding, for events of type @var{type}. Eachordinary binding applies to events of a particular @dfn{event type},which is always a character or a symbol. @xref{Classifying Events}.@item (t .@: @var{binding})@cindex default key bindingThis specifies a @dfn{default key binding}; any event not bound by otherelements of the keymap is given @var{binding} as its binding. Defaultbindings allow a keymap to bind all possible event types without havingto enumerate all of them. A keymap that has a default bindingcompletely masks any lower-precedence keymap.@item @var{vector}If an element of a keymap is a vector, the vector counts as bindings forall the @sc{ascii} characters, codes 0 through 127; vector element@var{n} is the binding for the character with code @var{n}. This is acompact way to record lots of bindings. A keymap with such a vector iscalled a @dfn{full keymap}. Other keymaps are called @dfn{sparsekeymaps}.A @code{nil} binding is used to mean that a key is explicitly not bound.Just like any other binding, it takes precedence over a default bindingor a binding in the parent keymap, but on the other hand, it does nottake precedence over keymaps of lower priority.When a keymap contains a vector, it always defines a binding for each@sc{ascii} character, even if the vector contains @code{nil} for thatcharacter. Such a binding of @code{nil} overrides any default keybinding in the keymap, for @sc{ascii} characters. However, defaultbindings are still meaningful for events other than @sc{ascii}characters. A binding of @code{nil} does @emph{not} overridelower-precedence keymaps; thus, if the local map gives a binding of@code{nil}, Emacs uses the binding from the global map.@item @var{string}@cindex keymap prompt string@cindex overall prompt string@cindex prompt string of keymapAside from bindings, a keymap can also have a string as an element.This is called the @dfn{overall prompt string} and makes it possible touse the keymap as a menu. @xref{Defining Menus}.@end table@cindex meta characters lookup Keymaps do not directly record bindings for the meta characters.Instead, meta characters are regarded for purposes of key lookup assequences of two characters, the first of which is @key{ESC} (orwhatever is currently the value of @code{meta-prefix-char}). Thus, thekey @kbd{M-a} is internally represented as @kbd{@key{ESC} a}, and itsglobal binding is found at the slot for @kbd{a} in @code{esc-map}(@pxref{Prefix Keys}). This conversion applies only to characters, not to function keys orother input events; thus, @kbd{M-@key{end}} has nothing to do with@kbd{@key{ESC} @key{end}}. Here as an example is the local keymap for Lisp mode, a sparsekeymap. It defines bindings for @key{DEL} and @key{TAB}, plus @kbd{C-cC-l}, @kbd{M-C-q}, and @kbd{M-C-x}.@example@grouplisp-mode-map@result{} @end group@group(keymap ;; @key{TAB} (9 . lisp-indent-line) @end group@group ;; @key{DEL} (127 . backward-delete-char-untabify) @end group@group (3 keymap ;; @kbd{C-c C-l} (12 . run-lisp)) @end group@group (27 keymap ;; @r{@kbd{M-C-q}, treated as @kbd{@key{ESC} C-q}} (17 . indent-sexp) ;; @r{@kbd{M-C-x}, treated as @kbd{@key{ESC} C-x}} (24 . lisp-send-defun))) @end group@end example@defun keymapp objectThis function returns @code{t} if @var{object} is a keymap, @code{nil}otherwise. More precisely, this function tests for a list whose@sc{car} is @code{keymap}.@example@group(keymapp '(keymap)) @result{} t@end group@group(keymapp (current-global-map)) @result{} t@end group@end example@end defun@node Creating Keymaps@section Creating Keymaps@cindex creating keymaps Here we describe the functions for creating keymaps.@c ??? This should come after make-sparse-keymap@defun make-keymap &optional promptThis function creates and returns a new full keymap. That keymapcontains a char-table (@pxref{Char-Tables}) with 384 slots: the first128 slots are for defining all the @sc{ascii} characters, the next 128slots are for 8-bit European characters, and each one of the final 128slots is for one character set of non-@sc{ascii} characters supported byEmacs. The new keymap initially binds all these characters to@code{nil}, and does not bind any other kind of event.@example@group(make-keymap) @result{} (keymap [nil nil nil @dots{} nil nil])@end group@end exampleIf you specify @var{prompt}, that becomes the overall prompt string forthe keymap. The prompt string should be provided for menu keymaps(@pxref{Defining Menus}).@end defun@defun make-sparse-keymap &optional promptThis function creates and returns a new sparse keymap with no entries.The new keymap does not contain a char-table, unlike @code{make-keymap},and does not bind any events. The argument @var{prompt} specifies aprompt string, as in @code{make-keymap}.@example@group(make-sparse-keymap) @result{} (keymap)@end group@end example@end defun@defun copy-keymap keymapThis function returns a copy of @var{keymap}. Any keymaps thatappear directly as bindings in @var{keymap} are also copied recursively,and so on to any number of levels. However, recursive copying does nottake place when the definition of a character is a symbol whose functiondefinition is a keymap; the same symbol appears in the new copy.@c Emacs 19 feature@example@group(setq map (copy-keymap (current-local-map)))@result{} (keymap@end group@group ;; @r{(This implements meta characters.)} (27 keymap (83 . center-paragraph) (115 . center-line)) (9 . tab-to-tab-stop))@end group@group(eq map (current-local-map)) @result{} nil@end group@group(equal map (current-local-map)) @result{} t@end group@end example@end defun@node Inheritance and Keymaps@section Inheritance and Keymaps@cindex keymap inheritance@cindex inheriting a keymap's bindings A keymap can inherit the bindings of another keymap, which we call the@dfn{parent keymap}. Such a keymap looks like this:@example(keymap @var{bindings}@dots{} . @var{parent-keymap})@end example@noindentThe effect is that this keymap inherits all the bindings of@var{parent-keymap}, whatever they may be at the time a key is looked up,but can add to them or override them with @var{bindings}.If you change the bindings in @var{parent-keymap} using @code{define-key}or other key-binding functions, these changes are visible in theinheriting keymap unless shadowed by @var{bindings}. The converse isnot true: if you use @code{define-key} to change the inheriting keymap,that affects @var{bindings}, but has no effect on @var{parent-keymap}.The proper way to construct a keymap with a parent is to use@code{set-keymap-parent}; if you have code that directly constructs akeymap with a parent, please convert the program to use@code{set-keymap-parent} instead.@defun keymap-parent keymapThis returns the parent keymap of @var{keymap}. If @var{keymap}has no parent, @code{keymap-parent} returns @code{nil}.@end defun@defun set-keymap-parent keymap parentThis sets the parent keymap of @var{keymap} to @var{parent}, and returns@var{parent}. If @var{parent} is @code{nil}, this function gives@var{keymap} no parent at all.If @var{keymap} has submaps (bindings for prefix keys), they too receivenew parent keymaps that reflect what @var{parent} specifies for thoseprefix keys.@end defun Here is an example showing how to make a keymap that inheritsfrom @code{text-mode-map}:@example(let ((map (make-sparse-keymap))) (set-keymap-parent map text-mode-map) map)@end example A non-sparse keymap can have a parent too, but this is not veryuseful. A non-sparse keymap always specifies something as the bindingfor every numeric character code without modifier bits, even if it is@code{nil}, so these character's bindings are never inherited fromthe parent keymap.@node Prefix Keys@section Prefix Keys@cindex prefix key A @dfn{prefix key} is a key sequence whose binding is a keymap. Thekeymap defines what to do with key sequences that extend the prefix key.For example, @kbd{C-x} is a prefix key, and it uses a keymap that isalso stored in the variable @code{ctl-x-map}. This keymap definesbindings for key sequences starting with @kbd{C-x}. Some of the standard Emacs prefix keys use keymaps that arealso found in Lisp variables:@itemize @bullet@item@vindex esc-map@findex ESC-prefix@code{esc-map} is the global keymap for the @key{ESC} prefix key. Thus,the global definitions of all meta characters are actually found here.This map is also the function definition of @code{ESC-prefix}.@item@cindex @kbd{C-h}@code{help-map} is the global keymap for the @kbd{C-h} prefix key.@item@cindex @kbd{C-c}@vindex mode-specific-map@code{mode-specific-map} is the global keymap for the prefix key@kbd{C-c}. This map is actually global, not mode-specific, but its nameprovides useful information about @kbd{C-c} in the output of @kbd{C-h b}(@code{display-bindings}), since the main use of this prefix key is formode-specific bindings.@item@cindex @kbd{C-x}@vindex ctl-x-map@findex Control-X-prefix@code{ctl-x-map} is the global keymap used for the @kbd{C-x} prefix key.This map is found via the function cell of the symbol@code{Control-X-prefix}.@item@cindex @kbd{C-x @key{RET}}@vindex mule-keymap@code{mule-keymap} is the global keymap used for the @kbd{C-x @key{RET}}prefix key.@item@cindex @kbd{C-x 4}@vindex ctl-x-4-map@code{ctl-x-4-map} is the global keymap used for the @kbd{C-x 4} prefixkey.@c Emacs 19 feature@item@cindex @kbd{C-x 5}@vindex ctl-x-5-map@code{ctl-x-5-map} is the global keymap used for the @kbd{C-x 5} prefixkey.@c Emacs 19 feature@item@cindex @kbd{C-x 6}@vindex 2C-mode-map@code{2C-mode-map} is the global keymap used for the @kbd{C-x 6} prefixkey.@item@cindex @kbd{C-x v}@vindex vc-prefix-map@code{vc-prefix-map} is the global keymap used for the @kbd{C-x v} prefixkey.@item@cindex @kbd{M-g}@vindex facemenu-keymap@code{facemenu-keymap} is the global keymap used for the @kbd{M-g}prefix key.@c Emacs 19 feature@itemThe other Emacs prefix keys are @kbd{C-x @@}, @kbd{C-x a i}, @kbd{C-x@key{ESC}} and @kbd{@key{ESC} @key{ESC}}. They use keymaps that have nospecial names.@end itemize The keymap binding of a prefix key is used for looking up the eventthat follows the prefix key. (It may instead be a symbol whose functiondefinition is a keymap. The effect is the same, but the symbol servesas a name for the prefix key.) Thus, the binding of @kbd{C-x} is thesymbol @code{Control-X-prefix}, whose function cell holds the keymapfor @kbd{C-x} commands. (The same keymap is also the value of@code{ctl-x-map}.) Prefix key definitions can appear in any active keymap. Thedefinitions of @kbd{C-c}, @kbd{C-x}, @kbd{C-h} and @key{ESC} as prefixkeys appear in the global map, so these prefix keys are alwaysavailable. Major and minor modes can redefine a key as a prefix byputting a prefix key definition for it in the local map or the minormode's map. @xref{Active Keymaps}. If a key is defined as a prefix in more than one active map, then itsvarious definitions are in effect merged: the commands defined in theminor mode keymaps come first, followed by those in the local map'sprefix definition, and then by those from the global map. In the following example, we make @kbd{C-p} a prefix key in the localkeymap, in such a way that @kbd{C-p} is identical to @kbd{C-x}. Thenthe binding for @kbd{C-p C-f} is the function @code{find-file}, justlike @kbd{C-x C-f}. The key sequence @kbd{C-p 6} is not found in anyactive keymap.@example@group(use-local-map (make-sparse-keymap)) @result{} nil@end group@group(local-set-key "\C-p" ctl-x-map) @result{} nil@end group@group(key-binding "\C-p\C-f") @result{} find-file@end group@group(key-binding "\C-p6") @result{} nil@end group@end example@defun define-prefix-command symbol &optional mapvar prompt@cindex prefix commandThis function prepares @var{symbol} for use as a prefix key's binding:it creates a sparse keymap and stores it as @var{symbol}'s functiondefinition. Subsequently binding a key sequence to @var{symbol} willmake that key sequence into a prefix key. The return value is @code{symbol}.This function also sets @var{symbol} as a variable, with the keymap asits value. But if @var{mapvar} is non-@code{nil}, it sets @var{mapvar}as a variable instead.If @var{prompt} is non-@code{nil}, that becomes the overall promptstring for the keymap. The prompt string should be given for menu keymaps(@pxref{Defining Menus}).@end defun@node Active Keymaps@section Active Keymaps@cindex active keymap@cindex global keymap@cindex local keymap Emacs normally contains many keymaps; at any given time, just a few ofthem are @dfn{active} in that they participate in the interpretationof user input. These are the global keymap, the current buffer'slocal keymap, and the keymaps of any enabled minor modes. The @dfn{global keymap} holds the bindings of keys that are definedregardless of the current buffer, such as @kbd{C-f}. The variable@code{global-map} holds this keymap, which is always active. Each buffer may have another keymap, its @dfn{local keymap}, which maycontain new or overriding definitions for keys. The current buffer'slocal keymap is always active except when @code{overriding-local-map}overrides it. Text properties can specify an alternative local map forcertain parts of the buffer; see @ref{Special Properties}. Each minor mode can have a keymap; if it does, the keymap is activewhen the minor mode is enabled. The variable @code{overriding-local-map}, if non-@code{nil}, specifiesanother local keymap that overrides the buffer's local map and all the minor mode keymaps. All the active keymaps are used together to determine what command toexecute when a key is entered. Emacs searches these maps one by one, inorder of decreasing precedence, until it finds a binding in one of themaps. The procedure for searching a single keymap is called @dfn{keylookup}; see @ref{Key Lookup}. Normally, Emacs first searches for the key in the minor mode maps, inthe order specified by @code{minor-mode-map-alist}; if they do notsupply a binding for the key, Emacs searches the local map; if that toohas no binding, Emacs then searches the global map. However, if@code{overriding-local-map} is non-@code{nil}, Emacs searches that mapfirst, before the global map.@cindex major mode keymap Since every buffer that uses the same major mode normally uses thesame local keymap, you can think of the keymap as local to the mode. Achange to the local keymap of a buffer (using @code{local-set-key}, forexample) is seen also in the other buffers that share that keymap. The local keymaps that are used for Lisp mode and some other majormodes exist even if they have not yet been used. These local maps arethe values of variables such as @code{lisp-mode-map}. For most majormodes, which are less frequently used, the local keymap is constructedonly when the mode is used for the first time in a session. The minibuffer has local keymaps, too; they contain various completionand exit commands. @xref{Intro to Minibuffers}. Emacs has other keymaps that are used in a different way---translatingevents within @code{read-key-sequence}. @xref{Translating Input}. @xref{Standard Keymaps}, for a list of standard keymaps.@defvar global-mapThis variable contains the default global keymap that maps Emacskeyboard input to commands. The global keymap is normally this keymap.The default global keymap is a full keymap that binds@code{self-insert-command} to all of the printing characters.It is normal practice to change the bindings in the global map, but youshould not assign this variable any value other than the keymap it startsout with.@end defvar@defun current-global-mapThis function returns the current global keymap. This is thesame as the value of @code{global-map} unless you change one or theother.@example@group(current-global-map)@result{} (keymap [set-mark-command beginning-of-line @dots{} delete-backward-char])@end group@end example@end defun@defun current-local-mapThis function returns the current buffer's local keymap, or @code{nil}if it has none. In the following example, the keymap for the@samp{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymapin which the entry for @key{ESC}, @sc{ascii} code 27, is another sparsekeymap.@example@group(current-local-map)@result{} (keymap (10 . eval-print-last-sexp) (9 . lisp-indent-line) (127 . backward-delete-char-untabify) @end group@group (27 keymap (24 . eval-defun) (17 . indent-sexp)))@end group@end example@end defun@defun current-minor-mode-mapsThis function returns a list of the keymaps of currently enabled minor modes.@end defun@defun use-global-map keymapThis function makes @var{keymap} the new current global keymap. Itreturns @code{nil}.It is very unusual to change the global keymap.@end defun@defun use-local-map keymapThis function makes @var{keymap} the new local keymap of the currentbuffer. If @var{keymap} is @code{nil}, then the buffer has no localkeymap. @code{use-local-map} returns @code{nil}. Most major modecommands use this function.@end defun@c Emacs 19 feature@defvar minor-mode-map-alistThis variable is an alist describing keymaps that may or may not beactive according to the values of certain variables. Its elements looklike this:@example(@var{variable} . @var{keymap})@end exampleThe keymap @var{keymap} is active whenever @var{variable} has anon-@code{nil} value. Typically @var{variable} is the variable thatenables or disables a minor mode. @xref{Keymaps and Minor Modes}.Note that elements of @code{minor-mode-map-alist} do not have the samestructure as elements of @code{minor-mode-alist}. The map must be the@sc{cdr} of the element; a list with the map as the second element willnot do. The @sc{cdr} can be either a keymap (a list) or a symbol whosefunction definition is a keymap.When more than one minor mode keymap is active, their order of priorityis the order of @code{minor-mode-map-alist}. But you should designminor modes so that they don't interfere with each other. If you dothis properly, the order will not matter.See @ref{Keymaps and Minor Modes}, for more information about minormodes. See also @code{minor-mode-key-binding} (@pxref{Functions for KeyLookup}).@end defvar@defvar minor-mode-overriding-map-alistThis variable allows major modes to override the key bindings forparticular minor modes. The elements of this alist look like theelements of @code{minor-mode-map-alist}: @code{(@var{variable}. @var{keymap})}.If a variable appears as an element of@code{minor-mode-overriding-map-alist}, the map specified by thatelement totally replaces any map specified for the same variable in@code{minor-mode-map-alist}.@code{minor-mode-overriding-map-alist} is automatically buffer-local inall buffers.@end defvar@defvar overriding-local-mapIf non-@code{nil}, this variable holds a keymap to use instead of thebuffer's local keymap and instead of all the minor mode keymaps. Thiskeymap, if any, overrides all other maps that would have been active,except for the current global map.@end defvar@defvar overriding-terminal-local-mapIf non-@code{nil}, this variable holds a keymap to use instead of@code{overriding-local-map}, the buffer's local keymap and all the minormode keymaps.This variable is always local to the current terminal and cannot bebuffer-local. @xref{Multiple Displays}. It is used to implementincremental search mode.@end defvar@defvar overriding-local-map-menu-flagIf this variable is non-@code{nil}, the value of@code{overriding-local-map} or @code{overriding-terminal-local-map} canaffect the display of the menu bar. The default value is @code{nil}, sothose map variables have no effect on the menu bar.Note that these two map variables do affect the execution of keysequences entered using the menu bar, even if they do not affect themenu bar display. So if a menu bar key sequence comes in, you shouldclear the variables before looking up and executing that key sequence.Modes that use the variables would typically do this anyway; normallythey respond to events that they do not handle by ``unreading'' them andexiting.@end defvar@defvar special-event-mapThis variable holds a keymap for special events. If an event type has abinding in this keymap, then it is special, and the binding for theevent is run directly by @code{read-event}. @xref{Special Events}.@end defvar@node Key Lookup@section Key Lookup@cindex key lookup@cindex keymap entry @dfn{Key lookup} is the process of finding the binding of a keysequence from a given keymap. Actual execution of the binding is notpart of key lookup. Key lookup uses just the event type of each event in the key sequence;the rest of the event is ignored. In fact, a key sequence used for keylookup may designate mouse events with just their types (symbols)instead of with entire mouse events (lists). @xref{Input Events}. Sucha ``key-sequence'' is insufficient for @code{command-execute} to run,but it is sufficient for looking up or rebinding a key. When the key sequence consists of multiple events, key lookupprocesses the events sequentially: the binding of the first event isfound, and must be a keymap; then the second event's binding is found inthat keymap, and so on until all the events in the key sequence are usedup. (The binding thus found for the last event may or may not be akeymap.) Thus, the process of key lookup is defined in terms of asimpler process for looking up a single event in a keymap. How that isdone depends on the type of object associated with the event in thatkeymap. Let's use the term @dfn{keymap entry} to describe the value found bylooking up an event type in a keymap. (This doesn't include the itemstring and other extra elements in menu key bindings, because@code{lookup-key} and other key lookup functions don't include them inthe returned value.) While any Lisp object may be stored in a keymap asa keymap entry, not all make sense for key lookup. Here is a table ofthe meaningful kinds of keymap entries:@table @asis@item @code{nil}@cindex @code{nil} in keymap@code{nil} means that the events used so far in the lookup form anundefined key. When a keymap fails to mention an event type at all, andhas no default binding, that is equivalent to a binding of @code{nil}for that event type.@item @var{command}@cindex command in keymapThe events used so far in the lookup form a complete key,and @var{command} is its binding. @xref{What Is a Function}.@item @var{array}@cindex string in keymapThe array (either a string or a vector) is a keyboard macro. The eventsused so far in the lookup form a complete key, and the array is itsbinding. See @ref{Keyboard Macros}, for more information.@item @var{keymap}@cindex keymap in keymapThe events used so far in the lookup form a prefix key. The nextevent of the key sequence is looked up in @var{keymap}.@item @var{list}@cindex list in keymapThe meaning of a list depends on the types of the elements of the list.@itemize @bullet@itemIf the @sc{car} of @var{list} is the symbol @code{keymap}, then the listis a keymap, and is treated as a keymap (see above).@item@cindex @code{lambda} in keymapIf the @sc{car} of @var{list} is @code{lambda}, then the list is alambda expression. This is presumed to be a command, and is treated assuch (see above).@itemIf the @sc{car} of @var{list} is a keymap and the @sc{cdr} is an eventtype, then this is an @dfn{indirect entry}:@example(@var{othermap} . @var{othertype})@end exampleWhen key lookup encounters an indirect entry, it looks up instead thebinding of @var{othertype} in @var{othermap} and uses that.This feature permits you to define one key as an alias for another key.For example, an entry whose @sc{car} is the keymap called @code{esc-map}and whose @sc{cdr} is 32 (the code for @key{SPC}) means, ``Use the globalbinding of @kbd{Meta-@key{SPC}}, whatever that may be.''@end itemize@item @var{symbol}@cindex symbol in keymapThe function definition of @var{symbol} is used in place of@var{symbol}. If that too is a symbol, then this process is repeated,any number of times. Ultimately this should lead to an object that isa keymap, a command, or a keyboard macro. A list is allowed if it is akeymap or a command, but indirect entries are not understood when foundvia symbols.Note that keymaps and keyboard macros (strings and vectors) are notvalid functions, so a symbol with a keymap, string, or vector as itsfunction definition is invalid as a function. It is, however, valid asa key binding. If the definition is a keyboard macro, then the symbolis also valid as an argument to @code{command-execute}(@pxref{Interactive Call}).@cindex @code{undefined} in keymapThe symbol @code{undefined} is worth special mention: it means to treatthe key as undefined. Strictly speaking, the key is defined, and itsbinding is the command @code{undefined}; but that command does the samething that is done automatically for an undefined key: it rings the bell(by calling @code{ding}) but does not signal an error.@cindex preventing prefix key@code{undefined} is used in local keymaps to override a global keybinding and make the key ``undefined'' locally. A local binding of@code{nil} would fail to do this because it would not override theglobal binding.@item @var{anything else}If any other type of object is found, the events used so far in thelookup form a complete key, and the object is its binding, but thebinding is not executable as a command.@end table In short, a keymap entry may be a keymap, a command, a keyboard macro,a symbol that leads to one of them, or an indirection or @code{nil}.Here is an example of a sparse keymap with two characters bound tocommands and one bound to another keymap. This map is the normal valueof @code{emacs-lisp-mode-map}. Note that 9 is the code for @key{TAB},127 for @key{DEL}, 27 for @key{ESC}, 17 for @kbd{C-q} and 24 for@kbd{C-x}.@example@group(keymap (9 . lisp-indent-line) (127 . backward-delete-char-untabify) (27 keymap (17 . indent-sexp) (24 . eval-defun)))@end group@end example@node Functions for Key Lookup@section Functions for Key Lookup Here are the functions and variables pertaining to key lookup.@defun lookup-key keymap key &optional accept-defaultsThis function returns the definition of @var{key} in @var{keymap}. Allthe other functions described in this chapter that look up keys use@code{lookup-key}. Here are examples:@example@group(lookup-key (current-global-map) "\C-x\C-f") @result{} find-file@end group@group(lookup-key (current-global-map) "\C-x\C-f12345") @result{} 2@end group@end exampleIf the string or vector @var{key} is not a valid key sequence accordingto the prefix keys specified in @var{keymap}, it must be ``too long''and have extra events at the end that do not fit into a single keysequence. Then the value is a number, the number of events at the frontof @var{key} that compose a complete key.@c Emacs 19 featureIf @var{accept-defaults} is non-@code{nil}, then @code{lookup-key}considers default bindings as well as bindings for the specific eventsin @var{key}. Otherwise, @code{lookup-key} reports only bindings forthe specific sequence @var{key}, ignoring default bindings except whenyou explicitly ask about them. (To do this, supply @code{t} as anelement of @var{key}; see @ref{Format of Keymaps}.)If @var{key} contains a meta character (not a function key), thatcharacter is implicitly replaced by a two-character sequence: the valueof @code{meta-prefix-char}, followed by the corresponding non-metacharacter. Thus, the first example below is handled by conversion intothe second example.@example@group(lookup-key (current-global-map) "\M-f") @result{} forward-word@end group@group(lookup-key (current-global-map) "\ef") @result{} forward-word@end group@end exampleUnlike @code{read-key-sequence}, this function does not modify thespecified events in ways that discard information (@pxref{Key SequenceInput}). In particular, it does not convert letters to lower case andit does not change drag events to clicks.@end defun@deffn Command undefinedUsed in keymaps to undefine keys. It calls @code{ding}, but doesnot cause an error.@end deffn@defun key-binding key &optional accept-defaultsThis function returns the binding for @var{key} in the currentkeymaps, trying all the active keymaps. The result is @code{nil} if@var{key} is undefined in the keymaps.@c Emacs 19 featureThe argument @var{accept-defaults} controls checking for defaultbindings, as in @code{lookup-key} (above).An error is signaled if @var{key} is not a string or a vector.@example@group(key-binding "\C-x\C-f") @result{} find-file@end group@end example@end defun@defun local-key-binding key &optional accept-defaultsThis function returns the binding for @var{key} in the currentlocal keymap, or @code{nil} if it is undefined there.@c Emacs 19 featureThe argument @var{accept-defaults} controls checking for default bindings,as in @code{lookup-key} (above).@end defun@defun global-key-binding key &optional accept-defaultsThis function returns the binding for command @var{key} in thecurrent global keymap, or @code{nil} if it is undefined there.@c Emacs 19 featureThe argument @var{accept-defaults} controls checking for default bindings,as in @code{lookup-key} (above).@end defun@c Emacs 19 feature@defun minor-mode-key-binding key &optional accept-defaultsThis function returns a list of all the active minor mode bindings of@var{key}. More precisely, it returns an alist of pairs@code{(@var{modename} . @var{binding})}, where @var{modename} is thevariable that enables the minor mode, and @var{binding} is @var{key}'sbinding in that mode. If @var{key} has no minor-mode bindings, thevalue is @code{nil}.If the first binding found is not a prefix definition (a keymap or asymbol defined as a keymap), all subsequent bindings from other minormodes are omitted, since they would be completely shadowed. Similarly,the list omits non-prefix bindings that follow prefix bindings.The argument @var{accept-defaults} controls checking for defaultbindings, as in @code{lookup-key} (above).@end defun@defvar meta-prefix-char@cindex @key{ESC}This variable is the meta-prefix character code. It is used whentranslating a meta character to a two-character sequence so it can belooked up in a keymap. For useful results, the value should be a prefixevent (@pxref{Prefix Keys}). The default value is 27, which is the@sc{ascii} code for @key{ESC}.As long as the value of @code{meta-prefix-char} remains 27, key lookuptranslates @kbd{M-b} into @kbd{@key{ESC} b}, which is normally definedas the @code{backward-word} command. However, if you were to set@code{meta-prefix-char} to 24, the code for @kbd{C-x}, then Emacs willtranslate @kbd{M-b} into @kbd{C-x b}, whose standard binding is the@code{switch-to-buffer} command. (Don't actually do this!) Here is anillustration of what would happen:@smallexample@groupmeta-prefix-char ; @r{The default value.} @result{} 27@end group@group(key-binding "\M-b") @result{} backward-word@end group@group?\C-x ; @r{The print representation} @result{} 24 ; @r{of a character.}@end group@group(setq meta-prefix-char 24) @result{} 24 @end group@group(key-binding "\M-b") @result{} switch-to-buffer ; @r{Now, typing @kbd{M-b} is} ; @r{like typing @kbd{C-x b}.}(setq meta-prefix-char 27) ; @r{Avoid confusion!} @result{} 27 ; @r{Restore the default value!}@end group@end smallexampleThis translation of one event into two happens only for characters, notfor other kinds of input events. Thus, @kbd{M-@key{F1}}, a functionkey, is not converted into @kbd{@key{ESC} @key{F1}}.@end defvar@node Changing Key Bindings@section Changing Key Bindings@cindex changing key bindings@cindex rebinding The way to rebind a key is to change its entry in a keymap. If youchange a binding in the global keymap, the change is effective in allbuffers (though it has no direct effect in buffers that shadow theglobal binding with a local one). If you change the current buffer'slocal map, that usually affects all buffers using the same major mode.The @code{global-set-key} and @code{local-set-key} functions areconvenient interfaces for these operations (@pxref{Key BindingCommands}). You can also use @code{define-key}, a more generalfunction; then you must specify explicitly the map to change.@cindex meta character key constants@cindex control character key constants In writing the key sequence to rebind, it is good to use the specialescape sequences for control and meta characters (@pxref{String Type}).The syntax @samp{\C-} means that the following character is a controlcharacter and @samp{\M-} means that the following character is a metacharacter. Thus, the string @code{"\M-x"} is read as containing asingle @kbd{M-x}, @code{"\C-f"} is read as containing a single@kbd{C-f}, and @code{"\M-\C-x"} and @code{"\C-\M-x"} are both read ascontaining a single @kbd{C-M-x}. You can also use this escape syntax invectors, as well as others that aren't allowed in strings; one exampleis @samp{[?\C-\H-x home]}. @xref{Character Type}. The key definition and lookup functions accept an alternate syntax forevent types in a key sequence that is a vector: you can use a listcontaining modifier names plus one base event (a character or functionkey name). For example, @code{(control ?a)} is equivalent to@code{?\C-a} and @code{(hyper control left)} is equivalent to@code{C-H-left}. One advantage of such lists is that the precisenumeric codes for the modifier bits don't appear in compiled files. For the functions below, an error is signaled if @var{keymap} is not akeymap or if @var{key} is not a string or vector representing a keysequence. You can use event types (symbols) as shorthand for eventsthat are lists.@defun define-key keymap key bindingThis function sets the binding for @var{key} in @var{keymap}. (If@var{key} is more than one event long, the change is actually madein another keymap reached from @var{keymap}.) The argument@var{binding} can be any Lisp object, but only certain types aremeaningful. (For a list of meaningful types, see @ref{Key Lookup}.)The value returned by @code{define-key} is @var{binding}.@cindex invalid prefix key error@cindex key sequence errorEvery prefix of @var{key} must be a prefix key (i.e., bound to a keymap)or undefined; otherwise an error is signaled. If some prefix of@var{key} is undefined, then @code{define-key} defines it as a prefixkey so that the rest of @var{key} can be defined as specified.If there was previously no binding for @var{key} in @var{keymap}, thenew binding is added at the beginning of @var{keymap}. The order ofbindings in a keymap makes no difference in most cases, but it doesmatter for menu keymaps (@pxref{Menu Keymaps}).@end defun Here is an example that creates a sparse keymap and makes a number ofbindings in it:@smallexample@group(setq map (make-sparse-keymap)) @result{} (keymap)@end group@group(define-key map "\C-f" 'forward-char) @result{} forward-char@end group@groupmap @result{} (keymap (6 . forward-char))@end group@group;; @r{Build sparse submap for @kbd{C-x} and bind @kbd{f} in that.}(define-key map "\C-xf" 'forward-word) @result{} forward-word@end group@groupmap@result{} (keymap (24 keymap ; @kbd{C-x} (102 . forward-word)) ; @kbd{f} (6 . forward-char)) ; @kbd{C-f}@end group@group;; @r{Bind @kbd{C-p} to the @code{ctl-x-map}.}(define-key map "\C-p" ctl-x-map);; @code{ctl-x-map}@result{} [nil @dots{} find-file @dots{} backward-kill-sentence] @end group@group;; @r{Bind @kbd{C-f} to @code{foo} in the @code{ctl-x-map}.}(define-key map "\C-p\C-f" 'foo)@result{} 'foo@end group@groupmap@result{} (keymap ; @r{Note @code{foo} in @code{ctl-x-map}.} (16 keymap [nil @dots{} foo @dots{} backward-kill-sentence]) (24 keymap (102 . forward-word)) (6 . forward-char))@end group@end smallexample@noindentNote that storing a new binding for @kbd{C-p C-f} actually works bychanging an entry in @code{ctl-x-map}, and this has the effect ofchanging the bindings of both @kbd{C-p C-f} and @kbd{C-x C-f} in thedefault global map.@defun substitute-key-definition olddef newdef keymap &optional oldmap@cindex replace bindingsThis function replaces @var{olddef} with @var{newdef} for any keys in@var{keymap} that were bound to @var{olddef}. In other words,@var{olddef} is replaced with @var{newdef} wherever it appears. Thefunction returns @code{nil}.For example, this redefines @kbd{C-x C-f}, if you do it in an Emacs withstandard bindings:@smallexample@group(substitute-key-definition 'find-file 'find-file-read-only (current-global-map))@end group@end smallexample@c Emacs 19 featureIf @var{oldmap} is non-@code{nil}, that changes the behavior of@code{substitute-key-definition}: the bindings in @var{oldmap} determinewhich keys to rebind. The rebindings still happen in @var{keymap}, notin @var{oldmap}. Thus, you can change one map under the control of thebindings in another. For example,@smallexample(substitute-key-definition 'delete-backward-char 'my-funny-delete my-map global-map)@end smallexample@noindentputs the special deletion command in @code{my-map} for whichever keysare globally bound to the standard deletion command.@ignore@c Emacs 18 onlyPrefix keymaps that appear within @var{keymap} are not checkedrecursively for keys bound to @var{olddef}; they are not changed at all.Perhaps it would be better to check nested keymaps recursively.@end ignoreHere is an example showing a keymap before and after substitution:@smallexample@group(setq map '(keymap (?1 . olddef-1) (?2 . olddef-2) (?3 . olddef-1)))@result{} (keymap (49 . olddef-1) (50 . olddef-2) (51 . olddef-1))@end group@group(substitute-key-definition 'olddef-1 'newdef map)@result{} nil@end group@groupmap@result{} (keymap (49 . newdef) (50 . olddef-2) (51 . newdef))@end group@end smallexample@end defun@defun suppress-keymap keymap &optional nodigits@cindex @code{self-insert-command} overrideThis function changes the contents of the full keymap @var{keymap} bymaking all the printing characters undefined. More precisely, it bindsthem to the command @code{undefined}. This makes ordinary insertion oftext impossible. @code{suppress-keymap} returns @code{nil}.If @var{nodigits} is @code{nil}, then @code{suppress-keymap} definesdigits to run @code{digit-argument}, and @kbd{-} to run@code{negative-argument}. Otherwise it makes them undefined like therest of the printing characters.@cindex yank suppression @cindex @code{quoted-insert} suppression The @code{suppress-keymap} function does not make it impossible tomodify a buffer, as it does not suppress commands such as @code{yank}and @code{quoted-insert}. To prevent any modification of a buffer, makeit read-only (@pxref{Read Only Buffers}).Since this function modifies @var{keymap}, you would normally use iton a newly created keymap. Operating on an existing keymapthat is used for some other purpose is likely to cause trouble; forexample, suppressing @code{global-map} would make it impossible to usemost of Emacs.Most often, @code{suppress-keymap} is used to initialize localkeymaps of modes such as Rmail and Dired where insertion of text is notdesirable and the buffer is read-only. Here is an example taken fromthe file @file{emacs/lisp/dired.el}, showing how the local keymap forDired mode is set up:@smallexample@group(setq dired-mode-map (make-keymap))(suppress-keymap dired-mode-map)(define-key dired-mode-map "r" 'dired-rename-file)(define-key dired-mode-map "\C-d" 'dired-flag-file-deleted)(define-key dired-mode-map "d" 'dired-flag-file-deleted)(define-key dired-mode-map "v" 'dired-view-file)(define-key dired-mode-map "e" 'dired-find-file)(define-key dired-mode-map "f" 'dired-find-file)@dots{}@end group@end smallexample@end defun@node Key Binding Commands@section Commands for Binding Keys This section describes some convenient interactive interfaces forchanging key bindings. They work by calling @code{define-key}. People often use @code{global-set-key} in their init files(@pxref{Init File}) for simple customization. For example,@smallexample(global-set-key "\C-x\C-\\" 'next-line)@end smallexample@noindentor@smallexample(global-set-key [?\C-x ?\C-\\] 'next-line)@end smallexample@noindentor@smallexample(global-set-key [(control ?x) (control ?\\)] 'next-line)@end smallexample@noindentredefines @kbd{C-x C-\} to move down a line.@smallexample(global-set-key [M-mouse-1] 'mouse-set-point)@end smallexample@noindentredefines the first (leftmost) mouse button, typed with the Meta key, toset point where you click.@cindex non-@sc{ascii} text in keybindings Be careful when using non-@sc{ascii} text characters in Lispspecifications of keys to bind. If these are read as multibyte text, asthey usually will be in a Lisp file (@pxref{Loading Non-ASCII}), youmust type the keys as multibyte too. For instance, if you use this:@smallexample(global-set-key "@"o" 'my-function) ; bind o-umlaut@end smallexample@noindentor@smallexample(global-set-key ?@"o 'my-function) ; bind o-umlaut@end smallexample@noindentand your language environment is multibyte Latin-1, these commandsactually bind the multibyte character with code 2294, not the unibyteLatin-1 character with code 246 (@kbd{M-v}). In order to use thisbinding, you need to enter the multibyte Latin-1 character as keyboardinput. One way to do this is by using an appropriate input method(@pxref{Input Methods, , Input Methods, emacs,The GNU Emacs Manual}). If you want to use a unibyte character in the key binding, you canconstruct the key sequence string using @code{multibyte-char-to-unibyte}or @code{string-make-unibyte} (@pxref{Converting Representations}).@deffn Command global-set-key key definitionThis function sets the binding of @var{key} in the current global mapto @var{definition}.@smallexample@group(global-set-key @var{key} @var{definition})@equiv{}(define-key (current-global-map) @var{key} @var{definition})@end group@end smallexample@end deffn@deffn Command global-unset-key key@cindex unbinding keysThis function removes the binding of @var{key} from the currentglobal map.One use of this function is in preparation for defining a longer keythat uses @var{key} as a prefix---which would not be allowed if@var{key} has a non-prefix binding. For example:@smallexample@group(global-unset-key "\C-l") @result{} nil@end group@group(global-set-key "\C-l\C-l" 'redraw-display) @result{} nil@end group@end smallexampleThis function is implemented simply using @code{define-key}:@smallexample@group(global-unset-key @var{key})@equiv{}(define-key (current-global-map) @var{key} nil)@end group@end smallexample@end deffn@deffn Command local-set-key key definitionThis function sets the binding of @var{key} in the current localkeymap to @var{definition}.@smallexample@group(local-set-key @var{key} @var{definition})@equiv{}(define-key (current-local-map) @var{key} @var{definition})@end group@end smallexample@end deffn@deffn Command local-unset-key keyThis function removes the binding of @var{key} from the currentlocal map.@smallexample@group(local-unset-key @var{key})@equiv{}(define-key (current-local-map) @var{key} nil)@end group@end smallexample@end deffn@node Scanning Keymaps@section Scanning Keymaps This section describes functions used to scan all the current keymapsfor the sake of printing help information.@defun accessible-keymaps keymap &optional prefixThis function returns a list of all the keymaps that can be reached (viazero or more prefix keys) from @var{keymap}. The value is anassociation list with elements of the form @code{(@var{key} .@:@var{map})}, where @var{key} is a prefix key whose definition in@var{keymap} is @var{map}.The elements of the alist are ordered so that the @var{key} increasesin length. The first element is always @code{("" .@: @var{keymap})},because the specified keymap is accessible from itself with a prefix ofno events.If @var{prefix} is given, it should be a prefix key sequence; then@code{accessible-keymaps} includes only the submaps whose prefixes startwith @var{prefix}. These elements look just as they do in the value of@code{(accessible-keymaps)}; the only difference is that some elementsare omitted.In the example below, the returned alist indicates that the key@key{ESC}, which is displayed as @samp{^[}, is a prefix key whosedefinition is the sparse keymap @code{(keymap (83 .@: center-paragraph)(115 .@: foo))}.@smallexample@group(accessible-keymaps (current-local-map))@result{}(("" keymap (27 keymap ; @r{Note this keymap for @key{ESC} is repeated below.} (83 . center-paragraph) (115 . center-line)) (9 . tab-to-tab-stop))@end group@group ("^[" keymap (83 . center-paragraph) (115 . foo)))@end group@end smallexampleIn the following example, @kbd{C-h} is a prefix key that uses a sparsekeymap starting with @code{(keymap (118 . describe-variable)@dots{})}.Another prefix, @kbd{C-x 4}, uses a keymap which is also the value ofthe variable @code{ctl-x-4-map}. The event @code{mode-line} is one ofseveral dummy events used as prefixes for mouse actions in special partsof a window.@smallexample@group(accessible-keymaps (current-global-map))@result{} (("" keymap [set-mark-command beginning-of-line @dots{} delete-backward-char])@end group@group ("^H" keymap (118 . describe-variable) @dots{} (8 . help-for-help))@end group@group ("^X" keymap [x-flush-mouse-queue @dots{} backward-kill-sentence])@end group@group ("^[" keymap [mark-sexp backward-sexp @dots{} backward-kill-word])@end group ("^X4" keymap (15 . display-buffer) @dots{})@group ([mode-line] keymap (S-mouse-2 . mouse-split-window-horizontally) @dots{}))@end group@end smallexample@noindentThese are not all the keymaps you would see in actuality.@end defun@defun where-is-internal command &optional keymap firstonly noindirectThis function is a subroutine used by the @code{where-is} command(@pxref{Help, , Help, emacs,The GNU Emacs Manual}). It returns a listof key sequences (of any length) that are bound to @var{command} in aset of keymaps.The argument @var{command} can be any object; it is compared with allkeymap entries using @code{eq}.If @var{keymap} is @code{nil}, then the maps used are the current activekeymaps, disregarding @code{overriding-local-map} (that is, pretendingits value is @code{nil}). If @var{keymap} is non-@code{nil}, then themaps searched are @var{keymap} and the global keymap. If @var{keymap}is a list of keymaps, only those keymaps are searched.Usually it's best to use @code{overriding-local-map} as the expressionfor @var{keymap}. Then @code{where-is-internal} searches precisely thekeymaps that are active. To search only the global map, pass@code{(keymap)} (an empty keymap) as @var{keymap}.If @var{firstonly} is @code{non-ascii}, then the value is a singlestring representing the first key sequence found, rather than a list ofall possible key sequences. If @var{firstonly} is @code{t}, then thevalue is the first key sequence, except that key sequences consistingentirely of @sc{ascii} characters (or meta variants of @sc{ascii}characters) are preferred to all other key sequences.If @var{noindirect} is non-@code{nil}, @code{where-is-internal} doesn'tfollow indirect keymap bindings. This makes it possible to search foran indirect definition itself.@smallexample@group(where-is-internal 'describe-function) @result{} ("\^hf" "\^hd")@end group@end smallexample@end defun@deffn Command describe-bindings &optional prefixThis function creates a listing of all current key bindings, anddisplays it in a buffer named @samp{*Help*}. The text is grouped bymodes---minor modes first, then the major mode, then global bindings.If @var{prefix} is non-@code{nil}, it should be a prefix key; then thelisting includes only keys that start with @var{prefix}.The listing describes meta characters as @key{ESC} followed by thecorresponding non-meta character.When several characters with consecutive @sc{ascii} codes have thesame definition, they are shown together, as@samp{@var{firstchar}..@var{lastchar}}. In this instance, you need toknow the @sc{ascii} codes to understand which characters this means.For example, in the default global map, the characters @samp{@key{SPC}..@: ~} are described by a single line. @key{SPC} is @sc{ascii} 32,@kbd{~} is @sc{ascii} 126, and the characters between them include allthe normal printing characters, (e.g., letters, digits, punctuation,etc.@:); all these characters are bound to @code{self-insert-command}.@end deffn@node Menu Keymaps@section Menu Keymaps@cindex menu keymaps@c Emacs 19 featureA keymap can define a menu as well as bindings for keyboard keys andmouse button. Menus are usually actuated with the mouse, but they canwork with the keyboard also.@menu* Defining Menus:: How to make a keymap that defines a menu.* Mouse Menus:: How users actuate the menu with the mouse.* Keyboard Menus:: How they actuate it with the keyboard.* Menu Example:: Making a simple menu.* Menu Bar:: How to customize the menu bar.* Tool Bar:: A tool bar is a row of images.* Modifying Menus:: How to add new items to a menu.@end menu@node Defining Menus@subsection Defining Menus@cindex defining menus@cindex menu prompt string@cindex prompt string (of menu)A keymap is suitable for menu use if it has an @dfn{overall promptstring}, which is a string that appears as an element of the keymap.(@xref{Format of Keymaps}.) The string should describe the purpose ofthe menu's commands. Emacs displays the overall prompt string as themenu title in some cases, depending on the toolkit (if any) used fordisplaying menus.@footnote{It is required for menus which do not use atoolkit, e.g.@: under MS-DOS.} Keyboard menus also display the overallprompt string.The easiest way to construct a keymap with a prompt string is to specifythe string as an argument when you call @code{make-keymap},@code{make-sparse-keymap} or @code{define-prefix-command}(@pxref{Creating Keymaps}).The order of items in the menu is the same as the order of bindings inthe keymap. Since @code{define-key} puts new bindings at the front, youshould define the menu items starting at the bottom of the menu andmoving to the top, if you care about the order. When you add an item toan existing menu, you can specify its position in the menu using@code{define-key-after} (@pxref{Modifying Menus}).@menu* Simple Menu Items:: A simple kind of menu key binding, limited in capabilities.* Extended Menu Items:: More powerful menu item definitions let you specify keywords to enable various features.* Menu Separators:: Drawing a horizontal line through a menu.* Alias Menu Items:: Using command aliases in menu items.@end menu@node Simple Menu Items@subsubsection Simple Menu Items The simpler and older way to define a menu keymap bindinglooks like this:@example(@var{item-string} . @var{real-binding})@end example@noindentThe @sc{car}, @var{item-string}, is the string to be displayed in themenu. It should be short---preferably one to three words. It shoulddescribe the action of the command it corresponds to.You can also supply a second string, called the help string, as follows:@example(@var{item-string} @var{help} . @var{real-binding})@end example@var{help} specifies a ``help-echo'' string to display while the mouseis on that item in the same way as @code{help-echo} text properties(@pxref{Help display}).As far as @code{define-key} is concerned, @var{item-string} and@var{help-string} are part of the event's binding. However,@code{lookup-key} returns just @var{real-binding}, and only@var{real-binding} is used for executing the key.If @var{real-binding} is @code{nil}, then @var{item-string} appears inthe menu but cannot be selected.If @var{real-binding} is a symbol and has a non-@code{nil}@code{menu-enable} property, that property is an expression thatcontrols whether the menu item is enabled. Every time the keymap isused to display a menu, Emacs evaluates the expression, and it enablesthe menu item only if the expression's value is non-@code{nil}. When amenu item is disabled, it is displayed in a ``fuzzy'' fashion, andcannot be selected.The menu bar does not recalculate which items are enabled every time youlook at a menu. This is because the X toolkit requires the whole treeof menus in advance. To force recalculation of the menu bar, call@code{force-mode-line-update} (@pxref{Mode Line Format}).You've probably noticed that menu items show the equivalent keyboard keysequence (if any) to invoke the same command. To save time onrecalculation, menu display caches this information in a sublist in thebinding, like this:@c This line is not too long--rms.@example(@var{item-string} @r{[}@var{help-string}@r{]} (@var{key-binding-data}) . @var{real-binding})@end example@noindentDon't put these sublists in the menu item yourself; menu displaycalculates them automatically. Don't mention keyboard equivalents inthe item strings themselves, since that is redundant.@node Extended Menu Items@subsubsection Extended Menu Items@kindex menu-item An extended-format menu item is a more flexible and also cleaneralternative to the simple format. It consists of a list that startswith the symbol @code{menu-item}. To define a non-selectable string,the item looks like this:@example(menu-item @var{item-name})@end example@noindentA string starting with two or more dashes specifies a separator line;see @ref{Menu Separators}. To define a real menu item which can be selected, the extended formatitem looks like this:@example(menu-item @var{item-name} @var{real-binding} . @var{item-property-list})@end example@noindentHere, @var{item-name} is an expression which evaluates to the menu itemstring. Thus, the string need not be a constant. The third element,@var{real-binding}, is the command to execute. The tail of the list,@var{item-property-list}, has the form of a property list which containsother information. Here is a table of the properties that are supported:@table @code@item :enable @var{form}The result of evaluating @var{form} determines whether the item isenabled (non-@code{nil} means yes). If the item is not enabled,you can't really click on it.@item :visible @var{form}The result of evaluating @var{form} determines whether the item shouldactually appear in the menu (non-@code{nil} means yes). If the itemdoes not appear, then the menu is displayed as if this item werenot defined at all.@item :help @var{help}The value of this property, @var{help}, specifies a ``help-echo'' stringto display while the mouse is on that item. This is displayed in thesame way as @code{help-echo} text properties (@pxref{Help display}).Note that this must be a constant string, unlike the @code{help-echo}property for text and overlays.@item :button (@var{type} . @var{selected})This property provides a way to define radio buttons and toggle buttons.The @sc{car}, @var{type}, says which: it should be @code{:toggle} or@code{:radio}. The @sc{cdr}, @var{selected}, should be a form; theresult of evaluating it says whether this button is currently selected.A @dfn{toggle} is a menu item which is labeled as either ``on'' or ``off''according to the value of @var{selected}. The command itself shouldtoggle @var{selected}, setting it to @code{t} if it is @code{nil},and to @code{nil} if it is @code{t}. Here is how the menu itemto toggle the @code{debug-on-error} flag is defined:@example(menu-item "Debug on Error" toggle-debug-on-error :button (:toggle . (and (boundp 'debug-on-error) debug-on-error)))@end example@noindentThis works because @code{toggle-debug-on-error} is defined as a commandwhich toggles the variable @code{debug-on-error}.@dfn{Radio buttons} are a group of menu items, in which at any time oneand only one is ``selected.'' There should be a variable whose valuesays which one is selected at any time. The @var{selected} form foreach radio button in the group should check whether the variable has theright value for selecting that button. Clicking on the button shouldset the variable so that the button you clicked on becomes selected.@item :key-sequence @var{key-sequence}This property specifies which key sequence is likely to be bound to thesame command invoked by this menu item. If you specify the right keysequence, that makes preparing the menu for display run much faster.If you specify the wrong key sequence, it has no effect; before Emacsdisplays @var{key-sequence} in the menu, it verifies that@var{key-sequence} is really equivalent to this menu item.@item :key-sequence nilThis property indicates that there is normally no key binding which isequivalent to this menu item. Using this property saves time inpreparing the menu for display, because Emacs does not need to searchthe keymaps for a keyboard equivalent for this menu item.However, if the user has rebound this item's definition to a keysequence, Emacs ignores the @code{:keys} property and finds the keyboardequivalent anyway.@item :keys @var{string}This property specifies that @var{string} is the string to displayas the keyboard equivalent for this menu item. You can usethe @samp{\\[...]} documentation construct in @var{string}.@item :filter @var{filter-fn}This property provides a way to compute the menu item dynamically.The property value @var{filter-fn} should be a function of one argument;when it is called, its argument will be @var{real-binding}. Thefunction should return the binding to use instead.@end table@node Menu Separators@subsubsection Menu Separators@cindex menu separators A menu separator is a kind of menu item that doesn't display anytext--instead, it divides the menu into subparts with a horizontal line.A separator looks like this in the menu keymap:@example(menu-item @var{separator-type})@end example@noindentwhere @var{separator-type} is a string starting with two or more dashes. In the simplest case, @var{separator-type} consists of only dashes.That specifies the default kind of separator. (For compatibility,@code{""} and @code{-} also count as separators.) Starting in Emacs 21, certain other values of @var{separator-type}specify a different style of separator. Here is a table of them:@table @code@item "--no-line"@itemx "--space"An extra vertical space, with no actual line.@item "--single-line"A single line in the menu's foreground color.@item "--double-line"A double line in the menu's foreground color.@item "--single-dashed-line"A single dashed line in the menu's foreground color.@item "--double-dashed-line"A double dashed line in the menu's foreground color.@item "--shadow-etched-in"A single line with a 3D sunken appearance. This is the default,used separators consisting of dashes only.@item "--shadow-etched-out"A single line with a 3D raised appearance.@item "--shadow-etched-in-dash"A single dashed line with a 3D sunken appearance.@item "--shadow-etched-out-dash"A single dashed line with a 3D raised appearance.@item "--shadow-double-etched-in"Two lines with a 3D sunken appearance.@item "--shadow-double-etched-out"Two lines with a 3D raised appearance.@item "--shadow-double-etched-in-dash"Two dashed lines with a 3D sunken appearance.@item "--shadow-double-etched-out-dash"Two dashed lines with a 3D raised appearance.@end table You can also give these names in another style, adding a colon afterthe double-dash and replacing each single dash with capitalization ofthe following word. Thus, @code{"--:singleLine"}, is equivalent to@code{"--single-line"}. Some systems and display toolkits don't really handle all of theseseparator types. If you use a type that isn't supported, the menudisplays a similar kind of separator that is supported.@node Alias Menu Items@subsubsection Alias Menu Items Sometimes it is useful to make menu items that use the ``same''command but with different enable conditions. The best way to do thisin Emacs now is with extended menu items; before that feature existed,it could be done by defining alias commands and using them in menuitems. Here's an example that makes two aliases for@code{toggle-read-only} and gives them different enable conditions:@example(defalias 'make-read-only 'toggle-read-only)(put 'make-read-only 'menu-enable '(not buffer-read-only))(defalias 'make-writable 'toggle-read-only)(put 'make-writable 'menu-enable 'buffer-read-only)@end exampleWhen using aliases in menus, often it is useful to display theequivalent key bindings for the ``real'' command name, not the aliases(which typically don't have any key bindings except for the menuitself). To request this, give the alias symbol a non-@code{nil}@code{menu-alias} property. Thus,@example(put 'make-read-only 'menu-alias t)(put 'make-writable 'menu-alias t)@end example@noindentcauses menu items for @code{make-read-only} and @code{make-writable} toshow the keyboard bindings for @code{toggle-read-only}.@node Mouse Menus@subsection Menus and the Mouse The usual way to make a menu keymap produce a menu is to make it thedefinition of a prefix key. (A Lisp program can explicitly pop up amenu and receive the user's choice---see @ref{Pop-Up Menus}.) If the prefix key ends with a mouse event, Emacs handles the menu keymapby popping up a visible menu, so that the user can select a choice withthe mouse. When the user clicks on a menu item, the event generated iswhatever character or symbol has the binding that brought about thatmenu item. (A menu item may generate a series of events if the menu hasmultiple levels or comes from the menu bar.) It's often best to use a button-down event to trigger the menu. Thenthe user can select a menu item by releasing the button. A single keymap can appear as multiple menu panes, if you explicitlyarrange for this. The way to do this is to make a keymap for each pane,then create a binding for each of those maps in the main keymap of themenu. Give each of these bindings an item string that starts with@samp{@@}. The rest of the item string becomes the name of the pane.See the file @file{lisp/mouse.el} for an example of this. Any ordinarybindings with @samp{@@}-less item strings are grouped into one pane,which appears along with the other panes explicitly created for thesubmaps. X toolkit menus don't have panes; instead, they can have submenus.Every nested keymap becomes a submenu, whether the item string startswith @samp{@@} or not. In a toolkit version of Emacs, the only thingspecial about @samp{@@} at the beginning of an item string is that the@samp{@@} doesn't appear in the menu item. You can also produce multiple panes or submenus from separate keymaps.The full definition of a prefix key always comes from merging thedefinitions supplied by the various active keymaps (minor mode, local,and global). When more than one of these keymaps is a menu, each ofthem makes a separate pane or panes (when Emacs does not use anX-toolkit) or a separate submenu (when using an X-toolkit).@xref{Active Keymaps}.@node Keyboard Menus@subsection Menus and the KeyboardWhen a prefix key ending with a keyboard event (a character or functionkey) has a definition that is a menu keymap, the user can use thekeyboard to choose a menu item.Emacs displays the menu's overall prompt string followed by thealternatives (the item strings of the bindings) in the echo area. Ifthe bindings don't all fit at once, the user can type @key{SPC} to seethe next line of alternatives. Successive uses of @key{SPC} eventuallyget to the end of the menu and then cycle around to the beginning. (Thevariable @code{menu-prompt-more-char} specifies which character is usedfor this; @key{SPC} is the default.)When the user has found the desired alternative from the menu, he or sheshould type the corresponding character---the one whose binding is thatalternative.@ignoreIn a menu intended for keyboard use, each menu item must clearlyindicate what character to type. The best convention to use is to makethe character the first letter of the item string---that is somethingusers will understand without being told. We plan to change this; bythe time you read this manual, keyboard menus may explicitly name thekey for each alternative.@end ignoreThis way of using menus in an Emacs-like editor was inspired by theHierarkey system.@defvar menu-prompt-more-charThis variable specifies the character to use to ask to seethe next line of a menu. Its initial value is 32, the codefor @key{SPC}.@end defvar@node Menu Example@subsection Menu Example@cindex menu definition example Here is a complete example of defining a menu keymap. It is thedefinition of the @samp{Print} submenu in the @samp{Tools} menu in themenu bar, and it uses the simple menu item format (@pxref{Simple MenuItems}). First we create the keymap, and give it a name:@example(defvar menu-bar-print-menu (make-sparse-keymap "Print"))@end example@noindentNext we define the menu items:@example(define-key menu-bar-print-menu [ps-print-region] '("Postscript Print Region" . ps-print-region-with-faces))(define-key menu-bar-print-menu [ps-print-buffer] '("Postscript Print Buffer" . ps-print-buffer-with-faces))(define-key menu-bar-print-menu [separator-ps-print] '("--"))(define-key menu-bar-print-menu [print-region] '("Print Region" . print-region))(define-key menu-bar-print-menu [print-buffer] '("Print Buffer" . print-buffer))@end example@noindentNote the symbols which the bindings are ``made for''; these appearinside square brackets, in the key sequence being defined. In somecases, this symbol is the same as the command name; sometimes it isdifferent. These symbols are treated as ``function keys'', but they arenot real function keys on the keyboard. They do not affect thefunctioning of the menu itself, but they are ``echoed'' in the echo areawhen the user selects from the menu, and they appear in the output of@code{where-is} and @code{apropos}. The binding whose definition is @code{("--")} is a separator line.Like a real menu item, the separator has a key symbol, in this case@code{separator-ps-print}. If one menu has two separators, they musthave two different key symbols. Here is code to define enable conditions for two of the commands inthe menu:@example(put 'print-region 'menu-enable 'mark-active)(put 'ps-print-region-with-faces 'menu-enable 'mark-active)@end example Here is how we make this menu appear as an item in the parent menu:@example(define-key menu-bar-tools-menu [print] (cons "Print" menu-bar-print-menu))@end example@noindentNote that this incorporates the submenu keymap, which is the value ofthe variable @code{menu-bar-print-menu}, rather than the symbol@code{menu-bar-print-menu} itself. Using that symbol in the parent menuitem would be meaningless because @code{menu-bar-print-menu} is not acommand. If you wanted to attach the same print menu to a mouse click, youcan do it this way:@example(define-key global-map [C-S-down-mouse-1] menu-bar-print-menu)@end example We could equally well use an extended menu item (@pxref{Extended MenuItems}) for @code{print-region}, like this:@example(define-key menu-bar-print-menu [print-region] '(menu-item "Print Region" print-region :enable mark-active))@end example@noindentWith the extended menu item, the enable condition is specifiedinside the menu item itself. If we wanted to make thisitem disappear from the menu entirely when the mark is inactive,we could do it this way:@example(define-key menu-bar-print-menu [print-region] '(menu-item "Print Region" print-region :visible mark-active))@end example@node Menu Bar@subsection The Menu Bar@cindex menu bar Most window systems allow each frame to have a @dfn{menu bar}---apermanently displayed menu stretching horizontally across the top of theframe. The items of the menu bar are the subcommands of the fake``function key'' @code{menu-bar}, as defined by all the active keymaps. To add an item to the menu bar, invent a fake ``function key'' of yourown (let's call it @var{key}), and make a binding for the key sequence@code{[menu-bar @var{key}]}. Most often, the binding is a menu keymap,so that pressing a button on the menu bar item leads to another menu. When more than one active keymap defines the same fake function keyfor the menu bar, the item appears just once. If the user clicks onthat menu bar item, it brings up a single, combined menu containingall the subcommands of that item---the global subcommands, the localsubcommands, and the minor mode subcommands. The variable @code{overriding-local-map} is normally ignored whendetermining the menu bar contents. That is, the menu bar is computedfrom the keymaps that would be active if @code{overriding-local-map}were @code{nil}. @xref{Active Keymaps}. In order for a frame to display a menu bar, its @code{menu-bar-lines}parameter must be greater than zero. Emacs uses just one line for themenu bar itself; if you specify more than one line, the other linesserve to separate the menu bar from the windows in the frame. Werecommend 1 or 2 as the value of @code{menu-bar-lines}. @xref{Window FrameParameters}. Here's an example of setting up a menu bar item:@example@group(modify-frame-parameters (selected-frame) '((menu-bar-lines . 2)))@end group@group;; @r{Make a menu keymap (with a prompt string)};; @r{and make it the menu bar item's definition.}(define-key global-map [menu-bar words] (cons "Words" (make-sparse-keymap "Words")))@end group@group;; @r{Define specific subcommands in this menu.}(define-key global-map [menu-bar words forward] '("Forward word" . forward-word))@end group@group(define-key global-map [menu-bar words backward] '("Backward word" . backward-word))@end group@end example A local keymap can cancel a menu bar item made by the global keymap byrebinding the same fake function key with @code{undefined} as thebinding. For example, this is how Dired suppresses the @samp{Edit} menubar item:@example(define-key dired-mode-map [menu-bar edit] 'undefined)@end example@noindent@code{edit} is the fake function key used by the global map for the@samp{Edit} menu bar item. The main reason to suppress a globalmenu bar item is to regain space for mode-specific items.@defvar menu-bar-final-itemsNormally the menu bar shows global items followed by items defined by thelocal maps.This variable holds a list of fake function keys for items to display atthe end of the menu bar rather than in normal sequence. The defaultvalue is @code{(help-menu)}; thus, the @samp{Help} menu item normally appearsat the end of the menu bar, following local menu items.@end defvar@defvar menu-bar-update-hookThis normal hook is run whenever the user clicks on the menu bar, beforedisplaying a submenu. You can use it to update submenus whose contentsshould vary.@end defvar@node Tool Bar@subsection Tool bars@cindex tool bar A @dfn{tool bar} is a row of icons at the top of a frame, that executecommands when you click on them---in effect, a kind of graphical menubar. Emacs supports tool bars starting with version 21. The frame parameter @code{tool-bar-lines} (X resource @samp{toolBar})controls how many lines' worth of height to reserve for the tool bar. Azero value suppresses the tool bar. If the value is nonzero, and@code{auto-resize-tool-bars} is non-@code{nil}, the tool bar expands andcontracts automatically as needed to hold the specified contents. The tool bar contents are controlled by a menu keymap attached to afake ``function key'' called @code{tool-bar} (much like the way the menubar is controlled). So you define a tool bar item using@code{define-key}, like this:@example(define-key global-map [tool-bar @var{key}] @var{item})@end example@noindentwhere @var{key} is a fake ``function key'' to distinguish this item fromother items, and @var{item} is a menu item key binding (@pxref{ExtendedMenu Items}), which says how to display this item and how it behaves. The usual menu keymap item properties, @code{:visible},@code{:enable}, @code{:button}, and @code{:filter}, are useful intool bar bindings and have their normal meanings. The @var{real-binding}in the item must be a command, not a keymap; in other words, it does notwork to define a tool bar icon as a prefix key. The @code{:help} property specifies a ``help-echo'' string to displaywhile the mouse is on that item. This is displayed in the same way as@code{help-echo} text properties (@pxref{Help display}). In addition, you should use the @code{:image} property;this is how you specify the image to display in the tool bar:@table @code@item :image @var{image}@var{images} is either a single image specification or a vector of fourimage specifications. If you use a vector of four,one of them is used, depending on circumstances:@table @asis@item item 0Used when the item is enabled and selected.@item item 1Used when the item is enabled and deselected.@item item 2Used when the item is disabled and selected.@item item 3Used when the item is disabled and deselected.@end table@end tableIf @var{image} is a single image specification, Emacs draws the tool barbutton in disabled state by applying an edge-detection algorithm to theimage.The default tool bar is defined so that items specific to editing do notappear for major modes whose command symbol has a @code{mode-class}property of @code{special} (@pxref{Major Mode Conventions}). Majormodes may add items to the global bar by binding @code{[tool-bar@var{foo}]} in their local map. It makes sense for some major modes toreplace the default tool bar items completely, since not many can beaccommodated conveniently, and the default bindings make this easy byusing an indirection through @code{tool-bar-map}.@defvar tool-bar-map@tindex tool-bar-mapBy default, the global map binds @code{[tool-bar]} as follows:@example(global-set-key [tool-bar] '(menu-item "tool bar" ignore :filter (lambda (ignore) tool-bar-map)))@end example@noindentThus the tool bar map is derived dynamically from the value of variable@code{tool-bar-map} and you should normally adjust the default (global)tool bar by changing that map. Major modes may replace the global barcompletely by making @code{tool-bar-map} buffer-local and set to akeymap containing only the desired items. Info mode provides anexample.@end defvarThere are two convenience functions for defining tool bar items, asfollows.@defun tool-bar-add-item icon def key &rest props@tindex tool-bar-add-itemThis function adds an item to the tool bar by modifying@code{tool-bar-map}. The image to use is defined by @var{icon}, whichis the base name of an XPM, XBM or PBM image file to located by@code{find-image}. Given a value @samp{"exit"}, say, @file{exit.xpm},@file{exit.pbm} and @file{exit.xbm} would be searched for in that orderon a color display. On a monochrome display, the search order is@samp{.pbm}, @samp{.xbm} and @samp{.xpm}. The binding to use is thecommand @var{def}, and @var{key} is the fake function key symbol in theprefix keymap. The remaining arguments @var{props} are additionalproperty list elements to add to the menu item specification.To define items in some local map, bind @code{`tool-bar-map} with@code{let} around calls of this function:@example(defvar foo-tool-bar-map (let ((tool-bar-map (make-sparse-keymap))) (tool-bar-add-item @dots{}) @dots{} tool-bar-map))@end example@end defun@defun tool-bar-add-item-from-menu command icon &optional map &rest props@tindex tool-bar-add-item-from-menuThis command is a convenience for defining tool bar items which areconsistent with existing menu bar bindings. The binding of@var{command} is looked up in the menu bar in @var{map} (default@code{global-map}) and modified to add an image specification for@var{icon}, which is looked for in the same way as by@code{tool-bar-add-item}. The resulting binding is then placed in@code{tool-bar-map}. @var{map} must contain an appropriate keymap boundto @code{[menu-bar]}. The remaining arguments @var{props} areadditional property list elements to add to the menu item specification.@end defun@tindex auto-resize-tool-bar@defvar auto-resize-tool-barIf this variable is non-@code{nil}, the tool bar automatically resizes toshow all defined tool bar items---but not larger than a quarter of theframe's height.@end defvar@tindex auto-raise-tool-bar-items@defvar auto-raise-tool-bar-itemsIf this variable is non-@code{nil}, tool bar items displayin raised form when the mouse moves over them.@end defvar@tindex tool-bar-item-margin@defvar tool-bar-item-marginThis variable specifies an extra margin to add around tool bar items.The value is an integer, a number of pixels. The default is 1.@end defvar@tindex tool-bar-item-relief@defvar tool-bar-item-reliefThis variable specifies the shadow width for tool bar items.The value is an integer, a number of pixels. The default is 3.@end defvar You can define a special meaning for clicking on a tool bar item withthe shift, control, meta, etc., modifiers. You do this by setting upadditional items that relate to the original item through the fakefunction keys. Specifically, the additional items should use themodified versions of the same fake function key used to name theoriginal item. Thus, if the original item was defined this way,@example(define-key global-map [tool-bar shell] '(menu-item "Shell" shell :image (image :type xpm :file "shell.xpm")))@end example@noindentthen here is how you can define clicking on the same tool bar image withthe shift modifier:@example(define-key global-map [tool-bar S-shell] 'some-command)@end example@xref{Function Keys}, for more information about how to add modifiers tofunction keys.@node Modifying Menus@subsection Modifying Menus When you insert a new item in an existing menu, you probably want toput it in a particular place among the menu's existing items. If youuse @code{define-key} to add the item, it normally goes at the front ofthe menu. To put it elsewhere in the menu, use @code{define-key-after}:@defun define-key-after map key binding &optional afterDefine a binding in @var{map} for @var{key}, with value @var{binding},just like @code{define-key}, but position the binding in @var{map} afterthe binding for the event @var{after}. The argument @var{key} should beof length one---a vector or string with just one element. But@var{after} should be a single event type---a symbol or a character, nota sequence. The new binding goes after the binding for @var{after}. If@var{after} is @code{t} or is omitted, then the new binding goes last, atthe end of the keymap. However, new bindings are added before anyinherited keymap.Here is an example:@example(define-key-after my-menu [drink] '("Drink" . drink-command) 'eat)@end example@noindentmakes a binding for the fake function key @key{DRINK} and puts itright after the binding for @key{EAT}.Here is how to insert an item called @samp{Work} in the @samp{Signals}menu of Shell mode, after the item @code{break}:@example(define-key-after (lookup-key shell-mode-map [menu-bar signals]) [work] '("Work" . work-command) 'break)@end example@end defun