lispref/maps.texi

   1 @c -*-texinfo-*-
   2 @c This is part of the GNU Emacs Lisp Reference Manual.
   3 @c Copyright (C) 1990, 1991, 1992, 1993, 1999, 2002, 2003, 2004,
   4 @c   2005, 2006 Free Software Foundation, Inc.
   5 @c See the file elisp.texi for copying conditions.
   6 @setfilename ../info/maps
   7 @node Standard Keymaps, Standard Hooks, Standard Buffer-Local Variables, Top
   8 @appendix Standard Keymaps
   9
  10 The following symbols are used as the names for various keymaps.
  11 Some of these exist when Emacs is first started, others are
  12 loaded only when their respective mode is used.  This is not
  13 an exhaustive list.
  14
  15 Several keymaps are used in the minibuffer.  @xref{Completion Commands}.
  16
  17 Almost all of these maps are used as local maps.  Indeed, of the modes
  18 that presently exist, only Vip mode and Terminal mode ever change the
  19 global keymap.
  20
  21 @table @code
  22 @item apropos-mode-map
  23 @vindex apropos-mode-map
  24 A sparse keymap for @code{apropos} buffers.
  25
  26 @item Buffer-menu-mode-map
  27 @vindex Buffer-menu-mode-map
  28 A full keymap used by Buffer Menu mode.
  29
  30 @item c-mode-map
  31 @vindex c-mode-map
  32 A sparse keymap used by C mode.
  33
  34 @item command-history-map
  35 @vindex command-history-map
  36 A full keymap used by Command History mode.
  37
  38 @item ctl-x-4-map
  39 A sparse keymap for subcommands of the prefix @kbd{C-x 4}.
  40
  41 @item ctl-x-5-map
  42 A sparse keymap for subcommands of the prefix @kbd{C-x 5}.
  43
  44 @item ctl-x-map
  45 A full keymap for @kbd{C-x} commands.
  46
  47 @item custom-mode-map
  48 A full keymap for Custom mode.
  49
  50 @item debugger-mode-map
  51 @vindex debugger-mode-map
  52 A full keymap used by Debugger mode.
  53
  54 @item dired-mode-map
  55 @vindex dired-mode-map
  56 A full keymap for @code{dired-mode} buffers.
  57
  58 @item edit-abbrevs-map
  59 @vindex edit-abbrevs-map
  60 A sparse keymap used in @code{edit-abbrevs}.
  61
  62 @item edit-tab-stops-map
  63 @vindex edit-tab-stops-map
  64 A sparse keymap used in @code{edit-tab-stops}.
  65
  66 @item electric-buffer-menu-mode-map
  67 @vindex electric-buffer-menu-mode-map
  68 A full keymap used by Electric Buffer Menu mode.
  69
  70 @item electric-history-map
  71 @vindex electric-history-map
  72 A full keymap used by Electric Command History mode.
  73
  74 @item emacs-lisp-mode-map
  75 @vindex emacs-lisp-mode-map
  76 A sparse keymap used by Emacs Lisp mode.
  77
  78 @item esc-map
  79 @vindex esc-map
  80 A full keymap for @kbd{ESC} (or @kbd{Meta}) commands.
  81
  82 @item facemenu-menu
  83 @vindex facemenu-menu
  84 The sparse keymap that displays the Text Properties menu.
  85
  86 @item facemenu-background-menu
  87 @vindex facemenu-background-menu
  88 The sparse keymap that displays the Background Color submenu of the Text
  89 Properties menu.
  90
  91 @item facemenu-face-menu
  92 @vindex facemenu-face-menu
  93 The sparse keymap that displays the Face submenu of the Text Properties menu.
  94
  95 @item facemenu-foreground-menu
  96 @vindex facemenu-foreground-menu
  97 The sparse keymap that displays the Foreground Color submenu of the Text
  98 Properties menu.
  99
 100 @item facemenu-indentation-menu
 101 @vindex facemenu-indentation-menu
 102 The sparse keymap that displays the Indentation submenu of the Text
 103 Properties menu.
 104
 105 @item facemenu-justification-menu
 106 @vindex facemenu-justification-menu
 107 The sparse keymap that displays the Justification submenu of the Text
 108 Properties menu.
 109
 110 @item facemenu-special-menu
 111 @vindex facemenu-special-menu
 112 The sparse keymap that displays the Special Props submenu of the Text
 113 Properties menu.
 114
 115 @item function-key-map
 116 The keymap for translating keypad and function keys.@*
 117 If there are none, then it contains an empty sparse keymap.
 118 @xref{Translation Keymaps}.
 119
 120 @item fundamental-mode-map
 121 @vindex fundamental-mode-map
 122 The sparse keymap for Fundamental mode.@*
 123 It is empty and should not be changed.
 124
 125 @item global-map
 126 The full keymap containing default global key bindings.@*
 127 Modes should not modify the Global map.
 128
 129 @item grep-mode-map
 130 @vindex grep-mode-map
 131 The keymap for @code{grep-mode} buffers.
 132
 133 @item help-map
 134 The sparse keymap for the keys that follow the help character @kbd{C-h}.
 135
 136 @item help-mode-map
 137 @vindex help-mode-map
 138 The sparse keymap for Help mode.
 139
 140 @item Helper-help-map
 141 @vindex Helper-help-map
 142 A full keymap used by the help utility package.@*
 143 It has the same keymap in its value cell and in its function
 144 cell.
 145
 146 @item Info-edit-map
 147 @vindex Info-edit-map
 148 A sparse keymap used by the @kbd{e} command of Info.
 149
 150 @item Info-mode-map
 151 @vindex Info-mode-map
 152 A sparse keymap containing Info commands.
 153
 154 @item isearch-mode-map
 155 @vindex isearch-mode-map
 156 A keymap that defines the characters you can type within incremental
 157 search.
 158
 159 @item key-translation-map
 160 A keymap for translating keys.  This one overrides ordinary key
 161 bindings, unlike @code{function-key-map}.  @xref{Translation Keymaps}.
 162
 163 @item kmacro-map
 164 @vindex kmacro-map
 165 A sparse keymap for keys that follows the @kbd{C-x C-k} prefix
 166 search.
 167
 168 @item lisp-interaction-mode-map
 169 @vindex lisp-interaction-mode-map
 170 A sparse keymap used by Lisp Interaction mode.
 171
 172 @item lisp-mode-map
 173 @vindex lisp-mode-map
 174 A sparse keymap used by Lisp mode.
 175
 176 @item menu-bar-edit-menu
 177 @vindex menu-bar-edit-menu
 178 The keymap which displays the Edit menu in the menu bar.
 179
 180 @item menu-bar-files-menu
 181 @vindex menu-bar-files-menu
 182 The keymap which displays the Files menu in the menu bar.
 183
 184 @item menu-bar-help-menu
 185 @vindex menu-bar-help-menu
 186 The keymap which displays the Help menu in the menu bar.
 187
 188 @item menu-bar-mule-menu
 189 @vindex menu-bar-mule-menu
 190 The keymap which displays the Mule menu in the menu bar.
 191
 192 @item menu-bar-search-menu
 193 @vindex menu-bar-search-menu
 194 The keymap which displays the Search menu in the menu bar.
 195
 196 @item menu-bar-tools-menu
 197 @vindex menu-bar-tools-menu
 198 The keymap which displays the Tools menu in the menu bar.
 199
 200 @item mode-specific-map
 201 The keymap for characters following @kbd{C-c}.  Note, this is in the
 202 global map.  This map is not actually mode specific: its name was chosen
 203 to be informative for the user in @kbd{C-h b} (@code{display-bindings}),
 204 where it describes the main use of the @kbd{C-c} prefix key.
 205
 206 @item occur-mode-map
 207 @vindex occur-mode-map
 208 A sparse keymap used by Occur mode.
 209
 210 @item query-replace-map
 211 A sparse keymap used for responses in @code{query-replace} and related
 212 commands; also for @code{y-or-n-p} and @code{map-y-or-n-p}.  The functions
 213 that use this map do not support prefix keys; they look up one event at a
 214 time.
 215
 216 @item text-mode-map
 217 @vindex text-mode-map
 218 A sparse keymap used by Text mode.
 219
 220 @item tool-bar-map
 221 The keymap defining the contents of the tool bar.
 222
 223 @item view-mode-map
 224 @vindex view-mode-map
 225 A full keymap used by View mode.
 226 @end table
 227
 228 @ignore
 229    arch-tag: b741253c-7e23-4a02-b3fa-cffd9e4d72b9
 230 @end ignore