]>
Commit | Line | Data |
---|---|---|
bc7bed50 | 1 | This is readline.info, produced by makeinfo version 4.7 from |
5e13499c CR |
2 | ./rlman.texi. |
3 | ||
8d618825 CR |
4 | This manual describes the GNU Readline Library (version 5.2, 9 |
5 | February 2006), a library which aids in the consistency of user | |
bc7bed50 CR |
6 | interface across discrete programs which provide a command line |
7 | interface. | |
5e13499c | 8 | |
e6e3b444 | 9 | Copyright (C) 1988-2004 Free Software Foundation, Inc. |
5e13499c CR |
10 | |
11 | Permission is granted to make and distribute verbatim copies of this | |
12 | manual provided the copyright notice and this permission notice are | |
13 | preserved on all copies. | |
14 | ||
15 | Permission is granted to copy, distribute and/or modify this | |
16 | document under the terms of the GNU Free Documentation License, | |
17 | Version 1.1 or any later version published by the Free Software | |
18 | Foundation; with no Invariant Sections, with the Front-Cover texts | |
19 | being "A GNU Manual," and with the Back-Cover Texts as in (a) | |
20 | below. A copy of the license is included in the section entitled | |
21 | "GNU Free Documentation License." | |
22 | ||
23 | (a) The FSF's Back-Cover Text is: "You have freedom to copy and | |
24 | modify this GNU Manual, like GNU software. Copies published by | |
25 | the Free Software Foundation raise funds for GNU development." | |
bc7bed50 | 26 | |
5e13499c CR |
27 | INFO-DIR-SECTION Libraries |
28 | START-INFO-DIR-ENTRY | |
29 | * Readline: (readline). The GNU readline library API. | |
30 | END-INFO-DIR-ENTRY | |
31 | ||
32 | \1f | |
33 | File: readline.info, Node: Top, Next: Command Line Editing, Up: (dir) | |
34 | ||
35 | GNU Readline Library | |
36 | ******************** | |
37 | ||
bc7bed50 CR |
38 | This document describes the GNU Readline Library, a utility which aids |
39 | in the consistency of user interface across discrete programs which | |
5e13499c CR |
40 | provide a command line interface. |
41 | ||
42 | * Menu: | |
43 | ||
44 | * Command Line Editing:: GNU Readline User's Manual. | |
45 | * Programming with GNU Readline:: GNU Readline Programmer's Manual. | |
46 | * Copying This Manual:: Copying this manual. | |
47 | * Concept Index:: Index of concepts described in this manual. | |
48 | * Function and Variable Index:: Index of externally visible functions | |
49 | and variables. | |
50 | ||
51 | \1f | |
52 | File: readline.info, Node: Command Line Editing, Next: Programming with GNU Readline, Prev: Top, Up: Top | |
53 | ||
bc7bed50 CR |
54 | 1 Command Line Editing |
55 | ********************** | |
5e13499c | 56 | |
bc7bed50 | 57 | This chapter describes the basic features of the GNU command line |
5e13499c CR |
58 | editing interface. |
59 | ||
60 | * Menu: | |
61 | ||
62 | * Introduction and Notation:: Notation used in this text. | |
63 | * Readline Interaction:: The minimum set of commands for editing a line. | |
64 | * Readline Init File:: Customizing Readline from a user's view. | |
65 | * Bindable Readline Commands:: A description of most of the Readline commands | |
66 | available for binding | |
67 | * Readline vi Mode:: A short description of how to make Readline | |
68 | behave like the vi editor. | |
69 | ||
70 | \1f | |
71 | File: readline.info, Node: Introduction and Notation, Next: Readline Interaction, Up: Command Line Editing | |
72 | ||
bc7bed50 CR |
73 | 1.1 Introduction to Line Editing |
74 | ================================ | |
5e13499c | 75 | |
bc7bed50 | 76 | The following paragraphs describe the notation used to represent |
5e13499c CR |
77 | keystrokes. |
78 | ||
79 | The text `C-k' is read as `Control-K' and describes the character | |
80 | produced when the <k> key is pressed while the Control key is depressed. | |
81 | ||
82 | The text `M-k' is read as `Meta-K' and describes the character | |
83 | produced when the Meta key (if you have one) is depressed, and the <k> | |
84 | key is pressed. The Meta key is labeled <ALT> on many keyboards. On | |
85 | keyboards with two keys labeled <ALT> (usually to either side of the | |
86 | space bar), the <ALT> on the left side is generally set to work as a | |
87 | Meta key. The <ALT> key on the right may also be configured to work as | |
88 | a Meta key or may be configured as some other modifier, such as a | |
89 | Compose key for typing accented characters. | |
90 | ||
91 | If you do not have a Meta or <ALT> key, or another key working as a | |
92 | Meta key, the identical keystroke can be generated by typing <ESC> | |
93 | _first_, and then typing <k>. Either process is known as "metafying" | |
94 | the <k> key. | |
95 | ||
96 | The text `M-C-k' is read as `Meta-Control-k' and describes the | |
97 | character produced by "metafying" `C-k'. | |
98 | ||
99 | In addition, several keys have their own names. Specifically, | |
100 | <DEL>, <ESC>, <LFD>, <SPC>, <RET>, and <TAB> all stand for themselves | |
101 | when seen in this text, or in an init file (*note Readline Init File::). | |
102 | If your keyboard lacks a <LFD> key, typing <C-j> will produce the | |
103 | desired character. The <RET> key may be labeled <Return> or <Enter> on | |
104 | some keyboards. | |
105 | ||
106 | \1f | |
107 | File: readline.info, Node: Readline Interaction, Next: Readline Init File, Prev: Introduction and Notation, Up: Command Line Editing | |
108 | ||
bc7bed50 CR |
109 | 1.2 Readline Interaction |
110 | ======================== | |
5e13499c | 111 | |
bc7bed50 | 112 | Often during an interactive session you type in a long line of text, |
5e13499c CR |
113 | only to notice that the first word on the line is misspelled. The |
114 | Readline library gives you a set of commands for manipulating the text | |
115 | as you type it in, allowing you to just fix your typo, and not forcing | |
116 | you to retype the majority of the line. Using these editing commands, | |
117 | you move the cursor to the place that needs correction, and delete or | |
118 | insert the text of the corrections. Then, when you are satisfied with | |
119 | the line, you simply press <RET>. You do not have to be at the end of | |
120 | the line to press <RET>; the entire line is accepted regardless of the | |
121 | location of the cursor within the line. | |
122 | ||
123 | * Menu: | |
124 | ||
125 | * Readline Bare Essentials:: The least you need to know about Readline. | |
126 | * Readline Movement Commands:: Moving about the input line. | |
127 | * Readline Killing Commands:: How to delete text, and how to get it back! | |
128 | * Readline Arguments:: Giving numeric arguments to commands. | |
129 | * Searching:: Searching through previous lines. | |
130 | ||
131 | \1f | |
132 | File: readline.info, Node: Readline Bare Essentials, Next: Readline Movement Commands, Up: Readline Interaction | |
133 | ||
bc7bed50 CR |
134 | 1.2.1 Readline Bare Essentials |
135 | ------------------------------ | |
5e13499c | 136 | |
bc7bed50 CR |
137 | In order to enter characters into the line, simply type them. The typed |
138 | character appears where the cursor was, and then the cursor moves one | |
139 | space to the right. If you mistype a character, you can use your erase | |
140 | character to back up and delete the mistyped character. | |
5e13499c CR |
141 | |
142 | Sometimes you may mistype a character, and not notice the error | |
143 | until you have typed several other characters. In that case, you can | |
144 | type `C-b' to move the cursor to the left, and then correct your | |
145 | mistake. Afterwards, you can move the cursor to the right with `C-f'. | |
146 | ||
147 | When you add text in the middle of a line, you will notice that | |
148 | characters to the right of the cursor are `pushed over' to make room | |
149 | for the text that you have inserted. Likewise, when you delete text | |
150 | behind the cursor, characters to the right of the cursor are `pulled | |
151 | back' to fill in the blank space created by the removal of the text. A | |
152 | list of the bare essentials for editing the text of an input line | |
153 | follows. | |
154 | ||
155 | `C-b' | |
156 | Move back one character. | |
157 | ||
158 | `C-f' | |
159 | Move forward one character. | |
160 | ||
161 | <DEL> or <Backspace> | |
162 | Delete the character to the left of the cursor. | |
163 | ||
164 | `C-d' | |
165 | Delete the character underneath the cursor. | |
166 | ||
167 | Printing characters | |
168 | Insert the character into the line at the cursor. | |
169 | ||
170 | `C-_' or `C-x C-u' | |
171 | Undo the last editing command. You can undo all the way back to an | |
172 | empty line. | |
173 | ||
174 | (Depending on your configuration, the <Backspace> key be set to delete | |
175 | the character to the left of the cursor and the <DEL> key set to delete | |
176 | the character underneath the cursor, like `C-d', rather than the | |
177 | character to the left of the cursor.) | |
178 | ||
179 | \1f | |
180 | File: readline.info, Node: Readline Movement Commands, Next: Readline Killing Commands, Prev: Readline Bare Essentials, Up: Readline Interaction | |
181 | ||
bc7bed50 CR |
182 | 1.2.2 Readline Movement Commands |
183 | -------------------------------- | |
5e13499c | 184 | |
bc7bed50 | 185 | The above table describes the most basic keystrokes that you need in |
5e13499c CR |
186 | order to do editing of the input line. For your convenience, many |
187 | other commands have been added in addition to `C-b', `C-f', `C-d', and | |
188 | <DEL>. Here are some commands for moving more rapidly about the line. | |
189 | ||
190 | `C-a' | |
191 | Move to the start of the line. | |
192 | ||
193 | `C-e' | |
194 | Move to the end of the line. | |
195 | ||
196 | `M-f' | |
197 | Move forward a word, where a word is composed of letters and | |
198 | digits. | |
199 | ||
200 | `M-b' | |
201 | Move backward a word. | |
202 | ||
203 | `C-l' | |
204 | Clear the screen, reprinting the current line at the top. | |
205 | ||
206 | Notice how `C-f' moves forward a character, while `M-f' moves | |
207 | forward a word. It is a loose convention that control keystrokes | |
208 | operate on characters while meta keystrokes operate on words. | |
209 | ||
210 | \1f | |
211 | File: readline.info, Node: Readline Killing Commands, Next: Readline Arguments, Prev: Readline Movement Commands, Up: Readline Interaction | |
212 | ||
bc7bed50 CR |
213 | 1.2.3 Readline Killing Commands |
214 | ------------------------------- | |
5e13499c | 215 | |
bc7bed50 CR |
216 | "Killing" text means to delete the text from the line, but to save it |
217 | away for later use, usually by "yanking" (re-inserting) it back into | |
5e13499c CR |
218 | the line. (`Cut' and `paste' are more recent jargon for `kill' and |
219 | `yank'.) | |
220 | ||
221 | If the description for a command says that it `kills' text, then you | |
222 | can be sure that you can get the text back in a different (or the same) | |
223 | place later. | |
224 | ||
225 | When you use a kill command, the text is saved in a "kill-ring". | |
226 | Any number of consecutive kills save all of the killed text together, so | |
227 | that when you yank it back, you get it all. The kill ring is not line | |
228 | specific; the text that you killed on a previously typed line is | |
bc7bed50 | 229 | available to be yanked back later, when you are typing another line. |
5e13499c CR |
230 | |
231 | Here is the list of commands for killing text. | |
232 | ||
233 | `C-k' | |
234 | Kill the text from the current cursor position to the end of the | |
235 | line. | |
236 | ||
237 | `M-d' | |
238 | Kill from the cursor to the end of the current word, or, if between | |
239 | words, to the end of the next word. Word boundaries are the same | |
240 | as those used by `M-f'. | |
241 | ||
242 | `M-<DEL>' | |
243 | Kill from the cursor the start of the current word, or, if between | |
244 | words, to the start of the previous word. Word boundaries are the | |
245 | same as those used by `M-b'. | |
246 | ||
247 | `C-w' | |
248 | Kill from the cursor to the previous whitespace. This is | |
249 | different than `M-<DEL>' because the word boundaries differ. | |
250 | ||
251 | ||
252 | Here is how to "yank" the text back into the line. Yanking means to | |
253 | copy the most-recently-killed text from the kill buffer. | |
254 | ||
255 | `C-y' | |
256 | Yank the most recently killed text back into the buffer at the | |
257 | cursor. | |
258 | ||
259 | `M-y' | |
260 | Rotate the kill-ring, and yank the new top. You can only do this | |
261 | if the prior command is `C-y' or `M-y'. | |
262 | ||
263 | \1f | |
264 | File: readline.info, Node: Readline Arguments, Next: Searching, Prev: Readline Killing Commands, Up: Readline Interaction | |
265 | ||
bc7bed50 CR |
266 | 1.2.4 Readline Arguments |
267 | ------------------------ | |
5e13499c | 268 | |
bc7bed50 | 269 | You can pass numeric arguments to Readline commands. Sometimes the |
5e13499c CR |
270 | argument acts as a repeat count, other times it is the sign of the |
271 | argument that is significant. If you pass a negative argument to a | |
272 | command which normally acts in a forward direction, that command will | |
273 | act in a backward direction. For example, to kill text back to the | |
274 | start of the line, you might type `M-- C-k'. | |
275 | ||
276 | The general way to pass numeric arguments to a command is to type | |
277 | meta digits before the command. If the first `digit' typed is a minus | |
278 | sign (`-'), then the sign of the argument will be negative. Once you | |
279 | have typed one meta digit to get the argument started, you can type the | |
280 | remainder of the digits, and then the command. For example, to give | |
281 | the `C-d' command an argument of 10, you could type `M-1 0 C-d', which | |
282 | will delete the next ten characters on the input line. | |
283 | ||
284 | \1f | |
285 | File: readline.info, Node: Searching, Prev: Readline Arguments, Up: Readline Interaction | |
286 | ||
bc7bed50 CR |
287 | 1.2.5 Searching for Commands in the History |
288 | ------------------------------------------- | |
5e13499c | 289 | |
bc7bed50 | 290 | Readline provides commands for searching through the command history |
5e13499c CR |
291 | for lines containing a specified string. There are two search modes: |
292 | "incremental" and "non-incremental". | |
293 | ||
294 | Incremental searches begin before the user has finished typing the | |
295 | search string. As each character of the search string is typed, | |
296 | Readline displays the next entry from the history matching the string | |
297 | typed so far. An incremental search requires only as many characters | |
298 | as needed to find the desired history entry. To search backward in the | |
299 | history for a particular string, type `C-r'. Typing `C-s' searches | |
300 | forward through the history. The characters present in the value of | |
301 | the `isearch-terminators' variable are used to terminate an incremental | |
302 | search. If that variable has not been assigned a value, the <ESC> and | |
303 | `C-J' characters will terminate an incremental search. `C-g' will | |
304 | abort an incremental search and restore the original line. When the | |
305 | search is terminated, the history entry containing the search string | |
306 | becomes the current line. | |
307 | ||
308 | To find other matching entries in the history list, type `C-r' or | |
309 | `C-s' as appropriate. This will search backward or forward in the | |
310 | history for the next entry matching the search string typed so far. | |
311 | Any other key sequence bound to a Readline command will terminate the | |
312 | search and execute that command. For instance, a <RET> will terminate | |
313 | the search and accept the line, thereby executing the command from the | |
314 | history list. A movement command will terminate the search, make the | |
315 | last line found the current line, and begin editing. | |
316 | ||
317 | Readline remembers the last incremental search string. If two | |
318 | `C-r's are typed without any intervening characters defining a new | |
319 | search string, any remembered search string is used. | |
320 | ||
321 | Non-incremental searches read the entire search string before | |
322 | starting to search for matching history lines. The search string may be | |
323 | typed by the user or be part of the contents of the current line. | |
324 | ||
325 | \1f | |
326 | File: readline.info, Node: Readline Init File, Next: Bindable Readline Commands, Prev: Readline Interaction, Up: Command Line Editing | |
327 | ||
bc7bed50 CR |
328 | 1.3 Readline Init File |
329 | ====================== | |
5e13499c | 330 | |
bc7bed50 | 331 | Although the Readline library comes with a set of Emacs-like |
5e13499c CR |
332 | keybindings installed by default, it is possible to use a different set |
333 | of keybindings. Any user can customize programs that use Readline by | |
334 | putting commands in an "inputrc" file, conventionally in his home | |
335 | directory. The name of this file is taken from the value of the | |
336 | environment variable `INPUTRC'. If that variable is unset, the default | |
8d618825 CR |
337 | is `~/.inputrc'. If that file does not exist or cannot be read, the |
338 | ultimate default is `/etc/inputrc'. | |
5e13499c CR |
339 | |
340 | When a program which uses the Readline library starts up, the init | |
341 | file is read, and the key bindings are set. | |
342 | ||
343 | In addition, the `C-x C-r' command re-reads this init file, thus | |
344 | incorporating any changes that you might have made to it. | |
345 | ||
346 | * Menu: | |
347 | ||
348 | * Readline Init File Syntax:: Syntax for the commands in the inputrc file. | |
349 | ||
350 | * Conditional Init Constructs:: Conditional key bindings in the inputrc file. | |
351 | ||
352 | * Sample Init File:: An example inputrc file. | |
353 | ||
354 | \1f | |
355 | File: readline.info, Node: Readline Init File Syntax, Next: Conditional Init Constructs, Up: Readline Init File | |
356 | ||
bc7bed50 CR |
357 | 1.3.1 Readline Init File Syntax |
358 | ------------------------------- | |
5e13499c | 359 | |
bc7bed50 | 360 | There are only a few basic constructs allowed in the Readline init |
5e13499c CR |
361 | file. Blank lines are ignored. Lines beginning with a `#' are |
362 | comments. Lines beginning with a `$' indicate conditional constructs | |
363 | (*note Conditional Init Constructs::). Other lines denote variable | |
364 | settings and key bindings. | |
365 | ||
366 | Variable Settings | |
367 | You can modify the run-time behavior of Readline by altering the | |
368 | values of variables in Readline using the `set' command within the | |
369 | init file. The syntax is simple: | |
370 | ||
371 | set VARIABLE VALUE | |
372 | ||
373 | Here, for example, is how to change from the default Emacs-like | |
374 | key binding to use `vi' line editing commands: | |
375 | ||
376 | set editing-mode vi | |
377 | ||
378 | Variable names and values, where appropriate, are recognized | |
bc7bed50 CR |
379 | without regard to case. Unrecognized variable names are ignored. |
380 | ||
381 | Boolean variables (those that can be set to on or off) are set to | |
382 | on if the value is null or empty, ON (case-insensitive), or 1. | |
383 | Any other value results in the variable being set to off. | |
5e13499c CR |
384 | |
385 | A great deal of run-time behavior is changeable with the following | |
386 | variables. | |
387 | ||
388 | `bell-style' | |
389 | Controls what happens when Readline wants to ring the | |
390 | terminal bell. If set to `none', Readline never rings the | |
391 | bell. If set to `visible', Readline uses a visible bell if | |
392 | one is available. If set to `audible' (the default), | |
393 | Readline attempts to ring the terminal's bell. | |
394 | ||
bc7bed50 CR |
395 | `bind-tty-special-chars' |
396 | If set to `on', Readline attempts to bind the control | |
397 | characters treated specially by the kernel's terminal driver | |
398 | to their Readline equivalents. | |
399 | ||
5e13499c CR |
400 | `comment-begin' |
401 | The string to insert at the beginning of the line when the | |
402 | `insert-comment' command is executed. The default value is | |
403 | `"#"'. | |
404 | ||
405 | `completion-ignore-case' | |
406 | If set to `on', Readline performs filename matching and | |
407 | completion in a case-insensitive fashion. The default value | |
408 | is `off'. | |
409 | ||
410 | `completion-query-items' | |
411 | The number of possible completions that determines when the | |
412 | user is asked whether the list of possibilities should be | |
413 | displayed. If the number of possible completions is greater | |
414 | than this value, Readline will ask the user whether or not he | |
415 | wishes to view them; otherwise, they are simply listed. This | |
416 | variable must be set to an integer value greater than or | |
bc7bed50 CR |
417 | equal to 0. A negative value means Readline should never ask. |
418 | The default limit is `100'. | |
5e13499c CR |
419 | |
420 | `convert-meta' | |
421 | If set to `on', Readline will convert characters with the | |
422 | eighth bit set to an ASCII key sequence by stripping the | |
423 | eighth bit and prefixing an <ESC> character, converting them | |
424 | to a meta-prefixed key sequence. The default value is `on'. | |
425 | ||
426 | `disable-completion' | |
427 | If set to `On', Readline will inhibit word completion. | |
428 | Completion characters will be inserted into the line as if | |
429 | they had been mapped to `self-insert'. The default is `off'. | |
430 | ||
431 | `editing-mode' | |
432 | The `editing-mode' variable controls which default set of key | |
433 | bindings is used. By default, Readline starts up in Emacs | |
434 | editing mode, where the keystrokes are most similar to Emacs. | |
435 | This variable can be set to either `emacs' or `vi'. | |
436 | ||
437 | `enable-keypad' | |
438 | When set to `on', Readline will try to enable the application | |
439 | keypad when it is called. Some systems need this to enable | |
440 | the arrow keys. The default is `off'. | |
441 | ||
442 | `expand-tilde' | |
443 | If set to `on', tilde expansion is performed when Readline | |
444 | attempts word completion. The default is `off'. | |
445 | ||
bc7bed50 | 446 | `history-preserve-point' |
5e13499c CR |
447 | If set to `on', the history code attempts to place point at |
448 | the same location on each history line retrieved with | |
bc7bed50 | 449 | `previous-history' or `next-history'. The default is `off'. |
5e13499c CR |
450 | |
451 | `horizontal-scroll-mode' | |
452 | This variable can be set to either `on' or `off'. Setting it | |
453 | to `on' means that the text of the lines being edited will | |
454 | scroll horizontally on a single screen line when they are | |
455 | longer than the width of the screen, instead of wrapping onto | |
456 | a new screen line. By default, this variable is set to `off'. | |
457 | ||
458 | `input-meta' | |
459 | If set to `on', Readline will enable eight-bit input (it will | |
460 | not clear the eighth bit in the characters it reads), | |
461 | regardless of what the terminal claims it can support. The | |
462 | default value is `off'. The name `meta-flag' is a synonym | |
463 | for this variable. | |
464 | ||
465 | `isearch-terminators' | |
466 | The string of characters that should terminate an incremental | |
467 | search without subsequently executing the character as a | |
468 | command (*note Searching::). If this variable has not been | |
469 | given a value, the characters <ESC> and `C-J' will terminate | |
470 | an incremental search. | |
471 | ||
472 | `keymap' | |
473 | Sets Readline's idea of the current keymap for key binding | |
474 | commands. Acceptable `keymap' names are `emacs', | |
475 | `emacs-standard', `emacs-meta', `emacs-ctlx', `vi', `vi-move', | |
476 | `vi-command', and `vi-insert'. `vi' is equivalent to | |
477 | `vi-command'; `emacs' is equivalent to `emacs-standard'. The | |
478 | default value is `emacs'. The value of the `editing-mode' | |
479 | variable also affects the default keymap. | |
480 | ||
481 | `mark-directories' | |
482 | If set to `on', completed directory names have a slash | |
483 | appended. The default is `on'. | |
484 | ||
485 | `mark-modified-lines' | |
486 | This variable, when set to `on', causes Readline to display an | |
487 | asterisk (`*') at the start of history lines which have been | |
488 | modified. This variable is `off' by default. | |
489 | ||
490 | `mark-symlinked-directories' | |
491 | If set to `on', completed names which are symbolic links to | |
492 | directories have a slash appended (subject to the value of | |
493 | `mark-directories'). The default is `off'. | |
494 | ||
495 | `match-hidden-files' | |
496 | This variable, when set to `on', causes Readline to match | |
497 | files whose names begin with a `.' (hidden files) when | |
498 | performing filename completion, unless the leading `.' is | |
499 | supplied by the user in the filename to be completed. This | |
500 | variable is `on' by default. | |
501 | ||
502 | `output-meta' | |
503 | If set to `on', Readline will display characters with the | |
504 | eighth bit set directly rather than as a meta-prefixed escape | |
505 | sequence. The default is `off'. | |
506 | ||
507 | `page-completions' | |
508 | If set to `on', Readline uses an internal `more'-like pager | |
509 | to display a screenful of possible completions at a time. | |
510 | This variable is `on' by default. | |
511 | ||
512 | `print-completions-horizontally' | |
513 | If set to `on', Readline will display completions with matches | |
514 | sorted horizontally in alphabetical order, rather than down | |
515 | the screen. The default is `off'. | |
516 | ||
517 | `show-all-if-ambiguous' | |
518 | This alters the default behavior of the completion functions. | |
519 | If set to `on', words which have more than one possible | |
520 | completion cause the matches to be listed immediately instead | |
521 | of ringing the bell. The default value is `off'. | |
522 | ||
523 | `show-all-if-unmodified' | |
524 | This alters the default behavior of the completion functions | |
525 | in a fashion similar to SHOW-ALL-IF-AMBIGUOUS. If set to | |
526 | `on', words which have more than one possible completion | |
527 | without any possible partial completion (the possible | |
528 | completions don't share a common prefix) cause the matches to | |
529 | be listed immediately instead of ringing the bell. The | |
530 | default value is `off'. | |
531 | ||
532 | `visible-stats' | |
533 | If set to `on', a character denoting a file's type is | |
534 | appended to the filename when listing possible completions. | |
535 | The default is `off'. | |
536 | ||
537 | ||
538 | Key Bindings | |
539 | The syntax for controlling key bindings in the init file is | |
540 | simple. First you need to find the name of the command that you | |
541 | want to change. The following sections contain tables of the | |
542 | command name, the default keybinding, if any, and a short | |
543 | description of what the command does. | |
544 | ||
545 | Once you know the name of the command, simply place on a line in | |
546 | the init file the name of the key you wish to bind the command to, | |
547 | a colon, and then the name of the command. The name of the key | |
548 | can be expressed in different ways, depending on what you find most | |
549 | comfortable. | |
550 | ||
551 | In addition to command names, readline allows keys to be bound to | |
552 | a string that is inserted when the key is pressed (a MACRO). | |
553 | ||
554 | KEYNAME: FUNCTION-NAME or MACRO | |
555 | KEYNAME is the name of a key spelled out in English. For | |
556 | example: | |
557 | Control-u: universal-argument | |
558 | Meta-Rubout: backward-kill-word | |
559 | Control-o: "> output" | |
560 | ||
561 | In the above example, `C-u' is bound to the function | |
562 | `universal-argument', `M-DEL' is bound to the function | |
563 | `backward-kill-word', and `C-o' is bound to run the macro | |
564 | expressed on the right hand side (that is, to insert the text | |
565 | `> output' into the line). | |
566 | ||
567 | A number of symbolic character names are recognized while | |
568 | processing this key binding syntax: DEL, ESC, ESCAPE, LFD, | |
569 | NEWLINE, RET, RETURN, RUBOUT, SPACE, SPC, and TAB. | |
570 | ||
571 | "KEYSEQ": FUNCTION-NAME or MACRO | |
572 | KEYSEQ differs from KEYNAME above in that strings denoting an | |
573 | entire key sequence can be specified, by placing the key | |
574 | sequence in double quotes. Some GNU Emacs style key escapes | |
575 | can be used, as in the following example, but the special | |
576 | character names are not recognized. | |
577 | ||
578 | "\C-u": universal-argument | |
579 | "\C-x\C-r": re-read-init-file | |
580 | "\e[11~": "Function Key 1" | |
581 | ||
582 | In the above example, `C-u' is again bound to the function | |
583 | `universal-argument' (just as it was in the first example), | |
584 | `C-x C-r' is bound to the function `re-read-init-file', and | |
585 | `<ESC> <[> <1> <1> <~>' is bound to insert the text `Function | |
586 | Key 1'. | |
587 | ||
588 | ||
589 | The following GNU Emacs style escape sequences are available when | |
590 | specifying key sequences: | |
591 | ||
592 | `\C-' | |
593 | control prefix | |
594 | ||
595 | `\M-' | |
596 | meta prefix | |
597 | ||
598 | `\e' | |
599 | an escape character | |
600 | ||
601 | `\\' | |
602 | backslash | |
603 | ||
604 | `\"' | |
605 | <">, a double quotation mark | |
606 | ||
607 | `\'' | |
608 | <'>, a single quote or apostrophe | |
609 | ||
610 | In addition to the GNU Emacs style escape sequences, a second set | |
611 | of backslash escapes is available: | |
612 | ||
613 | `\a' | |
614 | alert (bell) | |
615 | ||
616 | `\b' | |
617 | backspace | |
618 | ||
619 | `\d' | |
620 | delete | |
621 | ||
622 | `\f' | |
623 | form feed | |
624 | ||
625 | `\n' | |
626 | newline | |
627 | ||
628 | `\r' | |
629 | carriage return | |
630 | ||
631 | `\t' | |
632 | horizontal tab | |
633 | ||
634 | `\v' | |
635 | vertical tab | |
636 | ||
637 | `\NNN' | |
638 | the eight-bit character whose value is the octal value NNN | |
639 | (one to three digits) | |
640 | ||
641 | `\xHH' | |
642 | the eight-bit character whose value is the hexadecimal value | |
643 | HH (one or two hex digits) | |
644 | ||
645 | When entering the text of a macro, single or double quotes must be | |
646 | used to indicate a macro definition. Unquoted text is assumed to | |
647 | be a function name. In the macro body, the backslash escapes | |
648 | described above are expanded. Backslash will quote any other | |
649 | character in the macro text, including `"' and `''. For example, | |
650 | the following binding will make `C-x \' insert a single `\' into | |
651 | the line: | |
652 | "\C-x\\": "\\" | |
653 | ||
654 | ||
655 | \1f | |
656 | File: readline.info, Node: Conditional Init Constructs, Next: Sample Init File, Prev: Readline Init File Syntax, Up: Readline Init File | |
657 | ||
bc7bed50 CR |
658 | 1.3.2 Conditional Init Constructs |
659 | --------------------------------- | |
5e13499c | 660 | |
bc7bed50 | 661 | Readline implements a facility similar in spirit to the conditional |
5e13499c CR |
662 | compilation features of the C preprocessor which allows key bindings |
663 | and variable settings to be performed as the result of tests. There | |
664 | are four parser directives used. | |
665 | ||
666 | `$if' | |
667 | The `$if' construct allows bindings to be made based on the | |
668 | editing mode, the terminal being used, or the application using | |
669 | Readline. The text of the test extends to the end of the line; no | |
670 | characters are required to isolate it. | |
671 | ||
672 | `mode' | |
673 | The `mode=' form of the `$if' directive is used to test | |
674 | whether Readline is in `emacs' or `vi' mode. This may be | |
675 | used in conjunction with the `set keymap' command, for | |
676 | instance, to set bindings in the `emacs-standard' and | |
677 | `emacs-ctlx' keymaps only if Readline is starting out in | |
678 | `emacs' mode. | |
679 | ||
680 | `term' | |
681 | The `term=' form may be used to include terminal-specific key | |
682 | bindings, perhaps to bind the key sequences output by the | |
683 | terminal's function keys. The word on the right side of the | |
684 | `=' is tested against both the full name of the terminal and | |
685 | the portion of the terminal name before the first `-'. This | |
686 | allows `sun' to match both `sun' and `sun-cmd', for instance. | |
687 | ||
688 | `application' | |
689 | The APPLICATION construct is used to include | |
690 | application-specific settings. Each program using the | |
691 | Readline library sets the APPLICATION NAME, and you can test | |
692 | for a particular value. This could be used to bind key | |
693 | sequences to functions useful for a specific program. For | |
694 | instance, the following command adds a key sequence that | |
695 | quotes the current or previous word in Bash: | |
696 | $if Bash | |
697 | # Quote the current or previous word | |
698 | "\C-xq": "\eb\"\ef\"" | |
699 | $endif | |
700 | ||
701 | `$endif' | |
702 | This command, as seen in the previous example, terminates an `$if' | |
703 | command. | |
704 | ||
705 | `$else' | |
706 | Commands in this branch of the `$if' directive are executed if the | |
707 | test fails. | |
708 | ||
709 | `$include' | |
710 | This directive takes a single filename as an argument and reads | |
711 | commands and bindings from that file. For example, the following | |
712 | directive reads from `/etc/inputrc': | |
713 | $include /etc/inputrc | |
714 | ||
715 | \1f | |
716 | File: readline.info, Node: Sample Init File, Prev: Conditional Init Constructs, Up: Readline Init File | |
717 | ||
bc7bed50 CR |
718 | 1.3.3 Sample Init File |
719 | ---------------------- | |
5e13499c | 720 | |
bc7bed50 CR |
721 | Here is an example of an INPUTRC file. This illustrates key binding, |
722 | variable assignment, and conditional syntax. | |
5e13499c CR |
723 | |
724 | ||
725 | # This file controls the behaviour of line input editing for | |
726 | # programs that use the GNU Readline library. Existing | |
727 | # programs include FTP, Bash, and GDB. | |
728 | # | |
729 | # You can re-read the inputrc file with C-x C-r. | |
730 | # Lines beginning with '#' are comments. | |
731 | # | |
732 | # First, include any systemwide bindings and variable | |
733 | # assignments from /etc/Inputrc | |
734 | $include /etc/Inputrc | |
bc7bed50 | 735 | |
5e13499c CR |
736 | # |
737 | # Set various bindings for emacs mode. | |
bc7bed50 | 738 | |
5e13499c | 739 | set editing-mode emacs |
bc7bed50 | 740 | |
5e13499c | 741 | $if mode=emacs |
bc7bed50 | 742 | |
5e13499c | 743 | Meta-Control-h: backward-kill-word Text after the function name is ignored |
bc7bed50 | 744 | |
5e13499c CR |
745 | # |
746 | # Arrow keys in keypad mode | |
747 | # | |
748 | #"\M-OD": backward-char | |
749 | #"\M-OC": forward-char | |
750 | #"\M-OA": previous-history | |
751 | #"\M-OB": next-history | |
752 | # | |
753 | # Arrow keys in ANSI mode | |
754 | # | |
755 | "\M-[D": backward-char | |
756 | "\M-[C": forward-char | |
757 | "\M-[A": previous-history | |
758 | "\M-[B": next-history | |
759 | # | |
760 | # Arrow keys in 8 bit keypad mode | |
761 | # | |
762 | #"\M-\C-OD": backward-char | |
763 | #"\M-\C-OC": forward-char | |
764 | #"\M-\C-OA": previous-history | |
765 | #"\M-\C-OB": next-history | |
766 | # | |
767 | # Arrow keys in 8 bit ANSI mode | |
768 | # | |
769 | #"\M-\C-[D": backward-char | |
770 | #"\M-\C-[C": forward-char | |
771 | #"\M-\C-[A": previous-history | |
772 | #"\M-\C-[B": next-history | |
bc7bed50 | 773 | |
5e13499c | 774 | C-q: quoted-insert |
bc7bed50 | 775 | |
5e13499c | 776 | $endif |
bc7bed50 | 777 | |
5e13499c CR |
778 | # An old-style binding. This happens to be the default. |
779 | TAB: complete | |
bc7bed50 | 780 | |
5e13499c CR |
781 | # Macros that are convenient for shell interaction |
782 | $if Bash | |
783 | # edit the path | |
784 | "\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f" | |
785 | # prepare to type a quoted word -- | |
786 | # insert open and close double quotes | |
787 | # and move to just after the open quote | |
788 | "\C-x\"": "\"\"\C-b" | |
789 | # insert a backslash (testing backslash escapes | |
790 | # in sequences and macros) | |
791 | "\C-x\\": "\\" | |
792 | # Quote the current or previous word | |
793 | "\C-xq": "\eb\"\ef\"" | |
794 | # Add a binding to refresh the line, which is unbound | |
795 | "\C-xr": redraw-current-line | |
796 | # Edit variable on current line. | |
797 | "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y=" | |
798 | $endif | |
bc7bed50 | 799 | |
5e13499c CR |
800 | # use a visible bell if one is available |
801 | set bell-style visible | |
bc7bed50 | 802 | |
5e13499c CR |
803 | # don't strip characters to 7 bits when reading |
804 | set input-meta on | |
bc7bed50 | 805 | |
5e13499c CR |
806 | # allow iso-latin1 characters to be inserted rather |
807 | # than converted to prefix-meta sequences | |
808 | set convert-meta off | |
bc7bed50 | 809 | |
5e13499c CR |
810 | # display characters with the eighth bit set directly |
811 | # rather than as meta-prefixed characters | |
812 | set output-meta on | |
bc7bed50 | 813 | |
5e13499c CR |
814 | # if there are more than 150 possible completions for |
815 | # a word, ask the user if he wants to see all of them | |
816 | set completion-query-items 150 | |
bc7bed50 | 817 | |
5e13499c CR |
818 | # For FTP |
819 | $if Ftp | |
820 | "\C-xg": "get \M-?" | |
821 | "\C-xt": "put \M-?" | |
822 | "\M-.": yank-last-arg | |
823 | $endif | |
824 | ||
825 | \1f | |
826 | File: readline.info, Node: Bindable Readline Commands, Next: Readline vi Mode, Prev: Readline Init File, Up: Command Line Editing | |
827 | ||
bc7bed50 CR |
828 | 1.4 Bindable Readline Commands |
829 | ============================== | |
5e13499c CR |
830 | |
831 | * Menu: | |
832 | ||
833 | * Commands For Moving:: Moving about the line. | |
834 | * Commands For History:: Getting at previous lines. | |
835 | * Commands For Text:: Commands for changing text. | |
836 | * Commands For Killing:: Commands for killing and yanking. | |
837 | * Numeric Arguments:: Specifying numeric arguments, repeat counts. | |
838 | * Commands For Completion:: Getting Readline to do the typing for you. | |
839 | * Keyboard Macros:: Saving and re-executing typed characters | |
840 | * Miscellaneous Commands:: Other miscellaneous commands. | |
841 | ||
842 | This section describes Readline commands that may be bound to key | |
843 | sequences. Command names without an accompanying key sequence are | |
844 | unbound by default. | |
845 | ||
846 | In the following descriptions, "point" refers to the current cursor | |
847 | position, and "mark" refers to a cursor position saved by the | |
848 | `set-mark' command. The text between the point and mark is referred to | |
849 | as the "region". | |
850 | ||
851 | \1f | |
852 | File: readline.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands | |
853 | ||
bc7bed50 CR |
854 | 1.4.1 Commands For Moving |
855 | ------------------------- | |
5e13499c CR |
856 | |
857 | `beginning-of-line (C-a)' | |
858 | Move to the start of the current line. | |
859 | ||
860 | `end-of-line (C-e)' | |
861 | Move to the end of the line. | |
862 | ||
863 | `forward-char (C-f)' | |
864 | Move forward a character. | |
865 | ||
866 | `backward-char (C-b)' | |
867 | Move back a character. | |
868 | ||
869 | `forward-word (M-f)' | |
870 | Move forward to the end of the next word. Words are composed of | |
871 | letters and digits. | |
872 | ||
873 | `backward-word (M-b)' | |
874 | Move back to the start of the current or previous word. Words are | |
875 | composed of letters and digits. | |
876 | ||
877 | `clear-screen (C-l)' | |
878 | Clear the screen and redraw the current line, leaving the current | |
879 | line at the top of the screen. | |
880 | ||
881 | `redraw-current-line ()' | |
882 | Refresh the current line. By default, this is unbound. | |
883 | ||
884 | ||
885 | \1f | |
886 | File: readline.info, Node: Commands For History, Next: Commands For Text, Prev: Commands For Moving, Up: Bindable Readline Commands | |
887 | ||
bc7bed50 CR |
888 | 1.4.2 Commands For Manipulating The History |
889 | ------------------------------------------- | |
5e13499c CR |
890 | |
891 | `accept-line (Newline or Return)' | |
892 | Accept the line regardless of where the cursor is. If this line is | |
893 | non-empty, it may be added to the history list for future recall | |
894 | with `add_history()'. If this line is a modified history line, | |
895 | the history line is restored to its original state. | |
896 | ||
897 | `previous-history (C-p)' | |
898 | Move `back' through the history list, fetching the previous | |
899 | command. | |
900 | ||
901 | `next-history (C-n)' | |
902 | Move `forward' through the history list, fetching the next command. | |
903 | ||
904 | `beginning-of-history (M-<)' | |
905 | Move to the first line in the history. | |
906 | ||
907 | `end-of-history (M->)' | |
908 | Move to the end of the input history, i.e., the line currently | |
909 | being entered. | |
910 | ||
911 | `reverse-search-history (C-r)' | |
912 | Search backward starting at the current line and moving `up' | |
913 | through the history as necessary. This is an incremental search. | |
914 | ||
915 | `forward-search-history (C-s)' | |
916 | Search forward starting at the current line and moving `down' | |
917 | through the the history as necessary. This is an incremental | |
918 | search. | |
919 | ||
920 | `non-incremental-reverse-search-history (M-p)' | |
921 | Search backward starting at the current line and moving `up' | |
922 | through the history as necessary using a non-incremental search | |
923 | for a string supplied by the user. | |
924 | ||
925 | `non-incremental-forward-search-history (M-n)' | |
926 | Search forward starting at the current line and moving `down' | |
927 | through the the history as necessary using a non-incremental search | |
928 | for a string supplied by the user. | |
929 | ||
930 | `history-search-forward ()' | |
931 | Search forward through the history for the string of characters | |
932 | between the start of the current line and the point. This is a | |
933 | non-incremental search. By default, this command is unbound. | |
934 | ||
935 | `history-search-backward ()' | |
936 | Search backward through the history for the string of characters | |
937 | between the start of the current line and the point. This is a | |
938 | non-incremental search. By default, this command is unbound. | |
939 | ||
940 | `yank-nth-arg (M-C-y)' | |
941 | Insert the first argument to the previous command (usually the | |
942 | second word on the previous line) at point. With an argument N, | |
943 | insert the Nth word from the previous command (the words in the | |
944 | previous command begin with word 0). A negative argument inserts | |
bc7bed50 CR |
945 | the Nth word from the end of the previous command. Once the |
946 | argument N is computed, the argument is extracted as if the `!N' | |
947 | history expansion had been specified. | |
5e13499c CR |
948 | |
949 | `yank-last-arg (M-. or M-_)' | |
950 | Insert last argument to the previous command (the last word of the | |
951 | previous history entry). With an argument, behave exactly like | |
952 | `yank-nth-arg'. Successive calls to `yank-last-arg' move back | |
953 | through the history list, inserting the last argument of each line | |
bc7bed50 CR |
954 | in turn. The history expansion facilities are used to extract the |
955 | last argument, as if the `!$' history expansion had been specified. | |
5e13499c CR |
956 | |
957 | ||
958 | \1f | |
959 | File: readline.info, Node: Commands For Text, Next: Commands For Killing, Prev: Commands For History, Up: Bindable Readline Commands | |
960 | ||
bc7bed50 CR |
961 | 1.4.3 Commands For Changing Text |
962 | -------------------------------- | |
5e13499c CR |
963 | |
964 | `delete-char (C-d)' | |
965 | Delete the character at point. If point is at the beginning of | |
966 | the line, there are no characters in the line, and the last | |
967 | character typed was not bound to `delete-char', then return EOF. | |
968 | ||
969 | `backward-delete-char (Rubout)' | |
970 | Delete the character behind the cursor. A numeric argument means | |
971 | to kill the characters instead of deleting them. | |
972 | ||
973 | `forward-backward-delete-char ()' | |
974 | Delete the character under the cursor, unless the cursor is at the | |
975 | end of the line, in which case the character behind the cursor is | |
976 | deleted. By default, this is not bound to a key. | |
977 | ||
978 | `quoted-insert (C-q or C-v)' | |
979 | Add the next character typed to the line verbatim. This is how to | |
980 | insert key sequences like `C-q', for example. | |
981 | ||
982 | `tab-insert (M-<TAB>)' | |
983 | Insert a tab character. | |
984 | ||
985 | `self-insert (a, b, A, 1, !, ...)' | |
986 | Insert yourself. | |
987 | ||
988 | `transpose-chars (C-t)' | |
989 | Drag the character before the cursor forward over the character at | |
990 | the cursor, moving the cursor forward as well. If the insertion | |
991 | point is at the end of the line, then this transposes the last two | |
992 | characters of the line. Negative arguments have no effect. | |
993 | ||
994 | `transpose-words (M-t)' | |
995 | Drag the word before point past the word after point, moving point | |
996 | past that word as well. If the insertion point is at the end of | |
997 | the line, this transposes the last two words on the line. | |
998 | ||
999 | `upcase-word (M-u)' | |
1000 | Uppercase the current (or following) word. With a negative | |
1001 | argument, uppercase the previous word, but do not move the cursor. | |
1002 | ||
1003 | `downcase-word (M-l)' | |
1004 | Lowercase the current (or following) word. With a negative | |
1005 | argument, lowercase the previous word, but do not move the cursor. | |
1006 | ||
1007 | `capitalize-word (M-c)' | |
1008 | Capitalize the current (or following) word. With a negative | |
1009 | argument, capitalize the previous word, but do not move the cursor. | |
1010 | ||
1011 | `overwrite-mode ()' | |
1012 | Toggle overwrite mode. With an explicit positive numeric argument, | |
1013 | switches to overwrite mode. With an explicit non-positive numeric | |
1014 | argument, switches to insert mode. This command affects only | |
1015 | `emacs' mode; `vi' mode does overwrite differently. Each call to | |
1016 | `readline()' starts in insert mode. | |
1017 | ||
1018 | In overwrite mode, characters bound to `self-insert' replace the | |
1019 | text at point rather than pushing the text to the right. | |
1020 | Characters bound to `backward-delete-char' replace the character | |
1021 | before point with a space. | |
1022 | ||
1023 | By default, this command is unbound. | |
1024 | ||
1025 | ||
1026 | \1f | |
1027 | File: readline.info, Node: Commands For Killing, Next: Numeric Arguments, Prev: Commands For Text, Up: Bindable Readline Commands | |
1028 | ||
bc7bed50 CR |
1029 | 1.4.4 Killing And Yanking |
1030 | ------------------------- | |
5e13499c CR |
1031 | |
1032 | `kill-line (C-k)' | |
1033 | Kill the text from point to the end of the line. | |
1034 | ||
1035 | `backward-kill-line (C-x Rubout)' | |
1036 | Kill backward to the beginning of the line. | |
1037 | ||
1038 | `unix-line-discard (C-u)' | |
1039 | Kill backward from the cursor to the beginning of the current line. | |
1040 | ||
1041 | `kill-whole-line ()' | |
1042 | Kill all characters on the current line, no matter where point is. | |
1043 | By default, this is unbound. | |
1044 | ||
1045 | `kill-word (M-d)' | |
1046 | Kill from point to the end of the current word, or if between | |
1047 | words, to the end of the next word. Word boundaries are the same | |
1048 | as `forward-word'. | |
1049 | ||
1050 | `backward-kill-word (M-<DEL>)' | |
1051 | Kill the word behind point. Word boundaries are the same as | |
1052 | `backward-word'. | |
1053 | ||
1054 | `unix-word-rubout (C-w)' | |
1055 | Kill the word behind point, using white space as a word boundary. | |
1056 | The killed text is saved on the kill-ring. | |
1057 | ||
e6e3b444 CR |
1058 | `unix-filename-rubout ()' |
1059 | Kill the word behind point, using white space and the slash | |
1060 | character as the word boundaries. The killed text is saved on the | |
1061 | kill-ring. | |
1062 | ||
5e13499c CR |
1063 | `delete-horizontal-space ()' |
1064 | Delete all spaces and tabs around point. By default, this is | |
1065 | unbound. | |
1066 | ||
1067 | `kill-region ()' | |
1068 | Kill the text in the current region. By default, this command is | |
1069 | unbound. | |
1070 | ||
1071 | `copy-region-as-kill ()' | |
1072 | Copy the text in the region to the kill buffer, so it can be yanked | |
1073 | right away. By default, this command is unbound. | |
1074 | ||
1075 | `copy-backward-word ()' | |
1076 | Copy the word before point to the kill buffer. The word | |
1077 | boundaries are the same as `backward-word'. By default, this | |
1078 | command is unbound. | |
1079 | ||
1080 | `copy-forward-word ()' | |
1081 | Copy the word following point to the kill buffer. The word | |
1082 | boundaries are the same as `forward-word'. By default, this | |
1083 | command is unbound. | |
1084 | ||
1085 | `yank (C-y)' | |
1086 | Yank the top of the kill ring into the buffer at point. | |
1087 | ||
1088 | `yank-pop (M-y)' | |
1089 | Rotate the kill-ring, and yank the new top. You can only do this | |
1090 | if the prior command is `yank' or `yank-pop'. | |
1091 | ||
1092 | \1f | |
1093 | File: readline.info, Node: Numeric Arguments, Next: Commands For Completion, Prev: Commands For Killing, Up: Bindable Readline Commands | |
1094 | ||
bc7bed50 CR |
1095 | 1.4.5 Specifying Numeric Arguments |
1096 | ---------------------------------- | |
5e13499c CR |
1097 | |
1098 | `digit-argument (M-0, M-1, ... M--)' | |
1099 | Add this digit to the argument already accumulating, or start a new | |
1100 | argument. `M--' starts a negative argument. | |
1101 | ||
1102 | `universal-argument ()' | |
1103 | This is another way to specify an argument. If this command is | |
1104 | followed by one or more digits, optionally with a leading minus | |
1105 | sign, those digits define the argument. If the command is | |
1106 | followed by digits, executing `universal-argument' again ends the | |
1107 | numeric argument, but is otherwise ignored. As a special case, if | |
1108 | this command is immediately followed by a character that is | |
1109 | neither a digit or minus sign, the argument count for the next | |
1110 | command is multiplied by four. The argument count is initially | |
1111 | one, so executing this function the first time makes the argument | |
1112 | count four, a second time makes the argument count sixteen, and so | |
1113 | on. By default, this is not bound to a key. | |
1114 | ||
1115 | \1f | |
1116 | File: readline.info, Node: Commands For Completion, Next: Keyboard Macros, Prev: Numeric Arguments, Up: Bindable Readline Commands | |
1117 | ||
bc7bed50 CR |
1118 | 1.4.6 Letting Readline Type For You |
1119 | ----------------------------------- | |
5e13499c CR |
1120 | |
1121 | `complete (<TAB>)' | |
1122 | Attempt to perform completion on the text before point. The | |
1123 | actual completion performed is application-specific. The default | |
1124 | is filename completion. | |
1125 | ||
1126 | `possible-completions (M-?)' | |
1127 | List the possible completions of the text before point. | |
1128 | ||
1129 | `insert-completions (M-*)' | |
1130 | Insert all completions of the text before point that would have | |
1131 | been generated by `possible-completions'. | |
1132 | ||
1133 | `menu-complete ()' | |
1134 | Similar to `complete', but replaces the word to be completed with | |
1135 | a single match from the list of possible completions. Repeated | |
1136 | execution of `menu-complete' steps through the list of possible | |
1137 | completions, inserting each match in turn. At the end of the list | |
1138 | of completions, the bell is rung (subject to the setting of | |
1139 | `bell-style') and the original text is restored. An argument of N | |
1140 | moves N positions forward in the list of matches; a negative | |
1141 | argument may be used to move backward through the list. This | |
1142 | command is intended to be bound to <TAB>, but is unbound by | |
1143 | default. | |
1144 | ||
1145 | `delete-char-or-list ()' | |
1146 | Deletes the character under the cursor if not at the beginning or | |
1147 | end of the line (like `delete-char'). If at the end of the line, | |
1148 | behaves identically to `possible-completions'. This command is | |
1149 | unbound by default. | |
1150 | ||
1151 | ||
1152 | \1f | |
1153 | File: readline.info, Node: Keyboard Macros, Next: Miscellaneous Commands, Prev: Commands For Completion, Up: Bindable Readline Commands | |
1154 | ||
bc7bed50 CR |
1155 | 1.4.7 Keyboard Macros |
1156 | --------------------- | |
5e13499c CR |
1157 | |
1158 | `start-kbd-macro (C-x ()' | |
1159 | Begin saving the characters typed into the current keyboard macro. | |
1160 | ||
1161 | `end-kbd-macro (C-x ))' | |
1162 | Stop saving the characters typed into the current keyboard macro | |
1163 | and save the definition. | |
1164 | ||
1165 | `call-last-kbd-macro (C-x e)' | |
1166 | Re-execute the last keyboard macro defined, by making the | |
1167 | characters in the macro appear as if typed at the keyboard. | |
1168 | ||
1169 | ||
1170 | \1f | |
1171 | File: readline.info, Node: Miscellaneous Commands, Prev: Keyboard Macros, Up: Bindable Readline Commands | |
1172 | ||
bc7bed50 CR |
1173 | 1.4.8 Some Miscellaneous Commands |
1174 | --------------------------------- | |
5e13499c CR |
1175 | |
1176 | `re-read-init-file (C-x C-r)' | |
1177 | Read in the contents of the INPUTRC file, and incorporate any | |
1178 | bindings or variable assignments found there. | |
1179 | ||
1180 | `abort (C-g)' | |
1181 | Abort the current editing command and ring the terminal's bell | |
1182 | (subject to the setting of `bell-style'). | |
1183 | ||
1184 | `do-uppercase-version (M-a, M-b, M-X, ...)' | |
1185 | If the metafied character X is lowercase, run the command that is | |
1186 | bound to the corresponding uppercase character. | |
1187 | ||
1188 | `prefix-meta (<ESC>)' | |
1189 | Metafy the next character typed. This is for keyboards without a | |
1190 | meta key. Typing `<ESC> f' is equivalent to typing `M-f'. | |
1191 | ||
1192 | `undo (C-_ or C-x C-u)' | |
1193 | Incremental undo, separately remembered for each line. | |
1194 | ||
1195 | `revert-line (M-r)' | |
1196 | Undo all changes made to this line. This is like executing the | |
1197 | `undo' command enough times to get back to the beginning. | |
1198 | ||
1199 | `tilde-expand (M-~)' | |
1200 | Perform tilde expansion on the current word. | |
1201 | ||
1202 | `set-mark (C-@)' | |
1203 | Set the mark to the point. If a numeric argument is supplied, the | |
1204 | mark is set to that position. | |
1205 | ||
1206 | `exchange-point-and-mark (C-x C-x)' | |
1207 | Swap the point with the mark. The current cursor position is set | |
1208 | to the saved position, and the old cursor position is saved as the | |
1209 | mark. | |
1210 | ||
1211 | `character-search (C-])' | |
1212 | A character is read and point is moved to the next occurrence of | |
1213 | that character. A negative count searches for previous | |
1214 | occurrences. | |
1215 | ||
1216 | `character-search-backward (M-C-])' | |
1217 | A character is read and point is moved to the previous occurrence | |
1218 | of that character. A negative count searches for subsequent | |
1219 | occurrences. | |
1220 | ||
1221 | `insert-comment (M-#)' | |
1222 | Without a numeric argument, the value of the `comment-begin' | |
1223 | variable is inserted at the beginning of the current line. If a | |
1224 | numeric argument is supplied, this command acts as a toggle: if | |
1225 | the characters at the beginning of the line do not match the value | |
1226 | of `comment-begin', the value is inserted, otherwise the | |
1227 | characters in `comment-begin' are deleted from the beginning of | |
1228 | the line. In either case, the line is accepted as if a newline | |
1229 | had been typed. | |
1230 | ||
1231 | `dump-functions ()' | |
1232 | Print all of the functions and their key bindings to the Readline | |
1233 | output stream. If a numeric argument is supplied, the output is | |
1234 | formatted in such a way that it can be made part of an INPUTRC | |
1235 | file. This command is unbound by default. | |
1236 | ||
1237 | `dump-variables ()' | |
1238 | Print all of the settable variables and their values to the | |
1239 | Readline output stream. If a numeric argument is supplied, the | |
1240 | output is formatted in such a way that it can be made part of an | |
1241 | INPUTRC file. This command is unbound by default. | |
1242 | ||
1243 | `dump-macros ()' | |
1244 | Print all of the Readline key sequences bound to macros and the | |
1245 | strings they output. If a numeric argument is supplied, the | |
1246 | output is formatted in such a way that it can be made part of an | |
1247 | INPUTRC file. This command is unbound by default. | |
1248 | ||
1249 | `emacs-editing-mode (C-e)' | |
1250 | When in `vi' command mode, this causes a switch to `emacs' editing | |
1251 | mode. | |
1252 | ||
1253 | `vi-editing-mode (M-C-j)' | |
1254 | When in `emacs' editing mode, this causes a switch to `vi' editing | |
1255 | mode. | |
1256 | ||
1257 | ||
1258 | \1f | |
1259 | File: readline.info, Node: Readline vi Mode, Prev: Bindable Readline Commands, Up: Command Line Editing | |
1260 | ||
bc7bed50 CR |
1261 | 1.5 Readline vi Mode |
1262 | ==================== | |
5e13499c | 1263 | |
bc7bed50 | 1264 | While the Readline library does not have a full set of `vi' editing |
5e13499c CR |
1265 | functions, it does contain enough to allow simple editing of the line. |
1266 | The Readline `vi' mode behaves as specified in the POSIX 1003.2 | |
1267 | standard. | |
1268 | ||
1269 | In order to switch interactively between `emacs' and `vi' editing | |
1270 | modes, use the command `M-C-j' (bound to emacs-editing-mode when in | |
1271 | `vi' mode and to vi-editing-mode in `emacs' mode). The Readline | |
1272 | default is `emacs' mode. | |
1273 | ||
1274 | When you enter a line in `vi' mode, you are already placed in | |
1275 | `insertion' mode, as if you had typed an `i'. Pressing <ESC> switches | |
1276 | you into `command' mode, where you can edit the text of the line with | |
1277 | the standard `vi' movement keys, move to previous history lines with | |
1278 | `k' and subsequent lines with `j', and so forth. | |
1279 | ||
1280 | This document describes the GNU Readline Library, a utility for | |
bc7bed50 | 1281 | aiding in the consistency of user interface across discrete programs |
5e13499c CR |
1282 | that need to provide a command line interface. |
1283 | ||
bc7bed50 | 1284 | Copyright (C) 1988-2005 Free Software Foundation, Inc. |
5e13499c CR |
1285 | |
1286 | Permission is granted to make and distribute verbatim copies of this | |
1287 | manual provided the copyright notice and this permission notice pare | |
1288 | preserved on all copies. | |
1289 | ||
1290 | Permission is granted to copy and distribute modified versions of | |
1291 | this manual under the conditions for verbatim copying, provided that | |
1292 | the entire resulting derived work is distributed under the terms of a | |
1293 | permission notice identical to this one. | |
1294 | ||
1295 | Permission is granted to copy and distribute translations of this | |
1296 | manual into another language, under the above conditions for modified | |
1297 | versions, except that this permission notice may be stated in a | |
1298 | translation approved by the Foundation. | |
1299 | ||
1300 | \1f | |
1301 | File: readline.info, Node: Programming with GNU Readline, Next: Copying This Manual, Prev: Command Line Editing, Up: Top | |
1302 | ||
bc7bed50 CR |
1303 | 2 Programming with GNU Readline |
1304 | ******************************* | |
5e13499c | 1305 | |
bc7bed50 CR |
1306 | This chapter describes the interface between the GNU Readline Library |
1307 | and other programs. If you are a programmer, and you wish to include | |
1308 | the features found in GNU Readline such as completion, line editing, | |
1309 | and interactive history manipulation in your own programs, this section | |
1310 | is for you. | |
5e13499c CR |
1311 | |
1312 | * Menu: | |
1313 | ||
1314 | * Basic Behavior:: Using the default behavior of Readline. | |
1315 | * Custom Functions:: Adding your own functions to Readline. | |
1316 | * Readline Variables:: Variables accessible to custom | |
1317 | functions. | |
1318 | * Readline Convenience Functions:: Functions which Readline supplies to | |
1319 | aid in writing your own custom | |
1320 | functions. | |
1321 | * Readline Signal Handling:: How Readline behaves when it receives signals. | |
1322 | * Custom Completers:: Supplanting or supplementing Readline's | |
1323 | completion functions. | |
1324 | ||
1325 | \1f | |
1326 | File: readline.info, Node: Basic Behavior, Next: Custom Functions, Up: Programming with GNU Readline | |
1327 | ||
bc7bed50 CR |
1328 | 2.1 Basic Behavior |
1329 | ================== | |
5e13499c | 1330 | |
bc7bed50 CR |
1331 | Many programs provide a command line interface, such as `mail', `ftp', |
1332 | and `sh'. For such programs, the default behaviour of Readline is | |
1333 | sufficient. This section describes how to use Readline in the simplest | |
1334 | way possible, perhaps to replace calls in your code to `gets()' or | |
1335 | `fgets()'. | |
5e13499c CR |
1336 | |
1337 | The function `readline()' prints a prompt PROMPT and then reads and | |
1338 | returns a single line of text from the user. If PROMPT is `NULL' or | |
1339 | the empty string, no prompt is displayed. The line `readline' returns | |
1340 | is allocated with `malloc()'; the caller should `free()' the line when | |
1341 | it has finished with it. The declaration for `readline' in ANSI C is | |
1342 | ||
1343 | `char *readline (const char *PROMPT);' | |
1344 | ||
1345 | So, one might say | |
1346 | `char *line = readline ("Enter a line: ");' | |
bc7bed50 CR |
1347 | in order to read a line of text from the user. The line returned |
1348 | has the final newline removed, so only the text remains. | |
5e13499c CR |
1349 | |
1350 | If `readline' encounters an `EOF' while reading the line, and the | |
1351 | line is empty at that point, then `(char *)NULL' is returned. | |
1352 | Otherwise, the line is ended just as if a newline had been typed. | |
1353 | ||
1354 | If you want the user to be able to get at the line later, (with | |
1355 | <C-p> for example), you must call `add_history()' to save the line away | |
1356 | in a "history" list of such lines. | |
1357 | ||
1358 | `add_history (line)'; | |
1359 | ||
1360 | For full details on the GNU History Library, see the associated manual. | |
1361 | ||
1362 | It is preferable to avoid saving empty lines on the history list, | |
1363 | since users rarely have a burning need to reuse a blank line. Here is | |
1364 | a function which usefully replaces the standard `gets()' library | |
1365 | function, and has the advantage of no static buffer to overflow: | |
1366 | ||
1367 | /* A static variable for holding the line. */ | |
1368 | static char *line_read = (char *)NULL; | |
bc7bed50 | 1369 | |
5e13499c CR |
1370 | /* Read a string, and return a pointer to it. |
1371 | Returns NULL on EOF. */ | |
1372 | char * | |
1373 | rl_gets () | |
1374 | { | |
1375 | /* If the buffer has already been allocated, | |
1376 | return the memory to the free pool. */ | |
1377 | if (line_read) | |
1378 | { | |
1379 | free (line_read); | |
1380 | line_read = (char *)NULL; | |
1381 | } | |
bc7bed50 | 1382 | |
5e13499c CR |
1383 | /* Get a line from the user. */ |
1384 | line_read = readline (""); | |
bc7bed50 | 1385 | |
5e13499c CR |
1386 | /* If the line has any text in it, |
1387 | save it on the history. */ | |
1388 | if (line_read && *line_read) | |
1389 | add_history (line_read); | |
bc7bed50 | 1390 | |
5e13499c CR |
1391 | return (line_read); |
1392 | } | |
1393 | ||
1394 | This function gives the user the default behaviour of <TAB> | |
1395 | completion: completion on file names. If you do not want Readline to | |
1396 | complete on filenames, you can change the binding of the <TAB> key with | |
1397 | `rl_bind_key()'. | |
1398 | ||
1399 | `int rl_bind_key (int KEY, rl_command_func_t *FUNCTION);' | |
1400 | ||
1401 | `rl_bind_key()' takes two arguments: KEY is the character that you | |
1402 | want to bind, and FUNCTION is the address of the function to call when | |
1403 | KEY is pressed. Binding <TAB> to `rl_insert()' makes <TAB> insert | |
1404 | itself. `rl_bind_key()' returns non-zero if KEY is not a valid ASCII | |
1405 | character code (between 0 and 255). | |
1406 | ||
1407 | Thus, to disable the default <TAB> behavior, the following suffices: | |
1408 | `rl_bind_key ('\t', rl_insert);' | |
1409 | ||
1410 | This code should be executed once at the start of your program; you | |
1411 | might write a function called `initialize_readline()' which performs | |
1412 | this and other desired initializations, such as installing custom | |
1413 | completers (*note Custom Completers::). | |
1414 | ||
1415 | \1f | |
1416 | File: readline.info, Node: Custom Functions, Next: Readline Variables, Prev: Basic Behavior, Up: Programming with GNU Readline | |
1417 | ||
bc7bed50 CR |
1418 | 2.2 Custom Functions |
1419 | ==================== | |
5e13499c | 1420 | |
bc7bed50 CR |
1421 | Readline provides many functions for manipulating the text of the line, |
1422 | but it isn't possible to anticipate the needs of all programs. This | |
1423 | section describes the various functions and variables defined within | |
1424 | the Readline library which allow a user program to add customized | |
1425 | functionality to Readline. | |
5e13499c CR |
1426 | |
1427 | Before declaring any functions that customize Readline's behavior, or | |
1428 | using any functionality Readline provides in other code, an application | |
1429 | writer should include the file `<readline/readline.h>' in any file that | |
1430 | uses Readline's features. Since some of the definitions in | |
1431 | `readline.h' use the `stdio' library, the file `<stdio.h>' should be | |
1432 | included before `readline.h'. | |
1433 | ||
1434 | `readline.h' defines a C preprocessor variable that should be | |
1435 | treated as an integer, `RL_READLINE_VERSION', which may be used to | |
1436 | conditionally compile application code depending on the installed | |
1437 | Readline version. The value is a hexadecimal encoding of the major and | |
1438 | minor version numbers of the library, of the form 0xMMMM. MM is the | |
1439 | two-digit major version number; MM is the two-digit minor version | |
1440 | number. For Readline 4.2, for example, the value of | |
1441 | `RL_READLINE_VERSION' would be `0x0402'. | |
1442 | ||
1443 | * Menu: | |
1444 | ||
1445 | * Readline Typedefs:: C declarations to make code readable. | |
1446 | * Function Writing:: Variables and calling conventions. | |
1447 | ||
1448 | \1f | |
1449 | File: readline.info, Node: Readline Typedefs, Next: Function Writing, Up: Custom Functions | |
1450 | ||
bc7bed50 CR |
1451 | 2.2.1 Readline Typedefs |
1452 | ----------------------- | |
5e13499c | 1453 | |
bc7bed50 | 1454 | For readabilty, we declare a number of new object types, all pointers |
5e13499c CR |
1455 | to functions. |
1456 | ||
1457 | The reason for declaring these new types is to make it easier to | |
1458 | write code describing pointers to C functions with appropriately | |
1459 | prototyped arguments and return values. | |
1460 | ||
1461 | For instance, say we want to declare a variable FUNC as a pointer to | |
1462 | a function which takes two `int' arguments and returns an `int' (this | |
1463 | is the type of all of the Readline bindable functions). Instead of the | |
1464 | classic C declaration | |
1465 | ||
1466 | `int (*func)();' | |
1467 | ||
1468 | or the ANSI-C style declaration | |
1469 | ||
1470 | `int (*func)(int, int);' | |
1471 | ||
1472 | we may write | |
1473 | ||
1474 | `rl_command_func_t *func;' | |
1475 | ||
1476 | The full list of function pointer types available is | |
1477 | ||
1478 | `typedef int rl_command_func_t (int, int);' | |
1479 | ||
1480 | `typedef char *rl_compentry_func_t (const char *, int);' | |
1481 | ||
1482 | `typedef char **rl_completion_func_t (const char *, int, int);' | |
1483 | ||
1484 | `typedef char *rl_quote_func_t (char *, int, char *);' | |
1485 | ||
1486 | `typedef char *rl_dequote_func_t (char *, int);' | |
1487 | ||
1488 | `typedef int rl_compignore_func_t (char **);' | |
1489 | ||
1490 | `typedef void rl_compdisp_func_t (char **, int, int);' | |
1491 | ||
1492 | `typedef int rl_hook_func_t (void);' | |
1493 | ||
1494 | `typedef int rl_getc_func_t (FILE *);' | |
1495 | ||
1496 | `typedef int rl_linebuf_func_t (char *, int);' | |
1497 | ||
1498 | `typedef int rl_intfunc_t (int);' | |
1499 | ||
1500 | `#define rl_ivoidfunc_t rl_hook_func_t' | |
1501 | ||
1502 | `typedef int rl_icpfunc_t (char *);' | |
1503 | ||
1504 | `typedef int rl_icppfunc_t (char **);' | |
1505 | ||
1506 | `typedef void rl_voidfunc_t (void);' | |
1507 | ||
1508 | `typedef void rl_vintfunc_t (int);' | |
1509 | ||
1510 | `typedef void rl_vcpfunc_t (char *);' | |
1511 | ||
1512 | `typedef void rl_vcppfunc_t (char **);' | |
1513 | ||
1514 | \1f | |
1515 | File: readline.info, Node: Function Writing, Prev: Readline Typedefs, Up: Custom Functions | |
1516 | ||
bc7bed50 CR |
1517 | 2.2.2 Writing a New Function |
1518 | ---------------------------- | |
5e13499c | 1519 | |
bc7bed50 | 1520 | In order to write new functions for Readline, you need to know the |
5e13499c CR |
1521 | calling conventions for keyboard-invoked functions, and the names of the |
1522 | variables that describe the current state of the line read so far. | |
1523 | ||
1524 | The calling sequence for a command `foo' looks like | |
1525 | ||
1526 | `int foo (int count, int key)' | |
1527 | ||
1528 | where COUNT is the numeric argument (or 1 if defaulted) and KEY is the | |
1529 | key that invoked this function. | |
1530 | ||
1531 | It is completely up to the function as to what should be done with | |
1532 | the numeric argument. Some functions use it as a repeat count, some as | |
1533 | a flag, and others to choose alternate behavior (refreshing the current | |
1534 | line as opposed to refreshing the screen, for example). Some choose to | |
1535 | ignore it. In general, if a function uses the numeric argument as a | |
1536 | repeat count, it should be able to do something useful with both | |
1537 | negative and positive arguments. At the very least, it should be aware | |
1538 | that it can be passed a negative argument. | |
1539 | ||
1540 | A command function should return 0 if its action completes | |
bc7bed50 CR |
1541 | successfully, and a non-zero value if some error occurs. This is the |
1542 | convention obeyed by all of the builtin Readline bindable command | |
1543 | functions. | |
5e13499c CR |
1544 | |
1545 | \1f | |
1546 | File: readline.info, Node: Readline Variables, Next: Readline Convenience Functions, Prev: Custom Functions, Up: Programming with GNU Readline | |
1547 | ||
bc7bed50 CR |
1548 | 2.3 Readline Variables |
1549 | ====================== | |
5e13499c | 1550 | |
bc7bed50 | 1551 | These variables are available to function writers. |
5e13499c | 1552 | |
bc7bed50 | 1553 | -- Variable: char * rl_line_buffer |
5e13499c CR |
1554 | This is the line gathered so far. You are welcome to modify the |
1555 | contents of the line, but see *Note Allowing Undoing::. The | |
1556 | function `rl_extend_line_buffer' is available to increase the | |
1557 | memory allocated to `rl_line_buffer'. | |
1558 | ||
bc7bed50 | 1559 | -- Variable: int rl_point |
5e13499c CR |
1560 | The offset of the current cursor position in `rl_line_buffer' (the |
1561 | _point_). | |
1562 | ||
bc7bed50 | 1563 | -- Variable: int rl_end |
5e13499c CR |
1564 | The number of characters present in `rl_line_buffer'. When |
1565 | `rl_point' is at the end of the line, `rl_point' and `rl_end' are | |
1566 | equal. | |
1567 | ||
bc7bed50 | 1568 | -- Variable: int rl_mark |
5e13499c CR |
1569 | The MARK (saved position) in the current line. If set, the mark |
1570 | and point define a _region_. | |
1571 | ||
bc7bed50 | 1572 | -- Variable: int rl_done |
5e13499c CR |
1573 | Setting this to a non-zero value causes Readline to return the |
1574 | current line immediately. | |
1575 | ||
bc7bed50 | 1576 | -- Variable: int rl_num_chars_to_read |
5e13499c CR |
1577 | Setting this to a positive value before calling `readline()' causes |
1578 | Readline to return after accepting that many characters, rather | |
1579 | than reading up to a character bound to `accept-line'. | |
1580 | ||
bc7bed50 | 1581 | -- Variable: int rl_pending_input |
5e13499c CR |
1582 | Setting this to a value makes it the next keystroke read. This is |
1583 | a way to stuff a single character into the input stream. | |
1584 | ||
bc7bed50 | 1585 | -- Variable: int rl_dispatching |
5e13499c CR |
1586 | Set to a non-zero value if a function is being called from a key |
1587 | binding; zero otherwise. Application functions can test this to | |
1588 | discover whether they were called directly or by Readline's | |
1589 | dispatching mechanism. | |
1590 | ||
bc7bed50 | 1591 | -- Variable: int rl_erase_empty_line |
5e13499c CR |
1592 | Setting this to a non-zero value causes Readline to completely |
1593 | erase the current line, including any prompt, any time a newline | |
1594 | is typed as the only character on an otherwise-empty line. The | |
1595 | cursor is moved to the beginning of the newly-blank line. | |
1596 | ||
bc7bed50 | 1597 | -- Variable: char * rl_prompt |
5e13499c CR |
1598 | The prompt Readline uses. This is set from the argument to |
1599 | `readline()', and should not be assigned to directly. The | |
1600 | `rl_set_prompt()' function (*note Redisplay::) may be used to | |
1601 | modify the prompt string after calling `readline()'. | |
1602 | ||
bc7bed50 | 1603 | -- Variable: int rl_already_prompted |
5e13499c CR |
1604 | If an application wishes to display the prompt itself, rather than |
1605 | have Readline do it the first time `readline()' is called, it | |
1606 | should set this variable to a non-zero value after displaying the | |
1607 | prompt. The prompt must also be passed as the argument to | |
1608 | `readline()' so the redisplay functions can update the display | |
1609 | properly. The calling application is responsible for managing the | |
1610 | value; Readline never sets it. | |
1611 | ||
bc7bed50 | 1612 | -- Variable: const char * rl_library_version |
5e13499c CR |
1613 | The version number of this revision of the library. |
1614 | ||
bc7bed50 | 1615 | -- Variable: int rl_readline_version |
5e13499c CR |
1616 | An integer encoding the current version of the library. The |
1617 | encoding is of the form 0xMMMM, where MM is the two-digit major | |
1618 | version number, and MM is the two-digit minor version number. For | |
1619 | example, for Readline-4.2, `rl_readline_version' would have the | |
1620 | value 0x0402. | |
1621 | ||
bc7bed50 | 1622 | -- Variable: int rl_gnu_readline_p |
5e13499c CR |
1623 | Always set to 1, denoting that this is GNU readline rather than |
1624 | some emulation. | |
1625 | ||
bc7bed50 | 1626 | -- Variable: const char * rl_terminal_name |
5e13499c CR |
1627 | The terminal type, used for initialization. If not set by the |
1628 | application, Readline sets this to the value of the `TERM' | |
1629 | environment variable the first time it is called. | |
1630 | ||
bc7bed50 | 1631 | -- Variable: const char * rl_readline_name |
5e13499c CR |
1632 | This variable is set to a unique name by each application using |
1633 | Readline. The value allows conditional parsing of the inputrc file | |
1634 | (*note Conditional Init Constructs::). | |
1635 | ||
bc7bed50 | 1636 | -- Variable: FILE * rl_instream |
5e13499c CR |
1637 | The stdio stream from which Readline reads input. If `NULL', |
1638 | Readline defaults to STDIN. | |
1639 | ||
bc7bed50 | 1640 | -- Variable: FILE * rl_outstream |
5e13499c CR |
1641 | The stdio stream to which Readline performs output. If `NULL', |
1642 | Readline defaults to STDOUT. | |
1643 | ||
28089d04 CR |
1644 | -- Variable: int rl_prefer_env_winsize |
1645 | If non-zero, Readline gives values found in the `LINES' and | |
1646 | `COLUMNS' environment variables greater precedence than values | |
1647 | fetched from the kernel when computing the screen dimensions. | |
1648 | ||
bc7bed50 | 1649 | -- Variable: rl_command_func_t * rl_last_func |
5e13499c CR |
1650 | The address of the last command function Readline executed. May |
1651 | be used to test whether or not a function is being executed twice | |
1652 | in succession, for example. | |
1653 | ||
bc7bed50 | 1654 | -- Variable: rl_hook_func_t * rl_startup_hook |
5e13499c CR |
1655 | If non-zero, this is the address of a function to call just before |
1656 | `readline' prints the first prompt. | |
1657 | ||
bc7bed50 | 1658 | -- Variable: rl_hook_func_t * rl_pre_input_hook |
5e13499c CR |
1659 | If non-zero, this is the address of a function to call after the |
1660 | first prompt has been printed and just before `readline' starts | |
1661 | reading input characters. | |
1662 | ||
bc7bed50 | 1663 | -- Variable: rl_hook_func_t * rl_event_hook |
5e13499c CR |
1664 | If non-zero, this is the address of a function to call periodically |
1665 | when Readline is waiting for terminal input. By default, this | |
1666 | will be called at most ten times a second if there is no keyboard | |
1667 | input. | |
1668 | ||
bc7bed50 | 1669 | -- Variable: rl_getc_func_t * rl_getc_function |
5e13499c CR |
1670 | If non-zero, Readline will call indirectly through this pointer to |
1671 | get a character from the input stream. By default, it is set to | |
1672 | `rl_getc', the default Readline character input function (*note | |
1673 | Character Input::). | |
1674 | ||
bc7bed50 | 1675 | -- Variable: rl_voidfunc_t * rl_redisplay_function |
5e13499c CR |
1676 | If non-zero, Readline will call indirectly through this pointer to |
1677 | update the display with the current contents of the editing buffer. | |
1678 | By default, it is set to `rl_redisplay', the default Readline | |
1679 | redisplay function (*note Redisplay::). | |
1680 | ||
bc7bed50 | 1681 | -- Variable: rl_vintfunc_t * rl_prep_term_function |
5e13499c CR |
1682 | If non-zero, Readline will call indirectly through this pointer to |
1683 | initialize the terminal. The function takes a single argument, an | |
1684 | `int' flag that says whether or not to use eight-bit characters. | |
1685 | By default, this is set to `rl_prep_terminal' (*note Terminal | |
1686 | Management::). | |
1687 | ||
bc7bed50 | 1688 | -- Variable: rl_voidfunc_t * rl_deprep_term_function |
5e13499c CR |
1689 | If non-zero, Readline will call indirectly through this pointer to |
1690 | reset the terminal. This function should undo the effects of | |
1691 | `rl_prep_term_function'. By default, this is set to | |
1692 | `rl_deprep_terminal' (*note Terminal Management::). | |
1693 | ||
bc7bed50 | 1694 | -- Variable: Keymap rl_executing_keymap |
5e13499c CR |
1695 | This variable is set to the keymap (*note Keymaps::) in which the |
1696 | currently executing readline function was found. | |
1697 | ||
bc7bed50 | 1698 | -- Variable: Keymap rl_binding_keymap |
5e13499c CR |
1699 | This variable is set to the keymap (*note Keymaps::) in which the |
1700 | last key binding occurred. | |
1701 | ||
bc7bed50 | 1702 | -- Variable: char * rl_executing_macro |
5e13499c CR |
1703 | This variable is set to the text of any currently-executing macro. |
1704 | ||
bc7bed50 | 1705 | -- Variable: int rl_readline_state |
5e13499c CR |
1706 | A variable with bit values that encapsulate the current Readline |
1707 | state. A bit is set with the `RL_SETSTATE' macro, and unset with | |
1708 | the `RL_UNSETSTATE' macro. Use the `RL_ISSTATE' macro to test | |
1709 | whether a particular state bit is set. Current state bits include: | |
1710 | ||
1711 | `RL_STATE_NONE' | |
1712 | Readline has not yet been called, nor has it begun to | |
1713 | intialize. | |
1714 | ||
1715 | `RL_STATE_INITIALIZING' | |
1716 | Readline is initializing its internal data structures. | |
1717 | ||
1718 | `RL_STATE_INITIALIZED' | |
1719 | Readline has completed its initialization. | |
1720 | ||
1721 | `RL_STATE_TERMPREPPED' | |
1722 | Readline has modified the terminal modes to do its own input | |
1723 | and redisplay. | |
1724 | ||
1725 | `RL_STATE_READCMD' | |
1726 | Readline is reading a command from the keyboard. | |
1727 | ||
1728 | `RL_STATE_METANEXT' | |
1729 | Readline is reading more input after reading the meta-prefix | |
1730 | character. | |
1731 | ||
1732 | `RL_STATE_DISPATCHING' | |
1733 | Readline is dispatching to a command. | |
1734 | ||
1735 | `RL_STATE_MOREINPUT' | |
1736 | Readline is reading more input while executing an editing | |
1737 | command. | |
1738 | ||
1739 | `RL_STATE_ISEARCH' | |
1740 | Readline is performing an incremental history search. | |
1741 | ||
1742 | `RL_STATE_NSEARCH' | |
1743 | Readline is performing a non-incremental history search. | |
1744 | ||
1745 | `RL_STATE_SEARCH' | |
1746 | Readline is searching backward or forward through the history | |
1747 | for a string. | |
1748 | ||
1749 | `RL_STATE_NUMERICARG' | |
1750 | Readline is reading a numeric argument. | |
1751 | ||
1752 | `RL_STATE_MACROINPUT' | |
1753 | Readline is currently getting its input from a | |
1754 | previously-defined keyboard macro. | |
1755 | ||
1756 | `RL_STATE_MACRODEF' | |
1757 | Readline is currently reading characters defining a keyboard | |
1758 | macro. | |
1759 | ||
1760 | `RL_STATE_OVERWRITE' | |
1761 | Readline is in overwrite mode. | |
1762 | ||
1763 | `RL_STATE_COMPLETING' | |
1764 | Readline is performing word completion. | |
1765 | ||
1766 | `RL_STATE_SIGHANDLER' | |
1767 | Readline is currently executing the readline signal handler. | |
1768 | ||
1769 | `RL_STATE_UNDOING' | |
1770 | Readline is performing an undo. | |
1771 | ||
1772 | `RL_STATE_DONE' | |
1773 | Readline has read a key sequence bound to `accept-line' and | |
1774 | is about to return the line to the caller. | |
1775 | ||
1776 | ||
bc7bed50 | 1777 | -- Variable: int rl_explicit_arg |
5e13499c CR |
1778 | Set to a non-zero value if an explicit numeric argument was |
1779 | specified by the user. Only valid in a bindable command function. | |
1780 | ||
bc7bed50 | 1781 | -- Variable: int rl_numeric_arg |
5e13499c CR |
1782 | Set to the value of any numeric argument explicitly specified by |
1783 | the user before executing the current Readline function. Only | |
1784 | valid in a bindable command function. | |
1785 | ||
bc7bed50 | 1786 | -- Variable: int rl_editing_mode |
5e13499c CR |
1787 | Set to a value denoting Readline's current editing mode. A value |
1788 | of 1 means Readline is currently in emacs mode; 0 means that vi | |
1789 | mode is active. | |
1790 | ||
1791 | \1f | |
1792 | File: readline.info, Node: Readline Convenience Functions, Next: Readline Signal Handling, Prev: Readline Variables, Up: Programming with GNU Readline | |
1793 | ||
bc7bed50 CR |
1794 | 2.4 Readline Convenience Functions |
1795 | ================================== | |
5e13499c CR |
1796 | |
1797 | * Menu: | |
1798 | ||
1799 | * Function Naming:: How to give a function you write a name. | |
1800 | * Keymaps:: Making keymaps. | |
1801 | * Binding Keys:: Changing Keymaps. | |
1802 | * Associating Function Names and Bindings:: Translate function names to | |
1803 | key sequences. | |
1804 | * Allowing Undoing:: How to make your functions undoable. | |
1805 | * Redisplay:: Functions to control line display. | |
1806 | * Modifying Text:: Functions to modify `rl_line_buffer'. | |
1807 | * Character Input:: Functions to read keyboard input. | |
1808 | * Terminal Management:: Functions to manage terminal settings. | |
1809 | * Utility Functions:: Generally useful functions and hooks. | |
1810 | * Miscellaneous Functions:: Functions that don't fall into any category. | |
1811 | * Alternate Interface:: Using Readline in a `callback' fashion. | |
1812 | * A Readline Example:: An example Readline function. | |
1813 | ||
1814 | \1f | |
1815 | File: readline.info, Node: Function Naming, Next: Keymaps, Up: Readline Convenience Functions | |
1816 | ||
bc7bed50 CR |
1817 | 2.4.1 Naming a Function |
1818 | ----------------------- | |
5e13499c | 1819 | |
bc7bed50 | 1820 | The user can dynamically change the bindings of keys while using |
5e13499c CR |
1821 | Readline. This is done by representing the function with a descriptive |
1822 | name. The user is able to type the descriptive name when referring to | |
1823 | the function. Thus, in an init file, one might find | |
1824 | ||
1825 | Meta-Rubout: backward-kill-word | |
1826 | ||
1827 | This binds the keystroke <Meta-Rubout> to the function | |
1828 | _descriptively_ named `backward-kill-word'. You, as the programmer, | |
1829 | should bind the functions you write to descriptive names as well. | |
1830 | Readline provides a function for doing that: | |
1831 | ||
bc7bed50 | 1832 | -- Function: int rl_add_defun (const char *name, rl_command_func_t |
5e13499c CR |
1833 | *function, int key) |
1834 | Add NAME to the list of named functions. Make FUNCTION be the | |
1835 | function that gets called. If KEY is not -1, then bind it to | |
1836 | FUNCTION using `rl_bind_key()'. | |
1837 | ||
1838 | Using this function alone is sufficient for most applications. It | |
1839 | is the recommended way to add a few functions to the default functions | |
1840 | that Readline has built in. If you need to do something other than | |
1841 | adding a function to Readline, you may need to use the underlying | |
1842 | functions described below. | |
1843 | ||
1844 | \1f | |
1845 | File: readline.info, Node: Keymaps, Next: Binding Keys, Prev: Function Naming, Up: Readline Convenience Functions | |
1846 | ||
bc7bed50 CR |
1847 | 2.4.2 Selecting a Keymap |
1848 | ------------------------ | |
5e13499c | 1849 | |
bc7bed50 CR |
1850 | Key bindings take place on a "keymap". The keymap is the association |
1851 | between the keys that the user types and the functions that get run. | |
1852 | You can make your own keymaps, copy existing keymaps, and tell Readline | |
1853 | which keymap to use. | |
5e13499c | 1854 | |
bc7bed50 | 1855 | -- Function: Keymap rl_make_bare_keymap (void) |
5e13499c CR |
1856 | Returns a new, empty keymap. The space for the keymap is |
1857 | allocated with `malloc()'; the caller should free it by calling | |
1858 | `rl_discard_keymap()' when done. | |
1859 | ||
bc7bed50 | 1860 | -- Function: Keymap rl_copy_keymap (Keymap map) |
5e13499c CR |
1861 | Return a new keymap which is a copy of MAP. |
1862 | ||
bc7bed50 | 1863 | -- Function: Keymap rl_make_keymap (void) |
5e13499c CR |
1864 | Return a new keymap with the printing characters bound to |
1865 | rl_insert, the lowercase Meta characters bound to run their | |
1866 | equivalents, and the Meta digits bound to produce numeric | |
1867 | arguments. | |
1868 | ||
bc7bed50 | 1869 | -- Function: void rl_discard_keymap (Keymap keymap) |
5e13499c CR |
1870 | Free the storage associated with KEYMAP. |
1871 | ||
1872 | Readline has several internal keymaps. These functions allow you to | |
1873 | change which keymap is active. | |
1874 | ||
bc7bed50 | 1875 | -- Function: Keymap rl_get_keymap (void) |
5e13499c CR |
1876 | Returns the currently active keymap. |
1877 | ||
bc7bed50 | 1878 | -- Function: void rl_set_keymap (Keymap keymap) |
5e13499c CR |
1879 | Makes KEYMAP the currently active keymap. |
1880 | ||
bc7bed50 | 1881 | -- Function: Keymap rl_get_keymap_by_name (const char *name) |
5e13499c CR |
1882 | Return the keymap matching NAME. NAME is one which would be |
1883 | supplied in a `set keymap' inputrc line (*note Readline Init | |
1884 | File::). | |
1885 | ||
bc7bed50 | 1886 | -- Function: char * rl_get_keymap_name (Keymap keymap) |
5e13499c CR |
1887 | Return the name matching KEYMAP. NAME is one which would be |
1888 | supplied in a `set keymap' inputrc line (*note Readline Init | |
1889 | File::). | |
1890 | ||
1891 | \1f | |
1892 | File: readline.info, Node: Binding Keys, Next: Associating Function Names and Bindings, Prev: Keymaps, Up: Readline Convenience Functions | |
1893 | ||
bc7bed50 CR |
1894 | 2.4.3 Binding Keys |
1895 | ------------------ | |
5e13499c | 1896 | |
bc7bed50 | 1897 | Key sequences are associate with functions through the keymap. |
5e13499c CR |
1898 | Readline has several internal keymaps: `emacs_standard_keymap', |
1899 | `emacs_meta_keymap', `emacs_ctlx_keymap', `vi_movement_keymap', and | |
1900 | `vi_insertion_keymap'. `emacs_standard_keymap' is the default, and the | |
1901 | examples in this manual assume that. | |
1902 | ||
1903 | Since `readline()' installs a set of default key bindings the first | |
1904 | time it is called, there is always the danger that a custom binding | |
1905 | installed before the first call to `readline()' will be overridden. An | |
1906 | alternate mechanism is to install custom key bindings in an | |
1907 | initialization function assigned to the `rl_startup_hook' variable | |
1908 | (*note Readline Variables::). | |
1909 | ||
1910 | These functions manage key bindings. | |
1911 | ||
bc7bed50 | 1912 | -- Function: int rl_bind_key (int key, rl_command_func_t *function) |
5e13499c CR |
1913 | Binds KEY to FUNCTION in the currently active keymap. Returns |
1914 | non-zero in the case of an invalid KEY. | |
1915 | ||
bc7bed50 | 1916 | -- Function: int rl_bind_key_in_map (int key, rl_command_func_t |
5e13499c CR |
1917 | *function, Keymap map) |
1918 | Bind KEY to FUNCTION in MAP. Returns non-zero in the case of an | |
1919 | invalid KEY. | |
1920 | ||
bc7bed50 | 1921 | -- Function: int rl_bind_key_if_unbound (int key, rl_command_func_t |
5e13499c CR |
1922 | *function) |
1923 | Binds KEY to FUNCTION if it is not already bound in the currently | |
1924 | active keymap. Returns non-zero in the case of an invalid KEY or | |
1925 | if KEY is already bound. | |
1926 | ||
bc7bed50 | 1927 | -- Function: int rl_bind_key_if_unbound_in_map (int key, |
5e13499c CR |
1928 | rl_command_func_t *function, Keymap map) |
1929 | Binds KEY to FUNCTION if it is not already bound in MAP. Returns | |
1930 | non-zero in the case of an invalid KEY or if KEY is already bound. | |
1931 | ||
bc7bed50 | 1932 | -- Function: int rl_unbind_key (int key) |
5e13499c CR |
1933 | Bind KEY to the null function in the currently active keymap. |
1934 | Returns non-zero in case of error. | |
1935 | ||
bc7bed50 | 1936 | -- Function: int rl_unbind_key_in_map (int key, Keymap map) |
5e13499c CR |
1937 | Bind KEY to the null function in MAP. Returns non-zero in case of |
1938 | error. | |
1939 | ||
bc7bed50 | 1940 | -- Function: int rl_unbind_function_in_map (rl_command_func_t |
5e13499c CR |
1941 | *function, Keymap map) |
1942 | Unbind all keys that execute FUNCTION in MAP. | |
1943 | ||
bc7bed50 | 1944 | -- Function: int rl_unbind_command_in_map (const char *command, Keymap |
5e13499c CR |
1945 | map) |
1946 | Unbind all keys that are bound to COMMAND in MAP. | |
1947 | ||
bc7bed50 | 1948 | -- Function: int rl_bind_keyseq (const char *keyseq, rl_command_func_t |
5e13499c CR |
1949 | *function) |
1950 | Bind the key sequence represented by the string KEYSEQ to the | |
1951 | function FUNCTION, beginning in the current keymap. This makes | |
1952 | new keymaps as necessary. The return value is non-zero if KEYSEQ | |
1953 | is invalid. | |
1954 | ||
bc7bed50 | 1955 | -- Function: int rl_bind_keyseq_in_map (const char *keyseq, |
5e13499c CR |
1956 | rl_command_func_t *function, Keymap map) |
1957 | Bind the key sequence represented by the string KEYSEQ to the | |
1958 | function FUNCTION. This makes new keymaps as necessary. Initial | |
1959 | bindings are performed in MAP. The return value is non-zero if | |
1960 | KEYSEQ is invalid. | |
1961 | ||
bc7bed50 | 1962 | -- Function: int rl_set_key (const char *keyseq, rl_command_func_t |
5e13499c CR |
1963 | *function, Keymap map) |
1964 | Equivalent to `rl_bind_keyseq_in_map'. | |
1965 | ||
bc7bed50 | 1966 | -- Function: int rl_bind_keyseq_if_unbound (const char *keyseq, |
5e13499c CR |
1967 | rl_command_func_t *function) |
1968 | Binds KEYSEQ to FUNCTION if it is not already bound in the | |
1969 | currently active keymap. Returns non-zero in the case of an | |
1970 | invalid KEYSEQ or if KEYSEQ is already bound. | |
1971 | ||
bc7bed50 | 1972 | -- Function: int rl_bind_keyseq_if_unbound_in_map (const char *keyseq, |
5e13499c CR |
1973 | rl_command_func_t *function, Keymap map) |
1974 | Binds KEYSEQ to FUNCTION if it is not already bound in MAP. | |
1975 | Returns non-zero in the case of an invalid KEYSEQ or if KEYSEQ is | |
1976 | already bound. | |
1977 | ||
bc7bed50 | 1978 | -- Function: int rl_generic_bind (int type, const char *keyseq, char |
5e13499c CR |
1979 | *data, Keymap map) |
1980 | Bind the key sequence represented by the string KEYSEQ to the | |
1981 | arbitrary pointer DATA. TYPE says what kind of data is pointed to | |
1982 | by DATA; this can be a function (`ISFUNC'), a macro (`ISMACR'), or | |
1983 | a keymap (`ISKMAP'). This makes new keymaps as necessary. The | |
1984 | initial keymap in which to do bindings is MAP. | |
1985 | ||
bc7bed50 | 1986 | -- Function: int rl_parse_and_bind (char *line) |
5e13499c CR |
1987 | Parse LINE as if it had been read from the `inputrc' file and |
1988 | perform any key bindings and variable assignments found (*note | |
1989 | Readline Init File::). | |
1990 | ||
bc7bed50 | 1991 | -- Function: int rl_read_init_file (const char *filename) |
5e13499c CR |
1992 | Read keybindings and variable assignments from FILENAME (*note |
1993 | Readline Init File::). | |
1994 | ||
1995 | \1f | |
1996 | File: readline.info, Node: Associating Function Names and Bindings, Next: Allowing Undoing, Prev: Binding Keys, Up: Readline Convenience Functions | |
1997 | ||
bc7bed50 CR |
1998 | 2.4.4 Associating Function Names and Bindings |
1999 | --------------------------------------------- | |
5e13499c | 2000 | |
bc7bed50 CR |
2001 | These functions allow you to find out what keys invoke named functions |
2002 | and the functions invoked by a particular key sequence. You may also | |
2003 | associate a new function name with an arbitrary function. | |
5e13499c | 2004 | |
bc7bed50 | 2005 | -- Function: rl_command_func_t * rl_named_function (const char *name) |
5e13499c CR |
2006 | Return the function with name NAME. |
2007 | ||
bc7bed50 | 2008 | -- Function: rl_command_func_t * rl_function_of_keyseq (const char |
5e13499c CR |
2009 | *keyseq, Keymap map, int *type) |
2010 | Return the function invoked by KEYSEQ in keymap MAP. If MAP is | |
2011 | `NULL', the current keymap is used. If TYPE is not `NULL', the | |
2012 | type of the object is returned in the `int' variable it points to | |
2013 | (one of `ISFUNC', `ISKMAP', or `ISMACR'). | |
2014 | ||
bc7bed50 | 2015 | -- Function: char ** rl_invoking_keyseqs (rl_command_func_t *function) |
5e13499c CR |
2016 | Return an array of strings representing the key sequences used to |
2017 | invoke FUNCTION in the current keymap. | |
2018 | ||
bc7bed50 | 2019 | -- Function: char ** rl_invoking_keyseqs_in_map (rl_command_func_t |
5e13499c CR |
2020 | *function, Keymap map) |
2021 | Return an array of strings representing the key sequences used to | |
2022 | invoke FUNCTION in the keymap MAP. | |
2023 | ||
bc7bed50 | 2024 | -- Function: void rl_function_dumper (int readable) |
5e13499c CR |
2025 | Print the readline function names and the key sequences currently |
2026 | bound to them to `rl_outstream'. If READABLE is non-zero, the | |
2027 | list is formatted in such a way that it can be made part of an | |
2028 | `inputrc' file and re-read. | |
2029 | ||
bc7bed50 | 2030 | -- Function: void rl_list_funmap_names (void) |
5e13499c CR |
2031 | Print the names of all bindable Readline functions to |
2032 | `rl_outstream'. | |
2033 | ||
bc7bed50 | 2034 | -- Function: const char ** rl_funmap_names (void) |
5e13499c CR |
2035 | Return a NULL terminated array of known function names. The array |
2036 | is sorted. The array itself is allocated, but not the strings | |
2037 | inside. You should `free()' the array when you are done, but not | |
2038 | the pointers. | |
2039 | ||
bc7bed50 | 2040 | -- Function: int rl_add_funmap_entry (const char *name, |
5e13499c CR |
2041 | rl_command_func_t *function) |
2042 | Add NAME to the list of bindable Readline command names, and make | |
2043 | FUNCTION the function to be called when NAME is invoked. | |
2044 | ||
2045 | \1f | |
2046 | File: readline.info, Node: Allowing Undoing, Next: Redisplay, Prev: Associating Function Names and Bindings, Up: Readline Convenience Functions | |
2047 | ||
bc7bed50 CR |
2048 | 2.4.5 Allowing Undoing |
2049 | ---------------------- | |
5e13499c | 2050 | |
bc7bed50 | 2051 | Supporting the undo command is a painless thing, and makes your |
5e13499c CR |
2052 | functions much more useful. It is certainly easy to try something if |
2053 | you know you can undo it. | |
2054 | ||
2055 | If your function simply inserts text once, or deletes text once, and | |
2056 | uses `rl_insert_text()' or `rl_delete_text()' to do it, then undoing is | |
2057 | already done for you automatically. | |
2058 | ||
2059 | If you do multiple insertions or multiple deletions, or any | |
2060 | combination of these operations, you should group them together into | |
2061 | one operation. This is done with `rl_begin_undo_group()' and | |
2062 | `rl_end_undo_group()'. | |
2063 | ||
2064 | The types of events that can be undone are: | |
2065 | ||
2066 | enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; | |
2067 | ||
2068 | Notice that `UNDO_DELETE' means to insert some text, and | |
2069 | `UNDO_INSERT' means to delete some text. That is, the undo code tells | |
2070 | what to undo, not how to undo it. `UNDO_BEGIN' and `UNDO_END' are tags | |
2071 | added by `rl_begin_undo_group()' and `rl_end_undo_group()'. | |
2072 | ||
bc7bed50 | 2073 | -- Function: int rl_begin_undo_group (void) |
5e13499c CR |
2074 | Begins saving undo information in a group construct. The undo |
2075 | information usually comes from calls to `rl_insert_text()' and | |
2076 | `rl_delete_text()', but could be the result of calls to | |
2077 | `rl_add_undo()'. | |
2078 | ||
bc7bed50 | 2079 | -- Function: int rl_end_undo_group (void) |
5e13499c CR |
2080 | Closes the current undo group started with `rl_begin_undo_group |
2081 | ()'. There should be one call to `rl_end_undo_group()' for each | |
2082 | call to `rl_begin_undo_group()'. | |
2083 | ||
bc7bed50 CR |
2084 | -- Function: void rl_add_undo (enum undo_code what, int start, int |
2085 | end, char *text) | |
5e13499c CR |
2086 | Remember how to undo an event (according to WHAT). The affected |
2087 | text runs from START to END, and encompasses TEXT. | |
2088 | ||
bc7bed50 | 2089 | -- Function: void rl_free_undo_list (void) |
5e13499c CR |
2090 | Free the existing undo list. |
2091 | ||
bc7bed50 | 2092 | -- Function: int rl_do_undo (void) |
5e13499c CR |
2093 | Undo the first thing on the undo list. Returns `0' if there was |
2094 | nothing to undo, non-zero if something was undone. | |
2095 | ||
2096 | Finally, if you neither insert nor delete text, but directly modify | |
2097 | the existing text (e.g., change its case), call `rl_modifying()' once, | |
2098 | just before you modify the text. You must supply the indices of the | |
2099 | text range that you are going to modify. | |
2100 | ||
bc7bed50 | 2101 | -- Function: int rl_modifying (int start, int end) |
5e13499c CR |
2102 | Tell Readline to save the text between START and END as a single |
2103 | undo unit. It is assumed that you will subsequently modify that | |
2104 | text. | |
2105 | ||
2106 | \1f | |
2107 | File: readline.info, Node: Redisplay, Next: Modifying Text, Prev: Allowing Undoing, Up: Readline Convenience Functions | |
2108 | ||
bc7bed50 CR |
2109 | 2.4.6 Redisplay |
2110 | --------------- | |
5e13499c | 2111 | |
bc7bed50 | 2112 | -- Function: void rl_redisplay (void) |
5e13499c CR |
2113 | Change what's displayed on the screen to reflect the current |
2114 | contents of `rl_line_buffer'. | |
2115 | ||
bc7bed50 | 2116 | -- Function: int rl_forced_update_display (void) |
5e13499c CR |
2117 | Force the line to be updated and redisplayed, whether or not |
2118 | Readline thinks the screen display is correct. | |
2119 | ||
bc7bed50 | 2120 | -- Function: int rl_on_new_line (void) |
5e13499c CR |
2121 | Tell the update functions that we have moved onto a new (empty) |
2122 | line, usually after ouputting a newline. | |
2123 | ||
bc7bed50 | 2124 | -- Function: int rl_on_new_line_with_prompt (void) |
5e13499c CR |
2125 | Tell the update functions that we have moved onto a new line, with |
2126 | RL_PROMPT already displayed. This could be used by applications | |
2127 | that want to output the prompt string themselves, but still need | |
2128 | Readline to know the prompt string length for redisplay. It | |
2129 | should be used after setting RL_ALREADY_PROMPTED. | |
2130 | ||
bc7bed50 | 2131 | -- Function: int rl_reset_line_state (void) |
5e13499c CR |
2132 | Reset the display state to a clean state and redisplay the current |
2133 | line starting on a new line. | |
2134 | ||
bc7bed50 | 2135 | -- Function: int rl_crlf (void) |
5e13499c CR |
2136 | Move the cursor to the start of the next screen line. |
2137 | ||
bc7bed50 | 2138 | -- Function: int rl_show_char (int c) |
5e13499c CR |
2139 | Display character C on `rl_outstream'. If Readline has not been |
2140 | set to display meta characters directly, this will convert meta | |
2141 | characters to a meta-prefixed key sequence. This is intended for | |
2142 | use by applications which wish to do their own redisplay. | |
2143 | ||
bc7bed50 | 2144 | -- Function: int rl_message (const char *, ...) |
5e13499c CR |
2145 | The arguments are a format string as would be supplied to `printf', |
2146 | possibly containing conversion specifications such as `%d', and | |
2147 | any additional arguments necessary to satisfy the conversion | |
2148 | specifications. The resulting string is displayed in the "echo | |
2149 | area". The echo area is also used to display numeric arguments | |
bc7bed50 CR |
2150 | and search strings. You should call `rl_save_prompt' to save the |
2151 | prompt information before calling this function. | |
5e13499c | 2152 | |
bc7bed50 CR |
2153 | -- Function: int rl_clear_message (void) |
2154 | Clear the message in the echo area. If the prompt was saved with | |
2155 | a call to `rl_save_prompt' before the last call to `rl_message', | |
2156 | call `rl_restore_prompt' before calling this function. | |
5e13499c | 2157 | |
bc7bed50 | 2158 | -- Function: void rl_save_prompt (void) |
5e13499c CR |
2159 | Save the local Readline prompt display state in preparation for |
2160 | displaying a new message in the message area with `rl_message()'. | |
2161 | ||
bc7bed50 | 2162 | -- Function: void rl_restore_prompt (void) |
5e13499c | 2163 | Restore the local Readline prompt display state saved by the most |
bc7bed50 CR |
2164 | recent call to `rl_save_prompt'. if `rl_save_prompt' was called |
2165 | to save the prompt before a call to `rl_message', this function | |
2166 | should be called before the corresponding call to | |
2167 | `rl_clear_message'. | |
5e13499c | 2168 | |
bc7bed50 | 2169 | -- Function: int rl_expand_prompt (char *prompt) |
5e13499c CR |
2170 | Expand any special character sequences in PROMPT and set up the |
2171 | local Readline prompt redisplay variables. This function is | |
2172 | called by `readline()'. It may also be called to expand the | |
2173 | primary prompt if the `rl_on_new_line_with_prompt()' function or | |
2174 | `rl_already_prompted' variable is used. It returns the number of | |
2175 | visible characters on the last line of the (possibly multi-line) | |
e6e3b444 CR |
2176 | prompt. Applications may indicate that the prompt contains |
2177 | characters that take up no physical screen space when displayed by | |
2178 | bracketing a sequence of such characters with the special markers | |
2179 | `RL_PROMPT_START_IGNORE' and `RL_PROMPT_END_IGNORE' (declared in | |
2180 | `readline.h'. This may be used to embed terminal-specific escape | |
2181 | sequences in prompts. | |
5e13499c | 2182 | |
bc7bed50 | 2183 | -- Function: int rl_set_prompt (const char *prompt) |
5e13499c CR |
2184 | Make Readline use PROMPT for subsequent redisplay. This calls |
2185 | `rl_expand_prompt()' to expand the prompt and sets `rl_prompt' to | |
2186 | the result. | |
2187 | ||
2188 | \1f | |
2189 | File: readline.info, Node: Modifying Text, Next: Character Input, Prev: Redisplay, Up: Readline Convenience Functions | |
2190 | ||
bc7bed50 CR |
2191 | 2.4.7 Modifying Text |
2192 | -------------------- | |
5e13499c | 2193 | |
bc7bed50 | 2194 | -- Function: int rl_insert_text (const char *text) |
5e13499c CR |
2195 | Insert TEXT into the line at the current cursor position. Returns |
2196 | the number of characters inserted. | |
2197 | ||
bc7bed50 | 2198 | -- Function: int rl_delete_text (int start, int end) |
5e13499c CR |
2199 | Delete the text between START and END in the current line. |
2200 | Returns the number of characters deleted. | |
2201 | ||
bc7bed50 | 2202 | -- Function: char * rl_copy_text (int start, int end) |
5e13499c CR |
2203 | Return a copy of the text between START and END in the current |
2204 | line. | |
2205 | ||
bc7bed50 | 2206 | -- Function: int rl_kill_text (int start, int end) |
5e13499c CR |
2207 | Copy the text between START and END in the current line to the |
2208 | kill ring, appending or prepending to the last kill if the last | |
2209 | command was a kill command. The text is deleted. If START is | |
2210 | less than END, the text is appended, otherwise prepended. If the | |
2211 | last command was not a kill, a new kill ring slot is used. | |
2212 | ||
bc7bed50 | 2213 | -- Function: int rl_push_macro_input (char *macro) |
5e13499c CR |
2214 | Cause MACRO to be inserted into the line, as if it had been invoked |
2215 | by a key bound to a macro. Not especially useful; use | |
2216 | `rl_insert_text()' instead. | |
2217 | ||
2218 | \1f | |
2219 | File: readline.info, Node: Character Input, Next: Terminal Management, Prev: Modifying Text, Up: Readline Convenience Functions | |
2220 | ||
bc7bed50 CR |
2221 | 2.4.8 Character Input |
2222 | --------------------- | |
5e13499c | 2223 | |
bc7bed50 | 2224 | -- Function: int rl_read_key (void) |
5e13499c CR |
2225 | Return the next character available from Readline's current input |
2226 | stream. This handles input inserted into the input stream via | |
2227 | RL_PENDING_INPUT (*note Readline Variables::) and | |
2228 | `rl_stuff_char()', macros, and characters read from the keyboard. | |
2229 | While waiting for input, this function will call any function | |
2230 | assigned to the `rl_event_hook' variable. | |
2231 | ||
bc7bed50 | 2232 | -- Function: int rl_getc (FILE *stream) |
5e13499c CR |
2233 | Return the next character available from STREAM, which is assumed |
2234 | to be the keyboard. | |
2235 | ||
bc7bed50 | 2236 | -- Function: int rl_stuff_char (int c) |
5e13499c CR |
2237 | Insert C into the Readline input stream. It will be "read" before |
2238 | Readline attempts to read characters from the terminal with | |
2239 | `rl_read_key()'. Up to 512 characters may be pushed back. | |
2240 | `rl_stuff_char' returns 1 if the character was successfully | |
2241 | inserted; 0 otherwise. | |
2242 | ||
bc7bed50 | 2243 | -- Function: int rl_execute_next (int c) |
5e13499c CR |
2244 | Make C be the next command to be executed when `rl_read_key()' is |
2245 | called. This sets RL_PENDING_INPUT. | |
2246 | ||
bc7bed50 | 2247 | -- Function: int rl_clear_pending_input (void) |
5e13499c CR |
2248 | Unset RL_PENDING_INPUT, effectively negating the effect of any |
2249 | previous call to `rl_execute_next()'. This works only if the | |
2250 | pending input has not already been read with `rl_read_key()'. | |
2251 | ||
bc7bed50 | 2252 | -- Function: int rl_set_keyboard_input_timeout (int u) |
5e13499c CR |
2253 | While waiting for keyboard input in `rl_read_key()', Readline will |
2254 | wait for U microseconds for input before calling any function | |
8d618825 CR |
2255 | assigned to `rl_event_hook'. U must be greater than or equal to |
2256 | zero (a zero-length timeout is equivalent to a poll). The default | |
2257 | waiting period is one-tenth of a second. Returns the old timeout | |
2258 | value. | |
5e13499c CR |
2259 | |
2260 | \1f | |
2261 | File: readline.info, Node: Terminal Management, Next: Utility Functions, Prev: Character Input, Up: Readline Convenience Functions | |
2262 | ||
bc7bed50 CR |
2263 | 2.4.9 Terminal Management |
2264 | ------------------------- | |
5e13499c | 2265 | |
bc7bed50 | 2266 | -- Function: void rl_prep_terminal (int meta_flag) |
5e13499c CR |
2267 | Modify the terminal settings for Readline's use, so `readline()' |
2268 | can read a single character at a time from the keyboard. The | |
2269 | META_FLAG argument should be non-zero if Readline should read | |
2270 | eight-bit input. | |
2271 | ||
bc7bed50 | 2272 | -- Function: void rl_deprep_terminal (void) |
5e13499c CR |
2273 | Undo the effects of `rl_prep_terminal()', leaving the terminal in |
2274 | the state in which it was before the most recent call to | |
2275 | `rl_prep_terminal()'. | |
2276 | ||
bc7bed50 | 2277 | -- Function: void rl_tty_set_default_bindings (Keymap kmap) |
5e13499c CR |
2278 | Read the operating system's terminal editing characters (as would |
2279 | be displayed by `stty') to their Readline equivalents. The | |
2280 | bindings are performed in KMAP. | |
2281 | ||
bc7bed50 | 2282 | -- Function: void rl_tty_unset_default_bindings (Keymap kmap) |
5e13499c CR |
2283 | Reset the bindings manipulated by `rl_tty_set_default_bindings' so |
2284 | that the terminal editing characters are bound to `rl_insert'. | |
2285 | The bindings are performed in KMAP. | |
2286 | ||
bc7bed50 | 2287 | -- Function: int rl_reset_terminal (const char *terminal_name) |
5e13499c CR |
2288 | Reinitialize Readline's idea of the terminal settings using |
2289 | TERMINAL_NAME as the terminal type (e.g., `vt100'). If | |
2290 | TERMINAL_NAME is `NULL', the value of the `TERM' environment | |
2291 | variable is used. | |
2292 | ||
2293 | \1f | |
2294 | File: readline.info, Node: Utility Functions, Next: Miscellaneous Functions, Prev: Terminal Management, Up: Readline Convenience Functions | |
2295 | ||
bc7bed50 CR |
2296 | 2.4.10 Utility Functions |
2297 | ------------------------ | |
5e13499c | 2298 | |
bc7bed50 | 2299 | -- Function: void rl_replace_line (const char *text, int clear_undo) |
5e13499c CR |
2300 | Replace the contents of `rl_line_buffer' with TEXT. The point and |
2301 | mark are preserved, if possible. If CLEAR_UNDO is non-zero, the | |
2302 | undo list associated with the current line is cleared. | |
2303 | ||
bc7bed50 | 2304 | -- Function: int rl_extend_line_buffer (int len) |
5e13499c CR |
2305 | Ensure that `rl_line_buffer' has enough space to hold LEN |
2306 | characters, possibly reallocating it if necessary. | |
2307 | ||
bc7bed50 | 2308 | -- Function: int rl_initialize (void) |
5e13499c CR |
2309 | Initialize or re-initialize Readline's internal state. It's not |
2310 | strictly necessary to call this; `readline()' calls it before | |
2311 | reading any input. | |
2312 | ||
bc7bed50 | 2313 | -- Function: int rl_ding (void) |
5e13499c CR |
2314 | Ring the terminal bell, obeying the setting of `bell-style'. |
2315 | ||
bc7bed50 | 2316 | -- Function: int rl_alphabetic (int c) |
5e13499c CR |
2317 | Return 1 if C is an alphabetic character. |
2318 | ||
bc7bed50 | 2319 | -- Function: void rl_display_match_list (char **matches, int len, int |
5e13499c CR |
2320 | max) |
2321 | A convenience function for displaying a list of strings in | |
2322 | columnar format on Readline's output stream. `matches' is the list | |
2323 | of strings, in argv format, such as a list of completion matches. | |
2324 | `len' is the number of strings in `matches', and `max' is the | |
2325 | length of the longest string in `matches'. This function uses the | |
2326 | setting of `print-completions-horizontally' to select how the | |
2327 | matches are displayed (*note Readline Init File Syntax::). | |
2328 | ||
2329 | The following are implemented as macros, defined in `chardefs.h'. | |
2330 | Applications should refrain from using them. | |
2331 | ||
bc7bed50 | 2332 | -- Function: int _rl_uppercase_p (int c) |
5e13499c CR |
2333 | Return 1 if C is an uppercase alphabetic character. |
2334 | ||
bc7bed50 | 2335 | -- Function: int _rl_lowercase_p (int c) |
5e13499c CR |
2336 | Return 1 if C is a lowercase alphabetic character. |
2337 | ||
bc7bed50 | 2338 | -- Function: int _rl_digit_p (int c) |
5e13499c CR |
2339 | Return 1 if C is a numeric character. |
2340 | ||
bc7bed50 | 2341 | -- Function: int _rl_to_upper (int c) |
5e13499c CR |
2342 | If C is a lowercase alphabetic character, return the corresponding |
2343 | uppercase character. | |
2344 | ||
bc7bed50 | 2345 | -- Function: int _rl_to_lower (int c) |
5e13499c CR |
2346 | If C is an uppercase alphabetic character, return the corresponding |
2347 | lowercase character. | |
2348 | ||
bc7bed50 | 2349 | -- Function: int _rl_digit_value (int c) |
5e13499c CR |
2350 | If C is a number, return the value it represents. |
2351 | ||
2352 | \1f | |
2353 | File: readline.info, Node: Miscellaneous Functions, Next: Alternate Interface, Prev: Utility Functions, Up: Readline Convenience Functions | |
2354 | ||
bc7bed50 CR |
2355 | 2.4.11 Miscellaneous Functions |
2356 | ------------------------------ | |
5e13499c | 2357 | |
bc7bed50 | 2358 | -- Function: int rl_macro_bind (const char *keyseq, const char *macro, |
5e13499c CR |
2359 | Keymap map) |
2360 | Bind the key sequence KEYSEQ to invoke the macro MACRO. The | |
2361 | binding is performed in MAP. When KEYSEQ is invoked, the MACRO | |
2362 | will be inserted into the line. This function is deprecated; use | |
2363 | `rl_generic_bind()' instead. | |
2364 | ||
bc7bed50 | 2365 | -- Function: void rl_macro_dumper (int readable) |
5e13499c CR |
2366 | Print the key sequences bound to macros and their values, using |
2367 | the current keymap, to `rl_outstream'. If READABLE is non-zero, | |
2368 | the list is formatted in such a way that it can be made part of an | |
2369 | `inputrc' file and re-read. | |
2370 | ||
bc7bed50 | 2371 | -- Function: int rl_variable_bind (const char *variable, const char |
5e13499c CR |
2372 | *value) |
2373 | Make the Readline variable VARIABLE have VALUE. This behaves as | |
2374 | if the readline command `set VARIABLE VALUE' had been executed in | |
2375 | an `inputrc' file (*note Readline Init File Syntax::). | |
2376 | ||
bc7bed50 CR |
2377 | -- Function: char * rl_variable_value (const char *variable) |
2378 | Return a string representing the value of the Readline variable | |
2379 | VARIABLE. For boolean variables, this string is either `on' or | |
2380 | `off'. | |
2381 | ||
2382 | -- Function: void rl_variable_dumper (int readable) | |
5e13499c CR |
2383 | Print the readline variable names and their current values to |
2384 | `rl_outstream'. If READABLE is non-zero, the list is formatted in | |
2385 | such a way that it can be made part of an `inputrc' file and | |
2386 | re-read. | |
2387 | ||
bc7bed50 | 2388 | -- Function: int rl_set_paren_blink_timeout (int u) |
5e13499c CR |
2389 | Set the time interval (in microseconds) that Readline waits when |
2390 | showing a balancing character when `blink-matching-paren' has been | |
2391 | enabled. | |
2392 | ||
bc7bed50 | 2393 | -- Function: char * rl_get_termcap (const char *cap) |
5e13499c CR |
2394 | Retrieve the string value of the termcap capability CAP. Readline |
2395 | fetches the termcap entry for the current terminal name and uses | |
2396 | those capabilities to move around the screen line and perform other | |
2397 | terminal-specific operations, like erasing a line. Readline does | |
2398 | not use all of a terminal's capabilities, and this function will | |
2399 | return values for only those capabilities Readline uses. | |
2400 | ||
2401 | \1f | |
2402 | File: readline.info, Node: Alternate Interface, Next: A Readline Example, Prev: Miscellaneous Functions, Up: Readline Convenience Functions | |
2403 | ||
bc7bed50 CR |
2404 | 2.4.12 Alternate Interface |
2405 | -------------------------- | |
5e13499c | 2406 | |
bc7bed50 | 2407 | An alternate interface is available to plain `readline()'. Some |
5e13499c CR |
2408 | applications need to interleave keyboard I/O with file, device, or |
2409 | window system I/O, typically by using a main loop to `select()' on | |
2410 | various file descriptors. To accomodate this need, readline can also | |
2411 | be invoked as a `callback' function from an event loop. There are | |
2412 | functions available to make this easy. | |
2413 | ||
bc7bed50 | 2414 | -- Function: void rl_callback_handler_install (const char *prompt, |
5e13499c CR |
2415 | rl_vcpfunc_t *lhandler) |
2416 | Set up the terminal for readline I/O and display the initial | |
2417 | expanded value of PROMPT. Save the value of LHANDLER to use as a | |
2418 | function to call when a complete line of input has been entered. | |
2419 | The function takes the text of the line as an argument. | |
2420 | ||
bc7bed50 | 2421 | -- Function: void rl_callback_read_char (void) |
5e13499c CR |
2422 | Whenever an application determines that keyboard input is |
2423 | available, it should call `rl_callback_read_char()', which will | |
2424 | read the next character from the current input source. If that | |
2425 | character completes the line, `rl_callback_read_char' will invoke | |
2426 | the LHANDLER function saved by `rl_callback_handler_install' to | |
2427 | process the line. Before calling the LHANDLER function, the | |
2428 | terminal settings are reset to the values they had before calling | |
2429 | `rl_callback_handler_install'. If the LHANDLER function returns, | |
2430 | the terminal settings are modified for Readline's use again. | |
2431 | `EOF' is indicated by calling LHANDLER with a `NULL' line. | |
2432 | ||
bc7bed50 | 2433 | -- Function: void rl_callback_handler_remove (void) |
5e13499c CR |
2434 | Restore the terminal to its initial state and remove the line |
2435 | handler. This may be called from within a callback as well as | |
2436 | independently. If the LHANDLER installed by | |
2437 | `rl_callback_handler_install' does not exit the program, either | |
2438 | this function or the function referred to by the value of | |
2439 | `rl_deprep_term_function' should be called before the program | |
2440 | exits to reset the terminal settings. | |
2441 | ||
2442 | \1f | |
2443 | File: readline.info, Node: A Readline Example, Prev: Alternate Interface, Up: Readline Convenience Functions | |
2444 | ||
bc7bed50 CR |
2445 | 2.4.13 A Readline Example |
2446 | ------------------------- | |
5e13499c | 2447 | |
bc7bed50 CR |
2448 | Here is a function which changes lowercase characters to their uppercase |
2449 | equivalents, and uppercase characters to lowercase. If this function | |
2450 | was bound to `M-c', then typing `M-c' would change the case of the | |
2451 | character under point. Typing `M-1 0 M-c' would change the case of the | |
2452 | following 10 characters, leaving the cursor on the last character | |
5e13499c CR |
2453 | changed. |
2454 | ||
2455 | /* Invert the case of the COUNT following characters. */ | |
2456 | int | |
2457 | invert_case_line (count, key) | |
2458 | int count, key; | |
2459 | { | |
2460 | register int start, end, i; | |
bc7bed50 | 2461 | |
5e13499c | 2462 | start = rl_point; |
bc7bed50 | 2463 | |
5e13499c CR |
2464 | if (rl_point >= rl_end) |
2465 | return (0); | |
bc7bed50 | 2466 | |
5e13499c CR |
2467 | if (count < 0) |
2468 | { | |
2469 | direction = -1; | |
2470 | count = -count; | |
2471 | } | |
2472 | else | |
2473 | direction = 1; | |
bc7bed50 | 2474 | |
5e13499c CR |
2475 | /* Find the end of the range to modify. */ |
2476 | end = start + (count * direction); | |
bc7bed50 | 2477 | |
5e13499c CR |
2478 | /* Force it to be within range. */ |
2479 | if (end > rl_end) | |
2480 | end = rl_end; | |
2481 | else if (end < 0) | |
2482 | end = 0; | |
bc7bed50 | 2483 | |
5e13499c CR |
2484 | if (start == end) |
2485 | return (0); | |
bc7bed50 | 2486 | |
5e13499c CR |
2487 | if (start > end) |
2488 | { | |
2489 | int temp = start; | |
2490 | start = end; | |
2491 | end = temp; | |
2492 | } | |
bc7bed50 | 2493 | |
5e13499c CR |
2494 | /* Tell readline that we are modifying the line, |
2495 | so it will save the undo information. */ | |
2496 | rl_modifying (start, end); | |
bc7bed50 | 2497 | |
5e13499c CR |
2498 | for (i = start; i != end; i++) |
2499 | { | |
2500 | if (_rl_uppercase_p (rl_line_buffer[i])) | |
2501 | rl_line_buffer[i] = _rl_to_lower (rl_line_buffer[i]); | |
2502 | else if (_rl_lowercase_p (rl_line_buffer[i])) | |
2503 | rl_line_buffer[i] = _rl_to_upper (rl_line_buffer[i]); | |
2504 | } | |
2505 | /* Move point to on top of the last character changed. */ | |
2506 | rl_point = (direction == 1) ? end - 1 : start; | |
2507 | return (0); | |
2508 | } | |
2509 | ||
2510 | \1f | |
2511 | File: readline.info, Node: Readline Signal Handling, Next: Custom Completers, Prev: Readline Convenience Functions, Up: Programming with GNU Readline | |
2512 | ||
bc7bed50 CR |
2513 | 2.5 Readline Signal Handling |
2514 | ============================ | |
5e13499c | 2515 | |
bc7bed50 | 2516 | Signals are asynchronous events sent to a process by the Unix kernel, |
5e13499c CR |
2517 | sometimes on behalf of another process. They are intended to indicate |
2518 | exceptional events, like a user pressing the interrupt key on his | |
2519 | terminal, or a network connection being broken. There is a class of | |
2520 | signals that can be sent to the process currently reading input from | |
2521 | the keyboard. Since Readline changes the terminal attributes when it | |
2522 | is called, it needs to perform special processing when such a signal is | |
2523 | received in order to restore the terminal to a sane state, or provide | |
2524 | application writers with functions to do so manually. | |
2525 | ||
2526 | Readline contains an internal signal handler that is installed for a | |
2527 | number of signals (`SIGINT', `SIGQUIT', `SIGTERM', `SIGALRM', | |
2528 | `SIGTSTP', `SIGTTIN', and `SIGTTOU'). When one of these signals is | |
2529 | received, the signal handler will reset the terminal attributes to | |
2530 | those that were in effect before `readline()' was called, reset the | |
2531 | signal handling to what it was before `readline()' was called, and | |
2532 | resend the signal to the calling application. If and when the calling | |
2533 | application's signal handler returns, Readline will reinitialize the | |
2534 | terminal and continue to accept input. When a `SIGINT' is received, | |
2535 | the Readline signal handler performs some additional work, which will | |
2536 | cause any partially-entered line to be aborted (see the description of | |
2537 | `rl_free_line_state()' below). | |
2538 | ||
2539 | There is an additional Readline signal handler, for `SIGWINCH', which | |
2540 | the kernel sends to a process whenever the terminal's size changes (for | |
2541 | example, if a user resizes an `xterm'). The Readline `SIGWINCH' | |
2542 | handler updates Readline's internal screen size information, and then | |
2543 | calls any `SIGWINCH' signal handler the calling application has | |
2544 | installed. Readline calls the application's `SIGWINCH' signal handler | |
2545 | without resetting the terminal to its original state. If the | |
2546 | application's signal handler does more than update its idea of the | |
2547 | terminal size and return (for example, a `longjmp' back to a main | |
2548 | processing loop), it _must_ call `rl_cleanup_after_signal()' (described | |
2549 | below), to restore the terminal state. | |
2550 | ||
2551 | Readline provides two variables that allow application writers to | |
2552 | control whether or not it will catch certain signals and act on them | |
2553 | when they are received. It is important that applications change the | |
2554 | values of these variables only when calling `readline()', not in a | |
2555 | signal handler, so Readline's internal signal state is not corrupted. | |
2556 | ||
bc7bed50 | 2557 | -- Variable: int rl_catch_signals |
5e13499c CR |
2558 | If this variable is non-zero, Readline will install signal |
2559 | handlers for `SIGINT', `SIGQUIT', `SIGTERM', `SIGALRM', `SIGTSTP', | |
2560 | `SIGTTIN', and `SIGTTOU'. | |
2561 | ||
2562 | The default value of `rl_catch_signals' is 1. | |
2563 | ||
bc7bed50 | 2564 | -- Variable: int rl_catch_sigwinch |
5e13499c CR |
2565 | If this variable is non-zero, Readline will install a signal |
2566 | handler for `SIGWINCH'. | |
2567 | ||
2568 | The default value of `rl_catch_sigwinch' is 1. | |
2569 | ||
2570 | If an application does not wish to have Readline catch any signals, | |
2571 | or to handle signals other than those Readline catches (`SIGHUP', for | |
2572 | example), Readline provides convenience functions to do the necessary | |
2573 | terminal and internal state cleanup upon receipt of a signal. | |
2574 | ||
bc7bed50 | 2575 | -- Function: void rl_cleanup_after_signal (void) |
5e13499c CR |
2576 | This function will reset the state of the terminal to what it was |
2577 | before `readline()' was called, and remove the Readline signal | |
2578 | handlers for all signals, depending on the values of | |
2579 | `rl_catch_signals' and `rl_catch_sigwinch'. | |
2580 | ||
bc7bed50 | 2581 | -- Function: void rl_free_line_state (void) |
5e13499c CR |
2582 | This will free any partial state associated with the current input |
2583 | line (undo information, any partial history entry, any | |
2584 | partially-entered keyboard macro, and any partially-entered | |
2585 | numeric argument). This should be called before | |
2586 | `rl_cleanup_after_signal()'. The Readline signal handler for | |
2587 | `SIGINT' calls this to abort the current input line. | |
2588 | ||
bc7bed50 | 2589 | -- Function: void rl_reset_after_signal (void) |
5e13499c CR |
2590 | This will reinitialize the terminal and reinstall any Readline |
2591 | signal handlers, depending on the values of `rl_catch_signals' and | |
2592 | `rl_catch_sigwinch'. | |
2593 | ||
2594 | If an application does not wish Readline to catch `SIGWINCH', it may | |
2595 | call `rl_resize_terminal()' or `rl_set_screen_size()' to force Readline | |
2596 | to update its idea of the terminal size when a `SIGWINCH' is received. | |
2597 | ||
bc7bed50 | 2598 | -- Function: void rl_resize_terminal (void) |
5e13499c CR |
2599 | Update Readline's internal screen size by reading values from the |
2600 | kernel. | |
2601 | ||
bc7bed50 | 2602 | -- Function: void rl_set_screen_size (int rows, int cols) |
5e13499c | 2603 | Set Readline's idea of the terminal size to ROWS rows and COLS |
28089d04 CR |
2604 | columns. If either ROWS or COLUMNS is less than or equal to 0, |
2605 | Readline's idea of that terminal dimension is unchanged. | |
5e13499c CR |
2606 | |
2607 | If an application does not want to install a `SIGWINCH' handler, but | |
2608 | is still interested in the screen dimensions, Readline's idea of the | |
2609 | screen size may be queried. | |
2610 | ||
bc7bed50 | 2611 | -- Function: void rl_get_screen_size (int *rows, int *cols) |
5e13499c CR |
2612 | Return Readline's idea of the terminal's size in the variables |
2613 | pointed to by the arguments. | |
2614 | ||
28089d04 CR |
2615 | -- Function: void rl_reset_screen_size (void) |
2616 | Cause Readline to reobtain the screen size and recalculate its | |
2617 | dimensions. | |
2618 | ||
5e13499c CR |
2619 | The following functions install and remove Readline's signal |
2620 | handlers. | |
2621 | ||
bc7bed50 | 2622 | -- Function: int rl_set_signals (void) |
5e13499c CR |
2623 | Install Readline's signal handler for `SIGINT', `SIGQUIT', |
2624 | `SIGTERM', `SIGALRM', `SIGTSTP', `SIGTTIN', `SIGTTOU', and | |
2625 | `SIGWINCH', depending on the values of `rl_catch_signals' and | |
2626 | `rl_catch_sigwinch'. | |
2627 | ||
bc7bed50 | 2628 | -- Function: int rl_clear_signals (void) |
5e13499c CR |
2629 | Remove all of the Readline signal handlers installed by |
2630 | `rl_set_signals()'. | |
2631 | ||
2632 | \1f | |
2633 | File: readline.info, Node: Custom Completers, Prev: Readline Signal Handling, Up: Programming with GNU Readline | |
2634 | ||
bc7bed50 CR |
2635 | 2.6 Custom Completers |
2636 | ===================== | |
5e13499c | 2637 | |
bc7bed50 | 2638 | Typically, a program that reads commands from the user has a way of |
5e13499c CR |
2639 | disambiguating commands and data. If your program is one of these, then |
2640 | it can provide completion for commands, data, or both. The following | |
2641 | sections describe how your program and Readline cooperate to provide | |
2642 | this service. | |
2643 | ||
2644 | * Menu: | |
2645 | ||
2646 | * How Completing Works:: The logic used to do completion. | |
2647 | * Completion Functions:: Functions provided by Readline. | |
2648 | * Completion Variables:: Variables which control completion. | |
2649 | * A Short Completion Example:: An example of writing completer subroutines. | |
2650 | ||
2651 | \1f | |
2652 | File: readline.info, Node: How Completing Works, Next: Completion Functions, Up: Custom Completers | |
2653 | ||
bc7bed50 CR |
2654 | 2.6.1 How Completing Works |
2655 | -------------------------- | |
5e13499c | 2656 | |
bc7bed50 | 2657 | In order to complete some text, the full list of possible completions |
5e13499c CR |
2658 | must be available. That is, it is not possible to accurately expand a |
2659 | partial word without knowing all of the possible words which make sense | |
2660 | in that context. The Readline library provides the user interface to | |
2661 | completion, and two of the most common completion functions: filename | |
2662 | and username. For completing other types of text, you must write your | |
2663 | own completion function. This section describes exactly what such | |
2664 | functions must do, and provides an example. | |
2665 | ||
2666 | There are three major functions used to perform completion: | |
2667 | ||
2668 | 1. The user-interface function `rl_complete()'. This function is | |
2669 | called with the same arguments as other bindable Readline | |
2670 | functions: COUNT and INVOKING_KEY. It isolates the word to be | |
2671 | completed and calls `rl_completion_matches()' to generate a list | |
2672 | of possible completions. It then either lists the possible | |
2673 | completions, inserts the possible completions, or actually | |
2674 | performs the completion, depending on which behavior is desired. | |
2675 | ||
2676 | 2. The internal function `rl_completion_matches()' uses an | |
2677 | application-supplied "generator" function to generate the list of | |
2678 | possible matches, and then returns the array of these matches. | |
2679 | The caller should place the address of its generator function in | |
2680 | `rl_completion_entry_function'. | |
2681 | ||
2682 | 3. The generator function is called repeatedly from | |
2683 | `rl_completion_matches()', returning a string each time. The | |
2684 | arguments to the generator function are TEXT and STATE. TEXT is | |
2685 | the partial word to be completed. STATE is zero the first time | |
2686 | the function is called, allowing the generator to perform any | |
2687 | necessary initialization, and a positive non-zero integer for each | |
2688 | subsequent call. The generator function returns `(char *)NULL' to | |
2689 | inform `rl_completion_matches()' that there are no more | |
2690 | possibilities left. Usually the generator function computes the | |
2691 | list of possible completions when STATE is zero, and returns them | |
2692 | one at a time on subsequent calls. Each string the generator | |
2693 | function returns as a match must be allocated with `malloc()'; | |
2694 | Readline frees the strings when it has finished with them. Such a | |
2695 | generator function is referred to as an "application-specific | |
2696 | completion function". | |
2697 | ||
2698 | ||
bc7bed50 | 2699 | -- Function: int rl_complete (int ignore, int invoking_key) |
5e13499c CR |
2700 | Complete the word at or before point. You have supplied the |
2701 | function that does the initial simple matching selection algorithm | |
2702 | (see `rl_completion_matches()'). The default is to do filename | |
2703 | completion. | |
2704 | ||
bc7bed50 | 2705 | -- Variable: rl_compentry_func_t * rl_completion_entry_function |
5e13499c CR |
2706 | This is a pointer to the generator function for |
2707 | `rl_completion_matches()'. If the value of | |
2708 | `rl_completion_entry_function' is `NULL' then the default filename | |
2709 | generator function, `rl_filename_completion_function()', is used. | |
2710 | An "application-specific completion function" is a function whose | |
2711 | address is assigned to `rl_completion_entry_function' and whose | |
2712 | return values are used to generate possible completions. | |
2713 | ||
2714 | \1f | |
2715 | File: readline.info, Node: Completion Functions, Next: Completion Variables, Prev: How Completing Works, Up: Custom Completers | |
2716 | ||
bc7bed50 CR |
2717 | 2.6.2 Completion Functions |
2718 | -------------------------- | |
5e13499c | 2719 | |
bc7bed50 | 2720 | Here is the complete list of callable completion functions present in |
5e13499c CR |
2721 | Readline. |
2722 | ||
bc7bed50 | 2723 | -- Function: int rl_complete_internal (int what_to_do) |
5e13499c CR |
2724 | Complete the word at or before point. WHAT_TO_DO says what to do |
2725 | with the completion. A value of `?' means list the possible | |
2726 | completions. `TAB' means do standard completion. `*' means | |
2727 | insert all of the possible completions. `!' means to display all | |
2728 | of the possible completions, if there is more than one, as well as | |
2729 | performing partial completion. `@' is similar to `!', but | |
2730 | possible completions are not listed if the possible completions | |
2731 | share a common prefix. | |
2732 | ||
bc7bed50 | 2733 | -- Function: int rl_complete (int ignore, int invoking_key) |
5e13499c CR |
2734 | Complete the word at or before point. You have supplied the |
2735 | function that does the initial simple matching selection algorithm | |
2736 | (see `rl_completion_matches()' and `rl_completion_entry_function'). | |
2737 | The default is to do filename completion. This calls | |
2738 | `rl_complete_internal()' with an argument depending on | |
2739 | INVOKING_KEY. | |
2740 | ||
bc7bed50 | 2741 | -- Function: int rl_possible_completions (int count, int invoking_key) |
5e13499c CR |
2742 | List the possible completions. See description of `rl_complete |
2743 | ()'. This calls `rl_complete_internal()' with an argument of `?'. | |
2744 | ||
bc7bed50 | 2745 | -- Function: int rl_insert_completions (int count, int invoking_key) |
5e13499c CR |
2746 | Insert the list of possible completions into the line, deleting the |
2747 | partially-completed word. See description of `rl_complete()'. | |
2748 | This calls `rl_complete_internal()' with an argument of `*'. | |
2749 | ||
bc7bed50 | 2750 | -- Function: int rl_completion_mode (rl_command_func_t *cfunc) |
5e13499c CR |
2751 | Returns the apppriate value to pass to `rl_complete_internal()' |
2752 | depending on whether CFUNC was called twice in succession and the | |
2753 | values of the `show-all-if-ambiguous' and `show-all-if-unmodified' | |
2754 | variables. Application-specific completion functions may use this | |
2755 | function to present the same interface as `rl_complete()'. | |
2756 | ||
bc7bed50 | 2757 | -- Function: char ** rl_completion_matches (const char *text, |
5e13499c CR |
2758 | rl_compentry_func_t *entry_func) |
2759 | Returns an array of strings which is a list of completions for | |
2760 | TEXT. If there are no completions, returns `NULL'. The first | |
2761 | entry in the returned array is the substitution for TEXT. The | |
2762 | remaining entries are the possible completions. The array is | |
2763 | terminated with a `NULL' pointer. | |
2764 | ||
2765 | ENTRY_FUNC is a function of two args, and returns a `char *'. The | |
2766 | first argument is TEXT. The second is a state argument; it is | |
2767 | zero on the first call, and non-zero on subsequent calls. | |
2768 | ENTRY_FUNC returns a `NULL' pointer to the caller when there are | |
2769 | no more matches. | |
2770 | ||
bc7bed50 | 2771 | -- Function: char * rl_filename_completion_function (const char *text, |
5e13499c CR |
2772 | int state) |
2773 | A generator function for filename completion in the general case. | |
2774 | TEXT is a partial filename. The Bash source is a useful reference | |
2775 | for writing application-specific completion functions (the Bash | |
2776 | completion functions call this and other Readline functions). | |
2777 | ||
bc7bed50 | 2778 | -- Function: char * rl_username_completion_function (const char *text, |
5e13499c CR |
2779 | int state) |
2780 | A completion generator for usernames. TEXT contains a partial | |
2781 | username preceded by a random character (usually `~'). As with all | |
2782 | completion generators, STATE is zero on the first call and non-zero | |
2783 | for subsequent calls. | |
2784 | ||
2785 | \1f | |
2786 | File: readline.info, Node: Completion Variables, Next: A Short Completion Example, Prev: Completion Functions, Up: Custom Completers | |
2787 | ||
bc7bed50 CR |
2788 | 2.6.3 Completion Variables |
2789 | -------------------------- | |
5e13499c | 2790 | |
bc7bed50 | 2791 | -- Variable: rl_compentry_func_t * rl_completion_entry_function |
5e13499c CR |
2792 | A pointer to the generator function for `rl_completion_matches()'. |
2793 | `NULL' means to use `rl_filename_completion_function()', the | |
2794 | default filename completer. | |
2795 | ||
bc7bed50 | 2796 | -- Variable: rl_completion_func_t * rl_attempted_completion_function |
5e13499c CR |
2797 | A pointer to an alternative function to create matches. The |
2798 | function is called with TEXT, START, and END. START and END are | |
2799 | indices in `rl_line_buffer' defining the boundaries of TEXT, which | |
2800 | is a character string. If this function exists and returns | |
2801 | `NULL', or if this variable is set to `NULL', then `rl_complete()' | |
2802 | will call the value of `rl_completion_entry_function' to generate | |
2803 | matches, otherwise the array of strings returned will be used. If | |
2804 | this function sets the `rl_attempted_completion_over' variable to | |
2805 | a non-zero value, Readline will not perform its default completion | |
2806 | even if this function returns no matches. | |
2807 | ||
bc7bed50 | 2808 | -- Variable: rl_quote_func_t * rl_filename_quoting_function |
5e13499c CR |
2809 | A pointer to a function that will quote a filename in an |
2810 | application-specific fashion. This is called if filename | |
2811 | completion is being attempted and one of the characters in | |
2812 | `rl_filename_quote_characters' appears in a completed filename. | |
2813 | The function is called with TEXT, MATCH_TYPE, and QUOTE_POINTER. | |
2814 | The TEXT is the filename to be quoted. The MATCH_TYPE is either | |
2815 | `SINGLE_MATCH', if there is only one completion match, or | |
2816 | `MULT_MATCH'. Some functions use this to decide whether or not to | |
2817 | insert a closing quote character. The QUOTE_POINTER is a pointer | |
2818 | to any opening quote character the user typed. Some functions | |
2819 | choose to reset this character. | |
2820 | ||
bc7bed50 | 2821 | -- Variable: rl_dequote_func_t * rl_filename_dequoting_function |
5e13499c CR |
2822 | A pointer to a function that will remove application-specific |
2823 | quoting characters from a filename before completion is attempted, | |
2824 | so those characters do not interfere with matching the text | |
2825 | against names in the filesystem. It is called with TEXT, the text | |
2826 | of the word to be dequoted, and QUOTE_CHAR, which is the quoting | |
2827 | character that delimits the filename (usually `'' or `"'). If | |
2828 | QUOTE_CHAR is zero, the filename was not in an embedded string. | |
2829 | ||
bc7bed50 | 2830 | -- Variable: rl_linebuf_func_t * rl_char_is_quoted_p |
5e13499c CR |
2831 | A pointer to a function to call that determines whether or not a |
2832 | specific character in the line buffer is quoted, according to | |
2833 | whatever quoting mechanism the program calling Readline uses. The | |
2834 | function is called with two arguments: TEXT, the text of the line, | |
2835 | and INDEX, the index of the character in the line. It is used to | |
2836 | decide whether a character found in | |
2837 | `rl_completer_word_break_characters' should be used to break words | |
2838 | for the completer. | |
2839 | ||
bc7bed50 | 2840 | -- Variable: rl_compignore_func_t * rl_ignore_some_completions_function |
5e13499c CR |
2841 | This function, if defined, is called by the completer when real |
2842 | filename completion is done, after all the matching names have | |
2843 | been generated. It is passed a `NULL' terminated array of matches. | |
2844 | The first element (`matches[0]') is the maximal substring common | |
2845 | to all matches. This function can re-arrange the list of matches | |
2846 | as required, but each element deleted from the array must be freed. | |
2847 | ||
bc7bed50 | 2848 | -- Variable: rl_icppfunc_t * rl_directory_completion_hook |
5e13499c CR |
2849 | This function, if defined, is allowed to modify the directory |
2850 | portion of filenames Readline completes. It is called with the | |
2851 | address of a string (the current directory name) as an argument, | |
2852 | and may modify that string. If the string is replaced with a new | |
2853 | string, the old value should be freed. Any modified directory | |
2854 | name should have a trailing slash. The modified value will be | |
2855 | displayed as part of the completion, replacing the directory | |
2856 | portion of the pathname the user typed. It returns an integer | |
2857 | that should be non-zero if the function modifies its directory | |
2858 | argument. It could be used to expand symbolic links or shell | |
8d618825 CR |
2859 | variables in pathnames. At the least, even if no other expansion |
2860 | is performed, this function should remove any quote characters | |
2861 | from the directory name, because its result will be passed | |
2862 | directly to `opendir()'. | |
5e13499c | 2863 | |
bc7bed50 | 2864 | -- Variable: rl_compdisp_func_t * rl_completion_display_matches_hook |
5e13499c CR |
2865 | If non-zero, then this is the address of a function to call when |
2866 | completing a word would normally display the list of possible | |
2867 | matches. This function is called in lieu of Readline displaying | |
2868 | the list. It takes three arguments: (`char **'MATCHES, `int' | |
2869 | NUM_MATCHES, `int' MAX_LENGTH) where MATCHES is the array of | |
2870 | matching strings, NUM_MATCHES is the number of strings in that | |
2871 | array, and MAX_LENGTH is the length of the longest string in that | |
2872 | array. Readline provides a convenience function, | |
2873 | `rl_display_match_list', that takes care of doing the display to | |
2874 | Readline's output stream. That function may be called from this | |
2875 | hook. | |
2876 | ||
bc7bed50 | 2877 | -- Variable: const char * rl_basic_word_break_characters |
5e13499c CR |
2878 | The basic list of characters that signal a break between words for |
2879 | the completer routine. The default value of this variable is the | |
2880 | characters which break words for completion in Bash: `" | |
2881 | \t\n\"\\'`@$><=;|&{("'. | |
2882 | ||
bc7bed50 | 2883 | -- Variable: const char * rl_basic_quote_characters |
5e13499c CR |
2884 | A list of quote characters which can cause a word break. |
2885 | ||
bc7bed50 | 2886 | -- Variable: const char * rl_completer_word_break_characters |
5e13499c CR |
2887 | The list of characters that signal a break between words for |
2888 | `rl_complete_internal()'. The default list is the value of | |
2889 | `rl_basic_word_break_characters'. | |
2890 | ||
bc7bed50 | 2891 | -- Variable: rl_cpvfunc_t * rl_completion_word_break_hook |
e6e3b444 CR |
2892 | If non-zero, this is the address of a function to call when |
2893 | Readline is deciding where to separate words for word completion. | |
2894 | It should return a character string like | |
2895 | `rl_completer_word_break_characters' to be used to perform the | |
2896 | current completion. The function may choose to set | |
2897 | `rl_completer_word_break_characters' itself. If the function | |
2898 | returns `NULL', `rl_completer_word_break_characters' is used. | |
2899 | ||
bc7bed50 | 2900 | -- Variable: const char * rl_completer_quote_characters |
5e13499c CR |
2901 | A list of characters which can be used to quote a substring of the |
2902 | line. Completion occurs on the entire substring, and within the | |
2903 | substring `rl_completer_word_break_characters' are treated as any | |
2904 | other character, unless they also appear within this list. | |
2905 | ||
bc7bed50 | 2906 | -- Variable: const char * rl_filename_quote_characters |
5e13499c CR |
2907 | A list of characters that cause a filename to be quoted by the |
2908 | completer when they appear in a completed filename. The default | |
2909 | is the null string. | |
2910 | ||
bc7bed50 | 2911 | -- Variable: const char * rl_special_prefixes |
5e13499c CR |
2912 | The list of characters that are word break characters, but should |
2913 | be left in TEXT when it is passed to the completion function. | |
2914 | Programs can use this to help determine what kind of completing to | |
2915 | do. For instance, Bash sets this variable to "$@" so that it can | |
2916 | complete shell variables and hostnames. | |
2917 | ||
bc7bed50 | 2918 | -- Variable: int rl_completion_query_items |
5e13499c | 2919 | Up to this many items will be displayed in response to a |
bc7bed50 CR |
2920 | possible-completions call. After that, readline asks the user if |
2921 | she is sure she wants to see them all. The default value is 100. | |
2922 | A negative value indicates that Readline should never ask the user. | |
5e13499c | 2923 | |
bc7bed50 | 2924 | -- Variable: int rl_completion_append_character |
5e13499c CR |
2925 | When a single completion alternative matches at the end of the |
2926 | command line, this character is appended to the inserted | |
2927 | completion text. The default is a space character (` '). Setting | |
2928 | this to the null character (`\0') prevents anything being appended | |
2929 | automatically. This can be changed in application-specific | |
2930 | completion functions to provide the "most sensible word separator | |
2931 | character" according to an application-specific command line | |
2932 | syntax specification. | |
2933 | ||
bc7bed50 | 2934 | -- Variable: int rl_completion_suppress_append |
5e13499c CR |
2935 | If non-zero, RL_COMPLETION_APPEND_CHARACTER is not appended to |
2936 | matches at the end of the command line, as described above. It is | |
2937 | set to 0 before any application-specific completion function is | |
2938 | called, and may only be changed within such a function. | |
2939 | ||
bc7bed50 | 2940 | -- Variable: int rl_completion_quote_character |
e6e3b444 CR |
2941 | When Readline is completing quoted text, as delimited by one of the |
2942 | characters in RL_COMPLETER_QUOTE_CHARACTERS, it sets this variable | |
2943 | to the quoting character found. This is set before any | |
2944 | application-specific completion function is called. | |
2945 | ||
bc7bed50 | 2946 | -- Variable: int rl_completion_suppress_quote |
e6e3b444 CR |
2947 | If non-zero, Readline does not append a matching quote character |
2948 | when performing completion on a quoted string. It is set to 0 | |
2949 | before any application-specific completion function is called, and | |
2950 | may only be changed within such a function. | |
2951 | ||
bc7bed50 | 2952 | -- Variable: int rl_completion_found_quote |
e6e3b444 CR |
2953 | When Readline is completing quoted text, it sets this variable to |
2954 | a non-zero value if the word being completed contains or is | |
2955 | delimited by any quoting characters, including backslashes. This | |
2956 | is set before any application-specific completion function is | |
2957 | called. | |
2958 | ||
bc7bed50 | 2959 | -- Variable: int rl_completion_mark_symlink_dirs |
5e13499c CR |
2960 | If non-zero, a slash will be appended to completed filenames that |
2961 | are symbolic links to directory names, subject to the value of the | |
2962 | user-settable MARK-DIRECTORIES variable. This variable exists so | |
2963 | that application-specific completion functions can override the | |
2964 | user's global preference (set via the MARK-SYMLINKED-DIRECTORIES | |
2965 | Readline variable) if appropriate. This variable is set to the | |
2966 | user's preference before any application-specific completion | |
2967 | function is called, so unless that function modifies the value, | |
2968 | the user's preferences are honored. | |
2969 | ||
bc7bed50 | 2970 | -- Variable: int rl_ignore_completion_duplicates |
5e13499c CR |
2971 | If non-zero, then duplicates in the matches are removed. The |
2972 | default is 1. | |
2973 | ||
bc7bed50 | 2974 | -- Variable: int rl_filename_completion_desired |
5e13499c CR |
2975 | Non-zero means that the results of the matches are to be treated as |
2976 | filenames. This is _always_ zero when completion is attempted, | |
2977 | and can only be changed within an application-specific completion | |
2978 | function. If it is set to a non-zero value by such a function, | |
2979 | directory names have a slash appended and Readline attempts to | |
2980 | quote completed filenames if they contain any characters in | |
2981 | `rl_filename_quote_characters' and `rl_filename_quoting_desired' | |
2982 | is set to a non-zero value. | |
2983 | ||
bc7bed50 | 2984 | -- Variable: int rl_filename_quoting_desired |
5e13499c CR |
2985 | Non-zero means that the results of the matches are to be quoted |
2986 | using double quotes (or an application-specific quoting mechanism) | |
2987 | if the completed filename contains any characters in | |
2988 | `rl_filename_quote_chars'. This is _always_ non-zero when | |
2989 | completion is attempted, and can only be changed within an | |
2990 | application-specific completion function. The quoting is effected | |
2991 | via a call to the function pointed to by | |
2992 | `rl_filename_quoting_function'. | |
2993 | ||
bc7bed50 | 2994 | -- Variable: int rl_attempted_completion_over |
5e13499c CR |
2995 | If an application-specific completion function assigned to |
2996 | `rl_attempted_completion_function' sets this variable to a non-zero | |
2997 | value, Readline will not perform its default filename completion | |
2998 | even if the application's completion function returns no matches. | |
2999 | It should be set only by an application's completion function. | |
3000 | ||
bc7bed50 | 3001 | -- Variable: int rl_completion_type |
5e13499c CR |
3002 | Set to a character describing the type of completion Readline is |
3003 | currently attempting; see the description of | |
3004 | `rl_complete_internal()' (*note Completion Functions::) for the | |
3005 | list of characters. This is set to the appropriate value before | |
3006 | any application-specific completion function is called, allowing | |
3007 | such functions to present the same interface as `rl_complete()'. | |
3008 | ||
bc7bed50 | 3009 | -- Variable: int rl_inhibit_completion |
5e13499c CR |
3010 | If this variable is non-zero, completion is inhibited. The |
3011 | completion character will be inserted as any other bound to | |
3012 | `self-insert'. | |
3013 | ||
3014 | \1f | |
3015 | File: readline.info, Node: A Short Completion Example, Prev: Completion Variables, Up: Custom Completers | |
3016 | ||
bc7bed50 CR |
3017 | 2.6.4 A Short Completion Example |
3018 | -------------------------------- | |
5e13499c | 3019 | |
bc7bed50 | 3020 | Here is a small application demonstrating the use of the GNU Readline |
5e13499c CR |
3021 | library. It is called `fileman', and the source code resides in |
3022 | `examples/fileman.c'. This sample application provides completion of | |
3023 | command names, line editing features, and access to the history list. | |
3024 | ||
3025 | /* fileman.c -- A tiny application which demonstrates how to use the | |
3026 | GNU Readline library. This application interactively allows users | |
3027 | to manipulate files and their modes. */ | |
bc7bed50 | 3028 | |
5e13499c CR |
3029 | #include <stdio.h> |
3030 | #include <sys/types.h> | |
3031 | #include <sys/file.h> | |
3032 | #include <sys/stat.h> | |
3033 | #include <sys/errno.h> | |
bc7bed50 | 3034 | |
5e13499c CR |
3035 | #include <readline/readline.h> |
3036 | #include <readline/history.h> | |
bc7bed50 | 3037 | |
5e13499c | 3038 | extern char *xmalloc (); |
bc7bed50 | 3039 | |
5e13499c CR |
3040 | /* The names of functions that actually do the manipulation. */ |
3041 | int com_list __P((char *)); | |
3042 | int com_view __P((char *)); | |
3043 | int com_rename __P((char *)); | |
3044 | int com_stat __P((char *)); | |
3045 | int com_pwd __P((char *)); | |
3046 | int com_delete __P((char *)); | |
3047 | int com_help __P((char *)); | |
3048 | int com_cd __P((char *)); | |
3049 | int com_quit __P((char *)); | |
bc7bed50 | 3050 | |
5e13499c CR |
3051 | /* A structure which contains information on the commands this program |
3052 | can understand. */ | |
bc7bed50 | 3053 | |
5e13499c CR |
3054 | typedef struct { |
3055 | char *name; /* User printable name of the function. */ | |
3056 | rl_icpfunc_t *func; /* Function to call to do the job. */ | |
3057 | char *doc; /* Documentation for this function. */ | |
3058 | } COMMAND; | |
bc7bed50 | 3059 | |
5e13499c CR |
3060 | COMMAND commands[] = { |
3061 | { "cd", com_cd, "Change to directory DIR" }, | |
3062 | { "delete", com_delete, "Delete FILE" }, | |
3063 | { "help", com_help, "Display this text" }, | |
3064 | { "?", com_help, "Synonym for `help'" }, | |
3065 | { "list", com_list, "List files in DIR" }, | |
3066 | { "ls", com_list, "Synonym for `list'" }, | |
3067 | { "pwd", com_pwd, "Print the current working directory" }, | |
3068 | { "quit", com_quit, "Quit using Fileman" }, | |
3069 | { "rename", com_rename, "Rename FILE to NEWNAME" }, | |
3070 | { "stat", com_stat, "Print out statistics on FILE" }, | |
3071 | { "view", com_view, "View the contents of FILE" }, | |
3072 | { (char *)NULL, (rl_icpfunc_t *)NULL, (char *)NULL } | |
3073 | }; | |
bc7bed50 | 3074 | |
5e13499c CR |
3075 | /* Forward declarations. */ |
3076 | char *stripwhite (); | |
3077 | COMMAND *find_command (); | |
bc7bed50 | 3078 | |
5e13499c CR |
3079 | /* The name of this program, as taken from argv[0]. */ |
3080 | char *progname; | |
bc7bed50 | 3081 | |
5e13499c CR |
3082 | /* When non-zero, this means the user is done using this program. */ |
3083 | int done; | |
bc7bed50 | 3084 | |
5e13499c CR |
3085 | char * |
3086 | dupstr (s) | |
3087 | int s; | |
3088 | { | |
3089 | char *r; | |
bc7bed50 | 3090 | |
5e13499c CR |
3091 | r = xmalloc (strlen (s) + 1); |
3092 | strcpy (r, s); | |
3093 | return (r); | |
3094 | } | |
bc7bed50 | 3095 | |
5e13499c CR |
3096 | main (argc, argv) |
3097 | int argc; | |
3098 | char **argv; | |
3099 | { | |
3100 | char *line, *s; | |
bc7bed50 | 3101 | |
5e13499c | 3102 | progname = argv[0]; |
bc7bed50 | 3103 | |
5e13499c | 3104 | initialize_readline (); /* Bind our completer. */ |
bc7bed50 | 3105 | |
5e13499c CR |
3106 | /* Loop reading and executing lines until the user quits. */ |
3107 | for ( ; done == 0; ) | |
3108 | { | |
3109 | line = readline ("FileMan: "); | |
bc7bed50 | 3110 | |
5e13499c CR |
3111 | if (!line) |
3112 | break; | |
bc7bed50 | 3113 | |
5e13499c CR |
3114 | /* Remove leading and trailing whitespace from the line. |
3115 | Then, if there is anything left, add it to the history list | |
3116 | and execute it. */ | |
3117 | s = stripwhite (line); | |
bc7bed50 | 3118 | |
5e13499c CR |
3119 | if (*s) |
3120 | { | |
3121 | add_history (s); | |
3122 | execute_line (s); | |
3123 | } | |
bc7bed50 | 3124 | |
5e13499c CR |
3125 | free (line); |
3126 | } | |
3127 | exit (0); | |
3128 | } | |
bc7bed50 | 3129 | |
5e13499c CR |
3130 | /* Execute a command line. */ |
3131 | int | |
3132 | execute_line (line) | |
3133 | char *line; | |
3134 | { | |
3135 | register int i; | |
3136 | COMMAND *command; | |
3137 | char *word; | |
bc7bed50 | 3138 | |
5e13499c CR |
3139 | /* Isolate the command word. */ |
3140 | i = 0; | |
3141 | while (line[i] && whitespace (line[i])) | |
3142 | i++; | |
3143 | word = line + i; | |
bc7bed50 | 3144 | |
5e13499c CR |
3145 | while (line[i] && !whitespace (line[i])) |
3146 | i++; | |
bc7bed50 | 3147 | |
5e13499c CR |
3148 | if (line[i]) |
3149 | line[i++] = '\0'; | |
bc7bed50 | 3150 | |
5e13499c | 3151 | command = find_command (word); |
bc7bed50 | 3152 | |
5e13499c CR |
3153 | if (!command) |
3154 | { | |
3155 | fprintf (stderr, "%s: No such command for FileMan.\n", word); | |
3156 | return (-1); | |
3157 | } | |
bc7bed50 | 3158 | |
5e13499c CR |
3159 | /* Get argument to command, if any. */ |
3160 | while (whitespace (line[i])) | |
3161 | i++; | |
bc7bed50 | 3162 | |
5e13499c | 3163 | word = line + i; |
bc7bed50 | 3164 | |
5e13499c CR |
3165 | /* Call the function. */ |
3166 | return ((*(command->func)) (word)); | |
3167 | } | |
bc7bed50 | 3168 | |
5e13499c CR |
3169 | /* Look up NAME as the name of a command, and return a pointer to that |
3170 | command. Return a NULL pointer if NAME isn't a command name. */ | |
3171 | COMMAND * | |
3172 | find_command (name) | |
3173 | char *name; | |
3174 | { | |
3175 | register int i; | |
bc7bed50 | 3176 | |
5e13499c CR |
3177 | for (i = 0; commands[i].name; i++) |
3178 | if (strcmp (name, commands[i].name) == 0) | |
3179 | return (&commands[i]); | |
bc7bed50 | 3180 | |
5e13499c CR |
3181 | return ((COMMAND *)NULL); |
3182 | } | |
bc7bed50 | 3183 | |
5e13499c CR |
3184 | /* Strip whitespace from the start and end of STRING. Return a pointer |
3185 | into STRING. */ | |
3186 | char * | |
3187 | stripwhite (string) | |
3188 | char *string; | |
3189 | { | |
3190 | register char *s, *t; | |
bc7bed50 | 3191 | |
5e13499c CR |
3192 | for (s = string; whitespace (*s); s++) |
3193 | ; | |
bc7bed50 | 3194 | |
5e13499c CR |
3195 | if (*s == 0) |
3196 | return (s); | |
bc7bed50 | 3197 | |
5e13499c CR |
3198 | t = s + strlen (s) - 1; |
3199 | while (t > s && whitespace (*t)) | |
3200 | t--; | |
3201 | *++t = '\0'; | |
bc7bed50 | 3202 | |
5e13499c CR |
3203 | return s; |
3204 | } | |
bc7bed50 | 3205 | |
5e13499c CR |
3206 | /* **************************************************************** */ |
3207 | /* */ | |
3208 | /* Interface to Readline Completion */ | |
3209 | /* */ | |
3210 | /* **************************************************************** */ | |
bc7bed50 | 3211 | |
5e13499c CR |
3212 | char *command_generator __P((const char *, int)); |
3213 | char **fileman_completion __P((const char *, int, int)); | |
bc7bed50 | 3214 | |
5e13499c CR |
3215 | /* Tell the GNU Readline library how to complete. We want to try to |
3216 | complete on command names if this is the first word in the line, or | |
3217 | on filenames if not. */ | |
3218 | initialize_readline () | |
3219 | { | |
3220 | /* Allow conditional parsing of the ~/.inputrc file. */ | |
3221 | rl_readline_name = "FileMan"; | |
bc7bed50 | 3222 | |
5e13499c CR |
3223 | /* Tell the completer that we want a crack first. */ |
3224 | rl_attempted_completion_function = fileman_completion; | |
3225 | } | |
bc7bed50 | 3226 | |
5e13499c CR |
3227 | /* Attempt to complete on the contents of TEXT. START and END |
3228 | bound the region of rl_line_buffer that contains the word to | |
3229 | complete. TEXT is the word to complete. We can use the entire | |
3230 | contents of rl_line_buffer in case we want to do some simple | |
3231 | parsing. Returnthe array of matches, or NULL if there aren't any. */ | |
3232 | char ** | |
3233 | fileman_completion (text, start, end) | |
3234 | const char *text; | |
3235 | int start, end; | |
3236 | { | |
3237 | char **matches; | |
bc7bed50 | 3238 | |
5e13499c | 3239 | matches = (char **)NULL; |
bc7bed50 | 3240 | |
5e13499c CR |
3241 | /* If this word is at the start of the line, then it is a command |
3242 | to complete. Otherwise it is the name of a file in the current | |
3243 | directory. */ | |
3244 | if (start == 0) | |
3245 | matches = rl_completion_matches (text, command_generator); | |
bc7bed50 | 3246 | |
5e13499c CR |
3247 | return (matches); |
3248 | } | |
bc7bed50 | 3249 | |
5e13499c CR |
3250 | /* Generator function for command completion. STATE lets us |
3251 | know whether to start from scratch; without any state | |
3252 | (i.e. STATE == 0), then we start at the top of the list. */ | |
3253 | char * | |
3254 | command_generator (text, state) | |
3255 | const char *text; | |
3256 | int state; | |
3257 | { | |
3258 | static int list_index, len; | |
3259 | char *name; | |
bc7bed50 | 3260 | |
5e13499c CR |
3261 | /* If this is a new word to complete, initialize now. This |
3262 | includes saving the length of TEXT for efficiency, and | |
3263 | initializing the index variable to 0. */ | |
3264 | if (!state) | |
3265 | { | |
3266 | list_index = 0; | |
3267 | len = strlen (text); | |
3268 | } | |
bc7bed50 | 3269 | |
5e13499c CR |
3270 | /* Return the next name which partially matches from the |
3271 | command list. */ | |
3272 | while (name = commands[list_index].name) | |
3273 | { | |
3274 | list_index++; | |
bc7bed50 | 3275 | |
5e13499c CR |
3276 | if (strncmp (name, text, len) == 0) |
3277 | return (dupstr(name)); | |
3278 | } | |
bc7bed50 | 3279 | |
5e13499c CR |
3280 | /* If no names matched, then return NULL. */ |
3281 | return ((char *)NULL); | |
3282 | } | |
bc7bed50 | 3283 | |
5e13499c CR |
3284 | /* **************************************************************** */ |
3285 | /* */ | |
3286 | /* FileMan Commands */ | |
3287 | /* */ | |
3288 | /* **************************************************************** */ | |
bc7bed50 | 3289 | |
5e13499c CR |
3290 | /* String to pass to system (). This is for the LIST, VIEW and RENAME |
3291 | commands. */ | |
3292 | static char syscom[1024]; | |
bc7bed50 | 3293 | |
5e13499c CR |
3294 | /* List the file(s) named in arg. */ |
3295 | com_list (arg) | |
3296 | char *arg; | |
3297 | { | |
3298 | if (!arg) | |
3299 | arg = ""; | |
bc7bed50 | 3300 | |
5e13499c CR |
3301 | sprintf (syscom, "ls -FClg %s", arg); |
3302 | return (system (syscom)); | |
3303 | } | |
bc7bed50 | 3304 | |
5e13499c CR |
3305 | com_view (arg) |
3306 | char *arg; | |
3307 | { | |
3308 | if (!valid_argument ("view", arg)) | |
3309 | return 1; | |
bc7bed50 | 3310 | |
5e13499c CR |
3311 | sprintf (syscom, "more %s", arg); |
3312 | return (system (syscom)); | |
3313 | } | |
bc7bed50 | 3314 | |
5e13499c CR |
3315 | com_rename (arg) |
3316 | char *arg; | |
3317 | { | |
3318 | too_dangerous ("rename"); | |
3319 | return (1); | |
3320 | } | |
bc7bed50 | 3321 | |
5e13499c CR |
3322 | com_stat (arg) |
3323 | char *arg; | |
3324 | { | |
3325 | struct stat finfo; | |
bc7bed50 | 3326 | |
5e13499c CR |
3327 | if (!valid_argument ("stat", arg)) |
3328 | return (1); | |
bc7bed50 | 3329 | |
5e13499c CR |
3330 | if (stat (arg, &finfo) == -1) |
3331 | { | |
3332 | perror (arg); | |
3333 | return (1); | |
3334 | } | |
bc7bed50 | 3335 | |
5e13499c | 3336 | printf ("Statistics for `%s':\n", arg); |
bc7bed50 | 3337 | |
5e13499c CR |
3338 | printf ("%s has %d link%s, and is %d byte%s in length.\n", arg, |
3339 | finfo.st_nlink, | |
3340 | (finfo.st_nlink == 1) ? "" : "s", | |
3341 | finfo.st_size, | |
3342 | (finfo.st_size == 1) ? "" : "s"); | |
3343 | printf ("Inode Last Change at: %s", ctime (&finfo.st_ctime)); | |
3344 | printf (" Last access at: %s", ctime (&finfo.st_atime)); | |
3345 | printf (" Last modified at: %s", ctime (&finfo.st_mtime)); | |
3346 | return (0); | |
3347 | } | |
bc7bed50 | 3348 | |
5e13499c CR |
3349 | com_delete (arg) |
3350 | char *arg; | |
3351 | { | |
3352 | too_dangerous ("delete"); | |
3353 | return (1); | |
3354 | } | |
bc7bed50 | 3355 | |
5e13499c CR |
3356 | /* Print out help for ARG, or for all of the commands if ARG is |
3357 | not present. */ | |
3358 | com_help (arg) | |
3359 | char *arg; | |
3360 | { | |
3361 | register int i; | |
3362 | int printed = 0; | |
bc7bed50 | 3363 | |
5e13499c CR |
3364 | for (i = 0; commands[i].name; i++) |
3365 | { | |
3366 | if (!*arg || (strcmp (arg, commands[i].name) == 0)) | |
3367 | { | |
3368 | printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc); | |
3369 | printed++; | |
3370 | } | |
3371 | } | |
bc7bed50 | 3372 | |
5e13499c CR |
3373 | if (!printed) |
3374 | { | |
3375 | printf ("No commands match `%s'. Possibilties are:\n", arg); | |
bc7bed50 | 3376 | |
5e13499c CR |
3377 | for (i = 0; commands[i].name; i++) |
3378 | { | |
3379 | /* Print in six columns. */ | |
3380 | if (printed == 6) | |
3381 | { | |
3382 | printed = 0; | |
3383 | printf ("\n"); | |
3384 | } | |
bc7bed50 | 3385 | |
5e13499c CR |
3386 | printf ("%s\t", commands[i].name); |
3387 | printed++; | |
3388 | } | |
bc7bed50 | 3389 | |
5e13499c CR |
3390 | if (printed) |
3391 | printf ("\n"); | |
3392 | } | |
3393 | return (0); | |
3394 | } | |
bc7bed50 | 3395 | |
5e13499c CR |
3396 | /* Change to the directory ARG. */ |
3397 | com_cd (arg) | |
3398 | char *arg; | |
3399 | { | |
3400 | if (chdir (arg) == -1) | |
3401 | { | |
3402 | perror (arg); | |
3403 | return 1; | |
3404 | } | |
bc7bed50 | 3405 | |
5e13499c CR |
3406 | com_pwd (""); |
3407 | return (0); | |
3408 | } | |
bc7bed50 | 3409 | |
5e13499c CR |
3410 | /* Print out the current working directory. */ |
3411 | com_pwd (ignore) | |
3412 | char *ignore; | |
3413 | { | |
3414 | char dir[1024], *s; | |
bc7bed50 | 3415 | |
5e13499c CR |
3416 | s = getcwd (dir, sizeof(dir) - 1); |
3417 | if (s == 0) | |
3418 | { | |
3419 | printf ("Error getting pwd: %s\n", dir); | |
3420 | return 1; | |
3421 | } | |
bc7bed50 | 3422 | |
5e13499c CR |
3423 | printf ("Current directory is %s\n", dir); |
3424 | return 0; | |
3425 | } | |
bc7bed50 | 3426 | |
5e13499c CR |
3427 | /* The user wishes to quit using this program. Just set DONE |
3428 | non-zero. */ | |
3429 | com_quit (arg) | |
3430 | char *arg; | |
3431 | { | |
3432 | done = 1; | |
3433 | return (0); | |
3434 | } | |
bc7bed50 | 3435 | |
5e13499c CR |
3436 | /* Function which tells you that you can't do this. */ |
3437 | too_dangerous (caller) | |
3438 | char *caller; | |
3439 | { | |
3440 | fprintf (stderr, | |
bc7bed50 | 3441 | "%s: Too dangerous for me to distribute.\n", |
5e13499c CR |
3442 | caller); |
3443 | fprintf (stderr, "Write it yourself.\n"); | |
3444 | } | |
bc7bed50 | 3445 | |
5e13499c CR |
3446 | /* Return non-zero if ARG is a valid argument for CALLER, |
3447 | else print an error message and return zero. */ | |
3448 | int | |
3449 | valid_argument (caller, arg) | |
3450 | char *caller, *arg; | |
3451 | { | |
3452 | if (!arg || !*arg) | |
3453 | { | |
3454 | fprintf (stderr, "%s: Argument required.\n", caller); | |
3455 | return (0); | |
3456 | } | |
bc7bed50 | 3457 | |
5e13499c CR |
3458 | return (1); |
3459 | } | |
3460 | ||
3461 | \1f | |
3462 | File: readline.info, Node: Copying This Manual, Next: Concept Index, Prev: Programming with GNU Readline, Up: Top | |
3463 | ||
bc7bed50 CR |
3464 | Appendix A Copying This Manual |
3465 | ****************************** | |
5e13499c CR |
3466 | |
3467 | * Menu: | |
3468 | ||
3469 | * GNU Free Documentation License:: License for copying this manual. | |
3470 | ||
3471 | \1f | |
3472 | File: readline.info, Node: GNU Free Documentation License, Up: Copying This Manual | |
3473 | ||
bc7bed50 CR |
3474 | A.1 GNU Free Documentation License |
3475 | ================================== | |
5e13499c CR |
3476 | |
3477 | Version 1.2, November 2002 | |
bc7bed50 | 3478 | |
5e13499c CR |
3479 | Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. |
3480 | 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA | |
bc7bed50 | 3481 | |
5e13499c CR |
3482 | Everyone is permitted to copy and distribute verbatim copies |
3483 | of this license document, but changing it is not allowed. | |
3484 | ||
3485 | 0. PREAMBLE | |
3486 | ||
3487 | The purpose of this License is to make a manual, textbook, or other | |
3488 | functional and useful document "free" in the sense of freedom: to | |
3489 | assure everyone the effective freedom to copy and redistribute it, | |
3490 | with or without modifying it, either commercially or | |
3491 | noncommercially. Secondarily, this License preserves for the | |
3492 | author and publisher a way to get credit for their work, while not | |
3493 | being considered responsible for modifications made by others. | |
3494 | ||
3495 | This License is a kind of "copyleft", which means that derivative | |
3496 | works of the document must themselves be free in the same sense. | |
3497 | It complements the GNU General Public License, which is a copyleft | |
3498 | license designed for free software. | |
3499 | ||
3500 | We have designed this License in order to use it for manuals for | |
3501 | free software, because free software needs free documentation: a | |
3502 | free program should come with manuals providing the same freedoms | |
3503 | that the software does. But this License is not limited to | |
3504 | software manuals; it can be used for any textual work, regardless | |
3505 | of subject matter or whether it is published as a printed book. | |
3506 | We recommend this License principally for works whose purpose is | |
3507 | instruction or reference. | |
3508 | ||
3509 | 1. APPLICABILITY AND DEFINITIONS | |
3510 | ||
3511 | This License applies to any manual or other work, in any medium, | |
3512 | that contains a notice placed by the copyright holder saying it | |
3513 | can be distributed under the terms of this License. Such a notice | |
3514 | grants a world-wide, royalty-free license, unlimited in duration, | |
3515 | to use that work under the conditions stated herein. The | |
3516 | "Document", below, refers to any such manual or work. Any member | |
3517 | of the public is a licensee, and is addressed as "you". You | |
3518 | accept the license if you copy, modify or distribute the work in a | |
3519 | way requiring permission under copyright law. | |
3520 | ||
3521 | A "Modified Version" of the Document means any work containing the | |
3522 | Document or a portion of it, either copied verbatim, or with | |
3523 | modifications and/or translated into another language. | |
3524 | ||
3525 | A "Secondary Section" is a named appendix or a front-matter section | |
3526 | of the Document that deals exclusively with the relationship of the | |
3527 | publishers or authors of the Document to the Document's overall | |
3528 | subject (or to related matters) and contains nothing that could | |
3529 | fall directly within that overall subject. (Thus, if the Document | |
3530 | is in part a textbook of mathematics, a Secondary Section may not | |
3531 | explain any mathematics.) The relationship could be a matter of | |
3532 | historical connection with the subject or with related matters, or | |
3533 | of legal, commercial, philosophical, ethical or political position | |
3534 | regarding them. | |
3535 | ||
3536 | The "Invariant Sections" are certain Secondary Sections whose | |
3537 | titles are designated, as being those of Invariant Sections, in | |
3538 | the notice that says that the Document is released under this | |
3539 | License. If a section does not fit the above definition of | |
3540 | Secondary then it is not allowed to be designated as Invariant. | |
3541 | The Document may contain zero Invariant Sections. If the Document | |
3542 | does not identify any Invariant Sections then there are none. | |
3543 | ||
3544 | The "Cover Texts" are certain short passages of text that are | |
3545 | listed, as Front-Cover Texts or Back-Cover Texts, in the notice | |
3546 | that says that the Document is released under this License. A | |
3547 | Front-Cover Text may be at most 5 words, and a Back-Cover Text may | |
3548 | be at most 25 words. | |
3549 | ||
3550 | A "Transparent" copy of the Document means a machine-readable copy, | |
3551 | represented in a format whose specification is available to the | |
3552 | general public, that is suitable for revising the document | |
3553 | straightforwardly with generic text editors or (for images | |
3554 | composed of pixels) generic paint programs or (for drawings) some | |
3555 | widely available drawing editor, and that is suitable for input to | |
3556 | text formatters or for automatic translation to a variety of | |
3557 | formats suitable for input to text formatters. A copy made in an | |
3558 | otherwise Transparent file format whose markup, or absence of | |
3559 | markup, has been arranged to thwart or discourage subsequent | |
3560 | modification by readers is not Transparent. An image format is | |
3561 | not Transparent if used for any substantial amount of text. A | |
3562 | copy that is not "Transparent" is called "Opaque". | |
3563 | ||
3564 | Examples of suitable formats for Transparent copies include plain | |
3565 | ASCII without markup, Texinfo input format, LaTeX input format, | |
3566 | SGML or XML using a publicly available DTD, and | |
3567 | standard-conforming simple HTML, PostScript or PDF designed for | |
3568 | human modification. Examples of transparent image formats include | |
3569 | PNG, XCF and JPG. Opaque formats include proprietary formats that | |
3570 | can be read and edited only by proprietary word processors, SGML or | |
3571 | XML for which the DTD and/or processing tools are not generally | |
3572 | available, and the machine-generated HTML, PostScript or PDF | |
3573 | produced by some word processors for output purposes only. | |
3574 | ||
3575 | The "Title Page" means, for a printed book, the title page itself, | |
3576 | plus such following pages as are needed to hold, legibly, the | |
3577 | material this License requires to appear in the title page. For | |
3578 | works in formats which do not have any title page as such, "Title | |
3579 | Page" means the text near the most prominent appearance of the | |
3580 | work's title, preceding the beginning of the body of the text. | |
3581 | ||
3582 | A section "Entitled XYZ" means a named subunit of the Document | |
3583 | whose title either is precisely XYZ or contains XYZ in parentheses | |
3584 | following text that translates XYZ in another language. (Here XYZ | |
3585 | stands for a specific section name mentioned below, such as | |
3586 | "Acknowledgements", "Dedications", "Endorsements", or "History".) | |
3587 | To "Preserve the Title" of such a section when you modify the | |
3588 | Document means that it remains a section "Entitled XYZ" according | |
3589 | to this definition. | |
3590 | ||
3591 | The Document may include Warranty Disclaimers next to the notice | |
3592 | which states that this License applies to the Document. These | |
3593 | Warranty Disclaimers are considered to be included by reference in | |
3594 | this License, but only as regards disclaiming warranties: any other | |
3595 | implication that these Warranty Disclaimers may have is void and | |
3596 | has no effect on the meaning of this License. | |
3597 | ||
3598 | 2. VERBATIM COPYING | |
3599 | ||
3600 | You may copy and distribute the Document in any medium, either | |
3601 | commercially or noncommercially, provided that this License, the | |
3602 | copyright notices, and the license notice saying this License | |
3603 | applies to the Document are reproduced in all copies, and that you | |
3604 | add no other conditions whatsoever to those of this License. You | |
3605 | may not use technical measures to obstruct or control the reading | |
3606 | or further copying of the copies you make or distribute. However, | |
3607 | you may accept compensation in exchange for copies. If you | |
3608 | distribute a large enough number of copies you must also follow | |
3609 | the conditions in section 3. | |
3610 | ||
3611 | You may also lend copies, under the same conditions stated above, | |
3612 | and you may publicly display copies. | |
3613 | ||
3614 | 3. COPYING IN QUANTITY | |
3615 | ||
3616 | If you publish printed copies (or copies in media that commonly | |
3617 | have printed covers) of the Document, numbering more than 100, and | |
3618 | the Document's license notice requires Cover Texts, you must | |
3619 | enclose the copies in covers that carry, clearly and legibly, all | |
3620 | these Cover Texts: Front-Cover Texts on the front cover, and | |
3621 | Back-Cover Texts on the back cover. Both covers must also clearly | |
3622 | and legibly identify you as the publisher of these copies. The | |
3623 | front cover must present the full title with all words of the | |
3624 | title equally prominent and visible. You may add other material | |
3625 | on the covers in addition. Copying with changes limited to the | |
3626 | covers, as long as they preserve the title of the Document and | |
3627 | satisfy these conditions, can be treated as verbatim copying in | |
3628 | other respects. | |
3629 | ||
3630 | If the required texts for either cover are too voluminous to fit | |
3631 | legibly, you should put the first ones listed (as many as fit | |
3632 | reasonably) on the actual cover, and continue the rest onto | |
3633 | adjacent pages. | |
3634 | ||
3635 | If you publish or distribute Opaque copies of the Document | |
3636 | numbering more than 100, you must either include a | |
3637 | machine-readable Transparent copy along with each Opaque copy, or | |
3638 | state in or with each Opaque copy a computer-network location from | |
3639 | which the general network-using public has access to download | |
3640 | using public-standard network protocols a complete Transparent | |
3641 | copy of the Document, free of added material. If you use the | |
3642 | latter option, you must take reasonably prudent steps, when you | |
3643 | begin distribution of Opaque copies in quantity, to ensure that | |
3644 | this Transparent copy will remain thus accessible at the stated | |
3645 | location until at least one year after the last time you | |
3646 | distribute an Opaque copy (directly or through your agents or | |
3647 | retailers) of that edition to the public. | |
3648 | ||
3649 | It is requested, but not required, that you contact the authors of | |
3650 | the Document well before redistributing any large number of | |
3651 | copies, to give them a chance to provide you with an updated | |
3652 | version of the Document. | |
3653 | ||
3654 | 4. MODIFICATIONS | |
3655 | ||
3656 | You may copy and distribute a Modified Version of the Document | |
3657 | under the conditions of sections 2 and 3 above, provided that you | |
3658 | release the Modified Version under precisely this License, with | |
3659 | the Modified Version filling the role of the Document, thus | |
3660 | licensing distribution and modification of the Modified Version to | |
3661 | whoever possesses a copy of it. In addition, you must do these | |
3662 | things in the Modified Version: | |
3663 | ||
3664 | A. Use in the Title Page (and on the covers, if any) a title | |
3665 | distinct from that of the Document, and from those of | |
3666 | previous versions (which should, if there were any, be listed | |
3667 | in the History section of the Document). You may use the | |
3668 | same title as a previous version if the original publisher of | |
3669 | that version gives permission. | |
3670 | ||
3671 | B. List on the Title Page, as authors, one or more persons or | |
3672 | entities responsible for authorship of the modifications in | |
3673 | the Modified Version, together with at least five of the | |
3674 | principal authors of the Document (all of its principal | |
3675 | authors, if it has fewer than five), unless they release you | |
3676 | from this requirement. | |
3677 | ||
3678 | C. State on the Title page the name of the publisher of the | |
3679 | Modified Version, as the publisher. | |
3680 | ||
3681 | D. Preserve all the copyright notices of the Document. | |
3682 | ||
3683 | E. Add an appropriate copyright notice for your modifications | |
3684 | adjacent to the other copyright notices. | |
3685 | ||
3686 | F. Include, immediately after the copyright notices, a license | |
3687 | notice giving the public permission to use the Modified | |
3688 | Version under the terms of this License, in the form shown in | |
3689 | the Addendum below. | |
3690 | ||
3691 | G. Preserve in that license notice the full lists of Invariant | |
3692 | Sections and required Cover Texts given in the Document's | |
3693 | license notice. | |
3694 | ||
3695 | H. Include an unaltered copy of this License. | |
3696 | ||
3697 | I. Preserve the section Entitled "History", Preserve its Title, | |
3698 | and add to it an item stating at least the title, year, new | |
3699 | authors, and publisher of the Modified Version as given on | |
3700 | the Title Page. If there is no section Entitled "History" in | |
3701 | the Document, create one stating the title, year, authors, | |
3702 | and publisher of the Document as given on its Title Page, | |
3703 | then add an item describing the Modified Version as stated in | |
3704 | the previous sentence. | |
3705 | ||
3706 | J. Preserve the network location, if any, given in the Document | |
3707 | for public access to a Transparent copy of the Document, and | |
3708 | likewise the network locations given in the Document for | |
3709 | previous versions it was based on. These may be placed in | |
3710 | the "History" section. You may omit a network location for a | |
3711 | work that was published at least four years before the | |
3712 | Document itself, or if the original publisher of the version | |
3713 | it refers to gives permission. | |
3714 | ||
3715 | K. For any section Entitled "Acknowledgements" or "Dedications", | |
3716 | Preserve the Title of the section, and preserve in the | |
3717 | section all the substance and tone of each of the contributor | |
3718 | acknowledgements and/or dedications given therein. | |
3719 | ||
3720 | L. Preserve all the Invariant Sections of the Document, | |
3721 | unaltered in their text and in their titles. Section numbers | |
3722 | or the equivalent are not considered part of the section | |
3723 | titles. | |
3724 | ||
3725 | M. Delete any section Entitled "Endorsements". Such a section | |
3726 | may not be included in the Modified Version. | |
3727 | ||
3728 | N. Do not retitle any existing section to be Entitled | |
3729 | "Endorsements" or to conflict in title with any Invariant | |
3730 | Section. | |
3731 | ||
3732 | O. Preserve any Warranty Disclaimers. | |
3733 | ||
3734 | If the Modified Version includes new front-matter sections or | |
3735 | appendices that qualify as Secondary Sections and contain no | |
3736 | material copied from the Document, you may at your option | |
3737 | designate some or all of these sections as invariant. To do this, | |
3738 | add their titles to the list of Invariant Sections in the Modified | |
3739 | Version's license notice. These titles must be distinct from any | |
3740 | other section titles. | |
3741 | ||
3742 | You may add a section Entitled "Endorsements", provided it contains | |
3743 | nothing but endorsements of your Modified Version by various | |
3744 | parties--for example, statements of peer review or that the text | |
3745 | has been approved by an organization as the authoritative | |
3746 | definition of a standard. | |
3747 | ||
3748 | You may add a passage of up to five words as a Front-Cover Text, | |
3749 | and a passage of up to 25 words as a Back-Cover Text, to the end | |
3750 | of the list of Cover Texts in the Modified Version. Only one | |
3751 | passage of Front-Cover Text and one of Back-Cover Text may be | |
3752 | added by (or through arrangements made by) any one entity. If the | |
3753 | Document already includes a cover text for the same cover, | |
3754 | previously added by you or by arrangement made by the same entity | |
3755 | you are acting on behalf of, you may not add another; but you may | |
3756 | replace the old one, on explicit permission from the previous | |
3757 | publisher that added the old one. | |
3758 | ||
3759 | The author(s) and publisher(s) of the Document do not by this | |
3760 | License give permission to use their names for publicity for or to | |
3761 | assert or imply endorsement of any Modified Version. | |
3762 | ||
3763 | 5. COMBINING DOCUMENTS | |
3764 | ||
3765 | You may combine the Document with other documents released under | |
3766 | this License, under the terms defined in section 4 above for | |
3767 | modified versions, provided that you include in the combination | |
3768 | all of the Invariant Sections of all of the original documents, | |
3769 | unmodified, and list them all as Invariant Sections of your | |
3770 | combined work in its license notice, and that you preserve all | |
3771 | their Warranty Disclaimers. | |
3772 | ||
3773 | The combined work need only contain one copy of this License, and | |
3774 | multiple identical Invariant Sections may be replaced with a single | |
3775 | copy. If there are multiple Invariant Sections with the same name | |
3776 | but different contents, make the title of each such section unique | |
3777 | by adding at the end of it, in parentheses, the name of the | |
3778 | original author or publisher of that section if known, or else a | |
3779 | unique number. Make the same adjustment to the section titles in | |
3780 | the list of Invariant Sections in the license notice of the | |
3781 | combined work. | |
3782 | ||
3783 | In the combination, you must combine any sections Entitled | |
3784 | "History" in the various original documents, forming one section | |
3785 | Entitled "History"; likewise combine any sections Entitled | |
3786 | "Acknowledgements", and any sections Entitled "Dedications". You | |
3787 | must delete all sections Entitled "Endorsements." | |
3788 | ||
3789 | 6. COLLECTIONS OF DOCUMENTS | |
3790 | ||
3791 | You may make a collection consisting of the Document and other | |
3792 | documents released under this License, and replace the individual | |
3793 | copies of this License in the various documents with a single copy | |
3794 | that is included in the collection, provided that you follow the | |
3795 | rules of this License for verbatim copying of each of the | |
3796 | documents in all other respects. | |
3797 | ||
3798 | You may extract a single document from such a collection, and | |
3799 | distribute it individually under this License, provided you insert | |
3800 | a copy of this License into the extracted document, and follow | |
3801 | this License in all other respects regarding verbatim copying of | |
3802 | that document. | |
3803 | ||
3804 | 7. AGGREGATION WITH INDEPENDENT WORKS | |
3805 | ||
3806 | A compilation of the Document or its derivatives with other | |
3807 | separate and independent documents or works, in or on a volume of | |
3808 | a storage or distribution medium, is called an "aggregate" if the | |
3809 | copyright resulting from the compilation is not used to limit the | |
3810 | legal rights of the compilation's users beyond what the individual | |
3811 | works permit. When the Document is included an aggregate, this | |
3812 | License does not apply to the other works in the aggregate which | |
3813 | are not themselves derivative works of the Document. | |
3814 | ||
3815 | If the Cover Text requirement of section 3 is applicable to these | |
3816 | copies of the Document, then if the Document is less than one half | |
3817 | of the entire aggregate, the Document's Cover Texts may be placed | |
3818 | on covers that bracket the Document within the aggregate, or the | |
3819 | electronic equivalent of covers if the Document is in electronic | |
3820 | form. Otherwise they must appear on printed covers that bracket | |
3821 | the whole aggregate. | |
3822 | ||
3823 | 8. TRANSLATION | |
3824 | ||
3825 | Translation is considered a kind of modification, so you may | |
3826 | distribute translations of the Document under the terms of section | |
3827 | 4. Replacing Invariant Sections with translations requires special | |
3828 | permission from their copyright holders, but you may include | |
3829 | translations of some or all Invariant Sections in addition to the | |
3830 | original versions of these Invariant Sections. You may include a | |
3831 | translation of this License, and all the license notices in the | |
3832 | Document, and any Warranty Disclaimers, provided that you also | |
3833 | include the original English version of this License and the | |
3834 | original versions of those notices and disclaimers. In case of a | |
3835 | disagreement between the translation and the original version of | |
3836 | this License or a notice or disclaimer, the original version will | |
3837 | prevail. | |
3838 | ||
3839 | If a section in the Document is Entitled "Acknowledgements", | |
3840 | "Dedications", or "History", the requirement (section 4) to | |
3841 | Preserve its Title (section 1) will typically require changing the | |
3842 | actual title. | |
3843 | ||
3844 | 9. TERMINATION | |
3845 | ||
3846 | You may not copy, modify, sublicense, or distribute the Document | |
3847 | except as expressly provided for under this License. Any other | |
3848 | attempt to copy, modify, sublicense or distribute the Document is | |
3849 | void, and will automatically terminate your rights under this | |
3850 | License. However, parties who have received copies, or rights, | |
3851 | from you under this License will not have their licenses | |
3852 | terminated so long as such parties remain in full compliance. | |
3853 | ||
3854 | 10. FUTURE REVISIONS OF THIS LICENSE | |
3855 | ||
3856 | The Free Software Foundation may publish new, revised versions of | |
3857 | the GNU Free Documentation License from time to time. Such new | |
3858 | versions will be similar in spirit to the present version, but may | |
3859 | differ in detail to address new problems or concerns. See | |
3860 | `http://www.gnu.org/copyleft/'. | |
3861 | ||
3862 | Each version of the License is given a distinguishing version | |
3863 | number. If the Document specifies that a particular numbered | |
3864 | version of this License "or any later version" applies to it, you | |
3865 | have the option of following the terms and conditions either of | |
3866 | that specified version or of any later version that has been | |
3867 | published (not as a draft) by the Free Software Foundation. If | |
3868 | the Document does not specify a version number of this License, | |
3869 | you may choose any version ever published (not as a draft) by the | |
3870 | Free Software Foundation. | |
3871 | ||
bc7bed50 CR |
3872 | A.1.1 ADDENDUM: How to use this License for your documents |
3873 | ---------------------------------------------------------- | |
5e13499c | 3874 | |
bc7bed50 | 3875 | To use this License in a document you have written, include a copy of |
5e13499c CR |
3876 | the License in the document and put the following copyright and license |
3877 | notices just after the title page: | |
3878 | ||
3879 | Copyright (C) YEAR YOUR NAME. | |
3880 | Permission is granted to copy, distribute and/or modify this document | |
3881 | under the terms of the GNU Free Documentation License, Version 1.2 | |
3882 | or any later version published by the Free Software Foundation; | |
3883 | with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. | |
3884 | A copy of the license is included in the section entitled ``GNU | |
3885 | Free Documentation License''. | |
3886 | ||
3887 | If you have Invariant Sections, Front-Cover Texts and Back-Cover | |
3888 | Texts, replace the "with...Texts." line with this: | |
3889 | ||
3890 | with the Invariant Sections being LIST THEIR TITLES, with | |
3891 | the Front-Cover Texts being LIST, and with the Back-Cover Texts | |
3892 | being LIST. | |
3893 | ||
3894 | If you have Invariant Sections without Cover Texts, or some other | |
3895 | combination of the three, merge those two alternatives to suit the | |
3896 | situation. | |
3897 | ||
3898 | If your document contains nontrivial examples of program code, we | |
3899 | recommend releasing these examples in parallel under your choice of | |
3900 | free software license, such as the GNU General Public License, to | |
3901 | permit their use in free software. | |
3902 | ||
3903 | \1f | |
3904 | File: readline.info, Node: Concept Index, Next: Function and Variable Index, Prev: Copying This Manual, Up: Top | |
3905 | ||
3906 | Concept Index | |
3907 | ************* | |
3908 | ||
bc7bed50 | 3909 | \0\b[index\0\b] |
5e13499c CR |
3910 | * Menu: |
3911 | ||
3912 | * application-specific completion functions: Custom Completers. | |
bc7bed50 | 3913 | (line 6) |
5e13499c | 3914 | * command editing: Readline Bare Essentials. |
bc7bed50 | 3915 | (line 6) |
5e13499c | 3916 | * editing command lines: Readline Bare Essentials. |
bc7bed50 | 3917 | (line 6) |
5e13499c | 3918 | * FDL, GNU Free Documentation License: GNU Free Documentation License. |
bc7bed50 CR |
3919 | (line 6) |
3920 | * initialization file, readline: Readline Init File. (line 6) | |
3921 | * interaction, readline: Readline Interaction. (line 6) | |
5e13499c | 3922 | * kill ring: Readline Killing Commands. |
bc7bed50 | 3923 | (line 19) |
5e13499c | 3924 | * killing text: Readline Killing Commands. |
bc7bed50 | 3925 | (line 6) |
5e13499c | 3926 | * notation, readline: Readline Bare Essentials. |
bc7bed50 CR |
3927 | (line 6) |
3928 | * readline, function: Basic Behavior. (line 12) | |
5e13499c | 3929 | * variables, readline: Readline Init File Syntax. |
bc7bed50 | 3930 | (line 34) |
5e13499c | 3931 | * yanking text: Readline Killing Commands. |
bc7bed50 | 3932 | (line 6) |
5e13499c CR |
3933 | |
3934 | \1f | |
3935 | File: readline.info, Node: Function and Variable Index, Prev: Concept Index, Up: Top | |
3936 | ||
3937 | Function and Variable Index | |
3938 | *************************** | |
3939 | ||
bc7bed50 | 3940 | \0\b[index\0\b] |
5e13499c CR |
3941 | * Menu: |
3942 | ||
bc7bed50 CR |
3943 | * _rl_digit_p: Utility Functions. (line 46) |
3944 | * _rl_digit_value: Utility Functions. (line 57) | |
3945 | * _rl_lowercase_p: Utility Functions. (line 43) | |
3946 | * _rl_to_lower: Utility Functions. (line 53) | |
3947 | * _rl_to_upper: Utility Functions. (line 49) | |
3948 | * _rl_uppercase_p: Utility Functions. (line 40) | |
5e13499c | 3949 | * abort (C-g): Miscellaneous Commands. |
bc7bed50 | 3950 | (line 10) |
5e13499c | 3951 | * accept-line (Newline or Return): Commands For History. |
bc7bed50 CR |
3952 | (line 6) |
3953 | * backward-char (C-b): Commands For Moving. (line 15) | |
3954 | * backward-delete-char (Rubout): Commands For Text. (line 11) | |
5e13499c | 3955 | * backward-kill-line (C-x Rubout): Commands For Killing. |
bc7bed50 | 3956 | (line 9) |
5e13499c | 3957 | * backward-kill-word (M-<DEL>): Commands For Killing. |
bc7bed50 CR |
3958 | (line 24) |
3959 | * backward-word (M-b): Commands For Moving. (line 22) | |
5e13499c | 3960 | * beginning-of-history (M-<): Commands For History. |
bc7bed50 CR |
3961 | (line 19) |
3962 | * beginning-of-line (C-a): Commands For Moving. (line 6) | |
5e13499c | 3963 | * bell-style: Readline Init File Syntax. |
bc7bed50 CR |
3964 | (line 35) |
3965 | * bind-tty-special-chars: Readline Init File Syntax. | |
3966 | (line 42) | |
3967 | * call-last-kbd-macro (C-x e): Keyboard Macros. (line 13) | |
3968 | * capitalize-word (M-c): Commands For Text. (line 49) | |
5e13499c | 3969 | * character-search (C-]): Miscellaneous Commands. |
bc7bed50 | 3970 | (line 41) |
5e13499c | 3971 | * character-search-backward (M-C-]): Miscellaneous Commands. |
bc7bed50 CR |
3972 | (line 46) |
3973 | * clear-screen (C-l): Commands For Moving. (line 26) | |
5e13499c | 3974 | * comment-begin: Readline Init File Syntax. |
bc7bed50 | 3975 | (line 47) |
5e13499c | 3976 | * complete (<TAB>): Commands For Completion. |
bc7bed50 | 3977 | (line 6) |
5e13499c | 3978 | * completion-query-items: Readline Init File Syntax. |
bc7bed50 | 3979 | (line 57) |
5e13499c | 3980 | * convert-meta: Readline Init File Syntax. |
bc7bed50 | 3981 | (line 67) |
5e13499c | 3982 | * copy-backward-word (): Commands For Killing. |
bc7bed50 | 3983 | (line 49) |
5e13499c | 3984 | * copy-forward-word (): Commands For Killing. |
bc7bed50 | 3985 | (line 54) |
5e13499c | 3986 | * copy-region-as-kill (): Commands For Killing. |
bc7bed50 CR |
3987 | (line 45) |
3988 | * delete-char (C-d): Commands For Text. (line 6) | |
5e13499c | 3989 | * delete-char-or-list (): Commands For Completion. |
bc7bed50 | 3990 | (line 30) |
5e13499c | 3991 | * delete-horizontal-space (): Commands For Killing. |
bc7bed50 CR |
3992 | (line 37) |
3993 | * digit-argument (M-0, M-1, ... M--): Numeric Arguments. (line 6) | |
5e13499c | 3994 | * disable-completion: Readline Init File Syntax. |
bc7bed50 | 3995 | (line 73) |
5e13499c | 3996 | * do-uppercase-version (M-a, M-b, M-X, ...): Miscellaneous Commands. |
bc7bed50 CR |
3997 | (line 14) |
3998 | * downcase-word (M-l): Commands For Text. (line 45) | |
5e13499c | 3999 | * dump-functions (): Miscellaneous Commands. |
bc7bed50 | 4000 | (line 61) |
5e13499c | 4001 | * dump-macros (): Miscellaneous Commands. |
bc7bed50 | 4002 | (line 73) |
5e13499c | 4003 | * dump-variables (): Miscellaneous Commands. |
bc7bed50 | 4004 | (line 67) |
5e13499c | 4005 | * editing-mode: Readline Init File Syntax. |
bc7bed50 | 4006 | (line 78) |
5e13499c | 4007 | * enable-keypad: Readline Init File Syntax. |
bc7bed50 CR |
4008 | (line 84) |
4009 | * end-kbd-macro (C-x )): Keyboard Macros. (line 9) | |
5e13499c | 4010 | * end-of-history (M->): Commands For History. |
bc7bed50 CR |
4011 | (line 22) |
4012 | * end-of-line (C-e): Commands For Moving. (line 9) | |
5e13499c | 4013 | * exchange-point-and-mark (C-x C-x): Miscellaneous Commands. |
bc7bed50 | 4014 | (line 36) |
5e13499c | 4015 | * expand-tilde: Readline Init File Syntax. |
bc7bed50 CR |
4016 | (line 89) |
4017 | * forward-backward-delete-char (): Commands For Text. (line 15) | |
4018 | * forward-char (C-f): Commands For Moving. (line 12) | |
5e13499c | 4019 | * forward-search-history (C-s): Commands For History. |
bc7bed50 CR |
4020 | (line 30) |
4021 | * forward-word (M-f): Commands For Moving. (line 18) | |
5e13499c | 4022 | * history-preserve-point: Readline Init File Syntax. |
bc7bed50 | 4023 | (line 93) |
5e13499c | 4024 | * history-search-backward (): Commands For History. |
bc7bed50 | 4025 | (line 50) |
5e13499c | 4026 | * history-search-forward (): Commands For History. |
bc7bed50 | 4027 | (line 45) |
5e13499c | 4028 | * horizontal-scroll-mode: Readline Init File Syntax. |
bc7bed50 | 4029 | (line 98) |
5e13499c | 4030 | * input-meta: Readline Init File Syntax. |
bc7bed50 | 4031 | (line 105) |
5e13499c | 4032 | * insert-comment (M-#): Miscellaneous Commands. |
bc7bed50 | 4033 | (line 51) |
5e13499c | 4034 | * insert-completions (M-*): Commands For Completion. |
bc7bed50 | 4035 | (line 14) |
5e13499c | 4036 | * isearch-terminators: Readline Init File Syntax. |
bc7bed50 | 4037 | (line 112) |
5e13499c | 4038 | * keymap: Readline Init File Syntax. |
bc7bed50 | 4039 | (line 119) |
5e13499c | 4040 | * kill-line (C-k): Commands For Killing. |
bc7bed50 | 4041 | (line 6) |
5e13499c | 4042 | * kill-region (): Commands For Killing. |
bc7bed50 | 4043 | (line 41) |
5e13499c | 4044 | * kill-whole-line (): Commands For Killing. |
bc7bed50 | 4045 | (line 15) |
5e13499c | 4046 | * kill-word (M-d): Commands For Killing. |
bc7bed50 | 4047 | (line 19) |
5e13499c | 4048 | * mark-modified-lines: Readline Init File Syntax. |
bc7bed50 | 4049 | (line 132) |
5e13499c | 4050 | * mark-symlinked-directories: Readline Init File Syntax. |
bc7bed50 | 4051 | (line 137) |
5e13499c | 4052 | * match-hidden-files: Readline Init File Syntax. |
bc7bed50 | 4053 | (line 142) |
5e13499c | 4054 | * menu-complete (): Commands For Completion. |
bc7bed50 | 4055 | (line 18) |
5e13499c | 4056 | * meta-flag: Readline Init File Syntax. |
bc7bed50 | 4057 | (line 105) |
5e13499c | 4058 | * next-history (C-n): Commands For History. |
bc7bed50 | 4059 | (line 16) |
5e13499c | 4060 | * non-incremental-forward-search-history (M-n): Commands For History. |
bc7bed50 | 4061 | (line 40) |
5e13499c | 4062 | * non-incremental-reverse-search-history (M-p): Commands For History. |
bc7bed50 | 4063 | (line 35) |
5e13499c | 4064 | * output-meta: Readline Init File Syntax. |
bc7bed50 CR |
4065 | (line 149) |
4066 | * overwrite-mode (): Commands For Text. (line 53) | |
5e13499c | 4067 | * page-completions: Readline Init File Syntax. |
bc7bed50 | 4068 | (line 154) |
5e13499c | 4069 | * possible-completions (M-?): Commands For Completion. |
bc7bed50 | 4070 | (line 11) |
5e13499c | 4071 | * prefix-meta (<ESC>): Miscellaneous Commands. |
bc7bed50 | 4072 | (line 18) |
5e13499c | 4073 | * previous-history (C-p): Commands For History. |
bc7bed50 CR |
4074 | (line 12) |
4075 | * quoted-insert (C-q or C-v): Commands For Text. (line 20) | |
5e13499c | 4076 | * re-read-init-file (C-x C-r): Miscellaneous Commands. |
bc7bed50 CR |
4077 | (line 6) |
4078 | * readline: Basic Behavior. (line 12) | |
4079 | * redraw-current-line (): Commands For Moving. (line 30) | |
5e13499c | 4080 | * reverse-search-history (C-r): Commands For History. |
bc7bed50 | 4081 | (line 26) |
5e13499c | 4082 | * revert-line (M-r): Miscellaneous Commands. |
bc7bed50 CR |
4083 | (line 25) |
4084 | * rl_add_defun: Function Naming. (line 20) | |
5e13499c | 4085 | * rl_add_funmap_entry: Associating Function Names and Bindings. |
bc7bed50 CR |
4086 | (line 47) |
4087 | * rl_add_undo: Allowing Undoing. (line 41) | |
4088 | * rl_alphabetic: Utility Functions. (line 24) | |
4089 | * rl_already_prompted: Readline Variables. (line 59) | |
5e13499c | 4090 | * rl_attempted_completion_function: Completion Variables. |
bc7bed50 | 4091 | (line 12) |
5e13499c | 4092 | * rl_attempted_completion_over: Completion Variables. |
8d618825 | 4093 | (line 210) |
5e13499c | 4094 | * rl_basic_quote_characters: Completion Variables. |
8d618825 | 4095 | (line 99) |
5e13499c | 4096 | * rl_basic_word_break_characters: Completion Variables. |
8d618825 | 4097 | (line 93) |
bc7bed50 CR |
4098 | * rl_begin_undo_group: Allowing Undoing. (line 29) |
4099 | * rl_bind_key: Binding Keys. (line 22) | |
4100 | * rl_bind_key_if_unbound: Binding Keys. (line 32) | |
4101 | * rl_bind_key_if_unbound_in_map: Binding Keys. (line 38) | |
4102 | * rl_bind_key_in_map: Binding Keys. (line 27) | |
4103 | * rl_bind_keyseq: Binding Keys. (line 59) | |
4104 | * rl_bind_keyseq_if_unbound: Binding Keys. (line 77) | |
4105 | * rl_bind_keyseq_if_unbound_in_map: Binding Keys. (line 83) | |
4106 | * rl_bind_keyseq_in_map: Binding Keys. (line 66) | |
28089d04 | 4107 | * rl_binding_keymap: Readline Variables. (line 154) |
bc7bed50 CR |
4108 | * rl_callback_handler_install: Alternate Interface. (line 15) |
4109 | * rl_callback_handler_remove: Alternate Interface. (line 33) | |
4110 | * rl_callback_read_char: Alternate Interface. (line 21) | |
5e13499c | 4111 | * rl_catch_signals: Readline Signal Handling. |
bc7bed50 | 4112 | (line 48) |
5e13499c | 4113 | * rl_catch_sigwinch: Readline Signal Handling. |
bc7bed50 | 4114 | (line 55) |
5e13499c | 4115 | * rl_char_is_quoted_p: Completion Variables. |
bc7bed50 | 4116 | (line 46) |
5e13499c | 4117 | * rl_cleanup_after_signal: Readline Signal Handling. |
bc7bed50 CR |
4118 | (line 66) |
4119 | * rl_clear_message: Redisplay. (line 48) | |
4120 | * rl_clear_pending_input: Character Input. (line 30) | |
5e13499c | 4121 | * rl_clear_signals: Readline Signal Handling. |
28089d04 CR |
4122 | (line 119) |
4123 | * rl_complete <1>: Completion Functions. | |
bc7bed50 | 4124 | (line 20) |
28089d04 CR |
4125 | * rl_complete: How Completing Works. |
4126 | (line 49) | |
5e13499c | 4127 | * rl_complete_internal: Completion Functions. |
bc7bed50 | 4128 | (line 10) |
5e13499c | 4129 | * rl_completer_quote_characters: Completion Variables. |
8d618825 | 4130 | (line 116) |
5e13499c | 4131 | * rl_completer_word_break_characters: Completion Variables. |
8d618825 | 4132 | (line 102) |
5e13499c | 4133 | * rl_completion_append_character: Completion Variables. |
8d618825 | 4134 | (line 140) |
5e13499c | 4135 | * rl_completion_display_matches_hook: Completion Variables. |
8d618825 | 4136 | (line 80) |
e6e3b444 | 4137 | * rl_completion_entry_function <1>: Completion Variables. |
bc7bed50 | 4138 | (line 7) |
e6e3b444 | 4139 | * rl_completion_entry_function: How Completing Works. |
bc7bed50 | 4140 | (line 55) |
e6e3b444 | 4141 | * rl_completion_found_quote: Completion Variables. |
8d618825 | 4142 | (line 168) |
5e13499c | 4143 | * rl_completion_mark_symlink_dirs: Completion Variables. |
8d618825 | 4144 | (line 175) |
5e13499c | 4145 | * rl_completion_matches: Completion Functions. |
bc7bed50 | 4146 | (line 45) |
5e13499c | 4147 | * rl_completion_mode: Completion Functions. |
bc7bed50 | 4148 | (line 37) |
5e13499c | 4149 | * rl_completion_query_items: Completion Variables. |
8d618825 | 4150 | (line 134) |
e6e3b444 | 4151 | * rl_completion_quote_character: Completion Variables. |
8d618825 | 4152 | (line 156) |
5e13499c | 4153 | * rl_completion_suppress_append: Completion Variables. |
8d618825 | 4154 | (line 150) |
e6e3b444 | 4155 | * rl_completion_suppress_quote: Completion Variables. |
8d618825 | 4156 | (line 162) |
5e13499c | 4157 | * rl_completion_type: Completion Variables. |
8d618825 | 4158 | (line 217) |
e6e3b444 | 4159 | * rl_completion_word_break_hook: Completion Variables. |
8d618825 | 4160 | (line 107) |
bc7bed50 CR |
4161 | * rl_copy_keymap: Keymaps. (line 17) |
4162 | * rl_copy_text: Modifying Text. (line 15) | |
4163 | * rl_crlf: Redisplay. (line 30) | |
4164 | * rl_delete_text: Modifying Text. (line 11) | |
28089d04 | 4165 | * rl_deprep_term_function: Readline Variables. (line 144) |
bc7bed50 CR |
4166 | * rl_deprep_terminal: Terminal Management. (line 13) |
4167 | * rl_ding: Utility Functions. (line 21) | |
5e13499c | 4168 | * rl_directory_completion_hook: Completion Variables. |
bc7bed50 CR |
4169 | (line 64) |
4170 | * rl_discard_keymap: Keymaps. (line 26) | |
4171 | * rl_dispatching: Readline Variables. (line 41) | |
4172 | * rl_display_match_list: Utility Functions. (line 28) | |
4173 | * rl_do_undo: Allowing Undoing. (line 48) | |
4174 | * rl_done: Readline Variables. (line 28) | |
28089d04 | 4175 | * rl_editing_mode: Readline Variables. (line 242) |
bc7bed50 CR |
4176 | * rl_end: Readline Variables. (line 19) |
4177 | * rl_end_undo_group: Allowing Undoing. (line 35) | |
4178 | * rl_erase_empty_line: Readline Variables. (line 47) | |
28089d04 | 4179 | * rl_event_hook: Readline Variables. (line 119) |
bc7bed50 | 4180 | * rl_execute_next: Character Input. (line 26) |
28089d04 CR |
4181 | * rl_executing_keymap: Readline Variables. (line 150) |
4182 | * rl_executing_macro: Readline Variables. (line 158) | |
bc7bed50 | 4183 | * rl_expand_prompt: Redisplay. (line 64) |
28089d04 | 4184 | * rl_explicit_arg: Readline Variables. (line 233) |
bc7bed50 | 4185 | * rl_extend_line_buffer: Utility Functions. (line 12) |
5e13499c | 4186 | * rl_filename_completion_desired: Completion Variables. |
8d618825 | 4187 | (line 190) |
5e13499c | 4188 | * rl_filename_completion_function: Completion Functions. |
bc7bed50 | 4189 | (line 59) |
5e13499c | 4190 | * rl_filename_dequoting_function: Completion Variables. |
bc7bed50 | 4191 | (line 37) |
5e13499c | 4192 | * rl_filename_quote_characters: Completion Variables. |
8d618825 | 4193 | (line 122) |
5e13499c | 4194 | * rl_filename_quoting_desired: Completion Variables. |
8d618825 | 4195 | (line 200) |
5e13499c | 4196 | * rl_filename_quoting_function: Completion Variables. |
bc7bed50 CR |
4197 | (line 24) |
4198 | * rl_forced_update_display: Redisplay. (line 11) | |
5e13499c | 4199 | * rl_free_line_state: Readline Signal Handling. |
bc7bed50 CR |
4200 | (line 72) |
4201 | * rl_free_undo_list: Allowing Undoing. (line 45) | |
5e13499c | 4202 | * rl_function_dumper: Associating Function Names and Bindings. |
bc7bed50 | 4203 | (line 30) |
5e13499c | 4204 | * rl_function_of_keyseq: Associating Function Names and Bindings. |
bc7bed50 | 4205 | (line 15) |
5e13499c | 4206 | * rl_funmap_names: Associating Function Names and Bindings. |
bc7bed50 CR |
4207 | (line 40) |
4208 | * rl_generic_bind: Binding Keys. (line 89) | |
4209 | * rl_get_keymap: Keymaps. (line 32) | |
4210 | * rl_get_keymap_by_name: Keymaps. (line 38) | |
4211 | * rl_get_keymap_name: Keymaps. (line 43) | |
5e13499c | 4212 | * rl_get_screen_size: Readline Signal Handling. |
28089d04 | 4213 | (line 102) |
5e13499c | 4214 | * rl_get_termcap: Miscellaneous Functions. |
bc7bed50 CR |
4215 | (line 42) |
4216 | * rl_getc: Character Input. (line 15) | |
28089d04 | 4217 | * rl_getc_function: Readline Variables. (line 125) |
bc7bed50 | 4218 | * rl_gnu_readline_p: Readline Variables. (line 78) |
5e13499c | 4219 | * rl_ignore_completion_duplicates: Completion Variables. |
8d618825 | 4220 | (line 186) |
5e13499c | 4221 | * rl_ignore_some_completions_function: Completion Variables. |
bc7bed50 | 4222 | (line 56) |
5e13499c | 4223 | * rl_inhibit_completion: Completion Variables. |
8d618825 | 4224 | (line 225) |
bc7bed50 | 4225 | * rl_initialize: Utility Functions. (line 16) |
5e13499c | 4226 | * rl_insert_completions: Completion Functions. |
bc7bed50 CR |
4227 | (line 32) |
4228 | * rl_insert_text: Modifying Text. (line 7) | |
4229 | * rl_instream: Readline Variables. (line 92) | |
5e13499c | 4230 | * rl_invoking_keyseqs: Associating Function Names and Bindings. |
bc7bed50 | 4231 | (line 21) |
5e13499c | 4232 | * rl_invoking_keyseqs_in_map: Associating Function Names and Bindings. |
bc7bed50 CR |
4233 | (line 26) |
4234 | * rl_kill_text: Modifying Text. (line 19) | |
28089d04 | 4235 | * rl_last_func: Readline Variables. (line 105) |
bc7bed50 CR |
4236 | * rl_library_version: Readline Variables. (line 68) |
4237 | * rl_line_buffer: Readline Variables. (line 9) | |
5e13499c | 4238 | * rl_list_funmap_names: Associating Function Names and Bindings. |
bc7bed50 | 4239 | (line 36) |
5e13499c | 4240 | * rl_macro_bind: Miscellaneous Functions. |
bc7bed50 | 4241 | (line 8) |
5e13499c | 4242 | * rl_macro_dumper: Miscellaneous Functions. |
bc7bed50 CR |
4243 | (line 14) |
4244 | * rl_make_bare_keymap: Keymaps. (line 12) | |
4245 | * rl_make_keymap: Keymaps. (line 20) | |
4246 | * rl_mark: Readline Variables. (line 24) | |
4247 | * rl_message: Redisplay. (line 39) | |
4248 | * rl_modifying: Allowing Undoing. (line 57) | |
5e13499c | 4249 | * rl_named_function: Associating Function Names and Bindings. |
bc7bed50 CR |
4250 | (line 11) |
4251 | * rl_num_chars_to_read: Readline Variables. (line 32) | |
28089d04 | 4252 | * rl_numeric_arg: Readline Variables. (line 237) |
bc7bed50 CR |
4253 | * rl_on_new_line: Redisplay. (line 15) |
4254 | * rl_on_new_line_with_prompt: Redisplay. (line 19) | |
4255 | * rl_outstream: Readline Variables. (line 96) | |
4256 | * rl_parse_and_bind: Binding Keys. (line 96) | |
4257 | * rl_pending_input: Readline Variables. (line 37) | |
4258 | * rl_point: Readline Variables. (line 15) | |
5e13499c | 4259 | * rl_possible_completions: Completion Functions. |
bc7bed50 | 4260 | (line 28) |
28089d04 CR |
4261 | * rl_pre_input_hook: Readline Variables. (line 114) |
4262 | * rl_prefer_env_winsize: Readline Variables. (line 100) | |
4263 | * rl_prep_term_function: Readline Variables. (line 137) | |
bc7bed50 CR |
4264 | * rl_prep_terminal: Terminal Management. (line 7) |
4265 | * rl_prompt: Readline Variables. (line 53) | |
4266 | * rl_push_macro_input: Modifying Text. (line 26) | |
4267 | * rl_read_init_file: Binding Keys. (line 101) | |
4268 | * rl_read_key: Character Input. (line 7) | |
4269 | * rl_readline_name: Readline Variables. (line 87) | |
28089d04 | 4270 | * rl_readline_state: Readline Variables. (line 161) |
bc7bed50 CR |
4271 | * rl_readline_version: Readline Variables. (line 71) |
4272 | * rl_redisplay: Redisplay. (line 7) | |
28089d04 | 4273 | * rl_redisplay_function: Readline Variables. (line 131) |
bc7bed50 | 4274 | * rl_replace_line: Utility Functions. (line 7) |
5e13499c | 4275 | * rl_reset_after_signal: Readline Signal Handling. |
bc7bed50 CR |
4276 | (line 80) |
4277 | * rl_reset_line_state: Redisplay. (line 26) | |
28089d04 CR |
4278 | * rl_reset_screen_size: Readline Signal Handling. |
4279 | (line 106) | |
bc7bed50 | 4280 | * rl_reset_terminal: Terminal Management. (line 28) |
5e13499c | 4281 | * rl_resize_terminal: Readline Signal Handling. |
bc7bed50 CR |
4282 | (line 89) |
4283 | * rl_restore_prompt: Redisplay. (line 57) | |
4284 | * rl_save_prompt: Redisplay. (line 53) | |
4285 | * rl_set_key: Binding Keys. (line 73) | |
4286 | * rl_set_keyboard_input_timeout: Character Input. (line 35) | |
4287 | * rl_set_keymap: Keymaps. (line 35) | |
5e13499c | 4288 | * rl_set_paren_blink_timeout: Miscellaneous Functions. |
bc7bed50 CR |
4289 | (line 37) |
4290 | * rl_set_prompt: Redisplay. (line 78) | |
5e13499c | 4291 | * rl_set_screen_size: Readline Signal Handling. |
bc7bed50 | 4292 | (line 93) |
5e13499c | 4293 | * rl_set_signals: Readline Signal Handling. |
28089d04 | 4294 | (line 113) |
bc7bed50 | 4295 | * rl_show_char: Redisplay. (line 33) |
5e13499c | 4296 | * rl_special_prefixes: Completion Variables. |
8d618825 | 4297 | (line 127) |
28089d04 | 4298 | * rl_startup_hook: Readline Variables. (line 110) |
bc7bed50 CR |
4299 | * rl_stuff_char: Character Input. (line 19) |
4300 | * rl_terminal_name: Readline Variables. (line 82) | |
4301 | * rl_tty_set_default_bindings: Terminal Management. (line 18) | |
4302 | * rl_tty_unset_default_bindings: Terminal Management. (line 23) | |
4303 | * rl_unbind_command_in_map: Binding Keys. (line 55) | |
4304 | * rl_unbind_function_in_map: Binding Keys. (line 51) | |
4305 | * rl_unbind_key: Binding Keys. (line 42) | |
4306 | * rl_unbind_key_in_map: Binding Keys. (line 46) | |
5e13499c | 4307 | * rl_username_completion_function: Completion Functions. |
bc7bed50 | 4308 | (line 66) |
5e13499c | 4309 | * rl_variable_bind: Miscellaneous Functions. |
bc7bed50 | 4310 | (line 21) |
5e13499c | 4311 | * rl_variable_dumper: Miscellaneous Functions. |
bc7bed50 CR |
4312 | (line 31) |
4313 | * rl_variable_value: Miscellaneous Functions. | |
4314 | (line 26) | |
4315 | * self-insert (a, b, A, 1, !, ...): Commands For Text. (line 27) | |
5e13499c | 4316 | * set-mark (C-@): Miscellaneous Commands. |
bc7bed50 | 4317 | (line 32) |
5e13499c | 4318 | * show-all-if-ambiguous: Readline Init File Syntax. |
bc7bed50 | 4319 | (line 164) |
5e13499c | 4320 | * show-all-if-unmodified: Readline Init File Syntax. |
bc7bed50 CR |
4321 | (line 170) |
4322 | * start-kbd-macro (C-x (): Keyboard Macros. (line 6) | |
4323 | * transpose-chars (C-t): Commands For Text. (line 30) | |
4324 | * transpose-words (M-t): Commands For Text. (line 36) | |
5e13499c | 4325 | * undo (C-_ or C-x C-u): Miscellaneous Commands. |
bc7bed50 CR |
4326 | (line 22) |
4327 | * universal-argument (): Numeric Arguments. (line 10) | |
e6e3b444 | 4328 | * unix-filename-rubout (): Commands For Killing. |
bc7bed50 | 4329 | (line 32) |
5e13499c | 4330 | * unix-line-discard (C-u): Commands For Killing. |
bc7bed50 | 4331 | (line 12) |
5e13499c | 4332 | * unix-word-rubout (C-w): Commands For Killing. |
bc7bed50 CR |
4333 | (line 28) |
4334 | * upcase-word (M-u): Commands For Text. (line 41) | |
5e13499c | 4335 | * visible-stats: Readline Init File Syntax. |
bc7bed50 | 4336 | (line 179) |
5e13499c | 4337 | * yank (C-y): Commands For Killing. |
bc7bed50 | 4338 | (line 59) |
5e13499c | 4339 | * yank-last-arg (M-. or M-_): Commands For History. |
bc7bed50 | 4340 | (line 64) |
5e13499c | 4341 | * yank-nth-arg (M-C-y): Commands For History. |
bc7bed50 | 4342 | (line 55) |
5e13499c | 4343 | * yank-pop (M-y): Commands For Killing. |
bc7bed50 | 4344 | (line 62) |
5e13499c CR |
4345 | |
4346 | ||
4347 | \1f | |
4348 | Tag Table: | |
8d618825 CR |
4349 | Node: Top\7f1296 |
4350 | Node: Command Line Editing\7f1934 | |
4351 | Node: Introduction and Notation\7f2586 | |
4352 | Node: Readline Interaction\7f4209 | |
4353 | Node: Readline Bare Essentials\7f5401 | |
4354 | Node: Readline Movement Commands\7f7191 | |
4355 | Node: Readline Killing Commands\7f8157 | |
4356 | Node: Readline Arguments\7f10078 | |
4357 | Node: Searching\7f11123 | |
4358 | Node: Readline Init File\7f13275 | |
4359 | Node: Readline Init File Syntax\7f14429 | |
4360 | Node: Conditional Init Constructs\7f26364 | |
4361 | Node: Sample Init File\7f28898 | |
4362 | Node: Bindable Readline Commands\7f32016 | |
4363 | Node: Commands For Moving\7f33074 | |
4364 | Node: Commands For History\7f33936 | |
4365 | Node: Commands For Text\7f37061 | |
4366 | Node: Commands For Killing\7f39788 | |
4367 | Node: Numeric Arguments\7f41931 | |
4368 | Node: Commands For Completion\7f43071 | |
4369 | Node: Keyboard Macros\7f44616 | |
4370 | Node: Miscellaneous Commands\7f45188 | |
4371 | Node: Readline vi Mode\7f48550 | |
4372 | Node: Programming with GNU Readline\7f50374 | |
4373 | Node: Basic Behavior\7f51349 | |
4374 | Node: Custom Functions\7f54766 | |
4375 | Node: Readline Typedefs\7f56250 | |
4376 | Node: Function Writing\7f57889 | |
4377 | Node: Readline Variables\7f59196 | |
4378 | Node: Readline Convenience Functions\7f68898 | |
4379 | Node: Function Naming\7f69888 | |
4380 | Node: Keymaps\7f71150 | |
4381 | Node: Binding Keys\7f72922 | |
4382 | Node: Associating Function Names and Bindings\7f77469 | |
4383 | Node: Allowing Undoing\7f79731 | |
4384 | Node: Redisplay\7f82281 | |
4385 | Node: Modifying Text\7f86181 | |
4386 | Node: Character Input\7f87427 | |
4387 | Node: Terminal Management\7f89325 | |
4388 | Node: Utility Functions\7f90761 | |
4389 | Node: Miscellaneous Functions\7f93126 | |
4390 | Node: Alternate Interface\7f95423 | |
4391 | Node: A Readline Example\7f97582 | |
4392 | Node: Readline Signal Handling\7f99485 | |
4393 | Node: Custom Completers\7f105353 | |
4394 | Node: How Completing Works\7f106073 | |
4395 | Node: Completion Functions\7f109387 | |
4396 | Node: Completion Variables\7f112959 | |
4397 | Node: A Short Completion Example\7f125353 | |
4398 | Node: Copying This Manual\7f137526 | |
4399 | Node: GNU Free Documentation License\7f137788 | |
4400 | Node: Concept Index\7f160195 | |
4401 | Node: Function and Variable Index\7f161851 | |
5e13499c CR |
4402 | \1f |
4403 | End Tag Table |