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