Readline commands may be given numeric arguments, which
normally act as a repeat count. Sometimes, however, it is
the sign of the argument that is significant. Passing a
negative argument to a command that acts in the forward
direction (e.g., kill-line) causes that command to act in
a backward direction. Commands whose behavior with arguments deviates from this are noted.
When a command is described as killing text, the text
deleted is saved for possible future retrieval (yanking).
The killed text is saved in a kill-ring. Consecutive
kills cause the text to be accumulated into one unit,
which can be yanked all at once. Commands which do not
kill text separate the chunks of text on the kill-ring.
Initialization File
Readline is customized by putting commands in an initialization file.
The name of this file is taken from the
value of the INPUTRC variable. If that variable is unset,
the default is ~/.inputrc. 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 in the readline init file. Blank
lines are ignored. Lines beginning with a # are comments.
Lines beginning with a $ indicate conditional constructs.
Other lines denote key bindings and variable settings.
Each program using this library may add its own commands
and bindings.
For example, placing
M-Control-u: universal-argument
or
C-Meta-u: universal-argument
into the ~/.inputrc would make M-C-u execute the readline
command universal-argument.
The following symbolic character names are recognized
while processing key bindings:
RUBOUT, DEL, ESC, LFD,
NEWLINE, RET, RETURN, SPC,
SPACE, and TAB. In addition to
command names, readline allows keys to be bound to a
string that is inserted when the key is pressed (a macro).
Key Bindings
The syntax for controlling key bindings in the ~/.inputrc
file is simple. All that is required is the name of the
command or the text of a macro and a key sequence to which
it should be bound. The name may be specified in one of
two ways: as a symbolic key name, possibly with Meta- or
Control- prefixes, or as a key sequence. When using the
form
keyname: function-name or macro
keyname is the name
of a key spelled out in English. For example:
In the above example, C-u is bound to the functionControl-u: universal-argument Meta-Rubout: backward-kill-word Control-o: ">&output"
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).
In the second form,
keyseq differs from keyname above in that strings denoting 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."keyseq":function-name or macro
In this example, C-u is again bound to the function"\C-u": universal-argument "\C-x\C-r": re-read-init-file "\e[11~": "Function Key 1"
universal-argument. 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 full set of escape sequences is
\C- \M- \e \\ \" \' Bash allows the current readline key bindings to be displayed
or modified with the bind builtin command. The
editing mode may be switched during interactive use by
using the -o option to the set builtin command. Other
programs using this library provide similar mechanisms.
The inputrc file may be edited and re-read if a program
does not provide any other means to incorporate new bindings.
set variable-name value
Except where noted, readline variables can take the values
On or Off.
The variables and their default values are:
horizontal-scroll-mode (Off)
On, 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.
editing-mode (emacs)
emacs or vi.
editing-mode can
be set to either emacs or vi.
mark-modified-lines (Off)
On, history lines that have been modified
are displayed with a preceding asterisk (*).
bell-style (audible)
none, readline never
rings the bell. If set to visible, readline uses a
visible bell if one is available. If set to audible,
readline attempts to ring the terminal's bell.
comment-begin (``#'')
vi-comment command is executed.
meta-flag (Off)
On, readline will enable eight-bit input
(that is, it will not strip the high bit from the
characters it reads), regardless of what the terminal claims it can support.
blink-matching-paren (On)
On, readline will display the corresponding opening parenthesis when a closing parenthesis
is typed.
convert-meta (On)
On, readline will convert characters with
the eighth bit set to an ASCII key sequence by
stripping the eighth bit and prepending an escape
character (in effect, using escape as the meta prefix).
output-meta (Off)
On, readline will display characters with
the eighth bit set directly rather than as a meta-
prefixed escape sequence.
completion-query-items (100)
possible-completions command. 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.
keymap (emacs)
emacs, 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 editing-mode also affects the default
keymap.
show-all-if-ambiguous (Off)
on, words which have more
than one possible completion cause the matches to
be listed immediately instead of ringing the bell.
expand-tilde (Off)
on, tilde expansion is performed when
readline attempts word completion.
$if
$if construct allows bindings to be made based
on the editing mode, the terminal being used, or
the application using readline. The text of the
test extends to the end of the line; no characters
are required to isolate it.
mode
mode= form of the $if directive is used
to test whether readline is in emacs or vi
mode. This may be used in conjunction with
the set keymap command, for instance, to set
bindings in the emacs-standard
and emacs-ctlx keymaps only if readline is starting
out in emacs mode.
term
term= 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 = is tested against the full
name of the terminal and the portion of the
terminal name before the first -. This
allows sun to match both sun
and sun-cmd,
for instance.
application
application construct is used to include
application-specific settings. Each program
using the readline library sets the application name,
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
Bash:
$if bash # Quote the current or previous word "\C-xq": "\eb\"\ef\"" $endif
$endif
$if command.
$else
$if directive are
executed if the test fails.
beginning-of-line (C-a)
end-of-line (C-e)
forward-char (C-f)
backward-char (C-b)
forward-word (M-f)
backward-word (M-b)
clear-screen (C-l)
redraw-current-line
accept-line (Newline, Return)
previous-history (C-p)
next-history (C-n)
beginning-of-history (M-<)
end-of-history (M->)
reverse-search-history (C-r)
forward-search-history (C-s)
non-incremental-reverse-search-history (M-p)
non-incremental-forward-search-history (M-n)
history-search-forward
history-search-backward
yank-nth-arg (M-C-y)
delete-char (C-d)
backward-delete-char (Rubout)
quoted-insert (C-q, C-v)
tab-insert (M-TAB)
self-insert (a, b, A, 1, !, ...)
transpose-chars (C-t)
transpose-words (M-t)
upcase-word (M-u)
downcase-word (M-l)
capitalize-word (M-c)
kill-line (C-k)
backward-kill-line (C-x Rubout)
unix-line-discard (C-u)
kill-whole-line
kill-word (M-d)
forward-word.
backward-kill-word (M-Rubout)
backward-word.
unix-word-rubout (C-w)
backward-kill-word.
delete-horizontal-space
yank (C-y)
yank-pop (M-y)
yank or yank-pop.
digit-argument (M-0, M-1, ..., M--)
universal-argument
complete (TAB)
Clisp, for instance, attempts completion
of symbol names, of function names (if the
text is prefixed by ( or #') or of filenames (if
the text is prefixed by #"). Bash, on the other
hand, attempts completion treating the text as a
variable (if the text begins with $), username (if
the text begins with ~), hostname (if the text
begins with @), or command (including aliases and
functions) in turn. If none of these produces a
match, filename completion is attempted. Gdb,
finally, allows completion of program functions and
variables, and only attempts filename completion
under certain circumstances.
possible-completions (M-?)
insert-completions
possible-completions.
By default, this is not bound to
a key.
start-kbd-macro (C-x ()
end-kbd-macro (C-x ))
call-last-kbd-macro (C-x e)
re-read-init-file (C-x C-r)
abort (C-g)
bell-style).
do-uppercase-version (M-a, M-b, ...)
prefix-meta (ESC)
undo (C-_, C-x C-u)
revert-line (M-r)
undo command enough times to return the
line to its initial state.
tilde-expand (M-~)
dump-functions
emacs-editing-mode (C-e)
vi editing mode, this causes a switch to
emacs editing mode.
vi-editing-mode (M-C-j)
emacs editing mode, this causes a switch to
vi editing mode.
self-insert
function, which just inserts the given character into the
input line. In vi insertion mode, all characters not
specifically mentioned are bound to self-insert.
Characters assigned to signal generation by stty(1)
or the terminal driver, such as C-Z or C-C, retain that function.
Upper and lower case metafied characters are bound to the
same function in the emacs mode meta keymap. The remaining
characters are unbound, which causes readline to ring
the bell (subject to the setting of the bell-style variable).
"C-A" ->beginning-of-line"C-B" ->backward-char"C-D" ->delete-char"C-E" ->end-of-line"C-F" ->forward-char"C-G" ->abort"C-H" ->backward-delete-char"C-I" ->complete"C-J" ->accept-line"C-K" ->kill-line"C-L" ->clear-screen"C-M" ->accept-line"C-N" ->next-history"C-P" ->previous-history"C-Q" ->quoted-insert"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-Y" ->yank"C-_" ->undo" " to "/" ->self-insert"0" to "9" ->self-insert":" to "~" ->self-insert"C-?" ->backward-delete-char
"M-C-H" ->backward-kill-word"M-C-I" ->tab-insert"M-C-J" ->vi-editing-mode"M-C-M" ->vi-editing-mode"M-C-R" ->revert-line"M-C-Y" ->yank-nth-arg"M-C-[" ->complete"M-&" ->tilde-expand"M--" ->digit-argument"M-0" ->digit-argument"M-1" ->digit-argument"M-2" ->digit-argument"M-3" ->digit-argument"M-4" ->digit-argument"M-5" ->digit-argument"M-6" ->digit-argument"M-7" ->digit-argument"M-8" ->digit-argument"M-9" ->digit-argument"M-<" ->beginning-of-history"M->" ->end-of-history"M-?" ->possible-completions"M-B" ->backward-word"M-C" ->capitalize-word"M-D" ->kill-word"M-F" ->forward-word"M-L" ->downcase-word"M-N" ->non-incremental-forward-search-history"M-O" ->arrow-key-prefix"M-P" ->non-incremental-reverse-search-history"M-R" ->revert-line"M-T" ->transpose-words"M-U" ->upcase-word"M-Y" ->yank-pop"M-C-Y" ->yank-nth-arg"M-C-?" ->backward-delete-word
"C-XC-G" ->abort"C-XC-R" ->re-read-init-file"C-XC-U" ->undo"C-X(" ->start-kbd-macro"C-X)" ->end-kbd-macro"C-Xe" ->call-last-kbd-macro"C-XC-?" ->backward-kill-line
"C-D" ->vi-eof-maybe"C-H" ->backward-delete-char"C-I" ->complete"C-J" ->accept-line"C-K" ->kill-line"C-L" ->clear-screen"C-M" ->accept-line"C-N" ->next-history"C-P" ->previous-history"C-Q" ->quoted-insert"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-Y" ->yank"C-[" ->vi-movement-mode" " to "~" ->self-insert"C-?" ->backward-delete-char
"C-D" ->vi-eof-maybe"C-E" ->emacs-editing-mode"C-G" ->abort"C-H" ->backward-char"C-J" ->accept-line"C-K" ->kill-line"C-L" ->clear-screen"C-M" ->accept-line"C-N" ->next-history"C-P" ->previous-history"C-Q" ->quoted-insert"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-Y" ->yank"C-[" ->abort" " ->forward-char"#" ->vi-comment"$" ->end-of-line"%" ->vi-match"&" ->vi-tilde-expand"*" ->vi-complete"+" ->down-history"," ->vi-char-search"-" ->previous-history"." ->vi-redo"/" ->vi-search"0" ->beginning-of-line"1" to "9" ->vi-arg-digit";" ->vi-char-search"=" ->vi-complete"?" ->vi-search"@" ->is undefined"A" ->vi-append-eol"B" ->vi-prev-word"C" ->vi-change-to"D" ->vi-delete-to"E" ->vi-end-word"F" ->vi-char-search"I" ->vi-insert-beg"N" ->vi-search-again"P" ->vi-put"R" ->vi-replace"S" ->vi-subst"T" ->vi-char-search"U" ->revert-line"W" ->vi-next-word"X" ->backward-delete-char"Y" ->vi-yank-to"\" ->vi-complete"^" ->vi-first-print"_" ->vi-yank-arg"a" ->vi-append-mode"b" ->vi-prev-word"c" ->vi-change-to"d" ->vi-delete-to"e" ->vi-end-word"f" ->vi-char-search"h" ->backward-char"i" ->vi-insertion-mode"j" ->next-history"k" ->prev-history"l" ->forward-char"n" ->vi-search-again"r" ->vi-change-char"s" ->vi-subst"t" ->vi-char-search"u" ->undo"w" ->vi-next-word"x" ->vi-delete"y" ->vi-yank-to"|" ->vi-column"~" ->vi-change-case
bash(1)
~/.inputrc
Last modified: 2 January 1995.