aboutsummaryrefslogtreecommitdiffstats
path: root/src/doc.c
diff options
context:
space:
mode:
authorChong Yidong2012-05-31 14:08:06 +0800
committerChong Yidong2012-05-31 14:08:06 +0800
commitefc00ab16e2890b75d7224434ac43fe944ade4dd (patch)
tree28c1078ca32b96402cd1a5f618a17b3526143f27 /src/doc.c
parentba93a18774352c97d6dd73c73141cbff6305581b (diff)
parentdd41169b6cb0105b0766f3d368c657ebafc19cba (diff)
downloademacs-efc00ab16e2890b75d7224434ac43fe944ade4dd.tar.gz
emacs-efc00ab16e2890b75d7224434ac43fe944ade4dd.zip
Merge from emacs-24; up to 2012-04-24T21:47:24Z!michael.albinus@gmx.de
Diffstat (limited to 'src/doc.c')
-rw-r--r--src/doc.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/src/doc.c b/src/doc.c
index bec20fb0d94..cd23d9266a2 100644
--- a/src/doc.c
+++ b/src/doc.c
@@ -705,18 +705,23 @@ the same file name is found in the `doc-directory'. */)
705DEFUN ("substitute-command-keys", Fsubstitute_command_keys, 705DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
706 Ssubstitute_command_keys, 1, 1, 0, 706 Ssubstitute_command_keys, 1, 1, 0,
707 doc: /* Substitute key descriptions for command names in STRING. 707 doc: /* Substitute key descriptions for command names in STRING.
708Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke 708Each substring of the form \\=\\[COMMAND] is replaced by either a
709sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not 709keystroke sequence that invokes COMMAND, or "M-x COMMAND" if COMMAND
710on any keys. 710is not on any keys.
711Substrings of the form \\=\\{MAPVAR} are replaced by summaries 711
712\(made by `describe-bindings') of the value of MAPVAR, taken as a keymap. 712Each substring of the form \\=\\{MAPVAR} is replaced by a summary of
713Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR 713the value of MAPVAR as a keymap. This summary is similar to the one
714produced by `describe-bindings'. The summary ends in two newlines
715\(used by the helper function `help-make-xrefs' to find the end of the
716summary).
717
718Each substring of the form \\=\\<MAPVAR> specifies the use of MAPVAR
714as the keymap for future \\=\\[COMMAND] substrings. 719as the keymap for future \\=\\[COMMAND] substrings.
715\\=\\= quotes the following character and is discarded; 720\\=\\= quotes the following character and is discarded;
716thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. 721thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.
717 722
718Returns original STRING if no substitutions were made. Otherwise, 723Return the original STRING if no substitutions are made.
719a new string, without any text properties, is returned. */) 724Otherwise, return a new string, without any text properties. */)
720 (Lisp_Object string) 725 (Lisp_Object string)
721{ 726{
722 char *buf; 727 char *buf;