Add the info pages for GDB 6. The inc-hist.texinfo and rluser.texinfo are
[dragonfly.git] / gnu / usr.bin / gdb / gdb / doc / rluser.texinfo
1 @comment $DragonFly: src/gnu/usr.bin/gdb/gdb/doc/Attic/rluser.texinfo,v 1.1 2004/10/24 19:05:39 joerg Exp $
2 @comment %**start of header (This is for running Texinfo on a region.)
3 @setfilename rluser.info
4 @comment %**end of header (This is for running Texinfo on a region.)
5 @setchapternewpage odd
6
7 @ignore
8 This file documents the end user interface to the GNU command line
9 editing features.  It is to be an appendix to manuals for programs which
10 use these features.  There is a document entitled "readline.texinfo"
11 which contains both end-user and programmer documentation for the
12 GNU Readline Library.
13
14 Copyright (C) 1988-2002 Free Software Foundation, Inc.
15
16 Authored by Brian Fox and Chet Ramey.
17
18 Permission is granted to process this file through Tex and print the
19 results, provided the printed document carries copying permission notice
20 identical to this one except for the removal of this paragraph (this
21 paragraph not being relevant to the printed manual).
22
23 Permission is granted to make and distribute verbatim copies of this manual
24 provided the copyright notice and this permission notice are preserved on
25 all copies.
26
27 Permission is granted to copy and distribute modified versions of this
28 manual under the conditions for verbatim copying, provided also that the
29 GNU Copyright statement is available to the distributee, and provided that
30 the entire resulting derived work is distributed under the terms of a
31 permission notice identical to this one.
32
33 Permission is granted to copy and distribute translations of this manual
34 into another language, under the above conditions for modified versions.
35 @end ignore
36
37 @comment If you are including this manual as an appendix, then set the
38 @comment variable readline-appendix.
39
40 @ifclear BashFeatures
41 @defcodeindex bt
42 @end ifclear
43
44 @node Command Line Editing
45 @chapter Command Line Editing
46
47 This chapter describes the basic features of the @sc{gnu}
48 command line editing interface.
49 @ifset BashFeatures
50 Command line editing is provided by the Readline library, which is
51 used by several different programs, including Bash.
52 @end ifset
53
54 @menu
55 * Introduction and Notation::   Notation used in this text.
56 * Readline Interaction::        The minimum set of commands for editing a line.
57 * Readline Init File::          Customizing Readline from a user's view.
58 * Bindable Readline Commands::  A description of most of the Readline commands
59                                 available for binding
60 * Readline vi Mode::            A short description of how to make Readline
61                                 behave like the vi editor.
62 @ifset BashFeatures
63 * Programmable Completion::     How to specify the possible completions for
64                                 a specific command.
65 * Programmable Completion Builtins::    Builtin commands to specify how to
66                                 complete arguments for a particular command.
67 @end ifset
68 @end menu
69
70 @node Introduction and Notation
71 @section Introduction to Line Editing
72
73 The following paragraphs describe the notation used to represent
74 keystrokes.
75
76 The text @kbd{C-k} is read as `Control-K' and describes the character
77 produced when the @key{k} key is pressed while the Control key
78 is depressed.
79
80 The text @kbd{M-k} is read as `Meta-K' and describes the character
81 produced when the Meta key (if you have one) is depressed, and the @key{k}
82 key is pressed.
83 The Meta key is labeled @key{ALT} on many keyboards.
84 On keyboards with two keys labeled @key{ALT} (usually to either side of
85 the space bar), the @key{ALT} on the left side is generally set to
86 work as a Meta key.
87 The @key{ALT} key on the right may also be configured to work as a
88 Meta key or may be configured as some other modifier, such as a
89 Compose key for typing accented characters.
90
91 If you do not have a Meta or @key{ALT} key, or another key working as
92 a Meta key, the identical keystroke can be generated by typing @key{ESC}
93 @emph{first}, and then typing @key{k}.
94 Either process is known as @dfn{metafying} the @key{k} key.
95
96 The text @kbd{M-C-k} is read as `Meta-Control-k' and describes the
97 character produced by @dfn{metafying} @kbd{C-k}.
98
99 In addition, several keys have their own names.  Specifically,
100 @key{DEL}, @key{ESC}, @key{LFD}, @key{SPC}, @key{RET}, and @key{TAB} all
101 stand for themselves when seen in this text, or in an init file
102 (@pxref{Readline Init File}).
103 If your keyboard lacks a @key{LFD} key, typing @key{C-j} will
104 produce the desired character.
105 The @key{RET} key may be labeled @key{Return} or @key{Enter} on
106 some keyboards.
107
108 @node Readline Interaction
109 @section Readline Interaction
110 @cindex interaction, readline
111
112 Often during an interactive session you type in a long line of text,
113 only to notice that the first word on the line is misspelled.  The
114 Readline library gives you a set of commands for manipulating the text
115 as you type it in, allowing you to just fix your typo, and not forcing
116 you to retype the majority of the line.  Using these editing commands,
117 you move the cursor to the place that needs correction, and delete or
118 insert the text of the corrections.  Then, when you are satisfied with
119 the line, you simply press @key{RET}.  You do not have to be at the
120 end of the line to press @key{RET}; the entire line is accepted
121 regardless of the location of the cursor within the line.
122
123 @menu
124 * Readline Bare Essentials::    The least you need to know about Readline.
125 * Readline Movement Commands::  Moving about the input line.
126 * Readline Killing Commands::   How to delete text, and how to get it back!
127 * Readline Arguments::          Giving numeric arguments to commands.
128 * Searching::                   Searching through previous lines.
129 @end menu
130
131 @node Readline Bare Essentials
132 @subsection Readline Bare Essentials
133 @cindex notation, readline
134 @cindex command editing
135 @cindex editing command lines
136
137 In order to enter characters into the line, simply type them.  The typed
138 character appears where the cursor was, and then the cursor moves one
139 space to the right.  If you mistype a character, you can use your
140 erase character to back up and delete the mistyped character.
141
142 Sometimes you may mistype a character, and
143 not notice the error until you have typed several other characters.  In
144 that case, you can type @kbd{C-b} to move the cursor to the left, and then
145 correct your mistake.  Afterwards, you can move the cursor to the right
146 with @kbd{C-f}.
147
148 When you add text in the middle of a line, you will notice that characters
149 to the right of the cursor are `pushed over' to make room for the text
150 that you have inserted.  Likewise, when you delete text behind the cursor,
151 characters to the right of the cursor are `pulled back' to fill in the
152 blank space created by the removal of the text.  A list of the bare
153 essentials for editing the text of an input line follows.
154
155 @table @asis
156 @item @kbd{C-b}
157 Move back one character.
158 @item @kbd{C-f}
159 Move forward one character.
160 @item @key{DEL} or @key{Backspace}
161 Delete the character to the left of the cursor.
162 @item @kbd{C-d}
163 Delete the character underneath the cursor.
164 @item @w{Printing characters}
165 Insert the character into the line at the cursor.
166 @item @kbd{C-_} or @kbd{C-x C-u}
167 Undo the last editing command.  You can undo all the way back to an
168 empty line.
169 @end table
170
171 @noindent
172 (Depending on your configuration, the @key{Backspace} key be set to
173 delete the character to the left of the cursor and the @key{DEL} key set
174 to delete the character underneath the cursor, like @kbd{C-d}, rather
175 than the character to the left of the cursor.)
176
177 @node Readline Movement Commands
178 @subsection Readline Movement Commands
179
180
181 The above table describes the most basic keystrokes that you need
182 in order to do editing of the input line.  For your convenience, many
183 other commands have been added in addition to @kbd{C-b}, @kbd{C-f},
184 @kbd{C-d}, and @key{DEL}.  Here are some commands for moving more rapidly
185 about the line.
186
187 @table @kbd
188 @item C-a
189 Move to the start of the line.
190 @item C-e
191 Move to the end of the line.
192 @item M-f
193 Move forward a word, where a word is composed of letters and digits.
194 @item M-b
195 Move backward a word.
196 @item C-l
197 Clear the screen, reprinting the current line at the top.
198 @end table
199
200 Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves
201 forward a word.  It is a loose convention that control keystrokes
202 operate on characters while meta keystrokes operate on words.
203
204 @node Readline Killing Commands
205 @subsection Readline Killing Commands
206
207 @cindex killing text
208 @cindex yanking text
209
210 @dfn{Killing} text means to delete the text from the line, but to save
211 it away for later use, usually by @dfn{yanking} (re-inserting)
212 it back into the line.
213 (`Cut' and `paste' are more recent jargon for `kill' and `yank'.)
214
215 If the description for a command says that it `kills' text, then you can
216 be sure that you can get the text back in a different (or the same)
217 place later.
218
219 When you use a kill command, the text is saved in a @dfn{kill-ring}.
220 Any number of consecutive kills save all of the killed text together, so
221 that when you yank it back, you get it all.  The kill
222 ring is not line specific; the text that you killed on a previously
223 typed line is available to be yanked back later, when you are typing
224 another line.
225 @cindex kill ring
226
227 Here is the list of commands for killing text.
228
229 @table @kbd
230 @item C-k
231 Kill the text from the current cursor position to the end of the line.
232
233 @item M-d
234 Kill from the cursor to the end of the current word, or, if between
235 words, to the end of the next word.
236 Word boundaries are the same as those used by @kbd{M-f}.
237
238 @item M-@key{DEL}
239 Kill from the cursor the start of the current word, or, if between
240 words, to the start of the previous word.
241 Word boundaries are the same as those used by @kbd{M-b}.
242
243 @item C-w
244 Kill from the cursor to the previous whitespace.  This is different than
245 @kbd{M-@key{DEL}} because the word boundaries differ.
246
247 @end table
248
249 Here is how to @dfn{yank} the text back into the line.  Yanking
250 means to copy the most-recently-killed text from the kill buffer.
251
252 @table @kbd
253 @item C-y
254 Yank the most recently killed text back into the buffer at the cursor.
255
256 @item M-y
257 Rotate the kill-ring, and yank the new top.  You can only do this if
258 the prior command is @kbd{C-y} or @kbd{M-y}.
259 @end table
260
261 @node Readline Arguments
262 @subsection Readline Arguments
263
264 You can pass numeric arguments to Readline commands.  Sometimes the
265 argument acts as a repeat count, other times it is the @i{sign} of the
266 argument that is significant.  If you pass a negative argument to a
267 command which normally acts in a forward direction, that command will
268 act in a backward direction.  For example, to kill text back to the
269 start of the line, you might type @samp{M-- C-k}.
270
271 The general way to pass numeric arguments to a command is to type meta
272 digits before the command.  If the first `digit' typed is a minus
273 sign (@samp{-}), then the sign of the argument will be negative.  Once
274 you have typed one meta digit to get the argument started, you can type
275 the remainder of the digits, and then the command.  For example, to give
276 the @kbd{C-d} command an argument of 10, you could type @samp{M-1 0 C-d},
277 which will delete the next ten characters on the input line.
278
279 @node Searching
280 @subsection Searching for Commands in the History
281
282 Readline provides commands for searching through the command history
283 @ifset BashFeatures
284 (@pxref{Bash History Facilities})
285 @end ifset
286 for lines containing a specified string.
287 There are two search modes:  @dfn{incremental} and @dfn{non-incremental}.
288
289 Incremental searches begin before the user has finished typing the
290 search string.
291 As each character of the search string is typed, Readline displays
292 the next entry from the history matching the string typed so far.
293 An incremental search requires only as many characters as needed to
294 find the desired history entry.
295 To search backward in the history for a particular string, type
296 @kbd{C-r}.  Typing @kbd{C-s} searches forward through the history.
297 The characters present in the value of the @code{isearch-terminators} variable
298 are used to terminate an incremental search.
299 If that variable has not been assigned a value, the @key{ESC} and
300 @kbd{C-J} characters will terminate an incremental search.
301 @kbd{C-g} will abort an incremental search and restore the original line.
302 When the search is terminated, the history entry containing the
303 search string becomes the current line.
304
305 To find other matching entries in the history list, type @kbd{C-r} or
306 @kbd{C-s} as appropriate.
307 This will search backward or forward in the history for the next
308 entry matching the search string typed so far.
309 Any other key sequence bound to a Readline command will terminate
310 the search and execute that command.
311 For instance, a @key{RET} will terminate the search and accept
312 the line, thereby executing the command from the history list.
313 A movement command will terminate the search, make the last line found
314 the current line, and begin editing.
315
316 Readline remembers the last incremental search string.  If two
317 @kbd{C-r}s are typed without any intervening characters defining a new
318 search string, any remembered search string is used.
319
320 Non-incremental searches read the entire search string before starting
321 to search for matching history lines.  The search string may be
322 typed by the user or be part of the contents of the current line.
323
324 @node Readline Init File
325 @section Readline Init File
326 @cindex initialization file, readline
327
328 Although the Readline library comes with a set of Emacs-like
329 keybindings installed by default, it is possible to use a different set
330 of keybindings.
331 Any user can customize programs that use Readline by putting
332 commands in an @dfn{inputrc} file, conventionally in his home directory.
333 The name of this
334 @ifset BashFeatures
335 file is taken from the value of the shell variable @env{INPUTRC}.  If
336 @end ifset
337 @ifclear BashFeatures
338 file is taken from the value of the environment variable @env{INPUTRC}.  If
339 @end ifclear
340 that variable is unset, the default is @file{~/.inputrc}.
341
342 When a program which uses the Readline library starts up, the
343 init file is read, and the key bindings are set.
344
345 In addition, the @code{C-x C-r} command re-reads this init file, thus
346 incorporating any changes that you might have made to it.
347
348 @menu
349 * Readline Init File Syntax::   Syntax for the commands in the inputrc file.
350
351 * Conditional Init Constructs:: Conditional key bindings in the inputrc file.
352
353 * Sample Init File::            An example inputrc file.
354 @end menu
355
356 @node Readline Init File Syntax
357 @subsection Readline Init File Syntax
358
359 There are only a few basic constructs allowed in the
360 Readline init file.  Blank lines are ignored.
361 Lines beginning with a @samp{#} are comments.
362 Lines beginning with a @samp{$} indicate conditional
363 constructs (@pxref{Conditional Init Constructs}).  Other lines
364 denote variable settings and key bindings.
365
366 @table @asis
367 @item Variable Settings
368 You can modify the run-time behavior of Readline by
369 altering the values of variables in Readline
370 using the @code{set} command within the init file.
371 The syntax is simple:
372
373 @example
374 set @var{variable} @var{value}
375 @end example
376
377 @noindent
378 Here, for example, is how to
379 change from the default Emacs-like key binding to use
380 @code{vi} line editing commands:
381
382 @example
383 set editing-mode vi
384 @end example
385
386 Variable names and values, where appropriate, are recognized without regard
387 to case. 
388
389 @ifset BashFeatures
390 The @w{@code{bind -V}} command lists the current Readline variable names
391 and values.  @xref{Bash Builtins}.
392 @end ifset
393
394 A great deal of run-time behavior is changeable with the following
395 variables.
396
397 @cindex variables, readline
398 @table @code
399
400 @item bell-style
401 @vindex bell-style
402 Controls what happens when Readline wants to ring the terminal bell.
403 If set to @samp{none}, Readline never rings the bell.  If set to
404 @samp{visible}, Readline uses a visible bell if one is available.
405 If set to @samp{audible} (the default), Readline attempts to ring
406 the terminal's bell.
407
408 @item comment-begin
409 @vindex comment-begin
410 The string to insert at the beginning of the line when the
411 @code{insert-comment} command is executed.  The default value
412 is @code{"#"}.
413
414 @item completion-ignore-case
415 If set to @samp{on}, Readline performs filename matching and completion
416 in a case-insensitive fashion.
417 The default value is @samp{off}.
418
419 @item completion-query-items
420 @vindex completion-query-items
421 The number of possible completions that determines when the user is
422 asked whether he wants to see the list of possibilities.  If the
423 number of possible completions is greater than this value,
424 Readline will ask the user whether or not he wishes to view
425 them; otherwise, they are simply listed.
426 This variable must be set to an integer value greater than or equal to 0.
427 The default limit is @code{100}.
428
429 @item convert-meta
430 @vindex convert-meta
431 If set to @samp{on}, Readline will convert characters with the
432 eighth bit set to an @sc{ascii} key sequence by stripping the eighth
433 bit and prefixing an @key{ESC} character, converting them to a
434 meta-prefixed key sequence.  The default value is @samp{on}.
435
436 @item disable-completion
437 @vindex disable-completion
438 If set to @samp{On}, Readline will inhibit word completion.
439 Completion  characters will be inserted into the line as if they had
440 been mapped to @code{self-insert}.  The default is @samp{off}.
441
442 @item editing-mode
443 @vindex editing-mode
444 The @code{editing-mode} variable controls which default set of
445 key bindings is used.  By default, Readline starts up in Emacs editing
446 mode, where the keystrokes are most similar to Emacs.  This variable can be
447 set to either @samp{emacs} or @samp{vi}.
448
449 @item enable-keypad
450 @vindex enable-keypad
451 When set to @samp{on}, Readline will try to enable the application
452 keypad when it is called.  Some systems need this to enable the
453 arrow keys.  The default is @samp{off}.
454
455 @item expand-tilde
456 @vindex expand-tilde
457 If set to @samp{on}, tilde expansion is performed when Readline
458 attempts word completion.  The default is @samp{off}.
459
460 @vindex history-preserve-point
461 If set to @samp{on}, the history code attempts to place point at the
462 same location on each history line retrived with @code{previous-history}
463 or @code{next-history}.
464
465 @item horizontal-scroll-mode
466 @vindex horizontal-scroll-mode
467 This variable can be set to either @samp{on} or @samp{off}.  Setting it
468 to @samp{on} means that the text of the lines being edited will scroll
469 horizontally on a single screen line when they are longer than the width
470 of the screen, instead of wrapping onto a new screen line.  By default,
471 this variable is set to @samp{off}.
472
473 @item input-meta
474 @vindex input-meta
475 @vindex meta-flag
476 If set to @samp{on}, Readline will enable eight-bit input (it
477 will not clear the eighth bit in the characters it reads),
478 regardless of what the terminal claims it can support.  The
479 default value is @samp{off}.  The name @code{meta-flag} is a
480 synonym for this variable.
481
482 @item isearch-terminators
483 @vindex isearch-terminators
484 The string of characters that should terminate an incremental search without
485 subsequently executing the character as a command (@pxref{Searching}).
486 If this variable has not been given a value, the characters @key{ESC} and
487 @kbd{C-J} will terminate an incremental search.
488
489 @item keymap
490 @vindex keymap
491 Sets Readline's idea of the current keymap for key binding commands.
492 Acceptable @code{keymap} names are
493 @code{emacs},
494 @code{emacs-standard},
495 @code{emacs-meta},
496 @code{emacs-ctlx},
497 @code{vi},
498 @code{vi-move},
499 @code{vi-command}, and
500 @code{vi-insert}.
501 @code{vi} is equivalent to @code{vi-command}; @code{emacs} is
502 equivalent to @code{emacs-standard}.  The default value is @code{emacs}.
503 The value of the @code{editing-mode} variable also affects the
504 default keymap.
505
506 @item mark-directories
507 If set to @samp{on}, completed directory names have a slash
508 appended.  The default is @samp{on}.
509
510 @item mark-modified-lines
511 @vindex mark-modified-lines
512 This variable, when set to @samp{on}, causes Readline to display an
513 asterisk (@samp{*}) at the start of history lines which have been modified.
514 This variable is @samp{off} by default.
515
516 @item mark-symlinked-directories
517 @vindex mark-symlinked-directories
518 If set to @samp{on}, completed names which are symbolic links
519 to directories have a slash appended (subject to the value of
520 @code{mark-directories}).
521 The default is @samp{off}.
522
523 @item match-hidden-files
524 @vindex match-hidden-files
525 This variable, when set to @samp{on}, causes Readline to match files whose
526 names begin with a @samp{.} (hidden files) when performing filename
527 completion, unless the leading @samp{.} is
528 supplied by the user in the filename to be completed.
529 This variable is @samp{on} by default.
530
531 @item output-meta
532 @vindex output-meta
533 If set to @samp{on}, Readline will display characters with the
534 eighth bit set directly rather than as a meta-prefixed escape
535 sequence.  The default is @samp{off}.
536
537 @item page-completions
538 @vindex page-completions
539 If set to @samp{on}, Readline uses an internal @code{more}-like pager
540 to display a screenful of possible completions at a time.
541 This variable is @samp{on} by default.
542
543 @item print-completions-horizontally
544 If set to @samp{on}, Readline will display completions with matches
545 sorted horizontally in alphabetical order, rather than down the screen.
546 The default is @samp{off}.
547
548 @item show-all-if-ambiguous
549 @vindex show-all-if-ambiguous
550 This alters the default behavior of the completion functions.  If
551 set to @samp{on}, 
552 words which have more than one possible completion cause the
553 matches to be listed immediately instead of ringing the bell.
554 The default value is @samp{off}.
555
556 @item visible-stats
557 @vindex visible-stats
558 If set to @samp{on}, a character denoting a file's type
559 is appended to the filename when listing possible
560 completions.  The default is @samp{off}.
561
562 @end table
563
564 @item Key Bindings
565 The syntax for controlling key bindings in the init file is
566 simple.  First you need to find the name of the command that you
567 want to change.  The following sections contain tables of the command
568 name, the default keybinding, if any, and a short description of what
569 the command does.
570
571 Once you know the name of the command, simply place on a line
572 in the init file the name of the key
573 you wish to bind the command to, a colon, and then the name of the
574 command.  The name of the key
575 can be expressed in different ways, depending on what you find most
576 comfortable.
577
578 In addition to command names, readline allows keys to be bound
579 to a string that is inserted when the key is pressed (a @var{macro}).
580
581 @ifset BashFeatures
582 The @w{@code{bind -p}} command displays Readline function names and
583 bindings in a format that can put directly into an initialization file.
584 @xref{Bash Builtins}.
585 @end ifset
586
587 @table @asis
588 @item @w{@var{keyname}: @var{function-name} or @var{macro}}
589 @var{keyname} is the name of a key spelled out in English.  For example:
590 @example
591 Control-u: universal-argument
592 Meta-Rubout: backward-kill-word
593 Control-o: "> output"
594 @end example
595
596 In the above example, @kbd{C-u} is bound to the function
597 @code{universal-argument},
598 @kbd{M-DEL} is bound to the function @code{backward-kill-word}, and
599 @kbd{C-o} is bound to run the macro
600 expressed on the right hand side (that is, to insert the text
601 @samp{> output} into the line).
602
603 A number of symbolic character names are recognized while
604 processing this key binding syntax:
605 @var{DEL},
606 @var{ESC},
607 @var{ESCAPE},
608 @var{LFD},
609 @var{NEWLINE},
610 @var{RET},
611 @var{RETURN},
612 @var{RUBOUT},
613 @var{SPACE},
614 @var{SPC},
615 and
616 @var{TAB}.
617
618 @item @w{"@var{keyseq}": @var{function-name} or @var{macro}}
619 @var{keyseq} differs from @var{keyname} above in that strings
620 denoting an entire key sequence can be specified, by placing
621 the key sequence in double quotes.  Some @sc{gnu} Emacs style key
622 escapes can be used, as in the following example, but the
623 special character names are not recognized.
624
625 @example
626 "\C-u": universal-argument
627 "\C-x\C-r": re-read-init-file
628 "\e[11~": "Function Key 1"
629 @end example
630
631 In the above example, @kbd{C-u} is again bound to the function
632 @code{universal-argument} (just as it was in the first example),
633 @samp{@kbd{C-x} @kbd{C-r}} is bound to the function @code{re-read-init-file},
634 and @samp{@key{ESC} @key{[} @key{1} @key{1} @key{~}} is bound to insert
635 the text @samp{Function Key 1}.
636
637 @end table
638
639 The following @sc{gnu} Emacs style escape sequences are available when
640 specifying key sequences:
641
642 @table @code
643 @item @kbd{\C-}
644 control prefix
645 @item @kbd{\M-}
646 meta prefix
647 @item @kbd{\e}
648 an escape character
649 @item @kbd{\\}
650 backslash
651 @item @kbd{\"}
652 @key{"}, a double quotation mark
653 @item @kbd{\'}
654 @key{'}, a single quote or apostrophe
655 @end table
656
657 In addition to the @sc{gnu} Emacs style escape sequences, a second
658 set of backslash escapes is available:
659
660 @table @code
661 @item \a
662 alert (bell)
663 @item \b
664 backspace
665 @item \d
666 delete
667 @item \f
668 form feed
669 @item \n
670 newline
671 @item \r
672 carriage return
673 @item \t
674 horizontal tab
675 @item \v
676 vertical tab
677 @item \@var{nnn}
678 the eight-bit character whose value is the octal value @var{nnn}
679 (one to three digits)
680 @item \x@var{HH}
681 the eight-bit character whose value is the hexadecimal value @var{HH}
682 (one or two hex digits)
683 @end table
684
685 When entering the text of a macro, single or double quotes must
686 be used to indicate a macro definition.
687 Unquoted text is assumed to be a function name.
688 In the macro body, the backslash escapes described above are expanded.
689 Backslash will quote any other character in the macro text,
690 including @samp{"} and @samp{'}.
691 For example, the following binding will make @samp{@kbd{C-x} \}
692 insert a single @samp{\} into the line:
693 @example
694 "\C-x\\": "\\"
695 @end example
696
697 @end table
698
699 @node Conditional Init Constructs
700 @subsection Conditional Init Constructs
701
702 Readline implements a facility similar in spirit to the conditional
703 compilation features of the C preprocessor which allows key
704 bindings and variable settings to be performed as the result
705 of tests.  There are four parser directives used.
706
707 @table @code
708 @item $if
709 The @code{$if} construct allows bindings to be made based on the
710 editing mode, the terminal being used, or the application using
711 Readline.  The text of the test extends to the end of the line;
712 no characters are required to isolate it.
713
714 @table @code
715 @item mode
716 The @code{mode=} form of the @code{$if} directive is used to test
717 whether Readline is in @code{emacs} or @code{vi} mode.
718 This may be used in conjunction
719 with the @samp{set keymap} command, for instance, to set bindings in
720 the @code{emacs-standard} and @code{emacs-ctlx} keymaps only if
721 Readline is starting out in @code{emacs} mode.
722
723 @item term
724 The @code{term=} form may be used to include terminal-specific
725 key bindings, perhaps to bind the key sequences output by the
726 terminal's function keys.  The word on the right side of the
727 @samp{=} is tested against both the full name of the terminal and
728 the portion of the terminal name before the first @samp{-}.  This
729 allows @code{sun} to match both @code{sun} and @code{sun-cmd},
730 for instance.
731
732 @item application
733 The @var{application} construct is used to include
734 application-specific settings.  Each program using the Readline
735 library sets the @var{application name}, and you can test for
736 a particular value. 
737 This could be used to bind key sequences to functions useful for
738 a specific program.  For instance, the following command adds a
739 key sequence that quotes the current or previous word in Bash:
740 @example
741 $if Bash
742 # Quote the current or previous word
743 "\C-xq": "\eb\"\ef\""
744 $endif
745 @end example
746 @end table
747
748 @item $endif
749 This command, as seen in the previous example, terminates an
750 @code{$if} command.
751
752 @item $else
753 Commands in this branch of the @code{$if} directive are executed if
754 the test fails.
755
756 @item $include
757 This directive takes a single filename as an argument and reads commands
758 and bindings from that file.
759 For example, the following directive reads from @file{/etc/inputrc}:
760 @example
761 $include /etc/inputrc
762 @end example
763 @end table
764
765 @node Sample Init File
766 @subsection Sample Init File
767
768 Here is an example of an @var{inputrc} file.  This illustrates key
769 binding, variable assignment, and conditional syntax.
770
771 @example
772 @page
773 # This file controls the behaviour of line input editing for
774 # programs that use the GNU Readline library.  Existing
775 # programs include FTP, Bash, and GDB.
776 #
777 # You can re-read the inputrc file with C-x C-r.
778 # Lines beginning with '#' are comments.
779 #
780 # First, include any systemwide bindings and variable
781 # assignments from /etc/Inputrc
782 $include /etc/Inputrc
783
784 #
785 # Set various bindings for emacs mode.
786
787 set editing-mode emacs 
788
789 $if mode=emacs
790
791 Meta-Control-h: backward-kill-word      Text after the function name is ignored
792
793 #
794 # Arrow keys in keypad mode
795 #
796 #"\M-OD":        backward-char
797 #"\M-OC":        forward-char
798 #"\M-OA":        previous-history
799 #"\M-OB":        next-history
800 #
801 # Arrow keys in ANSI mode
802 #
803 "\M-[D":        backward-char
804 "\M-[C":        forward-char
805 "\M-[A":        previous-history
806 "\M-[B":        next-history
807 #
808 # Arrow keys in 8 bit keypad mode
809 #
810 #"\M-\C-OD":       backward-char
811 #"\M-\C-OC":       forward-char
812 #"\M-\C-OA":       previous-history
813 #"\M-\C-OB":       next-history
814 #
815 # Arrow keys in 8 bit ANSI mode
816 #
817 #"\M-\C-[D":       backward-char
818 #"\M-\C-[C":       forward-char
819 #"\M-\C-[A":       previous-history
820 #"\M-\C-[B":       next-history
821
822 C-q: quoted-insert
823
824 $endif
825
826 # An old-style binding.  This happens to be the default.
827 TAB: complete
828
829 # Macros that are convenient for shell interaction
830 $if Bash
831 # edit the path
832 "\C-xp": "PATH=$@{PATH@}\e\C-e\C-a\ef\C-f"
833 # prepare to type a quoted word --
834 # insert open and close double quotes
835 # and move to just after the open quote
836 "\C-x\"": "\"\"\C-b"
837 # insert a backslash (testing backslash escapes
838 # in sequences and macros)
839 "\C-x\\": "\\"
840 # Quote the current or previous word
841 "\C-xq": "\eb\"\ef\""
842 # Add a binding to refresh the line, which is unbound
843 "\C-xr": redraw-current-line
844 # Edit variable on current line.
845 "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
846 $endif
847
848 # use a visible bell if one is available
849 set bell-style visible
850
851 # don't strip characters to 7 bits when reading
852 set input-meta on
853
854 # allow iso-latin1 characters to be inserted rather
855 # than converted to prefix-meta sequences
856 set convert-meta off
857
858 # display characters with the eighth bit set directly
859 # rather than as meta-prefixed characters
860 set output-meta on
861
862 # if there are more than 150 possible completions for
863 # a word, ask the user if he wants to see all of them
864 set completion-query-items 150
865
866 # For FTP
867 $if Ftp
868 "\C-xg": "get \M-?"
869 "\C-xt": "put \M-?"
870 "\M-.": yank-last-arg
871 $endif
872 @end example
873
874 @node Bindable Readline Commands
875 @section Bindable Readline Commands
876
877 @menu
878 * Commands For Moving::         Moving about the line.
879 * Commands For History::        Getting at previous lines.
880 * Commands For Text::           Commands for changing text.
881 * Commands For Killing::        Commands for killing and yanking.
882 * Numeric Arguments::           Specifying numeric arguments, repeat counts.
883 * Commands For Completion::     Getting Readline to do the typing for you.
884 * Keyboard Macros::             Saving and re-executing typed characters
885 * Miscellaneous Commands::      Other miscellaneous commands.
886 @end menu
887
888 This section describes Readline commands that may be bound to key
889 sequences.
890 @ifset BashFeatures
891 You can list your key bindings by executing
892 @w{@code{bind -P}} or, for a more terse format, suitable for an
893 @var{inputrc} file, @w{@code{bind -p}}.  (@xref{Bash Builtins}.)
894 @end ifset
895 Command names without an accompanying key sequence are unbound by default.
896
897 In the following descriptions, @dfn{point} refers to the current cursor
898 position, and @dfn{mark} refers to a cursor position saved by the
899 @code{set-mark} command.
900 The text between the point and mark is referred to as the @dfn{region}.
901
902 @node Commands For Moving
903 @subsection Commands For Moving
904 @ftable @code
905 @item beginning-of-line (C-a)
906 Move to the start of the current line.
907
908 @item end-of-line (C-e)
909 Move to the end of the line.
910
911 @item forward-char (C-f)
912 Move forward a character.
913
914 @item backward-char (C-b)
915 Move back a character.
916
917 @item forward-word (M-f)
918 Move forward to the end of the next word.  Words are composed of
919 letters and digits.
920
921 @item backward-word (M-b)
922 Move back to the start of the current or previous word.  Words are
923 composed of letters and digits.
924
925 @item clear-screen (C-l)
926 Clear the screen and redraw the current line,
927 leaving the current line at the top of the screen.
928
929 @item redraw-current-line ()
930 Refresh the current line.  By default, this is unbound.
931
932 @end ftable
933
934 @node Commands For History
935 @subsection Commands For Manipulating The History
936
937 @ftable @code
938 @item accept-line (Newline or Return)
939 @ifset BashFeatures
940 Accept the line regardless of where the cursor is.
941 If this line is
942 non-empty, add it to the history list according to the setting of
943 the @env{HISTCONTROL} and @env{HISTIGNORE} variables.
944 If this line is a modified history line, then restore the history line
945 to its original state.
946 @end ifset
947 @ifclear BashFeatures
948 Accept the line regardless of where the cursor is.
949 If this line is
950 non-empty, it may be added to the history list for future recall with
951 @code{add_history()}.
952 If this line is a modified history line, the history line is restored
953 to its original state.
954 @end ifclear
955
956 @item previous-history (C-p)
957 Move `back' through the history list, fetching the previous command.
958
959 @item next-history (C-n)
960 Move `forward' through the history list, fetching the next command.
961
962 @item beginning-of-history (M-<)
963 Move to the first line in the history.
964
965 @item end-of-history (M->)
966 Move to the end of the input history, i.e., the line currently
967 being entered.
968
969 @item reverse-search-history (C-r)
970 Search backward starting at the current line and moving `up' through
971 the history as necessary.  This is an incremental search.
972
973 @item forward-search-history (C-s)
974 Search forward starting at the current line and moving `down' through
975 the the history as necessary.  This is an incremental search.
976
977 @item non-incremental-reverse-search-history (M-p)
978 Search backward starting at the current line and moving `up'
979 through the history as necessary using a non-incremental search
980 for a string supplied by the user.
981
982 @item non-incremental-forward-search-history (M-n)
983 Search forward starting at the current line and moving `down'
984 through the the history as necessary using a non-incremental search
985 for a string supplied by the user.
986
987 @item history-search-forward ()
988 Search forward through the history for the string of characters
989 between the start of the current line and the point.
990 This is a non-incremental search.
991 By default, this command is unbound.
992
993 @item history-search-backward ()
994 Search backward through the history for the string of characters
995 between the start of the current line and the point.  This
996 is a non-incremental search.  By default, this command is unbound.
997
998 @item yank-nth-arg (M-C-y)
999 Insert the first argument to the previous command (usually
1000 the second word on the previous line) at point.
1001 With an argument @var{n},
1002 insert the @var{n}th word from the previous command (the words
1003 in the previous command begin with word 0).  A negative argument
1004 inserts the @var{n}th word from the end of the previous command.
1005
1006 @item yank-last-arg (M-. or M-_)
1007 Insert last argument to the previous command (the last word of the
1008 previous history entry).  With an
1009 argument, behave exactly like @code{yank-nth-arg}.
1010 Successive calls to @code{yank-last-arg} move back through the history
1011 list, inserting the last argument of each line in turn.
1012
1013 @end ftable
1014
1015 @node Commands For Text
1016 @subsection Commands For Changing Text
1017
1018 @ftable @code
1019 @item delete-char (C-d)
1020 Delete the character at point.  If point is at the
1021 beginning of the line, there are no characters in the line, and
1022 the last character typed was not bound to @code{delete-char}, then
1023 return @sc{eof}.
1024
1025 @item backward-delete-char (Rubout)
1026 Delete the character behind the cursor.  A numeric argument means
1027 to kill the characters instead of deleting them.
1028
1029 @item forward-backward-delete-char ()
1030 Delete the character under the cursor, unless the cursor is at the
1031 end of the line, in which case the character behind the cursor is
1032 deleted.  By default, this is not bound to a key.
1033
1034 @item quoted-insert (C-q or C-v)
1035 Add the next character typed to the line verbatim.  This is
1036 how to insert key sequences like @kbd{C-q}, for example.
1037
1038 @ifclear BashFeatures
1039 @item tab-insert (M-@key{TAB})
1040 Insert a tab character.
1041 @end ifclear
1042
1043 @item self-insert (a, b, A, 1, !, @dots{})
1044 Insert yourself.
1045
1046 @item transpose-chars (C-t)
1047 Drag the character before the cursor forward over
1048 the character at the cursor, moving the
1049 cursor forward as well.  If the insertion point
1050 is at the end of the line, then this
1051 transposes the last two characters of the line.
1052 Negative arguments have no effect.
1053
1054 @item transpose-words (M-t)
1055 Drag the word before point past the word after point,
1056 moving point past that word as well.
1057 If the insertion point is at the end of the line, this transposes
1058 the last two words on the line.
1059
1060 @item upcase-word (M-u)
1061 Uppercase the current (or following) word.  With a negative argument,
1062 uppercase the previous word, but do not move the cursor.
1063
1064 @item downcase-word (M-l)
1065 Lowercase the current (or following) word.  With a negative argument,
1066 lowercase the previous word, but do not move the cursor.
1067
1068 @item capitalize-word (M-c)
1069 Capitalize the current (or following) word.  With a negative argument,
1070 capitalize the previous word, but do not move the cursor.
1071
1072 @item overwrite-mode ()
1073 Toggle overwrite mode.  With an explicit positive numeric argument,
1074 switches to overwrite mode.  With an explicit non-positive numeric
1075 argument, switches to insert mode.  This command affects only
1076 @code{emacs} mode; @code{vi} mode does overwrite differently.
1077 Each call to @code{readline()} starts in insert mode.
1078
1079 In overwrite mode, characters bound to @code{self-insert} replace
1080 the text at point rather than pushing the text to the right.
1081 Characters bound to @code{backward-delete-char} replace the character
1082 before point with a space.
1083
1084 By default, this command is unbound.
1085
1086 @end ftable
1087
1088 @node Commands For Killing
1089 @subsection Killing And Yanking
1090
1091 @ftable @code
1092
1093 @item kill-line (C-k)
1094 Kill the text from point to the end of the line.
1095
1096 @item backward-kill-line (C-x Rubout)
1097 Kill backward to the beginning of the line.
1098
1099 @item unix-line-discard (C-u)
1100 Kill backward from the cursor to the beginning of the current line.
1101
1102 @item kill-whole-line ()
1103 Kill all characters on the current line, no matter where point is.
1104 By default, this is unbound.
1105
1106 @item kill-word (M-d)
1107 Kill from point to the end of the current word, or if between
1108 words, to the end of the next word.
1109 Word boundaries are the same as @code{forward-word}.
1110
1111 @item backward-kill-word (M-@key{DEL})
1112 Kill the word behind point.
1113 Word boundaries are the same as @code{backward-word}.
1114
1115 @item unix-word-rubout (C-w)
1116 Kill the word behind point, using white space as a word boundary.
1117 The killed text is saved on the kill-ring.
1118
1119 @item delete-horizontal-space ()
1120 Delete all spaces and tabs around point.  By default, this is unbound.
1121
1122 @item kill-region ()
1123 Kill the text in the current region.
1124 By default, this command is unbound.
1125
1126 @item copy-region-as-kill ()
1127 Copy the text in the region to the kill buffer, so it can be yanked
1128 right away.  By default, this command is unbound.
1129
1130 @item copy-backward-word ()
1131 Copy the word before point to the kill buffer.
1132 The word boundaries are the same as @code{backward-word}.
1133 By default, this command is unbound.
1134
1135 @item copy-forward-word ()
1136 Copy the word following point to the kill buffer.
1137 The word boundaries are the same as @code{forward-word}.
1138 By default, this command is unbound.
1139
1140 @item yank (C-y)
1141 Yank the top of the kill ring into the buffer at point.
1142
1143 @item yank-pop (M-y)
1144 Rotate the kill-ring, and yank the new top.  You can only do this if
1145 the prior command is @code{yank} or @code{yank-pop}.
1146 @end ftable
1147
1148 @node Numeric Arguments
1149 @subsection Specifying Numeric Arguments
1150 @ftable @code
1151
1152 @item digit-argument (@kbd{M-0}, @kbd{M-1}, @dots{} @kbd{M--})
1153 Add this digit to the argument already accumulating, or start a new
1154 argument.  @kbd{M--} starts a negative argument.
1155
1156 @item universal-argument ()
1157 This is another way to specify an argument.
1158 If this command is followed by one or more digits, optionally with a
1159 leading minus sign, those digits define the argument.
1160 If the command is followed by digits, executing @code{universal-argument}
1161 again ends the numeric argument, but is otherwise ignored.
1162 As a special case, if this command is immediately followed by a
1163 character that is neither a digit or minus sign, the argument count
1164 for the next command is multiplied by four.
1165 The argument count is initially one, so executing this function the
1166 first time makes the argument count four, a second time makes the
1167 argument count sixteen, and so on.
1168 By default, this is not bound to a key.
1169 @end ftable
1170
1171 @node Commands For Completion
1172 @subsection Letting Readline Type For You
1173
1174 @ftable @code
1175 @item complete (@key{TAB})
1176 Attempt to perform completion on the text before point.
1177 The actual completion performed is application-specific.
1178 @ifset BashFeatures
1179 Bash attempts completion treating the text as a variable (if the
1180 text begins with @samp{$}), username (if the text begins with
1181 @samp{~}), hostname (if the text begins with @samp{@@}), or
1182 command (including aliases and functions) in turn.  If none 
1183 of these produces a match, filename completion is attempted.
1184 @end ifset
1185 @ifclear BashFeatures
1186 The default is filename completion.
1187 @end ifclear
1188
1189 @item possible-completions (M-?)
1190 List the possible completions of the text before point.
1191
1192 @item insert-completions (M-*)
1193 Insert all completions of the text before point that would have
1194 been generated by @code{possible-completions}.
1195
1196 @item menu-complete ()
1197 Similar to @code{complete}, but replaces the word to be completed
1198 with a single match from the list of possible completions.
1199 Repeated execution of @code{menu-complete} steps through the list
1200 of possible completions, inserting each match in turn.
1201 At the end of the list of completions, the bell is rung
1202 (subject to the setting of @code{bell-style})
1203 and the original text is restored.
1204 An argument of @var{n} moves @var{n} positions forward in the list
1205 of matches; a negative argument may be used to move backward
1206 through the list.
1207 This command is intended to be bound to @key{TAB}, but is unbound
1208 by default.
1209
1210 @item delete-char-or-list ()
1211 Deletes the character under the cursor if not at the beginning or
1212 end of the line (like @code{delete-char}).
1213 If at the end of the line, behaves identically to
1214 @code{possible-completions}.
1215 This command is unbound by default.
1216
1217 @ifset BashFeatures
1218 @item complete-filename (M-/)
1219 Attempt filename completion on the text before point.
1220
1221 @item possible-filename-completions (C-x /)
1222 List the possible completions of the text before point,
1223 treating it as a filename.
1224
1225 @item complete-username (M-~)
1226 Attempt completion on the text before point, treating
1227 it as a username.
1228
1229 @item possible-username-completions (C-x ~)
1230 List the possible completions of the text before point,
1231 treating it as a username.
1232
1233 @item complete-variable (M-$)
1234 Attempt completion on the text before point, treating
1235 it as a shell variable.
1236
1237 @item possible-variable-completions (C-x $)
1238 List the possible completions of the text before point,
1239 treating it as a shell variable.
1240
1241 @item complete-hostname (M-@@)
1242 Attempt completion on the text before point, treating
1243 it as a hostname.
1244
1245 @item possible-hostname-completions (C-x @@)
1246 List the possible completions of the text before point,
1247 treating it as a hostname.
1248
1249 @item complete-command (M-!)
1250 Attempt completion on the text before point, treating
1251 it as a command name.  Command completion attempts to
1252 match the text against aliases, reserved words, shell
1253 functions, shell builtins, and finally executable filenames,
1254 in that order.
1255
1256 @item possible-command-completions (C-x !)
1257 List the possible completions of the text before point,
1258 treating it as a command name.
1259
1260 @item dynamic-complete-history (M-@key{TAB})
1261 Attempt completion on the text before point, comparing
1262 the text against lines from the history list for possible
1263 completion matches.
1264
1265 @item complete-into-braces (M-@{)
1266 Perform filename completion and insert the list of possible completions
1267 enclosed within braces so the list is available to the shell
1268 (@pxref{Brace Expansion}).
1269
1270 @end ifset
1271 @end ftable
1272
1273 @node Keyboard Macros
1274 @subsection Keyboard Macros
1275 @ftable @code
1276
1277 @item start-kbd-macro (C-x ()
1278 Begin saving the characters typed into the current keyboard macro.
1279
1280 @item end-kbd-macro (C-x ))
1281 Stop saving the characters typed into the current keyboard macro
1282 and save the definition.
1283
1284 @item call-last-kbd-macro (C-x e)
1285 Re-execute the last keyboard macro defined, by making the characters
1286 in the macro appear as if typed at the keyboard.
1287
1288 @end ftable
1289
1290 @node Miscellaneous Commands
1291 @subsection Some Miscellaneous Commands
1292 @ftable @code
1293
1294 @item re-read-init-file (C-x C-r)
1295 Read in the contents of the @var{inputrc} file, and incorporate
1296 any bindings or variable assignments found there.
1297
1298 @item abort (C-g)
1299 Abort the current editing command and
1300 ring the terminal's bell (subject to the setting of
1301 @code{bell-style}).
1302
1303 @item do-uppercase-version (M-a, M-b, M-@var{x}, @dots{})
1304 If the metafied character @var{x} is lowercase, run the command
1305 that is bound to the corresponding uppercase character.
1306
1307 @item prefix-meta (@key{ESC})
1308 Metafy the next character typed.  This is for keyboards
1309 without a meta key.  Typing @samp{@key{ESC} f} is equivalent to typing
1310 @kbd{M-f}.
1311
1312 @item undo (C-_ or C-x C-u)
1313 Incremental undo, separately remembered for each line.
1314
1315 @item revert-line (M-r)
1316 Undo all changes made to this line.  This is like executing the @code{undo}
1317 command enough times to get back to the beginning.
1318
1319 @ifset BashFeatures
1320 @item tilde-expand (M-&)
1321 @end ifset
1322 @ifclear BashFeatures
1323 @item tilde-expand (M-~)
1324 @end ifclear
1325 Perform tilde expansion on the current word.
1326
1327 @item set-mark (C-@@)
1328 Set the mark to the point.  If a
1329 numeric argument is supplied, the mark is set to that position.
1330
1331 @item exchange-point-and-mark (C-x C-x)
1332 Swap the point with the mark.  The current cursor position is set to
1333 the saved position, and the old cursor position is saved as the mark.
1334
1335 @item character-search (C-])
1336 A character is read and point is moved to the next occurrence of that
1337 character.  A negative count searches for previous occurrences.
1338
1339 @item character-search-backward (M-C-])
1340 A character is read and point is moved to the previous occurrence
1341 of that character.  A negative count searches for subsequent
1342 occurrences.
1343
1344 @item insert-comment (M-#)
1345 Without a numeric argument, the value of the @code{comment-begin}
1346 variable is inserted at the beginning of the current line.
1347 If a numeric argument is supplied, this command acts as a toggle:  if
1348 the characters at the beginning of the line do not match the value
1349 of @code{comment-begin}, the value is inserted, otherwise
1350 the characters in @code{comment-begin} are deleted from the beginning of
1351 the line.
1352 In either case, the line is accepted as if a newline had been typed.
1353 @ifset BashFeatures
1354 The default value of @code{comment-begin} causes this command
1355 to make the current line a shell comment.
1356 If a numeric argument causes the comment character to be removed, the line
1357 will be executed by the shell.
1358 @end ifset
1359
1360 @item dump-functions ()
1361 Print all of the functions and their key bindings to the
1362 Readline output stream.  If a numeric argument is supplied,
1363 the output is formatted in such a way that it can be made part
1364 of an @var{inputrc} file.  This command is unbound by default.
1365
1366 @item dump-variables ()
1367 Print all of the settable variables and their values to the
1368 Readline output stream.  If a numeric argument is supplied,
1369 the output is formatted in such a way that it can be made part
1370 of an @var{inputrc} file.  This command is unbound by default.
1371
1372 @item dump-macros ()
1373 Print all of the Readline key sequences bound to macros and the
1374 strings they output.  If a numeric argument is supplied,
1375 the output is formatted in such a way that it can be made part
1376 of an @var{inputrc} file.  This command is unbound by default.
1377
1378 @ifset BashFeatures
1379 @item glob-complete-word (M-g)
1380 The word before point is treated as a pattern for pathname expansion,
1381 with an asterisk implicitly appended.  This pattern is used to
1382 generate a list of matching file names for possible completions.
1383
1384 @item glob-expand-word (C-x *)
1385 The word before point is treated as a pattern for pathname expansion,
1386 and the list of matching file names is inserted, replacing the word.
1387 If a numeric argument is supplied, a @samp{*} is appended before
1388 pathname expansion.
1389
1390 @item glob-list-expansions (C-x g)
1391 The list of expansions that would have been generated by
1392 @code{glob-expand-word} is displayed, and the line is redrawn.
1393 If a numeric argument is supplied, a @samp{*} is appended before
1394 pathname expansion.
1395
1396 @item display-shell-version (C-x C-v)
1397 Display version information about the current instance of Bash.
1398
1399 @item shell-expand-line (M-C-e)
1400 Expand the line as the shell does.
1401 This performs alias and history expansion as well as all of the shell
1402 word expansions (@pxref{Shell Expansions}).
1403
1404 @item history-expand-line (M-^)
1405 Perform history expansion on the current line.
1406
1407 @item magic-space ()
1408 Perform history expansion on the current line and insert a space
1409 (@pxref{History Interaction}).
1410
1411 @item alias-expand-line ()
1412 Perform alias expansion on the current line (@pxref{Aliases}).
1413
1414 @item history-and-alias-expand-line ()
1415 Perform history and alias expansion on the current line.
1416
1417 @item insert-last-argument (M-. or M-_)
1418 A synonym for @code{yank-last-arg}.
1419
1420 @item operate-and-get-next (C-o)
1421 Accept the current line for execution and fetch the next line
1422 relative to the current line from the history for editing.  Any
1423 argument is ignored.
1424
1425 @item edit-and-execute-command (C-xC-e)
1426 Invoke an editor on the current command line, and execute the result as shell
1427 commands.
1428 Bash attempts to invoke
1429 @code{$FCEDIT}, @code{$EDITOR}, and @code{emacs}
1430 as the editor, in that order.
1431
1432 @end ifset
1433
1434 @ifclear BashFeatures
1435 @item emacs-editing-mode (C-e)
1436 When in @code{vi} command mode, this causes a switch to @code{emacs}
1437 editing mode.
1438
1439 @item vi-editing-mode (M-C-j)
1440 When in @code{emacs} editing mode, this causes a switch to @code{vi}
1441 editing mode.
1442
1443 @end ifclear
1444
1445 @end ftable
1446
1447 @node Readline vi Mode
1448 @section Readline vi Mode
1449
1450 While the Readline library does not have a full set of @code{vi}
1451 editing functions, it does contain enough to allow simple editing
1452 of the line.  The Readline @code{vi} mode behaves as specified in
1453 the @sc{posix} 1003.2 standard.
1454
1455 @ifset BashFeatures
1456 In order to switch interactively between @code{emacs} and @code{vi}
1457 editing modes, use the @samp{set -o emacs} and @samp{set -o vi}
1458 commands (@pxref{The Set Builtin}).
1459 @end ifset
1460 @ifclear BashFeatures
1461 In order to switch interactively between @code{emacs} and @code{vi}
1462 editing modes, use the command @kbd{M-C-j} (bound to emacs-editing-mode
1463 when in @code{vi} mode and to vi-editing-mode in @code{emacs} mode).
1464 @end ifclear
1465 The Readline default is @code{emacs} mode.
1466
1467 When you enter a line in @code{vi} mode, you are already placed in
1468 `insertion' mode, as if you had typed an @samp{i}.  Pressing @key{ESC}
1469 switches you into `command' mode, where you can edit the text of the
1470 line with the standard @code{vi} movement keys, move to previous
1471 history lines with @samp{k} and subsequent lines with @samp{j}, and
1472 so forth.
1473
1474 @ifset BashFeatures
1475 @node Programmable Completion
1476 @section Programmable Completion
1477 @cindex programmable completion
1478
1479 When word completion is attempted for an argument to a command for
1480 which a completion specification (a @var{compspec}) has been defined
1481 using the @code{complete} builtin (@pxref{Programmable Completion Builtins}),
1482 the programmable completion facilities are invoked. 
1483
1484 First, the command name is identified.
1485 If a compspec has been defined for that command, the
1486 compspec is used to generate the list of possible completions for the word.
1487 If the command word is a full pathname, a compspec for the full
1488 pathname is searched for first.
1489 If no compspec is found for the full pathname, an attempt is made to
1490 find a compspec for the portion following the final slash.
1491
1492 Once a compspec has been found, it is used to generate the list of
1493 matching words.
1494 If a compspec is not found, the default Bash completion
1495 described above (@pxref{Commands For Completion}) is performed.
1496
1497 First, the actions specified by the compspec are used.
1498 Only matches which are prefixed by the word being completed are
1499 returned.
1500 When the @option{-f} or @option{-d} option is used for filename or
1501 directory name completion, the shell variable @env{FIGNORE} is
1502 used to filter the matches.
1503 @xref{Bash Variables}, for a description of @env{FIGNORE}.
1504
1505 Any completions specified by a filename expansion pattern to the
1506 @option{-G} option are generated next.
1507 The words generated by the pattern need not match the word being completed.
1508 The @env{GLOBIGNORE} shell variable is not used to filter the matches,
1509 but the @env{FIGNORE} shell variable is used.
1510
1511 Next, the string specified as the argument to the @option{-W} option
1512 is considered.
1513 The string is first split using the characters in the @env{IFS}
1514 special variable as delimiters.
1515 Shell quoting is honored.
1516 Each word is then expanded using
1517 brace expansion, tilde expansion, parameter and variable expansion,
1518 command substitution, arithmetic expansion, and pathname expansion,
1519 as described above (@pxref{Shell Expansions}).
1520 The results are split using the rules described above
1521 (@pxref{Word Splitting}).
1522 The results of the expansion are prefix-matched against the word being
1523 completed, and the matching words become the possible completions.
1524
1525 After these matches have been generated, any shell function or command
1526 specified with the @option{-F} and @option{-C} options is invoked.
1527 When the command or function is invoked, the @env{COMP_LINE} and
1528 @env{COMP_POINT} variables are assigned values as described above
1529 (@pxref{Bash Variables}).
1530 If a shell function is being invoked, the @env{COMP_WORDS} and
1531 @env{COMP_CWORD} variables are also set.
1532 When the function or command is invoked, the first argument is the
1533 name of the command whose arguments are being completed, the
1534 second argument is the word being completed, and the third argument
1535 is the word preceding the word being completed on the current command line.
1536 No filtering of the generated completions against the word being completed
1537 is performed; the function or command has complete freedom in generating
1538 the matches.
1539
1540 Any function specified with @option{-F} is invoked first.
1541 The function may use any of the shell facilities, including the
1542 @code{compgen} builtin described below
1543 (@pxref{Programmable Completion Builtins}), to generate the matches.
1544 It must put the possible completions in the @env{COMPREPLY} array
1545 variable.
1546
1547 Next, any command specified with the @option{-C} option is invoked
1548 in an environment equivalent to command substitution.
1549 It should print a list of completions, one per line, to
1550 the standard output.
1551 Backslash may be used to escape a newline, if necessary.
1552
1553 After all of the possible completions are generated, any filter
1554 specified with the @option{-X} option is applied to the list.
1555 The filter is a pattern as used for pathname expansion; a @samp{&}
1556 in the pattern is replaced with the text of the word being completed.
1557 A literal @samp{&} may be escaped with a backslash; the backslash
1558 is removed before attempting a match.
1559 Any completion that matches the pattern will be removed from the list.
1560 A leading @samp{!} negates the pattern; in this case any completion
1561 not matching the pattern will be removed.
1562
1563 Finally, any prefix and suffix specified with the @option{-P} and @option{-S}
1564 options are added to each member of the completion list, and the result is
1565 returned to the Readline completion code as the list of possible
1566 completions.
1567
1568 If the previously-applied actions do not generate any matches, and the
1569 @option{-o dirnames} option was supplied to @code{complete} when the
1570 compspec was defined, directory name completion is attempted. 
1571
1572 By default, if a compspec is found, whatever it generates is returned to
1573 the completion code as the full set of possible completions.
1574 The default Bash completions are not attempted, and the Readline default
1575 of filename completion is disabled.
1576 If the @option{-o default} option was supplied to @code{complete} when the
1577 compspec was defined, Readline's default completion will be performed
1578 if the compspec generates no matches.
1579
1580 When a compspec indicates that directory name completion is desired,
1581 the programmable completion functions force Readline to append a slash
1582 to completed names which are symbolic links to directories, subject to
1583 the value of the @var{mark-directories} Readline variable, regardless
1584 of the setting of the @var{mark-symlinked-directories} Readline variable.
1585
1586 @node Programmable Completion Builtins
1587 @section Programmable Completion Builtins
1588 @cindex completion builtins
1589
1590 Two builtin commands are available to manipulate the programmable completion
1591 facilities.
1592
1593 @table @code
1594 @item compgen
1595 @btindex compgen
1596 @example
1597 @code{compgen [@var{option}] [@var{word}]}
1598 @end example
1599
1600 Generate possible completion matches for @var{word} according to
1601 the @var{option}s, which may be any option accepted by the
1602 @code{complete}
1603 builtin with the exception of @option{-p} and @option{-r}, and write
1604 the matches to the standard output.
1605 When using the @option{-F} or @option{-C} options, the various shell variables
1606 set by the programmable completion facilities, while available, will not
1607 have useful values.
1608
1609 The matches will be generated in the same way as if the programmable
1610 completion code had generated them directly from a completion specification
1611 with the same flags.
1612 If @var{word} is specified, only those completions matching @var{word}
1613 will be displayed.
1614
1615 The return value is true unless an invalid option is supplied, or no
1616 matches were generated.
1617
1618 @item complete
1619 @btindex complete
1620 @example
1621 @code{complete [-abcdefgjksuv] [-o @var{comp-option}] [-A @var{action}] [-G @var{globpat}] [-W @var{wordlist}]
1622 [-P @var{prefix}] [-S @var{suffix}] [-X @var{filterpat}] [-F @var{function}]
1623 [-C @var{command}] @var{name} [@var{name} @dots{}]}
1624 @code{complete -pr [@var{name} @dots{}]}
1625 @end example
1626
1627 Specify how arguments to each @var{name} should be completed.
1628 If the @option{-p} option is supplied, or if no options are supplied, existing
1629 completion specifications are printed in a way that allows them to be
1630 reused as input.
1631 The @option{-r} option removes a completion specification for
1632 each @var{name}, or, if no @var{name}s are supplied, all
1633 completion specifications.
1634
1635 The process of applying these completion specifications when word completion
1636 is attempted is described above (@pxref{Programmable Completion}).
1637
1638 Other options, if specified, have the following meanings.
1639 The arguments to the @option{-G}, @option{-W}, and @option{-X} options
1640 (and, if necessary, the @option{-P} and @option{-S} options)
1641 should be quoted to protect them from expansion before the
1642 @code{complete} builtin is invoked.
1643
1644
1645 @table @code
1646 @item -o @var{comp-option}
1647 The @var{comp-option} controls several aspects of the compspec's behavior
1648 beyond the simple generation of completions.
1649 @var{comp-option} may be one of: 
1650
1651 @table @code
1652
1653 @item default
1654 Use Readline's default filename completion if the compspec generates
1655 no matches.
1656
1657 @item dirnames
1658 Perform directory name completion if the compspec generates no matches.
1659
1660 @item filenames
1661 Tell Readline that the compspec generates filenames, so it can perform any
1662 filename\-specific processing (like adding a slash to directory names or
1663 suppressing trailing spaces).  This option is intended to be used with
1664 shell functions specified with @option{-F}.
1665
1666 @item nospace
1667 Tell Readline not to append a space (the default) to words completed at
1668 the end of the line.
1669 @end table
1670
1671 @item -A @var{action}
1672 The @var{action} may be one of the following to generate a list of possible
1673 completions:
1674
1675 @table @code
1676 @item alias
1677 Alias names.  May also be specified as @option{-a}.
1678
1679 @item arrayvar
1680 Array variable names.
1681
1682 @item binding
1683 Readline key binding names (@pxref{Bindable Readline Commands}).
1684
1685 @item builtin
1686 Names of shell builtin commands.  May also be specified as @option{-b}.
1687
1688 @item command
1689 Command names.  May also be specified as @option{-c}.
1690
1691 @item directory
1692 Directory names.  May also be specified as @option{-d}.
1693
1694 @item disabled
1695 Names of disabled shell builtins.
1696
1697 @item enabled
1698 Names of enabled shell builtins.
1699
1700 @item export
1701 Names of exported shell variables.  May also be specified as @option{-e}.
1702
1703 @item file
1704 File names.  May also be specified as @option{-f}.
1705
1706 @item function
1707 Names of shell functions.
1708
1709 @item group
1710 Group names.  May also be specified as @option{-g}.
1711
1712 @item helptopic
1713 Help topics as accepted by the @code{help} builtin (@pxref{Bash Builtins}).
1714
1715 @item hostname
1716 Hostnames, as taken from the file specified by the
1717 @env{HOSTFILE} shell variable (@pxref{Bash Variables}).
1718
1719 @item job
1720 Job names, if job control is active.  May also be specified as @option{-j}.
1721
1722 @item keyword
1723 Shell reserved words.  May also be specified as @option{-k}.
1724
1725 @item running
1726 Names of running jobs, if job control is active.
1727
1728 @item service
1729 Service names.  May also be specified as @option{-s}.
1730
1731 @item setopt
1732 Valid arguments for the @option{-o} option to the @code{set} builtin
1733 (@pxref{The Set Builtin}).
1734
1735 @item shopt
1736 Shell option names as accepted by the @code{shopt} builtin
1737 (@pxref{Bash Builtins}).
1738
1739 @item signal
1740 Signal names.
1741
1742 @item stopped
1743 Names of stopped jobs, if job control is active.
1744
1745 @item user
1746 User names.  May also be specified as @option{-u}.
1747
1748 @item variable
1749 Names of all shell variables.  May also be specified as @option{-v}.
1750 @end table
1751
1752 @item -G @var{globpat}
1753 The filename expansion pattern @var{globpat} is expanded to generate
1754 the possible completions.
1755
1756 @item -W @var{wordlist}
1757 The @var{wordlist} is split using the characters in the
1758 @env{IFS} special variable as delimiters, and each resultant word
1759 is expanded.
1760 The possible completions are the members of the resultant list which
1761 match the word being completed.
1762
1763 @item -C @var{command}
1764 @var{command} is executed in a subshell environment, and its output is
1765 used as the possible completions.
1766
1767 @item -F @var{function}
1768 The shell function @var{function} is executed in the current shell
1769 environment.
1770 When it finishes, the possible completions are retrieved from the value
1771 of the @env{COMPREPLY} array variable.
1772
1773 @item -X @var{filterpat}
1774 @var{filterpat} is a pattern as used for filename expansion.
1775 It is applied to the list of possible completions generated by the
1776 preceding options and arguments, and each completion matching
1777 @var{filterpat} is removed from the list.
1778 A leading @samp{!} in @var{filterpat} negates the pattern; in this
1779 case, any completion not matching @var{filterpat} is removed.
1780
1781 @item -P @var{prefix}
1782 @var{prefix} is added at the beginning of each possible completion
1783 after all other options have been applied.
1784
1785 @item -S @var{suffix}
1786 @var{suffix} is appended to each possible completion
1787 after all other options have been applied.
1788 @end table
1789
1790 The return value is true unless an invalid option is supplied, an option
1791 other than @option{-p} or @option{-r} is supplied without a @var{name}
1792 argument, an attempt is made to remove a completion specification for
1793 a @var{name} for which no specification exists, or
1794 an error occurs adding a completion specification.
1795
1796 @end table
1797 @end ifset