aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--admin/FOR-RELEASE2
-rw-r--r--doc/lispref/ChangeLog7
-rw-r--r--doc/lispref/help.texi1
-rw-r--r--doc/lispref/keymaps.texi4
-rw-r--r--doc/lispref/maps.texi284
5 files changed, 133 insertions, 165 deletions
diff --git a/admin/FOR-RELEASE b/admin/FOR-RELEASE
index 22856c158e6..563e1588e35 100644
--- a/admin/FOR-RELEASE
+++ b/admin/FOR-RELEASE
@@ -209,7 +209,7 @@ keymaps.texi cyd
209lists.texi cyd 209lists.texi cyd
210loading.texi cyd 210loading.texi cyd
211macros.texi cyd 211macros.texi cyd
212maps.texi 212maps.texi rgm
213markers.texi 213markers.texi
214minibuf.texi 214minibuf.texi
215modes.texi cyd 215modes.texi cyd
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 06f0be7183c..c6f259b972d 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,10 @@
12012-03-01 Glenn Morris <rgm@gnu.org>
2
3 * maps.texi (Standard Keymaps): General update.
4 Remove mode-specific maps, talk about the more general keymaps.
5 * help.texi (Help Functions): Add vindex for Helper-help-map.
6 * keymaps.texi (Active Keymaps): Minor rephrasing.
7
12012-02-29 Glenn Morris <rgm@gnu.org> 82012-02-29 Glenn Morris <rgm@gnu.org>
2 9
3 * elisp.texi, vol1.texi, vol2.texi: Use "" quotes in menus. 10 * elisp.texi, vol1.texi, vol2.texi: Use "" quotes in menus.
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index a98797f3618..537514d7fb9 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -636,6 +636,7 @@ in the minibuffer with the message @samp{Help (Type ? for further
636options)}, and then provides assistance in finding out what the key 636options)}, and then provides assistance in finding out what the key
637bindings are, and what the mode is intended for. It returns @code{nil}. 637bindings are, and what the mode is intended for. It returns @code{nil}.
638 638
639@vindex Helper-help-map
639This can be customized by changing the map @code{Helper-help-map}. 640This can be customized by changing the map @code{Helper-help-map}.
640@end deffn 641@end deffn
641 642
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi
index 5652d94114e..669f058ef13 100644
--- a/doc/lispref/keymaps.texi
+++ b/doc/lispref/keymaps.texi
@@ -1,6 +1,6 @@
1@c -*-texinfo-*- 1@c -*-texinfo-*-
2@c This is part of the GNU Emacs Lisp Reference Manual. 2@c This is part of the GNU Emacs Lisp Reference Manual.
3@c Copyright (C) 1990-1994, 1998-2012 Free Software Foundation, Inc. 3@c Copyright (C) 1990-1994, 1998-2012 Free Software Foundation, Inc.
4@c See the file elisp.texi for copying conditions. 4@c See the file elisp.texi for copying conditions.
5@setfilename ../../info/keymaps 5@setfilename ../../info/keymaps
6@node Keymaps, Modes, Command Loop, Top 6@node Keymaps, Modes, Command Loop, Top
@@ -686,7 +686,7 @@ and exit commands. @xref{Intro to Minibuffers}.
686 Emacs has other keymaps that are used in a different way---translating 686 Emacs has other keymaps that are used in a different way---translating
687events within @code{read-key-sequence}. @xref{Translation Keymaps}. 687events within @code{read-key-sequence}. @xref{Translation Keymaps}.
688 688
689 @xref{Standard Keymaps}, for a list of standard keymaps. 689 @xref{Standard Keymaps}, for a list of some standard keymaps.
690 690
691@defun current-active-maps &optional olp position 691@defun current-active-maps &optional olp position
692This returns the list of active keymaps that would be used by the 692This returns the list of active keymaps that would be used by the
diff --git a/doc/lispref/maps.texi b/doc/lispref/maps.texi
index 524eab2cffe..b303562028b 100644
--- a/doc/lispref/maps.texi
+++ b/doc/lispref/maps.texi
@@ -1,39 +1,40 @@
1@c -*-texinfo-*- 1@c -*-texinfo-*-
2@c This is part of the GNU Emacs Lisp Reference Manual. 2@c This is part of the GNU Emacs Lisp Reference Manual.
3@c Copyright (C) 1990-1993, 1999, 2001-2012 Free Software Foundation, Inc. 3@c Copyright (C) 1990-1993, 1999, 2001-2012 Free Software Foundation, Inc.
4@c See the file elisp.texi for copying conditions. 4@c See the file elisp.texi for copying conditions.
5@setfilename ../../info/maps 5@setfilename ../../info/maps
6@node Standard Keymaps, Standard Hooks, Standard Errors, Top 6@node Standard Keymaps, Standard Hooks, Standard Errors, Top
7@appendix Standard Keymaps 7@appendix Standard Keymaps
8@cindex standard keymaps 8@cindex keymaps, standard
9 9
10The following symbols are used as the names for various keymaps. 10In this section we list some of the more general keymaps. Many of
11Some of these exist when Emacs is first started, others are 11these exist when Emacs is first started, but some are loaded only when
12loaded only when their respective mode is used. This is not 12the respective feature is accessed.
13an exhaustive list.
14 13
15Several keymaps are used in the minibuffer. @xref{Completion Commands}. 14There are many other, more specialized, maps than these; in particular
16 15those associated with major and minor modes. The minibuffer uses
17Almost all of these maps are used as local maps. Indeed, of the modes 16several keymaps (@pxref{Completion Commands}). For more details on
18that presently exist, only Vip mode and Terminal mode ever change the 17keymaps, @pxref{Keymaps}.
19global keymap.
20 18
19@c Don't list individual major mode keymaps here, only more general things.
20@c Only add vindex for things not covered elsewhere in this manual.
21@c Don't add xrefs to things covered in {Keymaps}.
21@table @code 22@table @code
22@item apropos-mode-map 23@item 2C-mode-map
23@vindex apropos-mode-map 24A sparse keymap for subcommands of the prefix @kbd{C-x 6}.@*
24A sparse keymap for @code{apropos} buffers. 25@xref{Two-Column,, Two-Column Editing, emacs, The GNU Emacs Manual}.
25 26
26@item Buffer-menu-mode-map 27@item abbrev-map
27@vindex Buffer-menu-mode-map 28@vindex abbrev-map
28A full keymap used by Buffer Menu mode. 29A sparse keymap for subcommands of the prefix @kbd{C-x a}.@*
30@xref{Defining Abbrevs,,, emacs, The GNU Emacs Manual}.
29 31
30@item c-mode-map 32@item button-buffer-map
31@vindex c-mode-map 33A sparse keymap useful for buffers containing buffers.@*
32A sparse keymap used by C mode. 34You may want to use this as a parent keymap. @xref{Buttons}.
33 35
34@item command-history-map 36@item button-map
35@vindex command-history-map 37A sparse keymap used by buttons.
36A full keymap used by Command History mode.
37 38
38@item ctl-x-4-map 39@item ctl-x-4-map
39A sparse keymap for subcommands of the prefix @kbd{C-x 4}. 40A sparse keymap for subcommands of the prefix @kbd{C-x 4}.
@@ -44,196 +45,155 @@ A sparse keymap for subcommands of the prefix @kbd{C-x 5}.
44@item ctl-x-map 45@item ctl-x-map
45A full keymap for @kbd{C-x} commands. 46A full keymap for @kbd{C-x} commands.
46 47
47@item custom-mode-map 48@item ctl-x-r-map
48A full keymap for Custom mode. 49@vindex ctl-x-r-map
49 50A sparse keymap for subcommands of the prefix @kbd{C-x r}.@*
50@item debugger-mode-map 51@xref{Registers,,, emacs, The GNU Emacs Manual}.
51@vindex debugger-mode-map
52A full keymap used by Debugger mode.
53
54@item dired-mode-map
55@vindex dired-mode-map
56A full keymap for @code{dired-mode} buffers.
57
58@item edit-abbrevs-map
59@vindex edit-abbrevs-map
60A sparse keymap used in @code{edit-abbrevs}.
61
62@item edit-tab-stops-map
63@vindex edit-tab-stops-map
64A sparse keymap used in @code{edit-tab-stops}.
65
66@item electric-buffer-menu-mode-map
67@vindex electric-buffer-menu-mode-map
68A full keymap used by Electric Buffer Menu mode.
69
70@item electric-history-map
71@vindex electric-history-map
72A full keymap used by Electric Command History mode.
73
74@item emacs-lisp-mode-map
75@vindex emacs-lisp-mode-map
76A sparse keymap used by Emacs Lisp mode.
77 52
78@item esc-map 53@item esc-map
79A full keymap for @kbd{ESC} (or @kbd{Meta}) commands. 54A full keymap for @kbd{ESC} (or @kbd{Meta}) commands.
80 55
81@item facemenu-menu 56@item facemenu-keymap
82@vindex facemenu-menu 57A sparse keymap used for the @kbd{M-o} prefix key.
83The sparse keymap that displays the Text Properties menu.
84
85@item facemenu-background-menu
86@vindex facemenu-background-menu
87The sparse keymap that displays the Background Color submenu of the Text
88Properties menu.
89
90@item facemenu-face-menu
91@vindex facemenu-face-menu
92The sparse keymap that displays the Face submenu of the Text Properties menu.
93 58
94@item facemenu-foreground-menu 59@item function-key-map
95@vindex facemenu-foreground-menu 60The parent keymap of all @code{local-function-key-map} (q.v.) instances.
96The sparse keymap that displays the Foreground Color submenu of the Text
97Properties menu.
98
99@item facemenu-indentation-menu
100@vindex facemenu-indentation-menu
101The sparse keymap that displays the Indentation submenu of the Text
102Properties menu.
103
104@item facemenu-justification-menu
105@vindex facemenu-justification-menu
106The sparse keymap that displays the Justification submenu of the Text
107Properties menu.
108
109@item facemenu-special-menu
110@vindex facemenu-special-menu
111The sparse keymap that displays the Special Props submenu of the Text
112Properties menu.
113
114@item local-function-key-map
115The keymap for translating key sequences to preferred alternatives.@*
116If there are none, then it contains an empty sparse keymap.
117@xref{Translation Keymaps}.
118 61
62@ignore
63@c Doesn't exist.
119@item fundamental-mode-map 64@item fundamental-mode-map
120@vindex fundamental-mode-map 65@vindex fundamental-mode-map
121The sparse keymap for Fundamental mode.@* 66The sparse keymap for Fundamental mode.@*
122It is empty and should not be changed. 67It is empty and should not be changed.
68@end ignore
123 69
124@item global-map 70@item global-map
125The full keymap containing default global key bindings.@* 71The full keymap containing default global key bindings.@*
126Modes should not modify the Global map. 72Modes should not modify the Global map.
127 73
128@item grep-mode-map 74@item goto-map
129@vindex grep-mode-map 75A sparse keymap used for the @kbd{M-g} prefix key.
130The keymap for @code{grep-mode} buffers.
131 76
132@item help-map 77@item help-map
133The sparse keymap for the keys that follow the help character @kbd{C-h}. 78A sparse keymap for the keys following the help character @kbd{C-h}.@*
134 79@xref{Help Functions}.
135@item help-mode-map
136@vindex help-mode-map
137The sparse keymap for Help mode.
138 80
139@item Helper-help-map 81@item Helper-help-map
140@vindex Helper-help-map
141A full keymap used by the help utility package.@* 82A full keymap used by the help utility package.@*
142It has the same keymap in its value cell and in its function 83It has the same keymap in its value cell and in its function cell.
143cell.
144
145@item Info-edit-map
146@vindex Info-edit-map
147A sparse keymap used by the @code{Info-edit} command.
148
149@item Info-mode-map
150@vindex Info-mode-map
151A sparse keymap containing Info commands.
152 84
153@item input-decode-map 85@item input-decode-map
154The keymap for translating keypad and function keys.@* 86The keymap for translating keypad and function keys.@*
155If there are none, then it contains an empty sparse keymap. 87If there are none, then it contains an empty sparse keymap.
156@xref{Translation Keymaps}. 88@xref{Translation Keymaps}.
157 89
158@item isearch-mode-map
159@vindex isearch-mode-map
160A keymap that defines the characters you can type within incremental
161search.
162
163@item key-translation-map 90@item key-translation-map
164A keymap for translating keys. This one overrides ordinary key 91A keymap for translating keys. This one overrides ordinary key
165bindings, unlike @code{local-function-key-map}. @xref{Translation 92bindings, unlike @code{local-function-key-map}. @xref{Translation
166Keymaps}. 93Keymaps}.
167 94
168@item kmacro-map 95@item kmacro-keymap
169@vindex kmacro-map 96@vindex kmacro-keymap
170A sparse keymap for keys that follows the @kbd{C-x C-k} prefix 97A sparse keymap for keys that follows the @kbd{C-x C-k} prefix search.@*
171search. 98@xref{Keyboard Macros,,, emacs, The GNU Emacs Manual}.
172
173@item lisp-interaction-mode-map
174@vindex lisp-interaction-mode-map
175A sparse keymap used by Lisp Interaction mode.
176 99
177@item lisp-mode-map 100@item local-function-key-map
178@vindex lisp-mode-map 101The keymap for translating key sequences to preferred alternatives.@*
179A sparse keymap used by Lisp mode. 102If there are none, then it contains an empty sparse keymap.
180 103@xref{Translation Keymaps}.
181@item menu-bar-edit-menu
182@vindex menu-bar-edit-menu
183The keymap which displays the Edit menu in the menu bar.
184 104
185@item menu-bar-file-menu 105@item menu-bar-file-menu
106@itemx menu-bar-edit-menu
107@itemx menu-bar-options-menu
108@itemx global-buffers-menu-map
109@itemx menu-bar-tools-menu
110@itemx menu-bar-help-menu
111@cindex menu bar keymaps
186@vindex menu-bar-file-menu 112@vindex menu-bar-file-menu
187The keymap which displays the File menu in the menu bar. 113@vindex menu-bar-options-menu
188 114@vindex global-buffers-menu-map
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 115@vindex menu-bar-tools-menu
203The keymap which displays the Tools menu in the menu bar. 116@vindex menu-bar-help-menu
117These keymaps display the main, top-level menus in the menu bar.@*
118Some of them contain sub-menus. For example, the Edit menu contains
119@code{menu-bar-search-menu}, etc. @xref{Menu Bar}.
120@ignore
121TODO list all submenus?
122There are probably too many, and it would not be useful to do so, eg:
123The Edit menu includes @code{yank-menu}, @code{menu-bar-search-menu},
124@code{menu-bar-replace-menu}, @code{menu-bar-goto-menu},
125@code{menu-bar-bookmark-map}, and @code{facemenu-menu}.
126There is also mule-menu-keymap, set-coding-system-map,
127setup-language-environment-map, describe-language-environment-map,
128menu-bar-epatch-menu, menu-bar-ediff-merge-menu, menu-bar-ediff-menu, etc.
129@end ignore
130
131@item minibuffer-inactive-mode-map
132A full keymap used in the minibuffer when it is not active.@*
133@xref{Minibuffer Edit,, Editing in the Minibuffer, emacs, The GNU Emacs Manual}.
134
135@item mode-line-coding-system-map
136@itemx mode-line-input-method-map
137@itemx mode-line-column-line-number-mode-map
138@vindex mode-line-coding-system-map
139@vindex mode-line-input-method-map
140@vindex mode-line-column-line-number-mode-map
141These keymaps control various areas of the mode line.@*
142@xref{Mode Line Format}.
204 143
205@item mode-specific-map 144@item mode-specific-map
206The keymap for characters following @kbd{C-c}. Note, this is in the 145The 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 146global 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}), 147to be informative in @kbd{C-h b} (@code{display-bindings}),
209where it describes the main use of the @kbd{C-c} prefix key. 148where it describes the main use of the @kbd{C-c} prefix key.
210 149
211@item multi-query-replace-map 150@c FIXME - don't mention this one?
212A sparse keymap that extends @code{query-replace-map} for multi-buffer 151@item mouse-appearance-menu-map
213replacements. @xref{Search and Replace, query-replace-map}. 152@vindex mouse-appearance-menu-map
153A sparse keymap used for the @kbd{S-mouse-1} key.
154
155@item mule-keymap
156The global keymap used for the @kbd{C-x @key{RET}} prefix key.
214 157
215@item occur-mode-map 158@item narrow-map
216@vindex occur-mode-map 159@vindex narrow-map
217A sparse keymap used by Occur mode. 160A sparse keymap for subcommands of the prefix @kbd{C-x n}.
161
162@item prog-mode-map
163The keymap used by Prog mode.@*
164@xref{Basic Major Modes}.
218 165
219@item query-replace-map 166@item query-replace-map
167@itemx multi-query-replace-map
220A sparse keymap used for responses in @code{query-replace} and related 168A sparse keymap used for responses in @code{query-replace} and related
221commands; also for @code{y-or-n-p} and @code{map-y-or-n-p}. The functions 169commands; also for @code{y-or-n-p} and @code{map-y-or-n-p}. The functions
222that use this map do not support prefix keys; they look up one event at a 170that use this map do not support prefix keys; they look up one event at a
223time. 171time. @code{multi-query-replace-map} extends @code{query-replace-map}
172for multi-buffer replacements. @xref{Search and Replace, query-replace-map}.
224 173
225@item search-map 174@item search-map
226A sparse keymap that provides global bindings for search-related 175A sparse keymap that provides global bindings for search-related commands.
227commands.
228 176
229@item text-mode-map 177@item special-mode-map
230@vindex text-mode-map 178The keymap used by Special mode.@*
231A sparse keymap used by Text mode. 179@xref{Basic Major Modes}.
232 180
233@item tool-bar-map 181@item tool-bar-map
234The keymap defining the contents of the tool bar. 182The keymap defining the contents of the tool bar.@*
183@xref{Tool Bar}.
184
185@item universal-argument-map
186@vindex universal-argument-map
187A sparse keymap used while processing @kbd{C-u}.@*
188@xref{Prefix Command Arguments}.
189
190@item vc-prefix-map
191The global keymap used for the @kbd{C-x v} prefix key.
192
193@item x-alternatives-map
194@vindex x-alternatives-map
195@findex x-setup-function-keys
196A sparse keymap used to map certain keys under graphical frames.@*
197The function @code{x-setup-function-keys} uses this.
235 198
236@item view-mode-map
237@vindex view-mode-map
238A full keymap used by View mode.
239@end table 199@end table