editrc - configuration file for editline library
The editrc file defines various settings to be used by the
The format of each line is:
[prog:]command [arg ...]
command is one of the editline(3) builtin commands.
Refer to BUILTIN COMMANDS for more information.
prog is the program name string that a program defines when
it calls el_init(3) to set up editline(3), which is usually
argv. command will be executed for any program which
prog may also be a regex(3) 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
The 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 tcsh(1) shell.
The following builtin commands are available:
- bind Oo Fl aeklrsv Oc [key
- 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
The options are as follows:
- List or change key bindings in the vi(1) 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 interpretation.
- Bind all keys to the standard vi(1) -like bindings.
The editline(7) 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 `No'^character ( e.g. `^A' ), and the following backslashed
- Carriage return
- Horizontal tab
- Vertical tab
- \ Ar nnn
- The ASCII character corresponding to the octal number nnn.
`\' nullifies the special meaning of the following character, if
it has any, notably `\' and `^'.
- echotc Oo Fl sv Oc arg ...
- 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
- edit [Li on | Li off]
- Enable or disable the editline functionality in a program.
- history list | size Dv n |
unique Dv n
- 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
- settc cap val
- Set the terminal capability cap to val, as defined in
termcap(5). No sanity checking is done.
- setty Oo Fl a Oc Oo Fl d Oc Oo Fl q Oc Oo Fl x Oc Oo
+mode Oc \fP
- Oo Ar -mode Oc Oo Ar mode Oc Oo Ar char=c Oc 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 -x.
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, -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 _POSIX_VDISABLE .
- List the values of all the terminal capabilities (see termcap(5))
- Names the default configuration file for the editline(3)
editline(3), regex(3), termcap(5), editline(7)
-nosplit The editline library was written by
- Last resort, if no other file is specified, user configuration file for
the editline(3) library.
Christos Zoulas , and this manual was written by
Luke Mewburn , with some sections inspired by tcsh(1).