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