EDITRC(5)

NAME
editrc - configuration file for editline library

SYNOPSIS
editrc

DESCRIPTION
The editrc file defines various settings to be used by the editline(3) library.

The format of each line is either:
    prog:command [arg [...]]
or
    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 setup editline(3), which is usually argv[0]. command will be executed for any program which matches prog.

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.

BUILTIN COMMANDS
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
    [-a] [-e] [-k] [-l] [-r] [-s] [-v] [key [command]] Without options, list all bound keys, and the editor command to which each is bound. If key is supplied, show the bindings for key. If key command is supplied, bind command to key. Options include:

    -e  Bind all keys to the standard GNU Emacs-like bindings.

    -v  Bind all keys to the standard vi(1) -like bindings.

    -a  List or change key bindings in the vi(1) mode alternate (command mode) key map.

    -k  key is interpreted as a symbolic arrow key name, which may be one of ‘up’, ‘down’, ‘left’ or ‘right’.

    -l  List all editor commands and a short description of each.

    -r  Remove a key's binding.

    -s  command is taken as a literal string and treated as terminal input when key is typed. Bound keys in command are themselves reinterpreted, and this continues for ten levels of interpretation.

    key and command can contain control characters of the form ‘^character’ ( e.g. ‘^A’), and the following backslashed escape sequences:

    \a  Bell
    \b  Backspace
    \e  Escape
    \f  Formfeed
    \n  Newline
    \r  Carriage return
    \t  Horizontal tab
    \v  Vertical tab
    \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
    [-sv] 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 emptry string for non-existant capabilities, rather than causing an error. -v causes messages to be verbose.

edit [on | off]
    Enable or disable the editline functionality in a program.

history
    List the history.

telltc
    List the values of all the terminal capabilities (see termcap(5) ).

settc cap val
    Set the terminal capability cap to val, as defined in termcap(5). No sanity checking is done.

setty
    [-a] [-d] [-q] [-x] [+mode] [-mode] [mode] 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.

SEE ALSO
editline(3), regex(3), termcap(5)

AUTHORS
The editline library was written by Christos Zoulas, and this manual was written by Luke Mewburn, with some sections inspired by tcsh(1).