aboutsummaryrefslogtreecommitdiff
path: root/readline/inc-readline.texinfo
diff options
context:
space:
mode:
authorRoland Pesch <pesch@cygnus>1991-04-04 00:00:00 +0000
committerRoland Pesch <pesch@cygnus>1991-04-04 00:00:00 +0000
commit414a49719337aa55c9cb1109afb44e19001957dc (patch)
tree890161504457c07e4889a92a2adcdd570159b295 /readline/inc-readline.texinfo
parent08665207c05439e2d229106d903e6dfa07d17865 (diff)
downloadgdb-414a49719337aa55c9cb1109afb44e19001957dc.zip
gdb-414a49719337aa55c9cb1109afb44e19001957dc.tar.gz
gdb-414a49719337aa55c9cb1109afb44e19001957dc.tar.bz2
Improvements to texinfo macro use due to RMS
Diffstat (limited to 'readline/inc-readline.texinfo')
-rwxr-xr-xreadline/inc-readline.texinfo57
1 files changed, 29 insertions, 28 deletions
diff --git a/readline/inc-readline.texinfo b/readline/inc-readline.texinfo
index cdc9944..2e6c49e 100755
--- a/readline/inc-readline.texinfo
+++ b/readline/inc-readline.texinfo
@@ -50,17 +50,17 @@ This appendix describes GNU's command line editing interface.
In this appendix a the following notation is used to describe
keystrokes.
-The text @key{C-k} is read as `Control-K' and describes the character
+The text @kbd{C-k} is read as `Control-K' and describes the character
produced when the Control key is depressed and the @key{k} key is struck.
-The text @key{M-k} is read as `Meta-K' and describes the character
+The text @kbd{M-k} is read as `Meta-K' and describes the character
produced when the meta key (if you have one) is depressed, and the @key{k}
key is struck. If you do not have a meta key, the identical keystroke
can be generated by typing @key{ESC} @i{first}, and then typing @key{k}.
Either process is known as @dfn{metafying} the @key{k} key.
-The text @key{M-C-k} is read as `Meta-Control-k' and describes the
-character produced by @dfn{metafying} @key{C-k}.
+The text @kbd{M-C-k} is read as `Meta-Control-k' and describes the
+character produced by @dfn{metafying} @kbd{C-k}.
In addition, several keys have their own names. Specifically,
@key{DEL}, @key{ESC}, @key{LFD}, @key{SPC}, @key{RET}, and @key{TAB} all
@@ -99,9 +99,9 @@ back up, and delete the mistyped character.
Sometimes you may miss typing a character that you wanted to type, and
not notice your error until you have typed several other characters. In
-that case, you can type @key{C-b} to move the cursor to the left, and then
+that case, you can type @kbd{C-b} to move the cursor to the left, and then
correct your mistake. Aftwerwards, you can move the cursor to the right
-with @key{C-f}.
+with @kbd{C-f}.
When you add text in the middle of a line, you will notice that characters
to the right of the cursor get `pushed over' to make room for the text
@@ -111,17 +111,17 @@ blank space created by the removal of the text. A list of the basic bare
essentials for editing the text of an input line follows.
@table @asis
-@item @key{C-b}
+@item @kbd{C-b}
Move back one character.
-@item @key{C-f}
+@item @kbd{C-f}
Move forward one character.
@item @key{DEL}
Delete the character to the left of the cursor.
-@item @key{C-d}
+@item @kbd{C-d}
Delete the character underneath the cursor.
@item @w{Printing characters}
Insert itself into the line at the cursor.
-@item @key{C-_}
+@item @kbd{C-_}
Undo the last thing that you did. You can undo all the way back to an
empty line.
@end table
@@ -132,11 +132,11 @@ empty line.
The above table describes the most basic possible keystrokes that you need
in order to do editing of the input line. For your convenience, many
-other commands have been added in addition to @key{C-b}, @key{C-f},
-@key{C-d}, and @key{DEL}. Here are some commands for moving more rapidly
+other commands have been added in addition to @kbd{C-b}, @kbd{C-f},
+@kbd{C-d}, and @key{DEL}. Here are some commands for moving more rapidly
about the line.
-@table @key
+@table @kbd
@item C-a
Move to the start of the line.
@item C-e
@@ -149,7 +149,7 @@ Move backward a word.
Clear the screen, reprinting the current line at the top.
@end table
-Notice how @key{C-f} moves forward a character, while @key{M-f} moves
+Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves
forward a word. It is a loose convention that control keystrokes
operate on characters while meta keystrokes operate on words.
@@ -164,7 +164,7 @@ place later.
Here is the list of commands for killing text.
-@table @key
+@table @kbd
@item C-k
Kill the text from the current cursor position to the end of the line.
@@ -172,25 +172,25 @@ Kill the text from the current cursor position to the end of the line.
Kill from the cursor to the end of the current word, or if between
words, to the end of the next word.
-@item M-DEL
+@item M-@key{DEL}
Kill fromthe cursor the start ofthe previous word, or if between words, to the start of the previous word.
@item C-w
Kill from the cursor to the previous whitespace. This is different than
-@key{M-DEL} because the word boundaries differ.
+@kbd{M-@key{DEL}} because the word boundaries differ.
@end table
And, here is how to @dfn{yank} the text back into the line. Yanking
is
-@table @key
+@table @kbd
@item C-y
Yank the most recently killed text back into the buffer at the cursor.
@item M-y
Rotate the kill-ring, and yank the new top. You can only do this if
-the prior command is @key{C-y} or @key{M-y}.
+the prior command is @kbd{C-y} or @kbd{M-y}.
@end table
When you use a kill command, the text is saved in a @dfn{kill-ring}.
@@ -208,14 +208,14 @@ argument acts as a repeat count, other times it is the @i{sign} of the
argument that is significant. If you pass a negative argument to a
command which normally acts in a forward direction, that command will
act in a backward direction. For example, to kill text back to the
-start of the line, you might type @key{M--} @key{C-k}.
+start of the line, you might type @kbd{M--} @kbd{C-k}.
The general way to pass numeric arguments to a command is to type meta
digits before the command. If the first `digit' you type is a minus
-sign (@key{-}), then the sign of the argument will be negative. Once
+sign (@kbd{-}), then the sign of the argument will be negative. Once
you have typed one meta digit to get the argument started, you can type
the remainder of the digits, and then the command. For example, to give
-the @key{C-d} command an argument of 10, you could type @key{M-1 0 C-d}.
+the @kbd{C-d} command an argument of 10, you could type @kbd{M-1 0 C-d}.
@node Readline Init File, , Readline Interaction, Readline Top
@@ -253,6 +253,7 @@ between the two edges of the screen by placing
@code{set horizontal-scroll-mode On}
@end example
+@noindent
in your @file{~/.inputrc} file.
The syntax for controlling keybindings in the @file{~/.inputrc} file is
@@ -451,20 +452,20 @@ List the possible completions of the text before point.
@appendixsubsubsec Other Commands
@table @code
-@item abort (C-g)
+@item abort (@kbd{C-g})
Ding! Stops things.
-@item do-uppercase-version (M-a, M-b, ...)
+@item do-uppercase-version (@kbd{M-a}, @kbd{M-b}, @dots)
Run the command that is bound to your uppercase brother.
-@item prefix-meta (ESC)
+@item prefix-meta (@key{ESC})
Make the next character that you type be metafied. This is for
-people without a meta key. @key{ESC-f} is equivalent to @key{M-f}.
+people without a meta key. @kbd{@key{ESC}-f} is equivalent to @kbd{M-f}.
-@item undo (C-_)
+@item undo (@kbd{C-_})
Incremental undo, separately remembered for each line.
-@item revert-line (M-r)
+@item revert-line (@kbd{M-r})
Undo all changes made to this line. This is like typing the `undo'
command enough times to get back to the beginning.
@end table