diff options
Diffstat (limited to 'doc/rluserman.info')
| -rw-r--r-- | doc/rluserman.info | 906 |
1 files changed, 457 insertions, 449 deletions
diff --git a/doc/rluserman.info b/doc/rluserman.info index 6bf1b4f..e432a35 100644 --- a/doc/rluserman.info +++ b/doc/rluserman.info @@ -1,12 +1,12 @@ -This is rluserman.info, produced by makeinfo version 6.8 from +This is rluserman.info, produced by makeinfo version 7.1 from rluserman.texi. This manual describes the end user interface of 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. +(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, @@ -64,10 +64,10 @@ File: rluserman.info, Node: Introduction and Notation, Next: Readline Interact 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 @@ -78,11 +78,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 @@ -129,8 +129,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 @@ -139,23 +139,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.) @@ -166,22 +166,22 @@ File: rluserman.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. @@ -191,15 +191,15 @@ File: rluserman.info, Node: Readline Killing Commands, Next: Readline Argument 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 @@ -207,34 +207,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: rluserman.info, Node: Readline Arguments, Next: Searching, Prev: Readline Killing Commands, Up: Readline Interaction @@ -247,14 +247,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. @@ -265,24 +265,24 @@ File: rluserman.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 @@ -290,9 +290,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 @@ -307,16 +307,16 @@ File: rluserman.info, Node: Readline Init File, Next: Bindable Readline Comman 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: @@ -334,20 +334,20 @@ File: rluserman.info, Node: Readline Init File Syntax, Next: Conditional Init ------------------------------- 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 @@ -361,10 +361,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 @@ -372,11 +372,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 @@ -385,72 +385,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 @@ -459,88 +462,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 @@ -549,43 +552,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 @@ -593,125 +596,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. @@ -737,11 +745,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, @@ -758,51 +766,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) @@ -810,8 +818,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\\": "\\" @@ -826,45 +834,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 @@ -877,32 +885,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 @@ -1035,10 +1043,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: rluserman.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands @@ -1046,50 +1054,50 @@ File: rluserman.info, Node: Commands For Moving, Next: Commands For History, 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. @@ -1098,103 +1106,103 @@ File: rluserman.info, Node: Commands For History, Next: Commands For Text, Pr 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. @@ -1205,43 +1213,43 @@ File: rluserman.info, Node: Commands For Text, Next: Commands For Killing, Pr 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 @@ -1249,39 +1257,39 @@ File: rluserman.info, Node: Commands For Text, Next: Commands For Killing, Pr 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. @@ -1292,76 +1300,69 @@ File: rluserman.info, Node: Commands For Killing, Next: Numeric Arguments, Pr 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'. + ‘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'. - -'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: rluserman.info, Node: Numeric Arguments, Next: Commands For Completion, Prev: Commands For Killing, Up: Bindable Readline Commands @@ -1369,15 +1370,15 @@ File: rluserman.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 @@ -1392,43 +1393,43 @@ File: rluserman.info, Node: Commands For Completion, Next: Keyboard Macros, P 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. @@ -1437,18 +1438,18 @@ File: rluserman.info, Node: Keyboard Macros, Next: Miscellaneous Commands, Pr 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. @@ -1458,53 +1459,53 @@ File: rluserman.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 @@ -1513,61 +1514,68 @@ File: rluserman.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: rluserman.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. File: rluserman.info, Node: GNU Free Documentation License, Prev: Command Line Editing, Up: Top @@ -1577,7 +1585,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 @@ -1586,7 +1594,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 @@ -2054,30 +2062,30 @@ their use in free software. Tag Table: -Node: Top909 -Node: Command Line Editing1431 -Node: Introduction and Notation2085 -Node: Readline Interaction3710 -Node: Readline Bare Essentials4903 -Node: Readline Movement Commands6694 -Node: Readline Killing Commands7656 -Node: Readline Arguments9579 -Node: Searching10625 -Node: Readline Init File12779 -Node: Readline Init File Syntax13936 -Node: Conditional Init Constructs37240 -Node: Sample Init File41438 -Node: Bindable Readline Commands44564 -Node: Commands For Moving45620 -Node: Commands For History47380 -Node: Commands For Text52345 -Node: Commands For Killing56049 -Node: Numeric Arguments58764 -Node: Commands For Completion59905 -Node: Keyboard Macros61875 -Node: Miscellaneous Commands62565 -Node: Readline vi Mode66494 -Node: GNU Free Documentation License67408 +Node: Top906 +Node: Command Line Editing1428 +Node: Introduction and Notation2082 +Node: Readline Interaction3731 +Node: Readline Bare Essentials4924 +Node: Readline Movement Commands6747 +Node: Readline Killing Commands7749 +Node: Readline Arguments9732 +Node: Searching10794 +Node: Readline Init File12994 +Node: Readline Init File Syntax14171 +Node: Conditional Init Constructs38822 +Node: Sample Init File43192 +Node: Bindable Readline Commands46318 +Node: Commands For Moving47390 +Node: Commands For History49194 +Node: Commands For Text54247 +Node: Commands For Killing58043 +Node: Numeric Arguments60513 +Node: Commands For Completion61670 +Node: Keyboard Macros63704 +Node: Miscellaneous Commands64410 +Node: Readline vi Mode68790 +Node: GNU Free Documentation License69756 End Tag Table |