which contains both end-user and programmer documentation for the
GNU Readline Library.
-Copyright (C) 1988-1999 Free Software Foundation, Inc.
+Copyright (C) 1988-2000 Free Software Foundation, Inc.
Authored by Brian Fox and Chet Ramey.
The following paragraphs describe the notation used to represent
keystrokes.
-The text @key{C-k} is read as `Control-K' and describes the character
+The text @kbd{C-k} is read as `Control-K' and describes the character
produced when the @key{k} key is pressed while the Control key
is depressed.
-The text @key{M-k} is read as `Meta-K' and describes the character
+The text @kbd{M-k} is read as `Meta-K' and describes the character
produced when the Meta key (if you have one) is depressed, and the @key{k}
key is pressed.
The Meta key is labeled @key{ALT} on many keyboards.
If you do not have a Meta or @key{ALT} key, or another key working as
a Meta key, the identical keystroke can be generated by typing @key{ESC}
-@i{first}, and then typing @key{k}.
+@emph{first}, and then typing @key{k}.
Either process is known as @dfn{metafying} the @key{k} key.
-The text @key{M-C-k} is read as `Meta-Control-k' and describes the
-character produced by @dfn{metafying} @key{C-k}.
+The text @kbd{M-C-k} is read as `Meta-Control-k' and describes the
+character produced by @dfn{metafying} @kbd{C-k}.
In addition, several keys have their own names. Specifically,
@key{DEL}, @key{ESC}, @key{LFD}, @key{SPC}, @key{RET}, and @key{TAB} all
you to retype the majority of the line. Using these editing commands,
you move the cursor to the place that needs correction, and delete or
insert the text of the corrections. Then, when you are satisfied with
-the line, you simply press @key{RETURN}. You do not have to be at the
-end of the line to press @key{RETURN}; the entire line is accepted
+the line, you simply press @key{RET}. You do not have to be at the
+end of the line to press @key{RET}; the entire line is accepted
regardless of the location of the cursor within the line.
@menu
Sometimes you may mistype a character, and
not notice the error until you have typed several other characters. In
-that case, you can type @key{C-b} to move the cursor to the left, and then
+that case, you can type @kbd{C-b} to move the cursor to the left, and then
correct your mistake. Afterwards, you can move the cursor to the right
-with @key{C-f}.
+with @kbd{C-f}.
When you add text in the middle of a line, you will notice that characters
to the right of the cursor are `pushed over' to make room for the text
essentials for editing the text of an input line follows.
@table @asis
-@item @key{C-b}
+@item @kbd{C-b}
Move back one character.
-@item @key{C-f}
+@item @kbd{C-f}
Move forward one character.
@item @key{DEL} or @key{Backspace}
Delete the character to the left of the cursor.
-@item @key{C-d}
+@item @kbd{C-d}
Delete the character underneath the cursor.
@item @w{Printing characters}
Insert the character into the line at the cursor.
-@item @key{C-_} or @key{C-x C-u}
+@item @kbd{C-_} or @kbd{C-x C-u}
Undo the last editing command. You can undo all the way back to an
empty line.
@end table
@noindent
(Depending on your configuration, the @key{Backspace} key be set to
delete the character to the left of the cursor and the @key{DEL} key set
-to delete the character underneath the cursor, like @key{C-d}, rather
+to delete the character underneath the cursor, like @kbd{C-d}, rather
than the character to the left of the cursor.)
@node Readline Movement Commands
The above table describes the most basic keystrokes that you need
in order to do editing of the input line. For your convenience, many
-other commands have been added in addition to @key{C-b}, @key{C-f},
-@key{C-d}, and @key{DEL}. Here are some commands for moving more rapidly
+other commands have been added in addition to @kbd{C-b}, @kbd{C-f},
+@kbd{C-d}, and @key{DEL}. Here are some commands for moving more rapidly
about the line.
-@table @key
+@table @kbd
@item C-a
Move to the start of the line.
@item C-e
Clear the screen, reprinting the current line at the top.
@end table
-Notice how @key{C-f} moves forward a character, while @key{M-f} moves
+Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves
forward a word. It is a loose convention that control keystrokes
operate on characters while meta keystrokes operate on words.
Here is the list of commands for killing text.
-@table @key
+@table @kbd
@item C-k
Kill the text from the current cursor position to the end of the line.
@item M-d
Kill from the cursor to the end of the current word, or, if between
words, to the end of the next word.
-Word boundaries are the same as those used by @key{M-f}.
+Word boundaries are the same as those used by @kbd{M-f}.
-@item M-DEL
+@item M-@key{DEL}
Kill from the cursor the start of the previous word, or, if between
words, to the start of the previous word.
-Word boundaries are the same as those used by @key{M-b}.
+Word boundaries are the same as those used by @kbd{M-b}.
@item C-w
Kill from the cursor to the previous whitespace. This is different than
-@key{M-DEL} because the word boundaries differ.
+@kbd{M-@key{DEL}} because the word boundaries differ.
@end table
Here is how to @dfn{yank} the text back into the line. Yanking
means to copy the most-recently-killed text from the kill buffer.
-@table @key
+@table @kbd
@item C-y
Yank the most recently killed text back into the buffer at the cursor.
@item M-y
Rotate the kill-ring, and yank the new top. You can only do this if
-the prior command is @key{C-y} or @key{M-y}.
+the prior command is @kbd{C-y} or @kbd{M-y}.
@end table
@node Readline Arguments
sign (@samp{-}), then the sign of the argument will be negative. Once
you have typed one meta digit to get the argument started, you can type
the remainder of the digits, and then the command. For example, to give
-the @key{C-d} command an argument of 10, you could type @samp{M-1 0 C-d}.
+the @kbd{C-d} command an argument of 10, you could type @samp{M-1 0 C-d},
+which will delete the next ten characters on the input line.
@node Searching
@subsection Searching for Commands in the History
(@pxref{Bash History Facilities})
@end ifset
for lines containing a specified string.
-There are two search modes: @var{incremental} and @var{non-incremental}.
+There are two search modes: @dfn{incremental} and @dfn{non-incremental}.
Incremental searches begin before the user has finished typing the
search string.
An incremental search requires only as many characters as needed to
find the desired history entry.
To search backward in the history for a particular string, type
-@key{C-r}. Typing @key{C-s} searches forward through the history.
+@kbd{C-r}. Typing @kbd{C-s} searches forward through the history.
The characters present in the value of the @code{isearch-terminators} variable
are used to terminate an incremental search.
If that variable has not been assigned a value, the @key{ESC} and
-@key{C-J} characters will terminate an incremental search.
-@key{C-g} will abort an incremental search and restore the original line.
+@kbd{C-J} characters will terminate an incremental search.
+@kbd{C-g} will abort an incremental search and restore the original line.
When the search is terminated, the history entry containing the
search string becomes the current line.
-To find other matching entries in the history list, type @key{C-r} or
-@key{C-s} as appropriate.
+To find other matching entries in the history list, type @kbd{C-r} or
+@kbd{C-s} as appropriate.
This will search backward or forward in the history for the next
entry matching the search string typed so far.
Any other key sequence bound to a Readline command will terminate
the search and execute that command.
For instance, a @key{RET} will terminate the search and accept
the line, thereby executing the command from the history list.
+A movement command will terminate the search, make the last line found
+the current line, and begin editing.
Non-incremental searches read the entire search string before starting
to search for matching history lines. The search string may be
commands in an @dfn{inputrc} file, conventionally in his home directory.
The name of this
@ifset BashFeatures
-file is taken from the value of the shell variable @code{INPUTRC}. If
+file is taken from the value of the shell variable @env{INPUTRC}. If
@end ifset
@ifclear BashFeatures
-file is taken from the value of the environment variable @code{INPUTRC}. If
+file is taken from the value of the environment variable @env{INPUTRC}. If
@end ifclear
that variable is unset, the default is @file{~/.inputrc}.
@item Variable Settings
You can modify the run-time behavior of Readline by
altering the values of variables in Readline
-using the @code{set} command within the init file. Here is how to
+using the @code{set} command within the init file.
+The syntax is simple:
+
+@example
+set @var{variable} @var{value}
+@end example
+
+@noindent
+Here, for example, is how to
change from the default Emacs-like key binding to use
@code{vi} line editing commands:
set editing-mode vi
@end example
+Variable names and values, where appropriate, are recognized without regard
+to case.
+
@ifset BashFeatures
The @w{@code{bind -V}} command lists the current Readline variable names
and values. @xref{Bash Builtins}.
A great deal of run-time behavior is changeable with the following
variables.
+@cindex variables, readline
@table @code
@item bell-style
asked whether he wants to see the list of possibilities. If the
number of possible completions is greater than this value,
Readline will ask the user whether or not he wishes to view
-them; otherwise, they are simply listed. The default limit is
-@code{100}.
+them; otherwise, they are simply listed.
+This variable must be set to an integer value greater than or equal to 0.
+The default limit is @code{100}.
@item convert-meta
@vindex convert-meta
If set to @samp{on}, Readline will convert characters with the
-eighth bit set to an ASCII key sequence by stripping the eighth
+eighth bit set to an @sc{ascii} key sequence by stripping the eighth
bit and prefixing an @key{ESC} character, converting them to a
meta-prefixed key sequence. The default value is @samp{on}.
@vindex input-meta
@vindex meta-flag
If set to @samp{on}, Readline will enable eight-bit input (it
-will not strip the eighth bit from the characters it reads),
+will not clear the eighth bit in the characters it reads),
regardless of what the terminal claims it can support. The
default value is @samp{off}. The name @code{meta-flag} is a
synonym for this variable.
The string of characters that should terminate an incremental search without
subsequently executing the character as a command (@pxref{Searching}).
If this variable has not been given a value, the characters @key{ESC} and
-@key{C-J} will terminate an incremental search.
+@kbd{C-J} will terminate an incremental search.
@item keymap
@vindex keymap
@code{emacs-meta},
@code{emacs-ctlx},
@code{vi},
+@code{vi-move},
@code{vi-command}, and
@code{vi-insert}.
@code{vi} is equivalent to @code{vi-command}; @code{emacs} is
name, the default keybinding, if any, and a short description of what
the command does.
-Once you know the name of the command, simply place the name of the key
+Once you know the name of the command, simply place on a line
+in the init file the name of the key
you wish to bind the command to, a colon, and then the name of the
-command on a line in the init file. The name of the key
-can be expressed in different ways, depending on which is most
-comfortable for you.
+command. The name of the key
+can be expressed in different ways, depending on what you find most
+comfortable.
+
+In addition to command names, readline allows keys to be bound
+to a string that is inserted when the key is pressed (a @var{macro}).
@ifset BashFeatures
The @w{@code{bind -p}} command displays Readline function names and
Control-o: "> output"
@end example
-In the above example, @key{C-u} is bound to the function
-@code{universal-argument}, and @key{C-o} is bound to run the macro
+In the above example, @kbd{C-u} is bound to the function
+@code{universal-argument},
+@kbd{M-DEL} is bound to the function @code{backward-kill-word}, and
+@kbd{C-o} is bound to run the macro
expressed on the right hand side (that is, to insert the text
@samp{> output} into the line).
+A number of symbolic character names are recognized while
+processing this key binding syntax:
+@var{DEL},
+@var{ESC},
+@var{ESCAPE},
+@var{LFD},
+@var{NEWLINE},
+@var{RET},
+@var{RETURN},
+@var{RUBOUT},
+@var{SPACE},
+@var{SPC},
+and
+@var{TAB}.
+
@item @w{"@var{keyseq}": @var{function-name} or @var{macro}}
@var{keyseq} differs from @var{keyname} above in that strings
denoting an entire key sequence can be specified, by placing
"\e[11~": "Function Key 1"
@end example
-In the above example, @key{C-u} is bound to the function
+In the above example, @kbd{C-u} is again bound to the function
@code{universal-argument} (just as it was in the first example),
-@samp{@key{C-x} @key{C-r}} is bound to the function @code{re-read-init-file},
+@samp{@kbd{C-x} @kbd{C-r}} is bound to the function @code{re-read-init-file},
and @samp{@key{ESC} @key{[} @key{1} @key{1} @key{~}} is bound to insert
the text @samp{Function Key 1}.
@item \v
vertical tab
@item \@var{nnn}
-the character whose @code{ASCII} code is the octal value @var{nnn}
+the character whose @sc{ascii} code is the octal value @var{nnn}
(one to three digits)
@item \x@var{nnn}
-the character whose @code{ASCII} code is the hexadecimal value @var{nnn}
+the character whose @sc{ascii} code is the hexadecimal value @var{nnn}
(one to three digits)
@end table
In the macro body, the backslash escapes described above are expanded.
Backslash will quote any other character in the macro text,
including @samp{"} and @samp{'}.
-For example, the following binding will make @samp{C-x \}
+For example, the following binding will make @samp{@kbd{C-x} \}
insert a single @samp{\} into the line:
@example
"\C-x\\": "\\"
@item application
The @var{application} construct is used to include
application-specific settings. Each program using the Readline
-library sets the @var{application name}, and you can test for it.
+library sets the @var{application name}, and you can test for
+a particular value.
This could be used to bind key sequences to functions useful for
a specific program. For instance, the following command adds a
key sequence that quotes the current or previous word in Bash:
@item $include
This directive takes a single filename as an argument and reads commands
and bindings from that file.
+For example, the following directive reads from @file{/etc/inputrc}:
@example
$include /etc/inputrc
@end example
@node Sample Init File
@subsection Sample Init File
-Here is an example of an inputrc file. This illustrates key
+Here is an example of an @var{inputrc} file. This illustrates key
binding, variable assignment, and conditional syntax.
@example
@w{@code{bind -P}} or, for a more terse format, suitable for an
@var{inputrc} file, @w{@code{bind -p}}. (@xref{Bash Builtins}.)
@end ifset
-
Command names without an accompanying key sequence are unbound by default.
-In the following descriptions, @var{point} refers to the current cursor
-position, and @var{mark} refers to a cursor position saved by the
+
+In the following descriptions, @dfn{point} refers to the current cursor
+position, and @dfn{mark} refers to a cursor position saved by the
@code{set-mark} command.
-The text between the point and mark is referred to as the @var{region}.
+The text between the point and mark is referred to as the @dfn{region}.
@node Commands For Moving
@subsection Commands For Moving
@subsection Commands For Manipulating The History
@ftable @code
-@item accept-line (Newline, Return)
+@item accept-line (Newline or Return)
@ifset BashFeatures
-Accept the line regardless of where the cursor is. If this line is
+Accept the line regardless of where the cursor is.
+If this line is
non-empty, add it to the history list according to the setting of
-the @code{HISTCONTROL} and @code{HISTIGNORE} variables.
-If this line was a history line, then restore the history line to its
-original state.
+the @env{HISTCONTROL} and @env{HISTIGNORE} variables.
+If this line is a modified history line, then restore the history line
+to its original state.
@end ifset
@ifclear BashFeatures
-Accept the line regardless of where the cursor is. If this line is
-non-empty, add it to the history list. If this line was a history
-line, then restore the history line to its original state.
+Accept the line regardless of where the cursor is.
+If this line is
+non-empty, it may be added to the history list for future recall with
+@code{add_history()}.
+If this line is a modified history line, the history line is restored
+to its original state.
@end ifclear
@item previous-history (C-p)
-Move `up' through the history list.
+Move `back' through the history list, fetching the previous command.
@item next-history (C-n)
-Move `down' through the history list.
+Move `forward' through the history list, fetching the next command.
@item beginning-of-history (M-<)
Move to the first line in the history.
@item yank-nth-arg (M-C-y)
Insert the first argument to the previous command (usually
-the second word on the previous line). With an argument @var{n},
+the second word on the previous line) at point.
+With an argument @var{n},
insert the @var{n}th word from the previous command (the words
in the previous command begin with word 0). A negative argument
inserts the @var{n}th word from the end of the previous command.
-@item yank-last-arg (M-., M-_)
+@item yank-last-arg (M-. or M-_)
Insert last argument to the previous command (the last word of the
previous history entry). With an
argument, behave exactly like @code{yank-nth-arg}.
@ftable @code
@item delete-char (C-d)
-Delete the character under the cursor. If the cursor is at the
+Delete the character at point. If point is at the
beginning of the line, there are no characters in the line, and
the last character typed was not bound to @code{delete-char}, then
-return @code{EOF}.
+return @sc{eof}.
@item backward-delete-char (Rubout)
Delete the character behind the cursor. A numeric argument means
end of the line, in which case the character behind the cursor is
deleted. By default, this is not bound to a key.
-@item quoted-insert (C-q, C-v)
+@item quoted-insert (C-q or C-v)
Add the next character typed to the line verbatim. This is
-how to insert key sequences like @key{C-q}, for example.
+how to insert key sequences like @kbd{C-q}, for example.
@ifclear BashFeatures
-@item tab-insert (M-TAB)
+@item tab-insert (M-@key{TAB})
Insert a tab character.
@end ifclear
-@item self-insert (a, b, A, 1, !, ...)
+@item self-insert (a, b, A, 1, !, @dots{})
Insert yourself.
@item transpose-chars (C-t)
Kill backward from the cursor to the beginning of the current line.
@item kill-whole-line ()
-Kill all characters on the current line, no matter point is.
+Kill all characters on the current line, no matter where point is.
By default, this is unbound.
@item kill-word (M-d)
words, to the end of the next word.
Word boundaries are the same as @code{forward-word}.
-@item backward-kill-word (M-DEL)
+@item backward-kill-word (M-@key{DEL})
Kill the word behind point.
Word boundaries are the same as @code{backward-word}.
By default, this command is unbound.
@item yank (C-y)
-Yank the top of the kill ring into the buffer at the current
-cursor position.
+Yank the top of the kill ring into the buffer at point.
@item yank-pop (M-y)
Rotate the kill-ring, and yank the new top. You can only do this if
-the prior command is yank or yank-pop.
+the prior command is @code{yank} or @code{yank-pop}.
@end ftable
@node Numeric Arguments
@subsection Specifying Numeric Arguments
@ftable @code
-@item digit-argument (M-0, M-1, ... M--)
+@item digit-argument (@kbd{M-0}, @kbd{M-1}, @dots{} @kbd{M--})
Add this digit to the argument already accumulating, or start a new
-argument. @key{M--} starts a negative argument.
+argument. @kbd{M--} starts a negative argument.
@item universal-argument ()
This is another way to specify an argument.
@subsection Letting Readline Type For You
@ftable @code
-@item complete (TAB)
-Attempt to do completion on the text before the cursor. This is
-application-specific. Generally, if you are typing a filename
-argument, you can do filename completion; if you are typing a command,
-you can do command completion; if you are typing in a symbol to GDB, you
-can do symbol name completion; if you are typing in a variable to Bash,
-you can do variable name completion, and so on.
+@item complete (@key{TAB})
+Attempt to perform completion on the text before point.
+The actual completion performed is application-specific.
@ifset BashFeatures
Bash attempts completion treating the text as a variable (if the
text begins with @samp{$}), username (if the text begins with
command (including aliases and functions) in turn. If none
of these produces a match, filename completion is attempted.
@end ifset
+@ifclear BashFeatures
+The default is filename completion.
+@end ifclear
@item possible-completions (M-?)
-List the possible completions of the text before the cursor.
+List the possible completions of the text before point.
@item insert-completions (M-*)
Insert all completions of the text before point that would have
with a single match from the list of possible completions.
Repeated execution of @code{menu-complete} steps through the list
of possible completions, inserting each match in turn.
-At the end of the list of completions, the bell is rung and the
-original text is restored.
+At the end of the list of completions, the bell is rung
+(subject to the setting of @code{bell-style})
+and the original text is restored.
An argument of @var{n} moves @var{n} positions forward in the list
of matches; a negative argument may be used to move backward
through the list.
-This command is intended to be bound to @code{TAB}, but is unbound
+This command is intended to be bound to @key{TAB}, but is unbound
by default.
@item delete-char-or-list ()
List the possible completions of the text before point,
treating it as a command name.
-@item dynamic-complete-history (M-TAB)
+@item dynamic-complete-history (M-@key{TAB})
Attempt completion on the text before point, comparing
the text against lines from the history list for possible
completion matches.
If the metafied character @var{x} is lowercase, run the command
that is bound to the corresponding uppercase character.
-@item prefix-meta (ESC)
-Make the next character typed be metafied. This is for keyboards
-without a meta key. Typing @samp{ESC f} is equivalent to typing
-@samp{M-f}.
+@item prefix-meta (@key{ESC})
+Metafy the next character typed. This is for keyboards
+without a meta key. Typing @samp{@key{ESC} f} is equivalent to typing
+@kbd{M-f}.
-@item undo (C-_, C-x C-u)
+@item undo (C-_ or C-x C-u)
Incremental undo, separately remembered for each line.
@item revert-line (M-r)
Perform tilde expansion on the current word.
@item set-mark (C-@@)
-Set the mark to the current point. If a
+Set the mark to the point. If a
numeric argument is supplied, the mark is set to that position.
@item exchange-point-and-mark (C-x C-x)
@item dump-macros ()
Print all of the Readline key sequences bound to macros and the
-strings they ouput. If a numeric argument is supplied,
+strings they output. If a numeric argument is supplied,
the output is formatted in such a way that it can be made part
of an @var{inputrc} file. This command is unbound by default.
@item history-and-alias-expand-line ()
Perform history and alias expansion on the current line.
-@item insert-last-argument (M-., M-_)
+@item insert-last-argument (M-. or M-_)
A synonym for @code{yank-last-arg}.
@item operate-and-get-next (C-o)
While the Readline library does not have a full set of @code{vi}
editing functions, it does contain enough to allow simple editing
of the line. The Readline @code{vi} mode behaves as specified in
-the @sc{POSIX} 1003.2 standard.
+the @sc{posix} 1003.2 standard.
@ifset BashFeatures
In order to switch interactively between @code{emacs} and @code{vi}
@end ifset
@ifclear BashFeatures
In order to switch interactively between @code{emacs} and @code{vi}
-editing modes, use the command M-C-j (toggle-editing-mode).
+editing modes, use the command @kbd{M-C-j} (bound to emacs-editing-mode
+when in @code{vi} mode and to vi-editing-mode in @code{emacs} mode).
@end ifclear
The Readline default is @code{emacs} mode.
First, the actions specified by the compspec are used.
Only matches which are prefixed by the word being completed are
returned.
-When the @samp{-f} or @samp{-d} option is used for filename or
-directory name completion, the shell variable @code{FIGNORE} is
+When the @option{-f} or @option{-d} option is used for filename or
+directory name completion, the shell variable @env{FIGNORE} is
used to filter the matches.
-@xref{Bash Variables}, for a description of @code{FIGNORE}.
+@xref{Bash Variables}, for a description of @env{FIGNORE}.
Any completions specified by a filename expansion pattern to the
-@samp{-G} option are generated next.
+@option{-G} option are generated next.
The words generated by the pattern need not match the word being completed.
-The @code{GLOBIGNORE} shell variable is not used to filter the matches,
-but the @code{FIGNORE} shell variable is used.
+The @env{GLOBIGNORE} shell variable is not used to filter the matches,
+but the @env{FIGNORE} shell variable is used.
-Next, the string specified as the argument to the @samp{-W} option
+Next, the string specified as the argument to the @option{-W} option
is considered.
-The string is first split using the characters in the @code{IFS}
+The string is first split using the characters in the @env{IFS}
special variable as delimiters.
Shell quoting is honored.
Each word is then expanded using
completed, and the matching words become the possible completions.
After these matches have been generated, any shell function or command
-specified with the @samp{-F} and @samp{-C} options is invoked.
-When the command or function is invoked, the @code{COMP_LINE} and
-@code{COMP_POINT} variables are assigned values as described above
+specified with the @option{-F} and @option{-C} options is invoked.
+When the command or function is invoked, the @env{COMP_LINE} and
+@env{COMP_POINT} variables are assigned values as described above
(@pxref{Bash Variables}).
-If a shell function is being invoked, the @code{COMP_WORDS} and
-@code{COMP_CWORD} variables are also set.
+If a shell function is being invoked, the @env{COMP_WORDS} and
+@env{COMP_CWORD} variables are also set.
When the function or command is invoked, the first argument is the
name of the command whose arguments are being completed, the
second argument is the word being completed, and the third argument
is performed; the function or command has complete freedom in generating
the matches.
-Any function specified with @samp{-F} is invoked first.
+Any function specified with @option{-F} is invoked first.
The function may use any of the shell facilities, including the
@code{compgen} builtin described below
(@pxref{Programmable Completion Builtins}), to generate the matches.
-It must put the possible completions in the @code{COMPREPLY} array
+It must put the possible completions in the @env{COMPREPLY} array
variable.
-Next, any command specified with the @samp{-C} option is invoked
+Next, any command specified with the @option{-C} option is invoked
in an environment equivalent to command substitution.
It should print a list of completions, one per line, to
the standard output.
Backslash may be used to escape a newline, if necessary.
After all of the possible completions are generated, any filter
-specified with the @samp{-X} option is applied to the list.
+specified with the @option{-X} option is applied to the list.
The filter is a pattern as used for pathname expansion; a @samp{&}
in the pattern is replaced with the text of the word being completed.
A literal @samp{&} may be escaped with a backslash; the backslash
A leading @samp{!} negates the pattern; in this case any completion
not matching the pattern will be removed.
-Finally, any prefix and suffix specified with the @samp{-P} and @samp{-S}
+Finally, any prefix and suffix specified with the @option{-P} and @option{-S}
options are added to each member of the completion list, and the result is
returned to the Readline completion code as the list of possible
completions.
-If a compspec is found, whatever it generates is returned to the completion
-code as the full set of possible completions.
-The default Bash completions are not attempted, and the Readline
-default of filename completion is disabled.
+If the previously-applied actions do not generate any matches, and the
+@option{-o dirnames} option was supplied to @code{complete} when the
+compspec was defined, directory name completion is attempted.
+
+By default, if a compspec is found, whatever it generates is returned to
+the completion code as the full set of possible completions.
+The default Bash completions are not attempted, and the Readline default
+of filename completion is disabled.
+If the @option{-o default} option was supplied to @code{complete} when the
+compspec was defined, Readline's default completion will be performed
+if the compspec generates no matches.
@node Programmable Completion Builtins
@section Programmable Completion Builtins
Generate possible completion matches for @var{word} according to
the @var{option}s, which may be any option accepted by the
@code{complete}
-builtin with the exception of @samp{-p} and @samp{-r}, and write
+builtin with the exception of @option{-p} and @option{-r}, and write
the matches to the standard output.
-When using the @samp{-F} or @samp{-C} options, the various shell variables
+When using the @option{-F} or @option{-C} options, the various shell variables
set by the programmable completion facilities, while available, will not
have useful values.
@item complete
@btindex complete
@example
-@code{complete [-abcdefjkvu] [-A @var{action}] [-G @var{globpat}] [-W @var{wordlist}]
+@code{complete [-abcdefjkvu] [-o @var{comp-option}] [-A @var{action}] [-G @var{globpat}] [-W @var{wordlist}]
[-P @var{prefix}] [-S @var{suffix}] [-X @var{filterpat}] [-F @var{function}]
[-C @var{command}] @var{name} [@var{name} @dots{}]}
@code{complete -pr [@var{name} @dots{}]}
@end example
Specify how arguments to each @var{name} should be completed.
-If the @samp{-p} option is supplied, or if no options are supplied, existing
+If the @option{-p} option is supplied, or if no options are supplied, existing
completion specifications are printed in a way that allows them to be
reused as input.
-The @samp{-r} option removes a completion specification for
+The @option{-r} option removes a completion specification for
each @var{name}, or, if no @var{name}s are supplied, all
completion specifications.
is attempted is described above (@pxref{Programmable Completion}).
Other options, if specified, have the following meanings.
-The arguments to the @samp{-G}, @samp{-W}, and @samp{-X} options
-(and, if necessary, the @samp{-P} and @samp{-S} options)
+The arguments to the @option{-G}, @option{-W}, and @option{-X} options
+(and, if necessary, the @option{-P} and @option{-S} options)
should be quoted to protect them from expansion before the
@code{complete} builtin is invoked.
+
+@table @code
+@item -o @var{comp-option}
+The @var{comp-option} controls several aspects of the compspec's behavior
+beyond the simple generation of completions.
+@var{comp-option} may be one of:
+
@table @code
+
+@item default
+Use readline's default completion if the compspec generates no matches.
+
+@item dirnames
+Perform directory name completion if the compspec generates no matches.
+
+@item filenames
+Tell Readline that the compspec generates filenames, so it can perform any
+filename\-specific processing (like adding a slash to directory names or
+suppressing trailing spaces). This option is intended to be used with
+shell functions specified with @option{-F}.
+@end table
+
@item -A @var{action}
The @var{action} may be one of the following to generate a list of possible
completions:
@table @code
@item alias
-Alias names. May also be specified as @samp{-a}.
+Alias names. May also be specified as @option{-a}.
@item arrayvar
Array variable names.
Readline key binding names (@pxref{Bindable Readline Commands}).
@item builtin
-Names of shell builtin commands. May also be specified as @samp{-b}.
+Names of shell builtin commands. May also be specified as @option{-b}.
@item command
-Command names. May also be specified as @samp{-c}.
+Command names. May also be specified as @option{-c}.
@item directory
-Directory names. May also be specified as @samp{-d}.
+Directory names. May also be specified as @option{-d}.
@item disabled
Names of disabled shell builtins.
Names of enabled shell builtins.
@item export
-Names of exported shell variables. May also be specified as @samp{-e}.
+Names of exported shell variables. May also be specified as @option{-e}.
@item file
-File names. May also be specified as @samp{-f}.
+File names. May also be specified as @option{-f}.
@item function
Names of shell functions.
@item hostname
Hostnames, as taken from the file specified by the
-@code{HOSTFILE} shell variable (@pxref{Bash Variables}).
+@env{HOSTFILE} shell variable (@pxref{Bash Variables}).
@item job
-Job names, if job control is active. May also be specified as @samp{-j}.
+Job names, if job control is active. May also be specified as @option{-j}.
@item keyword
-Shell reserved words. May also be specified as @samp{-k}.
+Shell reserved words. May also be specified as @option{-k}.
@item running
Names of running jobs, if job control is active.
@item setopt
-Valid arguments for the @samp{-o} option to the @code{set} builtin
+Valid arguments for the @option{-o} option to the @code{set} builtin
(@pxref{The Set Builtin}).
@item shopt
Names of stopped jobs, if job control is active.
@item user
-User names. May also be specified as @samp{-u}.
+User names. May also be specified as @option{-u}.
@item variable
-Names of all shell variables. May also be specified as @samp{-v}.
+Names of all shell variables. May also be specified as @option{-v}.
@end table
@item -G @var{globpat}
@item -W @var{wordlist}
The @var{wordlist} is split using the characters in the
-@code{IFS} special variable as delimiters, and each resultant word
+@env{IFS} special variable as delimiters, and each resultant word
is expanded.
The possible completions are the members of the resultant list which
match the word being completed.
The shell function @var{function} is executed in the current shell
environment.
When it finishes, the possible completions are retrieved from the value
-of the @code{COMPREPLY} array variable.
+of the @env{COMPREPLY} array variable.
@item -X @var{filterpat}
@var{filterpat} is a pattern as used for filename expansion.
@end table
The return value is true unless an invalid option is supplied, an option
-other than @samp{-p} or @samp{-r} is supplied without a @var{name}
+other than @option{-p} or @option{-r} is supplied without a @var{name}
argument, an attempt is made to remove a completion specification for
a @var{name} for which no specification exists, or
an error occurs adding a completion specification.
projects / thirdparty / bash.git / blobdiff