aboutsummaryrefslogtreecommitdiff
path: root/readline/doc/rluserman.info
diff options
context:
space:
mode:
authorElena Zannoni <ezannoni@kwikemart.cygnus.com>2002-08-23 22:02:32 +0000
committerElena Zannoni <ezannoni@kwikemart.cygnus.com>2002-08-23 22:02:32 +0000
commit84041b4c47edb0461f3b82afb77ca2d81819ebfa (patch)
treeddbca1e6f70f9c4a4b6c3c923b16603a95946b22 /readline/doc/rluserman.info
parentf9267e152c9c4e2b150366c590674180e66d45df (diff)
downloadgdb-84041b4c47edb0461f3b82afb77ca2d81819ebfa.zip
gdb-84041b4c47edb0461f3b82afb77ca2d81819ebfa.tar.gz
gdb-84041b4c47edb0461f3b82afb77ca2d81819ebfa.tar.bz2
import of readline-4.3
Diffstat (limited to 'readline/doc/rluserman.info')
-rw-r--r--readline/doc/rluserman.info411
1 files changed, 241 insertions, 170 deletions
diff --git a/readline/doc/rluserman.info b/readline/doc/rluserman.info
index b714421..3fccbd4 100644
--- a/readline/doc/rluserman.info
+++ b/readline/doc/rluserman.info
@@ -1,17 +1,16 @@
-This is Info file rluserman.info, produced by Makeinfo version 1.68
-from the input file
+This is rluserman.info, produced by makeinfo version 4.1 from
/usr/homes/chet/src/bash/readline-src/doc/rluserman.texinfo.
INFO-DIR-SECTION Libraries
START-INFO-DIR-ENTRY
-* Readline: (readline). The GNU readline library API
+* RLuserman: (rluserman). The GNU readline library User's Manual.
END-INFO-DIR-ENTRY
This document describes the end user interface of the GNU Readline
Library, a utility which aids in the consistency of user interface
across discrete programs that need to provide a command line interface.
- Copyright (C) 1988-1999 Free Software Foundation, Inc.
+ Copyright (C) 1988-2002 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice pare
@@ -69,10 +68,10 @@ Introduction to Line Editing
The following paragraphs describe the notation used to represent
keystrokes.
- The text <C-k> is read as `Control-K' and describes the character
+ The text `C-k' is read as `Control-K' and describes the character
produced when the <k> key is pressed while the Control key is depressed.
- The text <M-k> is read as `Meta-K' and describes the character
+ The text `M-k' is read as `Meta-K' and describes the character
produced when the Meta key (if you have one) is depressed, and the <k>
key is pressed. The Meta key is labeled <ALT> on many keyboards. On
keyboards with two keys labeled <ALT> (usually to either side of the
@@ -83,18 +82,18 @@ Compose key for typing accented characters.
If you do not have a Meta or <ALT> key, or another key working as a
Meta key, the identical keystroke can be generated by typing <ESC>
-first, and then typing <k>. Either process is known as "metafying" the
-<k> key.
+_first_, and then typing <k>. Either process is known as "metafying"
+the <k> key.
- The text <M-C-k> is read as `Meta-Control-k' and describes the
-character produced by "metafying" <C-k>.
+ The text `M-C-k' is read as `Meta-Control-k' and describes the
+character produced by "metafying" `C-k'.
In addition, several keys have their own names. Specifically,
<DEL>, <ESC>, <LFD>, <SPC>, <RET>, and <TAB> all stand for themselves
-when seen in this text, or in an init file (*note Readline Init
-File::.). If your keyboard lacks a <LFD> key, typing <C-j> will
-produce the desired character. The <RET> key may be labeled <Return>
-or <Enter> on some keyboards.
+when seen in this text, or in an init file (*note Readline Init File::).
+If your keyboard lacks a <LFD> key, typing <C-j> will produce the
+desired character. The <RET> key may be labeled <Return> or <Enter> on
+some keyboards.

File: rluserman.info, Node: Readline Interaction, Next: Readline Init File, Prev: Introduction and Notation, Up: Command Line Editing
@@ -109,9 +108,9 @@ 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 <RETURN>. You do not have to be at the end
-of the line to press <RETURN>; the entire line is accepted regardless
-of the location of the cursor within the line.
+the line, you simply press <RET>. You do not have to be at the end of
+the line to press <RET>; the entire line is accepted regardless of the
+location of the cursor within the line.
* Menu:
@@ -134,8 +133,8 @@ erase character to back up and delete the mistyped character.
Sometimes you may mistype a character, and not notice the error
until you have typed several other characters. In that case, you can
-type <C-b> to move the cursor to the left, and then correct your
-mistake. Afterwards, you can move the cursor to the right with <C-f>.
+type `C-b' to move the cursor to the left, and then correct your
+mistake. Afterwards, you can move the cursor to the right with `C-f'.
When you add text in the middle of a line, you will notice that
characters to the right of the cursor are `pushed over' to make room
@@ -145,28 +144,28 @@ back' to fill in the blank space created by the removal of the text. A
list of the bare essentials for editing the text of an input line
follows.
-<C-b>
+`C-b'
Move back one character.
-<C-f>
+`C-f'
Move forward one character.
<DEL> or <Backspace>
Delete the character to the left of the cursor.
-<C-d>
+`C-d'
Delete the character underneath the cursor.
Printing characters
Insert the character into the line at the cursor.
-<C-_> or <C-x C-u>
+`C-_' or `C-x C-u'
Undo the last editing command. You can undo all the way back to an
empty line.
(Depending on your configuration, the <Backspace> key be set to delete
the character to the left of the cursor and the <DEL> key set to delete
-the character underneath the cursor, like <C-d>, rather than the
+the character underneath the cursor, like `C-d', rather than the
character to the left of the cursor.)

@@ -177,26 +176,26 @@ Readline Movement Commands
The above table describes the most basic 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 <C-b>, <C-f>, <C-d>, and
+other commands have been added in addition to `C-b', `C-f', `C-d', and
<DEL>. Here are some commands for moving more rapidly about the line.
-<C-a>
+`C-a'
Move to the start of the line.
-<C-e>
+`C-e'
Move to the end of the line.
-<M-f>
+`M-f'
Move forward a word, where a word is composed of letters and
digits.
-<M-b>
+`M-b'
Move backward a word.
-<C-l>
+`C-l'
Clear the screen, reprinting the current line at the top.
- Notice how <C-f> moves forward a character, while <M-f> moves
+ Notice how `C-f' moves forward a character, while `M-f' moves
forward a word. It is a loose convention that control keystrokes
operate on characters while meta keystrokes operate on words.
@@ -223,34 +222,34 @@ available to be yanked back later, when you are typing another line.
Here is the list of commands for killing text.
-<C-k>
+`C-k'
Kill the text from the current cursor position to the end of the
line.
-<M-d>
+`M-d'
Kill from the cursor to the end of the current word, or, if between
words, to the end of the next word. Word boundaries are the same
- as those used by <M-f>.
+ as those used by `M-f'.
-<M-DEL>
- Kill from the cursor the start of the previous word, or, if between
+`M-<DEL>'
+ Kill from the cursor the start of the current word, or, if between
words, to the start of the previous word. Word boundaries are the
- same as those used by <M-b>.
+ same as those used by `M-b'.
-<C-w>
+`C-w'
Kill from the cursor to the previous whitespace. This is
- different than <M-DEL> because the word boundaries differ.
+ different than `M-<DEL>' because the word boundaries differ.
Here is how to "yank" the text back into the line. Yanking means to
copy the most-recently-killed text from the kill buffer.
-<C-y>
+`C-y'
Yank the most recently killed text back into the buffer at the
cursor.
-<M-y>
+`M-y'
Rotate the kill-ring, and yank the new top. You can only do this
- if the prior command is <C-y> or <M-y>.
+ if the prior command is `C-y' or `M-y'.

File: rluserman.info, Node: Readline Arguments, Next: Searching, Prev: Readline Killing Commands, Up: Readline Interaction
@@ -270,7 +269,8 @@ meta digits before the command. If the first `digit' typed is a minus
sign (`-'), 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 <C-d> command an argument of 10, you could type `M-1 0 C-d'.
+the `C-d' command an argument of 10, you could type `M-1 0 C-d', which
+will delete the next ten characters on the input line.

File: rluserman.info, Node: Searching, Prev: Readline Arguments, Up: Readline Interaction
@@ -280,29 +280,34 @@ Searching for Commands in the History
Readline provides commands for searching through the command history
for lines containing a specified string. There are two search modes:
-INCREMENTAL and NON-INCREMENTAL.
+"incremental" and "non-incremental".
Incremental searches begin before the user has finished typing the
search string. As each character of the search string is typed,
Readline displays the next entry from the history matching the string
typed so far. An incremental search requires only as many characters
as needed to find the desired history entry. To search backward in the
-history for a particular string, type <C-r>. Typing <C-s> searches
+history for a particular string, type `C-r'. Typing `C-s' searches
forward through the history. The characters present in the value of
the `isearch-terminators' variable are used to terminate an incremental
search. If that variable has not been assigned a value, the <ESC> and
-<C-J> characters will terminate an incremental search. <C-g> will
+`C-J' characters will terminate an incremental search. `C-g' will
abort an incremental search and restore the original line. When the
search is terminated, the history entry containing the search string
becomes the current line.
- To find other matching entries in the history list, type <C-r> or
-<C-s> as appropriate. This will search backward or forward in the
+ To find other matching entries in the history list, type `C-r' or
+`C-s' as appropriate. This will search backward or forward in the
history for the next entry matching the search string typed so far.
Any other key sequence bound to a Readline command will terminate the
search and execute that command. For instance, a <RET> will terminate
the search and accept the line, thereby executing the command from the
-history list.
+history list. A movement command will terminate the search, make the
+last line found the current line, and begin editing.
+
+ Readline remembers the last incremental search string. If two
+`C-r's are typed without any intervening characters defining a new
+search string, any remembered search string is used.
Non-incremental searches read the entire search string before
starting to search for matching history lines. The search string may be
@@ -345,17 +350,24 @@ Readline Init File Syntax
There are only a few basic constructs allowed in the Readline init
file. Blank lines are ignored. Lines beginning with a `#' are
comments. Lines beginning with a `$' indicate conditional constructs
-(*note Conditional Init Constructs::.). Other lines denote variable
+(*note Conditional Init Constructs::). Other lines denote variable
settings and key bindings.
Variable Settings
You can modify the run-time behavior of Readline by altering the
values of variables in Readline using the `set' command within the
- init file. Here is how to change from the default Emacs-like key
- binding to use `vi' line editing commands:
+ init file. The syntax is simple:
+
+ set VARIABLE VALUE
+
+ Here, for example, is how to change from the default Emacs-like
+ key binding to use `vi' line editing commands:
set editing-mode vi
+ Variable names and values, where appropriate, are recognized
+ without regard to case.
+
A great deal of run-time behavior is changeable with the following
variables.
@@ -382,7 +394,8 @@ Variable Settings
possibilities. If the number of possible completions is
greater than this value, Readline will ask the user whether
or not he wishes to view them; otherwise, they are simply
- listed. The default limit is `100'.
+ listed. This variable must be set to an integer value
+ greater than or equal to 0. The default limit is `100'.
`convert-meta'
If set to `on', Readline will convert characters with the
@@ -410,6 +423,10 @@ Variable Settings
If set to `on', tilde expansion is performed when Readline
attempts word completion. The default is `off'.
+ If set to `on', the history code attempts to place point at
+ the same location on each history line retrived with
+ `previous-history' or `next-history'.
+
`horizontal-scroll-mode'
This variable can be set to either `on' or `off'. Setting it
to `on' means that the text of the lines being edited will
@@ -419,7 +436,7 @@ Variable Settings
`input-meta'
If set to `on', Readline will enable eight-bit input (it will
- not strip the eighth bit from the characters it reads),
+ not clear the eighth bit in the characters it reads),
regardless of what the terminal claims it can support. The
default value is `off'. The name `meta-flag' is a synonym
for this variable.
@@ -427,14 +444,14 @@ Variable Settings
`isearch-terminators'
The string of characters that should terminate an incremental
search without subsequently executing the character as a
- command (*note Searching::.). If this variable has not been
- given a value, the characters <ESC> and <C-J> will terminate
+ command (*note Searching::). If this variable has not been
+ given a value, the characters <ESC> and `C-J' will terminate
an incremental search.
`keymap'
Sets Readline's idea of the current keymap for key binding
commands. Acceptable `keymap' names are `emacs',
- `emacs-standard', `emacs-meta', `emacs-ctlx', `vi',
+ `emacs-standard', `emacs-meta', `emacs-ctlx', `vi', `vi-move',
`vi-command', and `vi-insert'. `vi' is equivalent to
`vi-command'; `emacs' is equivalent to `emacs-standard'. The
default value is `emacs'. The value of the `editing-mode'
@@ -449,11 +466,28 @@ Variable Settings
asterisk (`*') at the start of history lines which have been
modified. This variable is `off' by default.
+ `mark-symlinked-directories'
+ If set to `on', completed names which are symbolic links to
+ directories have a slash appended (subject to the value of
+ `mark-directories'). The default is `off'.
+
+ `match-hidden-files'
+ This variable, when set to `on', causes Readline to match
+ files whose names begin with a `.' (hidden files) when
+ performing filename completion, unless the leading `.' is
+ supplied by the user in the filename to be completed. This
+ variable is `on' by default.
+
`output-meta'
If set to `on', Readline will display characters with the
eighth bit set directly rather than as a meta-prefixed escape
sequence. The default is `off'.
+ `page-completions'
+ If set to `on', Readline uses an internal `more'-like pager
+ to display a screenful of possible completions at a time.
+ This variable is `on' by default.
+
`print-completions-horizontally'
If set to `on', Readline will display completions with matches
sorted horizontally in alphabetical order, rather than down
@@ -477,11 +511,14 @@ Key Bindings
command name, the default keybinding, if any, and a short
description of what the command does.
- Once you know the name of the command, simply place the name of
- the key you wish to bind the command to, a colon, and then the
- name of the command on a line in the init file. The name of the
- key can be expressed in different ways, depending on which is most
- comfortable for you.
+ Once you know the name of the command, simply place on a line in
+ the init file the name of the key you wish to bind the command to,
+ a colon, and then the name of the command. The name of the key
+ can be expressed in different ways, depending on what you find most
+ comfortable.
+
+ In addition to command names, readline allows keys to be bound to
+ a string that is inserted when the key is pressed (a MACRO).
KEYNAME: FUNCTION-NAME or MACRO
KEYNAME is the name of a key spelled out in English. For
@@ -490,11 +527,16 @@ Key Bindings
Meta-Rubout: backward-kill-word
Control-o: "> output"
- In the above example, <C-u> is bound to the function
- `universal-argument', and <C-o> is bound to run the macro
+ In the above example, `C-u' is bound to the function
+ `universal-argument', `M-DEL' is bound to the function
+ `backward-kill-word', and `C-o' is bound to run the macro
expressed on the right hand side (that is, to insert the text
`> output' into the line).
+ A number of symbolic character names are recognized while
+ processing this key binding syntax: DEL, ESC, ESCAPE, LFD,
+ NEWLINE, RET, RETURN, RUBOUT, SPACE, SPC, and TAB.
+
"KEYSEQ": FUNCTION-NAME or MACRO
KEYSEQ differs from KEYNAME above in that strings denoting an
entire key sequence can be specified, by placing the key
@@ -506,11 +548,11 @@ Key Bindings
"\C-x\C-r": re-read-init-file
"\e[11~": "Function Key 1"
- In the above example, <C-u> is bound to the function
+ In the above example, `C-u' is again bound to the function
`universal-argument' (just as it was in the first example),
- `<C-x> <C-r>' is bound to the function `re-read-init-file',
- and `<ESC> <[> <1> <1> <~>' is bound to insert the text
- `Function Key 1'.
+ `C-x C-r' is bound to the function `re-read-init-file', and
+ `<ESC> <[> <1> <1> <~>' is bound to insert the text `Function
+ Key 1'.
The following GNU Emacs style escape sequences are available when
specifying key sequences:
@@ -561,13 +603,13 @@ Key Bindings
vertical tab
`\NNN'
- the character whose `ASCII' code is the octal value NNN (one
- to three digits)
-
- `\xNNN'
- the character whose `ASCII' code is the hexadecimal value NNN
+ the eight-bit character whose value is the octal value NNN
(one to three digits)
+ `\xHH'
+ the eight-bit character whose value is the hexadecimal value
+ HH (one or two hex digits)
+
When entering the text of a macro, single or double quotes must be
used to indicate a macro definition. Unquoted text is assumed to
be a function name. In the macro body, the backslash escapes
@@ -614,10 +656,10 @@ are four parser directives used.
The APPLICATION construct is used to include
application-specific settings. Each program using the
Readline library sets the APPLICATION NAME, and you can test
- for it. This could be used to bind key sequences to
- functions useful for a specific program. For instance, the
- following command adds a key sequence that quotes the current
- or previous word in Bash:
+ for a particular value. This could be used to bind key
+ sequences to functions useful for a specific program. For
+ instance, the following command adds a key sequence that
+ quotes the current or previous word in Bash:
$if Bash
# Quote the current or previous word
"\C-xq": "\eb\"\ef\""
@@ -633,7 +675,8 @@ are four parser directives used.
`$include'
This directive takes a single filename as an argument and reads
- commands and bindings from that file.
+ commands and bindings from that file. For example, the following
+ directive reads from `/etc/inputrc':
$include /etc/inputrc

@@ -642,19 +685,19 @@ File: rluserman.info, Node: Sample Init File, Prev: Conditional Init Construct
Sample Init File
----------------
- Here is an example of an inputrc file. This illustrates key
+ Here is an example of an INPUTRC file. This illustrates key
binding, variable assignment, and conditional syntax.
# This file controls the behaviour of line input editing for
- # programs that use the Gnu Readline library. Existing programs
- # include FTP, Bash, and Gdb.
+ # programs that use the GNU Readline library. Existing
+ # programs include FTP, Bash, and GDB.
#
# You can re-read the inputrc file with C-x C-r.
# Lines beginning with '#' are comments.
#
- # First, include any systemwide bindings and variable assignments from
- # /etc/Inputrc
+ # First, include any systemwide bindings and variable
+ # assignments from /etc/Inputrc
$include /etc/Inputrc
#
@@ -706,10 +749,12 @@ binding, variable assignment, and conditional syntax.
$if Bash
# edit the path
"\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f"
- # prepare to type a quoted word -- insert open and close double quotes
+ # prepare to type a quoted word --
+ # insert open and close double quotes
# and move to just after the open quote
"\C-x\"": "\"\"\C-b"
- # insert a backslash (testing backslash escapes in sequences and macros)
+ # insert a backslash (testing backslash escapes
+ # in sequences and macros)
"\C-x\\": "\\"
# Quote the current or previous word
"\C-xq": "\eb\"\ef\""
@@ -725,16 +770,16 @@ binding, variable assignment, and conditional syntax.
# don't strip characters to 7 bits when reading
set input-meta on
- # allow iso-latin1 characters to be inserted rather than converted to
- # prefix-meta sequences
+ # allow iso-latin1 characters to be inserted rather
+ # than converted to prefix-meta sequences
set convert-meta off
- # display characters with the eighth bit set directly rather than
- # as meta-prefixed characters
+ # display characters with the eighth bit set directly
+ # rather than as meta-prefixed characters
set output-meta on
- # if there are more than 150 possible completions for a word, ask the
- # user if he wants to see all of them
+ # if there are more than 150 possible completions for
+ # a word, ask the user if he wants to see all of them
set completion-query-items 150
# For FTP
@@ -762,13 +807,13 @@ Bindable Readline Commands
* Miscellaneous Commands:: Other miscellaneous commands.
This section describes Readline commands that may be bound to key
-sequences.
+sequences. Command names without an accompanying key sequence are
+unbound by default.
- Command names without an accompanying key sequence are unbound by
-default. In the following descriptions, POINT refers to the current
-cursor position, and MARK refers to a cursor position saved by the
+ In the following descriptions, "point" refers to the current cursor
+position, and "mark" refers to a cursor position saved by the
`set-mark' command. The text between the point and mark is referred to
-as the REGION.
+as the "region".

File: rluserman.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands
@@ -809,16 +854,18 @@ File: rluserman.info, Node: Commands For History, Next: Commands For Text, Pr
Commands For Manipulating The History
-------------------------------------
-`accept-line (Newline, Return)'
+`accept-line (Newline or Return)'
Accept the line regardless of where the cursor is. If this line is
- non-empty, add it to the history list. If this line was a history
- line, then restore the history line to its original state.
+ non-empty, it may be added to the history list for future recall
+ with `add_history()'. If this line is a modified history line,
+ the history line is restored to its original state.
`previous-history (C-p)'
- Move `up' through the history list.
+ Move `back' through the history list, fetching the previous
+ command.
`next-history (C-n)'
- Move `down' through the history list.
+ Move `forward' through the history list, fetching the next command.
`beginning-of-history (M-<)'
Move to the first line in the history.
@@ -858,12 +905,12 @@ Commands For Manipulating The History
`yank-nth-arg (M-C-y)'
Insert the first argument to the previous command (usually the
- second word on the previous line). With an argument N, insert the
- Nth word from the previous command (the words in the previous
- command begin with word 0). A negative argument inserts the Nth
- word from the end of the previous command.
+ second word on the previous line) at point. With an argument N,
+ insert the Nth word from the previous command (the words in the
+ previous command begin with word 0). A negative argument inserts
+ the Nth word from the end of the previous command.
-`yank-last-arg (M-., M-_)'
+`yank-last-arg (M-. or M-_)'
Insert last argument to the previous command (the last word of the
previous history entry). With an argument, behave exactly like
`yank-nth-arg'. Successive calls to `yank-last-arg' move back
@@ -877,10 +924,9 @@ Commands For Changing Text
--------------------------
`delete-char (C-d)'
- Delete the character under the cursor. If the cursor is at the
- beginning of the line, there are no characters in the line, and
- the last character typed was not bound to `delete-char', then
- return `EOF'.
+ Delete the character at point. If point is at the beginning of
+ the line, there are no characters in the line, and the last
+ character typed was not bound to `delete-char', then return EOF.
`backward-delete-char (Rubout)'
Delete the character behind the cursor. A numeric argument means
@@ -891,11 +937,11 @@ Commands For Changing Text
end of the line, in which case the character behind the cursor is
deleted. By default, this is not bound to a key.
-`quoted-insert (C-q, C-v)'
+`quoted-insert (C-q or C-v)'
Add the next character typed to the line verbatim. This is how to
- insert key sequences like <C-q>, for example.
+ insert key sequences like `C-q', for example.
-`tab-insert (M-TAB)'
+`tab-insert (M-<TAB>)'
Insert a tab character.
`self-insert (a, b, A, 1, !, ...)'
@@ -909,7 +955,8 @@ Commands For Changing Text
`transpose-words (M-t)'
Drag the word before point past the word after point, moving point
- past that word as well.
+ past that word as well. If the insertion point is at the end of
+ the line, this transposes the last two words on the line.
`upcase-word (M-u)'
Uppercase the current (or following) word. With a negative
@@ -923,6 +970,20 @@ Commands For Changing Text
Capitalize the current (or following) word. With a negative
argument, capitalize the previous word, but do not move the cursor.
+`overwrite-mode ()'
+ Toggle overwrite mode. With an explicit positive numeric argument,
+ switches to overwrite mode. With an explicit non-positive numeric
+ argument, switches to insert mode. This command affects only
+ `emacs' mode; `vi' mode does overwrite differently. Each call to
+ `readline()' starts in insert mode.
+
+ In overwrite mode, characters bound to `self-insert' replace the
+ text at point rather than pushing the text to the right.
+ Characters bound to `backward-delete-char' replace the character
+ before point with a space.
+
+ By default, this command is unbound.
+

File: rluserman.info, Node: Commands For Killing, Next: Numeric Arguments, Prev: Commands For Text, Up: Bindable Readline Commands
@@ -939,15 +1000,15 @@ Killing And Yanking
Kill backward from the cursor to the beginning of the current line.
`kill-whole-line ()'
- Kill all characters on the current line, no matter point is. By
- default, this is unbound.
+ Kill all characters on the current line, no matter where point is.
+ By default, this is unbound.
`kill-word (M-d)'
Kill from point to the end of the current word, or if between
words, to the end of the next word. Word boundaries are the same
as `forward-word'.
-`backward-kill-word (M-DEL)'
+`backward-kill-word (M-<DEL>)'
Kill the word behind point. Word boundaries are the same as
`backward-word'.
@@ -978,12 +1039,11 @@ Killing And Yanking
command is unbound.
`yank (C-y)'
- Yank the top of the kill ring into the buffer at the current
- cursor position.
+ Yank the top of the kill ring into the buffer at point.
`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.
+ if the prior command is `yank' or `yank-pop'.

File: rluserman.info, Node: Numeric Arguments, Next: Commands For Completion, Prev: Commands For Killing, Up: Bindable Readline Commands
@@ -993,7 +1053,7 @@ Specifying Numeric Arguments
`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. `M--' starts a negative argument.
`universal-argument ()'
This is another way to specify an argument. If this command is
@@ -1014,17 +1074,13 @@ File: rluserman.info, Node: Commands For Completion, Next: Keyboard Macros, P
Letting Readline Type For You
-----------------------------
-`complete (TAB)'
- Attempt to do completion on the text before the cursor. This is
- application-specific. Generally, if you are typing a filename
- argument, you can do filename completion; if you are typing a
- command, you can do command completion; if you are typing in a
- symbol to GDB, you can do symbol name completion; if you are
- typing in a variable to Bash, you can do variable name completion,
- and so on.
+`complete (<TAB>)'
+ Attempt to perform completion on the text before point. The
+ actual completion performed is application-specific. The default
+ is filename completion.
`possible-completions (M-?)'
- List the possible completions of the text before the cursor.
+ List the possible completions of the text before point.
`insert-completions (M-*)'
Insert all completions of the text before point that would have
@@ -1035,10 +1091,11 @@ Letting Readline Type For You
a single match from the list of possible completions. Repeated
execution of `menu-complete' steps through the list of possible
completions, inserting each match in turn. At the end of the list
- of completions, the bell is rung and the original text is restored.
- An argument of N moves N positions forward in the list of matches;
- a negative argument may be used to move backward through the list.
- This command is intended to be bound to `TAB', but is unbound by
+ of completions, the bell is rung (subject to the setting of
+ `bell-style') and the original text is restored. An argument of N
+ moves N positions forward in the list of matches; a negative
+ argument may be used to move backward through the list. This
+ command is intended to be bound to <TAB>, but is unbound by
default.
`delete-char-or-list ()'
@@ -1082,11 +1139,11 @@ Some Miscellaneous Commands
If the metafied character X is lowercase, run the command that is
bound to the corresponding uppercase character.
-`prefix-meta (ESC)'
- Make the next character typed be metafied. This is for keyboards
- without a meta key. Typing `ESC f' is equivalent to typing `M-f'.
+`prefix-meta (<ESC>)'
+ Metafy the next character typed. This is for keyboards without a
+ meta key. Typing `<ESC> f' is equivalent to typing `M-f'.
-`undo (C-_, C-x C-u)'
+`undo (C-_ or C-x C-u)'
Incremental undo, separately remembered for each line.
`revert-line (M-r)'
@@ -1097,8 +1154,8 @@ Some Miscellaneous Commands
Perform tilde expansion on the current word.
`set-mark (C-@)'
- Set the mark to the current point. If a numeric argument is
- supplied, the mark is set to that position.
+ Set the mark to the point. If a numeric argument is supplied, the
+ mark is set to that position.
`exchange-point-and-mark (C-x C-x)'
Swap the point with the mark. The current cursor position is set
@@ -1116,9 +1173,14 @@ Some Miscellaneous Commands
occurrences.
`insert-comment (M-#)'
- The value of the `comment-begin' variable is inserted at the
- beginning of the current line, and the line is accepted as if a
- newline had been typed.
+ Without a numeric argument, the value of the `comment-begin'
+ variable is inserted at the beginning of the current line. If a
+ numeric argument is supplied, this command acts as a toggle: if
+ the characters at the beginning of the line do not match the value
+ of `comment-begin', the value is inserted, otherwise the
+ characters in `comment-begin' are deleted from the beginning of
+ the line. In either case, the line is accepted as if a newline
+ had been typed.
`dump-functions ()'
Print all of the functions and their key bindings to the Readline
@@ -1134,9 +1196,17 @@ Some Miscellaneous Commands
`dump-macros ()'
Print all of the Readline key sequences bound to macros and the
- strings they ouput. If a numeric argument is supplied, the output
- is formatted in such a way that it can be made part of an INPUTRC
- file. This command is unbound by default.
+ strings they output. If a numeric argument is supplied, the
+ output is formatted in such a way that it can be made part of an
+ INPUTRC file. This command is unbound by default.
+
+`emacs-editing-mode (C-e)'
+ When in `vi' command mode, this causes a switch to `emacs' editing
+ mode.
+
+`vi-editing-mode (M-C-j)'
+ When in `emacs' editing mode, this causes a switch to `vi' editing
+ mode.

File: rluserman.info, Node: Readline vi Mode, Prev: Bindable Readline Commands, Up: Command Line Editing
@@ -1150,7 +1220,8 @@ The Readline `vi' mode behaves as specified in the POSIX 1003.2
standard.
In order to switch interactively between `emacs' and `vi' editing
-modes, use the command M-C-j (toggle-editing-mode). The Readline
+modes, use the command `M-C-j' (bound to emacs-editing-mode when in
+`vi' mode and to vi-editing-mode in `emacs' mode). The Readline
default is `emacs' mode.
When you enter a line in `vi' mode, you are already placed in
@@ -1162,28 +1233,28 @@ the standard `vi' movement keys, move to previous history lines with

Tag Table:
-Node: Top1221
-Node: Command Line Editing1617
-Node: Introduction and Notation2231
-Node: Readline Interaction3850
-Node: Readline Bare Essentials5044
-Node: Readline Movement Commands6826
-Node: Readline Killing Commands7784
-Node: Readline Arguments9691
-Node: Searching10667
-Node: Readline Init File12511
-Node: Readline Init File Syntax13573
-Node: Conditional Init Constructs22839
-Node: Sample Init File25279
-Node: Bindable Readline Commands28450
-Node: Commands For Moving29495
-Node: Commands For History30345
-Node: Commands For Text33063
-Node: Commands For Killing35067
-Node: Numeric Arguments37035
-Node: Commands For Completion38163
-Node: Keyboard Macros39912
-Node: Miscellaneous Commands40472
-Node: Readline vi Mode43277
+Node: Top1208
+Node: Command Line Editing1604
+Node: Introduction and Notation2218
+Node: Readline Interaction3837
+Node: Readline Bare Essentials5025
+Node: Readline Movement Commands6807
+Node: Readline Killing Commands7765
+Node: Readline Arguments9675
+Node: Searching10712
+Node: Readline Init File12856
+Node: Readline Init File Syntax13918
+Node: Conditional Init Constructs24802
+Node: Sample Init File27328
+Node: Bindable Readline Commands30513
+Node: Commands For Moving31564
+Node: Commands For History32414
+Node: Commands For Text35273
+Node: Commands For Killing37988
+Node: Numeric Arguments39940
+Node: Commands For Completion41069
+Node: Keyboard Macros42602
+Node: Miscellaneous Commands43162
+Node: Readline vi Mode46512

End Tag Table