doc/lispref/maps.texi

   1 @c -*-texinfo-*-
   2 @c This is part of the GNU Emacs Lisp Reference Manual.
   3 @c Copyright (C) 1990-1993, 1999, 2001-2011  Free Software Foundation, Inc.
   4 @c See the file elisp.texi for copying conditions.
   5 @setfilename ../../info/maps
   6 @node Standard Keymaps, Standard Hooks, Standard Buffer-Local Variables, Top
   7 @appendix Standard Keymaps
   8 @cindex 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 A full keymap for @kbd{ESC} (or @kbd{Meta}) commands.
  80
  81 @item facemenu-menu
  82 @vindex facemenu-menu
  83 The sparse keymap that displays the Text Properties menu.
  84
  85 @item facemenu-background-menu
  86 @vindex facemenu-background-menu
  87 The sparse keymap that displays the Background Color submenu of the Text
  88 Properties menu.
  89
  90 @item facemenu-face-menu
  91 @vindex facemenu-face-menu
  92 The sparse keymap that displays the Face submenu of the Text Properties menu.
  93
  94 @item facemenu-foreground-menu
  95 @vindex facemenu-foreground-menu
  96 The sparse keymap that displays the Foreground Color submenu of the Text
  97 Properties menu.
  98
  99 @item facemenu-indentation-menu
 100 @vindex facemenu-indentation-menu
 101 The sparse keymap that displays the Indentation submenu of the Text
 102 Properties menu.
 103
 104 @item facemenu-justification-menu
 105 @vindex facemenu-justification-menu
 106 The sparse keymap that displays the Justification submenu of the Text
 107 Properties menu.
 108
 109 @item facemenu-special-menu
 110 @vindex facemenu-special-menu
 111 The sparse keymap that displays the Special Props submenu of the Text
 112 Properties menu.
 113
 114 @item local-function-key-map
 115 The keymap for translating key sequences to preferred alternatives.@*
 116 If there are none, then it contains an empty sparse keymap.
 117 @xref{Translation Keymaps}.
 118
 119 @item fundamental-mode-map
 120 @vindex fundamental-mode-map
 121 The sparse keymap for Fundamental mode.@*
 122 It is empty and should not be changed.
 123
 124 @item global-map
 125 The full keymap containing default global key bindings.@*
 126 Modes should not modify the Global map.
 127
 128 @item grep-mode-map
 129 @vindex grep-mode-map
 130 The keymap for @code{grep-mode} buffers.
 131
 132 @item help-map
 133 The sparse keymap for the keys that follow the help character @kbd{C-h}.
 134
 135 @item help-mode-map
 136 @vindex help-mode-map
 137 The sparse keymap for Help mode.
 138
 139 @item Helper-help-map
 140 @vindex Helper-help-map
 141 A full keymap used by the help utility package.@*
 142 It has the same keymap in its value cell and in its function
 143 cell.
 144
 145 @item Info-edit-map
 146 @vindex Info-edit-map
 147 A sparse keymap used by the @kbd{e} command of Info.
 148
 149 @item Info-mode-map
 150 @vindex Info-mode-map
 151 A sparse keymap containing Info commands.
 152
 153 @item input-decode-map
 154 The keymap for translating keypad and function keys.@*
 155 If there are none, then it contains an empty sparse keymap.
 156 @xref{Translation Keymaps}.
 157
 158 @item isearch-mode-map
 159 @vindex isearch-mode-map
 160 A keymap that defines the characters you can type within incremental
 161 search.
 162
 163 @item key-translation-map
 164 A keymap for translating keys.  This one overrides ordinary key
 165 bindings, unlike @code{local-function-key-map}.  @xref{Translation
 166 Keymaps}.
 167
 168 @item kmacro-map
 169 @vindex kmacro-map
 170 A sparse keymap for keys that follows the @kbd{C-x C-k} prefix
 171 search.
 172
 173 @item lisp-interaction-mode-map
 174 @vindex lisp-interaction-mode-map
 175 A sparse keymap used by Lisp Interaction mode.
 176
 177 @item lisp-mode-map
 178 @vindex lisp-mode-map
 179 A sparse keymap used by Lisp mode.
 180
 181 @item menu-bar-edit-menu
 182 @vindex menu-bar-edit-menu
 183 The keymap which displays the Edit menu in the menu bar.
 184
 185 @item menu-bar-file-menu
 186 @vindex menu-bar-file-menu
 187 The keymap which displays the File menu in the menu bar.
 188
 189 @item menu-bar-help-menu
 190 @vindex menu-bar-help-menu
 191 The keymap which displays the Help menu in the menu bar.
 192
 193 @item menu-bar-mule-menu
 194 @vindex menu-bar-mule-menu
 195 The keymap which displays the Mule menu in the menu bar.
 196
 197 @item menu-bar-search-menu
 198 @vindex menu-bar-search-menu
 199 The keymap which displays the Search menu in the menu bar.
 200
 201 @item menu-bar-tools-menu
 202 @vindex menu-bar-tools-menu
 203 The keymap which displays the Tools menu in the menu bar.
 204
 205 @item mode-specific-map
 206 The keymap for characters following @kbd{C-c}.  Note, this is in the
 207 global map.  This map is not actually mode specific: its name was chosen
 208 to be informative for the user in @kbd{C-h b} (@code{display-bindings}),
 209 where it describes the main use of the @kbd{C-c} prefix key.
 210
 211 @item multi-query-replace-map
 212 A sparse keymap that extends @code{query-replace-map} for multi-buffer
 213 replacements.  @xref{Search and Replace, query-replace-map}.
 214
 215 @item occur-mode-map
 216 @vindex occur-mode-map
 217 A sparse keymap used by Occur mode.
 218
 219 @item query-replace-map
 220 A sparse keymap used for responses in @code{query-replace} and related
 221 commands; also for @code{y-or-n-p} and @code{map-y-or-n-p}.  The functions
 222 that use this map do not support prefix keys; they look up one event at a
 223 time.
 224
 225 @item search-map
 226 A sparse keymap that provides global bindings for search-related
 227 commands.
 228
 229 @item text-mode-map
 230 @vindex text-mode-map
 231 A sparse keymap used by Text mode.
 232
 233 @item tool-bar-map
 234 The keymap defining the contents of the tool bar.
 235
 236 @item view-mode-map
 237 @vindex view-mode-map
 238 A full keymap used by View mode.
 239 @end table