1 .\" $NetBSD: editrc.5,v 1.24 2009/04/11 22:17:52 wiz Exp $
3 .\" Copyright (c) 1997-2000 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.
17 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 .\" POSSIBILITY OF SUCH DAMAGE.
36 .Nd configuration file for editline library
42 file defines various settings to be used by the
46 The format of each line is:
47 .Dl [prog:]command [arg [...]]
58 is the program name string that a program defines when it calls
65 will be executed for any program which matches
72 regular expression, in which case
74 will be executed for any program that matches the regular expression.
80 is executed for all programs.
84 library has some builtin commands, which affect the way
85 that the line editing and history functions operate.
86 These are based on similar named builtins present in the
90 The following builtin commands are available:
92 .It Ic bind Oo Fl a Oc Oo Fl e Oc Oo Fl k Oc Oo Fl l Oc Oo Fl r Oc \
93 Oo Fl s Oc Oo Fl v Oc Oo Ar key Oo Ar command Oc Oc
94 Without options, list all bound keys, and the editor command to which
98 is supplied, show the bindings for
109 Bind all keys to the standard GNU Emacs-like bindings.
111 Bind all keys to the standard
115 List or change key bindings in the
117 mode alternate (command mode) key map.
120 is interpreted as a symbolic arrow key name, which may be one of
127 List all editor commands and a short description of each.
129 Remove a key's binding.
132 is taken as a literal string and treated as terminal input when
137 are themselves reinterpreted, and this continues for ten levels of
142 may be one of the commands documented in
143 .Sx "EDITOR COMMANDS"
144 below, or another key.
149 can contain control characters of the form
151 .Sq No ^ Ar character
155 and the following backslashed escape sequences:
157 .Bl -tag -compact -offset indent -width 4n
177 The ASCII character corresponding to the octal number
182 nullifies the special meaning of the following character,
183 if it has any, notably
187 .It Ic echotc Oo Fl sv Oc Ar arg Ar ...
188 Exercise terminal capabilities given in
199 the value of that capability is printed, with
203 indicating that the terminal does or does not have that capability.
206 returns an empty string for non-existent capabilities, rather than
209 causes messages to be verbose.
210 .It Ic edit Op Cm on | off
211 Enable or disable the
213 functionality in a program.
214 .It Ic history Ar list | Ar size Dv n | Ar unique Dv n
217 command lists all entries in the history.
220 command sets the history size to
225 command controls if history should keep duplicate entries.
228 is non zero, only keep unique history entries.
231 is zero, then keep all entries (the default).
233 List the values of all the terminal capabilities (see
235 .It Ic settc Ar cap Ar val
236 Set the terminal capability
242 No sanity checking is done.
243 .It Ic setty Oo Fl a Oc Oo Fl d Oc Oo Fl q Oc Oo Fl x Oc Oo Ar +mode Oc \
244 Oo Ar -mode Oc Oo Ar mode Oc Oo Ar char=c Oc
245 Control which tty modes that
247 will not allow the user to change.
259 set of tty modes respectively; defaulting to
262 Without other arguments,
264 lists the modes in the chosen set which are fixed on
269 lists all tty modes in the chosen set regardless of the setting.
277 on or off or removes control of
282 can also be used to set tty characters to particular values using
287 then the character is set to
288 .Dv _POSIX_VDISABLE .
291 The following editor commands are available for use in key bindings:
292 .\" Section automatically generated with makelist
295 Vi paste previous deletion to the right of the cursor.
297 Vi paste previous deletion to the left of the cursor.
298 .It Ic vi-prev-space-word
299 Vi move to the previous space delimited word.
301 Vi move to the previous word.
302 .It Ic vi-next-space-word
303 Vi move to the next space delimited word.
305 Vi move to the next word.
306 .It Ic vi-change-case
307 Vi change case of character under the cursor and advance one character.
308 .It Ic vi-change-meta
309 Vi change prefix command.
310 .It Ic vi-insert-at-bol
311 Vi enter insert mode at the beginning of line.
312 .It Ic vi-replace-char
313 Vi replace character under the cursor with the next character typed.
314 .It Ic vi-replace-mode
315 Vi enter replace mode.
316 .It Ic vi-substitute-char
317 Vi replace character under the cursor and enter insert mode.
318 .It Ic vi-substitute-line
319 Vi substitute entire line.
320 .It Ic vi-change-to-eol
321 Vi change to end of line.
323 Vi enter insert mode.
325 Vi enter insert mode after the cursor.
327 Vi enter insert mode at end of line.
328 .It Ic vi-delete-meta
329 Vi delete prefix command.
331 Vi move to the end of the current space delimited word.
332 .It Ic vi-to-end-word
333 Vi move to the end of the current word.
336 .It Ic vi-command-mode
337 Vi enter command mode (use alternative key bindings).
339 Vi move to the beginning of line.
340 .It Ic vi-delete-prev-char
341 Vi move to previous character (backspace).
342 .It Ic vi-list-or-eof
343 Vi list choices for completion or indicate end of file if empty line.
344 .It Ic vi-kill-line-prev
345 Vi cut from beginning of line to cursor.
346 .It Ic vi-search-prev
347 Vi search history previous.
348 .It Ic vi-search-next
349 Vi search history next.
350 .It Ic vi-repeat-search-next
351 Vi repeat current search in the same search direction.
352 .It Ic vi-repeat-search-prev
353 Vi repeat current search in the opposite search direction.
355 Vi move to the character specified next.
357 Vi move to the character specified previous.
358 .It Ic vi-to-next-char
359 Vi move up to the character specified next.
360 .It Ic vi-to-prev-char
361 Vi move up to the character specified previous.
362 .It Ic vi-repeat-next-char
363 Vi repeat current character search in the same search direction.
364 .It Ic vi-repeat-prev-char
365 Vi repeat current character search in the opposite search direction.
366 .It Ic em-delete-or-list
367 Delete character under cursor or list completions if at end of line.
368 .It Ic em-delete-next-word
369 Cut from cursor to end of current word.
371 Paste cut buffer at cursor position.
373 Cut the entire line and save in cut buffer.
374 .It Ic em-kill-region
375 Cut area between mark and cursor and save in cut buffer.
376 .It Ic em-copy-region
377 Copy area between mark and cursor to cut buffer.
378 .It Ic em-gosmacs-transpose
379 Exchange the two characters before the cursor.
381 Move next to end of current word.
383 Uppercase the characters from cursor to end of current word.
384 .It Ic em-capitol-case
385 Capitalize the characters from cursor to end of current word.
387 Lowercase the characters from cursor to end of current word.
389 Set the mark at cursor.
390 .It Ic em-exchange-mark
391 Exchange the cursor and mark.
392 .It Ic em-universal-argument
393 Universal argument (argument times 4).
395 Add 8th bit to next character typed.
396 .It Ic em-toggle-overwrite
397 Switch from insert to overwrite mode or vice versa.
398 .It Ic em-copy-prev-word
399 Copy current word to cursor.
400 .It Ic em-inc-search-next
401 Emacs incremental next search.
402 .It Ic em-inc-search-prev
403 Emacs incremental reverse search.
404 .It Ic ed-end-of-file
405 Indicate end of file.
407 Add character to the line.
408 .It Ic ed-delete-prev-word
409 Delete from beginning of current word to cursor.
410 .It Ic ed-delete-next-char
411 Delete character under cursor.
413 Cut to the end of line.
414 .It Ic ed-move-to-end
415 Move cursor to the end of line.
416 .It Ic ed-move-to-beg
417 Move cursor to the beginning of line.
418 .It Ic ed-transpose-chars
419 Exchange the character to the left of the cursor with the one under it.
421 Move to the right one character.
423 Move to the beginning of the current word.
425 Move to the left one character.
426 .It Ic ed-quoted-insert
427 Add the next character typed verbatim.
429 Adds to argument or enters a digit.
430 .It Ic ed-argument-digit
431 Digit that starts argument.
433 Indicates unbound character.
435 Tty interrupt character.
437 Tty delayed suspend character.
438 .It Ic ed-tty-flush-output
439 Tty flush output characters.
440 .It Ic ed-tty-sigquit
442 .It Ic ed-tty-sigtstp
443 Tty suspend character.
444 .It Ic ed-tty-stop-output
445 Tty disallow output characters.
446 .It Ic ed-tty-start-output
447 Tty allow output characters.
450 .It Ic ed-delete-prev-char
451 Delete the character to the left of the cursor.
452 .It Ic ed-clear-screen
453 Clear screen leaving current line at the top.
455 Redisplay everything.
457 Erase current line and start from scratch.
458 .It Ic ed-sequence-lead-in
459 First character in a bound sequence.
460 .It Ic ed-prev-history
461 Move to the previous history line.
462 .It Ic ed-next-history
463 Move to the next history line.
464 .It Ic ed-search-prev-history
465 Search previous in history for a line matching the current.
466 .It Ic ed-search-next-history
467 Search next in history for a line matching the current.
473 Editline extended command.
475 .\" End of section automatically generated with makelist
484 library was written by
485 .An Christos Zoulas ,
486 and this manual was written by
488 with some sections inspired by