diff options
author | Chet Ramey <chet.ramey@case.edu> | 2011-11-23 19:26:12 -0500 |
---|---|---|
committer | Chet Ramey <chet.ramey@case.edu> | 2011-11-23 19:26:12 -0500 |
commit | b1b0b2d7c8574132c39d819dc54522b4fe7e6df9 (patch) | |
tree | 95f51da88feb690d1af90b057fc5ce62819d25de /doc/rluserman.html | |
parent | cdd796540cf235ad4b5d4a892570aba697c7fb61 (diff) | |
download | readline-b1b0b2d7c8574132c39d819dc54522b4fe7e6df9.tar.gz |
Readline-6.2 import
Diffstat (limited to 'doc/rluserman.html')
-rw-r--r-- | doc/rluserman.html | 407 |
1 files changed, 220 insertions, 187 deletions
diff --git a/doc/rluserman.html b/doc/rluserman.html index ea7c5d9..1e9c579 100644 --- a/doc/rluserman.html +++ b/doc/rluserman.html @@ -1,6 +1,6 @@ <HTML> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<!-- Created on October, 12 2009 by texi2html 1.64 --> +<!-- Created on February, 8 2011 by texi2html 1.64 --> <!-- Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author) Karl Berry <karl@freefriends.org> @@ -599,14 +599,32 @@ The string to insert at the beginning of the line when the is <CODE>"#"</CODE>. <P> +<DT><CODE>completion-display-width</CODE> +<DD><A NAME="IDX8"></A> +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. +<P> + <DT><CODE>completion-ignore-case</CODE> -<DD>If set to <SAMP>`on'</SAMP>, Readline performs filename matching and completion +<DD><A NAME="IDX9"></A> +If set to <SAMP>`on'</SAMP>, Readline performs filename matching and completion in a case-insensitive fashion. The default value is <SAMP>`off'</SAMP>. <P> +<DT><CODE>completion-map-case</CODE> +<DD><A NAME="IDX10"></A> +If set to <SAMP>`on'</SAMP>, and <VAR>completion-ignore-case</VAR> is enabled, Readline +treats hyphens (<SAMP>`-'</SAMP>) and underscores (<SAMP>`_'</SAMP>) as equivalent when +performing case-insensitive filename matching and completion. +<P> + <DT><CODE>completion-prefix-display-length</CODE> -<DD><A NAME="IDX8"></A> +<DD><A NAME="IDX11"></A> 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 @@ -614,7 +632,7 @@ replaced with an ellipsis when displaying possible completions. <P> <DT><CODE>completion-query-items</CODE> -<DD><A NAME="IDX9"></A> +<DD><A NAME="IDX12"></A> 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 than this value, @@ -626,7 +644,7 @@ The default limit is <CODE>100</CODE>. <P> <DT><CODE>convert-meta</CODE> -<DD><A NAME="IDX10"></A> +<DD><A NAME="IDX13"></A> If set to <SAMP>`on'</SAMP>, Readline will convert characters with the eighth bit set to an ASCII key sequence by stripping the eighth bit and prefixing an <KBD>ESC</KBD> character, converting them to a @@ -634,14 +652,14 @@ meta-prefixed key sequence. The default value is <SAMP>`on'</SAMP>. <P> <DT><CODE>disable-completion</CODE> -<DD><A NAME="IDX11"></A> +<DD><A NAME="IDX14"></A> If set to <SAMP>`On'</SAMP>, Readline will inhibit word completion. Completion characters will be inserted into the line as if they had been mapped to <CODE>self-insert</CODE>. The default is <SAMP>`off'</SAMP>. <P> <DT><CODE>editing-mode</CODE> -<DD><A NAME="IDX12"></A> +<DD><A NAME="IDX15"></A> The <CODE>editing-mode</CODE> 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 @@ -655,7 +673,7 @@ keyboard. The default is <SAMP>`on'</SAMP>. <P> <DT><CODE>enable-keypad</CODE> -<DD><A NAME="IDX13"></A> +<DD><A NAME="IDX16"></A> When set to <SAMP>`on'</SAMP>, Readline will try to enable the application keypad when it is called. Some systems need this to enable the arrow keys. The default is <SAMP>`off'</SAMP>. @@ -669,13 +687,13 @@ The default is <SAMP>`on'</SAMP>. <P> <DT><CODE>expand-tilde</CODE> -<DD><A NAME="IDX14"></A> +<DD><A NAME="IDX17"></A> If set to <SAMP>`on'</SAMP>, tilde expansion is performed when Readline attempts word completion. The default is <SAMP>`off'</SAMP>. <P> <DT><CODE>history-preserve-point</CODE> -<DD><A NAME="IDX15"></A> +<DD><A NAME="IDX18"></A> If set to <SAMP>`on'</SAMP>, the history code attempts to place the point (the current cursor position) at the same location on each history line retrieved with <CODE>previous-history</CODE> @@ -683,13 +701,13 @@ or <CODE>next-history</CODE>. The default is <SAMP>`off'</SAMP>. <P> <DT><CODE>history-size</CODE> -<DD><A NAME="IDX16"></A> +<DD><A NAME="IDX19"></A> Set the maximum number of history entries saved in the history list. If set to zero, the number of entries in the history list is not limited. <P> <DT><CODE>horizontal-scroll-mode</CODE> -<DD><A NAME="IDX17"></A> +<DD><A NAME="IDX20"></A> This variable can be set to either <SAMP>`on'</SAMP> or <SAMP>`off'</SAMP>. Setting it to <SAMP>`on'</SAMP> means that the text of the lines being edited will scroll horizontally on a single screen line when they are longer than the width @@ -698,8 +716,8 @@ this variable is set to <SAMP>`off'</SAMP>. <P> <DT><CODE>input-meta</CODE> -<DD><A NAME="IDX18"></A> -<A NAME="IDX19"></A> +<DD><A NAME="IDX21"></A> +<A NAME="IDX22"></A> If set to <SAMP>`on'</SAMP>, 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 @@ -708,7 +726,7 @@ synonym for this variable. <P> <DT><CODE>isearch-terminators</CODE> -<DD><A NAME="IDX20"></A> +<DD><A NAME="IDX23"></A> The string of characters that should terminate an incremental search without subsequently executing the character as a command (see section <A HREF="rluserman.html#SEC8">1.2.5 Searching for Commands in the History</A>). If this variable has not been given a value, the characters <KBD>ESC</KBD> and @@ -716,7 +734,7 @@ If this variable has not been given a value, the characters <KBD>ESC</KBD> and <P> <DT><CODE>keymap</CODE> -<DD><A NAME="IDX21"></A> +<DD><A NAME="IDX24"></A> Sets Readline's idea of the current keymap for key binding commands. Acceptable <CODE>keymap</CODE> names are <CODE>emacs</CODE>, @@ -739,14 +757,14 @@ appended. The default is <SAMP>`on'</SAMP>. <P> <DT><CODE>mark-modified-lines</CODE> -<DD><A NAME="IDX22"></A> +<DD><A NAME="IDX25"></A> This variable, when set to <SAMP>`on'</SAMP>, causes Readline to display an asterisk (<SAMP>`*'</SAMP>) at the start of history lines which have been modified. This variable is <SAMP>`off'</SAMP> by default. <P> <DT><CODE>mark-symlinked-directories</CODE> -<DD><A NAME="IDX23"></A> +<DD><A NAME="IDX26"></A> If set to <SAMP>`on'</SAMP>, completed names which are symbolic links to directories have a slash appended (subject to the value of <CODE>mark-directories</CODE>). @@ -754,23 +772,31 @@ The default is <SAMP>`off'</SAMP>. <P> <DT><CODE>match-hidden-files</CODE> -<DD><A NAME="IDX24"></A> +<DD><A NAME="IDX27"></A> This variable, when set to <SAMP>`on'</SAMP>, causes Readline to match files whose names begin with a <SAMP>`.'</SAMP> (hidden files) when performing filename -completion, unless the leading <SAMP>`.'</SAMP> is +completion. +If set to <SAMP>`off'</SAMP>, the leading <SAMP>`.'</SAMP> must be supplied by the user in the filename to be completed. This variable is <SAMP>`on'</SAMP> by default. <P> +<DT><CODE>menu-complete-display-prefix</CODE> +<DD><A NAME="IDX28"></A> +If set to <SAMP>`on'</SAMP>, menu completion displays the common prefix of the +list of possible completions (which may be empty) before cycling through +the list. The default is <SAMP>`off'</SAMP>. +<P> + <DT><CODE>output-meta</CODE> -<DD><A NAME="IDX25"></A> +<DD><A NAME="IDX29"></A> If set to <SAMP>`on'</SAMP>, Readline will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. The default is <SAMP>`off'</SAMP>. <P> <DT><CODE>page-completions</CODE> -<DD><A NAME="IDX26"></A> +<DD><A NAME="IDX30"></A> If set to <SAMP>`on'</SAMP>, Readline uses an internal <CODE>more</CODE>-like pager to display a screenful of possible completions at a time. This variable is <SAMP>`on'</SAMP> by default. @@ -783,7 +809,7 @@ The default is <SAMP>`off'</SAMP>. <P> <DT><CODE>revert-all-at-newline</CODE> -<DD><A NAME="IDX27"></A> +<DD><A NAME="IDX31"></A> If set to <SAMP>`on'</SAMP>, Readline will undo all changes to history lines before returning when <CODE>accept-line</CODE> is executed. By default, history lines may be modified and retain individual undo lists across @@ -791,7 +817,7 @@ calls to <CODE>readline</CODE>. The default is <SAMP>`off'</SAMP>. <P> <DT><CODE>show-all-if-ambiguous</CODE> -<DD><A NAME="IDX28"></A> +<DD><A NAME="IDX32"></A> This alters the default behavior of the completion functions. If set to <SAMP>`on'</SAMP>, words which have more than one possible completion cause the @@ -800,7 +826,7 @@ The default value is <SAMP>`off'</SAMP>. <P> <DT><CODE>show-all-if-unmodified</CODE> -<DD><A NAME="IDX29"></A> +<DD><A NAME="IDX33"></A> This alters the default behavior of the completion functions in a fashion similar to <VAR>show-all-if-ambiguous</VAR>. If set to <SAMP>`on'</SAMP>, @@ -812,7 +838,7 @@ The default value is <SAMP>`off'</SAMP>. <P> <DT><CODE>skip-completed-text</CODE> -<DD><A NAME="IDX30"></A> +<DD><A NAME="IDX34"></A> If set to <SAMP>`on'</SAMP>, 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 @@ -827,7 +853,7 @@ The default value is <SAMP>`off'</SAMP>. <P> <DT><CODE>visible-stats</CODE> -<DD><A NAME="IDX31"></A> +<DD><A NAME="IDX35"></A> If set to <SAMP>`on'</SAMP>, a character denoting a file's type is appended to the filename when listing possible completions. The default is <SAMP>`off'</SAMP>. @@ -1243,54 +1269,54 @@ The text between the point and mark is referred to as the <EM>region</EM>. <H3> 1.4.1 Commands For Moving </H3> <!--docid::SEC14::--> <DL COMPACT> -<A NAME="IDX32"></A> +<A NAME="IDX36"></A> <DT><CODE>beginning-of-line (C-a)</CODE> -<DD><A NAME="IDX33"></A> +<DD><A NAME="IDX37"></A> Move to the start of the current line. <P> -<A NAME="IDX34"></A> +<A NAME="IDX38"></A> <DT><CODE>end-of-line (C-e)</CODE> -<DD><A NAME="IDX35"></A> +<DD><A NAME="IDX39"></A> Move to the end of the line. <P> -<A NAME="IDX36"></A> +<A NAME="IDX40"></A> <DT><CODE>forward-char (C-f)</CODE> -<DD><A NAME="IDX37"></A> +<DD><A NAME="IDX41"></A> Move forward a character. <P> -<A NAME="IDX38"></A> +<A NAME="IDX42"></A> <DT><CODE>backward-char (C-b)</CODE> -<DD><A NAME="IDX39"></A> +<DD><A NAME="IDX43"></A> Move back a character. <P> -<A NAME="IDX40"></A> +<A NAME="IDX44"></A> <DT><CODE>forward-word (M-f)</CODE> -<DD><A NAME="IDX41"></A> +<DD><A NAME="IDX45"></A> Move forward to the end of the next word. Words are composed of letters and digits. <P> -<A NAME="IDX42"></A> +<A NAME="IDX46"></A> <DT><CODE>backward-word (M-b)</CODE> -<DD><A NAME="IDX43"></A> +<DD><A NAME="IDX47"></A> Move back to the start of the current or previous word. Words are composed of letters and digits. <P> -<A NAME="IDX44"></A> +<A NAME="IDX48"></A> <DT><CODE>clear-screen (C-l)</CODE> -<DD><A NAME="IDX45"></A> +<DD><A NAME="IDX49"></A> Clear the screen and redraw the current line, leaving the current line at the top of the screen. <P> -<A NAME="IDX46"></A> +<A NAME="IDX50"></A> <DT><CODE>redraw-current-line ()</CODE> -<DD><A NAME="IDX47"></A> +<DD><A NAME="IDX51"></A> Refresh the current line. By default, this is unbound. <P> @@ -1316,9 +1342,9 @@ Refresh the current line. By default, this is unbound. <P> <DL COMPACT> -<A NAME="IDX48"></A> +<A NAME="IDX52"></A> <DT><CODE>accept-line (Newline or Return)</CODE> -<DD><A NAME="IDX49"></A> +<DD><A NAME="IDX53"></A> 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 @@ -1327,81 +1353,81 @@ If this line is a modified history line, the history line is restored to its original state. <P> -<A NAME="IDX50"></A> +<A NAME="IDX54"></A> <DT><CODE>previous-history (C-p)</CODE> -<DD><A NAME="IDX51"></A> +<DD><A NAME="IDX55"></A> Move `back' through the history list, fetching the previous command. <P> -<A NAME="IDX52"></A> +<A NAME="IDX56"></A> <DT><CODE>next-history (C-n)</CODE> -<DD><A NAME="IDX53"></A> +<DD><A NAME="IDX57"></A> Move `forward' through the history list, fetching the next command. <P> -<A NAME="IDX54"></A> +<A NAME="IDX58"></A> <DT><CODE>beginning-of-history (M-<)</CODE> -<DD><A NAME="IDX55"></A> +<DD><A NAME="IDX59"></A> Move to the first line in the history. <P> -<A NAME="IDX56"></A> +<A NAME="IDX60"></A> <DT><CODE>end-of-history (M->)</CODE> -<DD><A NAME="IDX57"></A> +<DD><A NAME="IDX61"></A> Move to the end of the input history, i.e., the line currently being entered. <P> -<A NAME="IDX58"></A> +<A NAME="IDX62"></A> <DT><CODE>reverse-search-history (C-r)</CODE> -<DD><A NAME="IDX59"></A> +<DD><A NAME="IDX63"></A> Search backward starting at the current line and moving `up' through the history as necessary. This is an incremental search. <P> -<A NAME="IDX60"></A> +<A NAME="IDX64"></A> <DT><CODE>forward-search-history (C-s)</CODE> -<DD><A NAME="IDX61"></A> +<DD><A NAME="IDX65"></A> Search forward starting at the current line and moving `down' through the the history as necessary. This is an incremental search. <P> -<A NAME="IDX62"></A> +<A NAME="IDX66"></A> <DT><CODE>non-incremental-reverse-search-history (M-p)</CODE> -<DD><A NAME="IDX63"></A> +<DD><A NAME="IDX67"></A> 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. <P> -<A NAME="IDX64"></A> +<A NAME="IDX68"></A> <DT><CODE>non-incremental-forward-search-history (M-n)</CODE> -<DD><A NAME="IDX65"></A> +<DD><A NAME="IDX69"></A> Search forward starting at the current line and moving `down' through the the history as necessary using a non-incremental search for a string supplied by the user. <P> -<A NAME="IDX66"></A> +<A NAME="IDX70"></A> <DT><CODE>history-search-forward ()</CODE> -<DD><A NAME="IDX67"></A> +<DD><A NAME="IDX71"></A> Search forward through the history for the string of characters between the start of the current line and the point. This is a non-incremental search. By default, this command is unbound. <P> -<A NAME="IDX68"></A> +<A NAME="IDX72"></A> <DT><CODE>history-search-backward ()</CODE> -<DD><A NAME="IDX69"></A> +<DD><A NAME="IDX73"></A> Search backward through the history for the string of characters between the start of the current line and the point. This is a non-incremental search. By default, this command is unbound. <P> -<A NAME="IDX70"></A> +<A NAME="IDX74"></A> <DT><CODE>yank-nth-arg (M-C-y)</CODE> -<DD><A NAME="IDX71"></A> +<DD><A NAME="IDX75"></A> Insert the first argument to the previous command (usually the second word on the previous line) at point. With an argument <VAR>n</VAR>, @@ -1412,14 +1438,18 @@ Once the argument <VAR>n</VAR> is computed, the argument is extracted as if the <SAMP>`!<VAR>n</VAR>'</SAMP> history expansion had been specified. <P> -<A NAME="IDX72"></A> +<A NAME="IDX76"></A> <DT><CODE>yank-last-arg (M-. or M-_)</CODE> -<DD><A NAME="IDX73"></A> +<DD><A NAME="IDX77"></A> Insert last argument to the previous command (the last word of the -previous history entry). With an -argument, behave exactly like <CODE>yank-nth-arg</CODE>. +previous history entry). +With a numeric argument, behave exactly like <CODE>yank-nth-arg</CODE>. Successive calls to <CODE>yank-last-arg</CODE> move back through the history -list, inserting the last argument of each line in turn. +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 <SAMP>`!$'</SAMP> history expansion had been specified. <P> @@ -1446,52 +1476,52 @@ as if the <SAMP>`!$'</SAMP> history expansion had been specified. <P> <DL COMPACT> -<A NAME="IDX74"></A> +<A NAME="IDX78"></A> <DT><CODE>delete-char (C-d)</CODE> -<DD><A NAME="IDX75"></A> +<DD><A NAME="IDX79"></A> Delete the character at point. If point is at the beginning of the line, there are no characters in the line, and the last character typed was not bound to <CODE>delete-char</CODE>, then return EOF. <P> -<A NAME="IDX76"></A> +<A NAME="IDX80"></A> <DT><CODE>backward-delete-char (Rubout)</CODE> -<DD><A NAME="IDX77"></A> +<DD><A NAME="IDX81"></A> Delete the character behind the cursor. A numeric argument means to kill the characters instead of deleting them. <P> -<A NAME="IDX78"></A> +<A NAME="IDX82"></A> <DT><CODE>forward-backward-delete-char ()</CODE> -<DD><A NAME="IDX79"></A> +<DD><A NAME="IDX83"></A> 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. <P> -<A NAME="IDX80"></A> +<A NAME="IDX84"></A> <DT><CODE>quoted-insert (C-q or C-v)</CODE> -<DD><A NAME="IDX81"></A> +<DD><A NAME="IDX85"></A> Add the next character typed to the line verbatim. This is how to insert key sequences like <KBD>C-q</KBD>, for example. <P> -<A NAME="IDX82"></A> +<A NAME="IDX86"></A> <DT><CODE>tab-insert (M-<KBD>TAB</KBD>)</CODE> -<DD><A NAME="IDX83"></A> +<DD><A NAME="IDX87"></A> Insert a tab character. <P> -<A NAME="IDX84"></A> +<A NAME="IDX88"></A> <DT><CODE>self-insert (a, b, A, 1, !, <small>...</small>)</CODE> -<DD><A NAME="IDX85"></A> +<DD><A NAME="IDX89"></A> Insert yourself. <P> -<A NAME="IDX86"></A> +<A NAME="IDX90"></A> <DT><CODE>transpose-chars (C-t)</CODE> -<DD><A NAME="IDX87"></A> +<DD><A NAME="IDX91"></A> Drag the character before the cursor forward over the character at the cursor, moving the cursor forward as well. If the insertion point @@ -1500,39 +1530,39 @@ transposes the last two characters of the line. Negative arguments have no effect. <P> -<A NAME="IDX88"></A> +<A NAME="IDX92"></A> <DT><CODE>transpose-words (M-t)</CODE> -<DD><A NAME="IDX89"></A> +<DD><A NAME="IDX93"></A> 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. <P> -<A NAME="IDX90"></A> +<A NAME="IDX94"></A> <DT><CODE>upcase-word (M-u)</CODE> -<DD><A NAME="IDX91"></A> +<DD><A NAME="IDX95"></A> Uppercase the current (or following) word. With a negative argument, uppercase the previous word, but do not move the cursor. <P> -<A NAME="IDX92"></A> +<A NAME="IDX96"></A> <DT><CODE>downcase-word (M-l)</CODE> -<DD><A NAME="IDX93"></A> +<DD><A NAME="IDX97"></A> Lowercase the current (or following) word. With a negative argument, lowercase the previous word, but do not move the cursor. <P> -<A NAME="IDX94"></A> +<A NAME="IDX98"></A> <DT><CODE>capitalize-word (M-c)</CODE> -<DD><A NAME="IDX95"></A> +<DD><A NAME="IDX99"></A> Capitalize the current (or following) word. With a negative argument, capitalize the previous word, but do not move the cursor. <P> -<A NAME="IDX96"></A> +<A NAME="IDX100"></A> <DT><CODE>overwrite-mode ()</CODE> -<DD><A NAME="IDX97"></A> +<DD><A NAME="IDX101"></A> 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 @@ -1572,106 +1602,106 @@ By default, this command is unbound. <DL COMPACT> -<A NAME="IDX98"></A> +<A NAME="IDX102"></A> <DT><CODE>kill-line (C-k)</CODE> -<DD><A NAME="IDX99"></A> +<DD><A NAME="IDX103"></A> Kill the text from point to the end of the line. <P> -<A NAME="IDX100"></A> +<A NAME="IDX104"></A> <DT><CODE>backward-kill-line (C-x Rubout)</CODE> -<DD><A NAME="IDX101"></A> +<DD><A NAME="IDX105"></A> Kill backward to the beginning of the line. <P> -<A NAME="IDX102"></A> +<A NAME="IDX106"></A> <DT><CODE>unix-line-discard (C-u)</CODE> -<DD><A NAME="IDX103"></A> +<DD><A NAME="IDX107"></A> Kill backward from the cursor to the beginning of the current line. <P> -<A NAME="IDX104"></A> +<A NAME="IDX108"></A> <DT><CODE>kill-whole-line ()</CODE> -<DD><A NAME="IDX105"></A> +<DD><A NAME="IDX109"></A> Kill all characters on the current line, no matter where point is. By default, this is unbound. <P> -<A NAME="IDX106"></A> +<A NAME="IDX110"></A> <DT><CODE>kill-word (M-d)</CODE> -<DD><A NAME="IDX107"></A> +<DD><A NAME="IDX111"></A> 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 <CODE>forward-word</CODE>. <P> -<A NAME="IDX108"></A> +<A NAME="IDX112"></A> <DT><CODE>backward-kill-word (M-<KBD>DEL</KBD>)</CODE> -<DD><A NAME="IDX109"></A> +<DD><A NAME="IDX113"></A> Kill the word behind point. Word boundaries are the same as <CODE>backward-word</CODE>. <P> -<A NAME="IDX110"></A> +<A NAME="IDX114"></A> <DT><CODE>unix-word-rubout (C-w)</CODE> -<DD><A NAME="IDX111"></A> +<DD><A NAME="IDX115"></A> Kill the word behind point, using white space as a word boundary. The killed text is saved on the kill-ring. <P> -<A NAME="IDX112"></A> +<A NAME="IDX116"></A> <DT><CODE>unix-filename-rubout ()</CODE> -<DD><A NAME="IDX113"></A> +<DD><A NAME="IDX117"></A> 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. <P> -<A NAME="IDX114"></A> +<A NAME="IDX118"></A> <DT><CODE>delete-horizontal-space ()</CODE> -<DD><A NAME="IDX115"></A> +<DD><A NAME="IDX119"></A> Delete all spaces and tabs around point. By default, this is unbound. <P> -<A NAME="IDX116"></A> +<A NAME="IDX120"></A> <DT><CODE>kill-region ()</CODE> -<DD><A NAME="IDX117"></A> +<DD><A NAME="IDX121"></A> Kill the text in the current region. By default, this command is unbound. <P> -<A NAME="IDX118"></A> +<A NAME="IDX122"></A> <DT><CODE>copy-region-as-kill ()</CODE> -<DD><A NAME="IDX119"></A> +<DD><A NAME="IDX123"></A> Copy the text in the region to the kill buffer, so it can be yanked right away. By default, this command is unbound. <P> -<A NAME="IDX120"></A> +<A NAME="IDX124"></A> <DT><CODE>copy-backward-word ()</CODE> -<DD><A NAME="IDX121"></A> +<DD><A NAME="IDX125"></A> Copy the word before point to the kill buffer. The word boundaries are the same as <CODE>backward-word</CODE>. By default, this command is unbound. <P> -<A NAME="IDX122"></A> +<A NAME="IDX126"></A> <DT><CODE>copy-forward-word ()</CODE> -<DD><A NAME="IDX123"></A> +<DD><A NAME="IDX127"></A> Copy the word following point to the kill buffer. The word boundaries are the same as <CODE>forward-word</CODE>. By default, this command is unbound. <P> -<A NAME="IDX124"></A> +<A NAME="IDX128"></A> <DT><CODE>yank (C-y)</CODE> -<DD><A NAME="IDX125"></A> +<DD><A NAME="IDX129"></A> Yank the top of the kill ring into the buffer at point. <P> -<A NAME="IDX126"></A> +<A NAME="IDX130"></A> <DT><CODE>yank-pop (M-y)</CODE> -<DD><A NAME="IDX127"></A> +<DD><A NAME="IDX131"></A> Rotate the kill-ring, and yank the new top. You can only do this if the prior command is <CODE>yank</CODE> or <CODE>yank-pop</CODE>. </DL> @@ -1695,16 +1725,16 @@ the prior command is <CODE>yank</CODE> or <CODE>yank-pop</CODE>. <!--docid::SEC18::--> <DL COMPACT> -<A NAME="IDX128"></A> +<A NAME="IDX132"></A> <DT><CODE>digit-argument (<KBD>M-0</KBD>, <KBD>M-1</KBD>, <small>...</small> <KBD>M--</KBD>)</CODE> -<DD><A NAME="IDX129"></A> +<DD><A NAME="IDX133"></A> Add this digit to the argument already accumulating, or start a new argument. <KBD>M--</KBD> starts a negative argument. <P> -<A NAME="IDX130"></A> +<A NAME="IDX134"></A> <DT><CODE>universal-argument ()</CODE> -<DD><A NAME="IDX131"></A> +<DD><A NAME="IDX135"></A> 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. @@ -1739,30 +1769,33 @@ By default, this is not bound to a key. <P> <DL COMPACT> -<A NAME="IDX132"></A> +<A NAME="IDX136"></A> <DT><CODE>complete (<KBD>TAB</KBD>)</CODE> -<DD><A NAME="IDX133"></A> +<DD><A NAME="IDX137"></A> Attempt to perform completion on the text before point. The actual completion performed is application-specific. The default is filename completion. <P> -<A NAME="IDX134"></A> +<A NAME="IDX138"></A> <DT><CODE>possible-completions (M-?)</CODE> -<DD><A NAME="IDX135"></A> +<DD><A NAME="IDX139"></A> 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 <CODE>completion-display-width</CODE>, the value of +the environment variable <CODE>COLUMNS</CODE>, or the screen width, in that order. <P> -<A NAME="IDX136"></A> +<A NAME="IDX140"></A> <DT><CODE>insert-completions (M-*)</CODE> -<DD><A NAME="IDX137"></A> +<DD><A NAME="IDX141"></A> Insert all completions of the text before point that would have been generated by <CODE>possible-completions</CODE>. <P> -<A NAME="IDX138"></A> +<A NAME="IDX142"></A> <DT><CODE>menu-complete ()</CODE> -<DD><A NAME="IDX139"></A> +<DD><A NAME="IDX143"></A> Similar to <CODE>complete</CODE>, but replaces the word to be completed with a single match from the list of possible completions. Repeated execution of <CODE>menu-complete</CODE> steps through the list @@ -1777,17 +1810,17 @@ This command is intended to be bound to <KBD>TAB</KBD>, but is unbound by default. <P> -<A NAME="IDX140"></A> +<A NAME="IDX144"></A> <DT><CODE>menu-complete-backward ()</CODE> -<DD><A NAME="IDX141"></A> +<DD><A NAME="IDX145"></A> Identical to <CODE>menu-complete</CODE>, but moves backward through the list of possible completions, as if <CODE>menu-complete</CODE> had been given a negative argument. <P> -<A NAME="IDX142"></A> +<A NAME="IDX146"></A> <DT><CODE>delete-char-or-list ()</CODE> -<DD><A NAME="IDX143"></A> +<DD><A NAME="IDX147"></A> Deletes the character under the cursor if not at the beginning or end of the line (like <CODE>delete-char</CODE>). If at the end of the line, behaves identically to @@ -1816,22 +1849,22 @@ This command is unbound by default. <!--docid::SEC20::--> <DL COMPACT> -<A NAME="IDX144"></A> +<A NAME="IDX148"></A> <DT><CODE>start-kbd-macro (C-x ()</CODE> -<DD><A NAME="IDX145"></A> +<DD><A NAME="IDX149"></A> Begin saving the characters typed into the current keyboard macro. <P> -<A NAME="IDX146"></A> +<A NAME="IDX150"></A> <DT><CODE>end-kbd-macro (C-x ))</CODE> -<DD><A NAME="IDX147"></A> +<DD><A NAME="IDX151"></A> Stop saving the characters typed into the current keyboard macro and save the definition. <P> -<A NAME="IDX148"></A> +<A NAME="IDX152"></A> <DT><CODE>call-last-kbd-macro (C-x e)</CODE> -<DD><A NAME="IDX149"></A> +<DD><A NAME="IDX153"></A> Re-execute the last keyboard macro defined, by making the characters in the macro appear as if typed at the keyboard. <P> @@ -1857,87 +1890,87 @@ in the macro appear as if typed at the keyboard. <!--docid::SEC21::--> <DL COMPACT> -<A NAME="IDX150"></A> +<A NAME="IDX154"></A> <DT><CODE>re-read-init-file (C-x C-r)</CODE> -<DD><A NAME="IDX151"></A> +<DD><A NAME="IDX155"></A> Read in the contents of the <VAR>inputrc</VAR> file, and incorporate any bindings or variable assignments found there. <P> -<A NAME="IDX152"></A> +<A NAME="IDX156"></A> <DT><CODE>abort (C-g)</CODE> -<DD><A NAME="IDX153"></A> +<DD><A NAME="IDX157"></A> Abort the current editing command and ring the terminal's bell (subject to the setting of <CODE>bell-style</CODE>). <P> -<A NAME="IDX154"></A> +<A NAME="IDX158"></A> <DT><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, <small>...</small>)</CODE> -<DD><A NAME="IDX155"></A> +<DD><A NAME="IDX159"></A> If the metafied character <VAR>x</VAR> is lowercase, run the command that is bound to the corresponding uppercase character. <P> -<A NAME="IDX156"></A> +<A NAME="IDX160"></A> <DT><CODE>prefix-meta (<KBD>ESC</KBD>)</CODE> -<DD><A NAME="IDX157"></A> +<DD><A NAME="IDX161"></A> Metafy the next character typed. This is for keyboards without a meta key. Typing <SAMP>`<KBD>ESC</KBD> f'</SAMP> is equivalent to typing <KBD>M-f</KBD>. <P> -<A NAME="IDX158"></A> +<A NAME="IDX162"></A> <DT><CODE>undo (C-_ or C-x C-u)</CODE> -<DD><A NAME="IDX159"></A> +<DD><A NAME="IDX163"></A> Incremental undo, separately remembered for each line. <P> -<A NAME="IDX160"></A> +<A NAME="IDX164"></A> <DT><CODE>revert-line (M-r)</CODE> -<DD><A NAME="IDX161"></A> +<DD><A NAME="IDX165"></A> Undo all changes made to this line. This is like executing the <CODE>undo</CODE> command enough times to get back to the beginning. <P> -<A NAME="IDX162"></A> +<A NAME="IDX166"></A> <DT><CODE>tilde-expand (M-~)</CODE> -<DD><A NAME="IDX163"></A> +<DD><A NAME="IDX167"></A> Perform tilde expansion on the current word. <P> -<A NAME="IDX164"></A> +<A NAME="IDX168"></A> <DT><CODE>set-mark (C-@)</CODE> -<DD><A NAME="IDX165"></A> +<DD><A NAME="IDX169"></A> Set the mark to the point. If a numeric argument is supplied, the mark is set to that position. <P> -<A NAME="IDX166"></A> +<A NAME="IDX170"></A> <DT><CODE>exchange-point-and-mark (C-x C-x)</CODE> -<DD><A NAME="IDX167"></A> +<DD><A NAME="IDX171"></A> 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. <P> -<A NAME="IDX168"></A> +<A NAME="IDX172"></A> <DT><CODE>character-search (C-])</CODE> -<DD><A NAME="IDX169"></A> +<DD><A NAME="IDX173"></A> A character is read and point is moved to the next occurrence of that character. A negative count searches for previous occurrences. <P> -<A NAME="IDX170"></A> +<A NAME="IDX174"></A> <DT><CODE>character-search-backward (M-C-])</CODE> -<DD><A NAME="IDX171"></A> +<DD><A NAME="IDX175"></A> A character is read and point is moved to the previous occurrence of that character. A negative count searches for subsequent occurrences. <P> -<A NAME="IDX172"></A> +<A NAME="IDX176"></A> <DT><CODE>skip-csi-sequence ()</CODE> -<DD><A NAME="IDX173"></A> +<DD><A NAME="IDX177"></A> 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 sequence is @@ -1947,9 +1980,9 @@ stray characters into the editing buffer. This is unbound by default, but usually bound to ESC-[. <P> -<A NAME="IDX174"></A> +<A NAME="IDX178"></A> <DT><CODE>insert-comment (M-#)</CODE> -<DD><A NAME="IDX175"></A> +<DD><A NAME="IDX179"></A> Without a numeric argument, the value of the <CODE>comment-begin</CODE> variable is inserted at the beginning of the current line. If a numeric argument is supplied, this command acts as a toggle: if @@ -1960,43 +1993,43 @@ the line. In either case, the line is accepted as if a newline had been typed. <P> -<A NAME="IDX176"></A> +<A NAME="IDX180"></A> <DT><CODE>dump-functions ()</CODE> -<DD><A NAME="IDX177"></A> +<DD><A NAME="IDX181"></A> 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 <VAR>inputrc</VAR> file. This command is unbound by default. <P> -<A NAME="IDX178"></A> +<A NAME="IDX182"></A> <DT><CODE>dump-variables ()</CODE> -<DD><A NAME="IDX179"></A> +<DD><A NAME="IDX183"></A> 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 <VAR>inputrc</VAR> file. This command is unbound by default. <P> -<A NAME="IDX180"></A> +<A NAME="IDX184"></A> <DT><CODE>dump-macros ()</CODE> -<DD><A NAME="IDX181"></A> +<DD><A NAME="IDX185"></A> 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 <VAR>inputrc</VAR> file. This command is unbound by default. <P> -<A NAME="IDX182"></A> +<A NAME="IDX186"></A> <DT><CODE>emacs-editing-mode (C-e)</CODE> -<DD><A NAME="IDX183"></A> +<DD><A NAME="IDX187"></A> When in <CODE>vi</CODE> command mode, this causes a switch to <CODE>emacs</CODE> editing mode. <P> -<A NAME="IDX184"></A> +<A NAME="IDX188"></A> <DT><CODE>vi-editing-mode (M-C-j)</CODE> -<DD><A NAME="IDX185"></A> +<DD><A NAME="IDX189"></A> When in <CODE>emacs</CODE> editing mode, this causes a switch to <CODE>vi</CODE> editing mode. <P> @@ -2025,7 +2058,7 @@ editing mode. While the Readline library does not have a full set of <CODE>vi</CODE> editing functions, it does contain enough to allow simple editing of the line. The Readline <CODE>vi</CODE> mode behaves as specified in -the POSIX 1003.2 standard. +the POSIX standard. </P><P> In order to switch interactively between <CODE>emacs</CODE> and <CODE>vi</CODE> @@ -2723,7 +2756,7 @@ to permit their use in free software. <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="rluserman.html#SEC_About"> ? </A>]</TD> </TR></TABLE> <H1>About this document</H1> -This document was generated by <I>Chet Ramey</I> on <I>October, 12 2009</I> +This document was generated by <I>Chet Ramey</I> on <I>February, 8 2011</I> using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html "><I>texi2html</I></A> <P></P> @@ -2885,7 +2918,7 @@ the following structure: <BR> <FONT SIZE="-1"> This document was generated -by <I>Chet Ramey</I> on <I>October, 12 2009</I> +by <I>Chet Ramey</I> on <I>February, 8 2011</I> using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html "><I>texi2html</I></A> |