Mercurial > emacs
annotate lispref/maps.texi @ 79541:bde0c5c8405c
*** empty log message ***
author | Jason Rumney <jasonr@gnu.org> |
---|---|
date | Thu, 06 Dec 2007 17:57:38 +0000 |
parents | 2122b5496349 |
children | a1e16e813aed 4ef881a120fe |
rev | line source |
---|---|
6451 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
75250
6d19c76d81c5
Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents:
72211
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1999, 2001, 2002, 2003, 2004, |
6d19c76d81c5
Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents:
72211
diff
changeset
|
4 @c 2005, 2006, 2007 Free Software Foundation, Inc. |
6451 | 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 | |
76833 | 9 @cindex standard keymaps |
6451 | 10 |
11 The following symbols are used as the names for various keymaps. | |
12 Some of these exist when Emacs is first started, others are | |
7600 | 13 loaded only when their respective mode is used. This is not |
6451 | 14 an exhaustive list. |
15 | |
71912
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
16 Several keymaps are used in the minibuffer. @xref{Completion Commands}. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
17 |
6451 | 18 Almost all of these maps are used as local maps. Indeed, of the modes |
19 that presently exist, only Vip mode and Terminal mode ever change the | |
20 global keymap. | |
21 | |
22 @table @code | |
71912
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
23 @item apropos-mode-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
24 @vindex apropos-mode-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
25 A sparse keymap for @code{apropos} buffers. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
26 |
6451 | 27 @item Buffer-menu-mode-map |
28 @vindex Buffer-menu-mode-map | |
29 A full keymap used by Buffer Menu mode. | |
30 | |
31 @item c-mode-map | |
32 @vindex c-mode-map | |
7600 | 33 A sparse keymap used by C mode. |
6451 | 34 |
35 @item command-history-map | |
36 @vindex command-history-map | |
37 A full keymap used by Command History mode. | |
38 | |
39 @item ctl-x-4-map | |
40 A sparse keymap for subcommands of the prefix @kbd{C-x 4}. | |
41 | |
12098 | 42 @item ctl-x-5-map |
43 A sparse keymap for subcommands of the prefix @kbd{C-x 5}. | |
44 | |
6451 | 45 @item ctl-x-map |
46 A full keymap for @kbd{C-x} commands. | |
47 | |
71912
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
48 @item custom-mode-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
49 A full keymap for Custom mode. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
50 |
6451 | 51 @item debugger-mode-map |
52 @vindex debugger-mode-map | |
53 A full keymap used by Debugger mode. | |
54 | |
55 @item dired-mode-map | |
56 @vindex dired-mode-map | |
57 A full keymap for @code{dired-mode} buffers. | |
58 | |
59 @item edit-abbrevs-map | |
60 @vindex edit-abbrevs-map | |
61 A sparse keymap used in @code{edit-abbrevs}. | |
62 | |
63 @item edit-tab-stops-map | |
64 @vindex edit-tab-stops-map | |
65 A sparse keymap used in @code{edit-tab-stops}. | |
66 | |
67 @item electric-buffer-menu-mode-map | |
68 @vindex electric-buffer-menu-mode-map | |
69 A full keymap used by Electric Buffer Menu mode. | |
70 | |
71 @item electric-history-map | |
72 @vindex electric-history-map | |
73 A full keymap used by Electric Command History mode. | |
74 | |
75 @item emacs-lisp-mode-map | |
76 @vindex emacs-lisp-mode-map | |
7600 | 77 A sparse keymap used by Emacs Lisp mode. |
6451 | 78 |
71912
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
79 @item esc-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
80 A full keymap for @kbd{ESC} (or @kbd{Meta}) commands. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
81 |
12098 | 82 @item facemenu-menu |
83 @vindex facemenu-menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
84 The sparse keymap that displays the Text Properties menu. |
12098 | 85 |
86 @item facemenu-background-menu | |
87 @vindex facemenu-background-menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
88 The sparse keymap that displays the Background Color submenu of the Text |
12098 | 89 Properties menu. |
90 | |
91 @item facemenu-face-menu | |
92 @vindex facemenu-face-menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
93 The sparse keymap that displays the Face submenu of the Text Properties menu. |
12098 | 94 |
95 @item facemenu-foreground-menu | |
96 @vindex facemenu-foreground-menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
97 The sparse keymap that displays the Foreground Color submenu of the Text |
12098 | 98 Properties menu. |
99 | |
100 @item facemenu-indentation-menu | |
101 @vindex facemenu-indentation-menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
102 The sparse keymap that displays the Indentation submenu of the Text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
103 Properties menu. |
12098 | 104 |
105 @item facemenu-justification-menu | |
106 @vindex facemenu-justification-menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
107 The sparse keymap that displays the Justification submenu of the Text |
12098 | 108 Properties menu. |
109 | |
110 @item facemenu-special-menu | |
111 @vindex facemenu-special-menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
112 The sparse keymap that displays the Special Props submenu of the Text |
12098 | 113 Properties menu. |
114 | |
6451 | 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. | |
72211
c2484c5211e4
Update xrefs from Translating Input to Translation Keymaps.
Richard M. Stallman <rms@gnu.org>
parents:
71912
diff
changeset
|
118 @xref{Translation Keymaps}. |
6451 | 119 |
120 @item fundamental-mode-map | |
121 @vindex fundamental-mode-map | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
122 The sparse keymap for Fundamental mode.@* |
6451 | 123 It is empty and should not be changed. |
124 | |
71912
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
125 @item global-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
126 The full keymap containing default global key bindings.@* |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
127 Modes should not modify the Global map. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
128 |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
129 @item grep-mode-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
130 @vindex grep-mode-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
131 The keymap for @code{grep-mode} buffers. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
132 |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
133 @item help-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
134 The sparse keymap for the keys that follow the help character @kbd{C-h}. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
135 |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
136 @item help-mode-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
137 @vindex help-mode-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
138 The sparse keymap for Help mode. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
139 |
6451 | 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 | |
12098 | 155 @vindex isearch-mode-map |
6451 | 156 A keymap that defines the characters you can type within incremental |
157 search. | |
158 | |
159 @item key-translation-map | |
7600 | 160 A keymap for translating keys. This one overrides ordinary key |
72211
c2484c5211e4
Update xrefs from Translating Input to Translation Keymaps.
Richard M. Stallman <rms@gnu.org>
parents:
71912
diff
changeset
|
161 bindings, unlike @code{function-key-map}. @xref{Translation Keymaps}. |
6451 | 162 |
71912
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
163 @item kmacro-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
164 @vindex kmacro-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
165 A sparse keymap for keys that follows the @kbd{C-x C-k} prefix |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
166 search. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
167 |
6451 | 168 @item lisp-interaction-mode-map |
169 @vindex lisp-interaction-mode-map | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
170 A sparse keymap used by Lisp Interaction mode. |
6451 | 171 |
172 @item lisp-mode-map | |
173 @vindex lisp-mode-map | |
7600 | 174 A sparse keymap used by Lisp mode. |
6451 | 175 |
12098 | 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 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
188 @item menu-bar-mule-menu |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
189 @vindex menu-bar-mule-menu |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
190 The keymap which displays the Mule menu in the menu bar. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
191 |
12098 | 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 | |
6451 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
208 A sparse keymap used by Occur mode. |
6451 | 209 |
210 @item query-replace-map | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
211 A sparse keymap used for responses in @code{query-replace} and related |
6451 | 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 | |
71912
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
220 @item tool-bar-map |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
221 The keymap defining the contents of the tool bar. |
0afb816dacfa
(Standard Keymaps): Add xref for minibuffer maps.
Kim F. Storm <storm@cua.dk>
parents:
68648
diff
changeset
|
222 |
6451 | 223 @item view-mode-map |
224 @vindex view-mode-map | |
225 A full keymap used by View mode. | |
226 @end table | |
52401 | 227 |
228 @ignore | |
229 arch-tag: b741253c-7e23-4a02-b3fa-cffd9e4d72b9 | |
230 @end ignore |