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
13 Copyright (C) 1988-2005 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.
43 @node Command Line Editing
44 @chapter Command Line Editing
46 This chapter describes the basic features of the @sc{gnu}
47 command line editing interface.
49 Command line editing is provided by the Readline library, which is
50 used by several different programs, including Bash.
54 * Introduction and Notation:: Notation used in this text.
55 * Readline Interaction:: The minimum set of commands for editing a line.
56 * Readline Init File:: Customizing Readline from a user's view.
57 * Bindable Readline Commands:: A description of most of the Readline commands
59 * Readline vi Mode:: A short description of how to make Readline
60 behave like the vi editor.
62 * Programmable Completion:: How to specify the possible completions for
64 * Programmable Completion Builtins:: Builtin commands to specify how to
65 complete arguments for a particular command.
69 @node Introduction and Notation
70 @section Introduction to Line Editing
72 The following paragraphs describe the notation used to represent
75 The text @kbd{C-k} is read as `Control-K' and describes the character
76 produced when the @key{k} key is pressed while the Control key
79 The text @kbd{M-k} is read as `Meta-K' and describes the character
80 produced when the Meta key (if you have one) is depressed, and the @key{k}
82 The Meta key is labeled @key{ALT} on many keyboards.
83 On keyboards with two keys labeled @key{ALT} (usually to either side of
84 the space bar), the @key{ALT} on the left side is generally set to
86 The @key{ALT} key on the right may also be configured to work as a
87 Meta key or may be configured as some other modifier, such as a
88 Compose key for typing accented characters.
90 If you do not have a Meta or @key{ALT} key, or another key working as
91 a Meta key, the identical keystroke can be generated by typing @key{ESC}
92 @emph{first}, and then typing @key{k}.
93 Either process is known as @dfn{metafying} the @key{k} key.
95 The text @kbd{M-C-k} is read as `Meta-Control-k' and describes the
96 character produced by @dfn{metafying} @kbd{C-k}.
98 In addition, several keys have their own names. Specifically,
99 @key{DEL}, @key{ESC}, @key{LFD}, @key{SPC}, @key{RET}, and @key{TAB} all
100 stand for themselves when seen in this text, or in an init file
101 (@pxref{Readline Init File}).
102 If your keyboard lacks a @key{LFD} key, typing @key{C-j} will
103 produce the desired character.
104 The @key{RET} key may be labeled @key{Return} or @key{Enter} on
107 @node Readline Interaction
108 @section Readline Interaction
109 @cindex interaction, readline
111 Often during an interactive session you type in a long line of text,
112 only to notice that the first word on the line is misspelled. The
113 Readline library gives you a set of commands for manipulating the text
114 as you type it in, allowing you to just fix your typo, and not forcing
115 you to retype the majority of the line. Using these editing commands,
116 you move the cursor to the place that needs correction, and delete or
117 insert the text of the corrections. Then, when you are satisfied with
118 the line, you simply press @key{RET}. You do not have to be at the
119 end of the line to press @key{RET}; the entire line is accepted
120 regardless of the location of the cursor within the line.
123 * Readline Bare Essentials:: The least you need to know about Readline.
124 * Readline Movement Commands:: Moving about the input line.
125 * Readline Killing Commands:: How to delete text, and how to get it back!
126 * Readline Arguments:: Giving numeric arguments to commands.
127 * Searching:: Searching through previous lines.
130 @node Readline Bare Essentials
131 @subsection Readline Bare Essentials
132 @cindex notation, readline
133 @cindex command editing
134 @cindex editing command lines
136 In order to enter characters into the line, simply type them. The typed
137 character appears where the cursor was, and then the cursor moves one
138 space to the right. If you mistype a character, you can use your
139 erase character to back up and delete the mistyped character.
141 Sometimes you may mistype a character, and
142 not notice the error until you have typed several other characters. In
143 that case, you can type @kbd{C-b} to move the cursor to the left, and then
144 correct your mistake. Afterwards, you can move the cursor to the right
147 When you add text in the middle of a line, you will notice that characters
148 to the right of the cursor are `pushed over' to make room for the text
149 that you have inserted. Likewise, when you delete text behind the cursor,
150 characters to the right of the cursor are `pulled back' to fill in the
151 blank space created by the removal of the text. A list of the bare
152 essentials for editing the text of an input line follows.
156 Move back one character.
158 Move forward one character.
159 @item @key{DEL} or @key{Backspace}
160 Delete the character to the left of the cursor.
162 Delete the character underneath the cursor.
163 @item @w{Printing characters}
164 Insert the character into the line at the cursor.
165 @item @kbd{C-_} or @kbd{C-x C-u}
166 Undo the last editing command. You can undo all the way back to an
171 (Depending on your configuration, the @key{Backspace} key be set to
172 delete the character to the left of the cursor and the @key{DEL} key set
173 to delete the character underneath the cursor, like @kbd{C-d}, rather
174 than the character to the left of the cursor.)
176 @node Readline Movement Commands
177 @subsection Readline Movement Commands
180 The above table describes the most basic keystrokes that you need
181 in order to do editing of the input line. For your convenience, many
182 other commands have been added in addition to @kbd{C-b}, @kbd{C-f},
183 @kbd{C-d}, and @key{DEL}. Here are some commands for moving more rapidly
188 Move to the start of the line.
190 Move to the end of the line.
192 Move forward a word, where a word is composed of letters and digits.
194 Move backward a word.
196 Clear the screen, reprinting the current line at the top.
199 Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves
200 forward a word. It is a loose convention that control keystrokes
201 operate on characters while meta keystrokes operate on words.
203 @node Readline Killing Commands
204 @subsection Readline Killing Commands
209 @dfn{Killing} text means to delete the text from the line, but to save
210 it away for later use, usually by @dfn{yanking} (re-inserting)
211 it back into the line.
212 (`Cut' and `paste' are more recent jargon for `kill' and `yank'.)
214 If the description for a command says that it `kills' text, then you can
215 be sure that you can get the text back in a different (or the same)
218 When you use a kill command, the text is saved in a @dfn{kill-ring}.
219 Any number of consecutive kills save all of the killed text together, so
220 that when you yank it back, you get it all. The kill
221 ring is not line specific; the text that you killed on a previously
222 typed line is available to be yanked back later, when you are typing
226 Here is the list of commands for killing text.
230 Kill the text from the current cursor position to the end of the line.
233 Kill from the cursor to the end of the current word, or, if between
234 words, to the end of the next word.
235 Word boundaries are the same as those used by @kbd{M-f}.
238 Kill from the cursor the start of the current word, or, if between
239 words, to the start of the previous word.
240 Word boundaries are the same as those used by @kbd{M-b}.
243 Kill from the cursor to the previous whitespace. This is different than
244 @kbd{M-@key{DEL}} because the word boundaries differ.
248 Here is how to @dfn{yank} the text back into the line. Yanking
249 means to copy the most-recently-killed text from the kill buffer.
253 Yank the most recently killed text back into the buffer at the cursor.
256 Rotate the kill-ring, and yank the new top. You can only do this if
257 the prior command is @kbd{C-y} or @kbd{M-y}.
260 @node Readline Arguments
261 @subsection Readline Arguments
263 You can pass numeric arguments to Readline commands. Sometimes the
264 argument acts as a repeat count, other times it is the @i{sign} of the
265 argument that is significant. If you pass a negative argument to a
266 command which normally acts in a forward direction, that command will
267 act in a backward direction. For example, to kill text back to the
268 start of the line, you might type @samp{M-- C-k}.
270 The general way to pass numeric arguments to a command is to type meta
271 digits before the command. If the first `digit' typed is a minus
272 sign (@samp{-}), then the sign of the argument will be negative. Once
273 you have typed one meta digit to get the argument started, you can type
274 the remainder of the digits, and then the command. For example, to give
275 the @kbd{C-d} command an argument of 10, you could type @samp{M-1 0 C-d},
276 which will delete the next ten characters on the input line.
279 @subsection Searching for Commands in the History
281 Readline provides commands for searching through the command history
283 (@pxref{Bash History Facilities})
285 for lines containing a specified string.
286 There are two search modes: @dfn{incremental} and @dfn{non-incremental}.
288 Incremental searches begin before the user has finished typing the
290 As each character of the search string is typed, Readline displays
291 the next entry from the history matching the string typed so far.
292 An incremental search requires only as many characters as needed to
293 find the desired history entry.
294 To search backward in the history for a particular string, type
295 @kbd{C-r}. Typing @kbd{C-s} searches forward through the history.
296 The characters present in the value of the @code{isearch-terminators} variable
297 are used to terminate an incremental search.
298 If that variable has not been assigned a value, the @key{ESC} and
299 @kbd{C-J} characters will terminate an incremental search.
300 @kbd{C-g} will abort an incremental search and restore the original line.
301 When the search is terminated, the history entry containing the
302 search string becomes the current line.
304 To find other matching entries in the history list, type @kbd{C-r} or
305 @kbd{C-s} as appropriate.
306 This will search backward or forward in the history for the next
307 entry matching the search string typed so far.
308 Any other key sequence bound to a Readline command will terminate
309 the search and execute that command.
310 For instance, a @key{RET} will terminate the search and accept
311 the line, thereby executing the command from the history list.
312 A movement command will terminate the search, make the last line found
313 the current line, and begin editing.
315 Readline remembers the last incremental search string. If two
316 @kbd{C-r}s are typed without any intervening characters defining a new
317 search string, any remembered search string is used.
319 Non-incremental searches read the entire search string before starting
320 to search for matching history lines. The search string may be
321 typed by the user or be part of the contents of the current line.
323 @node Readline Init File
324 @section Readline Init File
325 @cindex initialization file, readline
327 Although the Readline library comes with a set of Emacs-like
328 keybindings installed by default, it is possible to use a different set
330 Any user can customize programs that use Readline by putting
331 commands in an @dfn{inputrc} file, conventionally in his home directory.
334 file is taken from the value of the shell variable @env{INPUTRC}. If
336 @ifclear BashFeatures
337 file is taken from the value of the environment variable @env{INPUTRC}. If
339 that variable is unset, the default is @file{~/.inputrc}.
341 When a program which uses the Readline library starts up, the
342 init file is read, and the key bindings are set.
344 In addition, the @code{C-x C-r} command re-reads this init file, thus
345 incorporating any changes that you might have made to it.
348 * Readline Init File Syntax:: Syntax for the commands in the inputrc file.
350 * Conditional Init Constructs:: Conditional key bindings in the inputrc file.
352 * Sample Init File:: An example inputrc file.
355 @node Readline Init File Syntax
356 @subsection Readline Init File Syntax
358 There are only a few basic constructs allowed in the
359 Readline init file. Blank lines are ignored.
360 Lines beginning with a @samp{#} are comments.
361 Lines beginning with a @samp{$} indicate conditional
362 constructs (@pxref{Conditional Init Constructs}). Other lines
363 denote variable settings and key bindings.
366 @item Variable Settings
367 You can modify the run-time behavior of Readline by
368 altering the values of variables in Readline
369 using the @code{set} command within the init file.
370 The syntax is simple:
373 set @var{variable} @var{value}
377 Here, for example, is how to
378 change from the default Emacs-like key binding to use
379 @code{vi} line editing commands:
385 Variable names and values, where appropriate, are recognized without regard
386 to case. Unrecognized variable names are ignored.
388 Boolean variables (those that can be set to on or off) are set to on if
389 the value is null or empty, @var{on} (case-insensitive), or 1. Any other
390 value results in the variable being set to off.
393 The @w{@code{bind -V}} command lists the current Readline variable names
394 and values. @xref{Bash Builtins}.
397 A great deal of run-time behavior is changeable with the following
400 @cindex variables, readline
405 Controls what happens when Readline wants to ring the terminal bell.
406 If set to @samp{none}, Readline never rings the bell. If set to
407 @samp{visible}, Readline uses a visible bell if one is available.
408 If set to @samp{audible} (the default), Readline attempts to ring
411 @item bind-tty-special-chars
412 @vindex bind-tty-special-chars
413 If set to @samp{on}, Readline attempts to bind the control characters
414 treated specially by the kernel's terminal driver to their Readline
418 @vindex comment-begin
419 The string to insert at the beginning of the line when the
420 @code{insert-comment} command is executed. The default value
423 @item completion-ignore-case
424 If set to @samp{on}, Readline performs filename matching and completion
425 in a case-insensitive fashion.
426 The default value is @samp{off}.
428 @item completion-query-items
429 @vindex completion-query-items
430 The number of possible completions that determines when the user is
431 asked whether the list of possibilities should be displayed.
432 If the number of possible completions is greater than this value,
433 Readline will ask the user whether or not he wishes to view
434 them; otherwise, they are simply listed.
435 This variable must be set to an integer value greater than or equal to 0.
436 A negative value means Readline should never ask.
437 The default limit is @code{100}.
441 If set to @samp{on}, Readline will convert characters with the
442 eighth bit set to an @sc{ascii} key sequence by stripping the eighth
443 bit and prefixing an @key{ESC} character, converting them to a
444 meta-prefixed key sequence. The default value is @samp{on}.
446 @item disable-completion
447 @vindex disable-completion
448 If set to @samp{On}, Readline will inhibit word completion.
449 Completion characters will be inserted into the line as if they had
450 been mapped to @code{self-insert}. The default is @samp{off}.
454 The @code{editing-mode} variable controls which default set of
455 key bindings is used. By default, Readline starts up in Emacs editing
456 mode, where the keystrokes are most similar to Emacs. This variable can be
457 set to either @samp{emacs} or @samp{vi}.
460 @vindex enable-keypad
461 When set to @samp{on}, Readline will try to enable the application
462 keypad when it is called. Some systems need this to enable the
463 arrow keys. The default is @samp{off}.
467 If set to @samp{on}, tilde expansion is performed when Readline
468 attempts word completion. The default is @samp{off}.
470 @item history-preserve-point
471 @vindex history-preserve-point
472 If set to @samp{on}, the history code attempts to place point at the
473 same location on each history line retrieved with @code{previous-history}
474 or @code{next-history}. The default is @samp{off}.
476 @item horizontal-scroll-mode
477 @vindex horizontal-scroll-mode
478 This variable can be set to either @samp{on} or @samp{off}. Setting it
479 to @samp{on} means that the text of the lines being edited will scroll
480 horizontally on a single screen line when they are longer than the width
481 of the screen, instead of wrapping onto a new screen line. By default,
482 this variable is set to @samp{off}.
487 If set to @samp{on}, Readline will enable eight-bit input (it
488 will not clear the eighth bit in the characters it reads),
489 regardless of what the terminal claims it can support. The
490 default value is @samp{off}. The name @code{meta-flag} is a
491 synonym for this variable.
493 @item isearch-terminators
494 @vindex isearch-terminators
495 The string of characters that should terminate an incremental search without
496 subsequently executing the character as a command (@pxref{Searching}).
497 If this variable has not been given a value, the characters @key{ESC} and
498 @kbd{C-J} will terminate an incremental search.
502 Sets Readline's idea of the current keymap for key binding commands.
503 Acceptable @code{keymap} names are
505 @code{emacs-standard},
510 @code{vi-command}, and
512 @code{vi} is equivalent to @code{vi-command}; @code{emacs} is
513 equivalent to @code{emacs-standard}. The default value is @code{emacs}.
514 The value of the @code{editing-mode} variable also affects the
517 @item mark-directories
518 If set to @samp{on}, completed directory names have a slash
519 appended. The default is @samp{on}.
521 @item mark-modified-lines
522 @vindex mark-modified-lines
523 This variable, when set to @samp{on}, causes Readline to display an
524 asterisk (@samp{*}) at the start of history lines which have been modified.
525 This variable is @samp{off} by default.
527 @item mark-symlinked-directories
528 @vindex mark-symlinked-directories
529 If set to @samp{on}, completed names which are symbolic links
530 to directories have a slash appended (subject to the value of
531 @code{mark-directories}).
532 The default is @samp{off}.
534 @item match-hidden-files
535 @vindex match-hidden-files
536 This variable, when set to @samp{on}, causes Readline to match files whose
537 names begin with a @samp{.} (hidden files) when performing filename
538 completion, unless the leading @samp{.} is
539 supplied by the user in the filename to be completed.
540 This variable is @samp{on} by default.
544 If set to @samp{on}, Readline will display characters with the
545 eighth bit set directly rather than as a meta-prefixed escape
546 sequence. The default is @samp{off}.
548 @item page-completions
549 @vindex page-completions
550 If set to @samp{on}, Readline uses an internal @code{more}-like pager
551 to display a screenful of possible completions at a time.
552 This variable is @samp{on} by default.
554 @item print-completions-horizontally
555 If set to @samp{on}, Readline will display completions with matches
556 sorted horizontally in alphabetical order, rather than down the screen.
557 The default is @samp{off}.
559 @item show-all-if-ambiguous
560 @vindex show-all-if-ambiguous
561 This alters the default behavior of the completion functions. If
563 words which have more than one possible completion cause the
564 matches to be listed immediately instead of ringing the bell.
565 The default value is @samp{off}.
567 @item show-all-if-unmodified
568 @vindex show-all-if-unmodified
569 This alters the default behavior of the completion functions in
570 a fashion similar to @var{show-all-if-ambiguous}.
572 words which have more than one possible completion without any
573 possible partial completion (the possible completions don't share
574 a common prefix) cause the matches to be listed immediately instead
576 The default value is @samp{off}.
579 @vindex visible-stats
580 If set to @samp{on}, a character denoting a file's type
581 is appended to the filename when listing possible
582 completions. The default is @samp{off}.
587 The syntax for controlling key bindings in the init file is
588 simple. First you need to find the name of the command that you
589 want to change. The following sections contain tables of the command
590 name, the default keybinding, if any, and a short description of what
593 Once you know the name of the command, simply place on a line
594 in the init file the name of the key
595 you wish to bind the command to, a colon, and then the name of the
596 command. The name of the key
597 can be expressed in different ways, depending on what you find most
600 In addition to command names, readline allows keys to be bound
601 to a string that is inserted when the key is pressed (a @var{macro}).
604 The @w{@code{bind -p}} command displays Readline function names and
605 bindings in a format that can put directly into an initialization file.
606 @xref{Bash Builtins}.
610 @item @w{@var{keyname}: @var{function-name} or @var{macro}}
611 @var{keyname} is the name of a key spelled out in English. For example:
613 Control-u: universal-argument
614 Meta-Rubout: backward-kill-word
615 Control-o: "> output"
618 In the above example, @kbd{C-u} is bound to the function
619 @code{universal-argument},
620 @kbd{M-DEL} is bound to the function @code{backward-kill-word}, and
621 @kbd{C-o} is bound to run the macro
622 expressed on the right hand side (that is, to insert the text
623 @samp{> output} into the line).
625 A number of symbolic character names are recognized while
626 processing this key binding syntax:
640 @item @w{"@var{keyseq}": @var{function-name} or @var{macro}}
641 @var{keyseq} differs from @var{keyname} above in that strings
642 denoting an entire key sequence can be specified, by placing
643 the key sequence in double quotes. Some @sc{gnu} Emacs style key
644 escapes can be used, as in the following example, but the
645 special character names are not recognized.
648 "\C-u": universal-argument
649 "\C-x\C-r": re-read-init-file
650 "\e[11~": "Function Key 1"
653 In the above example, @kbd{C-u} is again bound to the function
654 @code{universal-argument} (just as it was in the first example),
655 @samp{@kbd{C-x} @kbd{C-r}} is bound to the function @code{re-read-init-file},
656 and @samp{@key{ESC} @key{[} @key{1} @key{1} @key{~}} is bound to insert
657 the text @samp{Function Key 1}.
661 The following @sc{gnu} Emacs style escape sequences are available when
662 specifying key sequences:
674 @key{"}, a double quotation mark
676 @key{'}, a single quote or apostrophe
679 In addition to the @sc{gnu} Emacs style escape sequences, a second
680 set of backslash escapes is available:
700 the eight-bit character whose value is the octal value @var{nnn}
701 (one to three digits)
703 the eight-bit character whose value is the hexadecimal value @var{HH}
704 (one or two hex digits)
707 When entering the text of a macro, single or double quotes must
708 be used to indicate a macro definition.
709 Unquoted text is assumed to be a function name.
710 In the macro body, the backslash escapes described above are expanded.
711 Backslash will quote any other character in the macro text,
712 including @samp{"} and @samp{'}.
713 For example, the following binding will make @samp{@kbd{C-x} \}
714 insert a single @samp{\} into the line:
721 @node Conditional Init Constructs
722 @subsection Conditional Init Constructs
724 Readline implements a facility similar in spirit to the conditional
725 compilation features of the C preprocessor which allows key
726 bindings and variable settings to be performed as the result
727 of tests. There are four parser directives used.
731 The @code{$if} construct allows bindings to be made based on the
732 editing mode, the terminal being used, or the application using
733 Readline. The text of the test extends to the end of the line;
734 no characters are required to isolate it.
738 The @code{mode=} form of the @code{$if} directive is used to test
739 whether Readline is in @code{emacs} or @code{vi} mode.
740 This may be used in conjunction
741 with the @samp{set keymap} command, for instance, to set bindings in
742 the @code{emacs-standard} and @code{emacs-ctlx} keymaps only if
743 Readline is starting out in @code{emacs} mode.
746 The @code{term=} form may be used to include terminal-specific
747 key bindings, perhaps to bind the key sequences output by the
748 terminal's function keys. The word on the right side of the
749 @samp{=} is tested against both the full name of the terminal and
750 the portion of the terminal name before the first @samp{-}. This
751 allows @code{sun} to match both @code{sun} and @code{sun-cmd},
755 The @var{application} construct is used to include
756 application-specific settings. Each program using the Readline
757 library sets the @var{application name}, and you can test for
759 This could be used to bind key sequences to functions useful for
760 a specific program. For instance, the following command adds a
761 key sequence that quotes the current or previous word in Bash:
764 # Quote the current or previous word
765 "\C-xq": "\eb\"\ef\""
771 This command, as seen in the previous example, terminates an
775 Commands in this branch of the @code{$if} directive are executed if
779 This directive takes a single filename as an argument and reads commands
780 and bindings from that file.
781 For example, the following directive reads from @file{/etc/inputrc}:
783 $include /etc/inputrc
787 @node Sample Init File
788 @subsection Sample Init File
790 Here is an example of an @var{inputrc} file. This illustrates key
791 binding, variable assignment, and conditional syntax.
795 # This file controls the behaviour of line input editing for
796 # programs that use the GNU Readline library. Existing
797 # programs include FTP, Bash, and GDB.
799 # You can re-read the inputrc file with C-x C-r.
800 # Lines beginning with '#' are comments.
802 # First, include any systemwide bindings and variable
803 # assignments from /etc/Inputrc
804 $include /etc/Inputrc
807 # Set various bindings for emacs mode.
809 set editing-mode emacs
813 Meta-Control-h: backward-kill-word Text after the function name is ignored
816 # Arrow keys in keypad mode
818 #"\M-OD": backward-char
819 #"\M-OC": forward-char
820 #"\M-OA": previous-history
821 #"\M-OB": next-history
823 # Arrow keys in ANSI mode
825 "\M-[D": backward-char
826 "\M-[C": forward-char
827 "\M-[A": previous-history
828 "\M-[B": next-history
830 # Arrow keys in 8 bit keypad mode
832 #"\M-\C-OD": backward-char
833 #"\M-\C-OC": forward-char
834 #"\M-\C-OA": previous-history
835 #"\M-\C-OB": next-history
837 # Arrow keys in 8 bit ANSI mode
839 #"\M-\C-[D": backward-char
840 #"\M-\C-[C": forward-char
841 #"\M-\C-[A": previous-history
842 #"\M-\C-[B": next-history
848 # An old-style binding. This happens to be the default.
851 # Macros that are convenient for shell interaction
854 "\C-xp": "PATH=$@{PATH@}\e\C-e\C-a\ef\C-f"
855 # prepare to type a quoted word --
856 # insert open and close double quotes
857 # and move to just after the open quote
859 # insert a backslash (testing backslash escapes
860 # in sequences and macros)
862 # Quote the current or previous word
863 "\C-xq": "\eb\"\ef\""
864 # Add a binding to refresh the line, which is unbound
865 "\C-xr": redraw-current-line
866 # Edit variable on current line.
867 "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
870 # use a visible bell if one is available
871 set bell-style visible
873 # don't strip characters to 7 bits when reading
876 # allow iso-latin1 characters to be inserted rather
877 # than converted to prefix-meta sequences
880 # display characters with the eighth bit set directly
881 # rather than as meta-prefixed characters
884 # if there are more than 150 possible completions for
885 # a word, ask the user if he wants to see all of them
886 set completion-query-items 150
892 "\M-.": yank-last-arg
896 @node Bindable Readline Commands
897 @section Bindable Readline Commands
900 * Commands For Moving:: Moving about the line.
901 * Commands For History:: Getting at previous lines.
902 * Commands For Text:: Commands for changing text.
903 * Commands For Killing:: Commands for killing and yanking.
904 * Numeric Arguments:: Specifying numeric arguments, repeat counts.
905 * Commands For Completion:: Getting Readline to do the typing for you.
906 * Keyboard Macros:: Saving and re-executing typed characters
907 * Miscellaneous Commands:: Other miscellaneous commands.
910 This section describes Readline commands that may be bound to key
913 You can list your key bindings by executing
914 @w{@code{bind -P}} or, for a more terse format, suitable for an
915 @var{inputrc} file, @w{@code{bind -p}}. (@xref{Bash Builtins}.)
917 Command names without an accompanying key sequence are unbound by default.
919 In the following descriptions, @dfn{point} refers to the current cursor
920 position, and @dfn{mark} refers to a cursor position saved by the
921 @code{set-mark} command.
922 The text between the point and mark is referred to as the @dfn{region}.
924 @node Commands For Moving
925 @subsection Commands For Moving
927 @item beginning-of-line (C-a)
928 Move to the start of the current line.
930 @item end-of-line (C-e)
931 Move to the end of the line.
933 @item forward-char (C-f)
934 Move forward a character.
936 @item backward-char (C-b)
937 Move back a character.
939 @item forward-word (M-f)
940 Move forward to the end of the next word. Words are composed of
943 @item backward-word (M-b)
944 Move back to the start of the current or previous word. Words are
945 composed of letters and digits.
947 @item clear-screen (C-l)
948 Clear the screen and redraw the current line,
949 leaving the current line at the top of the screen.
951 @item redraw-current-line ()
952 Refresh the current line. By default, this is unbound.
956 @node Commands For History
957 @subsection Commands For Manipulating The History
960 @item accept-line (Newline or Return)
962 Accept the line regardless of where the cursor is.
964 non-empty, add it to the history list according to the setting of
965 the @env{HISTCONTROL} and @env{HISTIGNORE} variables.
966 If this line is a modified history line, then restore the history line
967 to its original state.
969 @ifclear BashFeatures
970 Accept the line regardless of where the cursor is.
972 non-empty, it may be added to the history list for future recall with
973 @code{add_history()}.
974 If this line is a modified history line, the history line is restored
975 to its original state.
978 @item previous-history (C-p)
979 Move `back' through the history list, fetching the previous command.
981 @item next-history (C-n)
982 Move `forward' through the history list, fetching the next command.
984 @item beginning-of-history (M-<)
985 Move to the first line in the history.
987 @item end-of-history (M->)
988 Move to the end of the input history, i.e., the line currently
991 @item reverse-search-history (C-r)
992 Search backward starting at the current line and moving `up' through
993 the history as necessary. This is an incremental search.
995 @item forward-search-history (C-s)
996 Search forward starting at the current line and moving `down' through
997 the the history as necessary. This is an incremental search.
999 @item non-incremental-reverse-search-history (M-p)
1000 Search backward starting at the current line and moving `up'
1001 through the history as necessary using a non-incremental search
1002 for a string supplied by the user.
1004 @item non-incremental-forward-search-history (M-n)
1005 Search forward starting at the current line and moving `down'
1006 through the the history as necessary using a non-incremental search
1007 for a string supplied by the user.
1009 @item history-search-forward ()
1010 Search forward through the history for the string of characters
1011 between the start of the current line and the point.
1012 This is a non-incremental search.
1013 By default, this command is unbound.
1015 @item history-search-backward ()
1016 Search backward through the history for the string of characters
1017 between the start of the current line and the point. This
1018 is a non-incremental search. By default, this command is unbound.
1020 @item yank-nth-arg (M-C-y)
1021 Insert the first argument to the previous command (usually
1022 the second word on the previous line) at point.
1023 With an argument @var{n},
1024 insert the @var{n}th word from the previous command (the words
1025 in the previous command begin with word 0). A negative argument
1026 inserts the @var{n}th word from the end of the previous command.
1027 Once the argument @var{n} is computed, the argument is extracted
1028 as if the @samp{!@var{n}} history expansion had been specified.
1030 @item yank-last-arg (M-. or M-_)
1031 Insert last argument to the previous command (the last word of the
1032 previous history entry). With an
1033 argument, behave exactly like @code{yank-nth-arg}.
1034 Successive calls to @code{yank-last-arg} move back through the history
1035 list, inserting the last argument of each line in turn.
1036 The history expansion facilities are used to extract the last argument,
1037 as if the @samp{!$} history expansion had been specified.
1041 @node Commands For Text
1042 @subsection Commands For Changing Text
1045 @item delete-char (C-d)
1046 Delete the character at point. If point is at the
1047 beginning of the line, there are no characters in the line, and
1048 the last character typed was not bound to @code{delete-char}, then
1051 @item backward-delete-char (Rubout)
1052 Delete the character behind the cursor. A numeric argument means
1053 to kill the characters instead of deleting them.
1055 @item forward-backward-delete-char ()
1056 Delete the character under the cursor, unless the cursor is at the
1057 end of the line, in which case the character behind the cursor is
1058 deleted. By default, this is not bound to a key.
1060 @item quoted-insert (C-q or C-v)
1061 Add the next character typed to the line verbatim. This is
1062 how to insert key sequences like @kbd{C-q}, for example.
1064 @ifclear BashFeatures
1065 @item tab-insert (M-@key{TAB})
1066 Insert a tab character.
1069 @item self-insert (a, b, A, 1, !, @dots{})
1072 @item transpose-chars (C-t)
1073 Drag the character before the cursor forward over
1074 the character at the cursor, moving the
1075 cursor forward as well. If the insertion point
1076 is at the end of the line, then this
1077 transposes the last two characters of the line.
1078 Negative arguments have no effect.
1080 @item transpose-words (M-t)
1081 Drag the word before point past the word after point,
1082 moving point past that word as well.
1083 If the insertion point is at the end of the line, this transposes
1084 the last two words on the line.
1086 @item upcase-word (M-u)
1087 Uppercase the current (or following) word. With a negative argument,
1088 uppercase the previous word, but do not move the cursor.
1090 @item downcase-word (M-l)
1091 Lowercase the current (or following) word. With a negative argument,
1092 lowercase the previous word, but do not move the cursor.
1094 @item capitalize-word (M-c)
1095 Capitalize the current (or following) word. With a negative argument,
1096 capitalize the previous word, but do not move the cursor.
1098 @item overwrite-mode ()
1099 Toggle overwrite mode. With an explicit positive numeric argument,
1100 switches to overwrite mode. With an explicit non-positive numeric
1101 argument, switches to insert mode. This command affects only
1102 @code{emacs} mode; @code{vi} mode does overwrite differently.
1103 Each call to @code{readline()} starts in insert mode.
1105 In overwrite mode, characters bound to @code{self-insert} replace
1106 the text at point rather than pushing the text to the right.
1107 Characters bound to @code{backward-delete-char} replace the character
1108 before point with a space.
1110 By default, this command is unbound.
1114 @node Commands For Killing
1115 @subsection Killing And Yanking
1119 @item kill-line (C-k)
1120 Kill the text from point to the end of the line.
1122 @item backward-kill-line (C-x Rubout)
1123 Kill backward to the beginning of the line.
1125 @item unix-line-discard (C-u)
1126 Kill backward from the cursor to the beginning of the current line.
1128 @item kill-whole-line ()
1129 Kill all characters on the current line, no matter where point is.
1130 By default, this is unbound.
1132 @item kill-word (M-d)
1133 Kill from point to the end of the current word, or if between
1134 words, to the end of the next word.
1135 Word boundaries are the same as @code{forward-word}.
1137 @item backward-kill-word (M-@key{DEL})
1138 Kill the word behind point.
1139 Word boundaries are the same as @code{backward-word}.
1141 @item unix-word-rubout (C-w)
1142 Kill the word behind point, using white space as a word boundary.
1143 The killed text is saved on the kill-ring.
1145 @item unix-filename-rubout ()
1146 Kill the word behind point, using white space and the slash character
1147 as the word boundaries.
1148 The killed text is saved on the kill-ring.
1150 @item delete-horizontal-space ()
1151 Delete all spaces and tabs around point. By default, this is unbound.
1153 @item kill-region ()
1154 Kill the text in the current region.
1155 By default, this command is unbound.
1157 @item copy-region-as-kill ()
1158 Copy the text in the region to the kill buffer, so it can be yanked
1159 right away. By default, this command is unbound.
1161 @item copy-backward-word ()
1162 Copy the word before point to the kill buffer.
1163 The word boundaries are the same as @code{backward-word}.
1164 By default, this command is unbound.
1166 @item copy-forward-word ()
1167 Copy the word following point to the kill buffer.
1168 The word boundaries are the same as @code{forward-word}.
1169 By default, this command is unbound.
1172 Yank the top of the kill ring into the buffer at point.
1174 @item yank-pop (M-y)
1175 Rotate the kill-ring, and yank the new top. You can only do this if
1176 the prior command is @code{yank} or @code{yank-pop}.
1179 @node Numeric Arguments
1180 @subsection Specifying Numeric Arguments
1183 @item digit-argument (@kbd{M-0}, @kbd{M-1}, @dots{} @kbd{M--})
1184 Add this digit to the argument already accumulating, or start a new
1185 argument. @kbd{M--} starts a negative argument.
1187 @item universal-argument ()
1188 This is another way to specify an argument.
1189 If this command is followed by one or more digits, optionally with a
1190 leading minus sign, those digits define the argument.
1191 If the command is followed by digits, executing @code{universal-argument}
1192 again ends the numeric argument, but is otherwise ignored.
1193 As a special case, if this command is immediately followed by a
1194 character that is neither a digit or minus sign, the argument count
1195 for the next command is multiplied by four.
1196 The argument count is initially one, so executing this function the
1197 first time makes the argument count four, a second time makes the
1198 argument count sixteen, and so on.
1199 By default, this is not bound to a key.
1202 @node Commands For Completion
1203 @subsection Letting Readline Type For You
1206 @item complete (@key{TAB})
1207 Attempt to perform completion on the text before point.
1208 The actual completion performed is application-specific.
1210 Bash attempts completion treating the text as a variable (if the
1211 text begins with @samp{$}), username (if the text begins with
1212 @samp{~}), hostname (if the text begins with @samp{@@}), or
1213 command (including aliases and functions) in turn. If none
1214 of these produces a match, filename completion is attempted.
1216 @ifclear BashFeatures
1217 The default is filename completion.
1220 @item possible-completions (M-?)
1221 List the possible completions of the text before point.
1223 @item insert-completions (M-*)
1224 Insert all completions of the text before point that would have
1225 been generated by @code{possible-completions}.
1227 @item menu-complete ()
1228 Similar to @code{complete}, but replaces the word to be completed
1229 with a single match from the list of possible completions.
1230 Repeated execution of @code{menu-complete} steps through the list
1231 of possible completions, inserting each match in turn.
1232 At the end of the list of completions, the bell is rung
1233 (subject to the setting of @code{bell-style})
1234 and the original text is restored.
1235 An argument of @var{n} moves @var{n} positions forward in the list
1236 of matches; a negative argument may be used to move backward
1238 This command is intended to be bound to @key{TAB}, but is unbound
1241 @item delete-char-or-list ()
1242 Deletes the character under the cursor if not at the beginning or
1243 end of the line (like @code{delete-char}).
1244 If at the end of the line, behaves identically to
1245 @code{possible-completions}.
1246 This command is unbound by default.
1249 @item complete-filename (M-/)
1250 Attempt filename completion on the text before point.
1252 @item possible-filename-completions (C-x /)
1253 List the possible completions of the text before point,
1254 treating it as a filename.
1256 @item complete-username (M-~)
1257 Attempt completion on the text before point, treating
1260 @item possible-username-completions (C-x ~)
1261 List the possible completions of the text before point,
1262 treating it as a username.
1264 @item complete-variable (M-$)
1265 Attempt completion on the text before point, treating
1266 it as a shell variable.
1268 @item possible-variable-completions (C-x $)
1269 List the possible completions of the text before point,
1270 treating it as a shell variable.
1272 @item complete-hostname (M-@@)
1273 Attempt completion on the text before point, treating
1276 @item possible-hostname-completions (C-x @@)
1277 List the possible completions of the text before point,
1278 treating it as a hostname.
1280 @item complete-command (M-!)
1281 Attempt completion on the text before point, treating
1282 it as a command name. Command completion attempts to
1283 match the text against aliases, reserved words, shell
1284 functions, shell builtins, and finally executable filenames,
1287 @item possible-command-completions (C-x !)
1288 List the possible completions of the text before point,
1289 treating it as a command name.
1291 @item dynamic-complete-history (M-@key{TAB})
1292 Attempt completion on the text before point, comparing
1293 the text against lines from the history list for possible
1296 @item complete-into-braces (M-@{)
1297 Perform filename completion and insert the list of possible completions
1298 enclosed within braces so the list is available to the shell
1299 (@pxref{Brace Expansion}).
1304 @node Keyboard Macros
1305 @subsection Keyboard Macros
1308 @item start-kbd-macro (C-x ()
1309 Begin saving the characters typed into the current keyboard macro.
1311 @item end-kbd-macro (C-x ))
1312 Stop saving the characters typed into the current keyboard macro
1313 and save the definition.
1315 @item call-last-kbd-macro (C-x e)
1316 Re-execute the last keyboard macro defined, by making the characters
1317 in the macro appear as if typed at the keyboard.
1321 @node Miscellaneous Commands
1322 @subsection Some Miscellaneous Commands
1325 @item re-read-init-file (C-x C-r)
1326 Read in the contents of the @var{inputrc} file, and incorporate
1327 any bindings or variable assignments found there.
1330 Abort the current editing command and
1331 ring the terminal's bell (subject to the setting of
1334 @item do-uppercase-version (M-a, M-b, M-@var{x}, @dots{})
1335 If the metafied character @var{x} is lowercase, run the command
1336 that is bound to the corresponding uppercase character.
1338 @item prefix-meta (@key{ESC})
1339 Metafy the next character typed. This is for keyboards
1340 without a meta key. Typing @samp{@key{ESC} f} is equivalent to typing
1343 @item undo (C-_ or C-x C-u)
1344 Incremental undo, separately remembered for each line.
1346 @item revert-line (M-r)
1347 Undo all changes made to this line. This is like executing the @code{undo}
1348 command enough times to get back to the beginning.
1351 @item tilde-expand (M-&)
1353 @ifclear BashFeatures
1354 @item tilde-expand (M-~)
1356 Perform tilde expansion on the current word.
1358 @item set-mark (C-@@)
1359 Set the mark to the point. If a
1360 numeric argument is supplied, the mark is set to that position.
1362 @item exchange-point-and-mark (C-x C-x)
1363 Swap the point with the mark. The current cursor position is set to
1364 the saved position, and the old cursor position is saved as the mark.
1366 @item character-search (C-])
1367 A character is read and point is moved to the next occurrence of that
1368 character. A negative count searches for previous occurrences.
1370 @item character-search-backward (M-C-])
1371 A character is read and point is moved to the previous occurrence
1372 of that character. A negative count searches for subsequent
1375 @item insert-comment (M-#)
1376 Without a numeric argument, the value of the @code{comment-begin}
1377 variable is inserted at the beginning of the current line.
1378 If a numeric argument is supplied, this command acts as a toggle: if
1379 the characters at the beginning of the line do not match the value
1380 of @code{comment-begin}, the value is inserted, otherwise
1381 the characters in @code{comment-begin} are deleted from the beginning of
1383 In either case, the line is accepted as if a newline had been typed.
1385 The default value of @code{comment-begin} causes this command
1386 to make the current line a shell comment.
1387 If a numeric argument causes the comment character to be removed, the line
1388 will be executed by the shell.
1391 @item dump-functions ()
1392 Print all of the functions and their key bindings to the
1393 Readline output stream. If a numeric argument is supplied,
1394 the output is formatted in such a way that it can be made part
1395 of an @var{inputrc} file. This command is unbound by default.
1397 @item dump-variables ()
1398 Print all of the settable variables and their values to the
1399 Readline output stream. If a numeric argument is supplied,
1400 the output is formatted in such a way that it can be made part
1401 of an @var{inputrc} file. This command is unbound by default.
1403 @item dump-macros ()
1404 Print all of the Readline key sequences bound to macros and the
1405 strings they output. If a numeric argument is supplied,
1406 the output is formatted in such a way that it can be made part
1407 of an @var{inputrc} file. This command is unbound by default.
1410 @item glob-complete-word (M-g)
1411 The word before point is treated as a pattern for pathname expansion,
1412 with an asterisk implicitly appended. This pattern is used to
1413 generate a list of matching file names for possible completions.
1415 @item glob-expand-word (C-x *)
1416 The word before point is treated as a pattern for pathname expansion,
1417 and the list of matching file names is inserted, replacing the word.
1418 If a numeric argument is supplied, a @samp{*} is appended before
1421 @item glob-list-expansions (C-x g)
1422 The list of expansions that would have been generated by
1423 @code{glob-expand-word} is displayed, and the line is redrawn.
1424 If a numeric argument is supplied, a @samp{*} is appended before
1427 @item display-shell-version (C-x C-v)
1428 Display version information about the current instance of Bash.
1430 @item shell-expand-line (M-C-e)
1431 Expand the line as the shell does.
1432 This performs alias and history expansion as well as all of the shell
1433 word expansions (@pxref{Shell Expansions}).
1435 @item history-expand-line (M-^)
1436 Perform history expansion on the current line.
1438 @item magic-space ()
1439 Perform history expansion on the current line and insert a space
1440 (@pxref{History Interaction}).
1442 @item alias-expand-line ()
1443 Perform alias expansion on the current line (@pxref{Aliases}).
1445 @item history-and-alias-expand-line ()
1446 Perform history and alias expansion on the current line.
1448 @item insert-last-argument (M-. or M-_)
1449 A synonym for @code{yank-last-arg}.
1451 @item operate-and-get-next (C-o)
1452 Accept the current line for execution and fetch the next line
1453 relative to the current line from the history for editing. Any
1454 argument is ignored.
1456 @item edit-and-execute-command (C-xC-e)
1457 Invoke an editor on the current command line, and execute the result as shell
1459 Bash attempts to invoke
1460 @code{$VISUAL}, @code{$EDITOR}, and @code{emacs}
1461 as the editor, in that order.
1465 @ifclear BashFeatures
1466 @item emacs-editing-mode (C-e)
1467 When in @code{vi} command mode, this causes a switch to @code{emacs}
1470 @item vi-editing-mode (M-C-j)
1471 When in @code{emacs} editing mode, this causes a switch to @code{vi}
1478 @node Readline vi Mode
1479 @section Readline vi Mode
1481 While the Readline library does not have a full set of @code{vi}
1482 editing functions, it does contain enough to allow simple editing
1483 of the line. The Readline @code{vi} mode behaves as specified in
1484 the @sc{posix} 1003.2 standard.
1487 In order to switch interactively between @code{emacs} and @code{vi}
1488 editing modes, use the @samp{set -o emacs} and @samp{set -o vi}
1489 commands (@pxref{The Set Builtin}).
1491 @ifclear BashFeatures
1492 In order to switch interactively between @code{emacs} and @code{vi}
1493 editing modes, use the command @kbd{M-C-j} (bound to emacs-editing-mode
1494 when in @code{vi} mode and to vi-editing-mode in @code{emacs} mode).
1496 The Readline default is @code{emacs} mode.
1498 When you enter a line in @code{vi} mode, you are already placed in
1499 `insertion' mode, as if you had typed an @samp{i}. Pressing @key{ESC}
1500 switches you into `command' mode, where you can edit the text of the
1501 line with the standard @code{vi} movement keys, move to previous
1502 history lines with @samp{k} and subsequent lines with @samp{j}, and
1506 @node Programmable Completion
1507 @section Programmable Completion
1508 @cindex programmable completion
1510 When word completion is attempted for an argument to a command for
1511 which a completion specification (a @var{compspec}) has been defined
1512 using the @code{complete} builtin (@pxref{Programmable Completion Builtins}),
1513 the programmable completion facilities are invoked.
1515 First, the command name is identified.
1516 If a compspec has been defined for that command, the
1517 compspec is used to generate the list of possible completions for the word.
1518 If the command word is a full pathname, a compspec for the full
1519 pathname is searched for first.
1520 If no compspec is found for the full pathname, an attempt is made to
1521 find a compspec for the portion following the final slash.
1523 Once a compspec has been found, it is used to generate the list of
1525 If a compspec is not found, the default Bash completion
1526 described above (@pxref{Commands For Completion}) is performed.
1528 First, the actions specified by the compspec are used.
1529 Only matches which are prefixed by the word being completed are
1531 When the @option{-f} or @option{-d} option is used for filename or
1532 directory name completion, the shell variable @env{FIGNORE} is
1533 used to filter the matches.
1534 @xref{Bash Variables}, for a description of @env{FIGNORE}.
1536 Any completions specified by a filename expansion pattern to the
1537 @option{-G} option are generated next.
1538 The words generated by the pattern need not match the word being completed.
1539 The @env{GLOBIGNORE} shell variable is not used to filter the matches,
1540 but the @env{FIGNORE} shell variable is used.
1542 Next, the string specified as the argument to the @option{-W} option
1544 The string is first split using the characters in the @env{IFS}
1545 special variable as delimiters.
1546 Shell quoting is honored.
1547 Each word is then expanded using
1548 brace expansion, tilde expansion, parameter and variable expansion,
1549 command substitution, and arithmetic expansion,
1550 as described above (@pxref{Shell Expansions}).
1551 The results are split using the rules described above
1552 (@pxref{Word Splitting}).
1553 The results of the expansion are prefix-matched against the word being
1554 completed, and the matching words become the possible completions.
1556 After these matches have been generated, any shell function or command
1557 specified with the @option{-F} and @option{-C} options is invoked.
1558 When the command or function is invoked, the @env{COMP_LINE} and
1559 @env{COMP_POINT} variables are assigned values as described above
1560 (@pxref{Bash Variables}).
1561 If a shell function is being invoked, the @env{COMP_WORDS} and
1562 @env{COMP_CWORD} variables are also set.
1563 When the function or command is invoked, the first argument is the
1564 name of the command whose arguments are being completed, the
1565 second argument is the word being completed, and the third argument
1566 is the word preceding the word being completed on the current command line.
1567 No filtering of the generated completions against the word being completed
1568 is performed; the function or command has complete freedom in generating
1571 Any function specified with @option{-F} is invoked first.
1572 The function may use any of the shell facilities, including the
1573 @code{compgen} builtin described below
1574 (@pxref{Programmable Completion Builtins}), to generate the matches.
1575 It must put the possible completions in the @env{COMPREPLY} array
1578 Next, any command specified with the @option{-C} option is invoked
1579 in an environment equivalent to command substitution.
1580 It should print a list of completions, one per line, to
1581 the standard output.
1582 Backslash may be used to escape a newline, if necessary.
1584 After all of the possible completions are generated, any filter
1585 specified with the @option{-X} option is applied to the list.
1586 The filter is a pattern as used for pathname expansion; a @samp{&}
1587 in the pattern is replaced with the text of the word being completed.
1588 A literal @samp{&} may be escaped with a backslash; the backslash
1589 is removed before attempting a match.
1590 Any completion that matches the pattern will be removed from the list.
1591 A leading @samp{!} negates the pattern; in this case any completion
1592 not matching the pattern will be removed.
1594 Finally, any prefix and suffix specified with the @option{-P} and @option{-S}
1595 options are added to each member of the completion list, and the result is
1596 returned to the Readline completion code as the list of possible
1599 If the previously-applied actions do not generate any matches, and the
1600 @option{-o dirnames} option was supplied to @code{complete} when the
1601 compspec was defined, directory name completion is attempted.
1603 If the @option{-o plusdirs} option was supplied to @code{complete} when
1604 the compspec was defined, directory name completion is attempted and any
1605 matches are added to the results of the other actions.
1607 By default, if a compspec is found, whatever it generates is returned to
1608 the completion code as the full set of possible completions.
1609 The default Bash completions are not attempted, and the Readline default
1610 of filename completion is disabled.
1611 If the @option{-o bashdefault} option was supplied to @code{complete} when
1612 the compspec was defined, the default Bash completions are attempted
1613 if the compspec generates no matches.
1614 If the @option{-o default} option was supplied to @code{complete} when the
1615 compspec was defined, Readline's default completion will be performed
1616 if the compspec (and, if attempted, the default Bash completions)
1617 generate no matches.
1619 When a compspec indicates that directory name completion is desired,
1620 the programmable completion functions force Readline to append a slash
1621 to completed names which are symbolic links to directories, subject to
1622 the value of the @var{mark-directories} Readline variable, regardless
1623 of the setting of the @var{mark-symlinked-directories} Readline variable.
1625 @node Programmable Completion Builtins
1626 @section Programmable Completion Builtins
1627 @cindex completion builtins
1629 Two builtin commands are available to manipulate the programmable completion
1636 @code{compgen [@var{option}] [@var{word}]}
1639 Generate possible completion matches for @var{word} according to
1640 the @var{option}s, which may be any option accepted by the
1642 builtin with the exception of @option{-p} and @option{-r}, and write
1643 the matches to the standard output.
1644 When using the @option{-F} or @option{-C} options, the various shell variables
1645 set by the programmable completion facilities, while available, will not
1648 The matches will be generated in the same way as if the programmable
1649 completion code had generated them directly from a completion specification
1650 with the same flags.
1651 If @var{word} is specified, only those completions matching @var{word}
1654 The return value is true unless an invalid option is supplied, or no
1655 matches were generated.
1660 @code{complete [-abcdefgjksuv] [-o @var{comp-option}] [-A @var{action}] [-G @var{globpat}] [-W @var{wordlist}]
1661 [-P @var{prefix}] [-S @var{suffix}] [-X @var{filterpat}] [-F @var{function}]
1662 [-C @var{command}] @var{name} [@var{name} @dots{}]}
1663 @code{complete -pr [@var{name} @dots{}]}
1666 Specify how arguments to each @var{name} should be completed.
1667 If the @option{-p} option is supplied, or if no options are supplied, existing
1668 completion specifications are printed in a way that allows them to be
1670 The @option{-r} option removes a completion specification for
1671 each @var{name}, or, if no @var{name}s are supplied, all
1672 completion specifications.
1674 The process of applying these completion specifications when word completion
1675 is attempted is described above (@pxref{Programmable Completion}).
1677 Other options, if specified, have the following meanings.
1678 The arguments to the @option{-G}, @option{-W}, and @option{-X} options
1679 (and, if necessary, the @option{-P} and @option{-S} options)
1680 should be quoted to protect them from expansion before the
1681 @code{complete} builtin is invoked.
1685 @item -o @var{comp-option}
1686 The @var{comp-option} controls several aspects of the compspec's behavior
1687 beyond the simple generation of completions.
1688 @var{comp-option} may be one of:
1693 Perform the rest of the default Bash completions if the compspec
1694 generates no matches.
1697 Use Readline's default filename completion if the compspec generates
1701 Perform directory name completion if the compspec generates no matches.
1704 Tell Readline that the compspec generates filenames, so it can perform any
1705 filename-specific processing (like adding a slash to directory names or
1706 suppressing trailing spaces). This option is intended to be used with
1707 shell functions specified with @option{-F}.
1710 Tell Readline not to append a space (the default) to words completed at
1711 the end of the line.
1714 After any matches defined by the compspec are generated,
1715 directory name completion is attempted and any
1716 matches are added to the results of the other actions.
1720 @item -A @var{action}
1721 The @var{action} may be one of the following to generate a list of possible
1726 Alias names. May also be specified as @option{-a}.
1729 Array variable names.
1732 Readline key binding names (@pxref{Bindable Readline Commands}).
1735 Names of shell builtin commands. May also be specified as @option{-b}.
1738 Command names. May also be specified as @option{-c}.
1741 Directory names. May also be specified as @option{-d}.
1744 Names of disabled shell builtins.
1747 Names of enabled shell builtins.
1750 Names of exported shell variables. May also be specified as @option{-e}.
1753 File names. May also be specified as @option{-f}.
1756 Names of shell functions.
1759 Group names. May also be specified as @option{-g}.
1762 Help topics as accepted by the @code{help} builtin (@pxref{Bash Builtins}).
1765 Hostnames, as taken from the file specified by the
1766 @env{HOSTFILE} shell variable (@pxref{Bash Variables}).
1769 Job names, if job control is active. May also be specified as @option{-j}.
1772 Shell reserved words. May also be specified as @option{-k}.
1775 Names of running jobs, if job control is active.
1778 Service names. May also be specified as @option{-s}.
1781 Valid arguments for the @option{-o} option to the @code{set} builtin
1782 (@pxref{The Set Builtin}).
1785 Shell option names as accepted by the @code{shopt} builtin
1786 (@pxref{Bash Builtins}).
1792 Names of stopped jobs, if job control is active.
1795 User names. May also be specified as @option{-u}.
1798 Names of all shell variables. May also be specified as @option{-v}.
1801 @item -G @var{globpat}
1802 The filename expansion pattern @var{globpat} is expanded to generate
1803 the possible completions.
1805 @item -W @var{wordlist}
1806 The @var{wordlist} is split using the characters in the
1807 @env{IFS} special variable as delimiters, and each resultant word
1809 The possible completions are the members of the resultant list which
1810 match the word being completed.
1812 @item -C @var{command}
1813 @var{command} is executed in a subshell environment, and its output is
1814 used as the possible completions.
1816 @item -F @var{function}
1817 The shell function @var{function} is executed in the current shell
1819 When it finishes, the possible completions are retrieved from the value
1820 of the @env{COMPREPLY} array variable.
1822 @item -X @var{filterpat}
1823 @var{filterpat} is a pattern as used for filename expansion.
1824 It is applied to the list of possible completions generated by the
1825 preceding options and arguments, and each completion matching
1826 @var{filterpat} is removed from the list.
1827 A leading @samp{!} in @var{filterpat} negates the pattern; in this
1828 case, any completion not matching @var{filterpat} is removed.
1830 @item -P @var{prefix}
1831 @var{prefix} is added at the beginning of each possible completion
1832 after all other options have been applied.
1834 @item -S @var{suffix}
1835 @var{suffix} is appended to each possible completion
1836 after all other options have been applied.
1839 The return value is true unless an invalid option is supplied, an option
1840 other than @option{-p} or @option{-r} is supplied without a @var{name}
1841 argument, an attempt is made to remove a completion specification for
1842 a @var{name} for which no specification exists, or
1843 an error occurs adding a completion specification.