diff options
Diffstat (limited to 'readline/doc/readline.info')
| -rw-r--r-- | readline/doc/readline.info | 1695 |
1 files changed, 1113 insertions, 582 deletions
diff --git a/readline/doc/readline.info b/readline/doc/readline.info index ae6767f..57dbdfa 100644 --- a/readline/doc/readline.info +++ b/readline/doc/readline.info @@ -1,5 +1,5 @@ -This is Info file readline.info, produced by Makeinfo version 1.68 from -the input file /usr/homes/chet/src/bash/readline-src/doc/rlman.texinfo. +This is readline.info, produced by makeinfo version 4.1 from +/usr/homes/chet/src/bash/readline-src/doc/rlman.texinfo. INFO-DIR-SECTION Libraries START-INFO-DIR-ENTRY @@ -10,7 +10,7 @@ END-INFO-DIR-ENTRY aids in the consistency of user interface across discrete programs that need to provide a command line interface. - Copyright (C) 1988-1999 Free Software Foundation, Inc. + Copyright (C) 1988-2002 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice pare @@ -72,10 +72,10 @@ Introduction to Line Editing The following paragraphs describe the notation used to represent keystrokes. - The text <C-k> is read as `Control-K' and describes the character + The text `C-k' is read as `Control-K' and describes the character produced when the <k> key is pressed while the Control key is depressed. - The text <M-k> is read as `Meta-K' and describes the character + The text `M-k' is read as `Meta-K' and describes the character produced when the Meta key (if you have one) is depressed, and the <k> key is pressed. The Meta key is labeled <ALT> on many keyboards. On keyboards with two keys labeled <ALT> (usually to either side of the @@ -86,18 +86,18 @@ Compose key for typing accented characters. If you do not have a Meta or <ALT> key, or another key working as a Meta key, the identical keystroke can be generated by typing <ESC> -first, and then typing <k>. Either process is known as "metafying" the -<k> key. +_first_, and then typing <k>. Either process is known as "metafying" +the <k> key. - The text <M-C-k> is read as `Meta-Control-k' and describes the -character produced by "metafying" <C-k>. + The text `M-C-k' is read as `Meta-Control-k' and describes the +character produced by "metafying" `C-k'. In addition, several keys have their own names. Specifically, <DEL>, <ESC>, <LFD>, <SPC>, <RET>, and <TAB> all stand for themselves -when seen in this text, or in an init file (*note Readline Init -File::.). If your keyboard lacks a <LFD> key, typing <C-j> will -produce the desired character. The <RET> key may be labeled <Return> -or <Enter> on some keyboards. +when seen in this text, or in an init file (*note Readline Init File::). +If your keyboard lacks a <LFD> key, typing <C-j> will produce the +desired character. The <RET> key may be labeled <Return> or <Enter> on +some keyboards. File: readline.info, Node: Readline Interaction, Next: Readline Init File, Prev: Introduction and Notation, Up: Command Line Editing @@ -112,9 +112,9 @@ as you type it in, allowing you to just fix your typo, and not forcing you to retype the majority of the line. Using these editing commands, you move the cursor to the place that needs correction, and delete or insert the text of the corrections. Then, when you are satisfied with -the line, you simply press <RETURN>. You do not have to be at the end -of the line to press <RETURN>; the entire line is accepted regardless -of the location of the cursor within the line. +the line, you simply press <RET>. You do not have to be at the end of +the line to press <RET>; the entire line is accepted regardless of the +location of the cursor within the line. * Menu: @@ -137,8 +137,8 @@ erase character to back up and delete the mistyped character. Sometimes you may mistype a character, and not notice the error until you have typed several other characters. In that case, you can -type <C-b> to move the cursor to the left, and then correct your -mistake. Afterwards, you can move the cursor to the right with <C-f>. +type `C-b' to move the cursor to the left, and then correct your +mistake. Afterwards, you can move the cursor to the right with `C-f'. When you add text in the middle of a line, you will notice that characters to the right of the cursor are `pushed over' to make room @@ -148,28 +148,28 @@ back' to fill in the blank space created by the removal of the text. A list of the bare essentials for editing the text of an input line follows. -<C-b> +`C-b' Move back one character. -<C-f> +`C-f' Move forward one character. <DEL> or <Backspace> Delete the character to the left of the cursor. -<C-d> +`C-d' Delete the character underneath the cursor. Printing characters Insert the character into the line at the cursor. -<C-_> or <C-x C-u> +`C-_' or `C-x C-u' Undo the last editing command. You can undo all the way back to an empty line. (Depending on your configuration, the <Backspace> key be set to delete the character to the left of the cursor and the <DEL> key set to delete -the character underneath the cursor, like <C-d>, rather than the +the character underneath the cursor, like `C-d', rather than the character to the left of the cursor.) @@ -180,26 +180,26 @@ Readline Movement Commands The above table describes the most basic keystrokes that you need in order to do editing of the input line. For your convenience, many -other commands have been added in addition to <C-b>, <C-f>, <C-d>, and +other commands have been added in addition to `C-b', `C-f', `C-d', and <DEL>. Here are some commands for moving more rapidly about the line. -<C-a> +`C-a' Move to the start of the line. -<C-e> +`C-e' Move to the end of the line. -<M-f> +`M-f' Move forward a word, where a word is composed of letters and digits. -<M-b> +`M-b' Move backward a word. -<C-l> +`C-l' Clear the screen, reprinting the current line at the top. - Notice how <C-f> moves forward a character, while <M-f> moves + Notice how `C-f' moves forward a character, while `M-f' moves forward a word. It is a loose convention that control keystrokes operate on characters while meta keystrokes operate on words. @@ -226,34 +226,34 @@ available to be yanked back later, when you are typing another line. Here is the list of commands for killing text. -<C-k> +`C-k' Kill the text from the current cursor position to the end of the line. -<M-d> +`M-d' Kill from the cursor to the end of the current word, or, if between words, to the end of the next word. Word boundaries are the same - as those used by <M-f>. + as those used by `M-f'. -<M-DEL> - Kill from the cursor the start of the previous word, or, if between +`M-<DEL>' + Kill from the cursor the start of the current word, or, if between words, to the start of the previous word. Word boundaries are the - same as those used by <M-b>. + same as those used by `M-b'. -<C-w> +`C-w' Kill from the cursor to the previous whitespace. This is - different than <M-DEL> because the word boundaries differ. + different than `M-<DEL>' because the word boundaries differ. Here is how to "yank" the text back into the line. Yanking means to copy the most-recently-killed text from the kill buffer. -<C-y> +`C-y' Yank the most recently killed text back into the buffer at the cursor. -<M-y> +`M-y' Rotate the kill-ring, and yank the new top. You can only do this - if the prior command is <C-y> or <M-y>. + if the prior command is `C-y' or `M-y'. File: readline.info, Node: Readline Arguments, Next: Searching, Prev: Readline Killing Commands, Up: Readline Interaction @@ -273,7 +273,8 @@ meta digits before the command. If the first `digit' typed is a minus sign (`-'), then the sign of the argument will be negative. Once you have typed one meta digit to get the argument started, you can type the remainder of the digits, and then the command. For example, to give -the <C-d> command an argument of 10, you could type `M-1 0 C-d'. +the `C-d' command an argument of 10, you could type `M-1 0 C-d', which +will delete the next ten characters on the input line. File: readline.info, Node: Searching, Prev: Readline Arguments, Up: Readline Interaction @@ -283,29 +284,34 @@ Searching for Commands in the History Readline provides commands for searching through the command history for lines containing a specified string. There are two search modes: -INCREMENTAL and NON-INCREMENTAL. +"incremental" and "non-incremental". Incremental searches begin before the user has finished typing the search string. As each character of the search string is typed, Readline displays the next entry from the history matching the string typed so far. An incremental search requires only as many characters as needed to find the desired history entry. To search backward in the -history for a particular string, type <C-r>. Typing <C-s> searches +history for a particular string, type `C-r'. Typing `C-s' searches forward through the history. The characters present in the value of the `isearch-terminators' variable are used to terminate an incremental search. If that variable has not been assigned a value, the <ESC> and -<C-J> characters will terminate an incremental search. <C-g> will +`C-J' characters will terminate an incremental search. `C-g' will abort an incremental search and restore the original line. When the search is terminated, the history entry containing the search string becomes the current line. - To find other matching entries in the history list, type <C-r> or -<C-s> as appropriate. This will search backward or forward in the + To find other matching entries in the history list, type `C-r' or +`C-s' as appropriate. This will search backward or forward in the history for the next entry matching the search string typed so far. Any other key sequence bound to a Readline command will terminate the search and execute that command. For instance, a <RET> will terminate the search and accept the line, thereby executing the command from the -history list. +history list. A movement command will terminate the search, make the +last line found the current line, and begin editing. + + Readline remembers the last incremental search string. If two +`C-r's are typed without any intervening characters defining a new +search string, any remembered search string is used. Non-incremental searches read the entire search string before starting to search for matching history lines. The search string may be @@ -348,17 +354,24 @@ Readline Init File Syntax There are only a few basic constructs allowed in the Readline init file. Blank lines are ignored. Lines beginning with a `#' are comments. Lines beginning with a `$' indicate conditional constructs -(*note Conditional Init Constructs::.). Other lines denote variable +(*note Conditional Init Constructs::). Other lines denote variable settings and key bindings. Variable Settings You can modify the run-time behavior of Readline by altering the values of variables in Readline using the `set' command within the - init file. Here is how to change from the default Emacs-like key - binding to use `vi' line editing commands: + init file. The syntax is simple: + + set VARIABLE VALUE + + Here, for example, is how to change from the default Emacs-like + key binding to use `vi' line editing commands: set editing-mode vi + Variable names and values, where appropriate, are recognized + without regard to case. + A great deal of run-time behavior is changeable with the following variables. @@ -385,7 +398,8 @@ Variable Settings possibilities. If the number of possible completions is greater than this value, Readline will ask the user whether or not he wishes to view them; otherwise, they are simply - listed. The default limit is `100'. + listed. This variable must be set to an integer value + greater than or equal to 0. The default limit is `100'. `convert-meta' If set to `on', Readline will convert characters with the @@ -413,6 +427,10 @@ Variable Settings If set to `on', tilde expansion is performed when Readline attempts word completion. The default is `off'. + If set to `on', the history code attempts to place point at + the same location on each history line retrived with + `previous-history' or `next-history'. + `horizontal-scroll-mode' This variable can be set to either `on' or `off'. Setting it to `on' means that the text of the lines being edited will @@ -422,7 +440,7 @@ Variable Settings `input-meta' If set to `on', Readline will enable eight-bit input (it will - not strip the eighth bit from the characters it reads), + not clear the eighth bit in the characters it reads), regardless of what the terminal claims it can support. The default value is `off'. The name `meta-flag' is a synonym for this variable. @@ -430,14 +448,14 @@ Variable Settings `isearch-terminators' The string of characters that should terminate an incremental search without subsequently executing the character as a - command (*note Searching::.). If this variable has not been - given a value, the characters <ESC> and <C-J> will terminate + command (*note Searching::). If this variable has not been + given a value, the characters <ESC> and `C-J' will terminate an incremental search. `keymap' Sets Readline's idea of the current keymap for key binding commands. Acceptable `keymap' names are `emacs', - `emacs-standard', `emacs-meta', `emacs-ctlx', `vi', + `emacs-standard', `emacs-meta', `emacs-ctlx', `vi', `vi-move', `vi-command', and `vi-insert'. `vi' is equivalent to `vi-command'; `emacs' is equivalent to `emacs-standard'. The default value is `emacs'. The value of the `editing-mode' @@ -452,11 +470,28 @@ Variable Settings asterisk (`*') at the start of history lines which have been modified. This variable is `off' by default. + `mark-symlinked-directories' + If set to `on', completed names which are symbolic links to + directories have a slash appended (subject to the value of + `mark-directories'). The default is `off'. + + `match-hidden-files' + This variable, when set to `on', causes Readline to match + files whose names begin with a `.' (hidden files) when + performing filename completion, unless the leading `.' is + supplied by the user in the filename to be completed. This + variable is `on' by default. + `output-meta' If set to `on', Readline will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. The default is `off'. + `page-completions' + If set to `on', Readline uses an internal `more'-like pager + to display a screenful of possible completions at a time. + This variable is `on' by default. + `print-completions-horizontally' If set to `on', Readline will display completions with matches sorted horizontally in alphabetical order, rather than down @@ -480,11 +515,14 @@ Key Bindings command name, the default keybinding, if any, and a short description of what the command does. - Once you know the name of the command, simply place the name of - the key you wish to bind the command to, a colon, and then the - name of the command on a line in the init file. The name of the - key can be expressed in different ways, depending on which is most - comfortable for you. + Once you know the name of the command, simply place on a line in + the init file the name of the key you wish to bind the command to, + a colon, and then the name of the command. The name of the key + can be expressed in different ways, depending on what you find most + comfortable. + + In addition to command names, readline allows keys to be bound to + a string that is inserted when the key is pressed (a MACRO). KEYNAME: FUNCTION-NAME or MACRO KEYNAME is the name of a key spelled out in English. For @@ -493,11 +531,16 @@ Key Bindings Meta-Rubout: backward-kill-word Control-o: "> output" - In the above example, <C-u> is bound to the function - `universal-argument', and <C-o> is bound to run the macro + In the above example, `C-u' is bound to the function + `universal-argument', `M-DEL' is bound to the function + `backward-kill-word', and `C-o' is bound to run the macro expressed on the right hand side (that is, to insert the text `> output' into the line). + A number of symbolic character names are recognized while + processing this key binding syntax: DEL, ESC, ESCAPE, LFD, + NEWLINE, RET, RETURN, RUBOUT, SPACE, SPC, and TAB. + "KEYSEQ": FUNCTION-NAME or MACRO KEYSEQ differs from KEYNAME above in that strings denoting an entire key sequence can be specified, by placing the key @@ -509,11 +552,11 @@ Key Bindings "\C-x\C-r": re-read-init-file "\e[11~": "Function Key 1" - In the above example, <C-u> is bound to the function + In the above example, `C-u' is again bound to the function `universal-argument' (just as it was in the first example), - `<C-x> <C-r>' is bound to the function `re-read-init-file', - and `<ESC> <[> <1> <1> <~>' is bound to insert the text - `Function Key 1'. + `C-x C-r' is bound to the function `re-read-init-file', and + `<ESC> <[> <1> <1> <~>' is bound to insert the text `Function + Key 1'. The following GNU Emacs style escape sequences are available when specifying key sequences: @@ -564,13 +607,13 @@ Key Bindings vertical tab `\NNN' - the character whose `ASCII' code is the octal value NNN (one - to three digits) - - `\xNNN' - the character whose `ASCII' code is the hexadecimal value NNN + the eight-bit character whose value is the octal value NNN (one to three digits) + `\xHH' + the eight-bit character whose value is the hexadecimal value + HH (one or two hex digits) + When entering the text of a macro, single or double quotes must be used to indicate a macro definition. Unquoted text is assumed to be a function name. In the macro body, the backslash escapes @@ -617,10 +660,10 @@ are four parser directives used. The APPLICATION construct is used to include application-specific settings. Each program using the Readline library sets the APPLICATION NAME, and you can test - for it. This could be used to bind key sequences to - functions useful for a specific program. For instance, the - following command adds a key sequence that quotes the current - or previous word in Bash: + for a particular value. This could be used to bind key + sequences to functions useful for a specific program. For + instance, the following command adds a key sequence that + quotes the current or previous word in Bash: $if Bash # Quote the current or previous word "\C-xq": "\eb\"\ef\"" @@ -636,7 +679,8 @@ are four parser directives used. `$include' This directive takes a single filename as an argument and reads - commands and bindings from that file. + commands and bindings from that file. For example, the following + directive reads from `/etc/inputrc': $include /etc/inputrc @@ -645,19 +689,19 @@ File: readline.info, Node: Sample Init File, Prev: Conditional Init Constructs Sample Init File ---------------- - Here is an example of an inputrc file. This illustrates key + Here is an example of an INPUTRC file. This illustrates key binding, variable assignment, and conditional syntax. # This file controls the behaviour of line input editing for - # programs that use the Gnu Readline library. Existing programs - # include FTP, Bash, and Gdb. + # programs that use the GNU Readline library. Existing + # programs include FTP, Bash, and GDB. # # You can re-read the inputrc file with C-x C-r. # Lines beginning with '#' are comments. # - # First, include any systemwide bindings and variable assignments from - # /etc/Inputrc + # First, include any systemwide bindings and variable + # assignments from /etc/Inputrc $include /etc/Inputrc # @@ -709,10 +753,12 @@ binding, variable assignment, and conditional syntax. $if Bash # edit the path "\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f" - # prepare to type a quoted word -- insert open and close double quotes + # prepare to type a quoted word -- + # insert open and close double quotes # and move to just after the open quote "\C-x\"": "\"\"\C-b" - # insert a backslash (testing backslash escapes in sequences and macros) + # insert a backslash (testing backslash escapes + # in sequences and macros) "\C-x\\": "\\" # Quote the current or previous word "\C-xq": "\eb\"\ef\"" @@ -728,16 +774,16 @@ binding, variable assignment, and conditional syntax. # don't strip characters to 7 bits when reading set input-meta on - # allow iso-latin1 characters to be inserted rather than converted to - # prefix-meta sequences + # allow iso-latin1 characters to be inserted rather + # than converted to prefix-meta sequences set convert-meta off - # display characters with the eighth bit set directly rather than - # as meta-prefixed characters + # display characters with the eighth bit set directly + # rather than as meta-prefixed characters set output-meta on - # if there are more than 150 possible completions for a word, ask the - # user if he wants to see all of them + # if there are more than 150 possible completions for + # a word, ask the user if he wants to see all of them set completion-query-items 150 # For FTP @@ -765,13 +811,13 @@ Bindable Readline Commands * Miscellaneous Commands:: Other miscellaneous commands. This section describes Readline commands that may be bound to key -sequences. +sequences. Command names without an accompanying key sequence are +unbound by default. - Command names without an accompanying key sequence are unbound by -default. In the following descriptions, POINT refers to the current -cursor position, and MARK refers to a cursor position saved by the + In the following descriptions, "point" refers to the current cursor +position, and "mark" refers to a cursor position saved by the `set-mark' command. The text between the point and mark is referred to -as the REGION. +as the "region". File: readline.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands @@ -812,16 +858,18 @@ File: readline.info, Node: Commands For History, Next: Commands For Text, Pre Commands For Manipulating The History ------------------------------------- -`accept-line (Newline, Return)' +`accept-line (Newline or Return)' Accept the line regardless of where the cursor is. If this line is - non-empty, add it to the history list. If this line was a history - line, then restore the history line to its original state. + non-empty, it may be added to the history list for future recall + with `add_history()'. If this line is a modified history line, + the history line is restored to its original state. `previous-history (C-p)' - Move `up' through the history list. + Move `back' through the history list, fetching the previous + command. `next-history (C-n)' - Move `down' through the history list. + Move `forward' through the history list, fetching the next command. `beginning-of-history (M-<)' Move to the first line in the history. @@ -861,12 +909,12 @@ Commands For Manipulating The History `yank-nth-arg (M-C-y)' Insert the first argument to the previous command (usually the - second word on the previous line). With an argument N, insert the - Nth word from the previous command (the words in the previous - command begin with word 0). A negative argument inserts the Nth - word from the end of the previous command. + second word on the previous line) at point. With an argument N, + insert the Nth word from the previous command (the words in the + previous command begin with word 0). A negative argument inserts + the Nth word from the end of the previous command. -`yank-last-arg (M-., M-_)' +`yank-last-arg (M-. or M-_)' Insert last argument to the previous command (the last word of the previous history entry). With an argument, behave exactly like `yank-nth-arg'. Successive calls to `yank-last-arg' move back @@ -880,10 +928,9 @@ Commands For Changing Text -------------------------- `delete-char (C-d)' - Delete the character under the cursor. If the cursor is at the - beginning of the line, there are no characters in the line, and - the last character typed was not bound to `delete-char', then - return `EOF'. + Delete the character at point. If point is at the beginning of + the line, there are no characters in the line, and the last + character typed was not bound to `delete-char', then return EOF. `backward-delete-char (Rubout)' Delete the character behind the cursor. A numeric argument means @@ -894,11 +941,11 @@ Commands For Changing Text end of the line, in which case the character behind the cursor is deleted. By default, this is not bound to a key. -`quoted-insert (C-q, C-v)' +`quoted-insert (C-q or C-v)' Add the next character typed to the line verbatim. This is how to - insert key sequences like <C-q>, for example. + insert key sequences like `C-q', for example. -`tab-insert (M-TAB)' +`tab-insert (M-<TAB>)' Insert a tab character. `self-insert (a, b, A, 1, !, ...)' @@ -912,7 +959,8 @@ Commands For Changing Text `transpose-words (M-t)' Drag the word before point past the word after point, moving point - past that word as well. + past that word as well. If the insertion point is at the end of + the line, this transposes the last two words on the line. `upcase-word (M-u)' Uppercase the current (or following) word. With a negative @@ -926,6 +974,20 @@ Commands For Changing Text Capitalize the current (or following) word. With a negative argument, capitalize the previous word, but do not move the cursor. +`overwrite-mode ()' + Toggle overwrite mode. With an explicit positive numeric argument, + switches to overwrite mode. With an explicit non-positive numeric + argument, switches to insert mode. This command affects only + `emacs' mode; `vi' mode does overwrite differently. Each call to + `readline()' starts in insert mode. + + In overwrite mode, characters bound to `self-insert' replace the + text at point rather than pushing the text to the right. + Characters bound to `backward-delete-char' replace the character + before point with a space. + + By default, this command is unbound. + File: readline.info, Node: Commands For Killing, Next: Numeric Arguments, Prev: Commands For Text, Up: Bindable Readline Commands @@ -942,15 +1004,15 @@ Killing And Yanking Kill backward from the cursor to the beginning of the current line. `kill-whole-line ()' - Kill all characters on the current line, no matter point is. By - default, this is unbound. + Kill all characters on the current line, no matter where point is. + By default, this is unbound. `kill-word (M-d)' Kill from point to the end of the current word, or if between words, to the end of the next word. Word boundaries are the same as `forward-word'. -`backward-kill-word (M-DEL)' +`backward-kill-word (M-<DEL>)' Kill the word behind point. Word boundaries are the same as `backward-word'. @@ -981,12 +1043,11 @@ Killing And Yanking command is unbound. `yank (C-y)' - Yank the top of the kill ring into the buffer at the current - cursor position. + Yank the top of the kill ring into the buffer at point. `yank-pop (M-y)' Rotate the kill-ring, and yank the new top. You can only do this - if the prior command is yank or yank-pop. + if the prior command is `yank' or `yank-pop'. File: readline.info, Node: Numeric Arguments, Next: Commands For Completion, Prev: Commands For Killing, Up: Bindable Readline Commands @@ -996,7 +1057,7 @@ Specifying Numeric Arguments `digit-argument (M-0, M-1, ... M--)' Add this digit to the argument already accumulating, or start a new - argument. <M-> starts a negative argument. + argument. `M--' starts a negative argument. `universal-argument ()' This is another way to specify an argument. If this command is @@ -1017,17 +1078,13 @@ File: readline.info, Node: Commands For Completion, Next: Keyboard Macros, Pr Letting Readline Type For You ----------------------------- -`complete (TAB)' - Attempt to do completion on the text before the cursor. This is - application-specific. Generally, if you are typing a filename - argument, you can do filename completion; if you are typing a - command, you can do command completion; if you are typing in a - symbol to GDB, you can do symbol name completion; if you are - typing in a variable to Bash, you can do variable name completion, - and so on. +`complete (<TAB>)' + Attempt to perform completion on the text before point. The + actual completion performed is application-specific. The default + is filename completion. `possible-completions (M-?)' - List the possible completions of the text before the cursor. + List the possible completions of the text before point. `insert-completions (M-*)' Insert all completions of the text before point that would have @@ -1038,10 +1095,11 @@ Letting Readline Type For You a single match from the list of possible completions. Repeated execution of `menu-complete' steps through the list of possible completions, inserting each match in turn. At the end of the list - of completions, the bell is rung and the original text is restored. - An argument of N moves N positions forward in the list of matches; - a negative argument may be used to move backward through the list. - This command is intended to be bound to `TAB', but is unbound by + of completions, the bell is rung (subject to the setting of + `bell-style') and the original text is restored. An argument of N + moves N positions forward in the list of matches; a negative + argument may be used to move backward through the list. This + command is intended to be bound to <TAB>, but is unbound by default. `delete-char-or-list ()' @@ -1085,11 +1143,11 @@ Some Miscellaneous Commands If the metafied character X is lowercase, run the command that is bound to the corresponding uppercase character. -`prefix-meta (ESC)' - Make the next character typed be metafied. This is for keyboards - without a meta key. Typing `ESC f' is equivalent to typing `M-f'. +`prefix-meta (<ESC>)' + Metafy the next character typed. This is for keyboards without a + meta key. Typing `<ESC> f' is equivalent to typing `M-f'. -`undo (C-_, C-x C-u)' +`undo (C-_ or C-x C-u)' Incremental undo, separately remembered for each line. `revert-line (M-r)' @@ -1100,8 +1158,8 @@ Some Miscellaneous Commands Perform tilde expansion on the current word. `set-mark (C-@)' - Set the mark to the current point. If a numeric argument is - supplied, the mark is set to that position. + Set the mark to the point. If a numeric argument is supplied, the + mark is set to that position. `exchange-point-and-mark (C-x C-x)' Swap the point with the mark. The current cursor position is set @@ -1119,9 +1177,14 @@ Some Miscellaneous Commands occurrences. `insert-comment (M-#)' - The value of the `comment-begin' variable is inserted at the - beginning of the current line, and the line is accepted as if a - newline had been typed. + Without a numeric argument, the value of the `comment-begin' + variable is inserted at the beginning of the current line. If a + numeric argument is supplied, this command acts as a toggle: if + the characters at the beginning of the line do not match the value + of `comment-begin', the value is inserted, otherwise the + characters in `comment-begin' are deleted from the beginning of + the line. In either case, the line is accepted as if a newline + had been typed. `dump-functions ()' Print all of the functions and their key bindings to the Readline @@ -1137,9 +1200,17 @@ Some Miscellaneous Commands `dump-macros ()' Print all of the Readline key sequences bound to macros and the - strings they ouput. If a numeric argument is supplied, the output - is formatted in such a way that it can be made part of an INPUTRC - file. This command is unbound by default. + strings they output. If a numeric argument is supplied, the + output is formatted in such a way that it can be made part of an + INPUTRC file. This command is unbound by default. + +`emacs-editing-mode (C-e)' + When in `vi' command mode, this causes a switch to `emacs' editing + mode. + +`vi-editing-mode (M-C-j)' + When in `emacs' editing mode, this causes a switch to `vi' editing + mode. File: readline.info, Node: Readline vi Mode, Prev: Bindable Readline Commands, Up: Command Line Editing @@ -1153,7 +1224,8 @@ The Readline `vi' mode behaves as specified in the POSIX 1003.2 standard. In order to switch interactively between `emacs' and `vi' editing -modes, use the command M-C-j (toggle-editing-mode). The Readline +modes, use the command `M-C-j' (bound to emacs-editing-mode when in +`vi' mode and to vi-editing-mode in `emacs' mode). The Readline default is `emacs' mode. When you enter a line in `vi' mode, you are already placed in @@ -1166,8 +1238,7 @@ the standard `vi' movement keys, move to previous history lines with aiding in the consitency of user interface across discrete programs that need to provide a command line interface. - Copyright (C) 1988, 1994, 1996, 1998, 1999 Free Software Foundation, -Inc. + Copyright (C) 1988-2002 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice pare @@ -1218,14 +1289,15 @@ Basic Behavior `ftp', and `sh'. For such programs, the default behaviour of Readline is sufficient. This section describes how to use Readline in the simplest way possible, perhaps to replace calls in your code to -`gets()' or `fgets ()'. +`gets()' or `fgets()'. - The function `readline ()' prints a prompt and then reads and returns -a single line of text from the user. The line `readline' returns is -allocated with `malloc ()'; you should `free ()' the line when you are -done with it. The declaration for `readline' in ANSI C is + The function `readline()' prints a prompt PROMPT and then reads and +returns a single line of text from the user. If PROMPT is `NULL' or +the empty string, no prompt is displayed. The line `readline' returns +is allocated with `malloc()'; the caller should `free()' the line when +it has finished with it. The declaration for `readline' in ANSI C is - `char *readline (char *PROMPT);' + `char *readline (const char *PROMPT);' So, one might say `char *line = readline ("Enter a line: ");' @@ -1238,8 +1310,8 @@ line is empty at that point, then `(char *)NULL' is returned. Otherwise, the line is ended just as if a newline had been typed. If you want the user to be able to get at the line later, (with -<C-p> for example), you must call `add_history ()' to save the line -away in a "history" list of such lines. +<C-p> for example), you must call `add_history()' to save the line away +in a "history" list of such lines. `add_history (line)'; @@ -1247,18 +1319,19 @@ For full details on the GNU History Library, see the associated manual. It is preferable to avoid saving empty lines on the history list, since users rarely have a burning need to reuse a blank line. Here is -a function which usefully replaces the standard `gets ()' library +a function which usefully replaces the standard `gets()' library function, and has the advantage of no static buffer to overflow: /* A static variable for holding the line. */ static char *line_read = (char *)NULL; - /* Read a string, and return a pointer to it. Returns NULL on EOF. */ + /* Read a string, and return a pointer to it. + Returns NULL on EOF. */ char * rl_gets () { - /* If the buffer has already been allocated, return the memory - to the free pool. */ + /* If the buffer has already been allocated, + return the memory to the free pool. */ if (line_read) { free (line_read); @@ -1268,7 +1341,8 @@ function, and has the advantage of no static buffer to overflow: /* Get a line from the user. */ line_read = readline (""); - /* If the line has any text in it, save it on the history. */ + /* If the line has any text in it, + save it on the history. */ if (line_read && *line_read) add_history (line_read); @@ -1278,23 +1352,23 @@ function, and has the advantage of no static buffer to overflow: This function gives the user the default behaviour of <TAB> completion: completion on file names. If you do not want Readline to complete on filenames, you can change the binding of the <TAB> key with -`rl_bind_key ()'. +`rl_bind_key()'. - `int rl_bind_key (int KEY, int (*FUNCTION)());' + `int rl_bind_key (int KEY, rl_command_func_t *FUNCTION);' - `rl_bind_key ()' takes two arguments: KEY is the character that you + `rl_bind_key()' takes two arguments: KEY is the character that you want to bind, and FUNCTION is the address of the function to call when -KEY is pressed. Binding <TAB> to `rl_insert ()' makes <TAB> insert -itself. `rl_bind_key ()' returns non-zero if KEY is not a valid ASCII +KEY is pressed. Binding <TAB> to `rl_insert()' makes <TAB> insert +itself. `rl_bind_key()' returns non-zero if KEY is not a valid ASCII character code (between 0 and 255). Thus, to disable the default <TAB> behavior, the following suffices: `rl_bind_key ('\t', rl_insert);' This code should be executed once at the start of your program; you -might write a function called `initialize_readline ()' which performs +might write a function called `initialize_readline()' which performs this and other desired initializations, such as installing custom -completers (*note Custom Completers::.). +completers (*note Custom Completers::). File: readline.info, Node: Custom Functions, Next: Readline Variables, Prev: Basic Behavior, Up: Programming with GNU Readline @@ -1315,45 +1389,87 @@ uses Readline's features. Since some of the definitions in `readline.h' use the `stdio' library, the file `<stdio.h>' should be included before `readline.h'. + `readline.h' defines a C preprocessor variable that should be +treated as an integer, `RL_READLINE_VERSION', which may be used to +conditionally compile application code depending on the installed +Readline version. The value is a hexadecimal encoding of the major and +minor version numbers of the library, of the form 0xMMMM. MM is the +two-digit major version number; MM is the two-digit minor version +number. For Readline 4.2, for example, the value of +`RL_READLINE_VERSION' would be `0x0402'. + * Menu: -* The Function Type:: C declarations to make code readable. +* Readline Typedefs:: C declarations to make code readable. * Function Writing:: Variables and calling conventions. -File: readline.info, Node: The Function Type, Next: Function Writing, Up: Custom Functions +File: readline.info, Node: Readline Typedefs, Next: Function Writing, Up: Custom Functions -The Function Type +Readline Typedefs ----------------- - For readabilty, we declare a new type of object, called "Function". -A `Function' is a C function which returns an `int'. The type -declaration for `Function' is: + For readabilty, we declare a number of new object types, all pointers +to functions. + + The reason for declaring these new types is to make it easier to +write code describing pointers to C functions with appropriately +prototyped arguments and return values. -`typedef int Function ();' + For instance, say we want to declare a variable FUNC as a pointer to +a function which takes two `int' arguments and returns an `int' (this +is the type of all of the Readline bindable functions). Instead of the +classic C declaration - The reason for declaring this new type is to make it easier to write -code describing pointers to C functions. Let us say we had a variable -called FUNC which was a pointer to a function. Instead of the classic -C declaration + `int (*func)();' - `int (*)()func;' +or the ANSI-C style declaration + + `int (*func)(int, int);' we may write - `Function *func;' + `rl_command_func_t *func;' + + The full list of function pointer types available is + +`typedef int rl_command_func_t (int, int);' + +`typedef char *rl_compentry_func_t (const char *, int);' + +`typedef char **rl_completion_func_t (const char *, int, int);' + +`typedef char *rl_quote_func_t (char *, int, char *);' + +`typedef char *rl_dequote_func_t (char *, int);' + +`typedef int rl_compignore_func_t (char **);' + +`typedef void rl_compdisp_func_t (char **, int, int);' + +`typedef int rl_hook_func_t (void);' + +`typedef int rl_getc_func_t (FILE *);' + +`typedef int rl_linebuf_func_t (char *, int);' -Similarly, there are +`typedef int rl_intfunc_t (int);' - typedef void VFunction (); - typedef char *CPFunction (); and - typedef char **CPPFunction (); +`#define rl_ivoidfunc_t rl_hook_func_t' -for functions returning no value, `pointer to char', and `pointer to -pointer to char', respectively. +`typedef int rl_icpfunc_t (char *);' +`typedef int rl_icppfunc_t (char **);' + +`typedef void rl_voidfunc_t (void);' + +`typedef void rl_vintfunc_t (int);' + +`typedef void rl_vcpfunc_t (char *);' + +`typedef void rl_vcppfunc_t (char **);' -File: readline.info, Node: Function Writing, Prev: The Function Type, Up: Custom Functions +File: readline.info, Node: Function Writing, Prev: Readline Typedefs, Up: Custom Functions Writing a New Function ---------------------- @@ -1364,7 +1480,7 @@ variables that describe the current state of the line read so far. The calling sequence for a command `foo' looks like - `foo (int count, int key)' + `int foo (int count, int key)' where COUNT is the numeric argument (or 1 if defaulted) and KEY is the key that invoked this function. @@ -1378,6 +1494,9 @@ repeat count, it should be able to do something useful with both negative and positive arguments. At the very least, it should be aware that it can be passed a negative argument. + A command function should return 0 if its action completes +successfully, and a non-zero value if some error occurs. + File: readline.info, Node: Readline Variables, Next: Readline Convenience Functions, Prev: Custom Functions, Up: Programming with GNU Readline @@ -1394,7 +1513,7 @@ Readline Variables - Variable: int rl_point The offset of the current cursor position in `rl_line_buffer' (the - *point*). + _point_). - Variable: int rl_end The number of characters present in `rl_line_buffer'. When @@ -1402,17 +1521,28 @@ Readline Variables equal. - Variable: int rl_mark - The mark (saved position) in the current line. If set, the mark - and point define a *region*. + The MARK (saved position) in the current line. If set, the mark + and point define a _region_. - Variable: int rl_done Setting this to a non-zero value causes Readline to return the current line immediately. + - Variable: int rl_num_chars_to_read + Setting this to a positive value before calling `readline()' causes + Readline to return after accepting that many characters, rather + than reading up to a character bound to `accept-line'. + - Variable: int rl_pending_input Setting this to a value makes it the next keystroke read. This is a way to stuff a single character into the input stream. + - Variable: int rl_dispatching + Set to a non-zero value if a function is being called from a key + binding; zero otherwise. Application functions can test this to + discover whether they were called directly or by Readline's + dispatching mechanism. + - Variable: int rl_erase_empty_line Setting this to a non-zero value causes Readline to completely erase the current line, including any prompt, any time a newline @@ -1421,7 +1551,9 @@ Readline Variables - Variable: char * rl_prompt The prompt Readline uses. This is set from the argument to - `readline ()', and should not be assigned to directly. + `readline()', and should not be assigned to directly. The + `rl_set_prompt()' function (*note Redisplay::) may be used to + modify the prompt string after calling `readline()'. - Variable: int rl_already_prompted If an application wishes to display the prompt itself, rather than @@ -1432,56 +1564,180 @@ Readline Variables properly. The calling application is responsible for managing the value; Readline never sets it. - - Variable: char * rl_library_version + - Variable: const char * rl_library_version The version number of this revision of the library. - - Variable: char * rl_terminal_name - The terminal type, used for initialization. + - Variable: int rl_readline_version + An integer encoding the current version of the library. The + encoding is of the form 0xMMMM, where MM is the two-digit major + version number, and MM is the two-digit minor version number. For + example, for Readline-4.2, `rl_readline_version' would have the + value 0x0402. + + - Variable: int rl_gnu_readline_p + Always set to 1, denoting that this is GNU readline rather than + some emulation. + + - Variable: const char * rl_terminal_name + The terminal type, used for initialization. If not set by the + application, Readline sets this to the value of the `TERM' + environment variable the first time it is called. - - Variable: char * rl_readline_name + - Variable: const char * rl_readline_name This variable is set to a unique name by each application using Readline. The value allows conditional parsing of the inputrc file - (*note Conditional Init Constructs::.). + (*note Conditional Init Constructs::). - Variable: FILE * rl_instream - The stdio stream from which Readline reads input. + The stdio stream from which Readline reads input. If `NULL', + Readline defaults to STDIN. - Variable: FILE * rl_outstream - The stdio stream to which Readline performs output. + The stdio stream to which Readline performs output. If `NULL', + Readline defaults to STDOUT. - - Variable: Function * rl_startup_hook + - Variable: rl_command_func_t * rl_last_func + The address of the last command function Readline executed. May + be used to test whether or not a function is being executed twice + in succession, for example. + + - Variable: rl_hook_func_t * rl_startup_hook If non-zero, this is the address of a function to call just before `readline' prints the first prompt. - - Variable: Function * rl_pre_input_hook + - Variable: rl_hook_func_t * rl_pre_input_hook If non-zero, this is the address of a function to call after the first prompt has been printed and just before `readline' starts reading input characters. - - Variable: Function * rl_event_hook + - Variable: rl_hook_func_t * rl_event_hook If non-zero, this is the address of a function to call periodically - when readline is waiting for terminal input. - - - Variable: Function * rl_getc_function - If non-zero, `readline' will call indirectly through this pointer - to get a character from the input stream. By default, it is set to - `rl_getc', the default `readline' character input function (*note - Utility Functions::.). - - - Variable: VFunction * rl_redisplay_function - If non-zero, `readline' will call indirectly through this pointer - to update the display with the current contents of the editing - buffer. By default, it is set to `rl_redisplay', the default - `readline' redisplay function (*note Redisplay::.). + when Readline is waiting for terminal input. By default, this + will be called at most ten times a second if there is no keyboard + input. + + - Variable: rl_getc_func_t * rl_getc_function + If non-zero, Readline will call indirectly through this pointer to + get a character from the input stream. By default, it is set to + `rl_getc', the default Readline character input function (*note + Character Input::). + + - Variable: rl_voidfunc_t * rl_redisplay_function + If non-zero, Readline will call indirectly through this pointer to + update the display with the current contents of the editing buffer. + By default, it is set to `rl_redisplay', the default Readline + redisplay function (*note Redisplay::). + + - Variable: rl_vintfunc_t * rl_prep_term_function + If non-zero, Readline will call indirectly through this pointer to + initialize the terminal. The function takes a single argument, an + `int' flag that says whether or not to use eight-bit characters. + By default, this is set to `rl_prep_terminal' (*note Terminal + Management::). + + - Variable: rl_voidfunc_t * rl_deprep_term_function + If non-zero, Readline will call indirectly through this pointer to + reset the terminal. This function should undo the effects of + `rl_prep_term_function'. By default, this is set to + `rl_deprep_terminal' (*note Terminal Management::). - Variable: Keymap rl_executing_keymap - This variable is set to the keymap (*note Keymaps::.) in which the + This variable is set to the keymap (*note Keymaps::) in which the currently executing readline function was found. - Variable: Keymap rl_binding_keymap - This variable is set to the keymap (*note Keymaps::.) in which the + This variable is set to the keymap (*note Keymaps::) in which the last key binding occurred. + - Variable: char * rl_executing_macro + This variable is set to the text of any currently-executing macro. + + - Variable: int rl_readline_state + A variable with bit values that encapsulate the current Readline + state. A bit is set with the `RL_SETSTATE' macro, and unset with + the `RL_UNSETSTATE' macro. Use the `RL_ISSTATE' macro to test + whether a particular state bit is set. Current state bits include: + + `RL_STATE_NONE' + Readline has not yet been called, nor has it begun to + intialize. + + `RL_STATE_INITIALIZING' + Readline is initializing its internal data structures. + + `RL_STATE_INITIALIZED' + Readline has completed its initialization. + + `RL_STATE_TERMPREPPED' + Readline has modified the terminal modes to do its own input + and redisplay. + + `RL_STATE_READCMD' + Readline is reading a command from the keyboard. + + `RL_STATE_METANEXT' + Readline is reading more input after reading the meta-prefix + character. + + `RL_STATE_DISPATCHING' + Readline is dispatching to a command. + + `RL_STATE_MOREINPUT' + Readline is reading more input while executing an editing + command. + + `RL_STATE_ISEARCH' + Readline is performing an incremental history search. + + `RL_STATE_NSEARCH' + Readline is performing a non-incremental history search. + + `RL_STATE_SEARCH' + Readline is searching backward or forward through the history + for a string. + + `RL_STATE_NUMERICARG' + Readline is reading a numeric argument. + + `RL_STATE_MACROINPUT' + Readline is currently getting its input from a + previously-defined keyboard macro. + + `RL_STATE_MACRODEF' + Readline is currently reading characters defining a keyboard + macro. + + `RL_STATE_OVERWRITE' + Readline is in overwrite mode. + + `RL_STATE_COMPLETING' + Readline is performing word completion. + + `RL_STATE_SIGHANDLER' + Readline is currently executing the readline signal handler. + + `RL_STATE_UNDOING' + Readline is performing an undo. + + `RL_STATE_DONE' + Readline has read a key sequence bound to `accept-line' and + is about to return the line to the caller. + + + - Variable: int rl_explicit_arg + Set to a non-zero value if an explicit numeric argument was + specified by the user. Only valid in a bindable command function. + + - Variable: int rl_numeric_arg + Set to the value of any numeric argument explicitly specified by + the user before executing the current Readline function. Only + valid in a bindable command function. + + - Variable: int rl_editing_mode + Set to a value denoting Readline's current editing mode. A value + of 1 means Readline is currently in emacs mode; 0 means that vi + mode is active. + File: readline.info, Node: Readline Convenience Functions, Next: Readline Signal Handling, Prev: Readline Variables, Up: Programming with GNU Readline @@ -1498,8 +1754,12 @@ Readline Convenience Functions * Allowing Undoing:: How to make your functions undoable. * Redisplay:: Functions to control line display. * Modifying Text:: Functions to modify `rl_line_buffer'. +* Character Input:: Functions to read keyboard input. +* Terminal Management:: Functions to manage terminal settings. * Utility Functions:: Generally useful functions and hooks. +* Miscellaneous Functions:: Functions that don't fall into any category. * Alternate Interface:: Using Readline in a `callback' fashion. +* A Readline Example:: An example Readline function. File: readline.info, Node: Function Naming, Next: Keymaps, Up: Readline Convenience Functions @@ -1515,14 +1775,15 @@ the function. Thus, in an init file, one might find Meta-Rubout: backward-kill-word This binds the keystroke <Meta-Rubout> to the function -*descriptively* named `backward-kill-word'. You, as the programmer, +_descriptively_ named `backward-kill-word'. You, as the programmer, should bind the functions you write to descriptive names as well. Readline provides a function for doing that: - - Function: int rl_add_defun (char *name, Function *function, int key) + - Function: int rl_add_defun (const char *name, rl_command_func_t + *function, int key) Add NAME to the list of named functions. Make FUNCTION be the function that gets called. If KEY is not -1, then bind it to - FUNCTION using `rl_bind_key ()'. + FUNCTION using `rl_bind_key()'. Using this function alone is sufficient for most applications. It is the recommended way to add a few functions to the default functions that @@ -1541,15 +1802,15 @@ association between the keys that the user types and the functions that get run. You can make your own keymaps, copy existing keymaps, and tell Readline which keymap to use. - - Function: Keymap rl_make_bare_keymap () + - Function: Keymap rl_make_bare_keymap (void) Returns a new, empty keymap. The space for the keymap is - allocated with `malloc ()'; you should `free ()' it when you are - done. + allocated with `malloc()'; the caller should free it by calling + `rl_discard_keymap()' when done. - Function: Keymap rl_copy_keymap (Keymap map) Return a new keymap which is a copy of MAP. - - Function: Keymap rl_make_keymap () + - Function: Keymap rl_make_keymap (void) Return a new keymap with the printing characters bound to rl_insert, the lowercase Meta characters bound to run their equivalents, and the Meta digits bound to produce numeric @@ -1561,21 +1822,21 @@ Readline which keymap to use. Readline has several internal keymaps. These functions allow you to change which keymap is active. - - Function: Keymap rl_get_keymap () + - Function: Keymap rl_get_keymap (void) Returns the currently active keymap. - Function: void rl_set_keymap (Keymap keymap) Makes KEYMAP the currently active keymap. - - Function: Keymap rl_get_keymap_by_name (char *name) + - Function: Keymap rl_get_keymap_by_name (const char *name) Return the keymap matching NAME. NAME is one which would be supplied in a `set keymap' inputrc line (*note Readline Init - File::.). + File::). - Function: char * rl_get_keymap_name (Keymap keymap) Return the name matching KEYMAP. NAME is one which would be supplied in a `set keymap' inputrc line (*note Readline Init - File::.). + File::). File: readline.info, Node: Binding Keys, Next: Associating Function Names and Bindings, Prev: Keymaps, Up: Readline Convenience Functions @@ -1583,27 +1844,27 @@ File: readline.info, Node: Binding Keys, Next: Associating Function Names and Binding Keys ------------ - You associate keys with functions through the keymap. Readline has -several internal keymaps: `emacs_standard_keymap', `emacs_meta_keymap', -`emacs_ctlx_keymap', `vi_movement_keymap', and `vi_insertion_keymap'. -`emacs_standard_keymap' is the default, and the examples in this manual -assume that. + Key sequences are associate with functions through the keymap. +Readline has several internal keymaps: `emacs_standard_keymap', +`emacs_meta_keymap', `emacs_ctlx_keymap', `vi_movement_keymap', and +`vi_insertion_keymap'. `emacs_standard_keymap' is the default, and the +examples in this manual assume that. - Since `readline' installs a set of default key bindings the first + Since `readline()' installs a set of default key bindings the first time it is called, there is always the danger that a custom binding -installed before the first call to `readline' will be overridden. An +installed before the first call to `readline()' will be overridden. An alternate mechanism is to install custom key bindings in an initialization function assigned to the `rl_startup_hook' variable -(*note Readline Variables::.). +(*note Readline Variables::). These functions manage key bindings. - - Function: int rl_bind_key (int key, Function *function) + - Function: int rl_bind_key (int key, rl_command_func_t *function) Binds KEY to FUNCTION in the currently active keymap. Returns non-zero in the case of an invalid KEY. - - Function: int rl_bind_key_in_map (int key, Function *function, - Keymap map) + - Function: int rl_bind_key_in_map (int key, rl_command_func_t + *function, Keymap map) Bind KEY to FUNCTION in MAP. Returns non-zero in the case of an invalid KEY. @@ -1615,15 +1876,22 @@ initialization function assigned to the `rl_startup_hook' variable Bind KEY to the null function in MAP. Returns non-zero in case of error. - - Function: int rl_unbind_function_in_map (Function *function, Keymap - map) + - Function: int rl_unbind_function_in_map (rl_command_func_t + *function, Keymap map) Unbind all keys that execute FUNCTION in MAP. - - Function: int rl_unbind_command_in_map (char *command, Keymap map) + - Function: int rl_unbind_command_in_map (const char *command, Keymap + map) Unbind all keys that are bound to COMMAND in MAP. - - Function: int rl_generic_bind (int type, char *keyseq, char *data, - Keymap map) + - Function: int rl_set_key (const char *keyseq, rl_command_func_t + *function, Keymap map) + Bind the key sequence represented by the string KEYSEQ to the + function FUNCTION. This makes new keymaps as necessary. The + initial keymap in which to do bindings is MAP. + + - Function: int rl_generic_bind (int type, const char *keyseq, char + *data, Keymap map) Bind the key sequence represented by the string KEYSEQ to the arbitrary pointer DATA. TYPE says what kind of data is pointed to by DATA; this can be a function (`ISFUNC'), a macro (`ISMACR'), or @@ -1633,11 +1901,11 @@ initialization function assigned to the `rl_startup_hook' variable - Function: int rl_parse_and_bind (char *line) Parse LINE as if it had been read from the `inputrc' file and perform any key bindings and variable assignments found (*note - Readline Init File::.). + Readline Init File::). - - Function: int rl_read_init_file (char *filename) + - Function: int rl_read_init_file (const char *filename) Read keybindings and variable assignments from FILENAME (*note - Readline Init File::.). + Readline Init File::). File: readline.info, Node: Associating Function Names and Bindings, Next: Allowing Undoing, Prev: Binding Keys, Up: Readline Convenience Functions @@ -1646,24 +1914,25 @@ Associating Function Names and Bindings --------------------------------------- These functions allow you to find out what keys invoke named -functions and the functions invoked by a particular key sequence. +functions and the functions invoked by a particular key sequence. You +may also associate a new function name with an arbitrary function. - - Function: Function * rl_named_function (char *name) + - Function: rl_command_func_t * rl_named_function (const char *name) Return the function with name NAME. - - Function: Function * rl_function_of_keyseq (char *keyseq, Keymap - map, int *type) + - Function: rl_command_func_t * rl_function_of_keyseq (const char + *keyseq, Keymap map, int *type) Return the function invoked by KEYSEQ in keymap MAP. If MAP is - NULL, the current keymap is used. If TYPE is not NULL, the type - of the object is returned in it (one of `ISFUNC', `ISKMAP', or - `ISMACR'). + `NULL', the current keymap is used. If TYPE is not `NULL', the + type of the object is returned in the `int' variable it points to + (one of `ISFUNC', `ISKMAP', or `ISMACR'). - - Function: char ** rl_invoking_keyseqs (Function *function) + - Function: char ** rl_invoking_keyseqs (rl_command_func_t *function) Return an array of strings representing the key sequences used to invoke FUNCTION in the current keymap. - - Function: char ** rl_invoking_keyseqs_in_map (Function *function, - Keymap map) + - Function: char ** rl_invoking_keyseqs_in_map (rl_command_func_t + *function, Keymap map) Return an array of strings representing the key sequences used to invoke FUNCTION in the keymap MAP. @@ -1673,15 +1942,20 @@ functions and the functions invoked by a particular key sequence. list is formatted in such a way that it can be made part of an `inputrc' file and re-read. - - Function: void rl_list_funmap_names () + - Function: void rl_list_funmap_names (void) Print the names of all bindable Readline functions to `rl_outstream'. - - Function: char ** rl_funmap_names () + - Function: const char ** rl_funmap_names (void) Return a NULL terminated array of known function names. The array is sorted. The array itself is allocated, but not the strings - inside. You should free () the array when you done, but not the - pointrs. + inside. You should `free()' the array when you are done, but not + the pointers. + + - Function: int rl_add_funmap_entry (const char *name, + rl_command_func_t *function) + Add NAME to the list of bindable Readline command names, and make + FUNCTION the function to be called when NAME is invoked. File: readline.info, Node: Allowing Undoing, Next: Redisplay, Prev: Associating Function Names and Bindings, Up: Readline Convenience Functions @@ -1691,17 +1965,16 @@ Allowing Undoing Supporting the undo command is a painless thing, and makes your functions much more useful. It is certainly easy to try something if -you know you can undo it. I could use an undo function for the stock -market. +you know you can undo it. If your function simply inserts text once, or deletes text once, and -uses `rl_insert_text ()' or `rl_delete_text ()' to do it, then undoing -is already done for you automatically. +uses `rl_insert_text()' or `rl_delete_text()' to do it, then undoing is +already done for you automatically. If you do multiple insertions or multiple deletions, or any combination of these operations, you should group them together into -one operation. This is done with `rl_begin_undo_group ()' and -`rl_end_undo_group ()'. +one operation. This is done with `rl_begin_undo_group()' and +`rl_end_undo_group()'. The types of events that can be undone are: @@ -1709,34 +1982,34 @@ one operation. This is done with `rl_begin_undo_group ()' and Notice that `UNDO_DELETE' means to insert some text, and `UNDO_INSERT' means to delete some text. That is, the undo code tells -undo what to undo, not how to undo it. `UNDO_BEGIN' and `UNDO_END' are -tags added by `rl_begin_undo_group ()' and `rl_end_undo_group ()'. +what to undo, not how to undo it. `UNDO_BEGIN' and `UNDO_END' are tags +added by `rl_begin_undo_group()' and `rl_end_undo_group()'. - - Function: int rl_begin_undo_group () + - Function: int rl_begin_undo_group (void) Begins saving undo information in a group construct. The undo - information usually comes from calls to `rl_insert_text ()' and - `rl_delete_text ()', but could be the result of calls to - `rl_add_undo ()'. + information usually comes from calls to `rl_insert_text()' and + `rl_delete_text()', but could be the result of calls to + `rl_add_undo()'. - - Function: int rl_end_undo_group () + - Function: int rl_end_undo_group (void) Closes the current undo group started with `rl_begin_undo_group - ()'. There should be one call to `rl_end_undo_group ()' for each - call to `rl_begin_undo_group ()'. + ()'. There should be one call to `rl_end_undo_group()' for each + call to `rl_begin_undo_group()'. - Function: void rl_add_undo (enum undo_code what, int start, int end, char *text) Remember how to undo an event (according to WHAT). The affected text runs from START to END, and encompasses TEXT. - - Function: void free_undo_list () + - Function: void rl_free_undo_list (void) Free the existing undo list. - - Function: int rl_do_undo () + - Function: int rl_do_undo (void) Undo the first thing on the undo list. Returns `0' if there was nothing to undo, non-zero if something was undone. Finally, if you neither insert nor delete text, but directly modify -the existing text (e.g., change its case), call `rl_modifying ()' once, +the existing text (e.g., change its case), call `rl_modifying()' once, just before you modify the text. You must supply the indices of the text range that you are going to modify. @@ -1751,56 +2024,84 @@ File: readline.info, Node: Redisplay, Next: Modifying Text, Prev: Allowing Un Redisplay --------- - - Function: void rl_redisplay () + - Function: void rl_redisplay (void) Change what's displayed on the screen to reflect the current contents of `rl_line_buffer'. - - Function: int rl_forced_update_display () + - Function: int rl_forced_update_display (void) Force the line to be updated and redisplayed, whether or not Readline thinks the screen display is correct. - - Function: int rl_on_new_line () + - Function: int rl_on_new_line (void) Tell the update functions that we have moved onto a new (empty) line, usually after ouputting a newline. - - Function: int rl_on_new_line_with_prompt () + - Function: int rl_on_new_line_with_prompt (void) Tell the update functions that we have moved onto a new line, with RL_PROMPT already displayed. This could be used by applications that want to output the prompt string themselves, but still need Readline to know the prompt string length for redisplay. It should be used after setting RL_ALREADY_PROMPTED. - - Function: int rl_reset_line_state () + - Function: int rl_reset_line_state (void) Reset the display state to a clean state and redisplay the current line starting on a new line. - - Function: int rl_message (va_alist) - The arguments are a string as would be supplied to `printf'. The - resulting string is displayed in the "echo area". The echo area - is also used to display numeric arguments and search strings. + - Function: int rl_crlf (void) + Move the cursor to the start of the next screen line. + + - Function: int rl_show_char (int c) + Display character C on `rl_outstream'. If Readline has not been + set to display meta characters directly, this will convert meta + characters to a meta-prefixed key sequence. This is intended for + use by applications which wish to do their own redisplay. + + - Function: int rl_message (const char *, ...) + The arguments are a format string as would be supplied to `printf', + possibly containing conversion specifications such as `%d', and + any additional arguments necessary to satisfy the conversion + specifications. The resulting string is displayed in the "echo + area". The echo area is also used to display numeric arguments + and search strings. - - Function: int rl_clear_message () + - Function: int rl_clear_message (void) Clear the message in the echo area. - - Function: void rl_save_prompt () + - Function: void rl_save_prompt (void) Save the local Readline prompt display state in preparation for - displaying a new message in the message area with `rl_message'. + displaying a new message in the message area with `rl_message()'. - - Function: void rl_restore_prompt () + - Function: void rl_restore_prompt (void) Restore the local Readline prompt display state saved by the most recent call to `rl_save_prompt'. + - Function: int rl_expand_prompt (char *prompt) + Expand any special character sequences in PROMPT and set up the + local Readline prompt redisplay variables. This function is + called by `readline()'. It may also be called to expand the + primary prompt if the `rl_on_new_line_with_prompt()' function or + `rl_already_prompted' variable is used. It returns the number of + visible characters on the last line of the (possibly multi-line) + prompt. + + - Function: int rl_set_prompt (const char *prompt) + Make Readline use PROMPT for subsequent redisplay. This calls + `rl_expand_prompt()' to expand the prompt and sets `rl_prompt' to + the result. + -File: readline.info, Node: Modifying Text, Next: Utility Functions, Prev: Redisplay, Up: Readline Convenience Functions +File: readline.info, Node: Modifying Text, Next: Character Input, Prev: Redisplay, Up: Readline Convenience Functions Modifying Text -------------- - - Function: int rl_insert_text (char *text) - Insert TEXT into the line at the current cursor position. + - Function: int rl_insert_text (const char *text) + Insert TEXT into the line at the current cursor position. Returns + the number of characters inserted. - Function: int rl_delete_text (int start, int end) Delete the text between START and END in the current line. + Returns the number of characters deleted. - Function: char * rl_copy_text (int start, int end) Return a copy of the text between START and END in the current @@ -1813,48 +2114,105 @@ Modifying Text less than END, the text is appended, otherwise prepended. If the last command was not a kill, a new kill ring slot is used. + - Function: int rl_push_macro_input (char *macro) + Cause MACRO to be inserted into the line, as if it had been invoked + by a key bound to a macro. Not especially useful; use + `rl_insert_text()' instead. + -File: readline.info, Node: Utility Functions, Next: Alternate Interface, Prev: Modifying Text, Up: Readline Convenience Functions +File: readline.info, Node: Character Input, Next: Terminal Management, Prev: Modifying Text, Up: Readline Convenience Functions -Utility Functions ------------------ +Character Input +--------------- - - Function: int rl_read_key () - Return the next character available. This handles input inserted - into the input stream via PENDING INPUT (*note Readline - Variables::.) and `rl_stuff_char ()', macros, and characters read - from the keyboard. + - Function: int rl_read_key (void) + Return the next character available from Readline's current input + stream. This handles input inserted into the input stream via + RL_PENDING_INPUT (*note Readline Variables::) and + `rl_stuff_char()', macros, and characters read from the keyboard. + While waiting for input, this function will call any function + assigned to the `rl_event_hook' variable. - - Function: int rl_getc (FILE *) - Return the next character available from the keyboard. + - Function: int rl_getc (FILE *stream) + Return the next character available from STREAM, which is assumed + to be the keyboard. - Function: int rl_stuff_char (int c) Insert C into the Readline input stream. It will be "read" before Readline attempts to read characters from the terminal with - `rl_read_key ()'. + `rl_read_key()'. Up to 512 characters may be pushed back. + `rl_stuff_char' returns 1 if the character was successfully + inserted; 0 otherwise. - - Function: int rl_extend_line_buffer (int len) - Ensure that `rl_line_buffer' has enough space to hold LEN - characters, possibly reallocating it if necessary. + - Function: int rl_execute_next (int c) + Make C be the next command to be executed when `rl_read_key()' is + called. This sets RL_PENDING_INPUT. + + - Function: int rl_clear_pending_input (void) + Unset RL_PENDING_INPUT, effectively negating the effect of any + previous call to `rl_execute_next()'. This works only if the + pending input has not already been read with `rl_read_key()'. + + - Function: int rl_set_keyboard_input_timeout (int u) + While waiting for keyboard input in `rl_read_key()', Readline will + wait for U microseconds for input before calling any function + assigned to `rl_event_hook'. The default waiting period is + one-tenth of a second. Returns the old timeout value. + + +File: readline.info, Node: Terminal Management, Next: Utility Functions, Prev: Character Input, Up: Readline Convenience Functions + +Terminal Management +------------------- + + - Function: void rl_prep_terminal (int meta_flag) + Modify the terminal settings for Readline's use, so `readline()' + can read a single character at a time from the keyboard. The + META_FLAG argument should be non-zero if Readline should read + eight-bit input. + + - Function: void rl_deprep_terminal (void) + Undo the effects of `rl_prep_terminal()', leaving the terminal in + the state in which it was before the most recent call to + `rl_prep_terminal()'. - - Function: int rl_initialize () - Initialize or re-initialize Readline's internal state. + - Function: void rl_tty_set_default_bindings (Keymap kmap) + Read the operating system's terminal editing characters (as would + be displayed by `stty') to their Readline equivalents. The + bindings are performed in KMAP. - - Function: int rl_reset_terminal (char *terminal_name) + - Function: int rl_reset_terminal (const char *terminal_name) Reinitialize Readline's idea of the terminal settings using TERMINAL_NAME as the terminal type (e.g., `vt100'). If - TERMINAL_NAME is NULL, the value of the `TERM' environment + TERMINAL_NAME is `NULL', the value of the `TERM' environment variable is used. - - Function: int alphabetic (int c) - Return 1 if C is an alphabetic character. + +File: readline.info, Node: Utility Functions, Next: Miscellaneous Functions, Prev: Terminal Management, Up: Readline Convenience Functions - - Function: int numeric (int c) - Return 1 if C is a numeric character. +Utility Functions +----------------- + + - Function: void rl_replace_line (const char *text, int clear_undo) + Replace the contents of `rl_line_buffer' with TEXT. The point and + mark are preserved, if possible. If CLEAR_UNDO is non-zero, the + undo list associated with the current line is cleared. - - Function: int ding () + - Function: int rl_extend_line_buffer (int len) + Ensure that `rl_line_buffer' has enough space to hold LEN + characters, possibly reallocating it if necessary. + + - Function: int rl_initialize (void) + Initialize or re-initialize Readline's internal state. It's not + strictly necessary to call this; `readline()' calls it before + reading any input. + + - Function: int rl_ding (void) Ring the terminal bell, obeying the setting of `bell-style'. + - Function: int rl_alphabetic (int c) + Return 1 if C is an alphabetic character. + - Function: void rl_display_match_list (char **matches, int len, int max) A convenience function for displaying a list of strings in @@ -1863,32 +2221,77 @@ Utility Functions `len' is the number of strings in `matches', and `max' is the length of the longest string in `matches'. This function uses the setting of `print-completions-horizontally' to select how the - matches are displayed (*note Readline Init File Syntax::.). + matches are displayed (*note Readline Init File Syntax::). - The following are implemented as macros, defined in `chartypes.h'. + The following are implemented as macros, defined in `chardefs.h'. +Applications should refrain from using them. - - Function: int uppercase_p (int c) + - Function: int _rl_uppercase_p (int c) Return 1 if C is an uppercase alphabetic character. - - Function: int lowercase_p (int c) + - Function: int _rl_lowercase_p (int c) Return 1 if C is a lowercase alphabetic character. - - Function: int digit_p (int c) + - Function: int _rl_digit_p (int c) Return 1 if C is a numeric character. - - Function: int to_upper (int c) + - Function: int _rl_to_upper (int c) If C is a lowercase alphabetic character, return the corresponding uppercase character. - - Function: int to_lower (int c) + - Function: int _rl_to_lower (int c) If C is an uppercase alphabetic character, return the corresponding lowercase character. - - Function: int digit_value (int c) + - Function: int _rl_digit_value (int c) If C is a number, return the value it represents. -File: readline.info, Node: Alternate Interface, Prev: Utility Functions, Up: Readline Convenience Functions +File: readline.info, Node: Miscellaneous Functions, Next: Alternate Interface, Prev: Utility Functions, Up: Readline Convenience Functions + +Miscellaneous Functions +----------------------- + + - Function: int rl_macro_bind (const char *keyseq, const char *macro, + Keymap map) + Bind the key sequence KEYSEQ to invoke the macro MACRO. The + binding is performed in MAP. When KEYSEQ is invoked, the MACRO + will be inserted into the line. This function is deprecated; use + `rl_generic_bind()' instead. + + - Function: void rl_macro_dumper (int readable) + Print the key sequences bound to macros and their values, using + the current keymap, to `rl_outstream'. If READABLE is non-zero, + the list is formatted in such a way that it can be made part of an + `inputrc' file and re-read. + + - Function: int rl_variable_bind (const char *variable, const char + *value) + Make the Readline variable VARIABLE have VALUE. This behaves as + if the readline command `set VARIABLE VALUE' had been executed in + an `inputrc' file (*note Readline Init File Syntax::). + + - Function: void rl_variable_dumper (int readable) + Print the readline variable names and their current values to + `rl_outstream'. If READABLE is non-zero, the list is formatted in + such a way that it can be made part of an `inputrc' file and + re-read. + + - Function: int rl_set_paren_blink_timeout (int u) + Set the time interval (in microseconds) that Readline waits when + showing a balancing character when `blink-matching-paren' has been + enabled. + + - Function: char * rl_get_termcap (const char *cap) + Retrieve the string value of the termcap capability CAP. Readline + fetches the termcap entry for the current terminal name and uses + those capabilities to move around the screen line and perform other + terminal-specific operations, like erasing a line. Readline does + not use all of a terminal's capabilities, and this function will + return values for only those capabilities Readline uses. + + +File: readline.info, Node: Alternate Interface, Next: A Readline Example, Prev: Miscellaneous Functions, Up: Readline Convenience Functions Alternate Interface ------------------- @@ -1900,28 +2303,39 @@ various file descriptors. To accomodate this need, readline can also be invoked as a `callback' function from an event loop. There are functions available to make this easy. - - Function: void rl_callback_handler_install (char *prompt, Vfunction - *lhandler) + - Function: void rl_callback_handler_install (const char *prompt, + rl_vcpfunc_t *lhandler) Set up the terminal for readline I/O and display the initial expanded value of PROMPT. Save the value of LHANDLER to use as a - callback when a complete line of input has been entered. + function to call when a complete line of input has been entered. + The function takes the text of the line as an argument. - - Function: void rl_callback_read_char () + - Function: void rl_callback_read_char (void) Whenever an application determines that keyboard input is available, it should call `rl_callback_read_char()', which will read the next character from the current input source. If that character completes the line, `rl_callback_read_char' will invoke the LHANDLER function saved by `rl_callback_handler_install' to - process the line. `EOF' is indicated by calling LHANDLER with a - `NULL' line. + process the line. Before calling the LHANDLER function, the + terminal settings are reset to the values they had before calling + `rl_callback_handler_install'. If the LHANDLER function returns, + the terminal settings are modified for Readline's use again. + `EOF' is indicated by calling LHANDLER with a `NULL' line. - - Function: void rl_callback_handler_remove () + - Function: void rl_callback_handler_remove (void) Restore the terminal to its initial state and remove the line handler. This may be called from within a callback as well as - independently. + independently. If the LHANDLER installed by + `rl_callback_handler_install' does not exit the program, either + this function or the function referred to by the value of + `rl_deprep_term_function' should be called before the program + exits to reset the terminal settings. -An Example ----------- + +File: readline.info, Node: A Readline Example, Prev: Alternate Interface, Up: Readline Convenience Functions + +A Readline Example +------------------ Here is a function which changes lowercase characters to their uppercase equivalents, and uppercase characters to lowercase. If this @@ -1969,16 +2383,16 @@ changed. end = temp; } - /* Tell readline that we are modifying the line, so it will save - the undo information. */ + /* Tell readline that we are modifying the line, + so it will save the undo information. */ rl_modifying (start, end); for (i = start; i != end; i++) { - if (uppercase_p (rl_line_buffer[i])) - rl_line_buffer[i] = to_lower (rl_line_buffer[i]); - else if (lowercase_p (rl_line_buffer[i])) - rl_line_buffer[i] = to_upper (rl_line_buffer[i]); + if (_rl_uppercase_p (rl_line_buffer[i])) + rl_line_buffer[i] = _rl_to_lower (rl_line_buffer[i]); + else if (_rl_lowercase_p (rl_line_buffer[i])) + rl_line_buffer[i] = _rl_to_upper (rl_line_buffer[i]); } /* Move point to on top of the last character changed. */ rl_point = (direction == 1) ? end - 1 : start; @@ -1997,39 +2411,39 @@ exceptional events, like a user pressing the interrupt key on his terminal, or a network connection being broken. There is a class of signals that can be sent to the process currently reading input from the keyboard. Since Readline changes the terminal attributes when it -is called, it needs to perform special processing when a signal is -received to restore the terminal to a sane state, or provide application -writers with functions to do so manually. +is called, it needs to perform special processing when such a signal is +received in order to restore the terminal to a sane state, or provide +application writers with functions to do so manually. Readline contains an internal signal handler that is installed for a number of signals (`SIGINT', `SIGQUIT', `SIGTERM', `SIGALRM', `SIGTSTP', `SIGTTIN', and `SIGTTOU'). When one of these signals is received, the signal handler will reset the terminal attributes to -those that were in effect before `readline ()' was called, reset the -signal handling to what it was before `readline ()' was called, and +those that were in effect before `readline()' was called, reset the +signal handling to what it was before `readline()' was called, and resend the signal to the calling application. If and when the calling application's signal handler returns, Readline will reinitialize the terminal and continue to accept input. When a `SIGINT' is received, the Readline signal handler performs some additional work, which will cause any partially-entered line to be aborted (see the description of -`rl_free_line_state ()'). +`rl_free_line_state()' below). There is an additional Readline signal handler, for `SIGWINCH', which the kernel sends to a process whenever the terminal's size changes (for example, if a user resizes an `xterm'). The Readline `SIGWINCH' -handler updates Readline's internal screen size state, and then calls -any `SIGWINCH' signal handler the calling application has installed. -Readline calls the application's `SIGWINCH' signal handler without -resetting the terminal to its original state. If the application's -signal handler does more than update its idea of the terminal size and -return (for example, a `longjmp' back to a main processing loop), it -*must* call `rl_cleanup_after_signal ()' (described below), to restore -the terminal state. +handler updates Readline's internal screen size information, and then +calls any `SIGWINCH' signal handler the calling application has +installed. Readline calls the application's `SIGWINCH' signal handler +without resetting the terminal to its original state. If the +application's signal handler does more than update its idea of the +terminal size and return (for example, a `longjmp' back to a main +processing loop), it _must_ call `rl_cleanup_after_signal()' (described +below), to restore the terminal state. Readline provides two variables that allow application writers to control whether or not it will catch certain signals and act on them when they are received. It is important that applications change the -values of these variables only when calling `readline ()', not in a +values of these variables only when calling `readline()', not in a signal handler, so Readline's internal signal state is not corrupted. - Variable: int rl_catch_signals @@ -2052,7 +2466,7 @@ terminal and internal state cleanup upon receipt of a signal. - Function: void rl_cleanup_after_signal (void) This function will reset the state of the terminal to what it was - before `readline ()' was called, and remove the Readline signal + before `readline()' was called, and remove the Readline signal handlers for all signals, depending on the values of `rl_catch_signals' and `rl_catch_sigwinch'. @@ -2061,7 +2475,7 @@ terminal and internal state cleanup upon receipt of a signal. line (undo information, any partial history entry, any partially-entered keyboard macro, and any partially-entered numeric argument). This should be called before - `rl_cleanup_after_signal ()'. The Readline signal handler for + `rl_cleanup_after_signal()'. The Readline signal handler for `SIGINT' calls this to abort the current input line. - Function: void rl_reset_after_signal (void) @@ -2070,11 +2484,24 @@ terminal and internal state cleanup upon receipt of a signal. `rl_catch_sigwinch'. If an application does not wish Readline to catch `SIGWINCH', it may -call `rl_resize_terminal ()' to force Readline to update its idea of -the terminal size when a `SIGWINCH' is received. +call `rl_resize_terminal()' or `rl_set_screen_size()' to force Readline +to update its idea of the terminal size when a `SIGWINCH' is received. - Function: void rl_resize_terminal (void) - Update Readline's internal screen size. + Update Readline's internal screen size by reading values from the + kernel. + + - Function: void rl_set_screen_size (int rows, int cols) + Set Readline's idea of the terminal size to ROWS rows and COLS + columns. + + If an application does not want to install a `SIGWINCH' handler, but +is still interested in the screen dimensions, Readline's idea of the +screen size may be queried. + + - Function: void rl_get_screen_size (int *rows, int *cols) + Return Readline's idea of the terminal's size in the variables + pointed to by the arguments. The following functions install and remove Readline's signal handlers. @@ -2087,7 +2514,7 @@ handlers. - Function: int rl_clear_signals (void) Remove all of the Readline signal handlers installed by - `rl_set_signals ()'. + `rl_set_signals()'. File: readline.info, Node: Custom Completers, Prev: Readline Signal Handling, Up: Programming with GNU Readline @@ -2125,32 +2552,31 @@ functions must do, and provides an example. There are three major functions used to perform completion: - 1. The user-interface function `rl_complete ()'. This function is - called with the same arguments as other Readline functions - intended for interactive use: COUNT and INVOKING_KEY. It - isolates the word to be completed and calls `completion_matches - ()' to generate a list of possible completions. It then either - lists the possible completions, inserts the possible completions, - or actually performs the completion, depending on which behavior - is desired. - - 2. The internal function `completion_matches ()' uses your - "generator" function to generate the list of possible matches, and - then returns the array of these matches. You should place the - address of your generator function in + 1. The user-interface function `rl_complete()'. This function is + called with the same arguments as other bindable Readline + functions: COUNT and INVOKING_KEY. It isolates the word to be + completed and calls `rl_completion_matches()' to generate a list + of possible completions. It then either lists the possible + completions, inserts the possible completions, or actually + performs the completion, depending on which behavior is desired. + + 2. The internal function `rl_completion_matches()' uses an + application-supplied "generator" function to generate the list of + possible matches, and then returns the array of these matches. + The caller should place the address of its generator function in `rl_completion_entry_function'. 3. The generator function is called repeatedly from - `completion_matches ()', returning a string each time. The + `rl_completion_matches()', returning a string each time. The arguments to the generator function are TEXT and STATE. TEXT is the partial word to be completed. STATE is zero the first time the function is called, allowing the generator to perform any necessary initialization, and a positive non-zero integer for each - subsequent call. When the generator function returns `(char - *)NULL' this signals `completion_matches ()' that there are no - more possibilities left. Usually the generator function computes - the list of possible completions when STATE is zero, and returns - them one at a time on subsequent calls. Each string the generator + subsequent call. The generator function returns `(char *)NULL' to + inform `rl_completion_matches()' that there are no more + possibilities left. Usually the generator function computes the + list of possible completions when STATE is zero, and returns them + one at a time on subsequent calls. Each string the generator function returns as a match must be allocated with `malloc()'; Readline frees the strings when it has finished with them. @@ -2158,14 +2584,14 @@ functions must do, and provides an example. - Function: int rl_complete (int ignore, int invoking_key) Complete the word at or before point. You have supplied the function that does the initial simple matching selection algorithm - (see `completion_matches ()'). The default is to do filename + (see `rl_completion_matches()'). The default is to do filename completion. - - Variable: Function * rl_completion_entry_function - This is a pointer to the generator function for `completion_matches - ()'. If the value of `rl_completion_entry_function' is `(Function - *)NULL' then the default filename generator function, - `filename_completion_function ()', is used. + - Variable: rl_compentry_func_t * rl_completion_entry_function + This is a pointer to the generator function for + `rl_completion_matches()'. If the value of + `rl_completion_entry_function' is `NULL' then the default filename + generator function, `rl_filename_completion_function()', is used. File: readline.info, Node: Completion Functions, Next: Completion Variables, Prev: How Completing Works, Up: Custom Completers @@ -2187,42 +2613,50 @@ Readline. - Function: int rl_complete (int ignore, int invoking_key) Complete the word at or before point. You have supplied the function that does the initial simple matching selection algorithm - (see `completion_matches ()' and `rl_completion_entry_function'). + (see `rl_completion_matches()' and `rl_completion_entry_function'). The default is to do filename completion. This calls - `rl_complete_internal ()' with an argument depending on + `rl_complete_internal()' with an argument depending on INVOKING_KEY. - - Function: int rl_possible_completions (int count, int invoking_key)) + - Function: int rl_possible_completions (int count, int invoking_key) List the possible completions. See description of `rl_complete - ()'. This calls `rl_complete_internal ()' with an argument of `?'. + ()'. This calls `rl_complete_internal()' with an argument of `?'. - - Function: int rl_insert_completions (int count, int invoking_key)) + - Function: int rl_insert_completions (int count, int invoking_key) Insert the list of possible completions into the line, deleting the - partially-completed word. See description of `rl_complete ()'. - This calls `rl_complete_internal ()' with an argument of `*'. - - - Function: char ** completion_matches (char *text, CPFunction - *entry_func) - Returns an array of `(char *)' which is a list of completions for - TEXT. If there are no completions, returns `(char **)NULL'. The - first entry in the returned array is the substitution for TEXT. - The remaining entries are the possible completions. The array is + partially-completed word. See description of `rl_complete()'. + This calls `rl_complete_internal()' with an argument of `*'. + + - Function: int rl_completion_mode (rl_command_func_t *cfunc) + Returns the apppriate value to pass to `rl_complete_internal()' + depending on whether CFUNC was called twice in succession and the + value of the `show-all-if-ambiguous' variable. + Application-specific completion functions may use this function to + present the same interface as `rl_complete()'. + + - Function: char ** rl_completion_matches (const char *text, + rl_compentry_func_t *entry_func) + Returns an array of strings which is a list of completions for + TEXT. If there are no completions, returns `NULL'. The first + entry in the returned array is the substitution for TEXT. The + remaining entries are the possible completions. The array is terminated with a `NULL' pointer. - ENTRY_FUNC is a function of two args, and returns a `(char *)'. - The first argument is TEXT. The second is a state argument; it is + ENTRY_FUNC is a function of two args, and returns a `char *'. The + first argument is TEXT. The second is a state argument; it is zero on the first call, and non-zero on subsequent calls. ENTRY_FUNC returns a `NULL' pointer to the caller when there are no more matches. - - Function: char * filename_completion_function (char *text, int state) + - Function: char * rl_filename_completion_function (const char *text, + int state) A generator function for filename completion in the general case. - Note that completion in Bash is a little different because of all - the pathnames that must be followed when looking up completions - for a command. The Bash source is a useful reference for writing - custom completion functions. + TEXT is a partial filename. The Bash source is a useful reference + for writing custom completion functions (the Bash completion + functions call this and other Readline functions). - - Function: char * username_completion_function (char *text, int state) + - Function: char * rl_username_completion_function (const char *text, + int state) A completion generator for usernames. TEXT contains a partial username preceded by a random character (usually `~'). As with all completion generators, STATE is zero on the first call and non-zero @@ -2234,23 +2668,26 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam Completion Variables -------------------- - - Variable: Function * rl_completion_entry_function - A pointer to the generator function for `completion_matches ()'. - `NULL' means to use `filename_completion_function ()', the default - filename completer. + - Variable: rl_compentry_func_t * rl_completion_entry_function + A pointer to the generator function for `rl_completion_matches()'. + `NULL' means to use `rl_filename_completion_function()', the + default filename completer. - - Variable: CPPFunction * rl_attempted_completion_function + - Variable: rl_completion_func_t * rl_attempted_completion_function A pointer to an alternative function to create matches. The function is called with TEXT, START, and END. START and END are - indices in `rl_line_buffer' saying what the boundaries of TEXT - are. If this function exists and returns `NULL', or if this - variable is set to `NULL', then `rl_complete ()' will call the - value of `rl_completion_entry_function' to generate matches, - otherwise the array of strings returned will be used. - - - Variable: CPFunction * rl_filename_quoting_function + indices in `rl_line_buffer' defining the boundaries of TEXT, which + is a character string. If this function exists and returns + `NULL', or if this variable is set to `NULL', then `rl_complete()' + will call the value of `rl_completion_entry_function' to generate + matches, otherwise the array of strings returned will be used. If + this function sets the `rl_attempted_completion_over' variable to + a non-zero value, Readline will not perform its default completion + even if this function returns no matches. + + - Variable: rl_quote_func_t * rl_filename_quoting_function A pointer to a function that will quote a filename in an - application- specific fashion. This is called if filename + application-specific fashion. This is called if filename completion is being attempted and one of the characters in `rl_filename_quote_characters' appears in a completed filename. The function is called with TEXT, MATCH_TYPE, and QUOTE_POINTER. @@ -2261,7 +2698,7 @@ Completion Variables to any opening quote character the user typed. Some functions choose to reset this character. - - Variable: CPFunction * rl_filename_dequoting_function + - Variable: rl_dequote_func_t * rl_filename_dequoting_function A pointer to a function that will remove application-specific quoting characters from a filename before completion is attempted, so those characters do not interfere with matching the text @@ -2270,53 +2707,87 @@ Completion Variables character that delimits the filename (usually `'' or `"'). If QUOTE_CHAR is zero, the filename was not in an embedded string. - - Variable: Function * rl_char_is_quoted_p + - Variable: rl_linebuf_func_t * rl_char_is_quoted_p A pointer to a function to call that determines whether or not a specific character in the line buffer is quoted, according to - whatever quoting mechanism the program calling readline uses. The + whatever quoting mechanism the program calling Readline uses. The function is called with two arguments: TEXT, the text of the line, and INDEX, the index of the character in the line. It is used to decide whether a character found in `rl_completer_word_break_characters' should be used to break words for the completer. - - Variable: int rl_completion_query_items - Up to this many items will be displayed in response to a - possible-completions call. After that, we ask the user if she is - sure she wants to see them all. The default value is 100. + - Variable: rl_compignore_func_t * rl_ignore_some_completions_function + This function, if defined, is called by the completer when real + filename completion is done, after all the matching names have + been generated. It is passed a `NULL' terminated array of matches. + The first element (`matches[0]') is the maximal substring common + to all matches. This function can re-arrange the list of matches + as required, but each element deleted from the array must be freed. - - Variable: char * rl_basic_word_break_characters + - Variable: rl_icppfunc_t * rl_directory_completion_hook + This function, if defined, is allowed to modify the directory + portion of filenames Readline completes. It is called with the + address of a string (the current directory name) as an argument, + and may modify that string. If the string is replaced with a new + string, the old value should be freed. Any modified directory + name should have a trailing slash. The modified value will be + displayed as part of the completion, replacing the directory + portion of the pathname the user typed. It returns an integer + that should be non-zero if the function modifies its directory + argument. It could be used to expand symbolic links or shell + variables in pathnames. + + - Variable: rl_compdisp_func_t * rl_completion_display_matches_hook + If non-zero, then this is the address of a function to call when + completing a word would normally display the list of possible + matches. This function is called in lieu of Readline displaying + the list. It takes three arguments: (`char **'MATCHES, `int' + NUM_MATCHES, `int' MAX_LENGTH) where MATCHES is the array of + matching strings, NUM_MATCHES is the number of strings in that + array, and MAX_LENGTH is the length of the longest string in that + array. Readline provides a convenience function, + `rl_display_match_list', that takes care of doing the display to + Readline's output stream. That function may be called from this + hook. + + - Variable: const char * rl_basic_word_break_characters The basic list of characters that signal a break between words for the completer routine. The default value of this variable is the - characters which break words for completion in Bash, i.e., `" + characters which break words for completion in Bash: `" \t\n\"\\'`@$><=;|&{("'. - - Variable: char * rl_basic_quote_characters - List of quote characters which can cause a word break. + - Variable: const char * rl_basic_quote_characters + A list of quote characters which can cause a word break. - - Variable: char * rl_completer_word_break_characters + - Variable: const char * rl_completer_word_break_characters The list of characters that signal a break between words for - `rl_complete_internal ()'. The default list is the value of + `rl_complete_internal()'. The default list is the value of `rl_basic_word_break_characters'. - - Variable: char * rl_completer_quote_characters - List of characters which can be used to quote a substring of the + - Variable: const char * rl_completer_quote_characters + A list of characters which can be used to quote a substring of the line. Completion occurs on the entire substring, and within the substring `rl_completer_word_break_characters' are treated as any other character, unless they also appear within this list. - - Variable: char * rl_filename_quote_characters + - Variable: const char * rl_filename_quote_characters A list of characters that cause a filename to be quoted by the completer when they appear in a completed filename. The default is the null string. - - Variable: char * rl_special_prefixes + - Variable: const char * rl_special_prefixes The list of characters that are word break characters, but should be left in TEXT when it is passed to the completion function. Programs can use this to help determine what kind of completing to do. For instance, Bash sets this variable to "$@" so that it can complete shell variables and hostnames. + - Variable: int rl_completion_query_items + Up to this many items will be displayed in response to a + possible-completions call. After that, we ask the user if she is + sure she wants to see them all. The default value is 100. + - Variable: int rl_completion_append_character When a single completion alternative matches at the end of the command line, this character is appended to the inserted @@ -2326,60 +2797,63 @@ Completion Variables to provide the "most sensible word separator character" according to an application-specific command line syntax specification. + - Variable: int rl_completion_suppress_append + If non-zero, RL_COMPLETION_APPEND_CHARACTER is not appended to + matches at the end of the command line, as described above. It is + set to 0 before any application-specific completion function is + called. + + - Variable: int rl_completion_mark_symlink_dirs + If non-zero, a slash will be appended to completed filenames that + are symbolic links to directory names, subject to the value of the + user-settable MARK-DIRECTORIES variable. This variable exists so + that application completion functions can override the user's + global preference (set via the MARK-SYMLINKED-DIRECTORIES Readline + variable) if appropriate. This variable is set to the user's + preference before any application completion function is called, + so unless that function modifies the value, the user's preferences + are honored. + - Variable: int rl_ignore_completion_duplicates - If non-zero, then disallow duplicates in the matches. Default is - 1. + If non-zero, then duplicates in the matches are removed. The + default is 1. - Variable: int rl_filename_completion_desired Non-zero means that the results of the matches are to be treated as - filenames. This is *always* zero on entry, and can only be changed + filenames. This is _always_ zero on entry, and can only be changed within a completion entry generator function. If it is set to a non-zero value, directory names have a slash appended and Readline - attempts to quote completed filenames if they contain any embedded - word break characters. + attempts to quote completed filenames if they contain any + characters in `rl_filename_quote_characters' and + `rl_filename_quoting_desired' is set to a non-zero value. - Variable: int rl_filename_quoting_desired Non-zero means that the results of the matches are to be quoted using double quotes (or an application-specific quoting mechanism) if the completed filename contains any characters in - `rl_filename_quote_chars'. This is *always* non-zero on entry, + `rl_filename_quote_chars'. This is _always_ non-zero on entry, and can only be changed within a completion entry generator function. The quoting is effected via a call to the function pointed to by `rl_filename_quoting_function'. + - Variable: int rl_attempted_completion_over + If an application-specific completion function assigned to + `rl_attempted_completion_function' sets this variable to a non-zero + value, Readline will not perform its default filename completion + even if the application's completion function returns no matches. + It should be set only by an application's completion function. + + - Variable: int rl_completion_type + Set to a character describing the type of completion Readline is + currently attempting; see the description of + `rl_complete_internal()' (*note Completion Functions::) for the + list of characters. + - Variable: int rl_inhibit_completion - If this variable is non-zero, completion is inhibit<ed. The + If this variable is non-zero, completion is inhibited. The completion character will be inserted as any other bound to `self-insert'. - - Variable: Function * rl_ignore_some_completions_function - This function, if defined, is called by the completer when real - filename completion is done, after all the matching names have - been generated. It is passed a `NULL' terminated array of matches. - The first element (`matches[0]') is the maximal substring common - to all matches. This function can re-arrange the list of matches - as required, but each element deleted from the array must be freed. - - - Variable: Function * rl_directory_completion_hook - This function, if defined, is allowed to modify the directory - portion of filenames Readline completes. It is called with the - address of a string (the current directory name) as an argument. - It could be used to expand symbolic links or shell variables in - pathnames. - - - Variable: VFunction * rl_completion_display_matches_hook - If non-zero, then this is the address of a function to call when - completing a word would normally display the list of possible - matches. This function is called in lieu of Readline displaying - the list. It takes three arguments: (`char **'MATCHES, `int' - NUM_MATCHES, `int' MAX_LENGTH) where MATCHES is the array of - matching strings, NUM_MATCHES is the number of strings in that - array, and MAX_LENGTH is the length of the longest string in that - array. Readline provides a convenience function, - `rl_display_match_list', that takes care of doing the display to - Readline's output stream. That function may be called from this - hook. - File: readline.info, Node: A Short Completion Example, Prev: Completion Variables, Up: Custom Completers @@ -2404,19 +2878,25 @@ command names, line editing features, and access to the history list. #include <readline/readline.h> #include <readline/history.h> - extern char *getwd (); extern char *xmalloc (); /* The names of functions that actually do the manipulation. */ - int com_list (), com_view (), com_rename (), com_stat (), com_pwd (); - int com_delete (), com_help (), com_cd (), com_quit (); + int com_list __P((char *)); + int com_view __P((char *)); + int com_rename __P((char *)); + int com_stat __P((char *)); + int com_pwd __P((char *)); + int com_delete __P((char *)); + int com_help __P((char *)); + int com_cd __P((char *)); + int com_quit __P((char *)); /* A structure which contains information on the commands this program can understand. */ typedef struct { char *name; /* User printable name of the function. */ - Function *func; /* Function to call to do the job. */ + rl_icpfunc_t *func; /* Function to call to do the job. */ char *doc; /* Documentation for this function. */ } COMMAND; @@ -2432,7 +2912,7 @@ command names, line editing features, and access to the history list. { "rename", com_rename, "Rename FILE to NEWNAME" }, { "stat", com_stat, "Print out statistics on FILE" }, { "view", com_view, "View the contents of FILE" }, - { (char *)NULL, (Function *)NULL, (char *)NULL } + { (char *)NULL, (rl_icpfunc_t *)NULL, (char *)NULL } }; /* Forward declarations. */ @@ -2442,7 +2922,7 @@ command names, line editing features, and access to the history list. /* The name of this program, as taken from argv[0]. */ char *progname; - /* When non-zero, this global means the user is done using this program. */ + /* When non-zero, this means the user is done using this program. */ int done; char * @@ -2572,29 +3052,29 @@ command names, line editing features, and access to the history list. /* */ /* **************************************************************** */ - char *command_generator (); - char **fileman_completion (); + char *command_generator __P((const char *, int)); + char **fileman_completion __P((const char *, int, int)); - /* Tell the GNU Readline library how to complete. We want to try to complete - on command names if this is the first word in the line, or on filenames - if not. */ + /* Tell the GNU Readline library how to complete. We want to try to + complete on command names if this is the first word in the line, or + on filenames if not. */ initialize_readline () { /* Allow conditional parsing of the ~/.inputrc file. */ rl_readline_name = "FileMan"; /* Tell the completer that we want a crack first. */ - rl_attempted_completion_function = (CPPFunction *)fileman_completion; + rl_attempted_completion_function = fileman_completion; } - /* Attempt to complete on the contents of TEXT. START and END bound the - region of rl_line_buffer that contains the word to complete. TEXT is - the word to complete. We can use the entire contents of rl_line_buffer - in case we want to do some simple parsing. Return the array of matches, - or NULL if there aren't any. */ + /* Attempt to complete on the contents of TEXT. START and END + bound the region of rl_line_buffer that contains the word to + complete. TEXT is the word to complete. We can use the entire + contents of rl_line_buffer in case we want to do some simple + parsing. Returnthe array of matches, or NULL if there aren't any. */ char ** fileman_completion (text, start, end) - char *text; + const char *text; int start, end; { char **matches; @@ -2605,32 +3085,33 @@ command names, line editing features, and access to the history list. to complete. Otherwise it is the name of a file in the current directory. */ if (start == 0) - matches = completion_matches (text, command_generator); + matches = rl_completion_matches (text, command_generator); return (matches); } - /* Generator function for command completion. STATE lets us know whether - to start from scratch; without any state (i.e. STATE == 0), then we - start at the top of the list. */ + /* Generator function for command completion. STATE lets us + know whether to start from scratch; without any state + (i.e. STATE == 0), then we start at the top of the list. */ char * command_generator (text, state) - char *text; + const char *text; int state; { static int list_index, len; char *name; - /* If this is a new word to complete, initialize now. This includes - saving the length of TEXT for efficiency, and initializing the index - variable to 0. */ + /* If this is a new word to complete, initialize now. This + includes saving the length of TEXT for efficiency, and + initializing the index variable to 0. */ if (!state) { list_index = 0; len = strlen (text); } - /* Return the next name which partially matches from the command list. */ + /* Return the next name which partially matches from the + command list. */ while (name = commands[list_index].name) { list_index++; @@ -2775,7 +3256,7 @@ command names, line editing features, and access to the history list. { char dir[1024], *s; - s = getwd (dir); + s = getcwd (dir, sizeof(dir) - 1); if (s == 0) { printf ("Error getting pwd: %s\n", dir); @@ -2786,7 +3267,8 @@ command names, line editing features, and access to the history list. return 0; } - /* The user wishes to quit using this program. Just set DONE non-zero. */ + /* The user wishes to quit using this program. Just set DONE + non-zero. */ com_quit (arg) char *arg; { @@ -2799,12 +3281,13 @@ command names, line editing features, and access to the history list. char *caller; { fprintf (stderr, - "%s: Too dangerous for me to distribute. Write it yourself.\n", + "%s: Too dangerous for me to distribute.\n" caller); + fprintf (stderr, "Write it yourself.\n"); } - /* Return non-zero if ARG is a valid argument for CALLER, else print - an error message and return zero. */ + /* Return non-zero if ARG is a valid argument for CALLER, + else print an error message and return zero. */ int valid_argument (caller, arg) char *caller, *arg; @@ -2834,6 +3317,7 @@ Concept Index * killing text: Readline Killing Commands. * notation, readline: Readline Bare Essentials. * readline, function: Basic Behavior. +* variables, readline: Readline Init File Syntax. * yanking text: Readline Killing Commands. @@ -2844,13 +3328,18 @@ Function and Variable Index * Menu: +* _rl_digit_p: Utility Functions. +* _rl_digit_value: Utility Functions. +* _rl_lowercase_p: Utility Functions. +* _rl_to_lower: Utility Functions. +* _rl_to_upper: Utility Functions. +* _rl_uppercase_p: Utility Functions. * abort (C-g): Miscellaneous Commands. -* accept-line (Newline, Return): Commands For History. -* alphabetic: Utility Functions. +* accept-line (Newline or Return): Commands For History. * backward-char (C-b): Commands For Moving. * backward-delete-char (Rubout): Commands For Text. * backward-kill-line (C-x Rubout): Commands For Killing. -* backward-kill-word (M-DEL): Commands For Killing. +* backward-kill-word (M-<DEL>): Commands For Killing. * backward-word (M-b): Commands For Moving. * beginning-of-history (M-<): Commands For History. * beginning-of-line (C-a): Commands For Moving. @@ -2861,9 +3350,8 @@ Function and Variable Index * character-search-backward (M-C-]): Miscellaneous Commands. * clear-screen (C-l): Commands For Moving. * comment-begin: Readline Init File Syntax. -* complete (TAB): Commands For Completion. +* complete (<TAB>): Commands For Completion. * completion-query-items: Readline Init File Syntax. -* completion_matches: Completion Functions. * convert-meta: Readline Init File Syntax. * copy-backward-word (): Commands For Killing. * copy-forward-word (): Commands For Killing. @@ -2872,9 +3360,6 @@ Function and Variable Index * delete-char-or-list (): Commands For Completion. * delete-horizontal-space (): Commands For Killing. * digit-argument (M-0, M-1, ... M--): Numeric Arguments. -* digit_p: Utility Functions. -* digit_value: Utility Functions. -* ding: Utility Functions. * disable-completion: Readline Init File Syntax. * do-uppercase-version (M-a, M-b, M-X, ...): Miscellaneous Commands. * downcase-word (M-l): Commands For Text. @@ -2888,12 +3373,11 @@ Function and Variable Index * end-of-line (C-e): Commands For Moving. * exchange-point-and-mark (C-x C-x): Miscellaneous Commands. * expand-tilde: Readline Init File Syntax. -* filename_completion_function: Completion Functions. * forward-backward-delete-char (): Commands For Text. * forward-char (C-f): Commands For Moving. * forward-search-history (C-s): Commands For History. * forward-word (M-f): Commands For Moving. -* free_undo_list: Allowing Undoing. +* history-preserve-point: Readline Init File Syntax. * history-search-backward (): Commands For History. * history-search-forward (): Commands For History. * horizontal-scroll-mode: Readline Init File Syntax. @@ -2906,28 +3390,33 @@ Function and Variable Index * kill-region (): Commands For Killing. * kill-whole-line (): Commands For Killing. * kill-word (M-d): Commands For Killing. -* lowercase_p: Utility Functions. * mark-modified-lines: Readline Init File Syntax. +* mark-symlinked-directories: Readline Init File Syntax. +* match-hidden-files: Readline Init File Syntax. * menu-complete (): Commands For Completion. * meta-flag: Readline Init File Syntax. * next-history (C-n): Commands For History. * non-incremental-forward-search-history (M-n): Commands For History. * non-incremental-reverse-search-history (M-p): Commands For History. -* numeric: Utility Functions. * output-meta: Readline Init File Syntax. +* overwrite-mode (): Commands For Text. +* page-completions: Readline Init File Syntax. * possible-completions (M-?): Commands For Completion. -* prefix-meta (ESC): Miscellaneous Commands. +* prefix-meta (<ESC>): Miscellaneous Commands. * previous-history (C-p): Commands For History. -* quoted-insert (C-q, C-v): Commands For Text. +* quoted-insert (C-q or C-v): Commands For Text. * re-read-init-file (C-x C-r): Miscellaneous Commands. * readline: Basic Behavior. * redraw-current-line (): Commands For Moving. * reverse-search-history (C-r): Commands For History. * revert-line (M-r): Miscellaneous Commands. * rl_add_defun: Function Naming. +* rl_add_funmap_entry: Associating Function Names and Bindings. * rl_add_undo: Allowing Undoing. +* rl_alphabetic: Utility Functions. * rl_already_prompted: Readline Variables. * rl_attempted_completion_function: Completion Variables. +* rl_attempted_completion_over: Completion Variables. * rl_basic_quote_characters: Completion Variables. * rl_basic_word_break_characters: Completion Variables. * rl_begin_undo_group: Allowing Undoing. @@ -2942,9 +3431,10 @@ Function and Variable Index * rl_char_is_quoted_p: Completion Variables. * rl_cleanup_after_signal: Readline Signal Handling. * rl_clear_message: Redisplay. +* rl_clear_pending_input: Character Input. * rl_clear_signals: Readline Signal Handling. -* rl_complete <1>: Completion Functions. -* rl_complete: How Completing Works. +* rl_complete <1>: How Completing Works. +* rl_complete: Completion Functions. * rl_complete_internal: Completion Functions. * rl_completer_quote_characters: Completion Variables. * rl_completer_word_break_characters: Completion Variables. @@ -2952,28 +3442,45 @@ Function and Variable Index * rl_completion_display_matches_hook: Completion Variables. * rl_completion_entry_function <1>: Completion Variables. * rl_completion_entry_function: How Completing Works. +* rl_completion_mark_symlink_dirs: Completion Variables. +* rl_completion_matches: Completion Functions. +* rl_completion_mode: Completion Functions. * rl_completion_query_items: Completion Variables. +* rl_completion_suppress_append: Completion Variables. +* rl_completion_type: Completion Variables. * rl_copy_keymap: Keymaps. * rl_copy_text: Modifying Text. +* rl_crlf: Redisplay. * rl_delete_text: Modifying Text. +* rl_deprep_term_function: Readline Variables. +* rl_deprep_terminal: Terminal Management. +* rl_ding: Utility Functions. * rl_directory_completion_hook: Completion Variables. * rl_discard_keymap: Keymaps. +* rl_dispatching: Readline Variables. * rl_display_match_list: Utility Functions. * rl_do_undo: Allowing Undoing. * rl_done: Readline Variables. +* rl_editing_mode: Readline Variables. * rl_end: Readline Variables. * rl_end_undo_group: Allowing Undoing. * rl_erase_empty_line: Readline Variables. * rl_event_hook: Readline Variables. +* rl_execute_next: Character Input. * rl_executing_keymap: Readline Variables. +* rl_executing_macro: Readline Variables. +* rl_expand_prompt: Redisplay. +* rl_explicit_arg: Readline Variables. * rl_extend_line_buffer: Utility Functions. * rl_filename_completion_desired: Completion Variables. +* rl_filename_completion_function: Completion Functions. * rl_filename_dequoting_function: Completion Variables. * rl_filename_quote_characters: Completion Variables. * rl_filename_quoting_desired: Completion Variables. * rl_filename_quoting_function: Completion Variables. * rl_forced_update_display: Redisplay. * rl_free_line_state: Readline Signal Handling. +* rl_free_undo_list: Allowing Undoing. * rl_function_dumper: Associating Function Names and Bindings. * rl_function_of_keyseq: Associating Function Names and Bindings. * rl_funmap_names: Associating Function Names and Bindings. @@ -2981,8 +3488,11 @@ Function and Variable Index * rl_get_keymap: Keymaps. * rl_get_keymap_by_name: Keymaps. * rl_get_keymap_name: Keymaps. -* rl_getc: Utility Functions. +* rl_get_screen_size: Readline Signal Handling. +* rl_get_termcap: Miscellaneous Functions. +* rl_getc: Character Input. * rl_getc_function: Readline Variables. +* rl_gnu_readline_p: Readline Variables. * rl_ignore_completion_duplicates: Completion Variables. * rl_ignore_some_completions_function: Completion Variables. * rl_inhibit_completion: Completion Variables. @@ -2993,15 +3503,20 @@ Function and Variable Index * rl_invoking_keyseqs: Associating Function Names and Bindings. * rl_invoking_keyseqs_in_map: Associating Function Names and Bindings. * rl_kill_text: Modifying Text. +* rl_last_func: Readline Variables. * rl_library_version: Readline Variables. * rl_line_buffer: Readline Variables. * rl_list_funmap_names: Associating Function Names and Bindings. +* rl_macro_bind: Miscellaneous Functions. +* rl_macro_dumper: Miscellaneous Functions. * rl_make_bare_keymap: Keymaps. * rl_make_keymap: Keymaps. * rl_mark: Readline Variables. * rl_message: Redisplay. * rl_modifying: Allowing Undoing. * rl_named_function: Associating Function Names and Bindings. +* rl_num_chars_to_read: Readline Variables. +* rl_numeric_arg: Readline Variables. * rl_on_new_line: Redisplay. * rl_on_new_line_with_prompt: Redisplay. * rl_outstream: Readline Variables. @@ -3010,98 +3525,114 @@ Function and Variable Index * rl_point: Readline Variables. * rl_possible_completions: Completion Functions. * rl_pre_input_hook: Readline Variables. +* rl_prep_term_function: Readline Variables. +* rl_prep_terminal: Terminal Management. * rl_prompt: Readline Variables. +* rl_push_macro_input: Modifying Text. * rl_read_init_file: Binding Keys. -* rl_read_key: Utility Functions. +* rl_read_key: Character Input. * rl_readline_name: Readline Variables. +* rl_readline_state: Readline Variables. +* rl_readline_version: Readline Variables. * rl_redisplay: Redisplay. * rl_redisplay_function: Readline Variables. +* rl_replace_line: Utility Functions. * rl_reset_after_signal: Readline Signal Handling. * rl_reset_line_state: Redisplay. -* rl_reset_terminal: Utility Functions. +* rl_reset_terminal: Terminal Management. * rl_resize_terminal: Readline Signal Handling. * rl_restore_prompt: Redisplay. * rl_save_prompt: Redisplay. +* rl_set_key: Binding Keys. +* rl_set_keyboard_input_timeout: Character Input. * rl_set_keymap: Keymaps. +* rl_set_paren_blink_timeout: Miscellaneous Functions. +* rl_set_prompt: Redisplay. +* rl_set_screen_size: Readline Signal Handling. * rl_set_signals: Readline Signal Handling. +* rl_show_char: Redisplay. * rl_special_prefixes: Completion Variables. * rl_startup_hook: Readline Variables. -* rl_stuff_char: Utility Functions. +* rl_stuff_char: Character Input. * rl_terminal_name: Readline Variables. +* rl_tty_set_default_bindings: Terminal Management. * rl_unbind_command_in_map: Binding Keys. * rl_unbind_function_in_map: Binding Keys. * rl_unbind_key: Binding Keys. * rl_unbind_key_in_map: Binding Keys. +* rl_username_completion_function: Completion Functions. +* rl_variable_bind: Miscellaneous Functions. +* rl_variable_dumper: Miscellaneous Functions. * self-insert (a, b, A, 1, !, ...): Commands For Text. * set-mark (C-@): Miscellaneous Commands. * show-all-if-ambiguous: Readline Init File Syntax. * start-kbd-macro (C-x (): Keyboard Macros. -* to_lower: Utility Functions. -* to_upper: Utility Functions. * transpose-chars (C-t): Commands For Text. * transpose-words (M-t): Commands For Text. -* undo (C-_, C-x C-u): Miscellaneous Commands. +* undo (C-_ or C-x C-u): Miscellaneous Commands. * universal-argument (): Numeric Arguments. * unix-line-discard (C-u): Commands For Killing. * unix-word-rubout (C-w): Commands For Killing. * upcase-word (M-u): Commands For Text. -* uppercase_p: Utility Functions. -* username_completion_function: Completion Functions. * visible-stats: Readline Init File Syntax. * yank (C-y): Commands For Killing. -* yank-last-arg (M-., M-_): Commands For History. +* yank-last-arg (M-. or M-_): Commands For History. * yank-nth-arg (M-C-y): Commands For History. * yank-pop (M-y): Commands For Killing. Tag Table: -Node: Top1190 -Node: Command Line Editing1789 -Node: Introduction and Notation2440 -Node: Readline Interaction4058 -Node: Readline Bare Essentials5251 -Node: Readline Movement Commands7032 -Node: Readline Killing Commands7989 -Node: Readline Arguments9895 -Node: Searching10870 -Node: Readline Init File12713 -Node: Readline Init File Syntax13774 -Node: Conditional Init Constructs23039 -Node: Sample Init File25478 -Node: Bindable Readline Commands28648 -Node: Commands For Moving29692 -Node: Commands For History30541 -Node: Commands For Text33258 -Node: Commands For Killing35261 -Node: Numeric Arguments37228 -Node: Commands For Completion38355 -Node: Keyboard Macros40103 -Node: Miscellaneous Commands40662 -Node: Readline vi Mode43466 -Node: Programming with GNU Readline45236 -Node: Basic Behavior46204 -Node: Custom Functions49530 -Node: The Function Type50508 -Node: Function Writing51353 -Node: Readline Variables52437 -Node: Readline Convenience Functions56649 -Node: Function Naming57387 -Node: Keymaps58615 -Node: Binding Keys60329 -Node: Associating Function Names and Bindings62903 -Node: Allowing Undoing64746 -Node: Redisplay67331 -Node: Modifying Text69108 -Node: Utility Functions70019 -Node: Alternate Interface72799 -Node: Readline Signal Handling76093 -Node: Custom Completers81139 -Node: How Completing Works81854 -Node: Completion Functions84850 -Node: Completion Variables87865 -Node: A Short Completion Example95768 -Node: Concept Index108074 -Node: Function and Variable Index108828 +Node: Top1164 +Node: Command Line Editing1763 +Node: Introduction and Notation2414 +Node: Readline Interaction4032 +Node: Readline Bare Essentials5219 +Node: Readline Movement Commands7000 +Node: Readline Killing Commands7957 +Node: Readline Arguments9866 +Node: Searching10902 +Node: Readline Init File13045 +Node: Readline Init File Syntax14106 +Node: Conditional Init Constructs24989 +Node: Sample Init File27514 +Node: Bindable Readline Commands30698 +Node: Commands For Moving31748 +Node: Commands For History32597 +Node: Commands For Text35455 +Node: Commands For Killing38169 +Node: Numeric Arguments40120 +Node: Commands For Completion41248 +Node: Keyboard Macros42780 +Node: Miscellaneous Commands43339 +Node: Readline vi Mode46688 +Node: Programming with GNU Readline48506 +Node: Basic Behavior49474 +Node: Custom Functions52904 +Node: Readline Typedefs54382 +Node: Function Writing56011 +Node: Readline Variables57219 +Node: Readline Convenience Functions66642 +Node: Function Naming67624 +Node: Keymaps68876 +Node: Binding Keys70632 +Node: Associating Function Names and Bindings73558 +Node: Allowing Undoing75803 +Node: Redisplay78338 +Node: Modifying Text81409 +Node: Character Input82638 +Node: Terminal Management84418 +Node: Utility Functions85593 +Node: Miscellaneous Functions87932 +Node: Alternate Interface89996 +Node: A Readline Example92141 +Node: Readline Signal Handling94078 +Node: Custom Completers99681 +Node: How Completing Works100396 +Node: Completion Functions103394 +Node: Completion Variables106778 +Node: A Short Completion Example117049 +Node: Concept Index129602 +Node: Function and Variable Index130424 End Tag Table |