configuration file for editline library
file defines various settings to be used
by the editline(3)
The format of each line is:
[prog:]command [arg ...]
is one of the
Refer to BUILTIN
for more information.
is the program name string that a program
defines when it calls
to set up
, which is usually
will be executed for any program
which matches prog
may also be a
expression, in which case command
executed for any program that matches the regular expression.
is executed for all programs.
library has some builtin commands,
which affect the way that the line editing and history functions operate.
These are based on similar named builtins present in the tcsh shell.
The following builtin commands are available:
- Without options and arguments, list all bound keys and
macros, and the editor command or input string to which each one is bound.
If only key is supplied, show the binding
for that key or macro. If key command is
supplied, bind the editor command to that
key or macro.
The options are as follows:
The editline(7) manual
documents all editor commands and contains more information about macros
and the input queue.
command can contain control characters of
(e.g. ‘^A’), and the following backslashed escape sequences:
- List or change key bindings in the
vi(1) mode alternate
(command mode) key map.
- Bind all keys to the standard GNU Emacs-like
- key is interpreted as
a symbolic arrow key name, which may be one of ‘up’,
‘down’, ‘left’ or
- List all editor commands and a short description of
- Remove the binding of the key or macro
- Define a keyboard macro rather than a key binding or
command macro: command is taken as a
literal string and appended to the input queue whenever
key is typed. Bound keys and macros
in command are themselves
reinterpreted, and this continues for ten levels of
- Bind all keys to the standard
‘\’ nullifies the special meaning of the following character,
if it has any, notably ‘\’ and ‘^’.
- Carriage return
- Horizontal tab
- Vertical tab
- The ASCII character corresponding to the octal number
- Exercise terminal capabilities given in
arg .... If
arg is ‘baud’,
‘cols’, ‘lines’, ‘rows’,
‘meta’, or ‘tabs’, the value of that
capability is printed, with “yes” or “no”
indicating that the terminal does or does not have that capability.
-s returns an empty string for non-existent
capabilities, rather than causing an error.
-v causes messages to be verbose.
- Enable or disable the editline
functionality in a program.
- The list command lists all
entries in the history. The size command
sets the history size to
n entries. The
unique command controls if history should
keep duplicate entries. If
n is non
zero, only keep unique history entries. If
n is zero, then keep all entries (the
- Set the terminal capability
val, as defined in
termcap(5). No sanity
checking is done.
- Control which tty modes that
editrc won't allow the user to change.
-d, -q or
-x tells setty
to act on the ‘edit’, ‘quote’ or
‘execute’ set of tty modes respectively; defaulting to
Without other arguments, setty lists the modes
in the chosen set which are fixed on (‘+mode’) or off
(‘-mode’). -a lists all tty
modes in the chosen set regardless of the setting. With
mode on or off or removes control of
mode in the chosen set.
Setty can also be used to set tty characters to
particular values using char=value. If
value is empty then the character is set
- List the values of all the terminal capabilities (see
- User configuration file for the
library was written by
, and this manual was
written by Luke Mewburn
, with some sections
inspired by tcsh.