Readline Variables
Up
Next
Previous
Readline Variables
Readline has variables that can be used to further customize its
behavior. A variable may be set in the
inputrc
file with a statement of the form
Except where noted, readline variables can take the values
On
or
.BR Off .
The variables and their default values are:
-
bell-style (audible)
-
Controls what happens when readline wants to ring the terminal bell.
If set to none\fP, readline never rings the bell. If set to
visible\fP, readline uses a visible bell if one is available.
If set to audible\fP, readline attempts to ring the terminal's bell.
-
comment-begin (``#'')
-
The string that is inserted when the readline
insert-comment
command is executed.
This command is bound to
M-#
in emacs mode and to
#
in vi command mode.
-
completion-ignore-case (Off)
-
If set to On\fP, readline performs filename matching and completion
in a case-insensitive fashion.
-
completion-query-items (100)
-
This determines when the user is queried about viewing
the number of possible completions
generated by the possible-completions\fP 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.
-
convert-meta (On)
-
If set to On\fP, readline will convert characters with the
eighth bit set to an ASCII key sequence
by stripping the eighth bit and prefixing an
escape character (in effect, using escape as the meta prefix\fP).
-
disable-completion (Off)
-
If set to On\fP, readline will inhibit word completion. Completion
characters will be inserted into the line as if they had been
mapped to self-insert\fP.
-
editing-mode (emacs)
-
Controls whether readline begins with a set of key bindings similar
to emacs\fP or vi\fP.
editing-mode
can be set to either
emacs
or
.BR vi .
-
enable-keypad (Off)
-
When set to On\fP, readline will try to enable the application
keypad when it is called. Some systems need this to enable the
arrow keys.
-
expand-tilde (Off)
-
If set to on\fP, tilde expansion is performed when readline
attempts word completion.
-
horizontal-scroll-mode (Off)
-
When set to On\fP, 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.
-
input-meta (Off)
-
If set to On\fP, 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. The name
meta-flag
is a synonym for this variable.
-
isearch-terminators (``C-[C-J'')
-
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
ESC\fP and C-J\fP will terminate an incremental search.
-
keymap (emacs)
-
Set the current readline keymap. The set of valid keymap names is
emacs, emacs-standard, emacs-meta, emacs-ctlx, vi,
vi-command\fP, and
.IR vi-insert .
vi\fP is equivalent to vi-command\fP; emacs\fP is
equivalent to emacs-standard\fP. The default value is
.IR emacs ;
the value of
editing-mode
also affects the default keymap.
-
mark-directories (On)
-
If set to On\fP, completed directory names have a slash
appended.
-
mark-modified-lines (Off)
-
If set to On\fP, history lines that have been modified are displayed
with a preceding asterisk (*\fP).
-
output-meta (Off)
-
If set to On\fP, readline will display characters with the
eighth bit set directly rather than as a meta-prefixed escape
sequence.
-
print-completions-horizontally (Off)
-
If set to On\fP, readline will display completions with matches
sorted horizontally in alphabetical order, rather than down the screen.
-
show-all-if-ambiguous (Off)
-
This alters the default behavior of the completion functions. If
set to
.BR on ,
words which have more than one possible completion cause the
matches to be listed immediately instead of ringing the bell.
-
visible-stats (Off)
-
If set to On\fP, a character denoting a file's type as reported
by stat\fP(2) is appended to the filename when listing possible
completions.
Up
Next
Previous