1 .\" $NetBSD: editrc.5,v 1.4 1997/04/24 20:20:31 christos Exp $
3 .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This file was contributed to The NetBSD Foundation by Luke Mewburn.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\" must display the following acknowledgement:
18 .\" This product includes software developed by the NetBSD
19 .\" Foundation, Inc. and its contributors.
20 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
21 .\" contributors may be used to endorse or promote products derived
22 .\" from this software without specific prior written permission.
24 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
25 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
28 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 .\" POSSIBILITY OF SUCH DAMAGE.
36 .\" $FreeBSD: src/lib/libedit/editrc.5,v 1.5.2.4 2001/08/17 15:42:57 ru Exp $
37 .\" $DragonFly: src/lib/libedit/editrc.5,v 1.2 2003/06/17 04:26:49 dillon Exp $
44 .Nd configuration file for editline library
50 file defines various settings to be used by the
54 The format of each line is either:
55 .Dl prog:command [arg [...]]
57 .Dl command [arg [...]]
68 is the program name string that a program defines when it calls
75 will be executed for any program which matches
82 regular expression, in which case
84 will be executed for any program that matches the regular expression.
88 library has some builtin commands, which affect the way
89 that the line editing and history functions operate.
90 These are based on similar named builtins present in the
94 The following builtin commands are available:
104 .Op Ar key Op Ar command
106 Without options, list all bound keys, and the editor command to which
110 is supplied, show the bindings for
121 Bind all keys to the standard GNU Emacs-like bindings.
123 Bind all keys to the standard
127 List or change key bindings in the
129 mode alternate (command mode) key map.
132 is interpreted as a symbolic arrow key name, which may be one of
139 List all editor commands and a short description of each.
141 Remove a key's binding.
144 is taken as a literal string and treated as terminal input when
149 are themselves reinterpreted, and this continues for ten levels of
156 can contain control characters of the form
158 .Sq No ^ Ar character
162 and the following backslashed escape sequences:
164 .Bl -tag -compact -offset indent -width 4n
184 The ASCII character corresponding to the octal number
189 nullifies the special meaning of the following character,
190 if it has any, notably
199 Exercise terminal capabilities given in
210 the value of that capability is printed, with
214 indicating that the terminal does or does not have that capability.
217 returns an empty string for non-existent capabilities, rather than
220 causes messages to be verbose.
224 List the values of all the terminal capabilities (see
226 .It Ic settc Ar cap Ar val
227 Set the terminal capability
233 No sanity checking is done.
243 Control which tty modes that
245 won't allow the user to change.
257 set of tty modes respectively; defaulting to
260 Without other arguments,
262 lists the modes in the chosen set which are fixed on
267 lists all tty modes in the chosen set regardless of the setting.
275 on or off or removes control of
287 library was written by
288 .An Christos Zoulas ,
289 and this manual was written by
291 with some sections inspired by