unexmacosx.c (copy_data_segment): Added two section names used on Mac
[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.
53a1239b 3@c Copyright (C) 1990-1993, 1999, 2001-2012 Free Software Foundation, Inc.
b8d4c8d0 4@c See the file elisp.texi for copying conditions.
ecc6530d 5@node Standard Keymaps
b8d4c8d0 6@appendix Standard Keymaps
53a1239b 7@cindex keymaps, standard
b8d4c8d0 8
53a1239b
GM
9In this section we list some of the more general keymaps. Many of
10these exist when Emacs is first started, but some are loaded only when
11the respective feature is accessed.
b8d4c8d0 12
53a1239b
GM
13There are many other, more specialized, maps than these; in particular
14those associated with major and minor modes. The minibuffer uses
15several keymaps (@pxref{Completion Commands}). For more details on
16keymaps, @pxref{Keymaps}.
b8d4c8d0 17
53a1239b
GM
18@c Don't list individual major mode keymaps here, only more general things.
19@c Only add vindex for things not covered elsewhere in this manual.
20@c Don't add xrefs to things covered in {Keymaps}.
b8d4c8d0 21@table @code
53a1239b
GM
22@item 2C-mode-map
23A sparse keymap for subcommands of the prefix @kbd{C-x 6}.@*
24@xref{Two-Column,, Two-Column Editing, emacs, The GNU Emacs Manual}.
b8d4c8d0 25
53a1239b
GM
26@item abbrev-map
27@vindex abbrev-map
28A sparse keymap for subcommands of the prefix @kbd{C-x a}.@*
29@xref{Defining Abbrevs,,, emacs, The GNU Emacs Manual}.
b8d4c8d0 30
53a1239b
GM
31@item button-buffer-map
32A sparse keymap useful for buffers containing buffers.@*
33You may want to use this as a parent keymap. @xref{Buttons}.
b8d4c8d0 34
53a1239b
GM
35@item button-map
36A sparse keymap used by buttons.
b8d4c8d0
GM
37
38@item ctl-x-4-map
39A sparse keymap for subcommands of the prefix @kbd{C-x 4}.
40
41@item ctl-x-5-map
42A sparse keymap for subcommands of the prefix @kbd{C-x 5}.
43
44@item ctl-x-map
45A full keymap for @kbd{C-x} commands.
46
53a1239b
GM
47@item ctl-x-r-map
48@vindex ctl-x-r-map
49A sparse keymap for subcommands of the prefix @kbd{C-x r}.@*
50@xref{Registers,,, emacs, The GNU Emacs Manual}.
b8d4c8d0
GM
51
52@item esc-map
53A full keymap for @kbd{ESC} (or @kbd{Meta}) commands.
54
53a1239b
GM
55@item facemenu-keymap
56A sparse keymap used for the @kbd{M-o} prefix key.
b8d4c8d0 57
53a1239b
GM
58@item function-key-map
59The parent keymap of all @code{local-function-key-map} (q.v.) instances.
b8d4c8d0 60
53a1239b
GM
61@ignore
62@c Doesn't exist.
b8d4c8d0
GM
63@item fundamental-mode-map
64@vindex fundamental-mode-map
65The sparse keymap for Fundamental mode.@*
66It is empty and should not be changed.
53a1239b 67@end ignore
b8d4c8d0
GM
68
69@item global-map
70The full keymap containing default global key bindings.@*
71Modes should not modify the Global map.
72
53a1239b
GM
73@item goto-map
74A sparse keymap used for the @kbd{M-g} prefix key.
b8d4c8d0
GM
75
76@item help-map
53a1239b
GM
77A sparse keymap for the keys following the help character @kbd{C-h}.@*
78@xref{Help Functions}.
b8d4c8d0
GM
79
80@item Helper-help-map
b8d4c8d0 81A full keymap used by the help utility package.@*
53a1239b 82It has the same keymap in its value cell and in its function cell.
b8d4c8d0 83
4f4a84ec
SM
84@item input-decode-map
85The keymap for translating keypad and function keys.@*
86If there are none, then it contains an empty sparse keymap.
87@xref{Translation Keymaps}.
88
b8d4c8d0
GM
89@item key-translation-map
90A keymap for translating keys. This one overrides ordinary key
da0bbbc4 91bindings, unlike @code{local-function-key-map}. @xref{Translation
ead3f58d 92Keymaps}.
b8d4c8d0 93
53a1239b
GM
94@item kmacro-keymap
95@vindex kmacro-keymap
96A sparse keymap for keys that follows the @kbd{C-x C-k} prefix search.@*
97@xref{Keyboard Macros,,, emacs, The GNU Emacs Manual}.
b8d4c8d0 98
53a1239b
GM
99@item local-function-key-map
100The keymap for translating key sequences to preferred alternatives.@*
101If there are none, then it contains an empty sparse keymap.
102@xref{Translation Keymaps}.
b8d4c8d0 103
aab705a2 104@item menu-bar-file-menu
53a1239b
GM
105@itemx menu-bar-edit-menu
106@itemx menu-bar-options-menu
107@itemx global-buffers-menu-map
108@itemx menu-bar-tools-menu
109@itemx menu-bar-help-menu
110@cindex menu bar keymaps
aab705a2 111@vindex menu-bar-file-menu
53a1239b
GM
112@vindex menu-bar-options-menu
113@vindex global-buffers-menu-map
b8d4c8d0 114@vindex menu-bar-tools-menu
53a1239b
GM
115@vindex menu-bar-help-menu
116These keymaps display the main, top-level menus in the menu bar.@*
117Some of them contain sub-menus. For example, the Edit menu contains
118@code{menu-bar-search-menu}, etc. @xref{Menu Bar}.
119@ignore
120TODO list all submenus?
121There are probably too many, and it would not be useful to do so, eg:
122The Edit menu includes @code{yank-menu}, @code{menu-bar-search-menu},
123@code{menu-bar-replace-menu}, @code{menu-bar-goto-menu},
124@code{menu-bar-bookmark-map}, and @code{facemenu-menu}.
125There is also mule-menu-keymap, set-coding-system-map,
126setup-language-environment-map, describe-language-environment-map,
127menu-bar-epatch-menu, menu-bar-ediff-merge-menu, menu-bar-ediff-menu, etc.
128@end ignore
129
130@item minibuffer-inactive-mode-map
131A full keymap used in the minibuffer when it is not active.@*
132@xref{Minibuffer Edit,, Editing in the Minibuffer, emacs, The GNU Emacs Manual}.
133
134@item mode-line-coding-system-map
135@itemx mode-line-input-method-map
136@itemx mode-line-column-line-number-mode-map
137@vindex mode-line-coding-system-map
138@vindex mode-line-input-method-map
139@vindex mode-line-column-line-number-mode-map
140These keymaps control various areas of the mode line.@*
141@xref{Mode Line Format}.
b8d4c8d0
GM
142
143@item mode-specific-map
144The keymap for characters following @kbd{C-c}. Note, this is in the
53a1239b
GM
145global map. This map is not actually mode-specific: its name was chosen
146to be informative in @kbd{C-h b} (@code{display-bindings}),
b8d4c8d0
GM
147where it describes the main use of the @kbd{C-c} prefix key.
148
53a1239b
GM
149@c FIXME - don't mention this one?
150@item mouse-appearance-menu-map
151@vindex mouse-appearance-menu-map
152A sparse keymap used for the @kbd{S-mouse-1} key.
153
154@item mule-keymap
155The global keymap used for the @kbd{C-x @key{RET}} prefix key.
cdf17e86 156
53a1239b
GM
157@item narrow-map
158@vindex narrow-map
159A sparse keymap for subcommands of the prefix @kbd{C-x n}.
160
161@item prog-mode-map
162The keymap used by Prog mode.@*
163@xref{Basic Major Modes}.
b8d4c8d0
GM
164
165@item query-replace-map
53a1239b 166@itemx multi-query-replace-map
b8d4c8d0
GM
167A sparse keymap used for responses in @code{query-replace} and related
168commands; also for @code{y-or-n-p} and @code{map-y-or-n-p}. The functions
169that use this map do not support prefix keys; they look up one event at a
53a1239b
GM
170time. @code{multi-query-replace-map} extends @code{query-replace-map}
171for multi-buffer replacements. @xref{Search and Replace, query-replace-map}.
b8d4c8d0 172
cdf17e86 173@item search-map
53a1239b 174A sparse keymap that provides global bindings for search-related commands.
cdf17e86 175
53a1239b
GM
176@item special-mode-map
177The keymap used by Special mode.@*
178@xref{Basic Major Modes}.
b8d4c8d0
GM
179
180@item tool-bar-map
53a1239b
GM
181The keymap defining the contents of the tool bar.@*
182@xref{Tool Bar}.
183
184@item universal-argument-map
185@vindex universal-argument-map
186A sparse keymap used while processing @kbd{C-u}.@*
187@xref{Prefix Command Arguments}.
188
189@item vc-prefix-map
190The global keymap used for the @kbd{C-x v} prefix key.
191
192@item x-alternatives-map
193@vindex x-alternatives-map
194@findex x-setup-function-keys
195A sparse keymap used to map certain keys under graphical frames.@*
196The function @code{x-setup-function-keys} uses this.
b8d4c8d0 197
b8d4c8d0 198@end table