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