summaryrefslogtreecommitdiff
path: root/doc/readline.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/readline.3')
-rw-r--r--doc/readline.3319
1 files changed, 197 insertions, 122 deletions
diff --git a/doc/readline.3 b/doc/readline.3
index 77ef02a..b5ca022 100644
--- a/doc/readline.3
+++ b/doc/readline.3
@@ -6,15 +6,36 @@
.\" Case Western Reserve University
.\" chet.ramey@case.edu
.\"
-.\" Last Change: Mon Sep 19 11:11:22 EDT 2022
+.\" Last Change: Fri Mar 29 11:54:44 EDT 2024
.\"
-.TH READLINE 3 "2022 September 19" "GNU Readline 8.2"
+.TH READLINE 3 "2024 March 29" "GNU Readline 8.3"
.\"
+.ie \n(.g \{\
+.ds ' \(aq
+.ds " \(dq
+.ds ^ \(ha
+.ds ~ \(ti
+.\}
+.el \{\
+.ds ' '
+.\" not usable in macro arguments on AT&T troff (DWB, Solaris 10)
+.ds " ""\" two adjacent quotes and no space before this comment
+.ds ^ ^
+.ds ~ ~
+.\}
+.
.\" File Name macro. This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
.\"
.de FN
-\fI\|\\$1\|\fP
+\%\fI\|\\$1\|\fP
+..
+.de Q
+.ie \n(.g \(lq\\$1\(rq\\$2
+.el \{\
+. if t ``\\$1''\\$2
+. if n "\\$1"\\$2
+.\}
..
.SH NAME
readline \- get a line from a user with editing
@@ -34,15 +55,15 @@ readline \- get a line from a user with editing
\fBreadline\fP (\fIconst char *prompt\fP);
.fi
.SH COPYRIGHT
-.if n Readline is Copyright (C) 1989\-2020 Free Software Foundation, Inc.
-.if t Readline is Copyright \(co 1989\-2020 Free Software Foundation, Inc.
+.if n Readline is Copyright (C) 1989\-2024 Free Software Foundation, Inc.
+.if t Readline is Copyright \(co 1989\-2024 Free Software Foundation, Inc.
.SH DESCRIPTION
.LP
.B readline
will read a line from the terminal
and return it, using
.B prompt
-as a prompt. If
+as a prompt. If
.B prompt
is \fBNULL\fP or the empty string, no prompt is issued.
The line returned is allocated with
@@ -50,6 +71,9 @@ The line returned is allocated with
the caller must free it when finished. The line returned
has the final newline removed, so only the text of the line
remains.
+Since it's possible to enter characters into the line while quoting
+them to disable any \fBreadline\fP editing function they might normally have,
+this line may include embedded newlines and other special characters.
.LP
.B readline
offers editing capabilities while the user is entering the
@@ -77,11 +101,12 @@ treated as a newline.
.SH NOTATION
.LP
An Emacs-style notation is used to denote
-keystrokes. Control keys are denoted by C\-\fIkey\fR, e.g., C\-n
-means Control\-N. Similarly,
+keystrokes.
+Control keys are denoted by C\-\fIkey\fP, e.g., C\-n means Control\-N.
+Similarly,
.I meta
-keys are denoted by M\-\fIkey\fR, so M\-x means Meta\-X. (On keyboards
-without a
+keys are denoted by M\-\fIkey\fP, so M\-x means Meta\-X.
+(On keyboards without a
.I meta
key, M\-\fIx\fP means ESC \fIx\fP, i.e., press the Escape key
then the
@@ -116,7 +141,7 @@ file (the \fIinputrc\fP file).
The name of this file is taken from the value of the
.B INPUTRC
environment variable. If that variable is unset, the default is
-.IR ~/.inputrc .
+.IR \*~/.inputrc .
If that file does not exist or cannot be read, the ultimate default is
.IR /etc/inputrc .
When a program which uses the readline library starts up, the
@@ -138,7 +163,7 @@ or
.RS
C\-Meta\-u: universal\-argument
.RE
-.sp
+.LP
into the
.I inputrc
would make M\-C\-u execute the readline command
@@ -176,13 +201,15 @@ whitespace between the name and the colon.
When using the form \fBkeyname\fP:\^\fIfunction-name\fP or \fImacro\fP,
.I keyname
is the name of a key spelled out in English. For example:
-.sp
+.PP
.RS
-Control\-u: universal\-argument
-.br
-Meta\-Rubout: backward\-kill\-word
-.br
-Control\-o: "> output"
+.EX
+.nf
+Control-u: universal\-argument
+Meta-Rubout: backward\-kill\-word
+Control-o: \*"> output\*"
+.fi
+.EE
.RE
.LP
In the above example,
@@ -196,11 +223,11 @@ and
.I C\-o
is bound to run the macro
expressed on the right hand side (that is, to insert the text
-.if t \f(CW> output\fP
-.if n ``> output''
+.Q "> output"
into the line).
.PP
-In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP,
+In the second form,
+\fB\*"keyseq\*"\fP:\^\fIfunction\-name\fP or \fImacro\fP,
.B keyseq
differs from
.B keyname
@@ -209,13 +236,15 @@ an entire key sequence may be specified by placing the sequence
within double quotes. Some GNU Emacs style key escapes can be
used, as in the following example, but the symbolic character names
are not recognized.
-.sp
+.PP
.RS
-"\eC\-u": universal\-argument
-.br
-"\eC\-x\eC\-r": re\-read\-init\-file
-.br
-"\ee[11~": "Function Key 1"
+.EX
+.nf
+\*"\eC\-u\*": universal\-argument
+\*"\eC\-x\eC\-r\*": re\-read\-init\-file
+\*"\ee[11\*~\*": \*"Function Key 1\*"
+.fi
+.EE
.RE
.PP
In this example,
@@ -226,10 +255,9 @@ is again bound to the function
is bound to the function
.BR re\-read\-init\-file ,
and
-.I "ESC [ 1 1 ~"
+.I "ESC [ 1 1 \*~"
is bound to insert the text
-.if t \f(CWFunction Key 1\fP.
-.if n ``Function Key 1''.
+.Q "Function Key 1" .
.PP
The full set of GNU Emacs style escape sequences available when specifying
key sequences is
@@ -248,11 +276,11 @@ an escape character
.B \e\e
backslash
.TP
-.B \e"
-literal ", a double quote
+.B \e\*"
+literal \*", a double quote
.TP
-.B \e'
-literal ', a single quote
+.B \e\*'
+literal \*', a single quote
.RE
.PD
.PP
@@ -300,7 +328,7 @@ be used to indicate a macro definition. Unquoted text
is assumed to be a function name.
In the macro body, the backslash escapes described above are expanded.
Backslash will quote any other character in the macro text,
-including " and '.
+including \*" and \*'.
.PP
.B Bash
allows the current readline key bindings to be displayed or modified
@@ -332,8 +360,12 @@ or
.B Off
(without regard to case).
Unrecognized variable names are ignored.
-When a variable value is read, empty or null values, "on" (case-insensitive),
-and "1" are equivalent to \fBOn\fP. All other values are equivalent to
+When readline reads a variable value, empty or null values,
+.Q "on"
+(case-insensitive), and
+.Q 1
+are equivalent to \fBOn\fP.
+All other values are equivalent to
\fBOff\fP.
The variables and their default values are:
.PP
@@ -349,19 +381,24 @@ It is output to the terminal before displaying the text in the active region.
This variable is reset to the default value whenever the terminal type changes.
The default value is the string that puts the terminal in standout mode,
as obtained from the terminal's terminfo description.
-A sample value might be \f(CW"\ee[01;33m"\fP.
+A sample value might be
+.Q \ee[01;33m .
.TP
.B active\-region\-end\-color
-A string variable that "undoes" the effects of \fBactive\-region\-start\-color\fP
-and restores "normal" terminal display appearance after displaying text
-in the active region.
+A string variable that
+.Q undoes
+the effects of \fBactive\-region\-start\-color\fP
+and restores
+.Q normal
+terminal display appearance after displaying text in the active region.
This string must not take up any physical character positions on the display,
so it should consist only of terminal escape sequences.
It is output to the terminal after displaying the text in the active region.
This variable is reset to the default value whenever the terminal type changes.
The default value is the string that restores the terminal from standout mode,
as obtained from the terminal's terminfo description.
-A sample value might be \f(CW"\ee[0m\fP".
+A sample value might be
+.Q \ee[0m .
.TP
.B bell\-style (audible)
Controls what happens when readline wants to ring the terminal bell.
@@ -370,9 +407,14 @@ If set to \fBnone\fP, readline never rings the bell. If set to
If set to \fBaudible\fP, readline attempts to ring the terminal's bell.
.TP
.B bind\-tty\-special\-chars (On)
-If set to \fBOn\fP (the default), readline attempts to bind the control
-characters treated specially by the kernel's terminal driver to their
-readline equivalents.
+If set to \fBOn\fP (the default), readline attempts to bind
+the control characters that are treated specially by the kernel's
+terminal driver to their readline equivalents.
+These override the default readline bindings described here.
+Type
+.Q "stty -a"
+at a \fBbash\fP prompt to see your current terminal settings,
+including the special control characters (usually \fBcchars\fP).
.TP
.B blink\-matching\-paren (Off)
If set to \fBOn\fP, readline attempts to briefly move the cursor to an
@@ -384,7 +426,8 @@ common prefix of the set of possible completions using a different color.
The color definitions are taken from the value of the \fBLS_COLORS\fP
environment variable.
If there is a color definition in \fB$LS_COLORS\fP for the custom suffix
-"readline-colored-completion-prefix", readline uses this color for
+.Q readline-colored-completion-prefix ,
+readline uses this color for
the common prefix instead of its default.
.TP
.B colored\-stats (Off)
@@ -392,9 +435,13 @@ If set to \fBOn\fP, readline displays possible completions using different
colors to indicate their file type.
The color definitions are taken from the value of the \fBLS_COLORS\fP
environment variable.
+.\" Tucking multiple macro calls into a paragraph tag requires some
+.\" finesse. We require `\c`, and while the single-font macros don't
+.\" honor input trap continuation, the font alternation macros do.
.TP
-.B comment\-begin (``#'')
-The string that is inserted in \fBvi\fP mode when the
+.BR comment\-begin\ ( \c
+.Q \fB#\fP \fB)\fP
+The string that is inserted when the
.B insert\-comment
command is executed.
This command is bound to
@@ -410,7 +457,7 @@ The value is ignored if it is less than 0 or greater than the terminal
screen width.
A value of 0 will cause matches to be displayed one per line.
The default value is \-1.
-.TP
+.TP
.B completion\-ignore\-case (Off)
If set to \fBOn\fP, readline performs filename matching and completion
in a case\-insensitive fashion.
@@ -445,11 +492,11 @@ by stripping the eighth bit and prefixing it with an
escape character (in effect, using escape as the \fImeta prefix\fP).
The default is \fIOn\fP, but readline will set it to \fIOff\fP if the
locale contains eight-bit characters.
-This variable is dependent on the \fBLC_CTYPE\fP locale category, and
+This variable is dependent on the \fBLC_CTYPE\fP locale category, and
may change if the locale is changed.
.TP
.B disable\-completion (Off)
-If set to \fBOn\fP, readline will inhibit word completion. Completion
+If set to \fBOn\fP, readline will inhibit word completion. Completion
characters will be inserted into the line as if they had been
mapped to \fBself-insert\fP.
.TP
@@ -468,13 +515,13 @@ or
.BR vi .
.TP
.B emacs\-mode\-string (@)
-If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
+If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
this string is displayed immediately before the last line of the primary
prompt when emacs editing mode is active. The value is expanded like a
key binding, so the standard set of meta- and control prefixes and
backslash escape sequences is available.
Use the \e1 and \e2 escapes to begin and end sequences of
-non-printing characters, which can be used to embed a terminal control
+non-printing characters, which can be used to embed a terminal control
sequence into the mode string.
.TP
.B enable\-active\-region (On)
@@ -512,8 +559,8 @@ If set to \fBOn\fP, tilde expansion is performed when readline
attempts word completion.
.TP
.B history\-preserve\-point (Off)
-If set to \fBOn\fP, the history code attempts to place point at the
-same location on each history line retrieved with \fBprevious-history\fP
+If set to \fBOn\fP, the history code attempts to place point at the
+same location on each history line retrieved with \fBprevious-history\fP
or \fBnext-history\fP.
.TP
.B history\-size (unset)
@@ -538,12 +585,13 @@ it will not clear the eighth bit in the characters it reads),
regardless of what the terminal claims it can support. The name
.B meta\-flag
is a synonym for this variable.
-The default is \fIOff\fP, but readline will set it to \fIOn\fP if the
+The default is \fIOff\fP, but readline will set it to \fIOn\fP if the
locale contains eight-bit characters.
-This variable is dependent on the \fBLC_CTYPE\fP locale category, and
+This variable is dependent on the \fBLC_CTYPE\fP locale category, and
may change if the locale is changed.
.TP
-.B isearch\-terminators (``C\-[ C\-J'')
+.BR isearch\-terminators\ ( \c
+.Q \fBC\-[C\-J\fP \fB)\fP
The string of characters that should terminate an incremental
search without subsequently executing the character as a command.
If this variable has not been given a value, the characters
@@ -564,7 +612,7 @@ also affects the default keymap.
.B keyseq\-timeout (500)
Specifies the duration \fIreadline\fP will wait for a character when reading an
ambiguous key sequence (one that can form a complete key sequence using
-the input read so far, or can take additional input to complete a longer
+the input read so far, or can take additional input to complete a longer
key sequence).
If no input is received within the timeout, \fIreadline\fP will use the shorter
but complete key sequence.
@@ -588,11 +636,13 @@ have a slash appended (subject to the value of
\fBmark\-directories\fP).
.TP
.B match\-hidden\-files (On)
-This variable, when set to \fBOn\fP, causes readline to match files whose
-names begin with a `.' (hidden files) when performing filename
-completion.
-If set to \fBOff\fP, the leading `.' must be
-supplied by the user in the filename to be completed.
+This variable, when set to \fBOn\fP, forces readline to match files whose
+names begin with a
+.Q .
+(hidden files) when performing filename completion.
+If set to \fBOff\fP, the user must include the leading
+.Q .
+in the filename to be completed.
.TP
.B menu\-complete\-display\-prefix (Off)
If set to \fBOn\fP, menu completion displays the common prefix of the
@@ -622,6 +672,10 @@ before returning when \fBaccept\-line\fP is executed. By default,
history lines may be modified and retain individual undo lists across
calls to \fBreadline\fP.
.TP
+.B search\-ignore\-case (Off)
+If set to \fBOn\fP, readline performs incremental and non-incremental
+history list searches in a case\-insensitive fashion.
+.TP
.B show\-all\-if\-ambiguous (Off)
This alters the default behavior of the completion functions. If
set to
@@ -633,9 +687,9 @@ matches to be listed immediately instead of ringing the bell.
This alters the default behavior of the completion functions in
a fashion similar to \fBshow\-all\-if\-ambiguous\fP.
If set to
-.BR On ,
+.BR On ,
words which have more than one possible completion without any
-possible partial completion (the possible completions don't share
+possible partial completion (the possible completions don't share
a common prefix) cause the matches to be listed immediately instead
of ringing the bell.
.TP
@@ -653,7 +707,7 @@ after point in the word being completed, so portions of the word
following the cursor are not duplicated.
.TP
.B vi\-cmd\-mode\-string ((cmd))
-If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
+If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
this string is displayed immediately before the last line of the primary
prompt when vi editing mode is active and in command mode.
The value is expanded like a
@@ -664,18 +718,18 @@ non-printing characters, which can be used to embed a terminal control
sequence into the mode string.
.TP
.B vi\-ins\-mode\-string ((ins))
-If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
+If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
this string is displayed immediately before the last line of the primary
-prompt when vi editing mode is active and in insertion mode.
+prompt when vi editing mode is active and in insertion mode.
The value is expanded like a
-key binding, so the standard set of meta- and control prefixes and
+key binding, so the standard set of meta- and control prefixes and
backslash escape sequences is available.
Use the \e1 and \e2 escapes to begin and end sequences of
-non-printing characters, which can be used to embed a terminal control
+non-printing characters, which can be used to embed a terminal control
sequence into the mode string.
.TP
.B visible\-stats (Off)
-If set to \fBOn\fP, a character denoting a file's type as reported
+If set to \fBOn\fP, a character denoting a file's type as reported
by \fIstat\fP(2) is appended to the filename when listing possible
completions.
.PD
@@ -684,7 +738,8 @@ Readline implements a facility similar in spirit to the conditional
compilation features of the C preprocessor which allows key
bindings and variable settings to be performed as the result
of tests. There are four parser directives used.
-.IP \fB$if\fP
+.TP
+.B $if
The
.B $if
construct allows bindings to be made based on the
@@ -693,14 +748,16 @@ readline. The text of the test, after any comparison operator,
extends to the end of the line;
unless otherwise noted, no characters are required to isolate it.
.RS
-.IP \fBmode\fP
+.TP
+.B mode
The \fBmode=\fP form of the \fB$if\fP directive is used to test
whether readline is in emacs or vi mode.
This may be used in conjunction
with the \fBset keymap\fP command, for instance, to set bindings in
the \fIemacs-standard\fP and \fIemacs-ctlx\fP keymaps only if
readline is starting out in emacs mode.
-.IP \fBterm\fP
+.TP
+.B term
The \fBterm=\fP form may be used to include terminal-specific
key bindings, perhaps to bind the key sequences output by the
terminal's function keys. The word on the right side of the
@@ -713,7 +770,8 @@ to match both
and
.IR sun\-cmd ,
for instance.
-.IP \fBversion\fP
+.TP
+.B version
The \fBversion\fP test may be used to perform comparisons against
specific readline versions.
The \fBversion\fP expands to the current readline version.
@@ -733,24 +791,29 @@ minor version (e.g., \fB7.1\fP). If the minor version is omitted, it
is assumed to be \fB0\fP.
The operator may be separated from the string \fBversion\fP
and from the version number argument by whitespace.
-.IP \fBapplication\fP
-The \fBapplication\fP construct is used to include
-application-specific settings. Each program using the readline
+.TP
+.I application
+The \fIapplication\fP construct is used to include
+application-specific settings.
+Each program using the readline
library sets the \fIapplication name\fP, and an initialization
file can test 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 \fBbash\fP:
-.sp 1
+.PP
.RS
+.EX
.nf
\fB$if\fP Bash
# Quote the current or previous word
-"\eC-xq": "\eeb\e"\eef\e""
+\*"\eC-xq\*": \*"\eeb\e\*"\eef\e\*"\*"
\fB$endif\fP
.fi
+.EE
.RE
-.IP \fIvariable\fP
+.TP
+.I variable
The \fIvariable\fP construct provides simple equality tests for readline
variables and values.
The permitted comparison operators are \fI=\fP, \fI==\fP, and \fI!=\fP.
@@ -760,21 +823,24 @@ side by whitespace.
Both string and boolean variables may be tested. Boolean variables must be
tested against the values \fIon\fP and \fIoff\fP.
.RE
-.IP \fB$endif\fP
+.TP
+.B $endif
This command, as seen in the previous example, terminates an
\fB$if\fP command.
-.IP \fB$else\fP
+.TP
+.B $else
Commands in this branch of the \fB$if\fP directive are executed if
the test fails.
-.IP \fB$include\fP
+.TP
+.B $include
This directive takes a single filename as an argument and reads commands
and bindings from that file. For example, the following directive
would read \fI/etc/inputrc\fP:
-.sp 1
.RS
+.PP
.nf
\fB$include\fP \^ \fI/etc/inputrc\fP
-.fi
+.fi
.RE
.SH SEARCHING
Readline provides commands for searching through the command history
@@ -916,12 +982,16 @@ and make it the current line.
Without an argument, move back to the first entry in the history list.
.TP
.B reverse\-search\-history (C\-r)
-Search backward starting at the current line and moving `up' through
-the history as necessary. This is an incremental search.
+Search backward starting at the current line and moving
+.Q up
+through the history as necessary.
+This is an incremental search.
.TP
.B forward\-search\-history (C\-s)
-Search forward starting at the current line and moving `down' through
-the history as necessary. This is an incremental search.
+Search forward starting at the current line and moving
+.Q down
+through the history as necessary.
+This is an incremental search.
.TP
.B non\-incremental\-reverse\-search\-history (M\-p)
Search backward through the history starting at the current line
@@ -966,7 +1036,9 @@ insert the \fIn\fPth word from the previous command (the words
in the previous command begin with word 0). A negative argument
inserts the \fIn\fPth word from the end of the previous command.
Once the argument \fIn\fP is computed, the argument is extracted
-as if the "!\fIn\fP" history expansion had been specified.
+as if the
+.Q !\fIn\fP
+history expansion had been specified.
.TP
.B
yank\-last\-arg (M\-.\^, M\-_\^)
@@ -980,15 +1052,16 @@ Any numeric argument supplied to these successive calls determines
the direction to move through the history. A negative argument switches
the direction through the history (back or forward).
The history expansion facilities are used to extract the last argument,
-as if the "!$" history expansion had been specified.
+as if the
+.Q !$
+history expansion had been specified.
.PD
.SS Commands for Changing Text
.PD 0
.TP
.B \fIend\-of\-file\fP (usually C\-d)
The character indicating end-of-file as set, for example, by
-.if t \f(CWstty\fP.
-.if n ``stty''.
+.IR stty (1).
If this character is read when there are no characters
on the line, and point is at the beginning of the line, readline
interprets it as the end of input and returns
@@ -1005,7 +1078,7 @@ commonly is, see above for the effects.
Delete the character behind the cursor. When given a numeric argument,
save the deleted text on the kill ring.
.TP
-.B forward\-backward\-delete\-char
+.B forward\-backward\-delete\-char
Delete the character under the cursor, unless the cursor is at the
end of the line, in which case the character behind the cursor is
deleted.
@@ -1017,7 +1090,7 @@ how to insert characters like \fBC\-q\fP, for example.
.B tab\-insert (M-TAB)
Insert a tab character.
.TP
-.B self\-insert (a,\ b,\ A,\ 1,\ !,\ ...)
+.B "self\-insert (a, b, A, 1, !, \fR.\|.\|.\fP)"
Insert the character typed.
.TP
.B transpose\-chars (C\-t)
@@ -1121,7 +1194,7 @@ or
.SS Numeric Arguments
.PD 0
.TP
-.B digit\-argument (M\-0, M\-1, ..., M\-\-)
+.B digit\-argument (M\-0, M\-1, \fR.\|.\|.\fP, M\-\-)
Add this digit to the argument already accumulating, or start a new
argument. M\-\- starts a negative argument.
.TP
@@ -1148,7 +1221,7 @@ The actual completion performed is application-specific.
.BR Bash ,
for instance, attempts completion treating the text as a variable
(if the text begins with \fB$\fP), username (if the text begins with
-\fB~\fP), hostname (if the text begins with \fB@\fP), or
+\fB\*~\fP), hostname (if the text begins with \fB@\fP), or
command (including aliases and functions) in turn. If none
of these produces a match, filename completion is attempted.
.BR Gdb ,
@@ -1179,7 +1252,7 @@ At the end of the list of completions, the bell is rung
(subject to the setting of \fBbell\-style\fP)
and the original text is restored.
An argument of \fIn\fP moves \fIn\fP positions forward in the list
-of matches; a negative argument may be used to move backward
+of matches; a negative argument may be used to move backward
through the list.
This command is intended to be bound to \fBTAB\fP, but is unbound
by default.
@@ -1225,7 +1298,7 @@ Abort the current editing command and
ring the terminal's bell (subject to the setting of
.BR bell\-style ).
.TP
-.B do\-lowercase\-version (M\-A, M\-B, M\-\fIx\fP, ...)
+.B do\-lowercase\-version (M\-A, M\-B, M\-\fIx\fP, \fR.\|.\|.\fP)
If the metafied character \fIx\fP is uppercase, run the command
that is bound to the corresponding metafied lowercase character.
The behavior is undefined if \fIx\fP is already lowercase.
@@ -1269,7 +1342,9 @@ character. A negative argument searches for subsequent occurrences.
Read enough characters to consume a multi-key sequence such as those
defined for keys like Home and End. Such sequences begin with a
Control Sequence Indicator (CSI), usually ESC\-[. If this sequence is
-bound to "\e[", keys producing such sequences will have no effect
+bound to
+.Q \e[ ,
+keys producing such sequences will have no effect
unless explicitly bound to a readline command, instead of inserting
stray characters into the editing buffer. This is unbound by default,
but usually bound to ESC\-[.
@@ -1279,8 +1354,8 @@ Without a numeric argument, the value of the readline
.B 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 \fBcomment\-begin\fP, the value is inserted, otherwise
+the characters at the beginning of the line do not match the value
+of \fBcomment\-begin\fP, the value is inserted, otherwise
the characters in \fBcomment-begin\fP are deleted from the beginning of
the line.
In either case, the line is accepted as if a newline had been typed.
@@ -1352,7 +1427,7 @@ variable).
.ta 2.5i
.sp
Emacs Standard bindings
-.sp
+.PP
"C-@" set-mark
"C-A" beginning-of-line
"C-B" backward-char
@@ -1380,11 +1455,11 @@ Emacs Standard bindings
"C-_" undo
"\^ " to "/" self-insert
"0" to "9" self-insert
-":" to "~" self-insert
+":" to "\*~" self-insert
"C-?" backward-delete-char
.PP
Emacs Meta bindings
-.sp
+.PP
"M-C-G" abort
"M-C-H" backward-kill-word
"M-C-I" tab-insert
@@ -1427,12 +1502,12 @@ Emacs Meta bindings
"M-U" upcase-word
"M-Y" yank-pop
"M-\e" delete-horizontal-space
-"M-~" tilde-expand
+"M-\*~" tilde-expand
"M-C-?" backward-kill-word
"M-_" yank-last-arg
.PP
Emacs Control-X bindings
-.sp
+.PP
"C-XC-G" abort
"C-XC-R" re-read-init-file
"C-XC-U" undo
@@ -1441,35 +1516,35 @@ Emacs Control-X bindings
"C-X)" end-kbd-macro
"C-XE" call-last-kbd-macro
"C-XC-?" backward-kill-line
-.sp
.RE
.SS VI Mode bindings
.RS +.6i
.nf
.ta 2.5i
-.sp
.PP
VI Insert Mode functions
-.sp
+.PP
"C-D" vi-eof-maybe
"C-H" backward-delete-char
"C-I" complete
"C-J" accept-line
"C-M" accept-line
+"C-N" menu-complete
+"C-P" menu-complete-backward
"C-R" reverse-search-history
"C-S" forward-search-history
"C-T" transpose-chars
"C-U" unix-line-discard
"C-V" quoted-insert
-"C-W" unix-word-rubout
+"C-W" vi-unix-word-rubout
"C-Y" yank
"C-[" vi-movement-mode
-"C-_" undo
-"\^ " to "~" self-insert
+"C-_" vi-undo
+"\^ " to "\*~" self-insert
"C-?" backward-delete-char
.PP
VI Command Mode functions
-.sp
+.PP
"C-D" vi-eof-maybe
"C-E" emacs-editing-mode
"C-G" abort
@@ -1486,7 +1561,7 @@ VI Command Mode functions
"C-T" transpose-chars
"C-U" unix-line-discard
"C-V" quoted-insert
-"C-W" unix-word-rubout
+"C-W" vi-unix-word-rubout
"C-Y" yank
"C-_" vi-undo
"\^ " forward-char
@@ -1520,10 +1595,10 @@ VI Command Mode functions
"T" vi-char-search
"U" revert-line
"W" vi-next-word
-"X" backward-delete-char
+"X" vi-rubout
"Y" vi-yank-to
"\e" vi-complete
-"^" vi-first-print
+"\*^" vi-first-print
"_" vi-yank-arg
"`" vi-goto-mark
"a" vi-append-mode
@@ -1535,7 +1610,7 @@ VI Command Mode functions
"h" backward-char
"i" vi-insertion-mode
"j" next-history
-"k" prev-history
+"k" previous-history
"l" forward-char
"m" vi-set-mark
"n" vi-search-again
@@ -1548,7 +1623,7 @@ VI Command Mode functions
"x" vi-delete
"y" vi-yank-to
"|" vi-column
-"~" vi-change-case
+"\*~" vi-change-case
.RE
.SH "SEE ALSO"
.PD 0
@@ -1562,7 +1637,7 @@ VI Command Mode functions
.SH FILES
.PD 0
.TP
-.FN ~/.inputrc
+.FN \*~/.inputrc
Individual \fBreadline\fP initialization file
.PD
.SH AUTHORS