jpayne@68: .TH EDITRC 5 "May 22, 2016" ""
jpayne@68: .SH NAME
jpayne@68: \fBeditrc\fP
jpayne@68: \- configuration file for editline library
jpayne@68: .SH SYNOPSIS
jpayne@68: .br
jpayne@68: \fBeditrc\fP
jpayne@68: .SH DESCRIPTION
jpayne@68: The
jpayne@68: \fBeditrc\fP
jpayne@68: file defines various settings to be used by the
jpayne@68: \fBeditline\fP(3)
jpayne@68: library.
jpayne@68: 
jpayne@68: The format of each line is:
jpayne@68: is one of the
jpayne@68: builtin commands.
jpayne@68: Refer to
jpayne@68: for more information.
jpayne@68: is the program name string that a program defines when it calls
jpayne@68: to set up
jpayne@68: which is usually
jpayne@68: will be executed for any program which matches
jpayne@68: may also be a
jpayne@68: style
jpayne@68: regular expression, in which case
jpayne@68: will be executed for any program that matches the regular expression.
jpayne@68: 
jpayne@68: If
jpayne@68: is absent,
jpayne@68: is executed for all programs.
jpayne@68: The
jpayne@68: library has some builtin commands, which affect the way
jpayne@68: that the line editing and history functions operate.
jpayne@68: These are based on similar named builtins present in the
jpayne@68: shell.
jpayne@68: 
jpayne@68: The following builtin commands are available:
jpayne@68: Without options and arguments, list all bound keys and macros, and
jpayne@68: the editor command or input string to which each one is bound.
jpayne@68: If only
jpayne@68: is supplied, show the binding for that key or macro.
jpayne@68: If
jpayne@68: is supplied, bind the editor
jpayne@68: to that key or macro.
jpayne@68: 
jpayne@68: The options are as follows:
jpayne@68: List or change key bindings in the
jpayne@68: mode alternate (command mode) key map.
jpayne@68: Bind all keys to the standard
jpayne@68: Emacs-like bindings.
jpayne@68: is interpreted as a symbolic arrow key name, which may be one of
jpayne@68: or
jpayne@68: List all editor commands and a short description of each.
jpayne@68: Remove the binding of the key or macro
jpayne@68: Define a keyboard macro rather than a key binding or command macro:
jpayne@68: is taken as a literal string and appended to the input queue whenever
jpayne@68: is typed.
jpayne@68: Bound keys and macros in
jpayne@68: are themselves reinterpreted, and this continues for ten levels of
jpayne@68: interpretation.
jpayne@68: Bind all keys to the standard
jpayne@68: bindings.
jpayne@68: 
jpayne@68: The
jpayne@68: manual documents all editor commands and contains more information
jpayne@68: about macros and the input queue.
jpayne@68: and
jpayne@68: can contain control characters of the form
jpayne@68: e.g.\&
jpayne@68: and the following backslashed escape sequences:
jpayne@68: Bell
jpayne@68: Backspace
jpayne@68: Escape
jpayne@68: Formfeed
jpayne@68: Newline
jpayne@68: Carriage return
jpayne@68: Horizontal tab
jpayne@68: Vertical tab
jpayne@68: The
jpayne@68: character corresponding to the octal number
jpayne@68: nullifies the special meaning of the following character,
jpayne@68: if it has any, notably
jpayne@68: and
jpayne@68: Exercise terminal capabilities given in
jpayne@68: If
jpayne@68: is
jpayne@68: or
jpayne@68: the value of that capability is printed, with
jpayne@68: or
jpayne@68: indicating that the terminal does or does not have that capability.
jpayne@68: returns an empty string for non-existent capabilities, rather than
jpayne@68: causing an error.
jpayne@68: causes messages to be verbose.
jpayne@68: Enable or disable the
jpayne@68: functionality in a program.
jpayne@68: The
jpayne@68: command lists all entries in the history.
jpayne@68: The
jpayne@68: command sets the history size to
jpayne@68: entries.
jpayne@68: The
jpayne@68: command controls if history should keep duplicate entries.
jpayne@68: If
jpayne@68: is non zero, only keep unique history entries.
jpayne@68: If
jpayne@68: is zero, then keep all entries (the default).
jpayne@68: Set the terminal capability
jpayne@68: to
jpayne@68: as defined in
jpayne@68: No sanity checking is done.
jpayne@68: Oo Fl Ar mode Oc Oo Ar mode Oc Oo Ar char\| Ns Ic = Ns Ar c Oc
jpayne@68: Control which tty modes that
jpayne@68: won't allow the user to change.
jpayne@68: or
jpayne@68: tells
jpayne@68: to act on the
jpayne@68: or
jpayne@68: set of tty modes respectively; defaulting to
jpayne@68: 
jpayne@68: Without other arguments,
jpayne@68: lists the modes in the chosen set which are fixed on
jpayne@68: or off
jpayne@68: lists all tty modes in the chosen set regardless of the setting.
jpayne@68: With
jpayne@68: or
jpayne@68: fixes
jpayne@68: on or off or removes control of
jpayne@68: in the chosen set.
jpayne@68: can also be used to set tty characters to particular values using
jpayne@68: If
jpayne@68: is empty
jpayne@68: then the character is set to
jpayne@68: List the values of all the terminal capabilities (see
jpayne@68: Names the default configuration file for the
jpayne@68: library.
jpayne@68: Last resort user configuration file for the
jpayne@68: library if no other file is specified.
jpayne@68: The
jpayne@68: library was written by
jpayne@68: and this manual was written by
jpayne@68: with some sections inspired by