\e[1mreadline \e[22m(\e[4mconst\e[24m \e[4mchar\e[24m \e[4m*prompt\e[24m);
\e[1mCOPYRIGHT\e[0m
- Readline is Copyright (C) 1989-2014 Free Software Foundation, Inc.
+ Readline is Copyright (C) 1989-2020 Free Software Foundation, Inc.
\e[1mDESCRIPTION\e[0m
\e[1mreadline \e[22mwill read a line from the terminal and return it, using \e[1mprompt\e[0m
- as a prompt. If \e[1mprompt \e[22mis \e[1mNULL \e[22mor the empty string, no prompt is
- issued. The line returned is allocated with \e[4mmalloc\e[24m(3); the caller must
- free it when finished. The line returned has the final newline
- removed, so only the text of the line remains.
+ as a prompt. If \e[1mprompt \e[22mis \e[1mNULL \e[22mor the empty string, no prompt is is-
+ sued. The line returned is allocated with \e[4mmalloc\e[24m(3); the caller must
+ free it when finished. The line returned has the final newline re-
+ moved, so only the text of the line remains.
\e[1mreadline \e[22moffers editing capabilities while the user is entering the
line. By default, the line editing commands are similar to those of
\e[1mINITIALIZATION FILE\e[0m
Readline is customized by putting commands in an initialization file
(the \e[4minputrc\e[24m file). The name of this file is taken from the value of
- the \e[1mINPUTRC \e[22menvironment variable. If that variable is unset, the
- default is \e[4m~/.inputrc\e[24m. If that file does not exist or cannot be read,
+ the \e[1mINPUTRC \e[22menvironment variable. If that variable is unset, the de-
+ fault is \e[4m~/.inputrc\e[24m. If that file does not exist or cannot be read,
the ultimate default is \e[4m/etc/inputrc\e[24m. When a program which uses the
readline library starts up, the init file is read, and the key bindings
and variables are set. There are only a few basic constructs allowed
ber of possible completions generated by the \e[1mpossible-comple-\e[0m
\e[1mtions \e[22mcommand. It may be set to any integer value greater than
or equal to zero. If the number of possible completions is
- greater than or equal to the value of this variable, the user is
- asked whether or not he wishes to view them; otherwise they are
- simply listed on the terminal. A negative value causes readline
- to never ask.
+ greater than or equal to the value of this variable, readline
+ will ask whether or not the user wishes to view them; otherwise
+ they are simply listed on the terminal. A negative value causes
+ readline to never ask.
\e[1mconvert-meta (On)\e[0m
If set to \e[1mOn\e[22m, readline will convert characters with the eighth
bit set to an ASCII key sequence by stripping the eighth bit and
escapes to begin and end sequences of non-printing characters,
which can be used to embed a terminal control sequence into the
mode string.
- \e[1menable-bracketed-paste (Off)\e[0m
+ \e[1menable-bracketed-paste (On)\e[0m
When set to \e[1mOn\e[22m, readline will configure the terminal in a way
that will enable it to insert each paste into the editing buffer
as a single string of characters, instead of treating each char-
mands.
\e[1menable-keypad (Off)\e[0m
When set to \e[1mOn\e[22m, readline will try to enable the application key-
- pad when it is called. Some systems need this to enable the
- arrow keys.
+ pad when it is called. Some systems need this to enable the ar-
+ row keys.
\e[1menable-meta-key (On)\e[0m
When set to \e[1mOn\e[22m, readline will try to enable any meta modifier
key the terminal claims to support when it is called. On many
terminals, the meta key is used to send eight-bit characters.
\e[1mexpand-tilde (Off)\e[0m
- If set to \e[1mOn\e[22m, tilde expansion is performed when readline
- attempts word completion.
+ If set to \e[1mOn\e[22m, tilde expansion is performed when readline at-
+ tempts word completion.
\e[1mhistory-preserve-point (Off)\e[0m
If set to \e[1mOn\e[22m, the history code attempts to place point at the
same location on each history line retrieved with \e[1mprevious-his-\e[0m
When set to \e[1mOn\e[22m, makes readline use a single line for display,
scrolling the input horizontally on a single screen line when it
becomes longer than the screen width rather than wrapping to a
- new line.
+ new line. This setting is automatically enabled for terminals
+ of height 1.
\e[1minput-meta (Off)\e[0m
- If set to \e[1mOn\e[22m, readline will enable eight-bit input (that is, it
- will not clear the eighth bit in the characters it reads),
- regardless of what the terminal claims it can support. The name
- \e[1mmeta-flag \e[22mis a synonym for this variable. The default is \e[4mOff\e[24m,
- but readline will set it to \e[4mOn\e[24m if the locale contains eight-bit
+ If set to \e[1mOn\e[22m, readline will enable eight-bit input (that is, it
+ will not clear the eighth bit in the characters it reads), re-
+ gardless of what the terminal claims it can support. The name
+ \e[1mmeta-flag \e[22mis a synonym for this variable. The default is \e[4mOff\e[24m,
+ but readline will set it to \e[4mOn\e[24m if the locale contains eight-bit
characters.
\e[1misearch-terminators (``C-[ C-J'')\e[0m
- The string of characters that should terminate an incremental
- search without subsequently executing the character as a com-
- mand. If this variable has not been given a value, the charac-
+ The string of characters that should terminate an incremental
+ search without subsequently executing the character as a com-
+ mand. If this variable has not been given a value, the charac-
ters \e[4mESC\e[24m and \e[4mC-J\e[24m will terminate an incremental search.
\e[1mkeymap (emacs)\e[0m
- Set the current readline keymap. The set of legal keymap names
- is \e[4memacs,\e[24m \e[4memacs-standard,\e[24m \e[4memacs-meta,\e[24m \e[4memacs-ctlx,\e[24m \e[4mvi,\e[24m \e[4mvi-move,\e[0m
- \e[4mvi-command\e[24m, and \e[4mvi-insert\e[24m. \e[4mvi\e[24m is equivalent to \e[4mvi-command\e[24m;
- \e[4memacs\e[24m is equivalent to \e[4memacs-standard\e[24m. The default value is
- \e[4memacs\e[24m. The value of \e[1mediting-mode \e[22malso affects the default
+ Set the current readline keymap. The set of legal keymap names
+ is \e[4memacs,\e[24m \e[4memacs-standard,\e[24m \e[4memacs-meta,\e[24m \e[4memacs-ctlx,\e[24m \e[4mvi,\e[24m \e[4mvi-move,\e[0m
+ \e[4mvi-command\e[24m, and \e[4mvi-insert\e[24m. \e[4mvi\e[24m is equivalent to \e[4mvi-command\e[24m;
+ \e[4memacs\e[24m is equivalent to \e[4memacs-standard\e[24m. The default value is
+ \e[4memacs\e[24m. The value of \e[1mediting-mode \e[22malso affects the default
keymap.
\e[1mkeyseq-timeout (500)\e[0m
- Specifies the duration \e[4mreadline\e[24m will wait for a character when
- reading an ambiguous key sequence (one that can form a complete
+ Specifies the duration \e[4mreadline\e[24m 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 key sequence). If no input is
- received within the timeout, \e[4mreadline\e[24m will use the shorter but
- complete key sequence. The value is specified in milliseconds,
- so a value of 1000 means that \e[4mreadline\e[24m will wait one second for
- additional input. If this variable is set to a value less than
- or equal to zero, or to a non-numeric value, \e[4mreadline\e[24m will wait
- until another key is pressed to decide which key sequence to
+ input to complete a longer key sequence). If no input is re-
+ ceived within the timeout, \e[4mreadline\e[24m will use the shorter but
+ complete key sequence. The value is specified in milliseconds,
+ so a value of 1000 means that \e[4mreadline\e[24m will wait one second for
+ additional input. If this variable is set to a value less than
+ or equal to zero, or to a non-numeric value, \e[4mreadline\e[24m will wait
+ until another key is pressed to decide which key sequence to
complete.
\e[1mmark-directories (On)\e[0m
If set to \e[1mOn\e[22m, completed directory names have a slash appended.
\e[1mmark-modified-lines (Off)\e[0m
- If set to \e[1mOn\e[22m, history lines that have been modified are dis-
+ If set to \e[1mOn\e[22m, history lines that have been modified are dis-
played with a preceding asterisk (\e[1m*\e[22m).
\e[1mmark-symlinked-directories (Off)\e[0m
If set to \e[1mOn\e[22m, completed names which are symbolic links to direc-
- tories have a slash appended (subject to the value of
- \e[1mmark-directories\e[22m).
+ tories have a slash appended (subject to the value of \e[1mmark-di-\e[0m
+ \e[1mrectories\e[22m).
\e[1mmatch-hidden-files (On)\e[0m
- This variable, when set to \e[1mOn\e[22m, causes readline to match files
- whose names begin with a `.' (hidden files) when performing
- filename completion. If set to \e[1mOff\e[22m, the leading `.' must be
+ This variable, when set to \e[1mOn\e[22m, causes readline to match files
+ whose names begin with a `.' (hidden files) when performing
+ filename completion. If set to \e[1mOff\e[22m, the leading `.' must be
supplied by the user in the filename to be completed.
\e[1mmenu-complete-display-prefix (Off)\e[0m
- If set to \e[1mOn\e[22m, menu completion displays the common prefix of the
+ If set to \e[1mOn\e[22m, menu completion displays the common prefix of the
list of possible completions (which may be empty) before cycling
through the list.
\e[1moutput-meta (Off)\e[0m
- If set to \e[1mOn\e[22m, readline will display characters with the eighth
+ If set to \e[1mOn\e[22m, readline will display characters with the eighth
bit set directly rather than as a meta-prefixed escape sequence.
The default is \e[4mOff\e[24m, but readline will set it to \e[4mOn\e[24m if the locale
contains eight-bit characters.
\e[1mpage-completions (On)\e[0m
- If set to \e[1mOn\e[22m, readline uses an internal \e[4mmore\e[24m-like pager to dis-
+ If set to \e[1mOn\e[22m, readline uses an internal \e[4mmore\e[24m-like pager to dis-
play a screenful of possible completions at a time.
\e[1mprint-completions-horizontally (Off)\e[0m
- If set to \e[1mOn\e[22m, readline will display completions with matches
- sorted horizontally in alphabetical order, rather than down the
+ If set to \e[1mOn\e[22m, readline will display completions with matches
+ sorted horizontally in alphabetical order, rather than down the
screen.
\e[1mrevert-all-at-newline (Off)\e[0m
- If set to \e[1mOn\e[22m, readline will undo all changes to history lines
+ If set to \e[1mOn\e[22m, readline will undo all changes to history lines
before returning when \e[1maccept-line \e[22mis executed. By default, his-
- tory lines may be modified and retain individual undo lists
+ tory lines may be modified and retain individual undo lists
across calls to \e[1mreadline\e[22m.
\e[1mshow-all-if-ambiguous (Off)\e[0m
- This alters the default behavior of the completion functions.
+ This alters the default behavior of the completion functions.
If set to \e[1mOn\e[22m, words which have more than one possible completion
- cause the matches to be listed immediately instead of ringing
+ cause the matches to be listed immediately instead of ringing
the bell.
\e[1mshow-all-if-unmodified (Off)\e[0m
- This alters the default behavior of the completion functions in
+ This alters the default behavior of the completion functions in
a fashion similar to \e[1mshow-all-if-ambiguous\e[22m. If set to \e[1mOn\e[22m, words
- which have more than one possible completion without any possi-
- ble partial completion (the possible completions don't share a
- common prefix) cause the matches to be listed immediately
- instead of ringing the bell.
+ which have more than one possible completion without any possi-
+ ble partial completion (the possible completions don't share a
+ common prefix) cause the matches to be listed immediately in-
+ stead of ringing the bell.
\e[1mshow-mode-in-prompt (Off)\e[0m
- If set to \e[1mOn\e[22m, add a string to the beginning of the prompt indi-
- cating the editing mode: emacs, vi command, or vi insertion.
+ If set to \e[1mOn\e[22m, add a string to the beginning of the prompt indi-
+ cating the editing mode: emacs, vi command, or vi insertion.
The mode strings are user-settable (e.g., \e[4memacs-mode-string\e[24m).
\e[1mskip-completed-text (Off)\e[0m
- If set to \e[1mOn\e[22m, this alters the default completion behavior when
- inserting a single match into the line. It's only active when
- performing completion in the middle of a word. If enabled,
- readline does not insert characters from the completion that
- match characters after point in the word being completed, so
+ If set to \e[1mOn\e[22m, this alters the default completion behavior when
+ inserting a single match into the line. It's only active when
+ performing completion in the middle of a word. If enabled,
+ readline does not insert characters from the completion that
+ match characters after point in the word being completed, so
portions of the word following the cursor are not duplicated.
\e[1mvi-cmd-mode-string ((cmd))\e[0m
- If the \e[4mshow-mode-in-prompt\e[24m variable is enabled, this string is
+ If the \e[4mshow-mode-in-prompt\e[24m 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
+ when vi editing mode is active and in command mode. 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 \1 and \2 escapes to begin and end sequences of non-
- printing characters, which can be used to embed a terminal con-
+ control prefixes and backslash escape sequences is available.
+ Use the \1 and \2 escapes to begin and end sequences of non-
+ printing characters, which can be used to embed a terminal con-
trol sequence into the mode string.
\e[1mvi-ins-mode-string ((ins))\e[0m
- If the \e[4mshow-mode-in-prompt\e[24m variable is enabled, this string is
+ If the \e[4mshow-mode-in-prompt\e[24m 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. 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 \1 and \2 escapes to begin and end sequences of non-
- printing characters, which can be used to embed a terminal con-
+ control prefixes and backslash escape sequences is available.
+ Use the \1 and \2 escapes to begin and end sequences of non-
+ printing characters, which can be used to embed a terminal con-
trol sequence into the mode string.
\e[1mvisible-stats (Off)\e[0m
- If set to \e[1mOn\e[22m, a character denoting a file's type as reported by
- \e[4mstat\e[24m(2) is appended to the filename when listing possible com-
+ If set to \e[1mOn\e[22m, a character denoting a file's type as reported by
+ \e[4mstat\e[24m(2) is appended to the filename when listing possible com-
pletions.
\e[1mConditional Constructs\e[0m
- 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
+ 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.
- \e[1m$if \e[22mThe \e[1m$if \e[22mconstruct allows bindings to be made based on the edit-
- ing mode, the terminal being used, or the application using
- readline. The text of the test, after any comparison operator,
+ \e[1m$if \e[22mThe \e[1m$if \e[22mconstruct allows bindings to be made based on the edit-
+ ing mode, the terminal being used, or the application using
+ readline. The text of the test, after any comparison operator,
extends to the end of the line; unless otherwise noted, no char-
acters are required to isolate it.
- \e[1mmode \e[22mThe \e[1mmode= \e[22mform of the \e[1m$if \e[22mdirective is used to test
- whether readline is in emacs or vi mode. This may be
- used in conjunction with the \e[1mset keymap \e[22mcommand, for
- instance, to set bindings in the \e[4memacs-standard\e[24m and
- \e[4memacs-ctlx\e[24m keymaps only if readline is starting out in
- emacs mode.
+ \e[1mmode \e[22mThe \e[1mmode= \e[22mform of the \e[1m$if \e[22mdirective is used to test
+ whether readline is in emacs or vi mode. This may be
+ used in conjunction with the \e[1mset keymap \e[22mcommand, for in-
+ stance, to set bindings in the \e[4memacs-standard\e[24m and \e[4memacs-\e[0m
+ \e[4mctlx\e[24m keymaps only if readline is starting out in emacs
+ mode.
- \e[1mterm \e[22mThe \e[1mterm= \e[22mform may be used to include terminal-specific
+ \e[1mterm \e[22mThe \e[1mterm= \e[22mform 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 \e[1m= \e[22mis tested against the full name of the terminal
- and the portion of the terminal name before the first \e[1m-\e[22m.
- This allows \e[4msun\e[24m to match both \e[4msun\e[24m and \e[4msun-cmd\e[24m, for
- instance.
+ of the \e[1m= \e[22mis tested against the full name of the terminal
+ and the portion of the terminal name before the first \e[1m-\e[22m.
+ This allows \e[4msun\e[24m to match both \e[4msun\e[24m and \e[4msun-cmd\e[24m, for in-
+ stance.
\e[1mversion\e[0m
- The \e[1mversion \e[22mtest may be used to perform comparisons
- against specific readline versions. The \e[1mversion \e[22mexpands
- to the current readline version. The set of comparison
- operators includes \e[1m=\e[22m, (and \e[1m==\e[22m), \e[1m!=\e[22m, \e[1m<=\e[22m, \e[1m>=\e[22m, \e[1m<\e[22m, and \e[1m>\e[22m.
- The version number supplied on the right side of the
- operator consists of a major version number, an optional
+ The \e[1mversion \e[22mtest may be used to perform comparisons
+ against specific readline versions. The \e[1mversion \e[22mexpands
+ to the current readline version. The set of comparison
+ operators includes \e[1m=\e[22m, (and \e[1m==\e[22m), \e[1m!=\e[22m, \e[1m<=\e[22m, \e[1m>=\e[22m, \e[1m<\e[22m, and \e[1m>\e[22m.
+ The version number supplied on the right side of the op-
+ erator consists of a major version number, an optional
decimal point, and an optional minor version (e.g., \e[1m7.1\e[22m).
- If the minor version is omitted, it is assumed to be \e[1m0\e[22m.
+ If the minor version is omitted, it is assumed to be \e[1m0\e[22m.
The operator may be separated from the string \e[1mversion \e[22mand
from the version number argument by whitespace.
\e[1mapplication\e[0m
The \e[1mapplication \e[22mconstruct is used to include application-
- specific settings. Each program using the readline
- library sets the \e[4mapplication\e[24m \e[4mname\e[24m, and an initialization
+ specific settings. Each program using the readline li-
+ brary sets the \e[4mapplication\e[24m \e[4mname\e[24m, 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
+ 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
\e[1mbash\e[22m:
\e[1m$if \e[22mBash
\e[4mvariable\e[0m
The \e[4mvariable\e[24m construct provides simple equality tests for
- readline variables and values. The permitted comparison
- operators are \e[4m=\e[24m, \e[4m==\e[24m, and \e[4m!=\e[24m. The variable name must be
+ readline variables and values. The permitted comparison
+ operators are \e[4m=\e[24m, \e[4m==\e[24m, and \e[4m!=\e[24m. The variable name must be
separated from the comparison operator by whitespace; the
- operator may be separated from the value on the right
- hand side by whitespace. Both string and boolean vari-
- ables may be tested. Boolean variables must be tested
+ operator may be separated from the value on the right
+ hand side by whitespace. Both string and boolean vari-
+ ables may be tested. Boolean variables must be tested
against the values \e[4mon\e[24m and \e[4moff\e[24m.
\e[1m$endif \e[22mThis command, as seen in the previous example, terminates an \e[1m$if\e[0m
test fails.
\e[1m$include\e[0m
- This directive takes a single filename as an argument and reads
- commands and bindings from that file. For example, the follow-
+ This directive takes a single filename as an argument and reads
+ commands and bindings from that file. For example, the follow-
ing directive would read \e[4m/etc/inputrc\e[24m:
\e[1m$include \e[4m\e[22m/etc/inputrc\e[0m
\e[1mSEARCHING\e[0m
- Readline provides commands for searching through the command history
- for lines containing a specified string. There are two search modes:
+ Readline provides commands for searching through the command history
+ for lines containing a specified string. There are two search modes:
\e[4mincremental\e[24m and \e[4mnon-incremental\e[24m.
- Incremental searches begin before the user has finished typing the
- search string. As each character of the search string is typed, read-
+ Incremental searches begin before the user has finished typing the
+ search string. As each character of the search string is typed, read-
line 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
+ 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 \e[1mC-r\e[22m. Typing \e[1mC-s \e[22msearches forward
- through the history. The characters present in the value of the
- \e[1misearch-terminators \e[22mvariable are used to terminate an incremental
- search. If that variable has not been assigned a value the \e[4mEscape\e[24m and
+ through the history. The characters present in the value of the
+ \e[1misearch-terminators \e[22mvariable are used to terminate an incremental
+ search. If that variable has not been assigned a value the \e[4mEscape\e[24m and
\e[1mC-J \e[22mcharacters will terminate an incremental search. \e[1mC-G \e[22mwill abort an
- incremental search and restore the original line. When the search is
- terminated, the history entry containing the search string becomes the
+ 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 \e[1mC-s \e[22mor \e[1mC-r \e[22mas
- appropriate. This will search backward or forward in the history for
- the next line matching the search string typed so far. Any other key
+ To find other matching entries in the history list, type \e[1mC-s \e[22mor \e[1mC-r \e[22mas
+ appropriate. This will search backward or forward in the history for
+ the next line matching the search string typed so far. Any other key
sequence bound to a readline command will terminate the search and exe-
- cute that command. For instance, a newline will terminate the search
- and accept the line, thereby executing the command from the history
+ cute that command. For instance, a newline will terminate the search
+ and accept the line, thereby executing the command from the history
list. A movement command will terminate the search, make the last line
found the current line, and begin editing.
- Non-incremental searches read the entire search string before starting
- to search for matching history lines. The search string may be typed
+ Non-incremental searches read the entire search string before starting
+ to search for matching history lines. The search string may be typed
by the user or be part of the contents of the current line.
\e[1mEDITING COMMANDS\e[0m
- The following is a list of the names of the commands and the default
+ The following is a list of the names of the commands and the default
key sequences to which they are bound. Command names without an accom-
panying key sequence are unbound by default.
In the following descriptions, \e[4mpoint\e[24m refers to the current cursor posi-
- tion, and \e[4mmark\e[24m refers to a cursor position saved by the \e[1mset-mark \e[22mcom-
- mand. The text between the point and mark is referred to as the
- \e[4mregion\e[24m.
+ tion, and \e[4mmark\e[24m refers to a cursor position saved by the \e[1mset-mark \e[22mcom-
+ mand. The text between the point and mark is referred to as the \e[4mre-\e[0m
+ \e[4mgion\e[24m.
\e[1mCommands for Moving\e[0m
\e[1mbeginning-of-line (C-a)\e[0m
Move forward to the end of the next word. Words are composed of
alphanumeric characters (letters and digits).
\e[1mbackward-word (M-b)\e[0m
- Move back to the start of the current or previous word. Words
+ Move back to the start of the current or previous word. Words
are composed of alphanumeric characters (letters and digits).
\e[1mprevious-screen-line\e[0m
- Attempt to move point to the same physical screen column on the
- previous physical screen line. This will not have the desired
- effect if the current Readline line does not take up more than
- one physical line or if point is not greater than the length of
+ Attempt to move point to the same physical screen column on the
+ previous physical screen line. This will not have the desired
+ effect if the current Readline line does not take up more than
+ one physical line or if point is not greater than the length of
the prompt plus the screen width.
\e[1mnext-screen-line\e[0m
- Attempt to move point to the same physical screen column on the
+ Attempt to move point to the same physical screen column on the
next physical screen line. This will not have the desired effect
- if the current Readline line does not take up more than one
- physical line or if the length of the current Readline line is
+ if the current Readline line does not take up more than one
+ physical line or if the length of the current Readline line is
not greater than the length of the prompt plus the screen width.
+ \e[1mclear-display (M-C-l)\e[0m
+ Clear the screen and, if possible, the terminal's scrollback
+ buffer, then redraw the current line, leaving the current line
+ at the top of the screen.
\e[1mclear-screen (C-l)\e[0m
- Clear the screen leaving the current line at the top of the
- screen. With an argument, refresh the current line without
- clearing the screen.
+ Clear the screen, then redraw the current line, leaving the cur-
+ rent line at the top of the screen. With an argument, refresh
+ the current line without clearing the screen.
\e[1mredraw-current-line\e[0m
Refresh the current line.
\e[1mCommands for Manipulating the History\e[0m
\e[1maccept-line (Newline, Return)\e[0m
Accept the line regardless of where the cursor is. If this line
- is non-empty, it may be added to the history list for future
- recall with \e[1madd_history()\e[22m. If the line is a modified history
+ is non-empty, it may be added to the history list for future re-
+ call with \e[1madd_history()\e[22m. If the line is a modified history
line, the history line is restored to its original state.
\e[1mprevious-history (C-p)\e[0m
Fetch the previous command from the history list, moving back in
the list.
\e[1mnext-history (C-n)\e[0m
- Fetch the next command from the history list, moving forward in
+ Fetch the next command from the history list, moving forward in
the list.
\e[1mbeginning-of-history (M-<)\e[0m
Move to the first line in the history.
\e[1mend-of-history (M->)\e[0m
- Move to the end of the input history, i.e., the line currently
+ Move to the end of the input history, i.e., the line currently
being entered.
\e[1mreverse-search-history (C-r)\e[0m
- Search backward starting at the current line and moving `up'
- through the history as necessary. This is an incremental
+ Search backward starting at the current line and moving `up'
+ through the history as necessary. This is an incremental
search.
\e[1mforward-search-history (C-s)\e[0m
- Search forward starting at the current line and moving `down'
- through the history as necessary. This is an incremental
+ Search forward starting at the current line and moving `down'
+ through the history as necessary. This is an incremental
search.
\e[1mnon-incremental-reverse-search-history (M-p)\e[0m
Search backward through the history starting at the current line
- using a non-incremental search for a string supplied by the
+ using a non-incremental search for a string supplied by the
user.
\e[1mnon-incremental-forward-search-history (M-n)\e[0m
- Search forward through the history using a non-incremental
+ Search forward through the history using a non-incremental
search for a string supplied by the user.
\e[1mhistory-search-backward\e[0m
Search backward through the history for the string of characters
- between the start of the current line and the current cursor
- position (the \e[4mpoint\e[24m). The search string must match at the
- beginning of a history line. This is a non-incremental search.
+ between the start of the current line and the current cursor po-
+ sition (the \e[4mpoint\e[24m). The search string must match at the begin-
+ ning of a history line. This is a non-incremental search.
\e[1mhistory-search-forward\e[0m
- Search forward through the history for the string of characters
+ Search forward through the history for the string of characters
between the start of the current line and the point. The search
string must match at the beginning of a history line. This is a
non-incremental search.
\e[1mhistory-substring-search-backward\e[0m
Search backward through the history for the string of characters
- between the start of the current line and the current cursor
- position (the \e[4mpoint\e[24m). The search string may match anywhere in a
+ between the start of the current line and the current cursor po-
+ sition (the \e[4mpoint\e[24m). The search string may match anywhere in a
history line. This is a non-incremental search.
\e[1mhistory-substring-search-forward\e[0m
- Search forward through the history for the string of characters
+ Search forward through the history for the string of characters
between the start of the current line and the point. The search
- string may match anywhere in a history line. This is a non-
- incremental search.
+ string may match anywhere in a history line. This is a non-in-
+ cremental search.
\e[1myank-nth-arg (M-C-y)\e[0m
- Insert the first argument to the previous command (usually the
+ Insert the first argument to the previous command (usually the
second word on the previous line) at point. With an argument \e[4mn\e[24m,
- insert the \e[4mn\e[24mth word from the previous command (the words in the
- previous command begin with word 0). A negative argument
- inserts the \e[4mn\e[24mth word from the end of the previous command. Once
- the argument \e[4mn\e[24m is computed, the argument is extracted as if the
+ insert the \e[4mn\e[24mth word from the previous command (the words in the
+ previous command begin with word 0). A negative argument in-
+ serts the \e[4mn\e[24mth word from the end of the previous command. Once
+ the argument \e[4mn\e[24m is computed, the argument is extracted as if the
"!\e[4mn\e[24m" history expansion had been specified.
\e[1myank-last-arg (M-., M-_)\e[0m
- Insert the last argument to the previous command (the last word
+ Insert the last argument to the previous command (the last word
of the previous history entry). With a numeric argument, behave
- exactly like \e[1myank-nth-arg\e[22m. Successive calls to \e[1myank-last-arg\e[0m
- move back through the history list, inserting the last word (or
- the word specified by the argument to the first call) of each
+ exactly like \e[1myank-nth-arg\e[22m. Successive calls to \e[1myank-last-arg\e[0m
+ move back through the history list, inserting the last word (or
+ the word specified by the argument to the first call) of each
line in turn. 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
+ 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
+ extract the last argument, as if the "!$" history expansion had
been specified.
+ \e[1moperate-and-get-next (C-o)\e[0m
+ Accept the current line for return to the calling application as
+ if a newline had been entered, and fetch the next line relative
+ to the current line from the history for editing. A numeric ar-
+ gument, if supplied, specifies the history entry to use instead
+ of the current line.
\e[1mCommands for Changing Text\e[0m
\e[4mend-of-file\e[24m \e[1m(usually C-d)\e[0m
- The character indicating end-of-file as set, for example, by
- ``stty''. If this character is read when there are no charac-
- ters on the line, and point is at the beginning of the line,
+ The character indicating end-of-file as set, for example, by
+ ``stty''. If this character is read when there are no charac-
+ ters on the line, and point is at the beginning of the line,
Readline interprets it as the end of input and returns \e[1mEOF\e[22m.
\e[1mdelete-char (C-d)\e[0m
Delete the character at point. If this function is bound to the
same character as the tty \e[1mEOF \e[22mcharacter, as \e[1mC-d \e[22mcommonly is, see
above for the effects.
\e[1mbackward-delete-char (Rubout)\e[0m
- Delete the character behind the cursor. When given a numeric
+ Delete the character behind the cursor. When given a numeric
argument, save the deleted text on the kill ring.
\e[1mforward-backward-delete-char\e[0m
- Delete the character under the cursor, unless the cursor is at
+ Delete the character under the cursor, unless the cursor is at
the end of the line, in which case the character behind the cur-
sor is deleted.
\e[1mquoted-insert (C-q, C-v)\e[0m
\e[1mself-insert (a, b, A, 1, !, ...)\e[0m
Insert the character typed.
\e[1mtranspose-chars (C-t)\e[0m
- Drag the character before point forward over the character at
- point, moving point forward as well. If point is at the end of
- the line, then this transposes the two characters before point.
+ Drag the character before point forward over the character at
+ point, moving point forward as well. If point is at the end of
+ the line, then this transposes the two characters before point.
Negative arguments have no effect.
\e[1mtranspose-words (M-t)\e[0m
- Drag the word before point past the word after point, moving
- point over that word as well. If point is at the end of the
+ Drag the word before point past the word after point, moving
+ point over that word as well. If point is at the end of the
line, this transposes the last two words on the line.
\e[1mupcase-word (M-u)\e[0m
- Uppercase the current (or following) word. With a negative
- argument, uppercase the previous word, but do not move point.
+ Uppercase the current (or following) word. With a negative ar-
+ gument, uppercase the previous word, but do not move point.
\e[1mdowncase-word (M-l)\e[0m
- Lowercase the current (or following) word. With a negative
- argument, lowercase the previous word, but do not move point.
+ Lowercase the current (or following) word. With a negative ar-
+ gument, lowercase the previous word, but do not move point.
\e[1mcapitalize-word (M-c)\e[0m
- Capitalize the current (or following) word. With a negative
- argument, capitalize the previous word, but do not move point.
+ Capitalize the current (or following) word. With a negative ar-
+ gument, capitalize the previous word, but do not move point.
\e[1moverwrite-mode\e[0m
- Toggle overwrite mode. With an explicit positive numeric argu-
+ Toggle overwrite mode. With an explicit positive numeric argu-
ment, switches to overwrite mode. With an explicit non-positive
numeric argument, switches to insert mode. This command affects
- only \e[1memacs \e[22mmode; \e[1mvi \e[22mmode does overwrite differently. Each call
+ only \e[1memacs \e[22mmode; \e[1mvi \e[22mmode does overwrite differently. Each call
to \e[4mreadline()\e[24m starts in insert mode. In overwrite mode, charac-
- ters bound to \e[1mself-insert \e[22mreplace the text at point rather than
- pushing the text to the right. Characters bound to \e[1mback-\e[0m
- \e[1mward-delete-char \e[22mreplace the character before point with a
+ ters bound to \e[1mself-insert \e[22mreplace the text at point rather than
+ pushing the text to the right. Characters bound to \e[1mback-\e[0m
+ \e[1mward-delete-char \e[22mreplace the character before point with a
space. By default, this command is unbound.
\e[1mKilling and Yanking\e[0m
\e[1mbackward-kill-line (C-x Rubout)\e[0m
Kill backward to the beginning of the line.
\e[1munix-line-discard (C-u)\e[0m
- Kill backward from point to the beginning of the line. The
+ Kill backward from point to the beginning of the line. The
killed text is saved on the kill-ring.
\e[1mkill-whole-line\e[0m
- Kill all characters on the current line, no matter where point
+ Kill all characters on the current line, no matter where point
is.
\e[1mkill-word (M-d)\e[0m
- Kill from point the end of the current word, or if between
- words, to the end of the next word. Word boundaries are the
+ Kill from point 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 \e[1mforward-word\e[22m.
\e[1mbackward-kill-word (M-Rubout)\e[0m
- Kill the word behind point. Word boundaries are the same as
+ Kill the word behind point. Word boundaries are the same as
those used by \e[1mbackward-word\e[22m.
\e[1munix-word-rubout (C-w)\e[0m
- Kill the word behind point, using white space as a word bound-
+ Kill the word behind point, using white space as a word bound-
ary. The killed text is saved on the kill-ring.
\e[1munix-filename-rubout\e[0m
- Kill the word behind point, using white space and the slash
- character as the word boundaries. The killed text is saved on
+ Kill the word behind point, using white space and the slash
+ character as the word boundaries. The killed text is saved on
the kill-ring.
\e[1mdelete-horizontal-space (M-\)\e[0m
Delete all spaces and tabs around point.
\e[1mkill-region\e[0m
- Kill the text between the point and \e[4mmark\e[24m (saved cursor posi-
+ Kill the text between the point and \e[4mmark\e[24m (saved cursor posi-
tion). This text is referred to as the \e[4mregion\e[24m.
\e[1mcopy-region-as-kill\e[0m
Copy the text in the region to the kill buffer.
\e[1mcopy-backward-word\e[0m
- Copy the word before point to the kill buffer. The word bound-
+ Copy the word before point to the kill buffer. The word bound-
aries are the same as \e[1mbackward-word\e[22m.
\e[1mcopy-forward-word\e[0m
- Copy the word following point to the kill buffer. The word
+ Copy the word following point to the kill buffer. The word
boundaries are the same as \e[1mforward-word\e[22m.
\e[1myank (C-y)\e[0m
Yank the top of the kill ring into the buffer at point.
\e[1myank-pop (M-y)\e[0m
- Rotate the kill ring, and yank the new top. Only works follow-
+ Rotate the kill ring, and yank the new top. Only works follow-
ing \e[1myank \e[22mor \e[1myank-pop\e[22m.
\e[1mNumeric Arguments\e[0m
\e[1mdigit-argument (M-0, M-1, ..., M--)\e[0m
- Add this digit to the argument already accumulating, or start a
+ Add this digit to the argument already accumulating, or start a
new argument. M-- starts a negative argument.
\e[1muniversal-argument\e[0m
- This is another way to specify an argument. If this command is
- followed by one or more digits, optionally with a leading minus
- sign, those digits define the argument. If the command is fol-
- lowed by digits, executing \e[1muniversal-argument \e[22magain ends the
- numeric argument, but is otherwise ignored. As a special case,
- if this command is immediately followed by a character that is
- neither a digit or minus sign, the argument count for the next
- command is multiplied by four. The argument count is initially
- one, so executing this function the first time makes the argu-
+ This is another way to specify an argument. If this command is
+ followed by one or more digits, optionally with a leading minus
+ sign, those digits define the argument. If the command is fol-
+ lowed by digits, executing \e[1muniversal-argument \e[22magain ends the nu-
+ meric argument, but is otherwise ignored. As a special case, if
+ this command is immediately followed by a character that is nei-
+ ther a digit or minus sign, the argument count for the next com-
+ mand is multiplied by four. The argument count is initially
+ one, so executing this function the first time makes the argu-
ment count four, a second time makes the argument count sixteen,
and so on.
\e[1mCompleting\e[0m
\e[1mcomplete (TAB)\e[0m
- Attempt to perform completion on the text before point. The
- actual completion performed is application-specific. \e[1mBash\e[22m, for
- instance, attempts completion treating the text as a variable
- (if the text begins with \e[1m$\e[22m), username (if the text begins with
- \e[1m~\e[22m), hostname (if the text begins with \e[1m@\e[22m), or command (including
- aliases and functions) in turn. If none of these produces a
- match, filename completion is attempted. \e[1mGdb\e[22m, on the other
- hand, allows completion of program functions and variables, and
+ Attempt to perform completion on the text before point. The ac-
+ tual completion performed is application-specific. \e[1mBash\e[22m, for
+ instance, attempts completion treating the text as a variable
+ (if the text begins with \e[1m$\e[22m), username (if the text begins with
+ \e[1m~\e[22m), hostname (if the text begins with \e[1m@\e[22m), or command (including
+ aliases and functions) in turn. If none of these produces a
+ match, filename completion is attempted. \e[1mGdb\e[22m, on the other
+ hand, allows completion of program functions and variables, and
only attempts filename completion under certain circumstances.
\e[1mpossible-completions (M-?)\e[0m
- List the possible completions of the text before point. When
+ List the possible completions of the text before point. When
displaying completions, readline sets the number of columns used
- for display to the value of \e[1mcompletion-display-width\e[22m, the value
- of the environment variable \e[1mCOLUMNS\e[22m, or the screen width, in
+ for display to the value of \e[1mcompletion-display-width\e[22m, the value
+ of the environment variable \e[1mCOLUMNS\e[22m, or the screen width, in
that order.
\e[1minsert-completions (M-*)\e[0m
- Insert all completions of the text before point that would have
+ Insert all completions of the text before point that would have
been generated by \e[1mpossible-completions\e[22m.
\e[1mmenu-complete\e[0m
- Similar to \e[1mcomplete\e[22m, but replaces the word to be completed with
- a single match from the list of possible completions. Repeated
- execution of \e[1mmenu-complete \e[22msteps through the list of possible
- completions, inserting each match in turn. At the end of the
+ Similar to \e[1mcomplete\e[22m, but replaces the word to be completed with
+ a single match from the list of possible completions. Repeated
+ execution of \e[1mmenu-complete \e[22msteps through the list of possible
+ completions, inserting each match in turn. At the end of the
list of completions, the bell is rung (subject to the setting of
\e[1mbell-style\e[22m) and the original text is restored. An argument of \e[4mn\e[0m
- moves \e[4mn\e[24m 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 \e[1mTAB\e[22m, but is unbound by
- default.
+ moves \e[4mn\e[24m positions forward in the list of matches; a negative ar-
+ gument may be used to move backward through the list. This com-
+ mand is intended to be bound to \e[1mTAB\e[22m, but is unbound by default.
\e[1mmenu-complete-backward\e[0m
Identical to \e[1mmenu-complete\e[22m, but moves backward through the list
of possible completions, as if \e[1mmenu-complete \e[22mhad been given a
ning of the line. In either case, the line is accepted as if a
newline had been typed. The default value of \e[1mcomment-begin\e[0m
makes the current line a shell comment. If a numeric argument
- causes the comment character to be removed, the line will be
- executed by the shell.
+ causes the comment character to be removed, the line will be ex-
+ ecuted by the shell.
\e[1mdump-functions\e[0m
Print all of the functions and their key bindings to the read-
line output stream. If a numeric argument is supplied, the out-
\e[1mDEFAULT KEY BINDINGS\e[0m
The following is a list of the default emacs and vi bindings. Charac-
- ters with the eighth bit set are written as M-<character>, and are
- referred to as \e[4mmetafied\e[24m characters. The printable ASCII characters not
+ ters with the eighth bit set are written as M-<character>, and are re-
+ ferred to as \e[4mmetafied\e[24m characters. The printable ASCII characters not
mentioned in the list of emacs standard bindings are bound to the
\e[1mself-insert \e[22mfunction, which just inserts the given character into the
input line. In vi insertion mode, all characters not specifically men-
"M-C-H" backward-kill-word
"M-C-I" tab-insert
"M-C-J" vi-editing-mode
+ "M-C-L" clear-display
"M-C-M" vi-editing-mode
"M-C-R" revert-line
"M-C-Y" yank-nth-arg
-GNU Readline 7.0 2017 December 28 READLINE(3)
+GNU Readline 8.1 2020 October 29 READLINE(3)
projects / thirdparty / readline.git / blobdiff