1EDITRC(5)                     File Formats Manual                    EDITRC(5)
2
3
4

NAME

6       editrc - configuration file for editline library
7

SYNOPSIS

9       editrc
10

DESCRIPTION

12       The  editrc file defines various settings to be used by the editline(3)
13       library.
14
15       The format of each line is:
16
17       [prog:]command [arg ...]
18
19       command is one of the editline(3) builtin commands.  Refer  to  BUILTIN
20       COMMANDS for more information.
21
22       prog  is  the  program name string that a program defines when it calls
23       el_init(3) to set up editline(3), which is  usually  argv[0].   command
24       will be executed for any program which matches prog.
25
26       prog  may  also  be  a regex(3) style regular expression, in which case
27       command will be executed for  any  program  that  matches  the  regular
28       expression.
29
30       If prog is absent, command is executed for all programs.
31

BUILTIN COMMANDS

33       The  editline  library  has some builtin commands, which affect the way
34       that the line editing and history functions operate.  These  are  based
35       on similar named builtins present in the tcsh(1) shell.
36
37       The following builtin commands are available:
38
39       bind Oo Fl aeklrsv Oc [key [command]]
40              Without  options  and arguments, list all bound keys and macros,
41              and the editor command or input string  to  which  each  one  is
42              bound.   If  only key is supplied, show the binding for that key
43              or macro.  If key command is supplied, bind the  editor  command
44              to that key or macro.
45
46              The options are as follows:
47
48              -a     List  or  change key bindings in the vi(1) mode alternate
49                     (command mode) key map.
50
51              -e     Bind all keys to the standard GNU Emacs-like bindings.
52
53              -k     key is interpreted as a symbolic arrow  key  name,  which
54                     may be one of `up', `down', `left' or `right'.
55
56              -l     List all editor commands and a short description of each.
57
58              -r     Remove the binding of the key or macro key.
59
60              -s     Define a keyboard macro rather than a key binding or com‐
61                     mand macro: command is taken  as  a  literal  string  and
62                     appended to the input queue whenever key is typed.  Bound
63                     keys and macros in command are themselves  reinterpreted,
64                     and this continues for ten levels of interpretation.
65
66              -v     Bind all keys to the standard vi(1) -like bindings.
67
68       The  editline(7) manual documents all editor commands and contains more
69       information about macros and the input queue.
70
71       key and command can contain control characters of the form `No'^charac‐
72       ter ( e.g. `^A' ), and the following backslashed escape sequences:
73
74
75              \a     Bell
76
77              \b     Backspace
78
79              \e     Escape
80
81              \f     Formfeed
82
83              \n     Newline
84
85              \r     Carriage return
86
87              \t     Horizontal tab
88
89              \v     Vertical tab
90
91              \ Ar nnn
92                     The  ASCII  character  corresponding  to the octal number
93                     nnn.
94
95       `\' nullifies the special meaning of the following character, if it has
96       any, notably `\' and `^'.
97
98       echotc Oo Fl sv Oc arg ...
99              Exercise  terminal  capabilities  given  in  arg... .  If arg is
100              `baud', `cols', `lines', `rows', `meta', or `tabs', the value of
101              that  capability  is  printed, with ``yes'' or ``no'' indicating
102              that the terminal does or does not have that capability.
103
104              -s returns an empty string for non-existent capabilities, rather
105              than causing an error.  -v causes messages to be verbose.
106
107       edit [Li on | Li off]
108              Enable or disable the editline functionality in a program.
109
110       history list | size Dv n | unique Dv n
111              The  list  command  lists  all entries in the history.  The size
112              command sets the history size to n entries.  The unique  command
113              controls  if history should keep duplicate entries.  If n is non
114              zero, only keep unique history entries.  If n is zero, then keep
115              all entries (the default).
116
117       settc cap val
118              Set  the  terminal  capability  cap  to val, as defined in term‐
119              cap(5).  No sanity checking is done.
120
121       setty Oo Fl a Oc Oo Fl d Oc Oo Fl q Oc Oo Fl x Oc Oo +mode Oc \fP
122              Oo Ar -mode Oc Oo Ar mode Oc Oo Ar char=c Oc Control  which  tty
123              modes  that editrc won't allow the user to change.  -d, -q or -x
124              tells setty to act on the `edit', `quote' or  `execute'  set  of
125              tty modes respectively; defaulting to -x.
126
127              Without other arguments, setty lists the modes in the chosen set
128              which are fixed on ( `+mode' ) or off ( `-mode' ).  -a lists all
129              tty  modes  in  the  chosen set regardless of the setting.  With
130              +mode, -mode or mode, fixes mode on or off or removes control of
131              mode in the chosen set.
132
133              Setty  can also be used to set tty characters to particular val‐
134              ues using char=value.  If value is empty then the  character  is
135              set to _POSIX_VDISABLE .
136
137       telltc List  the  values  of  all  the terminal capabilities (see term‐
138              cap(5)) .
139

FILES

141       ~/.editrc
142              User configuration file for the editline(3) library.
143

SEE ALSO

145       editline(3), regex(3), termcap(5), editline(7)
146

AUTHORS

148       -nosplit The editline library was written by
149
150       Christos Zoulas , and this manual was written by
151
152       Luke Mewburn , with some sections inspired by tcsh(1).
153
154
155
156                                 May 22, 2016                        EDITRC(5)
Impressum