which contains both end-user and programmer documentation for the GNU
Readline Library.
-Copyright (C) 1988 Free Software Foundation, Inc.
+Copyright (C) 1988, 1991 Free Software Foundation, Inc.
-Authored by Brian Fox.
+Written by Brian Fox.
Permission is granted to process this file through Tex and print the
results, provided the printed document carries copying permission notice
@appendix Command Line Editing
This appendix describes GNU's command line editing interface.
+Often during an interactive session you will type in a long line of
+text, only to notice that the first word on the line is misspelled. The
+Readline library gives you a set of commands for manipulating the text
+as you type it in, allowing you to just fix your typo, and not forcing
+you to retype the majority of the line. Using these editing commands,
+you move the cursor to the place that needs correction, and delete or
+insert the text of the corrections. Then, when you are satisfied with
+the line, you simply press @key{RETURN}. You do not have to be at the
+end of the line to press @key{RETURN}; the entire line will be accepted
+in any case.
@menu
-* Introduction and Notation:: Notation used in this appendix.
+* Conventions:: Notation used in this appendix.
* Basic Line Editing:: The minimum set of commands for editing a line.
* Movement Commands:: Commands for moving the cursor about the line.
* Cutting and Pasting:: Deletion and copying of text sections.
the full text.
@end menu
-@node Introduction and Notation, Basic Line Editing, Command Line Editing, Command Line Editing
-@section Introduction to Line Editing
+@node Conventions, Basic Line Editing, Command Line Editing, Command Line Editing
+@appendixsec Conventions on Notation
-In this appendix a the following notation is used to describe
+In this Appendix, 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
-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 @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, it is equivalent
+to type @key{ESC} @i{first}, and then type @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
(@pxref{Readline Init File}, for more info).
@node Readline Interaction, Readline Init File, Readline Introduction, Readline Top
-@section Readline Interaction
+@appendixsec Readline Interaction
@cindex interaction, readline
-Often during an interactive session you will type in a long line of
-text, only to notice that the first word on the line is misspelled. The
-Readline library gives you a set of commands for manipulating the text
-as you type it in, allowing you to just fix your typo, and not forcing
-you to retype the majority of the line. Using these editing commands,
-you move the cursor to the place that needs correction, and delete or
-insert the text of the corrections. Then, when you are satisfied with
-the line, you simply press @key{RETURN}. You do not have to be at the
-end of the line to press @key{RETURN}; the entire line will be accepted
-in any case.
-
@menu
* Readline Bare Essentials:: The least you need to know about Readline.
* Readline Movement Commands:: Moving about the input line.
@end menu
@node Readline Bare Essentials, Readline Movement Commands, Readline Interaction, Readline Interaction
-@subsection Readline Bare Essentials
+@appendixsubsec Bare Essentials
In order to enter characters into the line, simply type them. The typed
character appears where the cursor was, and then the cursor moves one
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
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 @var{c}
+Insert an ordinary printing character @var{c} into the line at the cursor.
+@item @kbd{C-_}
Undo the last thing that you did. You can undo all the way back to an
empty line.
@end table
@node Readline Movement Commands, Readline Killing Commands, Readline Bare Essentials, Readline Interaction
-@subsection Readline Movement Commands
+@appendixsubsec Movement Commands
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
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.
@node Readline Killing Commands, Readline Arguments, Readline Movement Commands, Readline Interaction
-@subsection Readline Killing Commands
+@appendixsubsec Killing Commands
@dfn{Killing} text means to delete the text from the line, but to save
it away for later use, usually by @dfn{yanking} it back into the line.
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.
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
-Kill fromthe cursor the start ofthe previous word, or if between words, to the start of the previous word.
+@item M-@key{DEL}
+Kill from the 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}.
another line.
@node Readline Arguments, , Readline Killing Commands, Readline Interaction
-@subsection Readline Arguments
+@appendixsubsec Arguments
You can pass numeric arguments to Readline commands. Sometimes the
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
-@section Readline Init File
+@appendixsec Readline Init File
Although the Readline library comes with a set of Emacs-like
keybindings, it is possible that you would like to use a different set
commands in an @dfn{init} file in your home directory. The name of this
file is @file{~/.inputrc}.
-When a program which uses the Readline library starts up, the
-@file{~/.inputrc} file is read, and the keybindings are set.
+When a program which uses the Readline library starts up, it reads the file
+@file{~/.inputrc}, and sets the keybindings.
@menu
* Readline Init Syntax:: Syntax for the commands in @file{~/.inputrc}.
@end menu
@node Readline Init Syntax, Readline Vi Mode, Readline Init File, Readline Init File
-@subsection Readline Init Syntax
+@appendixsubsec Readline Init Syntax
You can start up with a vi-like editing mode by placing
@code{set editing-mode vi}
@end example
+@noindent
in your @file{~/.inputrc} file.
You can have Readline use a single line for display, scrolling the input
@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
@end menu
@node Commands For Moving, Commands For History, Readline Init Syntax, Readline Init Syntax
-@subsubsection Commands For Moving
+@appendixsubsubsec Moving
@table @code
@item beginning-of-line (C-a)
Move to the start of the current line.
@end table
@node Commands For History, Commands For Text, Commands For Moving, Readline Init Syntax
-@subsubsection Commands For Manipulating The History
+@appendixsubsubsec Using the History
@table @code
@item accept-line (Newline, Return)
@end table
@node Commands For Text, Commands For Killing, Commands For History, Readline Init Syntax
-@subsubsection Commands For Changing Text
+@appendixsubsubsec Changing Text
@table @code
@item delete-char (C-d)
Insert a tab character.
@item self-insert (a, b, A, 1, !, ...)
-Insert yourself.
+Insert an ordinary printing character into the line.
@item transpose-chars (C-t)
Drag the character before point forward over the character at point.
@end table
@node Commands For Killing, Numeric Arguments, Commands For Text, Readline Init Syntax
-@subsubsection Killing And Yanking
+@appendixsubsubsec Killing And Yanking
@table @code
Kill the word behind the cursor.
@item unix-line-discard (C-u)
-Do what C-u used to do in Unix line input. We save the killed text on
-the kill-ring, though.
+Kill the entire line. This is similar to the use of the Unix kill
+character (often also @key{C-u}), save that here the killed text can be
+retrieved later (since it goes on the kill-ring).
@item unix-word-rubout (C-w)
-Do what C-w used to do in Unix line input. The killed text is saved
-on the kill-ring. This is different than backward-kill-word because
-the word boundaries differ.
+Kill the current word, like the Unix word erase character. The killed
+text goes on the kill-ring. This is different than
+@code{backward-kill-word} because the word boundaries differ.
@item yank (C-y)
Yank the top of the kill ring into the buffer at point.
@item yank-pop (M-y)
Rotate the kill-ring, and yank the new top. You can only do this if
-the prior command is yank or yank-pop.
+the prior command is @code{yank} or @code{yank-pop}.
@end table
@node Numeric Arguments, Commands For Completion, Commands For Killing, Readline Init Syntax
-@subsubsection Specifying Numeric Arguments
+@appendixsubsubsec Numeric Arguments
@table @code
@item digit-argument (M-0, M-1, ... M--)
Add this digit to the argument already accumulating, or start a new
-argument. M-- starts a negative argument.
+argument. @kbd{M--} starts a negative argument.
@item universal-argument ()
-Do what C-u does in emacs. By default, this is not bound.
+Do what @key{C-u} does in emacs. By default, this is not bound to any keys.
@end table
@node Commands For Completion, Miscellaneous Commands, Numeric Arguments, Readline Init Syntax
-@subsubsection Letting Readline Type For You
+@appendixsubsubsec Letting Readline Type
@table @code
@item complete (TAB)
@end table
@node Miscellaneous Commands, , Commands For Completion, Readline Init Syntax
-@subsubsection Some Miscellaneous Commands
+@appendixsubsubsec Other Commands
@table @code
-@item abort (C-g)
-Ding! Stops things.
+@item abort (@kbd{C-g})
+The line editing commands @code{reverse-search-history} (@kbd{C-r}) and
+@code{forward-search-history} (@kbd{C-s} go into a separate input mode;
+you can abort the search, and return to normal input mode, by using the
+@code{abort} (@kbd{C-g}) command.
-@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
-@node Readline Vi Mode, , Readline Init Syntax, Readline Init File
-@subsection Readline Vi Mode
+@node Readline vi Mode, , Readline Init Syntax, Readline Init File
+@appendixsubsec Readline @code{vi} Mode
-While the Readline library does not have a full set of Vi editing
+While the Readline library does not have a full set of @code{vi} editing
functions, it does contain enough to allow simple editing of the line.
-In order to switch interactively between Emacs and Vi editing modes, use
-the command M-C-j (toggle-editing-mode).
+In order to switch interactively between Emacs and @code{vi} editing modes, use
+the command @kbd{M-C-j} (@code{toggle-editing-mode}).
-When you enter a line in Vi mode, you are already placed in `insertion'
-mode, as if you had typed an `i'. Pressing @key{ESC} switches you into
-`edit' mode, where you can edit the text of the line with the standard
-Vi movement keys, move to previous history lines with `k', and following
-lines with `j', and so forth.
+When you enter a line in @code{vi} mode, you are already in
+``insertion'' mode, as if you had typed an @kbd{i}. Pressing @key{ESC}
+switches you into ``edit'' mode, where you can edit the text of the line
+with the standard @code{vi} movement keys, move to previous history
+lines with @kbd{k}, to following lines with @kbd{j}, and so forth.
projects / external / binutils.git / blobdiff