diff options
Diffstat (limited to 'doc/readline.info')
| -rw-r--r-- | doc/readline.info | 2120 |
1 files changed, 1090 insertions, 1030 deletions
diff --git a/doc/readline.info b/doc/readline.info index 4ea6b8c..64e7d6c 100644 --- a/doc/readline.info +++ b/doc/readline.info @@ -1,11 +1,10 @@ -This is readline.info, produced by makeinfo version 6.8 from rlman.texi. +This is readline.info, produced by makeinfo version 7.1 from rlman.texi. -This manual describes the GNU Readline Library (version 8.2, 19 -September 2022), a library which aids in the consistency of user -interface across discrete programs which provide a command line -interface. +This manual describes the GNU Readline Library (version 8.3, 19 January +2024), a library which aids in the consistency of user interface across +discrete programs which provide a command line interface. - Copyright (C) 1988-2022 Free Software Foundation, Inc. + Copyright © 1988-2022 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, @@ -67,10 +66,10 @@ File: readline.info, Node: Introduction and Notation, Next: Readline Interacti 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 @@ -81,11 +80,11 @@ 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" +_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 @@ -132,8 +131,8 @@ 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'. +‘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 for @@ -142,23 +141,23 @@ the cursor, characters to the right of the cursor are 'pulled 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 might 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 +delete the character underneath the cursor, like ‘C-d’, rather than the character to the left of the cursor.) @@ -169,22 +168,22 @@ File: readline.info, Node: Readline Movement Commands, Next: Readline Killing 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 <DEL>. +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 forward + 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. @@ -194,15 +193,15 @@ File: readline.info, Node: Readline Killing Commands, Next: Readline Arguments 1.2.3 Readline Killing Commands ------------------------------- -"Killing" text means to delete the text from the line, but to save it -away for later use, usually by "yanking" (re-inserting) it back into the +“Killing” text means to delete the text from the line, but to save it +away for later use, usually by “yanking” (re-inserting) it back into the line. ('Cut' and 'paste' are more recent jargon for 'kill' and 'yank'.) If the description for a command says that it 'kills' text, then you can be sure that you can get the text back in a different (or the same) place later. - When you use a kill command, the text is saved in a "kill-ring". Any + When you use a kill command, the text is saved in a “kill-ring”. Any number of consecutive kills save all of the killed text together, so that when you yank it back, you get it all. The kill ring is not line specific; the text that you killed on a previously typed line is @@ -210,34 +209,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>' +‘M-<DEL>’ Kill from the cursor to 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'. + are the 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. + than ‘M-<DEL>’ because the word boundaries differ. - Here is how to "yank" the text back into the line. Yanking means to + 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 @@ -250,14 +249,14 @@ argument acts as a repeat count, other times it is the sign of the argument that is significant. If you pass a negative argument to a command which normally acts in a forward direction, that command will act in a backward direction. For example, to kill text back to the -start of the line, you might type 'M-- C-k'. +start of the line, you might type ‘M-- C-k’. The general way to pass numeric arguments to a command is to type 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 +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', which will +‘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. @@ -268,24 +267,24 @@ File: readline.info, Node: Searching, Prev: Readline Arguments, Up: Readline 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 +‘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 abort +‘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 @@ -293,9 +292,9 @@ search and accept the line, thereby executing the command from the history list. A movement command will terminate the search, make the last line found the current line, and begin editing. - Readline remembers the last incremental search string. If two 'C-r's + 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. +string, Readline uses any remembered search string. Non-incremental searches read the entire search string before starting to search for matching history lines. The search string may be @@ -310,16 +309,16 @@ File: readline.info, Node: Readline Init File, Next: Bindable Readline Command Although the Readline library comes with a set of Emacs-like keybindings installed by default, it is possible to use a different set of keybindings. Any user can customize programs that use Readline by -putting commands in an "inputrc" file, conventionally in their home +putting commands in an “inputrc” file, conventionally in their home directory. The name of this file is taken from the value of the -environment variable 'INPUTRC'. If that variable is unset, the default -is '~/.inputrc'. If that file does not exist or cannot be read, the -ultimate default is '/etc/inputrc'. +environment variable ‘INPUTRC’. If that variable is unset, the default +is ‘~/.inputrc’. If that file does not exist or cannot be read, the +ultimate default is ‘/etc/inputrc’. When a program which uses the Readline library starts up, the init file is read, and the key bindings are set. - In addition, the 'C-x C-r' command re-reads this init file, thus + In addition, the ‘C-x C-r’ command re-reads this init file, thus incorporating any changes that you might have made to it. * Menu: @@ -337,20 +336,20 @@ File: readline.info, Node: Readline Init File Syntax, Next: Conditional Init C ------------------------------- 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 +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 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 + values of variables in Readline using the ‘set’ command within the 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: + binding to use ‘vi’ line editing commands: set editing-mode vi @@ -364,10 +363,10 @@ Variable Settings A great deal of run-time behavior is changeable with the following variables. - 'active-region-start-color' + ‘active-region-start-color’ A string variable that controls the text color and background when displaying the text in the active region (see the - description of 'enable-active-region' below). This string + description of ‘enable-active-region’ below). This string must not take up any physical character positions on the display, so it should consist only of terminal escape sequences. It is output to the terminal before displaying the @@ -375,11 +374,11 @@ Variable Settings default value whenever the terminal type changes. The default value is the string that puts the terminal in standout mode, as obtained from the terminal's terminfo description. A - sample value might be '\e[01;33m'. + sample value might be ‘\e[01;33m’. - 'active-region-end-color' + ‘active-region-end-color’ A string variable that "undoes" the effects of - 'active-region-start-color' and restores "normal" terminal + ‘active-region-start-color’ and restores "normal" terminal display appearance after displaying text in the active region. This string must not take up any physical character positions on the display, so it should consist only of terminal escape @@ -388,72 +387,75 @@ Variable Settings default value whenever the terminal type changes. The default value is the string that restores the terminal from standout mode, as obtained from the terminal's terminfo description. A - sample value might be '\e[0m'. + sample value might be ‘\e[0m’. - 'bell-style' + ‘bell-style’ Controls what happens when Readline wants to ring the terminal - bell. If set to 'none', Readline never rings the bell. If - set to 'visible', Readline uses a visible bell if one is - available. If set to 'audible' (the default), Readline + bell. If set to ‘none’, Readline never rings the bell. If + set to ‘visible’, Readline uses a visible bell if one is + available. If set to ‘audible’ (the default), Readline attempts to ring the terminal's bell. - 'bind-tty-special-chars' - If set to 'on' (the default), Readline attempts to bind the - control characters treated specially by the kernel's terminal - driver to their Readline equivalents. + ‘bind-tty-special-chars’ + If set to ‘on’ (the default), Readline attempts to bind the + control characters that are treated specially by the kernel's + terminal driver to their Readline equivalents. These override + the default Readline bindings described here. Type ‘stty -a’ + at a Bash prompt to see your current terminal settings, + including the special control characters (usually ‘cchars’). - 'blink-matching-paren' - If set to 'on', Readline attempts to briefly move the cursor + ‘blink-matching-paren’ + If set to ‘on’, Readline attempts to briefly move the cursor to an opening parenthesis when a closing parenthesis is - inserted. The default is 'off'. + inserted. The default is ‘off’. - 'colored-completion-prefix' - If set to 'on', when listing completions, Readline displays + ‘colored-completion-prefix’ + If set to ‘on’, when listing completions, Readline displays the common prefix of the set of possible completions using a different color. The color definitions are taken from the - value of the 'LS_COLORS' environment variable. If there is a - color definition in 'LS_COLORS' for the custom suffix - 'readline-colored-completion-prefix', Readline uses this color + value of the ‘LS_COLORS’ environment variable. If there is a + color definition in ‘LS_COLORS’ for the custom suffix + ‘readline-colored-completion-prefix’, Readline uses this color for the common prefix instead of its default. The default is - 'off'. + ‘off’. - 'colored-stats' - If set to 'on', Readline displays possible completions using + ‘colored-stats’ + If set to ‘on’, Readline displays possible completions using different colors to indicate their file type. The color - definitions are taken from the value of the 'LS_COLORS' - environment variable. The default is 'off'. + definitions are taken from the value of the ‘LS_COLORS’ + environment variable. The default is ‘off’. - 'comment-begin' + ‘comment-begin’ The string to insert at the beginning of the line when the - 'insert-comment' command is executed. The default value is - '"#"'. + ‘insert-comment’ command is executed. The default value is + ‘"#"’. - 'completion-display-width' + ‘completion-display-width’ The number of screen columns used to display possible matches when performing completion. The value is ignored if it is less than 0 or greater than the terminal screen width. A value of 0 will cause matches to be displayed one per line. The default value is -1. - 'completion-ignore-case' - If set to 'on', Readline performs filename matching and + ‘completion-ignore-case’ + If set to ‘on’, Readline performs filename matching and completion in a case-insensitive fashion. The default value - is 'off'. + is ‘off’. - 'completion-map-case' - If set to 'on', and COMPLETION-IGNORE-CASE is enabled, - Readline treats hyphens ('-') and underscores ('_') as + ‘completion-map-case’ + If set to ‘on’, and COMPLETION-IGNORE-CASE is enabled, + Readline treats hyphens (‘-’) and underscores (‘_’) as equivalent when performing case-insensitive filename matching - and completion. The default value is 'off'. + and completion. The default value is ‘off’. - 'completion-prefix-display-length' + ‘completion-prefix-display-length’ The length in characters of the common prefix of a list of possible completions that is displayed without modification. When set to a value greater than zero, common prefixes longer than this value are replaced with an ellipsis when displaying possible completions. - 'completion-query-items' + ‘completion-query-items’ The number of possible completions that determines when the user is asked whether the list of possibilities should be displayed. If the number of possible completions is greater @@ -462,88 +464,88 @@ Variable Settings listed. This variable must be set to an integer value greater than or equal to zero. A zero value means Readline should never ask; negative values are treated as zero. The default - limit is '100'. + limit is ‘100’. - 'convert-meta' - If set to 'on', Readline will convert characters with the + ‘convert-meta’ + If set to ‘on’, Readline will convert characters with the eighth bit set to an ASCII key sequence by stripping the eighth bit and prefixing an <ESC> character, converting them - to a meta-prefixed key sequence. The default value is 'on', - but will be set to 'off' if the locale is one that contains + to a meta-prefixed key sequence. The default value is ‘on’, + but will be set to ‘off’ if the locale is one that contains eight-bit characters. This variable is dependent on the - 'LC_CTYPE' locale category, and may change if the locale is + ‘LC_CTYPE’ locale category, and may change if the locale is changed. - 'disable-completion' - If set to 'On', Readline will inhibit word completion. + ‘disable-completion’ + If set to ‘On’, Readline will inhibit word completion. Completion characters will be inserted into the line as if - they had been mapped to 'self-insert'. The default is 'off'. + they had been mapped to ‘self-insert’. The default is ‘off’. - 'echo-control-characters' - When set to 'on', on operating systems that indicate they + ‘echo-control-characters’ + When set to ‘on’, on operating systems that indicate they support it, Readline echoes a character corresponding to a - signal generated from the keyboard. The default is 'on'. + signal generated from the keyboard. The default is ‘on’. - 'editing-mode' - The 'editing-mode' variable controls which default set of key + ‘editing-mode’ + The ‘editing-mode’ variable controls which default set of key bindings is used. By default, Readline starts up in Emacs editing mode, where the keystrokes are most similar to Emacs. - This variable can be set to either 'emacs' or 'vi'. + This variable can be set to either ‘emacs’ or ‘vi’. - 'emacs-mode-string' + ‘emacs-mode-string’ If the SHOW-MODE-IN-PROMPT variable is enabled, this string is displayed immediately before the last line of the primary prompt when emacs editing mode is active. The value is expanded like a key binding, so the standard set of meta- and control prefixes and backslash escape sequences is available. - Use the '\1' and '\2' escapes to begin and end sequences of + Use the ‘\1’ and ‘\2’ escapes to begin and end sequences of non-printing characters, which can be used to embed a terminal - control sequence into the mode string. The default is '@'. + control sequence into the mode string. The default is ‘@’. - 'enable-active-region' - The "point" is the current cursor position, and "mark" refers + ‘enable-active-region’ + The “point” is the current cursor position, and “mark” refers to a saved cursor position (*note Commands For Moving::). The text between the point and mark is referred to as the - "region". When this variable is set to 'On', Readline allows - certain commands to designate the region as "active". When + “region”. When this variable is set to ‘On’, Readline allows + certain commands to designate the region as “active”. When the region is active, Readline highlights the text in the - region using the value of the 'active-region-start-color', + region using the value of the ‘active-region-start-color’, which defaults to the string that enables the terminal's standout mode. The active region shows the text inserted by bracketed-paste and any matching text found by incremental and - non-incremental history searches. The default is 'On'. + non-incremental history searches. The default is ‘On’. - 'enable-bracketed-paste' - When set to 'On', Readline configures the terminal to insert + ‘enable-bracketed-paste’ + When set to ‘On’, Readline configures the terminal to insert each paste into the editing buffer as a single string of characters, instead of treating each character as if it had been read from the keyboard. This is called putting the - terminal into "bracketed paste mode"; it prevents Readline + terminal into “bracketed paste mode”; it prevents Readline from executing any editing commands bound to key sequences - appearing in the pasted text. The default is 'On'. + appearing in the pasted text. The default is ‘On’. - 'enable-keypad' - When set to 'on', Readline will try to enable the application + ‘enable-keypad’ + When set to ‘on’, Readline will try to enable the application keypad when it is called. Some systems need this to enable - the arrow keys. The default is 'off'. + the arrow keys. The default is ‘off’. - 'enable-meta-key' - When set to 'on', Readline will try to enable any meta + ‘enable-meta-key’ + When set to ‘on’, Readline will try to enable any meta modifier key the terminal claims to support when it is called. On many terminals, the meta key is used to send eight-bit - characters. The default is 'on'. + characters. The default is ‘on’. - 'expand-tilde' - If set to 'on', tilde expansion is performed when Readline - attempts word completion. The default is 'off'. + ‘expand-tilde’ + If set to ‘on’, tilde expansion is performed when Readline + attempts word completion. The default is ‘off’. - 'history-preserve-point' - If set to 'on', the history code attempts to place the point + ‘history-preserve-point’ + If set to ‘on’, the history code attempts to place the point (the current cursor position) at the same location on each - history line retrieved with 'previous-history' or - 'next-history'. The default is 'off'. + history line retrieved with ‘previous-history’ or + ‘next-history’. The default is ‘off’. - 'history-size' + ‘history-size’ Set the maximum number of history entries saved in the history list. If set to zero, any existing history entries are deleted and no new entries are saved. If set to a value less @@ -552,43 +554,43 @@ Variable Settings attempt is made to set HISTORY-SIZE to a non-numeric value, the maximum number of history entries will be set to 500. - '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 + ‘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 scroll horizontally on a single screen line when they are longer than the width of the screen, instead of wrapping onto - a new screen line. This variable is automatically set to 'on' + a new screen line. This variable is automatically set to ‘on’ for terminals of height 1. By default, this variable is set - to 'off'. + to ‘off’. - 'input-meta' - If set to 'on', Readline will enable eight-bit input (it will + ‘input-meta’ + If set to ‘on’, Readline will enable eight-bit input (it will not clear the eighth bit in the characters it reads), regardless of what the terminal claims it can support. The - default value is 'off', but Readline will set it to 'on' if + default value is ‘off’, but Readline will set it to ‘on’ if the locale contains eight-bit characters. The name - 'meta-flag' is a synonym for this variable. This variable is - dependent on the 'LC_CTYPE' locale category, and may change if + ‘meta-flag’ is a synonym for this variable. This variable is + dependent on the ‘LC_CTYPE’ locale category, and may change if the locale is changed. - 'isearch-terminators' + ‘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 + given a value, the characters <ESC> and ‘C-J’ will terminate an incremental search. - 'keymap' + ‘keymap’ Sets Readline's idea of the current keymap for key binding - commands. Built-in 'keymap' names are 'emacs', - 'emacs-standard', 'emacs-meta', 'emacs-ctlx', 'vi', 'vi-move', - 'vi-command', and 'vi-insert'. 'vi' is equivalent to - 'vi-command' ('vi-move' is also a synonym); 'emacs' is - equivalent to 'emacs-standard'. Applications may add - additional names. The default value is 'emacs'. The value of - the 'editing-mode' variable also affects the default keymap. - - 'keyseq-timeout' + commands. Built-in ‘keymap’ names are ‘emacs’, + ‘emacs-standard’, ‘emacs-meta’, ‘emacs-ctlx’, ‘vi’, ‘vi-move’, + ‘vi-command’, and ‘vi-insert’. ‘vi’ is equivalent to + ‘vi-command’ (‘vi-move’ is also a synonym); ‘emacs’ is + equivalent to ‘emacs-standard’. Applications may add + additional names. The default value is ‘emacs’. The value of + the ‘editing-mode’ variable also affects the default keymap. + + ‘keyseq-timeout’ Specifies the duration Readline will wait for a character when reading an ambiguous key sequence (one that can form a complete key sequence using the input read so far, or can take @@ -596,125 +598,130 @@ Variable Settings input is received within the timeout, Readline will use the shorter but complete key sequence. Readline uses this value to determine whether or not input is available on the current - input source ('rl_instream' by default). The value is + input source (‘rl_instream’ by default). The value is specified in milliseconds, so a value of 1000 means that Readline will wait one second for additional input. If this variable is set to a value less than or equal to zero, or to a non-numeric value, Readline will wait until another key is pressed to decide which key sequence to complete. The default - value is '500'. + value is ‘500’. - 'mark-directories' - If set to 'on', completed directory names have a slash - appended. The default is 'on'. + ‘mark-directories’ + If set to ‘on’, completed directory names have a slash + appended. The default is ‘on’. - 'mark-modified-lines' - This variable, when set to 'on', causes Readline to display an - asterisk ('*') at the start of history lines which have been - modified. This variable is 'off' by default. + ‘mark-modified-lines’ + This variable, when set to ‘on’, causes Readline to display an + 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 + ‘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'. + ‘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. If set to 'off', the leading - '.' must be supplied by the user in the filename to be - completed. This variable is 'on' by default. + ‘match-hidden-files’ + This variable, when set to ‘on’, forces Readline to match + files whose names begin with a ‘.’ (hidden files) when + performing filename completion. If set to ‘off’, the user + must include the leading ‘.’ in the filename to be completed. + This variable is ‘on’ by default. - 'menu-complete-display-prefix' - If set to 'on', menu completion displays the common prefix of + ‘menu-complete-display-prefix’ + If set to ‘on’, menu completion displays the common prefix of the list of possible completions (which may be empty) before - cycling through the list. The default is 'off'. + cycling through the list. The default is ‘off’. - 'output-meta' - If set to 'on', Readline will display characters with the + ‘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', but Readline will set it to - 'on' if the locale contains eight-bit characters. This - variable is dependent on the 'LC_CTYPE' locale category, and + sequence. The default is ‘off’, but Readline will set it to + ‘on’ if the locale contains eight-bit characters. This + variable is dependent on the ‘LC_CTYPE’ locale category, and may change if the locale is changed. - 'page-completions' - If set to 'on', Readline uses an internal 'more'-like pager to + ‘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. + variable is ‘on’ by default. - 'print-completions-horizontally' - If set to 'on', Readline will display completions with matches + ‘print-completions-horizontally’ + If set to ‘on’, Readline will display completions with matches sorted horizontally in alphabetical order, rather than down - the screen. The default is 'off'. + the screen. The default is ‘off’. - 'revert-all-at-newline' - If set to 'on', Readline will undo all changes to history - lines before returning when 'accept-line' is executed. By + ‘revert-all-at-newline’ + If set to ‘on’, Readline will undo all changes to history + lines before returning when ‘accept-line’ is executed. By default, history lines may be modified and retain individual - undo lists across calls to 'readline()'. The default is - 'off'. + undo lists across calls to ‘readline()’. The default is + ‘off’. - 'show-all-if-ambiguous' + ‘search-ignore-case’ + If set to ‘on’, Readline performs incremental and + non-incremental history list searches in a case-insensitive + fashion. The default value is ‘off’. + + ‘show-all-if-ambiguous’ This alters the default behavior of the completion functions. - If set to 'on', words which have more than one possible + If set to ‘on’, words which have more than one possible completion cause the matches to be listed immediately instead - of ringing the bell. The default value is 'off'. + of ringing the bell. The default value is ‘off’. - 'show-all-if-unmodified' + ‘show-all-if-unmodified’ This alters the default behavior of the completion functions in a fashion similar to SHOW-ALL-IF-AMBIGUOUS. If set to - 'on', words which have more than one possible completion + ‘on’, words which have more than one possible completion without any possible partial completion (the possible completions don't share a common prefix) cause the matches to be listed immediately instead of ringing the bell. The - default value is 'off'. + default value is ‘off’. - 'show-mode-in-prompt' - If set to 'on', add a string to the beginning of the prompt + ‘show-mode-in-prompt’ + If set to ‘on’, add a string to the beginning of the prompt indicating the editing mode: emacs, vi command, or vi insertion. The mode strings are user-settable (e.g., - EMACS-MODE-STRING). The default value is 'off'. + EMACS-MODE-STRING). The default value is ‘off’. - 'skip-completed-text' - If set to 'on', this alters the default completion behavior + ‘skip-completed-text’ + If set to ‘on’, this alters the default completion behavior when inserting a single match into the line. It's only active when performing completion in the middle of a word. If enabled, Readline does not insert characters from the completion that match characters after point in the word being completed, so portions of the word following the cursor are not duplicated. For instance, if this is enabled, attempting - completion when the cursor is after the 'e' in 'Makefile' will - result in 'Makefile' rather than 'Makefilefile', assuming + completion when the cursor is after the ‘e’ in ‘Makefile’ will + result in ‘Makefile’ rather than ‘Makefilefile’, assuming there is a single possible completion. The default value is - 'off'. + ‘off’. - 'vi-cmd-mode-string' + ‘vi-cmd-mode-string’ If the SHOW-MODE-IN-PROMPT variable is enabled, this string is displayed immediately before the last line of the primary prompt when vi editing mode is active and in command mode. The value is expanded like a key binding, so the standard set of meta- and control prefixes and backslash escape sequences - is available. Use the '\1' and '\2' escapes to begin and end + is available. Use the ‘\1’ and ‘\2’ escapes to begin and end sequences of non-printing characters, which can be used to embed a terminal control sequence into the mode string. The - default is '(cmd)'. + default is ‘(cmd)’. - 'vi-ins-mode-string' + ‘vi-ins-mode-string’ If the SHOW-MODE-IN-PROMPT variable is enabled, this string is displayed immediately before the last line of the primary prompt when vi editing mode is active and in insertion mode. The value is expanded like a key binding, so the standard set of meta- and control prefixes and backslash escape sequences - is available. Use the '\1' and '\2' escapes to begin and end + is available. Use the ‘\1’ and ‘\2’ escapes to begin and end sequences of non-printing characters, which can be used to embed a terminal control sequence into the mode string. The - default is '(ins)'. + default is ‘(ins)’. - 'visible-stats' - If set to 'on', a character denoting a file's type is appended + ‘visible-stats’ + If set to ‘on’, a character denoting a file's type is appended to the filename when listing possible completions. The - default is 'off'. + default is ‘off’. Key Bindings The syntax for controlling key bindings in the init file is simple. @@ -740,11 +747,11 @@ Key Bindings Meta-Rubout: backward-kill-word Control-o: "> output" - In the example above, '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 + In the example above, ‘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). + ‘> output’ into the line). A number of symbolic character names are recognized while processing this key binding syntax: DEL, ESC, ESCAPE, LFD, @@ -761,51 +768,51 @@ Key Bindings "\C-x\C-r": re-read-init-file "\e[11~": "Function Key 1" - 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'. + 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’. The following GNU Emacs style escape sequences are available when specifying key sequences: - '\C-' + ‘\C-’ control prefix - '\M-' + ‘\M-’ meta prefix - '\e' + ‘\e’ an escape character - '\\' + ‘\\’ backslash - '\"' + ‘\"’ <">, a double quotation mark - '\'' + ‘\'’ <'>, a single quote or apostrophe In addition to the GNU Emacs style escape sequences, a second set of backslash escapes is available: - '\a' + ‘\a’ alert (bell) - '\b' + ‘\b’ backspace - '\d' + ‘\d’ delete - '\f' + ‘\f’ form feed - '\n' + ‘\n’ newline - '\r' + ‘\r’ carriage return - '\t' + ‘\t’ horizontal tab - '\v' + ‘\v’ vertical tab - '\NNN' + ‘\NNN’ the eight-bit character whose value is the octal value NNN (one to three digits) - '\xHH' + ‘\xHH’ the eight-bit character whose value is the hexadecimal value HH (one or two hex digits) @@ -813,8 +820,8 @@ Key Bindings used to indicate a macro definition. Unquoted text is assumed to be a function name. In the macro body, the backslash escapes described above are expanded. Backslash will quote any other - character in the macro text, including '"' and '''. For example, - the following binding will make ''C-x' \' insert a single '\' into + character in the macro text, including ‘"’ and ‘'’. For example, + the following binding will make ‘‘C-x’ \’ insert a single ‘\’ into the line: "\C-x\\": "\\" @@ -829,45 +836,45 @@ compilation features of the C preprocessor which allows key bindings and variable settings to be performed as the result of tests. There are four parser directives used. -'$if' - The '$if' construct allows bindings to be made based on the editing +‘$if’ + The ‘$if’ construct allows bindings to be made based on the editing mode, the terminal being used, or the application using Readline. The text of the test, after any comparison operator, extends to the end of the line; unless otherwise noted, no characters are required to isolate it. - 'mode' - The 'mode=' form of the '$if' directive is used to test - whether Readline is in 'emacs' or 'vi' mode. This may be used - in conjunction with the 'set keymap' command, for instance, to - set bindings in the 'emacs-standard' and 'emacs-ctlx' keymaps - only if Readline is starting out in 'emacs' mode. + ‘mode’ + The ‘mode=’ form of the ‘$if’ directive is used to test + whether Readline is in ‘emacs’ or ‘vi’ mode. This may be used + in conjunction with the ‘set keymap’ command, for instance, to + set bindings in the ‘emacs-standard’ and ‘emacs-ctlx’ keymaps + only if Readline is starting out in ‘emacs’ mode. - 'term' - The 'term=' form may be used to include terminal-specific key + ‘term’ + The ‘term=’ form may be used to include terminal-specific key bindings, perhaps to bind the key sequences output by the terminal's function keys. The word on the right side of the - '=' is tested against both the full name of the terminal and - the portion of the terminal name before the first '-'. This - allows 'sun' to match both 'sun' and 'sun-cmd', for instance. + ‘=’ is tested against both the full name of the terminal and + the portion of the terminal name before the first ‘-’. This + allows ‘sun’ to match both ‘sun’ and ‘sun-cmd’, for instance. - 'version' - The 'version' test may be used to perform comparisons against - specific Readline versions. The 'version' expands to the + ‘version’ + The ‘version’ test may be used to perform comparisons against + specific Readline versions. The ‘version’ expands to the current Readline version. The set of comparison operators - includes '=' (and '=='), '!=', '<=', '>=', '<', and '>'. The + includes ‘=’ (and ‘==’), ‘!=’, ‘<=’, ‘>=’, ‘<’, and ‘>’. The version number supplied on the right side of the operator consists of a major version number, an optional decimal point, - and an optional minor version (e.g., '7.1'). If the minor - version is omitted, it is assumed to be '0'. The operator may - be separated from the string 'version' and from the version + and an optional minor version (e.g., ‘7.1’). If the minor + version is omitted, it is assumed to be ‘0’. The operator may + be separated from the string ‘version’ and from the version number argument by whitespace. The following example sets a variable if the Readline version being used is 7.0 or newer: $if version >= 7.0 set show-mode-in-prompt on $endif - 'application' + ‘application’ The APPLICATION construct is used to include application-specific settings. Each program using the Readline library sets the APPLICATION NAME, and you can test @@ -880,32 +887,32 @@ four parser directives used. "\C-xq": "\eb\"\ef\"" $endif - 'variable' + ‘variable’ The VARIABLE construct provides simple equality tests for Readline variables and values. The permitted comparison - operators are '=', '==', and '!='. The variable name must be + operators are ‘=’, ‘==’, and ‘!=’. The variable name must be separated from the comparison operator by whitespace; the operator may be separated from the value on the right hand side by whitespace. Both string and boolean variables may be tested. Boolean variables must be tested against the values ON and OFF. The following example is equivalent to the - 'mode=emacs' test described above: + ‘mode=emacs’ test described above: $if editing-mode == emacs set show-mode-in-prompt on $endif -'$endif' - This command, as seen in the previous example, terminates an '$if' +‘$endif’ + This command, as seen in the previous example, terminates an ‘$if’ command. -'$else' - Commands in this branch of the '$if' directive are executed if the +‘$else’ + Commands in this branch of the ‘$if’ directive are executed if the test fails. -'$include' +‘$include’ This directive takes a single filename as an argument and reads commands and bindings from that file. For example, the following - directive reads from '/etc/inputrc': + directive reads from ‘/etc/inputrc’: $include /etc/inputrc @@ -1038,10 +1045,10 @@ This section describes Readline commands that may be bound to key sequences. 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 'set-mark' + 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". +“region”. File: readline.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands @@ -1049,50 +1056,50 @@ File: readline.info, Node: Commands For Moving, Next: Commands For History, U 1.4.1 Commands For Moving ------------------------- -'beginning-of-line (C-a)' +‘beginning-of-line (C-a)’ Move to the start of the current line. -'end-of-line (C-e)' +‘end-of-line (C-e)’ Move to the end of the line. -'forward-char (C-f)' +‘forward-char (C-f)’ Move forward a character. -'backward-char (C-b)' +‘backward-char (C-b)’ Move back a character. -'forward-word (M-f)' +‘forward-word (M-f)’ Move forward to the end of the next word. Words are composed of letters and digits. -'backward-word (M-b)' +‘backward-word (M-b)’ Move back to the start of the current or previous word. Words are composed of letters and digits. -'previous-screen-line ()' +‘previous-screen-line ()’ Attempt to move point to the same physical screen column on the previous physical screen line. This will not have the desired effect if the current Readline line does not take up more than one physical line or if point is not greater than the length of the prompt plus the screen width. -'next-screen-line ()' +‘next-screen-line ()’ Attempt to move point to the same physical screen column on the next physical screen line. This will not have the desired effect if the current Readline line does not take up more than one physical line or if the length of the current Readline line is not greater than the length of the prompt plus the screen width. -'clear-display (M-C-l)' +‘clear-display (M-C-l)’ Clear the screen and, if possible, the terminal's scrollback buffer, then redraw the current line, leaving the current line at the top of the screen. -'clear-screen (C-l)' +‘clear-screen (C-l)’ Clear the screen, then redraw the current line, leaving the current line at the top of the screen. -'redraw-current-line ()' +‘redraw-current-line ()’ Refresh the current line. By default, this is unbound. @@ -1101,103 +1108,103 @@ File: readline.info, Node: Commands For History, Next: Commands For Text, Pre 1.4.2 Commands For Manipulating The History ------------------------------------------- -'accept-line (Newline or Return)' +‘accept-line (Newline or Return)’ Accept the line regardless of where the cursor is. If this line is non-empty, it may be added to the history list for future recall - with 'add_history()'. If this line is a modified history line, the + with ‘add_history()’. If this line is a modified history line, the history line is restored to its original state. -'previous-history (C-p)' +‘previous-history (C-p)’ Move 'back' through the history list, fetching the previous command. -'next-history (C-n)' +‘next-history (C-n)’ Move 'forward' through the history list, fetching the next command. -'beginning-of-history (M-<)' +‘beginning-of-history (M-<)’ Move to the first line in the history. -'end-of-history (M->)' +‘end-of-history (M->)’ Move to the end of the input history, i.e., the line currently being entered. -'reverse-search-history (C-r)' +‘reverse-search-history (C-r)’ Search backward starting at the current line and moving 'up' through the history as necessary. This is an incremental search. This command sets the region to the matched text and activates the mark. -'forward-search-history (C-s)' +‘forward-search-history (C-s)’ Search forward starting at the current line and moving 'down' through the history as necessary. This is an incremental search. This command sets the region to the matched text and activates the mark. -'non-incremental-reverse-search-history (M-p)' +‘non-incremental-reverse-search-history (M-p)’ Search backward starting at the current line and moving 'up' through the history as necessary using a non-incremental search for a string supplied by the user. The search string may match anywhere in a history line. -'non-incremental-forward-search-history (M-n)' +‘non-incremental-forward-search-history (M-n)’ Search forward starting at the current line and moving 'down' through the history as necessary using a non-incremental search for a string supplied by the user. The search string may match anywhere in a history line. -'history-search-forward ()' +‘history-search-forward ()’ Search forward through the history for the string of characters between the start of the current line and the point. The search string must match at the beginning of a history line. This is a non-incremental search. By default, this command is unbound. -'history-search-backward ()' +‘history-search-backward ()’ Search backward through the history for the string of characters between the start of the current line and the point. The search string must match at the beginning of a history line. This is a non-incremental search. By default, this command is unbound. -'history-substring-search-forward ()' +‘history-substring-search-forward ()’ Search forward through the history for the string of characters between the start of the current line and the point. The search string may match anywhere in a history line. This is a non-incremental search. By default, this command is unbound. -'history-substring-search-backward ()' +‘history-substring-search-backward ()’ Search backward through the history for the string of characters between the start of the current line and the point. The search string may match anywhere in a history line. This is a non-incremental search. By default, this command is unbound. -'yank-nth-arg (M-C-y)' +‘yank-nth-arg (M-C-y)’ Insert the first argument to the previous command (usually the 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. Once the - argument N is computed, the argument is extracted as if the '!N' + argument N is computed, the argument is extracted as if the ‘!N’ history expansion had been specified. -'yank-last-arg (M-. or M-_)' +‘yank-last-arg (M-. or M-_)’ Insert last argument to the previous command (the last word of the previous history entry). With a numeric argument, behave exactly - like 'yank-nth-arg'. Successive calls to 'yank-last-arg' move back + like ‘yank-nth-arg’. Successive calls to ‘yank-last-arg’ move back through the history list, inserting the last word (or the word specified by the argument to the first call) of each line in turn. Any numeric argument supplied to these successive calls determines the direction to move through the history. A negative argument switches the direction through the history (back or forward). The history expansion facilities are used to extract the last argument, - as if the '!$' history expansion had been specified. + as if the ‘!$’ history expansion had been specified. -'operate-and-get-next (C-o)' +‘operate-and-get-next (C-o)’ Accept the current line for return to the calling application as if a newline had been entered, and fetch the next line relative to the current line from the history for editing. A numeric argument, if supplied, specifies the history entry to use instead of the current line. -'fetch-history ()' +‘fetch-history ()’ With a numeric argument, fetch that entry from the history list and make it the current line. Without an argument, move back to the first entry in the history list. @@ -1208,43 +1215,43 @@ File: readline.info, Node: Commands For Text, Next: Commands For Killing, Pre 1.4.3 Commands For Changing Text -------------------------------- -'end-of-file (usually C-d)' +‘end-of-file (usually C-d)’ The character indicating end-of-file as set, for example, by - 'stty'. If this character is read when there are no characters on + ‘stty’. If this character is read when there are no characters on the line, and point is at the beginning of the line, Readline interprets it as the end of input and returns EOF. -'delete-char (C-d)' +‘delete-char (C-d)’ Delete the character at point. If this function is bound to the - same character as the tty EOF character, as 'C-d' commonly is, see + same character as the tty EOF character, as ‘C-d’ commonly is, see above for the effects. -'backward-delete-char (Rubout)' +‘backward-delete-char (Rubout)’ Delete the character behind the cursor. A numeric argument means to kill the characters instead of deleting them. -'forward-backward-delete-char ()' +‘forward-backward-delete-char ()’ Delete the character under the cursor, unless the cursor is at the 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 or 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, !, ...)' +‘self-insert (a, b, A, 1, !, ...)’ Insert yourself. -'bracketed-paste-begin ()' +‘bracketed-paste-begin ()’ This function is intended to be bound to the "bracketed paste" escape sequence sent by some terminals, and such a binding is assigned by default. It allows Readline to insert the pasted text as a single unit without treating each character as if it had been read from the keyboard. The characters are inserted as if each one - was bound to 'self-insert' instead of executing any editing + was bound to ‘self-insert’ instead of executing any editing commands. Bracketed paste sets the region (the characters between point and @@ -1252,39 +1259,39 @@ File: readline.info, Node: Commands For Text, Next: Commands For Killing, Pre mark_: when the mark is active, Readline redisplay uses the terminal's standout mode to denote the region. -'transpose-chars (C-t)' +‘transpose-chars (C-t)’ Drag the character before the cursor forward over the character at the cursor, moving the cursor forward as well. If the insertion point is at the end of the line, then this transposes the last two characters of the line. Negative arguments have no effect. -'transpose-words (M-t)' +‘transpose-words (M-t)’ Drag the word before point past the word after point, moving point 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)' +‘upcase-word (M-u)’ Uppercase the current (or following) word. With a negative argument, uppercase the previous word, but do not move the cursor. -'downcase-word (M-l)' +‘downcase-word (M-l)’ Lowercase the current (or following) word. With a negative argument, lowercase the previous word, but do not move the cursor. -'capitalize-word (M-c)' +‘capitalize-word (M-c)’ Capitalize the current (or following) word. With a negative argument, capitalize the previous word, but do not move the cursor. -'overwrite-mode ()' +‘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. + ‘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 + 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 + Characters bound to ‘backward-delete-char’ replace the character before point with a space. By default, this command is unbound. @@ -1295,76 +1302,69 @@ File: readline.info, Node: Commands For Killing, Next: Numeric Arguments, Pre 1.4.4 Killing And Yanking ------------------------- -'kill-line (C-k)' +‘kill-line (C-k)’ Kill the text from point to the end of the line. With a negative numeric argument, kill backward from the cursor to the beginning of the current line. -'backward-kill-line (C-x Rubout)' +‘backward-kill-line (C-x Rubout)’ Kill backward from the cursor to the beginning of the current line. With a negative numeric argument, kill forward from the cursor to the end of the current line. -'unix-line-discard (C-u)' +‘unix-line-discard (C-u)’ Kill backward from the cursor to the beginning of the current line. -'kill-whole-line ()' +‘kill-whole-line ()’ Kill all characters on the current line, no matter where point is. By default, this is unbound. -'kill-word (M-d)' +‘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'. + 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'. - -'shell-transpose-words (M-C-t)' - Drag the word before point past the word after point, moving point - 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. Word - boundaries are the same as 'shell-forward-word' and - 'shell-backward-word'. + ‘backward-word’. -'unix-word-rubout (C-w)' +‘unix-word-rubout (C-w)’ Kill the word behind point, using white space as a word boundary. The killed text is saved on the kill-ring. -'unix-filename-rubout ()' +‘unix-filename-rubout ()’ Kill the word behind point, using white space and the slash character as the word boundaries. The killed text is saved on the kill-ring. -'delete-horizontal-space ()' +‘delete-horizontal-space ()’ Delete all spaces and tabs around point. By default, this is unbound. -'kill-region ()' +‘kill-region ()’ Kill the text in the current region. By default, this command is unbound. -'copy-region-as-kill ()' +‘copy-region-as-kill ()’ Copy the text in the region to the kill buffer, so it can be yanked right away. By default, this command is unbound. -'copy-backward-word ()' +‘copy-backward-word ()’ Copy the word before point to the kill buffer. The word boundaries - are the same as 'backward-word'. By default, this command is + are the same as ‘backward-word’. By default, this command is unbound. -'copy-forward-word ()' +‘copy-forward-word ()’ Copy the word following point to the kill buffer. The word - boundaries are the same as 'forward-word'. By default, this + boundaries are the same as ‘forward-word’. By default, this command is unbound. -'yank (C-y)' +‘yank (C-y)’ Yank the top of the kill ring into the buffer at point. -'yank-pop (M-y)' +‘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 @@ -1372,15 +1372,15 @@ File: readline.info, Node: Numeric Arguments, Next: Commands For Completion, 1.4.5 Specifying Numeric Arguments ---------------------------------- -'digit-argument (M-0, M-1, ... M--)' +‘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 ()' +‘universal-argument ()’ This is another way to specify an argument. If this command is followed by one or more digits, optionally with a leading minus sign, those digits define the argument. If the command is followed - by digits, executing 'universal-argument' again ends the numeric + by digits, executing ‘universal-argument’ again ends the numeric argument, but is otherwise ignored. As a special case, if this command is immediately followed by a character that is neither a digit nor minus sign, the argument count for the next command is @@ -1395,43 +1395,43 @@ File: readline.info, Node: Commands For Completion, Next: Keyboard Macros, Pr 1.4.6 Letting Readline Type For You ----------------------------------- -'complete (<TAB>)' +‘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-?)' +‘possible-completions (M-?)’ List the possible completions of the text before point. When displaying completions, Readline sets the number of columns used - for display to the value of 'completion-display-width', the value - of the environment variable 'COLUMNS', or the screen width, in that + for display to the value of ‘completion-display-width’, the value + of the environment variable ‘COLUMNS’, or the screen width, in that order. -'insert-completions (M-*)' +‘insert-completions (M-*)’ Insert all completions of the text before point that would have - been generated by 'possible-completions'. + been generated by ‘possible-completions’. -'menu-complete ()' - Similar to 'complete', but replaces the word to be completed with a +‘menu-complete ()’ + Similar to ‘complete’, but replaces the word to be completed with a single match from the list of possible completions. Repeated - execution of 'menu-complete' steps through the list of possible + 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 (subject to the setting of - 'bell-style') and the original text is restored. An argument of N + ‘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. -'menu-complete-backward ()' - Identical to 'menu-complete', but moves backward through the list - of possible completions, as if 'menu-complete' had been given a +‘menu-complete-backward ()’ + Identical to ‘menu-complete’, but moves backward through the list + of possible completions, as if ‘menu-complete’ had been given a negative argument. -'delete-char-or-list ()' +‘delete-char-or-list ()’ Deletes the character under the cursor if not at the beginning or - end of the line (like 'delete-char'). If at the end of the line, - behaves identically to 'possible-completions'. This command is + end of the line (like ‘delete-char’). If at the end of the line, + behaves identically to ‘possible-completions’. This command is unbound by default. @@ -1440,18 +1440,18 @@ File: readline.info, Node: Keyboard Macros, Next: Miscellaneous Commands, Pre 1.4.7 Keyboard Macros --------------------- -'start-kbd-macro (C-x ()' +‘start-kbd-macro (C-x ()’ Begin saving the characters typed into the current keyboard macro. -'end-kbd-macro (C-x ))' +‘end-kbd-macro (C-x ))’ Stop saving the characters typed into the current keyboard macro and save the definition. -'call-last-kbd-macro (C-x e)' +‘call-last-kbd-macro (C-x e)’ Re-execute the last keyboard macro defined, by making the characters in the macro appear as if typed at the keyboard. -'print-last-kbd-macro ()' +‘print-last-kbd-macro ()’ Print the last keyboard macro defined in a format suitable for the INPUTRC file. @@ -1461,53 +1461,53 @@ File: readline.info, Node: Miscellaneous Commands, Prev: Keyboard Macros, Up: 1.4.8 Some Miscellaneous Commands --------------------------------- -'re-read-init-file (C-x C-r)' +‘re-read-init-file (C-x C-r)’ Read in the contents of the INPUTRC file, and incorporate any bindings or variable assignments found there. -'abort (C-g)' +‘abort (C-g)’ Abort the current editing command and ring the terminal's bell - (subject to the setting of 'bell-style'). + (subject to the setting of ‘bell-style’). -'do-lowercase-version (M-A, M-B, M-X, ...)' +‘do-lowercase-version (M-A, M-B, M-X, ...)’ If the metafied character X is upper case, run the command that is bound to the corresponding metafied lower case character. The behavior is undefined if X is already lower case. -'prefix-meta (<ESC>)' +‘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'. + meta key. Typing ‘<ESC> f’ is equivalent to typing ‘M-f’. -'undo (C-_ or C-x C-u)' +‘undo (C-_ or C-x C-u)’ Incremental undo, separately remembered for each line. -'revert-line (M-r)' +‘revert-line (M-r)’ Undo all changes made to this line. This is like executing the - 'undo' command enough times to get back to the beginning. + ‘undo’ command enough times to get back to the beginning. -'tilde-expand (M-~)' +‘tilde-expand (M-~)’ Perform tilde expansion on the current word. -'set-mark (C-@)' +‘set-mark (C-@)’ 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)' +‘exchange-point-and-mark (C-x C-x)’ Swap the point with the mark. The current cursor position is set to the saved position, and the old cursor position is saved as the mark. -'character-search (C-])' +‘character-search (C-])’ A character is read and point is moved to the next occurrence of that character. A negative argument searches for previous occurrences. -'character-search-backward (M-C-])' +‘character-search-backward (M-C-])’ A character is read and point is moved to the previous occurrence of that character. A negative argument searches for subsequent occurrences. -'skip-csi-sequence ()' +‘skip-csi-sequence ()’ Read enough characters to consume a multi-key sequence such as those defined for keys like Home and End. Such sequences begin with a Control Sequence Indicator (CSI), usually ESC-[. If this @@ -1516,67 +1516,74 @@ File: readline.info, Node: Miscellaneous Commands, Prev: Keyboard Macros, Up: inserting stray characters into the editing buffer. This is unbound by default, but usually bound to ESC-[. -'insert-comment (M-#)' - Without a numeric argument, the value of the 'comment-begin' +‘insert-comment (M-#)’ + 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 + ‘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 ()' +‘dump-functions ()’ Print all of the functions and their key bindings to the Readline output stream. 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. -'dump-variables ()' +‘dump-variables ()’ Print all of the settable variables and their values to the Readline output stream. 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. -'dump-macros ()' +‘dump-macros ()’ Print all of the Readline key sequences bound to macros and the 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 +‘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 +‘vi-editing-mode (M-C-j)’ + When in ‘emacs’ editing mode, this causes a switch to ‘vi’ editing mode. +‘execute-named-command (M-x)’ + Read a bindable readline command name from the input and execute + the function to which it's bound, as if the key sequence to which + it was bound appeared in the input. If this function is supplied + with a numeric argument, it passes that argument to the function it + executes. + File: readline.info, Node: Readline vi Mode, Prev: Bindable Readline Commands, Up: Command Line Editing 1.5 Readline vi Mode ==================== -While the Readline library does not have a full set of 'vi' editing +While the Readline library does not have a full set of ‘vi’ editing functions, it does contain enough to allow simple editing of the line. -The Readline 'vi' mode behaves as specified in the POSIX standard. +The Readline ‘vi’ mode behaves as specified in the POSIX standard. - In order to switch interactively between 'emacs' and 'vi' editing -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. + In order to switch interactively between ‘emacs’ and ‘vi’ editing +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 -'insertion' mode, as if you had typed an 'i'. Pressing <ESC> switches + When you enter a line in ‘vi’ mode, you are already placed in +'insertion' mode, as if you had typed an ‘i’. Pressing <ESC> switches you into 'command' mode, where you can edit the text of the line with -the standard 'vi' movement keys, move to previous history lines with 'k' -and subsequent lines with 'j', and so forth. +the standard ‘vi’ movement keys, move to previous history lines with ‘k’ +and subsequent lines with ‘j’, and so forth. This document describes the GNU Readline Library, a utility for aiding in the consistency of user interface across discrete programs that need to provide a command line interface. - Copyright (C) 1988-2022 Free Software Foundation, Inc. + Copyright (C) 1988-2023 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 @@ -1623,17 +1630,21 @@ File: readline.info, Node: Basic Behavior, Next: Custom Functions, Up: Progra 2.1 Basic Behavior ================== -Many programs provide a command line interface, such as 'mail', 'ftp', -and 'sh'. For such programs, the default behaviour of Readline is +Many programs provide a command line interface, such as ‘mail’, ‘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()'. - - 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 +way possible, perhaps to replace calls in your code to ‘gets()’ or +‘fgets()’. + + The function ‘readline()’ prints a prompt PROMPT and then reads and +returns a single line of text from the user. Since it's possible to +enter characters into the line while quoting them to disable any +Readline editing function they might normally have, this line may +include embedded newlines and other special characters. 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 (const char *PROMPT); @@ -1642,18 +1653,18 @@ So, one might say in order to read a line of text from the user. The line returned has the final newline removed, so only the text remains. - If 'readline' encounters an 'EOF' while reading the line, and the -line is empty at that point, then '(char *)NULL' is returned. + If ‘readline’ encounters an ‘EOF’ while reading the line, and the +line is empty at that point, then ‘(char *)NULL’ is returned. Otherwise, the line is ended just as if a newline had been typed. Readline performs some expansion on the PROMPT before it is displayed -on the screen. See the description of 'rl_expand_prompt' (*note +on the screen. See the description of ‘rl_expand_prompt’ (*note Redisplay::) for additional details, especially if PROMPT will contain characters that do not consume physical screen space when displayed. 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. +for example), you must call ‘add_history()’ to save the line away in a +“history” list of such lines. add_history (line); @@ -1661,7 +1672,7 @@ 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 function, +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. */ @@ -1694,21 +1705,21 @@ 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, 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::). @@ -1726,18 +1737,18 @@ functionality to Readline. Before declaring any functions that customize Readline's behavior, or using any functionality Readline provides in other code, an application -writer should include the file '<readline/readline.h>' in any file that -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'. +writer should include the file ‘<readline/readline.h>’ in any file that +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 + ‘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'. +4.2, for example, the value of ‘RL_READLINE_VERSION’ would be ‘0x0402’. * Menu: @@ -1758,51 +1769,51 @@ write code describing pointers to C functions with appropriately prototyped arguments and return values. 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 +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 - 'int (*func)();' + ‘int (*func)();’ or the ANSI-C style declaration - 'int (*func)(int, int);' + ‘int (*func)(int, int);’ we may write - 'rl_command_func_t *func;' + ‘rl_command_func_t *func;’ The full list of function pointer types available is -'typedef int rl_command_func_t (int, int);' +‘typedef int rl_command_func_t (int, int);’ -'typedef char *rl_compentry_func_t (const char *, int);' +‘typedef char *rl_compentry_func_t (const char *, int);’ -'typedef char **rl_completion_func_t (const char *, int, int);' +‘typedef char **rl_completion_func_t (const char *, int, int);’ -'typedef char *rl_quote_func_t (char *, int, char *);' +‘typedef char *rl_quote_func_t (char *, int, char *);’ -'typedef char *rl_dequote_func_t (char *, int);' +‘typedef char *rl_dequote_func_t (char *, int);’ -'typedef int rl_compignore_func_t (char **);' +‘typedef int rl_compignore_func_t (char **);’ -'typedef void rl_compdisp_func_t (char **, int, int);' +‘typedef void rl_compdisp_func_t (char **, int, int);’ -'typedef int rl_hook_func_t (void);' +‘typedef int rl_hook_func_t (void);’ -'typedef int rl_getc_func_t (FILE *);' +‘typedef int rl_getc_func_t (FILE *);’ -'typedef int rl_linebuf_func_t (char *, int);' +‘typedef int rl_linebuf_func_t (char *, int);’ -'typedef int rl_intfunc_t (int);' -'#define rl_ivoidfunc_t rl_hook_func_t' -'typedef int rl_icpfunc_t (char *);' -'typedef int rl_icppfunc_t (char **);' +‘typedef int rl_intfunc_t (int);’ +‘#define rl_ivoidfunc_t rl_hook_func_t’ +‘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 **);' +‘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: Readline Typedefs, Up: Custom Functions @@ -1814,7 +1825,7 @@ In order to write new functions for Readline, you need to know the calling conventions for keyboard-invoked functions, and the names of the variables that describe the current state of the line read so far. - The calling sequence for a command 'foo' looks like + The calling sequence for a command ‘foo’ looks like int foo (int count, int key) @@ -1846,16 +1857,16 @@ These variables are available to function writers. -- Variable: char * rl_line_buffer This is the line gathered so far. You are welcome to modify the contents of the line, but see *note Allowing Undoing::. The - function 'rl_extend_line_buffer' is available to increase the - memory allocated to 'rl_line_buffer'. + function ‘rl_extend_line_buffer’ is available to increase the + memory allocated to ‘rl_line_buffer’. -- Variable: int rl_point - The offset of the current cursor position in 'rl_line_buffer' (the + The offset of the current cursor position in ‘rl_line_buffer’ (the _point_). -- Variable: int rl_end - The number of characters present in 'rl_line_buffer'. When - 'rl_point' is at the end of the line, 'rl_point' and 'rl_end' are + The number of characters present in ‘rl_line_buffer’. When + ‘rl_point’ is at the end of the line, ‘rl_point’ and ‘rl_end’ are equal. -- Variable: int rl_mark @@ -1865,18 +1876,18 @@ These variables are available to function writers. -- Variable: int rl_done Setting this to a non-zero value causes Readline to return the current line immediately. Readline will set this variable when it - has read a key sequence bound to 'accept-line' and is about to + has read a key sequence bound to ‘accept-line’ and is about to return the line to the caller. -- Variable: int rl_eof_found Readline will set this variable when it has read an EOF character - (e.g., the stty 'EOF' character) on an empty line or encountered a + (e.g., the stty ‘EOF’ character) on an empty line or encountered a read error and is about to return a NULL line to the caller. -- Variable: int rl_num_chars_to_read - Setting this to a positive value before calling 'readline()' causes + 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'. + 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 @@ -1896,9 +1907,9 @@ These variables are available to function writers. -- Variable: char * rl_prompt The prompt Readline uses. This is set from the argument to - '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()'. + ‘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: char * rl_display_prompt The string displayed as the prompt. This is usually identical to @@ -1907,10 +1918,10 @@ These variables are available to function writers. -- Variable: int rl_already_prompted If an application wishes to display the prompt itself, rather than - have Readline do it the first time 'readline()' is called, it + have Readline do it the first time ‘readline()’ is called, it should set this variable to a non-zero value after displaying the prompt. The prompt must also be passed as the argument to - 'readline()' so the redisplay functions can update the display + ‘readline()’ so the redisplay functions can update the display properly. The calling application is responsible for managing the value; Readline never sets it. @@ -1921,7 +1932,7 @@ These variables are available to function writers. 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 + example, for Readline-4.2, ‘rl_readline_version’ would have the value 0x0402. -- Variable: int rl_gnu_readline_p @@ -1930,7 +1941,7 @@ These variables are available to function writers. -- 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' + application, Readline sets this to the value of the ‘TERM’ environment variable the first time it is called. -- Variable: const char * rl_readline_name @@ -1939,16 +1950,16 @@ These variables are available to function writers. (*note Conditional Init Constructs::). -- Variable: FILE * rl_instream - The stdio stream from which Readline reads input. If 'NULL', + 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. If 'NULL', + The stdio stream to which Readline performs output. If ‘NULL’, Readline defaults to STDOUT. -- Variable: int rl_prefer_env_winsize - If non-zero, Readline gives values found in the 'LINES' and - 'COLUMNS' environment variables greater precedence than values + If non-zero, Readline gives values found in the ‘LINES’ and + ‘COLUMNS’ environment variables greater precedence than values fetched from the kernel when computing the screen dimensions. -- Variable: rl_command_func_t * rl_last_func @@ -1958,11 +1969,11 @@ These variables are available to function writers. -- 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. + ‘readline’ prints the first prompt. -- 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 + first prompt has been printed and just before ‘readline’ starts reading input characters. -- Variable: rl_hook_func_t * rl_event_hook @@ -1973,7 +1984,7 @@ These variables are available to function writers. -- 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 + ‘rl_getc’, the default Readline character input function (*note Character Input::). In general, an application that sets RL_GETC_FUNCTION should consider setting RL_INPUT_AVAILABLE_HOOK as well. @@ -1989,42 +2000,51 @@ These variables are available to function writers. -- Variable: rl_hook_func_t * rl_input_available_hook If non-zero, Readline will use this function's return value when it needs to determine whether or not there is available input on the - current input source. The default hook checks 'rl_instream'; if an + current input source. The default hook checks ‘rl_instream’; if an application is using a different input source, it should set the hook appropriately. Readline queries for available input when implementing intra-key-sequence timeouts during input and - incremental searches. This may use an application-specific timeout - before returning a value; Readline uses the value passed to - 'rl_set_keyboard_input_timeout()' or the value of the user-settable - KEYSEQ-TIMEOUT variable. This is designed for use by applications - using Readline's callback interface (*note Alternate Interface::), - which may not use the traditional 'read(2)' and file descriptor - interface, or other applications using a different input mechanism. - If an application uses an input mechanism or hook that can - potentially exceed the value of KEYSEQ-TIMEOUT, it should increase - the timeout or set this hook appropriately even when not using the - callback interface. In general, an application that sets - RL_GETC_FUNCTION should consider setting RL_INPUT_AVAILABLE_HOOK as - well. + incremental searches. This function must return zero if there is + no input available, and non-zero if input is available. This may + use an application-specific timeout before returning a value; + Readline uses the value passed to ‘rl_set_keyboard_input_timeout()’ + or the value of the user-settable KEYSEQ-TIMEOUT variable. This is + designed for use by applications using Readline's callback + interface (*note Alternate Interface::), which may not use the + traditional ‘read(2)’ and file descriptor interface, or other + applications using a different input mechanism. If an application + uses an input mechanism or hook that can potentially exceed the + value of KEYSEQ-TIMEOUT, it should increase the timeout or set this + hook appropriately even when not using the callback interface. In + general, an application that sets RL_GETC_FUNCTION should consider + setting RL_INPUT_AVAILABLE_HOOK as well. -- 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 + 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 + ‘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::). + ‘rl_prep_term_function’. By default, this is set to + ‘rl_deprep_terminal’ (*note Terminal Management::). + + -- Variable: void rl_macro_display_hook + If set, this points to a function that ‘rl_macro_dumper’ will call + to display a key sequence bound to a macro. It is called with the + key sequence, the "untranslated" macro value (i.e., with backslash + escapes included, as when passed to ‘rl_macro_bind’), the + ‘readable’ argument passed to ‘rl_macro_dumper’, and any prefix to + display before the key sequence. -- Variable: Keymap rl_executing_keymap This variable is set to the keymap (*note Keymaps::) in which the @@ -2050,80 +2070,80 @@ These variables are available to function writers. -- 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 + 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' + ‘RL_STATE_NONE’ Readline has not yet been called, nor has it begun to initialize. - 'RL_STATE_INITIALIZING' + ‘RL_STATE_INITIALIZING’ Readline is initializing its internal data structures. - 'RL_STATE_INITIALIZED' + ‘RL_STATE_INITIALIZED’ Readline has completed its initialization. - 'RL_STATE_TERMPREPPED' + ‘RL_STATE_TERMPREPPED’ Readline has modified the terminal modes to do its own input and redisplay. - 'RL_STATE_READCMD' + ‘RL_STATE_READCMD’ Readline is reading a command from the keyboard. - 'RL_STATE_METANEXT' + ‘RL_STATE_METANEXT’ Readline is reading more input after reading the meta-prefix character. - 'RL_STATE_DISPATCHING' + ‘RL_STATE_DISPATCHING’ Readline is dispatching to a command. - 'RL_STATE_MOREINPUT' + ‘RL_STATE_MOREINPUT’ Readline is reading more input while executing an editing command. - 'RL_STATE_ISEARCH' + ‘RL_STATE_ISEARCH’ Readline is performing an incremental history search. - 'RL_STATE_NSEARCH' + ‘RL_STATE_NSEARCH’ Readline is performing a non-incremental history search. - 'RL_STATE_SEARCH' + ‘RL_STATE_SEARCH’ Readline is searching backward or forward through the history for a string. - 'RL_STATE_NUMERICARG' + ‘RL_STATE_NUMERICARG’ Readline is reading a numeric argument. - 'RL_STATE_MACROINPUT' + ‘RL_STATE_MACROINPUT’ Readline is currently getting its input from a previously-defined keyboard macro. - 'RL_STATE_MACRODEF' + ‘RL_STATE_MACRODEF’ Readline is currently reading characters defining a keyboard macro. - 'RL_STATE_OVERWRITE' + ‘RL_STATE_OVERWRITE’ Readline is in overwrite mode. - 'RL_STATE_COMPLETING' + ‘RL_STATE_COMPLETING’ Readline is performing word completion. - 'RL_STATE_SIGHANDLER' + ‘RL_STATE_SIGHANDLER’ Readline is currently executing the readline signal handler. - 'RL_STATE_UNDOING' + ‘RL_STATE_UNDOING’ Readline is performing an undo. - 'RL_STATE_INPUTPENDING' + ‘RL_STATE_INPUTPENDING’ Readline has input pending due to a call to - 'rl_execute_next()'. - 'RL_STATE_TTYCSAVED' + ‘rl_execute_next()’. + ‘RL_STATE_TTYCSAVED’ Readline has saved the values of the terminal's special characters. - 'RL_STATE_CALLBACK' + ‘RL_STATE_CALLBACK’ Readline is currently using the alternate (callback) interface (*note Alternate Interface::). - 'RL_STATE_VIMOTION' + ‘RL_STATE_VIMOTION’ Readline is reading the argument to a vi-mode "motion" command. - 'RL_STATE_MULTIKEY' + ‘RL_STATE_MULTIKEY’ Readline is reading a multiple-keystroke command. - 'RL_STATE_VICMDONCE' + ‘RL_STATE_VICMDONCE’ Readline has entered vi command (movement) mode at least one - time during the current call to 'readline()'. - 'RL_STATE_DONE' - Readline has read a key sequence bound to 'accept-line' and is + time during the current call to ‘readline()’. + ‘RL_STATE_DONE’ + Readline has read a key sequence bound to ‘accept-line’ and is about to return the line to the caller. - 'RL_STATE_TIMEOUT' + ‘RL_STATE_TIMEOUT’ Readline has timed out (it did not receive a line or specified number of characters before the timeout duration specified by - 'rl_set_timeout' elapsed) and is returning that status to the + ‘rl_set_timeout’ elapsed) and is returning that status to the caller. - 'RL_STATE_EOF' - Readline has read an EOF character (e.g., the stty 'EOF' + ‘RL_STATE_EOF’ + Readline has read an EOF character (e.g., the stty ‘EOF’ character) or encountered a read error and is about to return a NULL line to the caller. @@ -2156,7 +2176,7 @@ File: readline.info, Node: Readline Convenience Functions, Next: Readline Sign key sequences. * Allowing Undoing:: How to make your functions undoable. * Redisplay:: Functions to control line display. -* Modifying Text:: Functions to modify 'rl_line_buffer'. +* 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. @@ -2179,7 +2199,7 @@ 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: @@ -2187,7 +2207,7 @@ Readline provides a function for doing that: *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 @@ -2201,15 +2221,15 @@ File: readline.info, Node: Keymaps, Next: Binding Keys, Prev: Function Naming 2.4.2 Selecting a Keymap ------------------------ -Key bindings take place on a "keymap". The keymap is the association +Key bindings take place on a “keymap”. The keymap is the 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 (void) Returns a new, empty keymap. The space for the keymap is allocated - with 'malloc()'; the caller should free it by calling - 'rl_free_keymap()' when done. + with ‘malloc()’; the caller should free it by calling + ‘rl_free_keymap()’ when done. -- Function: Keymap rl_copy_keymap (Keymap map) Return a new keymap which is a copy of MAP. @@ -2226,7 +2246,7 @@ which keymap to use. -- Function: void rl_free_keymap (Keymap keymap) Free all storage associated with KEYMAP. This calls - 'rl_discard_keymap' to free subordindate keymaps and macros. + ‘rl_discard_keymap’ to free subordindate keymaps and macros. -- Function: int rl_empty_keymap (Keymap keymap) Return non-zero if there are no keys bound to functions in KEYMAP; @@ -2243,17 +2263,17 @@ change which keymap is active. -- 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 + supplied in a ‘set keymap’ inputrc line (*note Readline Init 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 + supplied in a ‘set keymap’ inputrc line (*note Readline Init File::). -- Function: int rl_set_keymap_name (const char *name, Keymap keymap) Set the name of KEYMAP. This name will then be "registered" and - available for use in a 'set keymap' inputrc directive *note + available for use in a ‘set keymap’ inputrc directive *note Readline Init File::). The NAME may not be one of Readline's builtin keymap names; you may not add a different name for one of Readline's builtin keymaps. You may replace the name associated @@ -2273,16 +2293,16 @@ File: readline.info, Node: Binding Keys, Next: Associating Function Names and ------------------ 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 +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 +initialization function assigned to the ‘rl_startup_hook’ variable (*note Readline Variables::). These functions manage key bindings. @@ -2339,7 +2359,7 @@ initialization function assigned to the 'rl_startup_hook' variable -- Function: int rl_set_key (const char *keyseq, rl_command_func_t *function, Keymap map) - Equivalent to 'rl_bind_keyseq_in_map'. + Equivalent to ‘rl_bind_keyseq_in_map’. -- Function: int rl_bind_keyseq_if_unbound (const char *keyseq, rl_command_func_t *function) @@ -2357,12 +2377,12 @@ initialization function assigned to the 'rl_startup_hook' variable *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 - a keymap ('ISKMAP'). This makes new keymaps as necessary. The + by DATA; this can be a function (‘ISFUNC’), a macro (‘ISMACR’), or + a keymap (‘ISKMAP’). This makes new keymaps as necessary. The initial keymap in which to do bindings is MAP. -- Function: int rl_parse_and_bind (char *line) - Parse LINE as if it had been read from the 'inputrc' file and + 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::). @@ -2386,16 +2406,16 @@ associate a new function name with an arbitrary function. -- 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 the 'int' variable it points to - (one of 'ISFUNC', 'ISKMAP', or 'ISMACR'). It takes a "translated" + ‘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’). It takes a "translated" key sequence and should not be used if the key sequence can include NUL. -- Function: rl_command_func_t * rl_function_of_keyseq_len (const char *keyseq, size_t len, Keymap map, int *type) Return the function invoked by KEYSEQ of length LEN in keymap MAP. - Equivalent to 'rl_function_of_keyseq' with the addition of the LEN + Equivalent to ‘rl_function_of_keyseq’ with the addition of the LEN parameter. It takes a "translated" key sequence and should be used if the key sequence can include NUL. @@ -2404,7 +2424,7 @@ associate a new function name with an arbitrary function. If there is a numeric argument at the beginning of KEYSEQ, possibly including digits, return the index of the first character in KEYSEQ following the numeric argument. This can be used to skip over the - numeric argument (which is available as 'rl_numeric_arg' while + numeric argument (which is available as ‘rl_numeric_arg’ while traversing the key sequence that invoked the current command. -- Function: char ** rl_invoking_keyseqs (rl_command_func_t *function) @@ -2416,21 +2436,28 @@ associate a new function name with an arbitrary function. Return an array of strings representing the key sequences used to invoke FUNCTION in the keymap MAP. + -- Function: void rl_print_keybinding (const char *name, Keymap map, + int readable) + Print key sequences bound to Readline function name NAME in keymap + MAP. If MAP is NULL, this uses the current keymap. 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: void rl_function_dumper (int readable) Print the Readline function names and the key sequences currently - bound to them 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' + bound to them 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: void rl_list_funmap_names (void) Print the names of all bindable Readline functions to - 'rl_outstream'. + ‘rl_outstream’. -- 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, but not the pointers, using - 'free' or 'rl_free' when you are done. + ‘free’ or ‘rl_free’ when you are done. -- Function: int rl_add_funmap_entry (const char *name, rl_command_func_t *function) @@ -2448,33 +2475,33 @@ functions much more useful. It is certainly easy to try something if 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 +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()'. +operation. This is done with ‘rl_begin_undo_group()’ and +‘rl_end_undo_group()’. The types of events that can be undone are: enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; - Notice that 'UNDO_DELETE' means to insert some text, and -'UNDO_INSERT' means to delete some text. That is, the undo code tells -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()'. + Notice that ‘UNDO_DELETE’ means to insert some text, and +‘UNDO_INSERT’ means to delete some text. That is, the undo code tells +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 (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 (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()'. + 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()’. -- Function: void rl_add_undo (enum undo_code what, int start, int end, char *text) @@ -2485,11 +2512,11 @@ added by 'rl_begin_undo_group()' and 'rl_end_undo_group()'. Free the existing undo list. -- Function: int rl_do_undo (void) - Undo the first thing on the undo list. Returns '0' if there was + 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. @@ -2506,7 +2533,7 @@ File: readline.info, Node: Redisplay, Next: Modifying Text, Prev: Allowing Un -- Function: void rl_redisplay (void) Change what's displayed on the screen to reflect the current - contents of 'rl_line_buffer'. + contents of ‘rl_line_buffer’. -- Function: int rl_forced_update_display (void) Force the line to be updated and redisplayed, whether or not @@ -2535,52 +2562,52 @@ File: readline.info, Node: Redisplay, Next: Modifying Text, Prev: Allowing Un 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 + 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 + 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. You should call 'rl_save_prompt' to save the + specifications. The resulting string is displayed in the “echo + area”. The echo area is also used to display numeric arguments and + search strings. You should call ‘rl_save_prompt’ to save the prompt information before calling this function. -- Function: int rl_clear_message (void) Clear the message in the echo area. If the prompt was saved with a - call to 'rl_save_prompt' before the last call to 'rl_message', call - 'rl_restore_prompt' before calling this function. + call to ‘rl_save_prompt’ before the last call to ‘rl_message’, call + ‘rl_restore_prompt’ before calling this function. -- 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 (void) Restore the local Readline prompt display state saved by the most - recent call to 'rl_save_prompt'. if 'rl_save_prompt' was called to - save the prompt before a call to 'rl_message', this function should - be called before the corresponding call to 'rl_clear_message'. + recent call to ‘rl_save_prompt’. if ‘rl_save_prompt’ was called to + save the prompt before a call to ‘rl_message’, this function should + be called before the corresponding call to ‘rl_clear_message’. -- 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 + 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. Applications may indicate that the prompt contains characters that take up no physical screen space when displayed by bracketing a sequence of such characters with the special markers - 'RL_PROMPT_START_IGNORE' and 'RL_PROMPT_END_IGNORE' (declared in - 'readline.h' as '\001' and '\002', respectively). This may be used + ‘RL_PROMPT_START_IGNORE’ and ‘RL_PROMPT_END_IGNORE’ (declared in + ‘readline.h’ as ‘\001’ and ‘\002’, respectively). This may be used to embed terminal-specific escape sequences in prompts. -- 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 + ‘rl_expand_prompt()’ to expand the prompt and sets ‘rl_prompt’ to the result. @@ -2611,7 +2638,7 @@ File: readline.info, Node: Modifying Text, Next: Character Input, Prev: Redis -- 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. + ‘rl_insert_text()’ instead. File: readline.info, Node: Character Input, Next: Terminal Management, Prev: Modifying Text, Up: Readline Convenience Functions @@ -2623,9 +2650,9 @@ File: readline.info, Node: Character Input, Next: Terminal Management, Prev: 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. + ‘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. + assigned to the ‘rl_event_hook’ variable. -- Function: int rl_getc (FILE *stream) Return the next character available from STREAM, which is assumed @@ -2634,35 +2661,35 @@ File: readline.info, Node: Character Input, Next: Terminal Management, Prev: -- 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()'. Up to 512 characters may be pushed back. - 'rl_stuff_char' returns 1 if the character was successfully + ‘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_execute_next (int c) - Make C be the next command to be executed when 'rl_read_key()' is + 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()'. + 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 + 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'. U must be greater than or equal to + assigned to ‘rl_event_hook’. U must be greater than or equal to zero (a zero-length timeout is equivalent to a poll). The default waiting period is one-tenth of a second. Returns the old timeout value. -- Function: int rl_set_timeout (unsigned int secs, unsigned int usecs) - Set a timeout for subsequent calls to 'readline()'. If Readline + Set a timeout for subsequent calls to ‘readline()’. If Readline does not read a complete line, or the number of characters - specified by 'rl_num_chars_to_read', before the duration specified + specified by ‘rl_num_chars_to_read’, before the duration specified by SECS (in seconds) and USECS (microseconds), it returns and sets - 'RL_STATE_TIMEOUT' in 'rl_readline_state'. Passing 0 for 'secs' - and 'usecs' cancels any previously set timeout; the convenience - macro 'rl_clear_timeout()' is shorthand for this. Returns 0 if the + ‘RL_STATE_TIMEOUT’ in ‘rl_readline_state’. Passing 0 for ‘secs’ + and ‘usecs’ cancels any previously set timeout; the convenience + macro ‘rl_clear_timeout()’ is shorthand for this. Returns 0 if the timeout is set successfully. -- Function: int rl_timeout_remaining (unsigned int *secs, unsigned int @@ -2673,7 +2700,7 @@ File: readline.info, Node: Character Input, Next: Terminal Management, Prev: value is -1 on error or when there is no timeout set, 0 when the timeout has expired (leaving *SECS and *USECS unchanged), and 1 if the timeout has not expired. If either of SECS and USECS is - 'NULL', the return value indicates whether the timeout has expired. + ‘NULL’, the return value indicates whether the timeout has expired. File: readline.info, Node: Terminal Management, Next: Utility Functions, Prev: Character Input, Up: Readline Convenience Functions @@ -2682,24 +2709,24 @@ File: readline.info, Node: Terminal Management, Next: Utility Functions, Prev ------------------------- -- Function: void rl_prep_terminal (int meta_flag) - Modify the terminal settings for Readline's use, so 'readline()' + 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 + 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()'. + ‘rl_prep_terminal()’. -- 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 + be displayed by ‘stty’) to their Readline equivalents. The bindings are performed in KMAP. -- Function: void rl_tty_unset_default_bindings (Keymap kmap) - Reset the bindings manipulated by 'rl_tty_set_default_bindings' so - that the terminal editing characters are bound to 'rl_insert'. The + Reset the bindings manipulated by ‘rl_tty_set_default_bindings’ so + that the terminal editing characters are bound to ‘rl_insert’. The bindings are performed in KMAP. -- Function: int rl_tty_set_echoing (int value) @@ -2711,8 +2738,8 @@ File: readline.info, Node: Terminal Management, Next: Utility Functions, Prev -- 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 as the terminal type (e.g., ‘vt100’). If + TERMINAL_NAME is ‘NULL’, the value of the ‘TERM’ environment variable is used. @@ -2723,35 +2750,35 @@ File: readline.info, Node: Utility Functions, Next: Miscellaneous Functions, -- Function: int rl_save_state (struct readline_state *sp) Save a snapshot of Readline's internal state to SP. The contents - of the READLINE_STATE structure are documented in 'readline.h'. + of the READLINE_STATE structure are documented in ‘readline.h’. The caller is responsible for allocating the structure. -- Function: int rl_restore_state (struct readline_state *sp) Restore Readline's internal state to that stored in SP, which must - have been saved by a call to 'rl_save_state'. The contents of the - READLINE_STATE structure are documented in 'readline.h'. The + have been saved by a call to ‘rl_save_state’. The contents of the + READLINE_STATE structure are documented in ‘readline.h’. The caller is responsible for freeing the structure. -- Function: void rl_free (void *mem) Deallocate the memory pointed to by MEM. MEM must have been - allocated by 'malloc'. + allocated by ‘malloc’. -- Function: void rl_replace_line (const char *text, int clear_undo) - Replace the contents of 'rl_line_buffer' with TEXT. The point and + 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: void rl_extend_line_buffer (int len) - Ensure that 'rl_line_buffer' has enough space to hold 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 + 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'. + Ring the terminal bell, obeying the setting of ‘bell-style’. -- Function: int rl_alphabetic (int c) Return 1 if C is an alphabetic character. @@ -2759,18 +2786,18 @@ File: readline.info, Node: Utility Functions, Next: Miscellaneous Functions, -- Function: void rl_display_match_list (char **matches, int len, int max) A convenience function for displaying a list of strings in columnar - format on Readline's output stream. 'matches' is the list of + format on Readline's output stream. ‘matches’ is the list of strings, in argv format, such as a list of completion matches. - '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 + ‘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::). When displaying completions, this function sets the number of columns - used for display to the value of 'completion-display-width', the - value of the environment variable 'COLUMNS', or the screen width, + used for display to the value of ‘completion-display-width’, the + value of the environment variable ‘COLUMNS’, or the screen width, in that order. - The following are implemented as macros, defined in 'chardefs.h'. + The following are implemented as macros, defined in ‘chardefs.h’. Applications should refrain from using them. -- Function: int _rl_uppercase_p (int c) @@ -2804,34 +2831,36 @@ File: readline.info, Node: Miscellaneous Functions, Next: Alternate Interface, 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. + ‘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. + current keymap, to ‘rl_outstream’. If the application has assigned + a value to ‘rl_macro_display_hook’, ‘rl_macro_dumper’ calls it + instead of printing anything. If READABLE is greater than 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::). + the Readline command ‘set VARIABLE VALUE’ had been executed in an + ‘inputrc’ file (*note Readline Init File Syntax::). -- Function: char * rl_variable_value (const char *variable) Return a string representing the value of the Readline variable - VARIABLE. For boolean variables, this string is either 'on' or - 'off'. + VARIABLE. For boolean variables, this string is either ‘on’ or + ‘off’. -- 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 + ‘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 + showing a balancing character when ‘blink-matching-paren’ has been enabled. -- Function: char * rl_get_termcap (const char *cap) @@ -2842,10 +2871,13 @@ File: readline.info, Node: Miscellaneous Functions, Next: Alternate Interface, not use all of a terminal's capabilities, and this function will return values for only those capabilities Readline uses. + -- Function: void rl_reparse_colors (void) + Read or re-read color definitions from ‘LS_COLORS’. + -- Function: void rl_clear_history (void) Clear the history list by deleting all of the entries, in the same - manner as the History library's 'clear_history()' function. This - differs from 'clear_history' because it frees private data Readline + manner as the History library's ‘clear_history()’ function. This + differs from ‘clear_history’ because it frees private data Readline saves in the history list. -- Function: void rl_activate_mark (void) @@ -2874,9 +2906,9 @@ File: readline.info, Node: Alternate Interface, Next: A Readline Example, Pre 2.4.12 Alternate Interface -------------------------- -An alternate interface is available to plain 'readline()'. Some +An alternate interface is available to plain ‘readline()’. Some applications need to interleave keyboard I/O with file, device, or -window system I/O, typically by using a main loop to 'select()' on +window system I/O, typically by using a main loop to ‘select()’ on various file descriptors. To accommodate this need, Readline can also be invoked as a 'callback' function from an event loop. There are functions available to make this easy. @@ -2887,21 +2919,21 @@ functions available to make this easy. expanded value of PROMPT. Save the value of LHANDLER to use as a handler function to call when a complete line of input has been entered. The handler function receives the text of the line as an - argument. As with 'readline()', the handler function should 'free' + argument. As with ‘readline()’, the handler function should ‘free’ the line when it it finished with it. -- 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 + 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 installed by 'rl_callback_handler_install' to + character completes the line, ‘rl_callback_read_char’ will invoke + the LHANDLER function installed by ‘rl_callback_handler_install’ to 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, + ‘rl_callback_handler_install’. If the LHANDLER function returns, and the line handler remains installed, the terminal settings are - modified for Readline's use again. 'EOF' is indicated by calling - LHANDLER with a 'NULL' line. + modified for Readline's use again. ‘EOF’ is indicated by calling + LHANDLER with a ‘NULL’ line. -- Function: void rl_callback_sigcleanup (void) Clean up any internal state the callback interface uses to maintain @@ -2914,9 +2946,9 @@ functions available to make this easy. Restore the terminal to its initial state and remove the line handler. You may call this function from within a callback as well as independently. If the LHANDLER installed by - 'rl_callback_handler_install' does not exit the program, either + ‘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 + ‘rl_deprep_term_function’ should be called before the program exits to reset the terminal settings. @@ -2927,8 +2959,8 @@ File: readline.info, Node: A Readline Example, Next: Alternate Interface Examp Here is a function which changes lowercase characters to their uppercase equivalents, and uppercase characters to lowercase. If this function -was bound to 'M-c', then typing 'M-c' would change the case of the -character under point. Typing 'M-1 0 M-c' would change the case of the +was bound to ‘M-c’, then typing ‘M-c’ would change the case of the +character under point. Typing ‘M-1 0 M-c’ would change the case of the following 10 characters, leaving the cursor on the last character changed. @@ -3125,88 +3157,88 @@ 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', 'SIGHUP', 'SIGALRM', -'SIGTSTP', 'SIGTTIN', and 'SIGTTOU'). When one of these signals is +number of signals (‘SIGINT’, ‘SIGQUIT’, ‘SIGTERM’, ‘SIGHUP’, ‘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 resend the +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 +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()' below). +‘rl_free_line_state()’ below). - There is an additional Readline signal handler, for 'SIGWINCH', which + 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 +example, if a user resizes an ‘xterm’). The Readline ‘SIGWINCH’ 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 +‘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 +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. When an application is using the callback interface (*note Alternate Interface::), Readline installs signal handlers only for the duration of -the call to 'rl_callback_read_char'. Applications using the callback +the call to ‘rl_callback_read_char’. Applications using the callback interface should be prepared to clean up Readline's state if they wish to handle the signal before the line handler completes and restores the terminal state. If an application using the callback interface wishes to have Readline install its signal handlers at the time the application calls -'rl_callback_handler_install' and remove them only when a complete line +‘rl_callback_handler_install’ and remove them only when a complete line of input has been read, it should set the -'rl_persistent_signal_handlers' variable to a non-zero value. This +‘rl_persistent_signal_handlers’ variable to a non-zero value. This allows an application to defer all of the handling of the signals Readline catches to Readline. Applications should use this variable with care; it can result in Readline catching signals and not acting on them (or allowing the application to react to them) until the -application calls 'rl_callback_read_char'. This can result in an +application calls ‘rl_callback_read_char’. This can result in an application becoming less responsive to keyboard signals like SIGINT. If an application does not want or need to perform any signal handling, or does not need to do any processing between calls to -'rl_callback_read_char', setting this variable may be desirable. +‘rl_callback_read_char’, setting this variable may be desirable. 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 If this variable is non-zero, Readline will install signal handlers - for 'SIGINT', 'SIGQUIT', 'SIGTERM', 'SIGHUP', 'SIGALRM', 'SIGTSTP', - 'SIGTTIN', and 'SIGTTOU'. + for ‘SIGINT’, ‘SIGQUIT’, ‘SIGTERM’, ‘SIGHUP’, ‘SIGALRM’, ‘SIGTSTP’, + ‘SIGTTIN’, and ‘SIGTTOU’. - The default value of 'rl_catch_signals' is 1. + The default value of ‘rl_catch_signals’ is 1. -- Variable: int rl_catch_sigwinch If this variable is set to a non-zero value, Readline will install - a signal handler for 'SIGWINCH'. + a signal handler for ‘SIGWINCH’. - The default value of 'rl_catch_sigwinch' is 1. + The default value of ‘rl_catch_sigwinch’ is 1. -- Variable: int rl_persistent_signal_handlers If an application using the callback interface wishes Readline's signal handlers to be installed and active during the set of calls - to 'rl_callback_read_char' that constitutes an entire single line, + to ‘rl_callback_read_char’ that constitutes an entire single line, it should set this variable to a non-zero value. - The default value of 'rl_persistent_signal_handlers' is 0. + The default value of ‘rl_persistent_signal_handlers’ is 0. -- Variable: int rl_change_environment If this variable is set to a non-zero value, and Readline is - handling 'SIGWINCH', Readline will modify the LINES and COLUMNS - environment variables upon receipt of a 'SIGWINCH' + handling ‘SIGWINCH’, Readline will modify the LINES and COLUMNS + environment variables upon receipt of a ‘SIGWINCH’ - The default value of 'rl_change_environment' is 1. + The default value of ‘rl_change_environment’ is 1. If an application does not wish to have Readline catch any signals, -or to handle signals other than those Readline catches ('SIGHUP', for +or to handle signals other than those Readline catches (‘SIGHUP’, for example), Readline provides convenience functions to do the necessary terminal and internal state cleanup upon receipt of a signal. @@ -3217,45 +3249,45 @@ 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'. + ‘rl_catch_signals’ and ‘rl_catch_sigwinch’. -- Function: void rl_free_line_state (void) This will free any partial state associated with the current input 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 - 'SIGINT' calls this to abort the current input line. + ‘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) This will reinitialize the terminal and reinstall any Readline - signal handlers, depending on the values of 'rl_catch_signals' and - 'rl_catch_sigwinch'. + signal handlers, depending on the values of ‘rl_catch_signals’ and + ‘rl_catch_sigwinch’. If an application wants to force Readline to handle any signals that -have arrived while it has been executing, 'rl_check_signals()' will call +have arrived while it has been executing, ‘rl_check_signals()’ will call Readline's internal signal handler if there are any pending signals. This is primarily intended for those applications that use a custom -'rl_getc_function' (*note Readline Variables::) and wish to handle +‘rl_getc_function’ (*note Readline Variables::) and wish to handle signals received while waiting for input. -- Function: void rl_check_signals (void) If there are any pending signals, call Readline's internal signal - handling functions to process them. 'rl_pending_signal()' can be + handling functions to process them. ‘rl_pending_signal()’ can be used independently to determine whether or not there are any pending signals. - If an application does not wish Readline to catch 'SIGWINCH', it may -call 'rl_resize_terminal()' or 'rl_set_screen_size()' to force Readline -to update its idea of the terminal size when it receives a 'SIGWINCH'. + If an application does not wish Readline to catch ‘SIGWINCH’, it may +call ‘rl_resize_terminal()’ or ‘rl_set_screen_size()’ to force Readline +to update its idea of the terminal size when it receives a ‘SIGWINCH’. -- Function: void rl_echo_signal_char (int sig) If an application wishes to install its own signal handlers, but still have Readline display characters that generate signals, - calling this function with SIG set to 'SIGINT', 'SIGQUIT', or - 'SIGTSTP' will display the character generating that signal. + calling this function with SIG set to ‘SIGINT’, ‘SIGQUIT’, or + ‘SIGTSTP’ will display the character generating that signal. -- Function: void rl_resize_terminal (void) Update Readline's internal screen size by reading values from the @@ -3269,7 +3301,7 @@ to update its idea of the terminal size when it receives a 'SIGWINCH'. and is used internally to calculate the maximum number of characters that may appear on a single line and on the screen. - If an application does not want to install a 'SIGWINCH' handler, but + If an application does not want to install a ‘SIGWINCH’ handler, but is still interested in the screen dimensions, it may query Readline's idea of the screen size. @@ -3285,14 +3317,14 @@ idea of the screen size. handlers. -- Function: int rl_set_signals (void) - Install Readline's signal handler for 'SIGINT', 'SIGQUIT', - 'SIGTERM', 'SIGHUP', 'SIGALRM', 'SIGTSTP', 'SIGTTIN', 'SIGTTOU', - and 'SIGWINCH', depending on the values of 'rl_catch_signals' and - 'rl_catch_sigwinch'. + Install Readline's signal handler for ‘SIGINT’, ‘SIGQUIT’, + ‘SIGTERM’, ‘SIGHUP’, ‘SIGALRM’, ‘SIGTSTP’, ‘SIGTTIN’, ‘SIGTTOU’, + and ‘SIGWINCH’, depending on the values of ‘rl_catch_signals’ and + ‘rl_catch_sigwinch’. -- 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 @@ -3330,48 +3362,48 @@ 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 + 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 + 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 + 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'. + ‘rl_completion_entry_function’. 3. The generator function is called repeatedly from - 'rl_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. The generator function returns '(char *)NULL' to inform - 'rl_completion_matches()' that there are no more possibilities + 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 + match must be allocated with ‘malloc()’; Readline frees the strings when it has finished with them. Such a generator function is - referred to as an "application-specific completion function". + referred to as an “application-specific completion function”. -- 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 'rl_completion_matches()'). The default is to do filename + (see ‘rl_completion_matches()’). The default is to do filename completion. -- 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. - An "application-specific completion function" is a function whose - address is assigned to 'rl_completion_entry_function' and whose + ‘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. + An “application-specific completion function” is a function whose + address is assigned to ‘rl_completion_entry_function’ and whose return values are used to generate possible completions. @@ -3385,50 +3417,50 @@ Readline. -- Function: int rl_complete_internal (int what_to_do) Complete the word at or before point. WHAT_TO_DO says what to do - with the completion. A value of '?' means list the possible - completions. 'TAB' means do standard completion. '*' means insert - all of the possible completions. '!' means to display all of the + with the completion. A value of ‘?’ means list the possible + completions. ‘TAB’ means do standard completion. ‘*’ means insert + all of the possible completions. ‘!’ means to display all of the possible completions, if there is more than one, as well as - performing partial completion. '@' is similar to '!', but possible + performing partial completion. ‘@’ is similar to ‘!’, but possible completions are not listed if the possible completions share a common prefix. -- 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 'rl_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) - List the possible completions. See description of 'rl_complete - ()'. This calls 'rl_complete_internal()' with an argument of '?'. + List the possible completions. See description of ‘rl_complete + ()’. This calls ‘rl_complete_internal()’ with an argument of ‘?’. -- 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 '*'. + 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 appropriate value to pass to 'rl_complete_internal()' + Returns the appropriate value to pass to ‘rl_complete_internal()’ depending on whether CFUNC was called twice in succession and the - values of the 'show-all-if-ambiguous' and 'show-all-if-unmodified' + values of the ‘show-all-if-ambiguous’ and ‘show-all-if-unmodified’ variables. Application-specific completion functions may use this - function to present the same interface as 'rl_complete()'. + 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 + 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. + terminated with a ‘NULL’ pointer. - ENTRY_FUNC is a function of two args, and returns a 'char *'. The + 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 + returns a ‘NULL’ pointer to the caller when there are no more matches. -- Function: char * rl_filename_completion_function (const char *text, @@ -3441,7 +3473,7 @@ Readline. -- 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 + username preceded by a random character (usually ‘~’). As with all completion generators, STATE is zero on the first call and non-zero for subsequent calls. @@ -3452,19 +3484,19 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam -------------------------- -- 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 + A pointer to the generator function for ‘rl_completion_matches()’. + ‘NULL’ means to use ‘rl_filename_completion_function()’, the default filename completer. -- 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' 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 + 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 + 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. @@ -3472,11 +3504,11 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam A pointer to a function that will quote a filename in an 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. + ‘rl_filename_quote_characters’ appears in a completed filename. The function is called with TEXT, MATCH_TYPE, and QUOTE_POINTER. The TEXT is the filename to be quoted. The MATCH_TYPE is either - 'SINGLE_MATCH', if there is only one completion match, or - 'MULT_MATCH'. Some functions use this to decide whether or not to + ‘SINGLE_MATCH’, if there is only one completion match, or + ‘MULT_MATCH’. Some functions use this to decide whether or not to insert a closing quote character. The QUOTE_POINTER is a pointer to any opening quote character the user typed. Some functions choose to reset this character. @@ -3487,7 +3519,7 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam so those characters do not interfere with matching the text against names in the filesystem. It is called with TEXT, the text of the word to be dequoted, and QUOTE_CHAR, which is the quoting character - that delimits the filename (usually ''' or '"'). If QUOTE_CHAR is + that delimits the filename (usually ‘'’ or ‘"’). If QUOTE_CHAR is zero, the filename was not in an embedded string. -- Variable: rl_linebuf_func_t * rl_char_is_quoted_p @@ -3497,14 +3529,14 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam 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 + ‘rl_completer_word_break_characters’ should be used to break words for the completer. -- 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 + 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. @@ -3520,7 +3552,7 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam portion of the pathname the user typed. At the least, even if no other expansion is performed, this function should remove any quote characters from the directory name, because its result will be - passed directly to 'opendir()'. + passed directly to ‘opendir()’. The directory completion hook returns an integer that should be non-zero if the function modifies its directory argument. The @@ -3530,13 +3562,13 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam If non-zero, this is the address of a function to call when completing a directory name. This function takes the address of the directory name to be modified as an argument. Unlike - 'rl_directory_completion_hook', it only modifies the directory name - used in 'opendir', not what is displayed when the possible + ‘rl_directory_completion_hook’, it only modifies the directory name + used in ‘opendir’, not what is displayed when the possible completions are printed or inserted. It is called before rl_directory_completion_hook. At the least, even if no other expansion is performed, this function should remove any quote characters from the directory name, because its result will be - passed directly to 'opendir()'. + passed directly to ‘opendir()’. The directory rewrite hook returns an integer that should be non-zero if the function modifies its directory argument. The @@ -3546,7 +3578,7 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam If non-zero, this is the address of a function for the completer to call before deciding which character to append to a completed name. This function modifies its filename name argument, and the modified - value is passed to 'stat()' to determine the file's type and + value is passed to ‘stat()’ to determine the file's type and characteristics. This function does not need to remove quote characters from the filename. @@ -3557,58 +3589,75 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam -- Variable: rl_dequote_func_t * rl_filename_rewrite_hook If non-zero, this is the address of a function called when reading directory entries from the filesystem for completion and comparing - them to the partial word to be completed. The function should - perform any necessary application or system-specific conversion on - the filename, such as converting between character sets or - converting from a filesystem format to a character input format. - The function takes two arguments: FNAME, the filename to be - converted, and FNLEN, its length in bytes. It must either return - its first argument (if no conversion takes place) or the converted - filename in newly-allocated memory. The converted form is used to - compare against the word to be completed, and, if it matches, is - added to the list of matches. Readline will free the allocated - string. + them to the filename portion of the partial word to be completed + (after its potential modification by ‘rl_completion_rewrite_hook’). + The function should perform any necessary application or + system-specific conversion on the filename, such as converting + between character sets or converting from a filesystem format to a + character input format. The function takes two arguments: FNAME, + the filename to be converted, and FNLEN, its length in bytes. It + must either return its first argument (if no conversion takes + place) or the converted filename in newly-allocated memory. The + converted form is used to compare against the word to be completed, + and, if it matches, is added to the list of matches. Readline will + free the allocated string. + + -- Variable: rl_dequote_func_t * rl_completion_rewrite_hook + If non-zero, this is the address of a function to call before + comparing the filename portion of a word to be completed with + directory entries from the filesystem. The function takes two + arguments: FNAME, the filename to be converted, after any + ‘rl_filename_dequoting_function’ has been applied, and FNLEN, its + length in bytes. It must either return its first argument (if no + conversion takes place) or the converted filename in + newly-allocated memory. The function should perform any necessary + application or system-specific conversion on the filename, such as + converting between character sets or converting from a character + input format to some other format. Readline compares the converted + form against directory entries, after their potential modification + by ‘rl_filename_rewrite_hook’, and adds any matches to the list of + matches. Readline will free the allocated string. -- 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 + 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 + ‘rl_display_match_list’, that takes care of doing the display to Readline's output stream. You may call that function 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: '" - \t\n\"\\'`@$><=;|&{("'. + characters which break words for completion in Bash: ‘" + \t\n\"\\'`@$><=;|&{("’. -- Variable: const char * rl_basic_quote_characters A list of quote characters which can cause a word break. -- 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_basic_word_break_characters'. + ‘rl_complete_internal()’. The default list is the value of + ‘rl_basic_word_break_characters’. -- Variable: rl_cpvfunc_t * rl_completion_word_break_hook If non-zero, this is the address of a function to call when Readline is deciding where to separate words for word completion. It should return a character string like - 'rl_completer_word_break_characters' to be used to perform the + ‘rl_completer_word_break_characters’ to be used to perform the current completion. The function may choose to set - 'rl_completer_word_break_characters' itself. If the function - returns 'NULL', 'rl_completer_word_break_characters' is used. + ‘rl_completer_word_break_characters’ itself. If the function + returns ‘NULL’, ‘rl_completer_word_break_characters’ is used. -- 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 + substring ‘rl_completer_word_break_characters’ are treated as any other character, unless they also appear within this list. -- Variable: const char * rl_filename_quote_characters @@ -3633,8 +3682,8 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam -- 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 completion - text. The default is a space character (' '). Setting this to the - null character ('\0') prevents anything being appended + text. The default is a space character (‘ ’). Setting this to the + null character (‘\0’) prevents anything being appended automatically. This can be changed in application-specific completion functions to provide the "most sensible word separator character" according to an application-specific command line syntax @@ -3688,22 +3737,31 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam function. If it is set to a non-zero value by such a function, directory names have a slash appended and Readline attempts to quote completed filenames if they contain any characters in - 'rl_filename_quote_characters' and 'rl_filename_quoting_desired' is + ‘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 when + ‘rl_filename_quote_chars’. This is _always_ non-zero when completion is attempted, and can only be changed within an application-specific completion function. The quoting is effected via a call to the function pointed to by - 'rl_filename_quoting_function'. + ‘rl_filename_quoting_function’. + + -- Variable: int rl_full_quoting_desired + Non-zero means that Readline should apply filename-style quoting, + including any application-specified quoting mechanism, to all + completion matches even if we are not otherwise treating the + matches as filenames. This is _always_ zero when completion is + attempted, and can only be changed within an application-specific + completion 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 + ‘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. @@ -3713,27 +3771,27 @@ File: readline.info, Node: Completion Variables, Next: A Short Completion Exam the list of completions (which implies that it cannot remove any duplicate completions). The default value is 1, which means that Readline will sort the completions and, depending on the value of - 'rl_ignore_completion_duplicates', will attempt to remove duplicate + ‘rl_ignore_completion_duplicates’, will attempt to remove duplicate matches. -- 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 + ‘rl_complete_internal()’ (*note Completion Functions::) for the list of characters. This is set to the appropriate value before any application-specific completion function is called, allowing - such functions to present the same interface as 'rl_complete()'. + such functions to present the same interface as ‘rl_complete()’. -- Variable: int rl_completion_invoking_key Set to the final character in the key sequence that invoked one of - the completion functions that call 'rl_complete_internal()'. This + the completion functions that call ‘rl_complete_internal()’. This is set to the appropriate value before any application-specific completion function is called. -- Variable: int rl_inhibit_completion If this variable is non-zero, completion is inhibited. The completion character will be inserted as any other bound to - 'self-insert'. + ‘self-insert’. File: readline.info, Node: A Short Completion Example, Prev: Completion Variables, Up: Custom Completers @@ -3742,8 +3800,8 @@ File: readline.info, Node: A Short Completion Example, Prev: Completion Variab -------------------------------- Here is a small application demonstrating the use of the GNU Readline -library. It is called 'fileman', and the source code resides in -'examples/fileman.c'. This sample application provides completion of +library. It is called ‘fileman’, and the source code resides in +‘examples/fileman.c’. This sample application provides completion of command names, line editing features, and access to the history list. /* fileman.c -- A tiny application which demonstrates how to use the @@ -3822,8 +3880,8 @@ command names, line editing features, and access to the history list. }; /* Forward declarations. */ - char *stripwhite (); - COMMAND *find_command (); + char *stripwhite (char *); + COMMAND *find_command (char *); /* The name of this program, as taken from argv[0]. */ char *progname; @@ -3832,8 +3890,7 @@ command names, line editing features, and access to the history list. int done; char * - dupstr (s) - char *s; + dupstr (char *s) { char *r; @@ -3842,9 +3899,8 @@ command names, line editing features, and access to the history list. return (r); } - main (argc, argv) - int argc; - char **argv; + int + main (int argc, char **argv) { char *line, *s; @@ -3880,8 +3936,7 @@ command names, line editing features, and access to the history list. /* Execute a command line. */ int - execute_line (line) - char *line; + execute_line (char *line) { register int i; COMMAND *command; @@ -3920,8 +3975,7 @@ command names, line editing features, and access to the history list. /* Look up NAME as the name of a command, and return a pointer to that command. Return a NULL pointer if NAME isn't a command name. */ COMMAND * - find_command (name) - char *name; + find_command (char *name) { register int i; @@ -3935,8 +3989,7 @@ command names, line editing features, and access to the history list. /* Strip whitespace from the start and end of STRING. Return a pointer into STRING. */ char * - stripwhite (string) - char *string; + stripwhite (char *string) { register char *s, *t; @@ -3960,13 +4013,14 @@ command names, line editing features, and access to the history list. /* */ /* **************************************************************** */ - char *command_generator PARAMS((const char *, int)); - char **fileman_completion PARAMS((const char *, int, int)); + char *command_generator (const char *, int); + char **fileman_completion (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. */ - initialize_readline () + void + initialize_readline (void) { /* Allow conditional parsing of the ~/.inputrc file. */ rl_readline_name = "FileMan"; @@ -3981,9 +4035,7 @@ command names, line editing features, and access to the history list. in case we want to do some simple parsing. Return the array of matches, or NULL if there aren't any. */ char ** - fileman_completion (text, start, end) - const char *text; - int start, end; + fileman_completion (const char *text, int start, int end) { char **matches; @@ -4002,9 +4054,7 @@ command names, line editing features, and access to the history list. 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) - const char *text; - int state; + command_generator (const char *text, int state) { static int list_index, len; char *name; @@ -4042,40 +4092,40 @@ command names, line editing features, and access to the history list. static char syscom[1024]; /* List the file(s) named in arg. */ - com_list (arg) - char *arg; + int + com_list (char *arg) { if (!arg) arg = ""; - sprintf (syscom, "ls -FClg %s", arg); + snprintf (syscom, sizeof (syscom), "ls -FClg %s", arg); return (system (syscom)); } - com_view (arg) - char *arg; + int + com_view (char *arg) { if (!valid_argument ("view", arg)) return 1; #if defined (__MSDOS__) /* more.com doesn't grok slashes in pathnames */ - sprintf (syscom, "less %s", arg); + snprintf (syscom, sizeof (syscom), "less %s", arg); #else - sprintf (syscom, "more %s", arg); + snprintf (syscom, sizeof (syscom), "more %s", arg); #endif return (system (syscom)); } - com_rename (arg) - char *arg; + int + com_rename (char *arg) { too_dangerous ("rename"); return (1); } - com_stat (arg) - char *arg; + int + com_stat (char *arg) { struct stat finfo; @@ -4102,8 +4152,8 @@ command names, line editing features, and access to the history list. return (0); } - com_delete (arg) - char *arg; + int + com_delete (char *arg) { too_dangerous ("delete"); return (1); @@ -4111,8 +4161,8 @@ command names, line editing features, and access to the history list. /* Print out help for ARG, or for all of the commands if ARG is not present. */ - com_help (arg) - char *arg; + int + com_help (char *arg) { register int i; int printed = 0; @@ -4150,8 +4200,8 @@ command names, line editing features, and access to the history list. } /* Change to the directory ARG. */ - com_cd (arg) - char *arg; + int + com_cd (char *arg) { if (chdir (arg) == -1) { @@ -4164,8 +4214,8 @@ command names, line editing features, and access to the history list. } /* Print out the current working directory. */ - com_pwd (ignore) - char *ignore; + int + com_pwd (char *ignore) { char dir[1024], *s; @@ -4181,16 +4231,16 @@ command names, line editing features, and access to the history list. } /* The user wishes to quit using this program. Just set DONE non-zero. */ - com_quit (arg) - char *arg; + int + com_quit (char *arg) { done = 1; return (0); } /* Function which tells you that you can't do this. */ - too_dangerous (caller) - char *caller; + void + too_dangerous (char *caller) { fprintf (stderr, "%s: Too dangerous for me to distribute. Write it yourself.\n", @@ -4200,8 +4250,7 @@ command names, line editing features, and access to the history list. /* 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; + valid_argument (char *caller, char *arg) { if (!arg || !*arg) { @@ -4220,7 +4269,7 @@ Appendix A GNU Free Documentation License Version 1.3, 3 November 2008 - Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies @@ -4229,7 +4278,7 @@ Appendix A GNU Free Documentation License 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other - functional and useful document "free" in the sense of freedom: to + functional and useful document “free” in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the @@ -4761,7 +4810,7 @@ Function and Variable Index * bind-tty-special-chars: Readline Init File Syntax. (line 68) * blink-matching-paren: Readline Init File Syntax. - (line 73) + (line 76) * bracketed-paste-begin (): Commands For Text. (line 36) * call-last-kbd-macro (C-x e): Keyboard Macros. (line 13) * capitalize-word (M-c): Commands For Text. (line 69) @@ -4772,39 +4821,39 @@ Function and Variable Index * clear-display (M-C-l): Commands For Moving. (line 40) * clear-screen (C-l): Commands For Moving. (line 45) * colored-completion-prefix: Readline Init File Syntax. - (line 78) + (line 81) * colored-stats: Readline Init File Syntax. - (line 88) + (line 91) * comment-begin: Readline Init File Syntax. - (line 94) + (line 97) * complete (<TAB>): Commands For Completion. (line 6) * completion-display-width: Readline Init File Syntax. - (line 99) + (line 102) * completion-ignore-case: Readline Init File Syntax. - (line 106) + (line 109) * completion-map-case: Readline Init File Syntax. - (line 111) + (line 114) * completion-prefix-display-length: Readline Init File Syntax. - (line 117) + (line 120) * completion-query-items: Readline Init File Syntax. - (line 124) + (line 127) * convert-meta: Readline Init File Syntax. - (line 135) + (line 138) * copy-backward-word (): Commands For Killing. - (line 60) + (line 53) * copy-forward-word (): Commands For Killing. - (line 65) + (line 58) * copy-region-as-kill (): Commands For Killing. - (line 56) + (line 49) * delete-char (C-d): Commands For Text. (line 12) * delete-char-or-list (): Commands For Completion. (line 39) * delete-horizontal-space (): Commands For Killing. - (line 48) + (line 41) * digit-argument (M-0, M-1, ... M--): Numeric Arguments. (line 6) * disable-completion: Readline Init File Syntax. - (line 145) + (line 148) * do-lowercase-version (M-A, M-B, M-X, ...): Miscellaneous Commands. (line 14) * downcase-word (M-l): Commands For Text. (line 65) @@ -4815,19 +4864,19 @@ Function and Variable Index * dump-variables (): Miscellaneous Commands. (line 76) * echo-control-characters: Readline Init File Syntax. - (line 150) + (line 153) * editing-mode: Readline Init File Syntax. - (line 155) + (line 158) * emacs-editing-mode (C-e): Miscellaneous Commands. (line 88) * emacs-mode-string: Readline Init File Syntax. - (line 161) + (line 164) * enable-active-region: Readline Init File Syntax. - (line 171) + (line 174) * enable-bracketed-paste: Readline Init File Syntax. - (line 184) + (line 187) * enable-keypad: Readline Init File Syntax. - (line 193) + (line 196) * end-kbd-macro (C-x )): Keyboard Macros. (line 9) * end-of-file (usually C-d): Commands For Text. (line 6) * end-of-history (M->): Commands For History. @@ -4835,8 +4884,10 @@ Function and Variable Index * end-of-line (C-e): Commands For Moving. (line 9) * exchange-point-and-mark (C-x C-x): Miscellaneous Commands. (line 37) +* execute-named-command (M-x): Miscellaneous Commands. + (line 96) * expand-tilde: Readline Init File Syntax. - (line 204) + (line 207) * fetch-history (): Commands For History. (line 102) * forward-backward-delete-char (): Commands For Text. (line 21) @@ -4845,51 +4896,51 @@ Function and Variable Index (line 32) * forward-word (M-f): Commands For Moving. (line 18) * history-preserve-point: Readline Init File Syntax. - (line 208) + (line 211) * history-search-backward (): Commands For History. (line 56) * history-search-forward (): Commands For History. (line 50) * history-size: Readline Init File Syntax. - (line 214) + (line 217) * history-substring-search-backward (): Commands For History. (line 68) * history-substring-search-forward (): Commands For History. (line 62) * horizontal-scroll-mode: Readline Init File Syntax. - (line 223) + (line 226) * input-meta: Readline Init File Syntax. - (line 232) + (line 235) * insert-comment (M-#): Miscellaneous Commands. (line 61) * insert-completions (M-*): Commands For Completion. (line 18) * isearch-terminators: Readline Init File Syntax. - (line 242) + (line 245) * keymap: Readline Init File Syntax. - (line 249) + (line 252) * kill-line (C-k): Commands For Killing. (line 6) * kill-region (): Commands For Killing. - (line 52) + (line 45) * kill-whole-line (): Commands For Killing. (line 19) * kill-word (M-d): Commands For Killing. (line 23) * mark-modified-lines: Readline Init File Syntax. - (line 279) + (line 282) * mark-symlinked-directories: Readline Init File Syntax. - (line 284) + (line 287) * match-hidden-files: Readline Init File Syntax. - (line 289) + (line 292) * menu-complete (): Commands For Completion. (line 22) * menu-complete-backward (): Commands For Completion. (line 34) * menu-complete-display-prefix: Readline Init File Syntax. - (line 296) + (line 299) * meta-flag: Readline Init File Syntax. - (line 232) + (line 235) * next-history (C-n): Commands For History. (line 16) * next-screen-line (): Commands For Moving. (line 33) @@ -4900,10 +4951,10 @@ Function and Variable Index * operate-and-get-next (C-o): Commands For History. (line 95) * output-meta: Readline Init File Syntax. - (line 301) + (line 304) * overwrite-mode (): Commands For Text. (line 73) * page-completions: Readline Init File Syntax. - (line 309) + (line 312) * possible-completions (M-?): Commands For Completion. (line 11) * prefix-meta (<ESC>): Miscellaneous Commands. @@ -4920,35 +4971,35 @@ Function and Variable Index * reverse-search-history (C-r): Commands For History. (line 26) * revert-all-at-newline: Readline Init File Syntax. - (line 319) + (line 322) * revert-line (M-r): Miscellaneous Commands. (line 26) * rl_activate_mark: Miscellaneous Functions. - (line 55) + (line 60) * rl_add_defun: Function Naming. (line 18) * rl_add_funmap_entry: Associating Function Names and Bindings. - (line 62) + (line 69) * rl_add_undo: Allowing Undoing. (line 39) * rl_alphabetic: Utility Functions. (line 38) * rl_already_prompted: Readline Variables. (line 70) * rl_attempted_completion_function: Completion Variables. (line 11) * rl_attempted_completion_over: Completion Variables. - (line 256) + (line 282) * rl_basic_quote_characters: Completion Variables. - (line 143) + (line 160) * rl_basic_word_break_characters: Completion Variables. - (line 137) + (line 154) * rl_begin_undo_group: Allowing Undoing. (line 28) -* rl_binding_keymap: Readline Variables. (line 195) * rl_bind_key: Binding Keys. (line 21) +* rl_bind_key_if_unbound: Binding Keys. (line 30) +* rl_bind_key_if_unbound_in_map: Binding Keys. (line 36) +* rl_bind_key_in_map: Binding Keys. (line 25) * rl_bind_keyseq: Binding Keys. (line 57) * rl_bind_keyseq_if_unbound: Binding Keys. (line 75) * rl_bind_keyseq_if_unbound_in_map: Binding Keys. (line 81) * rl_bind_keyseq_in_map: Binding Keys. (line 64) -* rl_bind_key_if_unbound: Binding Keys. (line 30) -* rl_bind_key_if_unbound_in_map: Binding Keys. (line 36) -* rl_bind_key_in_map: Binding Keys. (line 25) +* rl_binding_keymap: Readline Variables. (line 204) * rl_callback_handler_install: Alternate Interface. (line 13) * rl_callback_handler_remove: Alternate Interface. (line 42) * rl_callback_read_char: Alternate Interface. (line 22) @@ -4966,7 +5017,7 @@ Function and Variable Index * rl_cleanup_after_signal: Readline Signal Handling. (line 107) * rl_clear_history: Miscellaneous Functions. - (line 49) + (line 54) * rl_clear_message: Redisplay. (line 51) * rl_clear_pending_input: Character Input. (line 29) * rl_clear_signals: Readline Signal Handling. @@ -4976,50 +5027,52 @@ Function and Variable Index (line 46) * rl_complete <1>: Completion Functions. (line 19) -* rl_completer_quote_characters: Completion Variables. - (line 160) -* rl_completer_word_break_characters: Completion Variables. - (line 146) * rl_complete_internal: Completion Functions. (line 9) +* rl_completer_quote_characters: Completion Variables. + (line 177) +* rl_completer_word_break_characters: Completion Variables. + (line 163) * rl_completion_append_character: Completion Variables. - (line 185) + (line 202) * rl_completion_display_matches_hook: Completion Variables. - (line 124) + (line 141) * rl_completion_entry_function: How Completing Works. (line 52) * rl_completion_entry_function <1>: Completion Variables. (line 6) * rl_completion_found_quote: Completion Variables. - (line 215) + (line 232) * rl_completion_invoking_key: Completion Variables. - (line 279) + (line 305) * rl_completion_mark_symlink_dirs: Completion Variables. - (line 221) + (line 238) * rl_completion_matches: Completion Functions. (line 43) * rl_completion_mode: Completion Functions. (line 36) * rl_completion_query_items: Completion Variables. - (line 178) + (line 195) * rl_completion_quote_character: Completion Variables. - (line 203) + (line 220) +* rl_completion_rewrite_hook: Completion Variables. + (line 125) * rl_completion_suppress_append: Completion Variables. - (line 197) + (line 214) * rl_completion_suppress_quote: Completion Variables. - (line 209) + (line 226) * rl_completion_type: Completion Variables. - (line 271) + (line 297) * rl_completion_word_break_hook: Completion Variables. - (line 151) + (line 168) * rl_copy_keymap: Keymaps. (line 16) * rl_copy_text: Modifying Text. (line 14) * rl_crlf: Redisplay. (line 33) * rl_deactivate_mark: Miscellaneous Functions. - (line 62) + (line 67) * rl_delete_text: Modifying Text. (line 10) +* rl_deprep_term_function: Readline Variables. (line 186) * rl_deprep_terminal: Terminal Management. (line 12) -* rl_deprep_term_function: Readline Variables. (line 185) * rl_ding: Utility Functions. (line 35) * rl_directory_completion_hook: Completion Variables. (line 63) @@ -5029,11 +5082,11 @@ Function and Variable Index * rl_dispatching: Readline Variables. (line 47) * rl_display_match_list: Utility Functions. (line 41) * rl_display_prompt: Readline Variables. (line 65) -* rl_done: Readline Variables. (line 27) * rl_do_undo: Allowing Undoing. (line 47) +* rl_done: Readline Variables. (line 27) * rl_echo_signal_char: Readline Signal Handling. (line 143) -* rl_editing_mode: Readline Variables. (line 301) +* rl_editing_mode: Readline Variables. (line 310) * rl_empty_keymap: Keymaps. (line 33) * rl_end: Readline Variables. (line 18) * rl_end_undo_group: Allowing Undoing. (line 34) @@ -5041,23 +5094,23 @@ Function and Variable Index * rl_erase_empty_line: Readline Variables. (line 53) * rl_event_hook: Readline Variables. (line 130) * rl_execute_next: Character Input. (line 25) -* rl_executing_key: Readline Variables. (line 202) -* rl_executing_keymap: Readline Variables. (line 191) -* rl_executing_keyseq: Readline Variables. (line 206) -* rl_executing_macro: Readline Variables. (line 199) +* rl_executing_key: Readline Variables. (line 211) +* rl_executing_keymap: Readline Variables. (line 200) +* rl_executing_keyseq: Readline Variables. (line 215) +* rl_executing_macro: Readline Variables. (line 208) * rl_expand_prompt: Redisplay. (line 66) -* rl_explicit_arg: Readline Variables. (line 292) +* rl_explicit_arg: Readline Variables. (line 301) * rl_extend_line_buffer: Utility Functions. (line 26) * rl_filename_completion_desired: Completion Variables. - (line 236) + (line 253) * rl_filename_completion_function: Completion Functions. (line 57) * rl_filename_dequoting_function: Completion Variables. (line 36) * rl_filename_quote_characters: Completion Variables. - (line 166) + (line 183) * rl_filename_quoting_desired: Completion Variables. - (line 246) + (line 263) * rl_filename_quoting_function: Completion Variables. (line 23) * rl_filename_rewrite_hook: Completion Variables. @@ -5070,31 +5123,33 @@ Function and Variable Index * rl_free_line_state: Readline Signal Handling. (line 113) * rl_free_undo_list: Allowing Undoing. (line 44) +* rl_full_quoting_desired: Completion Variables. + (line 273) * rl_function_dumper: Associating Function Names and Bindings. - (line 46) + (line 53) * rl_function_of_keyseq: Associating Function Names and Bindings. (line 13) * rl_function_of_keyseq_len: Associating Function Names and Bindings. (line 22) * rl_funmap_names: Associating Function Names and Bindings. - (line 56) + (line 63) * rl_generic_bind: Binding Keys. (line 87) -* rl_getc: Character Input. (line 14) -* rl_getc_function: Readline Variables. (line 135) * rl_get_keymap: Keymaps. (line 40) * rl_get_keymap_by_name: Keymaps. (line 46) * rl_get_keymap_name: Keymaps. (line 51) * rl_get_screen_size: Readline Signal Handling. (line 165) * rl_get_termcap: Miscellaneous Functions. - (line 41) + (line 43) +* rl_getc: Character Input. (line 14) +* rl_getc_function: Readline Variables. (line 135) * rl_gnu_readline_p: Readline Variables. (line 89) * rl_ignore_completion_duplicates: Completion Variables. - (line 232) + (line 249) * rl_ignore_some_completions_function: Completion Variables. (line 55) * rl_inhibit_completion: Completion Variables. - (line 285) + (line 311) * rl_initialize: Utility Functions. (line 30) * rl_input_available_hook: Readline Variables. (line 151) * rl_insert_completions: Completion Functions. @@ -5106,29 +5161,30 @@ Function and Variable Index * rl_invoking_keyseqs_in_map: Associating Function Names and Bindings. (line 41) * rl_keep_mark_active: Miscellaneous Functions. - (line 65) -* rl_key_sequence_length: Readline Variables. (line 210) + (line 70) +* rl_key_sequence_length: Readline Variables. (line 219) * rl_kill_text: Modifying Text. (line 18) * rl_last_func: Readline Variables. (line 116) * rl_library_version: Readline Variables. (line 79) * rl_line_buffer: Readline Variables. (line 8) * rl_list_funmap_names: Associating Function Names and Bindings. - (line 52) + (line 59) * rl_macro_bind: Miscellaneous Functions. (line 6) +* rl_macro_display_hook: Readline Variables. (line 192) * rl_macro_dumper: Miscellaneous Functions. (line 13) * rl_make_bare_keymap: Keymaps. (line 11) * rl_make_keymap: Keymaps. (line 19) * rl_mark: Readline Variables. (line 23) * rl_mark_active_p: Miscellaneous Functions. - (line 71) + (line 76) * rl_message: Redisplay. (line 42) * rl_modifying: Allowing Undoing. (line 56) * rl_named_function: Associating Function Names and Bindings. (line 10) -* rl_numeric_arg: Readline Variables. (line 296) * rl_num_chars_to_read: Readline Variables. (line 38) +* rl_numeric_arg: Readline Variables. (line 305) * rl_on_new_line: Redisplay. (line 14) * rl_on_new_line_with_prompt: Redisplay. (line 18) * rl_outstream: Readline Variables. (line 107) @@ -5141,19 +5197,23 @@ Function and Variable Index * rl_point: Readline Variables. (line 14) * rl_possible_completions: Completion Functions. (line 27) +* rl_pre_input_hook: Readline Variables. (line 125) * rl_prefer_env_winsize: Readline Variables. (line 111) +* rl_prep_term_function: Readline Variables. (line 179) * rl_prep_terminal: Terminal Management. (line 6) -* rl_prep_term_function: Readline Variables. (line 178) -* rl_pre_input_hook: Readline Variables. (line 125) +* rl_print_keybinding: Associating Function Names and Bindings. + (line 46) * rl_prompt: Readline Variables. (line 59) * rl_push_macro_input: Modifying Text. (line 25) -* rl_readline_name: Readline Variables. (line 98) -* rl_readline_state: Readline Variables. (line 213) -* rl_readline_version: Readline Variables. (line 82) * rl_read_init_file: Binding Keys. (line 100) * rl_read_key: Character Input. (line 6) +* rl_readline_name: Readline Variables. (line 98) +* rl_readline_state: Readline Variables. (line 222) +* rl_readline_version: Readline Variables. (line 82) * rl_redisplay: Redisplay. (line 6) -* rl_redisplay_function: Readline Variables. (line 172) +* rl_redisplay_function: Readline Variables. (line 173) +* rl_reparse_colors: Miscellaneous Functions. + (line 51) * rl_replace_line: Utility Functions. (line 21) * rl_reset_after_signal: Readline Signal Handling. (line 121) @@ -5172,7 +5232,7 @@ Function and Variable Index * rl_set_keymap: Keymaps. (line 43) * rl_set_keymap_name: Keymaps. (line 56) * rl_set_paren_blink_timeout: Miscellaneous Functions. - (line 36) + (line 38) * rl_set_prompt: Redisplay. (line 80) * rl_set_screen_size: Readline Signal Handling. (line 153) @@ -5182,9 +5242,9 @@ Function and Variable Index * rl_show_char: Redisplay. (line 36) * rl_signal_event_hook: Readline Variables. (line 143) * rl_sort_completion_matches: Completion Variables. - (line 263) + (line 289) * rl_special_prefixes: Completion Variables. - (line 171) + (line 188) * rl_startup_hook: Readline Variables. (line 121) * rl_stuff_char: Character Input. (line 18) * rl_terminal_name: Readline Variables. (line 93) @@ -5202,24 +5262,24 @@ Function and Variable Index * rl_username_completion_function: Completion Functions. (line 64) * rl_variable_bind: Miscellaneous Functions. - (line 19) + (line 21) * rl_variable_dumper: Miscellaneous Functions. - (line 30) + (line 32) * rl_variable_value: Miscellaneous Functions. - (line 25) + (line 27) +* search-ignore-case: Readline Init File Syntax. + (line 329) * self-insert (a, b, A, 1, !, ...): Commands For Text. (line 33) * set-mark (C-@): Miscellaneous Commands. (line 33) -* shell-transpose-words (M-C-t): Commands For Killing. - (line 32) * show-all-if-ambiguous: Readline Init File Syntax. - (line 326) + (line 334) * show-all-if-unmodified: Readline Init File Syntax. - (line 332) + (line 340) * show-mode-in-prompt: Readline Init File Syntax. - (line 341) + (line 349) * skip-completed-text: Readline Init File Syntax. - (line 347) + (line 355) * skip-csi-sequence (): Miscellaneous Commands. (line 52) * start-kbd-macro (C-x (): Keyboard Macros. (line 6) @@ -5232,85 +5292,85 @@ Function and Variable Index (line 23) * universal-argument (): Numeric Arguments. (line 10) * unix-filename-rubout (): Commands For Killing. - (line 43) + (line 36) * unix-line-discard (C-u): Commands For Killing. (line 16) * unix-word-rubout (C-w): Commands For Killing. - (line 39) + (line 32) * upcase-word (M-u): Commands For Text. (line 61) * vi-cmd-mode-string: Readline Init File Syntax. - (line 360) + (line 368) * vi-editing-mode (M-C-j): Miscellaneous Commands. (line 92) * vi-ins-mode-string: Readline Init File Syntax. - (line 371) + (line 379) * visible-stats: Readline Init File Syntax. - (line 382) + (line 390) * yank (C-y): Commands For Killing. - (line 70) + (line 63) * yank-last-arg (M-. or M-_): Commands For History. (line 83) * yank-nth-arg (M-C-y): Commands For History. (line 74) * yank-pop (M-y): Commands For Killing. - (line 73) + (line 66) Tag Table: -Node: Top866 -Node: Command Line Editing1591 -Node: Introduction and Notation2243 -Node: Readline Interaction3867 -Node: Readline Bare Essentials5059 -Node: Readline Movement Commands6849 -Node: Readline Killing Commands7810 -Node: Readline Arguments9732 -Node: Searching10777 -Node: Readline Init File12930 -Node: Readline Init File Syntax14086 -Node: Conditional Init Constructs37389 -Node: Sample Init File41586 -Node: Bindable Readline Commands44711 -Node: Commands For Moving45766 -Node: Commands For History47525 -Node: Commands For Text52489 -Node: Commands For Killing56192 -Node: Numeric Arguments58906 -Node: Commands For Completion60046 -Node: Keyboard Macros62015 -Node: Miscellaneous Commands62704 -Node: Readline vi Mode66632 -Node: Programming with GNU Readline68449 -Node: Basic Behavior69435 -Node: Custom Functions73118 -Node: Readline Typedefs74601 -Node: Function Writing76235 -Node: Readline Variables77549 -Node: Readline Convenience Functions91224 -Node: Function Naming92296 -Node: Keymaps93558 -Node: Binding Keys96637 -Node: Associating Function Names and Bindings101185 -Node: Allowing Undoing104415 -Node: Redisplay106965 -Node: Modifying Text111024 -Node: Character Input112271 -Node: Terminal Management115352 -Node: Utility Functions117175 -Node: Miscellaneous Functions120503 -Node: Alternate Interface123922 -Node: A Readline Example126664 -Node: Alternate Interface Example128603 -Node: Readline Signal Handling132135 -Node: Custom Completers141388 -Node: How Completing Works142108 -Node: Completion Functions145415 -Node: Completion Variables148989 -Node: A Short Completion Example164795 -Node: GNU Free Documentation License177632 -Node: Concept Index202806 -Node: Function and Variable Index204327 +Node: Top863 +Node: Command Line Editing1588 +Node: Introduction and Notation2240 +Node: Readline Interaction3888 +Node: Readline Bare Essentials5080 +Node: Readline Movement Commands6902 +Node: Readline Killing Commands7903 +Node: Readline Arguments9885 +Node: Searching10946 +Node: Readline Init File13145 +Node: Readline Init File Syntax14321 +Node: Conditional Init Constructs38971 +Node: Sample Init File43340 +Node: Bindable Readline Commands46465 +Node: Commands For Moving47536 +Node: Commands For History49339 +Node: Commands For Text54391 +Node: Commands For Killing58186 +Node: Numeric Arguments60655 +Node: Commands For Completion61811 +Node: Keyboard Macros63844 +Node: Miscellaneous Commands64549 +Node: Readline vi Mode68928 +Node: Programming with GNU Readline70797 +Node: Basic Behavior71783 +Node: Custom Functions75769 +Node: Readline Typedefs77288 +Node: Function Writing79014 +Node: Readline Variables80332 +Node: Readline Convenience Functions94832 +Node: Function Naming95908 +Node: Keymaps97178 +Node: Binding Keys100285 +Node: Associating Function Names and Bindings104889 +Node: Allowing Undoing108530 +Node: Redisplay111152 +Node: Modifying Text115307 +Node: Character Input116558 +Node: Terminal Management119707 +Node: Utility Functions121566 +Node: Miscellaneous Functions124962 +Node: Alternate Interface128686 +Node: A Readline Example131476 +Node: Alternate Interface Example133427 +Node: Readline Signal Handling136959 +Node: Custom Completers146500 +Node: How Completing Works147220 +Node: Completion Functions150595 +Node: Completion Variables154265 +Node: A Short Completion Example171897 +Node: GNU Free Documentation License184570 +Node: Concept Index209747 +Node: Function and Variable Index211268 End Tag Table |