summaryrefslogtreecommitdiff
path: root/doc/lispref/help.texi
diff options
context:
space:
mode:
authorChong Yidong <cyd@gnu.org>2012-04-17 13:58:34 +0800
committerChong Yidong <cyd@gnu.org>2012-04-17 13:58:34 +0800
commit21ffa320b1ff22f00a927261348517acd37ab790 (patch)
treedb468ffe8bf42f77d79f1191f3ac24c0d9f302ef /doc/lispref/help.texi
parentf0f6bc351ba0e4a9ba5a62fb1bbc6fe4b5ce2e0c (diff)
downloademacs-21ffa320b1ff22f00a927261348517acd37ab790.tar.gz
Improve description of :advertised-binding in Lisp manual.
* doc/lispref/keymaps.texi (Menu Bar): Move most of the :advertised-binding description to help.texi. * doc/lispref/help.texi (Keys in Documentation): Mention :advertised-binding.
Diffstat (limited to 'doc/lispref/help.texi')
-rw-r--r--doc/lispref/help.texi15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index 2575f5e5bd6..627197f09f1 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -348,6 +348,21 @@ This function scans @var{string} for the above special sequences and
replaces them by what they stand for, returning the result as a string.
This permits display of documentation that refers accurately to the
user's own customized key bindings.
+
+@cindex advertised binding
+If a command has multiple bindings, this function normally uses the
+first one it finds. You can specify one particular key binding by
+assigning an @code{:advertised-binding} symbol property to the
+command, like this:
+
+@smallexample
+(put 'undo :advertised-binding [?\C-/])
+@end smallexample
+
+@noindent
+The @code{:advertised-binding} property also affects the binding shown
+in menu items (@pxref{Menu Bar}). The property is ignored if it
+specifies a key binding that the command does not actually have.
@end defun
Here are examples of the special sequences: