Mercurial > emacs
annotate doc/lispref/maps.texi @ 104078:2658bfb08516
Better docstring for `called-interactively-p'.
author | Bastien Guerry <bzg@altern.org> |
---|---|
date | Mon, 27 Jul 2009 02:02:49 +0000 |
parents | bdb92c8099f7 |
children | 1d1d5d9bd884 |
rev | line source |
---|---|
84085 | 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, | |
100974 | 4 @c 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
84085 | 5 @c See the file elisp.texi for copying conditions. |
84116
0ba80d073e27
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84085
diff
changeset
|
6 @setfilename ../../info/maps |
84085 | 7 @node Standard Keymaps, Standard Hooks, Standard Buffer-Local Variables, Top |
8 @appendix Standard Keymaps | |
9 @cindex standard keymaps | |
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 | |
13 loaded only when their respective mode is used. This is not | |
14 an exhaustive list. | |
15 | |
16 Several keymaps are used in the minibuffer. @xref{Completion Commands}. | |
17 | |
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 | |
23 @item apropos-mode-map | |
24 @vindex apropos-mode-map | |
25 A sparse keymap for @code{apropos} buffers. | |
26 | |
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 | |
33 A sparse keymap used by C mode. | |
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 | |
42 @item ctl-x-5-map | |
43 A sparse keymap for subcommands of the prefix @kbd{C-x 5}. | |
44 | |
45 @item ctl-x-map | |
46 A full keymap for @kbd{C-x} commands. | |
47 | |
48 @item custom-mode-map | |
49 A full keymap for Custom mode. | |
50 | |
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 | |
77 A sparse keymap used by Emacs Lisp mode. | |
78 | |
79 @item 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 | |
101266
bdb92c8099f7
(Standard Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
115 @item local-function-key-map |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
116 The keymap for translating key sequences to preferred alternatives.@* |
84085 | 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 | |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
154 @item input-decode-map |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
155 The keymap for translating keypad and function keys.@* |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
156 If there are none, then it contains an empty sparse keymap. |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
157 @xref{Translation Keymaps}. |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
158 |
84085 | 159 @item isearch-mode-map |
160 @vindex isearch-mode-map | |
161 A keymap that defines the characters you can type within incremental | |
162 search. | |
163 | |
164 @item key-translation-map | |
165 A keymap for translating keys. This one overrides ordinary key | |
101266
bdb92c8099f7
(Standard Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
166 bindings, unlike @code{local- function-key-map}. @xref{Translation |
bdb92c8099f7
(Standard Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
167 Keymaps}. |
84085 | 168 |
169 @item kmacro-map | |
170 @vindex kmacro-map | |
171 A sparse keymap for keys that follows the @kbd{C-x C-k} prefix | |
172 search. | |
173 | |
174 @item lisp-interaction-mode-map | |
175 @vindex lisp-interaction-mode-map | |
176 A sparse keymap used by Lisp Interaction mode. | |
177 | |
178 @item lisp-mode-map | |
179 @vindex lisp-mode-map | |
180 A sparse keymap used by Lisp mode. | |
181 | |
182 @item menu-bar-edit-menu | |
183 @vindex menu-bar-edit-menu | |
184 The keymap which displays the Edit menu in the menu bar. | |
185 | |
186 @item menu-bar-files-menu | |
187 @vindex menu-bar-files-menu | |
188 The keymap which displays the Files menu in the menu bar. | |
189 | |
190 @item menu-bar-help-menu | |
191 @vindex menu-bar-help-menu | |
192 The keymap which displays the Help menu in the menu bar. | |
193 | |
194 @item menu-bar-mule-menu | |
195 @vindex menu-bar-mule-menu | |
196 The keymap which displays the Mule menu in the menu bar. | |
197 | |
198 @item menu-bar-search-menu | |
199 @vindex menu-bar-search-menu | |
200 The keymap which displays the Search menu in the menu bar. | |
201 | |
202 @item menu-bar-tools-menu | |
203 @vindex menu-bar-tools-menu | |
204 The keymap which displays the Tools menu in the menu bar. | |
205 | |
206 @item mode-specific-map | |
207 The keymap for characters following @kbd{C-c}. Note, this is in the | |
208 global map. This map is not actually mode specific: its name was chosen | |
209 to be informative for the user in @kbd{C-h b} (@code{display-bindings}), | |
210 where it describes the main use of the @kbd{C-c} prefix key. | |
211 | |
98821
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
212 @item multi-query-replace-map |
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
213 A sparse keymap that extends @code{query-replace-map} for multi-buffer |
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
214 replacements. @xref{Search and Replace, query-replace-map}. |
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
215 |
84085 | 216 @item occur-mode-map |
217 @vindex occur-mode-map | |
218 A sparse keymap used by Occur mode. | |
219 | |
220 @item query-replace-map | |
221 A sparse keymap used for responses in @code{query-replace} and related | |
222 commands; also for @code{y-or-n-p} and @code{map-y-or-n-p}. The functions | |
223 that use this map do not support prefix keys; they look up one event at a | |
224 time. | |
225 | |
98821
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
226 @item search-map |
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
227 A sparse keymap that provides global bindings for search-related |
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
228 commands. |
4c7eff0c3954
(Standard Keymaps): Document `multi-query-replace-map' and `search-map'.
Eli Zaretskii <eliz@gnu.org>
parents:
87649
diff
changeset
|
229 |
84085 | 230 @item text-mode-map |
231 @vindex text-mode-map | |
232 A sparse keymap used by Text mode. | |
233 | |
234 @item tool-bar-map | |
235 The keymap defining the contents of the tool bar. | |
236 | |
237 @item view-mode-map | |
238 @vindex view-mode-map | |
239 A full keymap used by View mode. | |
240 @end table | |
241 | |
242 @ignore | |
243 arch-tag: b741253c-7e23-4a02-b3fa-cffd9e4d72b9 | |
244 @end ignore |