1 @comment %**start of header (This is for running Texinfo on a region.)
2 @setfilename rluser.info
3 @comment %**end of header (This is for running Texinfo on a region.)
7 This file documents the end user interface to the GNU command line
8 editing features. It is to be an appendix to manuals for programs which
9 use these features. There is a document entitled "readline.texinfo"
10 which contains both end-user and programmer documentation for the GNU
13 Copyright (C) 1988, 1991, 1993, 1996 Free Software Foundation, Inc.
15 Authored by Brian Fox and Chet Ramey.
17 Permission is granted to process this file through Tex and print the
18 results, provided the printed document carries copying permission notice
19 identical to this one except for the removal of this paragraph (this
20 paragraph not being relevant to the printed manual).
22 Permission is granted to make and distribute verbatim copies of this manual
23 provided the copyright notice and this permission notice are preserved on
26 Permission is granted to copy and distribute modified versions of this
27 manual under the conditions for verbatim copying, provided also that the
28 GNU Copyright statement is available to the distributee, and provided that
29 the entire resulting derived work is distributed under the terms of a
30 permission notice identical to this one.
32 Permission is granted to copy and distribute translations of this manual
33 into another language, under the above conditions for modified versions.
36 @comment If you are including this manual as an appendix, then set the
37 @comment variable readline-appendix.
39 @node Command Line Editing
40 @chapter Command Line Editing
42 This chapter describes the basic features of the @sc{GNU}
43 command line editing interface.
46 * Introduction and Notation:: Notation used in this text.
47 * Readline Interaction:: The minimum set of commands for editing a line.
48 * Readline Init File:: Customizing Readline from a user's view.
49 * Bindable Readline Commands:: A description of most of the Readline commands
51 * Readline vi Mode:: A short description of how to make Readline
52 behave like the vi editor.
55 @node Introduction and Notation
56 @section Introduction to Line Editing
58 The following paragraphs describe the notation used to represent
61 The text @key{C-k} is read as `Control-K' and describes the character
62 produced when the @key{k} key is pressed while the Control key
65 The text @key{M-k} is read as `Meta-K' and describes the character
66 produced when the meta key (if you have one) is depressed, and the @key{k}
67 key is pressed. If you do not have a meta key, the identical keystroke
68 can be generated by typing @key{ESC} @i{first}, and then typing @key{k}.
69 Either process is known as @dfn{metafying} the @key{k} key.
71 The text @key{M-C-k} is read as `Meta-Control-k' and describes the
72 character produced by @dfn{metafying} @key{C-k}.
74 In addition, several keys have their own names. Specifically,
75 @key{DEL}, @key{ESC}, @key{LFD}, @key{SPC}, @key{RET}, and @key{TAB} all
76 stand for themselves when seen in this text, or in an init file
77 (@pxref{Readline Init File}).
79 @node Readline Interaction
80 @section Readline Interaction
81 @cindex interaction, readline
83 Often during an interactive session you type in a long line of text,
84 only to notice that the first word on the line is misspelled. The
85 Readline library gives you a set of commands for manipulating the text
86 as you type it in, allowing you to just fix your typo, and not forcing
87 you to retype the majority of the line. Using these editing commands,
88 you move the cursor to the place that needs correction, and delete or
89 insert the text of the corrections. Then, when you are satisfied with
90 the line, you simply press @key{RETURN}. You do not have to be at the
91 end of the line to press @key{RETURN}; the entire line is accepted
92 regardless of the location of the cursor within the line.
95 * Readline Bare Essentials:: The least you need to know about Readline.
96 * Readline Movement Commands:: Moving about the input line.
97 * Readline Killing Commands:: How to delete text, and how to get it back!
98 * Readline Arguments:: Giving numeric arguments to commands.
99 * Searching:: Searching through previous lines.
102 @node Readline Bare Essentials
103 @subsection Readline Bare Essentials
104 @cindex notation, readline
105 @cindex command editing
106 @cindex editing command lines
108 In order to enter characters into the line, simply type them. The typed
109 character appears where the cursor was, and then the cursor moves one
110 space to the right. If you mistype a character, you can use your
111 erase character to back up and delete the mistyped character.
113 Sometimes you may miss typing a character that you wanted to type, and
114 not notice your error until you have typed several other characters. In
115 that case, you can type @key{C-b} to move the cursor to the left, and then
116 correct your mistake. Afterwards, you can move the cursor to the right
119 When you add text in the middle of a line, you will notice that characters
120 to the right of the cursor are `pushed over' to make room for the text
121 that you have inserted. Likewise, when you delete text behind the cursor,
122 characters to the right of the cursor are `pulled back' to fill in the
123 blank space created by the removal of the text. A list of the basic bare
124 essentials for editing the text of an input line follows.
128 Move back one character.
130 Move forward one character.
132 Delete the character to the left of the cursor.
134 Delete the character underneath the cursor.
135 @item @w{Printing characters}
136 Insert the character into the line at the cursor.
138 Undo the last editing command. You can undo all the way back to an
142 @node Readline Movement Commands
143 @subsection Readline Movement Commands
146 The above table describes the most basic possible keystrokes that you need
147 in order to do editing of the input line. For your convenience, many
148 other commands have been added in addition to @key{C-b}, @key{C-f},
149 @key{C-d}, and @key{DEL}. Here are some commands for moving more rapidly
154 Move to the start of the line.
156 Move to the end of the line.
158 Move forward a word, where a word is composed of letters and digits.
160 Move backward a word.
162 Clear the screen, reprinting the current line at the top.
165 Notice how @key{C-f} moves forward a character, while @key{M-f} moves
166 forward a word. It is a loose convention that control keystrokes
167 operate on characters while meta keystrokes operate on words.
169 @node Readline Killing Commands
170 @subsection Readline Killing Commands
175 @dfn{Killing} text means to delete the text from the line, but to save
176 it away for later use, usually by @dfn{yanking} (re-inserting)
177 it back into the line.
178 If the description for a command says that it `kills' text, then you can
179 be sure that you can get the text back in a different (or the same)
182 When you use a kill command, the text is saved in a @dfn{kill-ring}.
183 Any number of consecutive kills save all of the killed text together, so
184 that when you yank it back, you get it all. The kill
185 ring is not line specific; the text that you killed on a previously
186 typed line is available to be yanked back later, when you are typing
190 Here is the list of commands for killing text.
194 Kill the text from the current cursor position to the end of the line.
197 Kill from the cursor to the end of the current word, or if between
198 words, to the end of the next word.
201 Kill from the cursor the start of the previous word, or if between
202 words, to the start of the previous word.
205 Kill from the cursor to the previous whitespace. This is different than
206 @key{M-DEL} because the word boundaries differ.
210 Here is how to @dfn{yank} the text back into the line. Yanking
211 means to copy the most-recently-killed text from the kill buffer.
215 Yank the most recently killed text back into the buffer at the cursor.
218 Rotate the kill-ring, and yank the new top. You can only do this if
219 the prior command is @key{C-y} or @key{M-y}.
222 @node Readline Arguments
223 @subsection Readline Arguments
225 You can pass numeric arguments to Readline commands. Sometimes the
226 argument acts as a repeat count, other times it is the @i{sign} of the
227 argument that is significant. If you pass a negative argument to a
228 command which normally acts in a forward direction, that command will
229 act in a backward direction. For example, to kill text back to the
230 start of the line, you might type @samp{M-- C-k}.
232 The general way to pass numeric arguments to a command is to type meta
233 digits before the command. If the first `digit' typed is a minus
234 sign (@key{-}), then the sign of the argument will be negative. Once
235 you have typed one meta digit to get the argument started, you can type
236 the remainder of the digits, and then the command. For example, to give
237 the @key{C-d} command an argument of 10, you could type @samp{M-1 0 C-d}.
240 @subsection Searching for Commands in the History
242 Readline provides commands for searching through the command history
244 (@pxref{Bash History Facilities})
246 for lines containing a specified string.
247 There are two search modes: @var{incremental} and @var{non-incremental}.
249 Incremental searches begin before the user has finished typing the
251 As each character of the search string is typed, Readline displays
252 the next entry from the history matching the string typed so far.
253 An incremental search requires only as many characters as needed to
254 find the desired history entry.
255 The @key{ESC} character is used to terminate an incremental search.
256 @key{C-j} will also terminate the search.
257 @key{C-g} will abort an incremental search and restore the original line.
258 When the search is terminated, the history entry containing the
259 search string becomes the current line.
260 To find other matching entries in the history list, type @key{C-s} or
261 @key{C-r} as appropriate.
262 This will search backward or forward in the history for the next
263 entry matching the search string typed so far.
264 Any other key sequence bound to a Readline command will terminate
265 the search and execute that command.
266 For instance, a @key{RET} will terminate the search and accept
267 the line, thereby executing the command from the history list.
269 Non-incremental searches read the entire search string before starting
270 to search for matching history lines. The search string may be
271 typed by the user or be part of the contents of the current line.
273 @node Readline Init File
274 @section Readline Init File
275 @cindex initialization file, readline
277 Although the Readline library comes with a set of @code{emacs}-like
278 keybindings installed by default, it is possible to use a different set
280 Any user can customize programs that use Readline by putting
281 commands in an @dfn{inputrc} file in his home directory.
284 file is taken from the value of the shell variable @code{INPUTRC}. If
286 @ifclear BashFeatures
287 file is taken from the value of the environment variable @code{INPUTRC}. If
289 that variable is unset, the default is @file{~/.inputrc}.
291 When a program which uses the Readline library starts up, the
292 init file is read, and the key bindings are set.
294 In addition, the @code{C-x C-r} command re-reads this init file, thus
295 incorporating any changes that you might have made to it.
298 * Readline Init File Syntax:: Syntax for the commands in the inputrc file.
300 * Conditional Init Constructs:: Conditional key bindings in the inputrc file.
302 * Sample Init File:: An example inputrc file.
305 @node Readline Init File Syntax
306 @subsection Readline Init File Syntax
308 There are only a few basic constructs allowed in the
309 Readline init file. Blank lines are ignored.
310 Lines beginning with a @samp{#} are comments.
311 Lines beginning with a @samp{$} indicate conditional
312 constructs (@pxref{Conditional Init Constructs}). Other lines
313 denote variable settings and key bindings.
316 @item Variable Settings
317 You can modify the run-time behavior of Readline by
318 altering the values of variables in Readline
319 using the @code{set} command within the init file. Here is how to
320 change from the default Emacs-like key binding to use
321 @code{vi} line editing commands:
327 A great deal of run-time behavior is changeable with the following
334 Controls what happens when Readline wants to ring the terminal bell.
335 If set to @samp{none}, Readline never rings the bell. If set to
336 @samp{visible}, Readline uses a visible bell if one is available.
337 If set to @samp{audible} (the default), Readline attempts to ring
341 @vindex comment-begin
342 The string to insert at the beginning of the line when the
343 @code{insert-comment} command is executed. The default value
346 @item completion-ignore-case
347 If set to @samp{on}, Readline performs filename matching and completion
348 in a case-insensitive fashion.
349 The default value is @samp{off}.
351 @item completion-query-items
352 @vindex completion-query-items
353 The number of possible completions that determines when the user is
354 asked whether he wants to see the list of possibilities. If the
355 number of possible completions is greater than this value,
356 Readline will ask the user whether or not he wishes to view
357 them; otherwise, they are simply listed. The default limit is
362 If set to @samp{on}, Readline will convert characters with the
363 eighth bit set to an ASCII key sequence by stripping the eighth
364 bit and prepending an @key{ESC} character, converting them to a
365 meta-prefixed key sequence. The default value is @samp{on}.
367 @item disable-completion
368 @vindex disable-completion
369 If set to @samp{On}, Readline will inhibit word completion.
370 Completion characters will be inserted into the line as if they had
371 been mapped to @code{self-insert}. The default is @samp{off}.
375 The @code{editing-mode} variable controls which default set of
376 key bindings is used. By default, Readline starts up in Emacs editing
377 mode, where the keystrokes are most similar to Emacs. This variable can be
378 set to either @samp{emacs} or @samp{vi}.
381 @vindex enable-keypad
382 When set to @samp{on}, Readline will try to enable the application
383 keypad when it is called. Some systems need this to enable the
384 arrow keys. The default is @samp{off}.
388 If set to @samp{on}, tilde expansion is performed when Readline
389 attempts word completion. The default is @samp{off}.
391 @item horizontal-scroll-mode
392 @vindex horizontal-scroll-mode
393 This variable can be set to either @samp{on} or @samp{off}. Setting it
394 to @samp{on} means that the text of the lines being edited will scroll
395 horizontally on a single screen line when they are longer than the width
396 of the screen, instead of wrapping onto a new screen line. By default,
397 this variable is set to @samp{off}.
401 Sets Readline's idea of the current keymap for key binding commands.
402 Acceptable @code{keymap} names are
404 @code{emacs-standard},
408 @code{vi-command}, and
410 @code{vi} is equivalent to @code{vi-command}; @code{emacs} is
411 equivalent to @code{emacs-standard}. The default value is @code{emacs}.
412 The value of the @code{editing-mode} variable also affects the
415 @item mark-directories
416 If set to @samp{on}, completed directory names have a slash
417 appended. The default is @samp{on}.
419 @item mark-modified-lines
420 @vindex mark-modified-lines
421 This variable, when set to @samp{on}, causes Readline to display an
422 asterisk (@samp{*}) at the start of history lines which have been modified.
423 This variable is @samp{off} by default.
428 If set to @samp{on}, Readline will enable eight-bit input (it
429 will not strip the eighth bit from the characters it reads),
430 regardless of what the terminal claims it can support. The
431 default value is @samp{off}. The name @code{meta-flag} is a
432 synonym for this variable.
436 If set to @samp{on}, Readline will display characters with the
437 eighth bit set directly rather than as a meta-prefixed escape
438 sequence. The default is @samp{off}.
440 @item print-completions-horizontally
441 If set to @samp{on}, Readline will display completions with matches
442 sorted horizontally in alphabetical order, rather than down the screen.
443 The default is @samp{off}.
445 @item show-all-if-ambiguous
446 @vindex show-all-if-ambiguous
447 This alters the default behavior of the completion functions. If
449 words which have more than one possible completion cause the
450 matches to be listed immediately instead of ringing the bell.
451 The default value is @samp{off}.
454 @vindex visible-stats
455 If set to @samp{on}, a character denoting a file's type
456 is appended to the filename when listing possible
457 completions. The default is @samp{off}.
462 The syntax for controlling key bindings in the init file is
463 simple. First you have to know the name of the command that you
464 want to change. The following sections contain tables of the command
465 name, the default keybinding, if any, and a short description of what
468 Once you know the name of the command, simply place the name of the key
469 you wish to bind the command to, a colon, and then the name of the
470 command on a line in the init file. The name of the key
471 can be expressed in different ways, depending on which is most
475 @item @w{@var{keyname}: @var{function-name} or @var{macro}}
476 @var{keyname} is the name of a key spelled out in English. For example:
478 Control-u: universal-argument
479 Meta-Rubout: backward-kill-word
480 Control-o: "> output"
483 In the above example, @key{C-u} is bound to the function
484 @code{universal-argument}, and @key{C-o} is bound to run the macro
485 expressed on the right hand side (that is, to insert the text
486 @samp{> output} into the line).
488 @item @w{"@var{keyseq}": @var{function-name} or @var{macro}}
489 @var{keyseq} differs from @var{keyname} above in that strings
490 denoting an entire key sequence can be specified, by placing
491 the key sequence in double quotes. Some GNU Emacs style key
492 escapes can be used, as in the following example, but the
493 special character names are not recognized.
496 "\C-u": universal-argument
497 "\C-x\C-r": re-read-init-file
498 "\e[11~": "Function Key 1"
501 In the above example, @key{C-u} is bound to the function
502 @code{universal-argument} (just as it was in the first example),
503 @samp{@key{C-x} @key{C-r}} is bound to the function @code{re-read-init-file},
504 and @samp{@key{ESC} @key{[} @key{1} @key{1} @key{~}} is bound to insert
505 the text @samp{Function Key 1}.
509 The following GNU Emacs style escape sequences are available when
510 specifying key sequences:
527 In addition to the GNU Emacs style escape sequences, a second
528 set of backslash escapes is available:
548 the character whose ASCII code is the octal value @var{nnn}
549 (one to three digits)
551 the character whose ASCII code is the hexadecimal value @var{nnn}
552 (one to three digits)
555 When entering the text of a macro, single or double quotes must
556 be used to indicate a macro definition.
557 Unquoted text is assumed to be a function name.
558 In the macro body, the backslash escapes described above are expanded.
559 Backslash will quote any other character in the macro text,
560 including @samp{"} and @samp{'}.
561 For example, the following binding will make @samp{C-x \}
562 insert a single @samp{\} into the line:
569 @node Conditional Init Constructs
570 @subsection Conditional Init Constructs
572 Readline implements a facility similar in spirit to the conditional
573 compilation features of the C preprocessor which allows key
574 bindings and variable settings to be performed as the result
575 of tests. There are four parser directives used.
579 The @code{$if} construct allows bindings to be made based on the
580 editing mode, the terminal being used, or the application using
581 Readline. The text of the test extends to the end of the line;
582 no characters are required to isolate it.
586 The @code{mode=} form of the @code{$if} directive is used to test
587 whether Readline is in @code{emacs} or @code{vi} mode.
588 This may be used in conjunction
589 with the @samp{set keymap} command, for instance, to set bindings in
590 the @code{emacs-standard} and @code{emacs-ctlx} keymaps only if
591 Readline is starting out in @code{emacs} mode.
594 The @code{term=} form may be used to include terminal-specific
595 key bindings, perhaps to bind the key sequences output by the
596 terminal's function keys. The word on the right side of the
597 @samp{=} is tested against both the full name of the terminal and
598 the portion of the terminal name before the first @samp{-}. This
599 allows @code{sun} to match both @code{sun} and @code{sun-cmd},
603 The @var{application} construct is used to include
604 application-specific settings. Each program using the Readline
605 library sets the @var{application name}, and you can test for it.
606 This could be used to bind key sequences to functions useful for
607 a specific program. For instance, the following command adds a
608 key sequence that quotes the current or previous word in Bash:
611 # Quote the current or previous word
612 "\C-xq": "\eb\"\ef\""
618 This command, as seen in the previous example, terminates an
622 Commands in this branch of the @code{$if} directive are executed if
626 This directive takes a single filename as an argument and reads commands
627 and bindings from that file.
629 $include /etc/inputrc
633 @node Sample Init File
634 @subsection Sample Init File
636 Here is an example of an inputrc file. This illustrates key
637 binding, variable assignment, and conditional syntax.
641 # This file controls the behaviour of line input editing for
642 # programs that use the Gnu Readline library. Existing programs
643 # include FTP, Bash, and Gdb.
645 # You can re-read the inputrc file with C-x C-r.
646 # Lines beginning with '#' are comments.
648 # First, include any systemwide bindings and variable assignments from
650 $include /etc/Inputrc
653 # Set various bindings for emacs mode.
655 set editing-mode emacs
659 Meta-Control-h: backward-kill-word Text after the function name is ignored
662 # Arrow keys in keypad mode
664 #"\M-OD": backward-char
665 #"\M-OC": forward-char
666 #"\M-OA": previous-history
667 #"\M-OB": next-history
669 # Arrow keys in ANSI mode
671 "\M-[D": backward-char
672 "\M-[C": forward-char
673 "\M-[A": previous-history
674 "\M-[B": next-history
676 # Arrow keys in 8 bit keypad mode
678 #"\M-\C-OD": backward-char
679 #"\M-\C-OC": forward-char
680 #"\M-\C-OA": previous-history
681 #"\M-\C-OB": next-history
683 # Arrow keys in 8 bit ANSI mode
685 #"\M-\C-[D": backward-char
686 #"\M-\C-[C": forward-char
687 #"\M-\C-[A": previous-history
688 #"\M-\C-[B": next-history
694 # An old-style binding. This happens to be the default.
697 # Macros that are convenient for shell interaction
700 "\C-xp": "PATH=$@{PATH@}\e\C-e\C-a\ef\C-f"
701 # prepare to type a quoted word -- insert open and close double quotes
702 # and move to just after the open quote
704 # insert a backslash (testing backslash escapes in sequences and macros)
706 # Quote the current or previous word
707 "\C-xq": "\eb\"\ef\""
708 # Add a binding to refresh the line, which is unbound
709 "\C-xr": redraw-current-line
710 # Edit variable on current line.
711 "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
714 # use a visible bell if one is available
715 set bell-style visible
717 # don't strip characters to 7 bits when reading
720 # allow iso-latin1 characters to be inserted rather than converted to
721 # prefix-meta sequences
724 # display characters with the eighth bit set directly rather than
725 # as meta-prefixed characters
728 # if there are more than 150 possible completions for a word, ask the
729 # user if he wants to see all of them
730 set completion-query-items 150
736 "\M-.": yank-last-arg
740 @node Bindable Readline Commands
741 @section Bindable Readline Commands
744 * Commands For Moving:: Moving about the line.
745 * Commands For History:: Getting at previous lines.
746 * Commands For Text:: Commands for changing text.
747 * Commands For Killing:: Commands for killing and yanking.
748 * Numeric Arguments:: Specifying numeric arguments, repeat counts.
749 * Commands For Completion:: Getting Readline to do the typing for you.
750 * Keyboard Macros:: Saving and re-executing typed characters
751 * Miscellaneous Commands:: Other miscellaneous commands.
754 This section describes Readline commands that may be bound to key
757 @node Commands For Moving
758 @subsection Commands For Moving
760 @item beginning-of-line (C-a)
761 Move to the start of the current line.
763 @item end-of-line (C-e)
764 Move to the end of the line.
766 @item forward-char (C-f)
767 Move forward a character.
769 @item backward-char (C-b)
770 Move back a character.
772 @item forward-word (M-f)
773 Move forward to the end of the next word. Words are composed of
776 @item backward-word (M-b)
777 Move back to the start of this, or the previous, word. Words are
778 composed of letters and digits.
780 @item clear-screen (C-l)
781 Clear the screen and redraw the current line,
782 leaving the current line at the top of the screen.
784 @item redraw-current-line ()
785 Refresh the current line. By default, this is unbound.
789 @node Commands For History
790 @subsection Commands For Manipulating The History
793 @item accept-line (Newline, Return)
795 Accept the line regardless of where the cursor is. If this line is
796 non-empty, add it to the history list according to the setting of
797 the @code{HISTCONTROL} and @code{HISTIGNORE} variables.
798 If this line was a history line, then restore the history line to its
801 @ifclear BashFeatures
802 Accept the line regardless of where the cursor is. If this line is
803 non-empty, add it to the history list. If this line was a history
804 line, then restore the history line to its original state.
807 @item previous-history (C-p)
808 Move `up' through the history list.
810 @item next-history (C-n)
811 Move `down' through the history list.
813 @item beginning-of-history (M-<)
814 Move to the first line in the history.
816 @item end-of-history (M->)
817 Move to the end of the input history, i.e., the line currently
820 @item reverse-search-history (C-r)
821 Search backward starting at the current line and moving `up' through
822 the history as necessary. This is an incremental search.
824 @item forward-search-history (C-s)
825 Search forward starting at the current line and moving `down' through
826 the the history as necessary. This is an incremental search.
828 @item non-incremental-reverse-search-history (M-p)
829 Search backward starting at the current line and moving `up'
830 through the history as necessary using a non-incremental search
831 for a string supplied by the user.
833 @item non-incremental-forward-search-history (M-n)
834 Search forward starting at the current line and moving `down'
835 through the the history as necessary using a non-incremental search
836 for a string supplied by the user.
838 @item history-search-forward ()
839 Search forward through the history for the string of characters
840 between the start of the current line and the current cursor
841 position (the @var{point}). This is a non-incremental search. By
842 default, this command is unbound.
844 @item history-search-backward ()
845 Search backward through the history for the string of characters
846 between the start of the current line and the point. This
847 is a non-incremental search. By default, this command is unbound.
849 @item yank-nth-arg (M-C-y)
850 Insert the first argument to the previous command (usually
851 the second word on the previous line). With an argument @var{n},
852 insert the @var{n}th word from the previous command (the words
853 in the previous command begin with word 0). A negative argument
854 inserts the @var{n}th word from the end of the previous command.
856 @item yank-last-arg (M-., M-_)
857 Insert last argument to the previous command (the last word of the
858 previous history entry). With an
859 argument, behave exactly like @code{yank-nth-arg}.
860 Successive calls to @code{yank-last-arg} move back through the history
861 list, inserting the last argument of each line in turn.
865 @node Commands For Text
866 @subsection Commands For Changing Text
869 @item delete-char (C-d)
870 Delete the character under the cursor. If the cursor is at the
871 beginning of the line, there are no characters in the line, and
872 the last character typed was not bound to @code{delete-char}, then
875 @item backward-delete-char (Rubout)
876 Delete the character behind the cursor. A numeric argument means
877 to kill the characters instead of deleting them.
879 @item quoted-insert (C-q, C-v)
880 Add the next character typed to the line verbatim. This is
881 how to insert key sequences like @key{C-q}, for example.
883 @ifclear BashFeatures
884 @item tab-insert (M-TAB)
885 Insert a tab character.
888 @item self-insert (a, b, A, 1, !, ...)
891 @item transpose-chars (C-t)
892 Drag the character before the cursor forward over
893 the character at the cursor, moving the
894 cursor forward as well. If the insertion point
895 is at the end of the line, then this
896 transposes the last two characters of the line.
897 Negative arguments don't work.
899 @item transpose-words (M-t)
900 Drag the word behind the cursor past the word in front of the cursor
901 moving the cursor over that word as well.
903 @item upcase-word (M-u)
904 Uppercase the current (or following) word. With a negative argument,
905 uppercase the previous word, but do not move the cursor.
907 @item downcase-word (M-l)
908 Lowercase the current (or following) word. With a negative argument,
909 lowercase the previous word, but do not move the cursor.
911 @item capitalize-word (M-c)
912 Capitalize the current (or following) word. With a negative argument,
913 capitalize the previous word, but do not move the cursor.
917 @node Commands For Killing
918 @subsection Killing And Yanking
922 @item kill-line (C-k)
923 Kill the text from the current cursor position to the end of the line.
925 @item backward-kill-line (C-x Rubout)
926 Kill backward to the beginning of the line.
928 @item unix-line-discard (C-u)
929 Kill backward from the cursor to the beginning of the current line.
930 The killed text is saved on the kill-ring.
932 @item kill-whole-line ()
933 Kill all characters on the current line, no matter where the
934 cursor is. By default, this is unbound.
936 @item kill-word (M-d)
937 Kill from the cursor to the end of the current word, or if between
938 words, to the end of the next word. Word boundaries are the same
939 as @code{forward-word}.
941 @item backward-kill-word (M-DEL)
942 Kill the word behind the cursor. Word boundaries are the same
943 as @code{backward-word}.
945 @item unix-word-rubout (C-w)
946 Kill the word behind the cursor, using white space as a word
947 boundary. The killed text is saved on the kill-ring.
949 @item delete-horizontal-space ()
950 Delete all spaces and tabs around point. By default, this is unbound.
953 Kill the text between the point and the @emph{mark} (saved
954 cursor position). This text is referred to as the @var{region}.
955 By default, this command is unbound.
957 @item copy-region-as-kill ()
958 Copy the text in the region to the kill buffer, so it can be yanked
959 right away. By default, this command is unbound.
961 @item copy-backward-word ()
962 Copy the word before point to the kill buffer.
963 The word boundaries are the same as @code{backward-word}.
964 By default, this command is unbound.
966 @item copy-forward-word ()
967 Copy the word following point to the kill buffer.
968 The word boundaries are the same as @code{forward-word}.
969 By default, this command is unbound.
972 Yank the top of the kill ring into the buffer at the current
976 Rotate the kill-ring, and yank the new top. You can only do this if
977 the prior command is yank or yank-pop.
980 @node Numeric Arguments
981 @subsection Specifying Numeric Arguments
984 @item digit-argument (M-0, M-1, ... M--)
985 Add this digit to the argument already accumulating, or start a new
986 argument. @key{M--} starts a negative argument.
988 @item universal-argument ()
989 This is another way to specify an argument.
990 If this command is followed by one or more digits, optionally with a
991 leading minus sign, those digits define the argument.
992 If the command is followed by digits, executing @code{universal-argument}
993 again ends the numeric argument, but is otherwise ignored.
994 As a special case, if this command is immediately followed by a
995 character that is neither a digit or minus sign, the argument count
996 for the next command is multiplied by four.
997 The argument count is initially one, so executing this function the
998 first time makes the argument count four, a second time makes the
999 argument count sixteen, and so on.
1000 By default, this is not bound to a key.
1003 @node Commands For Completion
1004 @subsection Letting Readline Type For You
1007 @item complete (TAB)
1008 Attempt to do completion on the text before the cursor. This is
1009 application-specific. Generally, if you are typing a filename
1010 argument, you can do filename completion; if you are typing a command,
1011 you can do command completion; if you are typing in a symbol to GDB, you
1012 can do symbol name completion; if you are typing in a variable to Bash,
1013 you can do variable name completion, and so on.
1015 Bash attempts completion treating the text as a variable (if the
1016 text begins with @samp{$}), username (if the text begins with
1017 @samp{~}), hostname (if the text begins with @samp{@@}), or
1018 command (including aliases and functions) in turn. If none
1019 of these produces a match, filename completion is attempted.
1022 @item possible-completions (M-?)
1023 List the possible completions of the text before the cursor.
1025 @item insert-completions (M-*)
1026 Insert all completions of the text before point that would have
1027 been generated by @code{possible-completions}.
1029 @item menu-complete ()
1030 Similar to @code{complete}, but replaces the word to be completed
1031 with a single match from the list of possible completions.
1032 Repeated execution of @code{menu-complete} steps through the list
1033 of possible completions, inserting each match in turn.
1034 At the end of the list of completions, the bell is rung and the
1035 original text is restored.
1036 An argument of @var{n} moves @var{n} positions forward in the list
1037 of matches; a negative argument may be used to move backward
1039 This command is intended to be bound to @code{TAB}, but is unbound
1043 @item complete-filename (M-/)
1044 Attempt filename completion on the text before point.
1046 @item possible-filename-completions (C-x /)
1047 List the possible completions of the text before point,
1048 treating it as a filename.
1050 @item complete-username (M-~)
1051 Attempt completion on the text before point, treating
1054 @item possible-username-completions (C-x ~)
1055 List the possible completions of the text before point,
1056 treating it as a username.
1058 @item complete-variable (M-$)
1059 Attempt completion on the text before point, treating
1060 it as a shell variable.
1062 @item possible-variable-completions (C-x $)
1063 List the possible completions of the text before point,
1064 treating it as a shell variable.
1066 @item complete-hostname (M-@@)
1067 Attempt completion on the text before point, treating
1070 @item possible-hostname-completions (C-x @@)
1071 List the possible completions of the text before point,
1072 treating it as a hostname.
1074 @item complete-command (M-!)
1075 Attempt completion on the text before point, treating
1076 it as a command name. Command completion attempts to
1077 match the text against aliases, reserved words, shell
1078 functions, shell builtins, and finally executable filenames,
1081 @item possible-command-completions (C-x !)
1082 List the possible completions of the text before point,
1083 treating it as a command name.
1085 @item dynamic-complete-history (M-TAB)
1086 Attempt completion on the text before point, comparing
1087 the text against lines from the history list for possible
1090 @item complete-into-braces (M-@{)
1091 Perform filename completion and return the list of possible completions
1092 enclosed within braces so the list is available to the shell
1093 (@pxref{Brace Expansion}).
1098 @node Keyboard Macros
1099 @subsection Keyboard Macros
1102 @item start-kbd-macro (C-x ()
1103 Begin saving the characters typed into the current keyboard macro.
1105 @item end-kbd-macro (C-x ))
1106 Stop saving the characters typed into the current keyboard macro
1107 and save the definition.
1109 @item call-last-kbd-macro (C-x e)
1110 Re-execute the last keyboard macro defined, by making the characters
1111 in the macro appear as if typed at the keyboard.
1115 @node Miscellaneous Commands
1116 @subsection Some Miscellaneous Commands
1119 @item re-read-init-file (C-x C-r)
1120 Read in the contents of the inputrc file, and incorporate
1121 any bindings or variable assignments found there.
1124 Abort the current editing command and
1125 ring the terminal's bell (subject to the setting of
1128 @item do-uppercase-version (M-a, M-b, M-@var{x}, @dots{})
1129 If the metafied character @var{x} is lowercase, run the command
1130 that is bound to the corresponding uppercase character.
1132 @item prefix-meta (ESC)
1133 Make the next character typed be metafied. This is for keyboards
1134 without a meta key. Typing @samp{ESC f} is equivalent to typing
1137 @item undo (C-_, C-x C-u)
1138 Incremental undo, separately remembered for each line.
1140 @item revert-line (M-r)
1141 Undo all changes made to this line. This is like executing the @code{undo}
1142 command enough times to get back to the beginning.
1144 @item tilde-expand (M-~)
1145 Perform tilde expansion on the current word.
1147 @item set-mark (C-@@)
1148 Set the mark to the current point. If a
1149 numeric argument is supplied, the mark is set to that position.
1151 @item exchange-point-and-mark (C-x C-x)
1152 Swap the point with the mark. The current cursor position is set to
1153 the saved position, and the old cursor position is saved as the mark.
1155 @item character-search (C-])
1156 A character is read and point is moved to the next occurrence of that
1157 character. A negative count searches for previous occurrences.
1159 @item character-search-backward (M-C-])
1160 A character is read and point is moved to the previous occurrence
1161 of that character. A negative count searches for subsequent
1164 @item insert-comment (M-#)
1165 The value of the @code{comment-begin}
1166 variable is inserted at the beginning of the current line,
1167 and the line is accepted as if a newline had been typed.
1169 This makes the current line a shell comment.
1172 @item dump-functions ()
1173 Print all of the functions and their key bindings to the
1174 Readline output stream. If a numeric argument is supplied,
1175 the output is formatted in such a way that it can be made part
1176 of an @var{inputrc} file. This command is unbound by default.
1178 @item dump-variables ()
1179 Print all of the settable variables and their values to the
1180 Readline output stream. If a numeric argument is supplied,
1181 the output is formatted in such a way that it can be made part
1182 of an @var{inputrc} file. This command is unbound by default.
1184 @item dump-macros ()
1185 Print all of the Readline key sequences bound to macros and the
1186 strings they ouput. If a numeric argument is supplied,
1187 the output is formatted in such a way that it can be made part
1188 of an @var{inputrc} file. This command is unbound by default.
1191 @item glob-expand-word (C-x *)
1192 The word before point is treated as a pattern for pathname expansion,
1193 and the list of matching file names is inserted, replacing the word.
1195 @item glob-list-expansions (C-x g)
1196 The list of expansions that would have been generated by
1197 @code{glob-expand-word} is displayed, and the line is redrawn.
1199 @item display-shell-version (C-x C-v)
1200 Display version information about the current instance of Bash.
1202 @item shell-expand-line (M-C-e)
1203 Expand the line as the shell does.
1204 This performs alias and history expansion as well as all of the shell
1205 word expansions (@pxref{Shell Expansions}).
1207 @item history-expand-line (M-^)
1208 Perform history expansion on the current line.
1210 @item magic-space ()
1211 Perform history expansion on the current line and insert a space
1212 (@pxref{History Interaction}).
1214 @item alias-expand-line ()
1215 Perform alias expansion on the current line (@pxref{Aliases}).
1217 @item history-and-alias-expand-line ()
1218 Perform history and alias expansion on the current line.
1220 @item insert-last-argument (M-., M-_)
1221 A synonym for @code{yank-last-arg}.
1223 @item operate-and-get-next (C-o)
1224 Accept the current line for execution and fetch the next line
1225 relative to the current line from the history for editing. Any
1226 argument is ignored.
1228 @item emacs-editing-mode (C-e)
1229 When in @code{vi} editing mode, this causes a switch back to
1230 @code{emacs} editing mode, as if the command @samp{set -o emacs} had
1237 @node Readline vi Mode
1238 @section Readline vi Mode
1240 While the Readline library does not have a full set of @code{vi}
1241 editing functions, it does contain enough to allow simple editing
1242 of the line. The Readline @code{vi} mode behaves as specified in
1243 the @sc{POSIX} 1003.2 standard.
1246 In order to switch interactively between @code{emacs} and @code{vi}
1247 editing modes, use the @samp{set -o emacs} and @samp{set -o vi}
1248 commands (@pxref{The Set Builtin}).
1250 @ifclear BashFeatures
1251 In order to switch interactively between @code{emacs} and @code{vi}
1252 editing modes, use the command M-C-j (toggle-editing-mode).
1254 The Readline default is @code{emacs} mode.
1256 When you enter a line in @code{vi} mode, you are already placed in
1257 `insertion' mode, as if you had typed an @samp{i}. Pressing @key{ESC}
1258 switches you into `command' mode, where you can edit the text of the
1259 line with the standard @code{vi} movement keys, move to previous
1260 history lines with @samp{k} and subsequent lines with @samp{j}, and