aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Albinus2018-01-31 19:59:12 +0100
committerMichael Albinus2018-01-31 19:59:12 +0100
commit56c37bbdb60f201791b57a3af2f47b7517de810c (patch)
tree7444f9f80ca4d2d0f39ef86f0e875a98d4db5769 /doc
parent25c01983afa55c83b8443d51267b7957e5d2c739 (diff)
downloademacs-56c37bbdb60f201791b57a3af2f47b7517de810c.tar.gz
emacs-56c37bbdb60f201791b57a3af2f47b7517de810c.zip
Use @key{} where it is missing in the manuals
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/display.texi6
-rw-r--r--doc/emacs/emacs.texi2
-rw-r--r--doc/emacs/killing.texi2
-rw-r--r--doc/emacs/maintaining.texi2
-rw-r--r--doc/emacs/programs.texi2
-rw-r--r--doc/emacs/search.texi4
-rw-r--r--doc/lispref/commands.texi2
-rw-r--r--doc/lispref/debugging.texi8
-rw-r--r--doc/lispref/display.texi2
-rw-r--r--doc/lispref/modes.texi9
-rw-r--r--doc/lispref/nonascii.texi2
-rw-r--r--doc/lispref/tips.texi19
12 files changed, 31 insertions, 29 deletions
diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index b2a4011b4a7..d0ab5486af1 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -1259,9 +1259,9 @@ Highlight empty lines.
1259@item big-indent 1259@item big-indent
1260@vindex whitespace-big-indent-regexp 1260@vindex whitespace-big-indent-regexp
1261Highlight too-deep indentation. By default any sequence of at least 4 1261Highlight too-deep indentation. By default any sequence of at least 4
1262consecutive TAB characters or 32 consecutive SPC characters is 1262consecutive @key{TAB} characters or 32 consecutive @key{SPC}
1263highlighted. To change that, customize the regular expression 1263characters is highlighted. To change that, customize the regular
1264@code{whitespace-big-indent-regexp}. 1264expression @code{whitespace-big-indent-regexp}.
1265 1265
1266@item space-mark 1266@item space-mark
1267Draw space and non-breaking characters with a special glyph. 1267Draw space and non-breaking characters with a special glyph.
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi
index 0051868fee6..b0539221b82 100644
--- a/doc/emacs/emacs.texi
+++ b/doc/emacs/emacs.texi
@@ -723,7 +723,7 @@ C and Related Modes
723 723
724* Motion in C:: Commands to move by C statements, etc. 724* Motion in C:: Commands to move by C statements, etc.
725* Electric C:: Colon and other chars can automatically reindent. 725* Electric C:: Colon and other chars can automatically reindent.
726* Hungry Delete:: A more powerful DEL command. 726* Hungry Delete:: A more powerful @key{DEL} command.
727* Other C Commands:: Filling comments, viewing expansion of macros, 727* Other C Commands:: Filling comments, viewing expansion of macros,
728 and other neat features. 728 and other neat features.
729 729
diff --git a/doc/emacs/killing.texi b/doc/emacs/killing.texi
index 6efcc9d35de..78203936c78 100644
--- a/doc/emacs/killing.texi
+++ b/doc/emacs/killing.texi
@@ -857,7 +857,7 @@ region is active.
857 857
858Unlike the standard region, the region-rectangle can have its corners 858Unlike the standard region, the region-rectangle can have its corners
859extended past the end of buffer, or inside stretches of white space 859extended past the end of buffer, or inside stretches of white space
860that point normally cannot enter, like the TAB. 860that point normally cannot enter, like the @key{TAB}.
861 861
862@findex rectangle-exchange-point-and-mark 862@findex rectangle-exchange-point-and-mark
863@findex exchange-point-and-mark@r{, in rectangle-mark-mode} 863@findex exchange-point-and-mark@r{, in rectangle-mark-mode}
diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 158b04c9f2e..8acbb5317ed 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1899,7 +1899,7 @@ Move to the previous reference and display it in the other window
1899@findex xref-show-location-at-point 1899@findex xref-show-location-at-point
1900Display the reference on the current line in the other window 1900Display the reference on the current line in the other window
1901(@code{xref-show-location-at-point}). 1901(@code{xref-show-location-at-point}).
1902@item TAB 1902@item @key{TAB}
1903@findex xref-quit-and-goto-xref 1903@findex xref-quit-and-goto-xref
1904Display the reference on the current line and bury the @file{*xref*} 1904Display the reference on the current line and bury the @file{*xref*}
1905buffer (@code{xref-quit-and-goto-xref}). 1905buffer (@code{xref-quit-and-goto-xref}).
diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi
index 42891245451..970647e1277 100644
--- a/doc/emacs/programs.texi
+++ b/doc/emacs/programs.texi
@@ -1587,7 +1587,7 @@ with Emacs.
1587@menu 1587@menu
1588* Motion in C:: Commands to move by C statements, etc. 1588* Motion in C:: Commands to move by C statements, etc.
1589* Electric C:: Colon and other chars can automatically reindent. 1589* Electric C:: Colon and other chars can automatically reindent.
1590* Hungry Delete:: A more powerful DEL command. 1590* Hungry Delete:: A more powerful @key{DEL} command.
1591* Other C Commands:: Filling comments, viewing expansion of macros, 1591* Other C Commands:: Filling comments, viewing expansion of macros,
1592 and other neat features. 1592 and other neat features.
1593@end menu 1593@end menu
diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi
index c7216128cd8..c0adab497ba 100644
--- a/doc/emacs/search.texi
+++ b/doc/emacs/search.texi
@@ -1675,8 +1675,8 @@ line. In particular, @kbd{C-g} simply exits the @code{query-replace}.
1675 1675
1676 To restart a @code{query-replace} once it is exited, use @kbd{C-x 1676 To restart a @code{query-replace} once it is exited, use @kbd{C-x
1677@key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it 1677@key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it
1678used the minibuffer to read its arguments. @xref{Repetition, C-x ESC 1678used the minibuffer to read its arguments. @xref{Repetition, C-x @key{ESC}
1679ESC}. 1679@key{ESC}}.
1680 1680
1681@cindex invisible text, and query-replace 1681@cindex invisible text, and query-replace
1682 The option @code{search-invisible} determines how @code{query-replace} 1682 The option @code{search-invisible} determines how @code{query-replace}
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 6700b8fac30..0753d6fb67c 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -748,7 +748,7 @@ part of the prompt.
748@group 748@group
749(execute-extended-command 3) 749(execute-extended-command 3)
750---------- Buffer: Minibuffer ---------- 750---------- Buffer: Minibuffer ----------
7513 M-x forward-word RET 7513 M-x forward-word @key{RET}
752---------- Buffer: Minibuffer ---------- 752---------- Buffer: Minibuffer ----------
753 @result{} t 753 @result{} t
754@end group 754@end group
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 2c757dd39d5..2b5f64827c4 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -941,10 +941,10 @@ The profiler report buffer shows, on each line, a function that was
941called, followed by how much resource (processor or memory) it used in 941called, followed by how much resource (processor or memory) it used in
942absolute and percentage times since profiling started. If a given 942absolute and percentage times since profiling started. If a given
943line has a @samp{+} symbol at the left-hand side, you can expand that 943line has a @samp{+} symbol at the left-hand side, you can expand that
944line by typing @key{RET}, in order to see the function(s) called by 944line by typing @kbd{@key{RET}}, in order to see the function(s) called
945the higher-level function. Use a prefix argument (@key{C-u RET}) to 945by the higher-level function. Use a prefix argument (@kbd{C-u
946see the whole call tree below a function. Pressing @key{RET} again 946@key{RET}}) to see the whole call tree below a function. Pressing
947will collapse back to the original state. 947@kbd{@key{RET}} again will collapse back to the original state.
948 948
949Press @kbd{j} or @kbd{mouse-2} to jump to the definition of a function. 949Press @kbd{j} or @kbd{mouse-2} to jump to the definition of a function.
950Press @kbd{d} to view a function's documentation. 950Press @kbd{d} to view a function's documentation.
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index fbf943a08c7..bd1f671225c 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -4599,7 +4599,7 @@ first character in the group of consecutive characters that have the
4599same @code{display} property. The space width is the pixel width of 4599same @code{display} property. The space width is the pixel width of
4600that character, multiplied by @var{factor}. (On text-mode terminals, 4600that character, multiplied by @var{factor}. (On text-mode terminals,
4601the ``pixel width'' of a character is usually 1, but it could be more 4601the ``pixel width'' of a character is usually 1, but it could be more
4602for TABs and double-width CJK characters.) 4602for @key{TAB}s and double-width CJK characters.)
4603 4603
4604@item :align-to @var{hpos} 4604@item :align-to @var{hpos}
4605Specifies that the space should be wide enough to reach @var{hpos}. 4605Specifies that the space should be wide enough to reach @var{hpos}.
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index efa14e5e2a6..f1a00e72f3d 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -3545,10 +3545,11 @@ provided grammar is precise enough, @code{transpose-sexps} can correctly
3545transpose the two arguments of a @code{+} operator, taking into account 3545transpose the two arguments of a @code{+} operator, taking into account
3546the precedence rules of the language. 3546the precedence rules of the language.
3547 3547
3548Calling @code{smie-setup} is also sufficient to make TAB indentation work in 3548Calling @code{smie-setup} is also sufficient to make @key{TAB}
3549the expected way, extends @code{blink-matching-paren} to apply to 3549indentation work in the expected way, extends
3550elements like @code{begin...end}, and provides some commands that you 3550@code{blink-matching-paren} to apply to elements like
3551can bind in the major mode keymap. 3551@code{begin...end}, and provides some commands that you can bind in
3552the major mode keymap.
3552 3553
3553@deffn Command smie-close-block 3554@deffn Command smie-close-block
3554This command closes the most recently opened (and not yet closed) block. 3555This command closes the most recently opened (and not yet closed) block.
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi
index 2fd2bbc1ce5..8bc7e209894 100644
--- a/doc/lispref/nonascii.texi
+++ b/doc/lispref/nonascii.texi
@@ -1776,7 +1776,7 @@ affect it.
1776Binding @code{coding-system-for-write} to a non-@code{nil} value 1776Binding @code{coding-system-for-write} to a non-@code{nil} value
1777prevents output primitives from calling the function specified by 1777prevents output primitives from calling the function specified by
1778@code{select-safe-coding-system-function} (@pxref{User-Chosen Coding 1778@code{select-safe-coding-system-function} (@pxref{User-Chosen Coding
1779Systems}). This is because @kbd{C-x RET c} 1779Systems}). This is because @kbd{C-x @key{RET} c}
1780(@code{universal-coding-system-argument}) works by binding 1780(@code{universal-coding-system-argument}) works by binding
1781@code{coding-system-for-write}, and Emacs should obey user selection. 1781@code{coding-system-for-write}, and Emacs should obey user selection.
1782If a Lisp program binds @code{coding-system-for-write} to a value that 1782If a Lisp program binds @code{coding-system-for-write} to a value that
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 0f883fe4b4d..0695d9b7b12 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -17,14 +17,15 @@ should follow.
17@findex checkdoc 17@findex checkdoc
18@findex checkdoc-current-buffer 18@findex checkdoc-current-buffer
19@findex checkdoc-file 19@findex checkdoc-file
20 You can automatically check some of the conventions described below by 20 You can automatically check some of the conventions described below
21running the command @kbd{M-x checkdoc RET} when visiting a Lisp file. 21by running the command @kbd{M-x checkdoc @key{RET}} when visiting a
22It cannot check all of the conventions, and not all the warnings it 22Lisp file. It cannot check all of the conventions, and not all the
23gives necessarily correspond to problems, but it is worth examining them 23warnings it gives necessarily correspond to problems, but it is worth
24all. Alternatively, use the command @kbd{M-x checkdoc-current-buffer RET} 24examining them all. Alternatively, use the command @kbd{M-x
25to check the conventions in the current buffer, or @code{checkdoc-file} 25checkdoc-current-buffer @key{RET}} to check the conventions in the
26when you want to check a file in batch mode, e.g., with a command run by 26current buffer, or @code{checkdoc-file} when you want to check a file
27@kbd{@w{M-x compile RET}}. 27in batch mode, e.g., with a command run by @kbd{@w{M-x compile
28@key{RET}}}.
28 29
29@menu 30@menu
30* Coding Conventions:: Conventions for clean and robust programs. 31* Coding Conventions:: Conventions for clean and robust programs.
@@ -1028,7 +1029,7 @@ but only the main one.
1028@findex checkdoc-package-keywords 1029@findex checkdoc-package-keywords
1029This line lists keywords for the @code{finder-by-keyword} help command. 1030This line lists keywords for the @code{finder-by-keyword} help command.
1030Please use that command to see a list of the meaningful keywords. The 1031Please use that command to see a list of the meaningful keywords. The
1031command @kbd{M-x checkdoc-package-keywords RET} will find and display 1032command @kbd{M-x checkdoc-package-keywords @key{RET}} will find and display
1032any keywords that are not in @code{finder-known-keywords}. If you set 1033any keywords that are not in @code{finder-known-keywords}. If you set
1033the variable @code{checkdoc-package-keywords-flag} non-@code{nil}, 1034the variable @code{checkdoc-package-keywords-flag} non-@code{nil},
1034checkdoc commands will include the keyword verification in its checks. 1035checkdoc commands will include the keyword verification in its checks.