jpayne@68
|
1 .TH EDITRC 5 "May 22, 2016" ""
|
jpayne@68
|
2 .SH NAME
|
jpayne@68
|
3 \fBeditrc\fP
|
jpayne@68
|
4 \- configuration file for editline library
|
jpayne@68
|
5 .SH SYNOPSIS
|
jpayne@68
|
6 .br
|
jpayne@68
|
7 \fBeditrc\fP
|
jpayne@68
|
8 .SH DESCRIPTION
|
jpayne@68
|
9 The
|
jpayne@68
|
10 \fBeditrc\fP
|
jpayne@68
|
11 file defines various settings to be used by the
|
jpayne@68
|
12 \fBeditline\fP(3)
|
jpayne@68
|
13 library.
|
jpayne@68
|
14
|
jpayne@68
|
15 The format of each line is:
|
jpayne@68
|
16 is one of the
|
jpayne@68
|
17 builtin commands.
|
jpayne@68
|
18 Refer to
|
jpayne@68
|
19 for more information.
|
jpayne@68
|
20 is the program name string that a program defines when it calls
|
jpayne@68
|
21 to set up
|
jpayne@68
|
22 which is usually
|
jpayne@68
|
23 will be executed for any program which matches
|
jpayne@68
|
24 may also be a
|
jpayne@68
|
25 style
|
jpayne@68
|
26 regular expression, in which case
|
jpayne@68
|
27 will be executed for any program that matches the regular expression.
|
jpayne@68
|
28
|
jpayne@68
|
29 If
|
jpayne@68
|
30 is absent,
|
jpayne@68
|
31 is executed for all programs.
|
jpayne@68
|
32 The
|
jpayne@68
|
33 library has some builtin commands, which affect the way
|
jpayne@68
|
34 that the line editing and history functions operate.
|
jpayne@68
|
35 These are based on similar named builtins present in the
|
jpayne@68
|
36 shell.
|
jpayne@68
|
37
|
jpayne@68
|
38 The following builtin commands are available:
|
jpayne@68
|
39 Without options and arguments, list all bound keys and macros, and
|
jpayne@68
|
40 the editor command or input string to which each one is bound.
|
jpayne@68
|
41 If only
|
jpayne@68
|
42 is supplied, show the binding for that key or macro.
|
jpayne@68
|
43 If
|
jpayne@68
|
44 is supplied, bind the editor
|
jpayne@68
|
45 to that key or macro.
|
jpayne@68
|
46
|
jpayne@68
|
47 The options are as follows:
|
jpayne@68
|
48 List or change key bindings in the
|
jpayne@68
|
49 mode alternate (command mode) key map.
|
jpayne@68
|
50 Bind all keys to the standard
|
jpayne@68
|
51 Emacs-like bindings.
|
jpayne@68
|
52 is interpreted as a symbolic arrow key name, which may be one of
|
jpayne@68
|
53 or
|
jpayne@68
|
54 List all editor commands and a short description of each.
|
jpayne@68
|
55 Remove the binding of the key or macro
|
jpayne@68
|
56 Define a keyboard macro rather than a key binding or command macro:
|
jpayne@68
|
57 is taken as a literal string and appended to the input queue whenever
|
jpayne@68
|
58 is typed.
|
jpayne@68
|
59 Bound keys and macros in
|
jpayne@68
|
60 are themselves reinterpreted, and this continues for ten levels of
|
jpayne@68
|
61 interpretation.
|
jpayne@68
|
62 Bind all keys to the standard
|
jpayne@68
|
63 bindings.
|
jpayne@68
|
64
|
jpayne@68
|
65 The
|
jpayne@68
|
66 manual documents all editor commands and contains more information
|
jpayne@68
|
67 about macros and the input queue.
|
jpayne@68
|
68 and
|
jpayne@68
|
69 can contain control characters of the form
|
jpayne@68
|
70 e.g.\&
|
jpayne@68
|
71 and the following backslashed escape sequences:
|
jpayne@68
|
72 Bell
|
jpayne@68
|
73 Backspace
|
jpayne@68
|
74 Escape
|
jpayne@68
|
75 Formfeed
|
jpayne@68
|
76 Newline
|
jpayne@68
|
77 Carriage return
|
jpayne@68
|
78 Horizontal tab
|
jpayne@68
|
79 Vertical tab
|
jpayne@68
|
80 The
|
jpayne@68
|
81 character corresponding to the octal number
|
jpayne@68
|
82 nullifies the special meaning of the following character,
|
jpayne@68
|
83 if it has any, notably
|
jpayne@68
|
84 and
|
jpayne@68
|
85 Exercise terminal capabilities given in
|
jpayne@68
|
86 If
|
jpayne@68
|
87 is
|
jpayne@68
|
88 or
|
jpayne@68
|
89 the value of that capability is printed, with
|
jpayne@68
|
90 or
|
jpayne@68
|
91 indicating that the terminal does or does not have that capability.
|
jpayne@68
|
92 returns an empty string for non-existent capabilities, rather than
|
jpayne@68
|
93 causing an error.
|
jpayne@68
|
94 causes messages to be verbose.
|
jpayne@68
|
95 Enable or disable the
|
jpayne@68
|
96 functionality in a program.
|
jpayne@68
|
97 The
|
jpayne@68
|
98 command lists all entries in the history.
|
jpayne@68
|
99 The
|
jpayne@68
|
100 command sets the history size to
|
jpayne@68
|
101 entries.
|
jpayne@68
|
102 The
|
jpayne@68
|
103 command controls if history should keep duplicate entries.
|
jpayne@68
|
104 If
|
jpayne@68
|
105 is non zero, only keep unique history entries.
|
jpayne@68
|
106 If
|
jpayne@68
|
107 is zero, then keep all entries (the default).
|
jpayne@68
|
108 Set the terminal capability
|
jpayne@68
|
109 to
|
jpayne@68
|
110 as defined in
|
jpayne@68
|
111 No sanity checking is done.
|
jpayne@68
|
112 Oo Fl Ar mode Oc Oo Ar mode Oc Oo Ar char\| Ns Ic = Ns Ar c Oc
|
jpayne@68
|
113 Control which tty modes that
|
jpayne@68
|
114 won't allow the user to change.
|
jpayne@68
|
115 or
|
jpayne@68
|
116 tells
|
jpayne@68
|
117 to act on the
|
jpayne@68
|
118 or
|
jpayne@68
|
119 set of tty modes respectively; defaulting to
|
jpayne@68
|
120
|
jpayne@68
|
121 Without other arguments,
|
jpayne@68
|
122 lists the modes in the chosen set which are fixed on
|
jpayne@68
|
123 or off
|
jpayne@68
|
124 lists all tty modes in the chosen set regardless of the setting.
|
jpayne@68
|
125 With
|
jpayne@68
|
126 or
|
jpayne@68
|
127 fixes
|
jpayne@68
|
128 on or off or removes control of
|
jpayne@68
|
129 in the chosen set.
|
jpayne@68
|
130 can also be used to set tty characters to particular values using
|
jpayne@68
|
131 If
|
jpayne@68
|
132 is empty
|
jpayne@68
|
133 then the character is set to
|
jpayne@68
|
134 List the values of all the terminal capabilities (see
|
jpayne@68
|
135 Names the default configuration file for the
|
jpayne@68
|
136 library.
|
jpayne@68
|
137 Last resort user configuration file for the
|
jpayne@68
|
138 library if no other file is specified.
|
jpayne@68
|
139 The
|
jpayne@68
|
140 library was written by
|
jpayne@68
|
141 and this manual was written by
|
jpayne@68
|
142 with some sections inspired by
|