||FreeBSD File Formats Manual
configuration file for editline library
editrc file defines various settings to be used by
The format of each line is:
[prog:]command [arg ...]
command is one of the
builtin commands. Refer to BUILTIN
COMMANDS for more information.
prog is the program name string that a
program defines when it calls
to set up
which is usually argv.
command will be executed for any program which matches
prog may also be a
style regular expression, in which case command will
be executed for any program that matches the regular expression.
If prog is absent,
command is executed for all programs.
editline 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
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:
- List or change key bindings in the
mode alternate (command mode) key map.
- Bind all keys to the standard GNU Emacs-like bindings.
- key is interpreted as a symbolic arrow key name,
which may be one of ‘up’, ‘down’,
‘left’ or ‘right’.
- List all editor commands and a short description of each.
- Remove the binding of the key or macro key.
- 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
manual documents all editor commands and contains more information about
macros and the input queue.
key and command
can contain control characters of the form
character’ (e.g. ‘^A’), and
the following backslashed escape sequences:
- Carriage return
- Horizontal tab
- Vertical tab
- The ASCII character corresponding to the octal number
‘\’ nullifies the special meaning of the
following character, if it has any, notably ‘\’ and
- 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
list | size
n | unique
- 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.
n is zero, then keep all entries (the
- Set the terminal capability cap to
val, as defined in
No sanity checking is done.
- Control which tty modes that
editrc won't allow
the user to change.
setty to act
on the ‘edit’, ‘quote’ or
‘execute’ set of tty modes respectively; defaulting to
Without other arguments,
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, -mode or
mode, fixes 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 to
- List the values of all the terminal capabilities (see
- Last resort, if no other file is specified, user configuration file for
editline library was written by
Christos Zoulas, and this manual was written by
Luke Mewburn, with some sections inspired by
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.