comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man5/editrc.5 @ 68:5028fdace37b

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