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-2002 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
389 The @w{@code{bind -V}} command lists the current Readline variable names
390 and values. @xref{Bash Builtins}.
393 A great deal of run-time behavior is changeable with the following
396 @cindex variables, readline
401 Controls what happens when Readline wants to ring the terminal bell.
402 If set to @samp{none}, Readline never rings the bell. If set to
403 @samp{visible}, Readline uses a visible bell if one is available.
404 If set to @samp{audible} (the default), Readline attempts to ring
408 @vindex comment-begin
409 The string to insert at the beginning of the line when the
410 @code{insert-comment} command is executed. The default value
413 @item completion-ignore-case
414 If set to @samp{on}, Readline performs filename matching and completion
415 in a case-insensitive fashion.
416 The default value is @samp{off}.
418 @item completion-query-items
419 @vindex completion-query-items
420 The number of possible completions that determines when the user is
421 asked whether he wants to see the list of possibilities. If the
422 number of possible completions is greater than this value,
423 Readline will ask the user whether or not he wishes to view
424 them; otherwise, they are simply listed.
425 This variable must be set to an integer value greater than or equal to 0.
426 The default limit is @code{100}.
430 If set to @samp{on}, Readline will convert characters with the
431 eighth bit set to an @sc{ascii} key sequence by stripping the eighth
432 bit and prefixing an @key{ESC} character, converting them to a
433 meta-prefixed key sequence. The default value is @samp{on}.
435 @item disable-completion
436 @vindex disable-completion
437 If set to @samp{On}, Readline will inhibit word completion.
438 Completion characters will be inserted into the line as if they had
439 been mapped to @code{self-insert}. The default is @samp{off}.
443 The @code{editing-mode} variable controls which default set of
444 key bindings is used. By default, Readline starts up in Emacs editing
445 mode, where the keystrokes are most similar to Emacs. This variable can be
446 set to either @samp{emacs} or @samp{vi}.
449 @vindex enable-keypad
450 When set to @samp{on}, Readline will try to enable the application
451 keypad when it is called. Some systems need this to enable the
452 arrow keys. The default is @samp{off}.
456 If set to @samp{on}, tilde expansion is performed when Readline
457 attempts word completion. The default is @samp{off}.
459 @vindex history-preserve-point
460 If set to @samp{on}, the history code attempts to place point at the
461 same location on each history line retrived with @code{previous-history}
462 or @code{next-history}.
464 @item horizontal-scroll-mode
465 @vindex horizontal-scroll-mode
466 This variable can be set to either @samp{on} or @samp{off}. Setting it
467 to @samp{on} means that the text of the lines being edited will scroll
468 horizontally on a single screen line when they are longer than the width
469 of the screen, instead of wrapping onto a new screen line. By default,
470 this variable is set to @samp{off}.
475 If set to @samp{on}, Readline will enable eight-bit input (it
476 will not clear the eighth bit in the characters it reads),
477 regardless of what the terminal claims it can support. The
478 default value is @samp{off}. The name @code{meta-flag} is a
479 synonym for this variable.
481 @item isearch-terminators
482 @vindex isearch-terminators
483 The string of characters that should terminate an incremental search without
484 subsequently executing the character as a command (@pxref{Searching}).
485 If this variable has not been given a value, the characters @key{ESC} and
486 @kbd{C-J} will terminate an incremental search.
490 Sets Readline's idea of the current keymap for key binding commands.
491 Acceptable @code{keymap} names are
493 @code{emacs-standard},
498 @code{vi-command}, and
500 @code{vi} is equivalent to @code{vi-command}; @code{emacs} is
501 equivalent to @code{emacs-standard}. The default value is @code{emacs}.
502 The value of the @code{editing-mode} variable also affects the
505 @item mark-directories
506 If set to @samp{on}, completed directory names have a slash
507 appended. The default is @samp{on}.
509 @item mark-modified-lines
510 @vindex mark-modified-lines
511 This variable, when set to @samp{on}, causes Readline to display an
512 asterisk (@samp{*}) at the start of history lines which have been modified.
513 This variable is @samp{off} by default.
515 @item mark-symlinked-directories
516 @vindex mark-symlinked-directories
517 If set to @samp{on}, completed names which are symbolic links
518 to directories have a slash appended (subject to the value of
519 @code{mark-directories}).
520 The default is @samp{off}.
522 @item match-hidden-files
523 @vindex match-hidden-files
524 This variable, when set to @samp{on}, causes Readline to match files whose
525 names begin with a @samp{.} (hidden files) when performing filename
526 completion, unless the leading @samp{.} is
527 supplied by the user in the filename to be completed.
528 This variable is @samp{on} by default.
532 If set to @samp{on}, Readline will display characters with the
533 eighth bit set directly rather than as a meta-prefixed escape
534 sequence. The default is @samp{off}.
536 @item page-completions
537 @vindex page-completions
538 If set to @samp{on}, Readline uses an internal @code{more}-like pager
539 to display a screenful of possible completions at a time.
540 This variable is @samp{on} by default.
542 @item print-completions-horizontally
543 If set to @samp{on}, Readline will display completions with matches
544 sorted horizontally in alphabetical order, rather than down the screen.
545 The default is @samp{off}.
547 @item show-all-if-ambiguous
548 @vindex show-all-if-ambiguous
549 This alters the default behavior of the completion functions. If
551 words which have more than one possible completion cause the
552 matches to be listed immediately instead of ringing the bell.
553 The default value is @samp{off}.
556 @vindex visible-stats
557 If set to @samp{on}, a character denoting a file's type
558 is appended to the filename when listing possible
559 completions. The default is @samp{off}.
564 The syntax for controlling key bindings in the init file is
565 simple. First you need to find the name of the command that you
566 want to change. The following sections contain tables of the command
567 name, the default keybinding, if any, and a short description of what
570 Once you know the name of the command, simply place on a line
571 in the init file the name of the key
572 you wish to bind the command to, a colon, and then the name of the
573 command. The name of the key
574 can be expressed in different ways, depending on what you find most
577 In addition to command names, readline allows keys to be bound
578 to a string that is inserted when the key is pressed (a @var{macro}).
581 The @w{@code{bind -p}} command displays Readline function names and
582 bindings in a format that can put directly into an initialization file.
583 @xref{Bash Builtins}.
587 @item @w{@var{keyname}: @var{function-name} or @var{macro}}
588 @var{keyname} is the name of a key spelled out in English. For example:
590 Control-u: universal-argument
591 Meta-Rubout: backward-kill-word
592 Control-o: "> output"
595 In the above example, @kbd{C-u} is bound to the function
596 @code{universal-argument},
597 @kbd{M-DEL} is bound to the function @code{backward-kill-word}, and
598 @kbd{C-o} is bound to run the macro
599 expressed on the right hand side (that is, to insert the text
600 @samp{> output} into the line).
602 A number of symbolic character names are recognized while
603 processing this key binding syntax:
617 @item @w{"@var{keyseq}": @var{function-name} or @var{macro}}
618 @var{keyseq} differs from @var{keyname} above in that strings
619 denoting an entire key sequence can be specified, by placing
620 the key sequence in double quotes. Some @sc{gnu} Emacs style key
621 escapes can be used, as in the following example, but the
622 special character names are not recognized.
625 "\C-u": universal-argument
626 "\C-x\C-r": re-read-init-file
627 "\e[11~": "Function Key 1"
630 In the above example, @kbd{C-u} is again bound to the function
631 @code{universal-argument} (just as it was in the first example),
632 @samp{@kbd{C-x} @kbd{C-r}} is bound to the function @code{re-read-init-file},
633 and @samp{@key{ESC} @key{[} @key{1} @key{1} @key{~}} is bound to insert
634 the text @samp{Function Key 1}.
638 The following @sc{gnu} Emacs style escape sequences are available when
639 specifying key sequences:
651 @key{"}, a double quotation mark
653 @key{'}, a single quote or apostrophe
656 In addition to the @sc{gnu} Emacs style escape sequences, a second
657 set of backslash escapes is available:
677 the eight-bit character whose value is the octal value @var{nnn}
678 (one to three digits)
680 the eight-bit character whose value is the hexadecimal value @var{HH}
681 (one or two hex digits)
684 When entering the text of a macro, single or double quotes must
685 be used to indicate a macro definition.
686 Unquoted text is assumed to be a function name.
687 In the macro body, the backslash escapes described above are expanded.
688 Backslash will quote any other character in the macro text,
689 including @samp{"} and @samp{'}.
690 For example, the following binding will make @samp{@kbd{C-x} \}
691 insert a single @samp{\} into the line:
698 @node Conditional Init Constructs
699 @subsection Conditional Init Constructs
701 Readline implements a facility similar in spirit to the conditional
702 compilation features of the C preprocessor which allows key
703 bindings and variable settings to be performed as the result
704 of tests. There are four parser directives used.
708 The @code{$if} construct allows bindings to be made based on the
709 editing mode, the terminal being used, or the application using
710 Readline. The text of the test extends to the end of the line;
711 no characters are required to isolate it.
715 The @code{mode=} form of the @code{$if} directive is used to test
716 whether Readline is in @code{emacs} or @code{vi} mode.
717 This may be used in conjunction
718 with the @samp{set keymap} command, for instance, to set bindings in
719 the @code{emacs-standard} and @code{emacs-ctlx} keymaps only if
720 Readline is starting out in @code{emacs} mode.
723 The @code{term=} form may be used to include terminal-specific
724 key bindings, perhaps to bind the key sequences output by the
725 terminal's function keys. The word on the right side of the
726 @samp{=} is tested against both the full name of the terminal and
727 the portion of the terminal name before the first @samp{-}. This
728 allows @code{sun} to match both @code{sun} and @code{sun-cmd},
732 The @var{application} construct is used to include
733 application-specific settings. Each program using the Readline
734 library sets the @var{application name}, and you can test for
736 This could be used to bind key sequences to functions useful for
737 a specific program. For instance, the following command adds a
738 key sequence that quotes the current or previous word in Bash:
741 # Quote the current or previous word
742 "\C-xq": "\eb\"\ef\""
748 This command, as seen in the previous example, terminates an
752 Commands in this branch of the @code{$if} directive are executed if
756 This directive takes a single filename as an argument and reads commands
757 and bindings from that file.
758 For example, the following directive reads from @file{/etc/inputrc}:
760 $include /etc/inputrc
764 @node Sample Init File
765 @subsection Sample Init File
767 Here is an example of an @var{inputrc} file. This illustrates key
768 binding, variable assignment, and conditional syntax.
772 # This file controls the behaviour of line input editing for
773 # programs that use the GNU Readline library. Existing
774 # programs include FTP, Bash, and GDB.
776 # You can re-read the inputrc file with C-x C-r.
777 # Lines beginning with '#' are comments.
779 # First, include any systemwide bindings and variable
780 # assignments from /etc/Inputrc
781 $include /etc/Inputrc
784 # Set various bindings for emacs mode.
786 set editing-mode emacs
790 Meta-Control-h: backward-kill-word Text after the function name is ignored
793 # Arrow keys in keypad mode
795 #"\M-OD": backward-char
796 #"\M-OC": forward-char
797 #"\M-OA": previous-history
798 #"\M-OB": next-history
800 # Arrow keys in ANSI mode
802 "\M-[D": backward-char
803 "\M-[C": forward-char
804 "\M-[A": previous-history
805 "\M-[B": next-history
807 # Arrow keys in 8 bit keypad mode
809 #"\M-\C-OD": backward-char
810 #"\M-\C-OC": forward-char
811 #"\M-\C-OA": previous-history
812 #"\M-\C-OB": next-history
814 # Arrow keys in 8 bit ANSI mode
816 #"\M-\C-[D": backward-char
817 #"\M-\C-[C": forward-char
818 #"\M-\C-[A": previous-history
819 #"\M-\C-[B": next-history
825 # An old-style binding. This happens to be the default.
828 # Macros that are convenient for shell interaction
831 "\C-xp": "PATH=$@{PATH@}\e\C-e\C-a\ef\C-f"
832 # prepare to type a quoted word --
833 # insert open and close double quotes
834 # and move to just after the open quote
836 # insert a backslash (testing backslash escapes
837 # in sequences and macros)
839 # Quote the current or previous word
840 "\C-xq": "\eb\"\ef\""
841 # Add a binding to refresh the line, which is unbound
842 "\C-xr": redraw-current-line
843 # Edit variable on current line.
844 "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
847 # use a visible bell if one is available
848 set bell-style visible
850 # don't strip characters to 7 bits when reading
853 # allow iso-latin1 characters to be inserted rather
854 # than converted to prefix-meta sequences
857 # display characters with the eighth bit set directly
858 # rather than as meta-prefixed characters
861 # if there are more than 150 possible completions for
862 # a word, ask the user if he wants to see all of them
863 set completion-query-items 150
869 "\M-.": yank-last-arg
873 @node Bindable Readline Commands
874 @section Bindable Readline Commands
877 * Commands For Moving:: Moving about the line.
878 * Commands For History:: Getting at previous lines.
879 * Commands For Text:: Commands for changing text.
880 * Commands For Killing:: Commands for killing and yanking.
881 * Numeric Arguments:: Specifying numeric arguments, repeat counts.
882 * Commands For Completion:: Getting Readline to do the typing for you.
883 * Keyboard Macros:: Saving and re-executing typed characters
884 * Miscellaneous Commands:: Other miscellaneous commands.
887 This section describes Readline commands that may be bound to key
890 You can list your key bindings by executing
891 @w{@code{bind -P}} or, for a more terse format, suitable for an
892 @var{inputrc} file, @w{@code{bind -p}}. (@xref{Bash Builtins}.)
894 Command names without an accompanying key sequence are unbound by default.
896 In the following descriptions, @dfn{point} refers to the current cursor
897 position, and @dfn{mark} refers to a cursor position saved by the
898 @code{set-mark} command.
899 The text between the point and mark is referred to as the @dfn{region}.
901 @node Commands For Moving
902 @subsection Commands For Moving
904 @item beginning-of-line (C-a)
905 Move to the start of the current line.
907 @item end-of-line (C-e)
908 Move to the end of the line.
910 @item forward-char (C-f)
911 Move forward a character.
913 @item backward-char (C-b)
914 Move back a character.
916 @item forward-word (M-f)
917 Move forward to the end of the next word. Words are composed of
920 @item backward-word (M-b)
921 Move back to the start of the current or previous word. Words are
922 composed of letters and digits.
924 @item clear-screen (C-l)
925 Clear the screen and redraw the current line,
926 leaving the current line at the top of the screen.
928 @item redraw-current-line ()
929 Refresh the current line. By default, this is unbound.
933 @node Commands For History
934 @subsection Commands For Manipulating The History
937 @item accept-line (Newline or Return)
939 Accept the line regardless of where the cursor is.
941 non-empty, add it to the history list according to the setting of
942 the @env{HISTCONTROL} and @env{HISTIGNORE} variables.
943 If this line is a modified history line, then restore the history line
944 to its original state.
946 @ifclear BashFeatures
947 Accept the line regardless of where the cursor is.
949 non-empty, it may be added to the history list for future recall with
950 @code{add_history()}.
951 If this line is a modified history line, the history line is restored
952 to its original state.
955 @item previous-history (C-p)
956 Move `back' through the history list, fetching the previous command.
958 @item next-history (C-n)
959 Move `forward' through the history list, fetching the next command.
961 @item beginning-of-history (M-<)
962 Move to the first line in the history.
964 @item end-of-history (M->)
965 Move to the end of the input history, i.e., the line currently
968 @item reverse-search-history (C-r)
969 Search backward starting at the current line and moving `up' through
970 the history as necessary. This is an incremental search.
972 @item forward-search-history (C-s)
973 Search forward starting at the current line and moving `down' through
974 the the history as necessary. This is an incremental search.
976 @item non-incremental-reverse-search-history (M-p)
977 Search backward starting at the current line and moving `up'
978 through the history as necessary using a non-incremental search
979 for a string supplied by the user.
981 @item non-incremental-forward-search-history (M-n)
982 Search forward starting at the current line and moving `down'
983 through the the history as necessary using a non-incremental search
984 for a string supplied by the user.
986 @item history-search-forward ()
987 Search forward through the history for the string of characters
988 between the start of the current line and the point.
989 This is a non-incremental search.
990 By default, this command is unbound.
992 @item history-search-backward ()
993 Search backward through the history for the string of characters
994 between the start of the current line and the point. This
995 is a non-incremental search. By default, this command is unbound.
997 @item yank-nth-arg (M-C-y)
998 Insert the first argument to the previous command (usually
999 the second word on the previous line) at point.
1000 With an argument @var{n},
1001 insert the @var{n}th word from the previous command (the words
1002 in the previous command begin with word 0). A negative argument
1003 inserts the @var{n}th word from the end of the previous command.
1005 @item yank-last-arg (M-. or M-_)
1006 Insert last argument to the previous command (the last word of the
1007 previous history entry). With an
1008 argument, behave exactly like @code{yank-nth-arg}.
1009 Successive calls to @code{yank-last-arg} move back through the history
1010 list, inserting the last argument of each line in turn.
1014 @node Commands For Text
1015 @subsection Commands For Changing Text
1018 @item delete-char (C-d)
1019 Delete the character at point. If point is at the
1020 beginning of the line, there are no characters in the line, and
1021 the last character typed was not bound to @code{delete-char}, then
1024 @item backward-delete-char (Rubout)
1025 Delete the character behind the cursor. A numeric argument means
1026 to kill the characters instead of deleting them.
1028 @item forward-backward-delete-char ()
1029 Delete the character under the cursor, unless the cursor is at the
1030 end of the line, in which case the character behind the cursor is
1031 deleted. By default, this is not bound to a key.
1033 @item quoted-insert (C-q or C-v)
1034 Add the next character typed to the line verbatim. This is
1035 how to insert key sequences like @kbd{C-q}, for example.
1037 @ifclear BashFeatures
1038 @item tab-insert (M-@key{TAB})
1039 Insert a tab character.
1042 @item self-insert (a, b, A, 1, !, @dots{})
1045 @item transpose-chars (C-t)
1046 Drag the character before the cursor forward over
1047 the character at the cursor, moving the
1048 cursor forward as well. If the insertion point
1049 is at the end of the line, then this
1050 transposes the last two characters of the line.
1051 Negative arguments have no effect.
1053 @item transpose-words (M-t)
1054 Drag the word before point past the word after point,
1055 moving point past that word as well.
1056 If the insertion point is at the end of the line, this transposes
1057 the last two words on the line.
1059 @item upcase-word (M-u)
1060 Uppercase the current (or following) word. With a negative argument,
1061 uppercase the previous word, but do not move the cursor.
1063 @item downcase-word (M-l)
1064 Lowercase the current (or following) word. With a negative argument,
1065 lowercase the previous word, but do not move the cursor.
1067 @item capitalize-word (M-c)
1068 Capitalize the current (or following) word. With a negative argument,
1069 capitalize the previous word, but do not move the cursor.
1071 @item overwrite-mode ()
1072 Toggle overwrite mode. With an explicit positive numeric argument,
1073 switches to overwrite mode. With an explicit non-positive numeric
1074 argument, switches to insert mode. This command affects only
1075 @code{emacs} mode; @code{vi} mode does overwrite differently.
1076 Each call to @code{readline()} starts in insert mode.
1078 In overwrite mode, characters bound to @code{self-insert} replace
1079 the text at point rather than pushing the text to the right.
1080 Characters bound to @code{backward-delete-char} replace the character
1081 before point with a space.
1083 By default, this command is unbound.
1087 @node Commands For Killing
1088 @subsection Killing And Yanking
1092 @item kill-line (C-k)
1093 Kill the text from point to the end of the line.
1095 @item backward-kill-line (C-x Rubout)
1096 Kill backward to the beginning of the line.
1098 @item unix-line-discard (C-u)
1099 Kill backward from the cursor to the beginning of the current line.
1101 @item kill-whole-line ()
1102 Kill all characters on the current line, no matter where point is.
1103 By default, this is unbound.
1105 @item kill-word (M-d)
1106 Kill from point to the end of the current word, or if between
1107 words, to the end of the next word.
1108 Word boundaries are the same as @code{forward-word}.
1110 @item backward-kill-word (M-@key{DEL})
1111 Kill the word behind point.
1112 Word boundaries are the same as @code{backward-word}.
1114 @item unix-word-rubout (C-w)
1115 Kill the word behind point, using white space as a word boundary.
1116 The killed text is saved on the kill-ring.
1118 @item delete-horizontal-space ()
1119 Delete all spaces and tabs around point. By default, this is unbound.
1121 @item kill-region ()
1122 Kill the text in the current region.
1123 By default, this command is unbound.
1125 @item copy-region-as-kill ()
1126 Copy the text in the region to the kill buffer, so it can be yanked
1127 right away. By default, this command is unbound.
1129 @item copy-backward-word ()
1130 Copy the word before point to the kill buffer.
1131 The word boundaries are the same as @code{backward-word}.
1132 By default, this command is unbound.
1134 @item copy-forward-word ()
1135 Copy the word following point to the kill buffer.
1136 The word boundaries are the same as @code{forward-word}.
1137 By default, this command is unbound.
1140 Yank the top of the kill ring into the buffer at point.
1142 @item yank-pop (M-y)
1143 Rotate the kill-ring, and yank the new top. You can only do this if
1144 the prior command is @code{yank} or @code{yank-pop}.
1147 @node Numeric Arguments
1148 @subsection Specifying Numeric Arguments
1151 @item digit-argument (@kbd{M-0}, @kbd{M-1}, @dots{} @kbd{M--})
1152 Add this digit to the argument already accumulating, or start a new
1153 argument. @kbd{M--} starts a negative argument.
1155 @item universal-argument ()
1156 This is another way to specify an argument.
1157 If this command is followed by one or more digits, optionally with a
1158 leading minus sign, those digits define the argument.
1159 If the command is followed by digits, executing @code{universal-argument}
1160 again ends the numeric argument, but is otherwise ignored.
1161 As a special case, if this command is immediately followed by a
1162 character that is neither a digit or minus sign, the argument count
1163 for the next command is multiplied by four.
1164 The argument count is initially one, so executing this function the
1165 first time makes the argument count four, a second time makes the
1166 argument count sixteen, and so on.
1167 By default, this is not bound to a key.
1170 @node Commands For Completion
1171 @subsection Letting Readline Type For You
1174 @item complete (@key{TAB})
1175 Attempt to perform completion on the text before point.
1176 The actual completion performed is application-specific.
1178 Bash attempts completion treating the text as a variable (if the
1179 text begins with @samp{$}), username (if the text begins with
1180 @samp{~}), hostname (if the text begins with @samp{@@}), or
1181 command (including aliases and functions) in turn. If none
1182 of these produces a match, filename completion is attempted.
1184 @ifclear BashFeatures
1185 The default is filename completion.
1188 @item possible-completions (M-?)
1189 List the possible completions of the text before point.
1191 @item insert-completions (M-*)
1192 Insert all completions of the text before point that would have
1193 been generated by @code{possible-completions}.
1195 @item menu-complete ()
1196 Similar to @code{complete}, but replaces the word to be completed
1197 with a single match from the list of possible completions.
1198 Repeated execution of @code{menu-complete} steps through the list
1199 of possible completions, inserting each match in turn.
1200 At the end of the list of completions, the bell is rung
1201 (subject to the setting of @code{bell-style})
1202 and the original text is restored.
1203 An argument of @var{n} moves @var{n} positions forward in the list
1204 of matches; a negative argument may be used to move backward
1206 This command is intended to be bound to @key{TAB}, but is unbound
1209 @item delete-char-or-list ()
1210 Deletes the character under the cursor if not at the beginning or
1211 end of the line (like @code{delete-char}).
1212 If at the end of the line, behaves identically to
1213 @code{possible-completions}.
1214 This command is unbound by default.
1217 @item complete-filename (M-/)
1218 Attempt filename completion on the text before point.
1220 @item possible-filename-completions (C-x /)
1221 List the possible completions of the text before point,
1222 treating it as a filename.
1224 @item complete-username (M-~)
1225 Attempt completion on the text before point, treating
1228 @item possible-username-completions (C-x ~)
1229 List the possible completions of the text before point,
1230 treating it as a username.
1232 @item complete-variable (M-$)
1233 Attempt completion on the text before point, treating
1234 it as a shell variable.
1236 @item possible-variable-completions (C-x $)
1237 List the possible completions of the text before point,
1238 treating it as a shell variable.
1240 @item complete-hostname (M-@@)
1241 Attempt completion on the text before point, treating
1244 @item possible-hostname-completions (C-x @@)
1245 List the possible completions of the text before point,
1246 treating it as a hostname.
1248 @item complete-command (M-!)
1249 Attempt completion on the text before point, treating
1250 it as a command name. Command completion attempts to
1251 match the text against aliases, reserved words, shell
1252 functions, shell builtins, and finally executable filenames,
1255 @item possible-command-completions (C-x !)
1256 List the possible completions of the text before point,
1257 treating it as a command name.
1259 @item dynamic-complete-history (M-@key{TAB})
1260 Attempt completion on the text before point, comparing
1261 the text against lines from the history list for possible
1264 @item complete-into-braces (M-@{)
1265 Perform filename completion and insert the list of possible completions
1266 enclosed within braces so the list is available to the shell
1267 (@pxref{Brace Expansion}).
1272 @node Keyboard Macros
1273 @subsection Keyboard Macros
1276 @item start-kbd-macro (C-x ()
1277 Begin saving the characters typed into the current keyboard macro.
1279 @item end-kbd-macro (C-x ))
1280 Stop saving the characters typed into the current keyboard macro
1281 and save the definition.
1283 @item call-last-kbd-macro (C-x e)
1284 Re-execute the last keyboard macro defined, by making the characters
1285 in the macro appear as if typed at the keyboard.
1289 @node Miscellaneous Commands
1290 @subsection Some Miscellaneous Commands
1293 @item re-read-init-file (C-x C-r)
1294 Read in the contents of the @var{inputrc} file, and incorporate
1295 any bindings or variable assignments found there.
1298 Abort the current editing command and
1299 ring the terminal's bell (subject to the setting of
1302 @item do-uppercase-version (M-a, M-b, M-@var{x}, @dots{})
1303 If the metafied character @var{x} is lowercase, run the command
1304 that is bound to the corresponding uppercase character.
1306 @item prefix-meta (@key{ESC})
1307 Metafy the next character typed. This is for keyboards
1308 without a meta key. Typing @samp{@key{ESC} f} is equivalent to typing
1311 @item undo (C-_ or C-x C-u)
1312 Incremental undo, separately remembered for each line.
1314 @item revert-line (M-r)
1315 Undo all changes made to this line. This is like executing the @code{undo}
1316 command enough times to get back to the beginning.
1319 @item tilde-expand (M-&)
1321 @ifclear BashFeatures
1322 @item tilde-expand (M-~)
1324 Perform tilde expansion on the current word.
1326 @item set-mark (C-@@)
1327 Set the mark to the point. If a
1328 numeric argument is supplied, the mark is set to that position.
1330 @item exchange-point-and-mark (C-x C-x)
1331 Swap the point with the mark. The current cursor position is set to
1332 the saved position, and the old cursor position is saved as the mark.
1334 @item character-search (C-])
1335 A character is read and point is moved to the next occurrence of that
1336 character. A negative count searches for previous occurrences.
1338 @item character-search-backward (M-C-])
1339 A character is read and point is moved to the previous occurrence
1340 of that character. A negative count searches for subsequent
1343 @item insert-comment (M-#)
1344 Without a numeric argument, the value of the @code{comment-begin}
1345 variable is inserted at the beginning of the current line.
1346 If a numeric argument is supplied, this command acts as a toggle: if
1347 the characters at the beginning of the line do not match the value
1348 of @code{comment-begin}, the value is inserted, otherwise
1349 the characters in @code{comment-begin} are deleted from the beginning of
1351 In either case, the line is accepted as if a newline had been typed.
1353 The default value of @code{comment-begin} causes this command
1354 to make the current line a shell comment.
1355 If a numeric argument causes the comment character to be removed, the line
1356 will be executed by the shell.
1359 @item dump-functions ()
1360 Print all of the functions and their key bindings to the
1361 Readline output stream. If a numeric argument is supplied,
1362 the output is formatted in such a way that it can be made part
1363 of an @var{inputrc} file. This command is unbound by default.
1365 @item dump-variables ()
1366 Print all of the settable variables and their values to the
1367 Readline output stream. If a numeric argument is supplied,
1368 the output is formatted in such a way that it can be made part
1369 of an @var{inputrc} file. This command is unbound by default.
1371 @item dump-macros ()
1372 Print all of the Readline key sequences bound to macros and the
1373 strings they output. If a numeric argument is supplied,
1374 the output is formatted in such a way that it can be made part
1375 of an @var{inputrc} file. This command is unbound by default.
1378 @item glob-complete-word (M-g)
1379 The word before point is treated as a pattern for pathname expansion,
1380 with an asterisk implicitly appended. This pattern is used to
1381 generate a list of matching file names for possible completions.
1383 @item glob-expand-word (C-x *)
1384 The word before point is treated as a pattern for pathname expansion,
1385 and the list of matching file names is inserted, replacing the word.
1386 If a numeric argument is supplied, a @samp{*} is appended before
1389 @item glob-list-expansions (C-x g)
1390 The list of expansions that would have been generated by
1391 @code{glob-expand-word} is displayed, and the line is redrawn.
1392 If a numeric argument is supplied, a @samp{*} is appended before
1395 @item display-shell-version (C-x C-v)
1396 Display version information about the current instance of Bash.
1398 @item shell-expand-line (M-C-e)
1399 Expand the line as the shell does.
1400 This performs alias and history expansion as well as all of the shell
1401 word expansions (@pxref{Shell Expansions}).
1403 @item history-expand-line (M-^)
1404 Perform history expansion on the current line.
1406 @item magic-space ()
1407 Perform history expansion on the current line and insert a space
1408 (@pxref{History Interaction}).
1410 @item alias-expand-line ()
1411 Perform alias expansion on the current line (@pxref{Aliases}).
1413 @item history-and-alias-expand-line ()
1414 Perform history and alias expansion on the current line.
1416 @item insert-last-argument (M-. or M-_)
1417 A synonym for @code{yank-last-arg}.
1419 @item operate-and-get-next (C-o)
1420 Accept the current line for execution and fetch the next line
1421 relative to the current line from the history for editing. Any
1422 argument is ignored.
1424 @item edit-and-execute-command (C-xC-e)
1425 Invoke an editor on the current command line, and execute the result as shell
1427 Bash attempts to invoke
1428 @code{$FCEDIT}, @code{$EDITOR}, and @code{emacs}
1429 as the editor, in that order.
1433 @ifclear BashFeatures
1434 @item emacs-editing-mode (C-e)
1435 When in @code{vi} command mode, this causes a switch to @code{emacs}
1438 @item vi-editing-mode (M-C-j)
1439 When in @code{emacs} editing mode, this causes a switch to @code{vi}
1446 @node Readline vi Mode
1447 @section Readline vi Mode
1449 While the Readline library does not have a full set of @code{vi}
1450 editing functions, it does contain enough to allow simple editing
1451 of the line. The Readline @code{vi} mode behaves as specified in
1452 the @sc{posix} 1003.2 standard.
1455 In order to switch interactively between @code{emacs} and @code{vi}
1456 editing modes, use the @samp{set -o emacs} and @samp{set -o vi}
1457 commands (@pxref{The Set Builtin}).
1459 @ifclear BashFeatures
1460 In order to switch interactively between @code{emacs} and @code{vi}
1461 editing modes, use the command @kbd{M-C-j} (bound to emacs-editing-mode
1462 when in @code{vi} mode and to vi-editing-mode in @code{emacs} mode).
1464 The Readline default is @code{emacs} mode.
1466 When you enter a line in @code{vi} mode, you are already placed in
1467 `insertion' mode, as if you had typed an @samp{i}. Pressing @key{ESC}
1468 switches you into `command' mode, where you can edit the text of the
1469 line with the standard @code{vi} movement keys, move to previous
1470 history lines with @samp{k} and subsequent lines with @samp{j}, and
1474 @node Programmable Completion
1475 @section Programmable Completion
1476 @cindex programmable completion
1478 When word completion is attempted for an argument to a command for
1479 which a completion specification (a @var{compspec}) has been defined
1480 using the @code{complete} builtin (@pxref{Programmable Completion Builtins}),
1481 the programmable completion facilities are invoked.
1483 First, the command name is identified.
1484 If a compspec has been defined for that command, the
1485 compspec is used to generate the list of possible completions for the word.
1486 If the command word is a full pathname, a compspec for the full
1487 pathname is searched for first.
1488 If no compspec is found for the full pathname, an attempt is made to
1489 find a compspec for the portion following the final slash.
1491 Once a compspec has been found, it is used to generate the list of
1493 If a compspec is not found, the default Bash completion
1494 described above (@pxref{Commands For Completion}) is performed.
1496 First, the actions specified by the compspec are used.
1497 Only matches which are prefixed by the word being completed are
1499 When the @option{-f} or @option{-d} option is used for filename or
1500 directory name completion, the shell variable @env{FIGNORE} is
1501 used to filter the matches.
1502 @xref{Bash Variables}, for a description of @env{FIGNORE}.
1504 Any completions specified by a filename expansion pattern to the
1505 @option{-G} option are generated next.
1506 The words generated by the pattern need not match the word being completed.
1507 The @env{GLOBIGNORE} shell variable is not used to filter the matches,
1508 but the @env{FIGNORE} shell variable is used.
1510 Next, the string specified as the argument to the @option{-W} option
1512 The string is first split using the characters in the @env{IFS}
1513 special variable as delimiters.
1514 Shell quoting is honored.
1515 Each word is then expanded using
1516 brace expansion, tilde expansion, parameter and variable expansion,
1517 command substitution, arithmetic expansion, and pathname expansion,
1518 as described above (@pxref{Shell Expansions}).
1519 The results are split using the rules described above
1520 (@pxref{Word Splitting}).
1521 The results of the expansion are prefix-matched against the word being
1522 completed, and the matching words become the possible completions.
1524 After these matches have been generated, any shell function or command
1525 specified with the @option{-F} and @option{-C} options is invoked.
1526 When the command or function is invoked, the @env{COMP_LINE} and
1527 @env{COMP_POINT} variables are assigned values as described above
1528 (@pxref{Bash Variables}).
1529 If a shell function is being invoked, the @env{COMP_WORDS} and
1530 @env{COMP_CWORD} variables are also set.
1531 When the function or command is invoked, the first argument is the
1532 name of the command whose arguments are being completed, the
1533 second argument is the word being completed, and the third argument
1534 is the word preceding the word being completed on the current command line.
1535 No filtering of the generated completions against the word being completed
1536 is performed; the function or command has complete freedom in generating
1539 Any function specified with @option{-F} is invoked first.
1540 The function may use any of the shell facilities, including the
1541 @code{compgen} builtin described below
1542 (@pxref{Programmable Completion Builtins}), to generate the matches.
1543 It must put the possible completions in the @env{COMPREPLY} array
1546 Next, any command specified with the @option{-C} option is invoked
1547 in an environment equivalent to command substitution.
1548 It should print a list of completions, one per line, to
1549 the standard output.
1550 Backslash may be used to escape a newline, if necessary.
1552 After all of the possible completions are generated, any filter
1553 specified with the @option{-X} option is applied to the list.
1554 The filter is a pattern as used for pathname expansion; a @samp{&}
1555 in the pattern is replaced with the text of the word being completed.
1556 A literal @samp{&} may be escaped with a backslash; the backslash
1557 is removed before attempting a match.
1558 Any completion that matches the pattern will be removed from the list.
1559 A leading @samp{!} negates the pattern; in this case any completion
1560 not matching the pattern will be removed.
1562 Finally, any prefix and suffix specified with the @option{-P} and @option{-S}
1563 options are added to each member of the completion list, and the result is
1564 returned to the Readline completion code as the list of possible
1567 If the previously-applied actions do not generate any matches, and the
1568 @option{-o dirnames} option was supplied to @code{complete} when the
1569 compspec was defined, directory name completion is attempted.
1571 By default, if a compspec is found, whatever it generates is returned to
1572 the completion code as the full set of possible completions.
1573 The default Bash completions are not attempted, and the Readline default
1574 of filename completion is disabled.
1575 If the @option{-o default} option was supplied to @code{complete} when the
1576 compspec was defined, Readline's default completion will be performed
1577 if the compspec generates no matches.
1579 When a compspec indicates that directory name completion is desired,
1580 the programmable completion functions force Readline to append a slash
1581 to completed names which are symbolic links to directories, subject to
1582 the value of the @var{mark-directories} Readline variable, regardless
1583 of the setting of the @var{mark-symlinked-directories} Readline variable.
1585 @node Programmable Completion Builtins
1586 @section Programmable Completion Builtins
1587 @cindex completion builtins
1589 Two builtin commands are available to manipulate the programmable completion
1596 @code{compgen [@var{option}] [@var{word}]}
1599 Generate possible completion matches for @var{word} according to
1600 the @var{option}s, which may be any option accepted by the
1602 builtin with the exception of @option{-p} and @option{-r}, and write
1603 the matches to the standard output.
1604 When using the @option{-F} or @option{-C} options, the various shell variables
1605 set by the programmable completion facilities, while available, will not
1608 The matches will be generated in the same way as if the programmable
1609 completion code had generated them directly from a completion specification
1610 with the same flags.
1611 If @var{word} is specified, only those completions matching @var{word}
1614 The return value is true unless an invalid option is supplied, or no
1615 matches were generated.
1620 @code{complete [-abcdefgjksuv] [-o @var{comp-option}] [-A @var{action}] [-G @var{globpat}] [-W @var{wordlist}]
1621 [-P @var{prefix}] [-S @var{suffix}] [-X @var{filterpat}] [-F @var{function}]
1622 [-C @var{command}] @var{name} [@var{name} @dots{}]}
1623 @code{complete -pr [@var{name} @dots{}]}
1626 Specify how arguments to each @var{name} should be completed.
1627 If the @option{-p} option is supplied, or if no options are supplied, existing
1628 completion specifications are printed in a way that allows them to be
1630 The @option{-r} option removes a completion specification for
1631 each @var{name}, or, if no @var{name}s are supplied, all
1632 completion specifications.
1634 The process of applying these completion specifications when word completion
1635 is attempted is described above (@pxref{Programmable Completion}).
1637 Other options, if specified, have the following meanings.
1638 The arguments to the @option{-G}, @option{-W}, and @option{-X} options
1639 (and, if necessary, the @option{-P} and @option{-S} options)
1640 should be quoted to protect them from expansion before the
1641 @code{complete} builtin is invoked.
1645 @item -o @var{comp-option}
1646 The @var{comp-option} controls several aspects of the compspec's behavior
1647 beyond the simple generation of completions.
1648 @var{comp-option} may be one of:
1653 Use Readline's default filename completion if the compspec generates
1657 Perform directory name completion if the compspec generates no matches.
1660 Tell Readline that the compspec generates filenames, so it can perform any
1661 filename\-specific processing (like adding a slash to directory names or
1662 suppressing trailing spaces). This option is intended to be used with
1663 shell functions specified with @option{-F}.
1666 Tell Readline not to append a space (the default) to words completed at
1667 the end of the line.
1670 @item -A @var{action}
1671 The @var{action} may be one of the following to generate a list of possible
1676 Alias names. May also be specified as @option{-a}.
1679 Array variable names.
1682 Readline key binding names (@pxref{Bindable Readline Commands}).
1685 Names of shell builtin commands. May also be specified as @option{-b}.
1688 Command names. May also be specified as @option{-c}.
1691 Directory names. May also be specified as @option{-d}.
1694 Names of disabled shell builtins.
1697 Names of enabled shell builtins.
1700 Names of exported shell variables. May also be specified as @option{-e}.
1703 File names. May also be specified as @option{-f}.
1706 Names of shell functions.
1709 Group names. May also be specified as @option{-g}.
1712 Help topics as accepted by the @code{help} builtin (@pxref{Bash Builtins}).
1715 Hostnames, as taken from the file specified by the
1716 @env{HOSTFILE} shell variable (@pxref{Bash Variables}).
1719 Job names, if job control is active. May also be specified as @option{-j}.
1722 Shell reserved words. May also be specified as @option{-k}.
1725 Names of running jobs, if job control is active.
1728 Service names. May also be specified as @option{-s}.
1731 Valid arguments for the @option{-o} option to the @code{set} builtin
1732 (@pxref{The Set Builtin}).
1735 Shell option names as accepted by the @code{shopt} builtin
1736 (@pxref{Bash Builtins}).
1742 Names of stopped jobs, if job control is active.
1745 User names. May also be specified as @option{-u}.
1748 Names of all shell variables. May also be specified as @option{-v}.
1751 @item -G @var{globpat}
1752 The filename expansion pattern @var{globpat} is expanded to generate
1753 the possible completions.
1755 @item -W @var{wordlist}
1756 The @var{wordlist} is split using the characters in the
1757 @env{IFS} special variable as delimiters, and each resultant word
1759 The possible completions are the members of the resultant list which
1760 match the word being completed.
1762 @item -C @var{command}
1763 @var{command} is executed in a subshell environment, and its output is
1764 used as the possible completions.
1766 @item -F @var{function}
1767 The shell function @var{function} is executed in the current shell
1769 When it finishes, the possible completions are retrieved from the value
1770 of the @env{COMPREPLY} array variable.
1772 @item -X @var{filterpat}
1773 @var{filterpat} is a pattern as used for filename expansion.
1774 It is applied to the list of possible completions generated by the
1775 preceding options and arguments, and each completion matching
1776 @var{filterpat} is removed from the list.
1777 A leading @samp{!} in @var{filterpat} negates the pattern; in this
1778 case, any completion not matching @var{filterpat} is removed.
1780 @item -P @var{prefix}
1781 @var{prefix} is added at the beginning of each possible completion
1782 after all other options have been applied.
1784 @item -S @var{suffix}
1785 @var{suffix} is appended to each possible completion
1786 after all other options have been applied.
1789 The return value is true unless an invalid option is supplied, an option
1790 other than @option{-p} or @option{-r} is supplied without a @var{name}
1791 argument, an attempt is made to remove a completion specification for
1792 a @var{name} for which no specification exists, or
1793 an error occurs adding a completion specification.