diff options
Diffstat (limited to 'doc/rluserman.html')
| -rw-r--r-- | doc/rluserman.html | 354 |
1 files changed, 198 insertions, 156 deletions
diff --git a/doc/rluserman.html b/doc/rluserman.html index b813dda..76b05d3 100644 --- a/doc/rluserman.html +++ b/doc/rluserman.html @@ -1,14 +1,14 @@ <HTML> <HEAD> <!-- This HTML file has been created by texi2html 1.52 - from /usr/homes/chet/src/bash/readline-src/doc/rluserman.texinfo on 1 March 2000 --> + from /usr/homes/chet/src/bash/readline-src/doc/rluserman.texinfo on 16 April 2001 --> <TITLE>GNU Readline Library</TITLE> </HEAD> <BODY> <H1>GNU Readline Library User Interface</H1> -<H2>Edition 4.1, for <CODE>Readline Library</CODE> Version 4.1.</H2> -<H2>January 2000</H2> +<H2>Edition 4.2, for <CODE>Readline Library</CODE> Version 4.2.</H2> +<H2>Apr 2001</H2> <ADDRESS>Brian Fox, Free Software Foundation</ADDRESS> <ADDRESS>Chet Ramey, Case Western Reserve University</ADDRESS> <P> @@ -81,7 +81,7 @@ by the Free Software Foundation. </P> <P> -Copyright (C) 1988-1999 Free Software Foundation, Inc. +Copyright (C) 1988-2001 Free Software Foundation, Inc. </P> @@ -136,7 +136,7 @@ Compose key for typing accented characters. <P> If you do not have a Meta or <KBD>ALT</KBD> key, or another key working as a Meta key, the identical keystroke can be generated by typing <KBD>ESC</KBD> -<I>first</I>, and then typing <KBD>k</KBD>. +<EM>first</EM>, and then typing <KBD>k</KBD>. Either process is known as <EM>metafying</EM> the <KBD>k</KBD> key. </P> @@ -171,8 +171,8 @@ as you type it in, allowing you to just fix your typo, and not forcing you to retype the majority of the line. Using these editing commands, you move the cursor to the place that needs correction, and delete or insert the text of the corrections. Then, when you are satisfied with -the line, you simply press <KBD>RETURN</KBD>. You do not have to be at the -end of the line to press <KBD>RETURN</KBD>; the entire line is accepted +the line, you simply press <KBD>RET</KBD>. You do not have to be at the +end of the line to press <KBD>RET</KBD>; the entire line is accepted regardless of the location of the cursor within the line. </P> @@ -333,7 +333,7 @@ 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 <KBD>M-f</KBD>. -<DT><KBD>M-DEL</KBD> +<DT><KBD>M-<KBD>DEL</KBD></KBD> <DD> Kill from the cursor the start of the previous word, or, if between words, to the start of the previous word. @@ -342,7 +342,7 @@ Word boundaries are the same as those used by <KBD>M-b</KBD>. <DT><KBD>C-w</KBD> <DD> Kill from the cursor to the previous whitespace. This is different than -<KBD>M-DEL</KBD> because the word boundaries differ. +<KBD>M-<KBD>DEL</KBD></KBD> because the word boundaries differ. </DL> @@ -382,7 +382,8 @@ digits before the command. If the first `digit' typed is a minus sign (<SAMP>`-'</SAMP>), 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 <KBD>C-d</KBD> command an argument of 10, you could type <SAMP>`M-1 0 C-d'</SAMP>. +the <KBD>C-d</KBD> command an argument of 10, you could type <SAMP>`M-1 0 C-d'</SAMP>, +which will delete the next ten characters on the input line. </P> @@ -392,7 +393,7 @@ the <KBD>C-d</KBD> command an argument of 10, you could type <SAMP>`M-1 0 C-d'</ <P> Readline provides commands for searching through the command history for lines containing a specified string. -There are two search modes: <VAR>incremental</VAR> and <VAR>non-incremental</VAR>. +There are two search modes: <EM>incremental</EM> and <EM>non-incremental</EM>. </P> <P> @@ -422,6 +423,8 @@ Any other key sequence bound to a Readline command will terminate the search and execute that command. For instance, a <KBD>RET</KBD> will terminate the 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. </P> <P> @@ -444,7 +447,7 @@ of keybindings. Any user can customize programs that use Readline by putting commands in an <EM>inputrc</EM> file, conventionally in his home directory. The name of this -file is taken from the value of the environment variable <CODE>INPUTRC</CODE>. If +file is taken from the value of the environment variable @env{INPUTRC}. If that variable is unset, the default is <TT>`~/.inputrc'</TT>. </P> @@ -486,7 +489,15 @@ denote variable settings and key bindings. <DD> You can modify the run-time behavior of Readline by altering the values of variables in Readline -using the <CODE>set</CODE> command within the init file. Here is how to +using the <CODE>set</CODE> command within the init file. +The syntax is simple: + + +<PRE> +set <VAR>variable</VAR> <VAR>value</VAR> +</PRE> + +Here, for example, is how to change from the default Emacs-like key binding to use <CODE>vi</CODE> line editing commands: @@ -495,14 +506,18 @@ change from the default Emacs-like key binding to use set editing-mode vi </PRE> +Variable names and values, where appropriate, are recognized without regard +to case. + A great deal of run-time behavior is changeable with the following variables. +<A NAME="IDX9"></A> <DL COMPACT> <DT><CODE>bell-style</CODE> <DD> -<A NAME="IDX9"></A> +<A NAME="IDX10"></A> Controls what happens when Readline wants to ring the terminal bell. If set to <SAMP>`none'</SAMP>, Readline never rings the bell. If set to <SAMP>`visible'</SAMP>, Readline uses a visible bell if one is available. @@ -511,7 +526,7 @@ the terminal's bell. <DT><CODE>comment-begin</CODE> <DD> -<A NAME="IDX10"></A> +<A NAME="IDX11"></A> The string to insert at the beginning of the line when the <CODE>insert-comment</CODE> command is executed. The default value is <CODE>"#"</CODE>. @@ -524,17 +539,18 @@ The default value is <SAMP>`off'</SAMP>. <DT><CODE>completion-query-items</CODE> <DD> -<A NAME="IDX11"></A> +<A NAME="IDX12"></A> The number of possible completions that determines when the user is asked whether he wants to see the list of possibilities. If the number of possible completions is greater than this value, Readline will ask the user whether or not he wishes to view -them; otherwise, they are simply listed. The default limit is -<CODE>100</CODE>. +them; otherwise, they are simply listed. +This variable must be set to an integer value greater than or equal to 0. +The default limit is <CODE>100</CODE>. <DT><CODE>convert-meta</CODE> <DD> -<A NAME="IDX12"></A> +<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 @@ -542,14 +558,14 @@ meta-prefixed key sequence. The default value is <SAMP>`on'</SAMP>. <DT><CODE>disable-completion</CODE> <DD> -<A NAME="IDX13"></A> +<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>. <DT><CODE>editing-mode</CODE> <DD> -<A NAME="IDX14"></A> +<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 @@ -557,20 +573,20 @@ set to either <SAMP>`emacs'</SAMP> or <SAMP>`vi'</SAMP>. <DT><CODE>enable-keypad</CODE> <DD> -<A NAME="IDX15"></A> +<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>. <DT><CODE>expand-tilde</CODE> <DD> -<A NAME="IDX16"></A> +<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>. <DT><CODE>horizontal-scroll-mode</CODE> <DD> -<A NAME="IDX17"></A> +<A NAME="IDX18"></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 @@ -579,17 +595,17 @@ this variable is set to <SAMP>`off'</SAMP>. <DT><CODE>input-meta</CODE> <DD> -<A NAME="IDX18"></A> <A NAME="IDX19"></A> +<A NAME="IDX20"></A> If set to <SAMP>`on'</SAMP>, Readline will enable eight-bit input (it -will not strip the eighth bit from the characters it reads), +will not clear the eighth bit in the characters it reads), regardless of what the terminal claims it can support. The default value is <SAMP>`off'</SAMP>. The name <CODE>meta-flag</CODE> is a synonym for this variable. <DT><CODE>isearch-terminators</CODE> <DD> -<A NAME="IDX20"></A> +<A NAME="IDX21"></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">Searching for Commands in the History</A>). If this variable has not been given a value, the characters <KBD>ESC</KBD> and @@ -597,7 +613,7 @@ If this variable has not been given a value, the characters <KBD>ESC</KBD> and <DT><CODE>keymap</CODE> <DD> -<A NAME="IDX21"></A> +<A NAME="IDX22"></A> Sets Readline's idea of the current keymap for key binding commands. Acceptable <CODE>keymap</CODE> names are <CODE>emacs</CODE>, @@ -605,6 +621,7 @@ Acceptable <CODE>keymap</CODE> names are <CODE>emacs-meta</CODE>, <CODE>emacs-ctlx</CODE>, <CODE>vi</CODE>, +<CODE>vi-move</CODE>, <CODE>vi-command</CODE>, and <CODE>vi-insert</CODE>. <CODE>vi</CODE> is equivalent to <CODE>vi-command</CODE>; <CODE>emacs</CODE> is @@ -619,14 +636,14 @@ appended. The default is <SAMP>`on'</SAMP>. <DT><CODE>mark-modified-lines</CODE> <DD> -<A NAME="IDX22"></A> +<A NAME="IDX23"></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. <DT><CODE>output-meta</CODE> <DD> -<A NAME="IDX23"></A> +<A NAME="IDX24"></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>. @@ -639,7 +656,7 @@ The default is <SAMP>`off'</SAMP>. <DT><CODE>show-all-if-ambiguous</CODE> <DD> -<A NAME="IDX24"></A> +<A NAME="IDX25"></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 @@ -648,7 +665,7 @@ The default value is <SAMP>`off'</SAMP>. <DT><CODE>visible-stats</CODE> <DD> -<A NAME="IDX25"></A> +<A NAME="IDX26"></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>. @@ -663,11 +680,15 @@ want to change. The following sections contain tables of the command name, the default keybinding, if any, and a short description of what the command does. -Once you know the name of the command, simply place the name of the key +Once you know the name of the command, simply place on a line +in the init file the name of the key you wish to bind the command to, a colon, and then the name of the -command on a line in the init file. The name of the key -can be expressed in different ways, depending on which is most -comfortable for you. +command. The name of the key +can be expressed in different ways, depending on what you find most +comfortable. + +In addition to command names, readline allows keys to be bound +to a string that is inserted when the key is pressed (a <VAR>macro</VAR>). <DL COMPACT> @@ -682,10 +703,27 @@ Control-o: "> output" </PRE> In the above example, <KBD>C-u</KBD> is bound to the function -<CODE>universal-argument</CODE>, and <KBD>C-o</KBD> is bound to run the macro +<CODE>universal-argument</CODE>, +<KBD>M-DEL</KBD> is bound to the function <CODE>backward-kill-word</CODE>, and +<KBD>C-o</KBD> is bound to run the macro expressed on the right hand side (that is, to insert the text <SAMP>`> output'</SAMP> into the line). +A number of symbolic character names are recognized while +processing this key binding syntax: +<VAR>DEL</VAR>, +<VAR>ESC</VAR>, +<VAR>ESCAPE</VAR>, +<VAR>LFD</VAR>, +<VAR>NEWLINE</VAR>, +<VAR>RET</VAR>, +<VAR>RETURN</VAR>, +<VAR>RUBOUT</VAR>, +<VAR>SPACE</VAR>, +<VAR>SPC</VAR>, +and +<VAR>TAB</VAR>. + <DT>"<VAR>keyseq</VAR>": <VAR>function-name</VAR> or <VAR>macro</VAR> <DD> <VAR>keyseq</VAR> differs from <VAR>keyname</VAR> above in that strings @@ -701,7 +739,7 @@ special character names are not recognized. "\e[11~": "Function Key 1" </PRE> -In the above example, <KBD>C-u</KBD> is bound to the function +In the above example, <KBD>C-u</KBD> is again bound to the function <CODE>universal-argument</CODE> (just as it was in the first example), <SAMP>`<KBD>C-x</KBD> <KBD>C-r</KBD>'</SAMP> is bound to the function <CODE>re-read-init-file</CODE>, and <SAMP>`<KBD>ESC</KBD> <KBD>[</KBD> <KBD>1</KBD> <KBD>1</KBD> <KBD>~</KBD>'</SAMP> is bound to insert @@ -765,11 +803,11 @@ horizontal tab vertical tab <DT><CODE>\<VAR>nnn</VAR></CODE> <DD> -the character whose <CODE>ASCII</CODE> code is the octal value <VAR>nnn</VAR> +the character whose ASCII code is the octal value <VAR>nnn</VAR> (one to three digits) <DT><CODE>\x<VAR>nnn</VAR></CODE> <DD> -the character whose <CODE>ASCII</CODE> code is the hexadecimal value <VAR>nnn</VAR> +the character whose ASCII code is the hexadecimal value <VAR>nnn</VAR> (one to three digits) </DL> @@ -779,7 +817,7 @@ 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 <SAMP>`"'</SAMP> and <SAMP>`''</SAMP>. -For example, the following binding will make <SAMP>`C-x \'</SAMP> +For example, the following binding will make <SAMP>`<KBD>C-x</KBD> \'</SAMP> insert a single <SAMP>`\'</SAMP> into the line: <PRE> @@ -833,7 +871,8 @@ for instance. <DD> The <VAR>application</VAR> construct is used to include application-specific settings. Each program using the Readline -library sets the <VAR>application name</VAR>, and you can test for it. +library sets the <VAR>application name</VAR>, and you can test for +a particular value. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word in Bash: @@ -861,6 +900,7 @@ the test fails. <DD> This directive takes a single filename as an argument and reads commands and bindings from that file. +For example, the following directive reads from <TT>`/etc/inputrc'</TT>: <PRE> $include /etc/inputrc @@ -873,7 +913,7 @@ $include /etc/inputrc <H3><A NAME="SEC12" HREF="rluserman.html#TOC12">Sample Init File</A></H3> <P> -Here is an example of an inputrc file. This illustrates key +Here is an example of an <VAR>inputrc</VAR> file. This illustrates key binding, variable assignment, and conditional syntax. </P> @@ -997,14 +1037,14 @@ $endif <P> This section describes Readline commands that may be bound to key sequences. +Command names without an accompanying key sequence are unbound by default. </P> <P> -Command names without an accompanying key sequence are unbound by default. -In the following descriptions, <VAR>point</VAR> refers to the current cursor -position, and <VAR>mark</VAR> refers to a cursor position saved by the +In the following descriptions, <EM>point</EM> refers to the current cursor +position, and <EM>mark</EM> refers to a cursor position saved by the <CODE>set-mark</CODE> command. -The text between the point and mark is referred to as the <VAR>region</VAR>. +The text between the point and mark is referred to as the <EM>region</EM>. </P> @@ -1014,45 +1054,45 @@ The text between the point and mark is referred to as the <VAR>region</VAR>. <DT><CODE>beginning-of-line (C-a)</CODE> <DD> -<A NAME="IDX26"></A> +<A NAME="IDX27"></A> Move to the start of the current line. <DT><CODE>end-of-line (C-e)</CODE> <DD> -<A NAME="IDX27"></A> +<A NAME="IDX28"></A> Move to the end of the line. <DT><CODE>forward-char (C-f)</CODE> <DD> -<A NAME="IDX28"></A> +<A NAME="IDX29"></A> Move forward a character. <DT><CODE>backward-char (C-b)</CODE> <DD> -<A NAME="IDX29"></A> +<A NAME="IDX30"></A> Move back a character. <DT><CODE>forward-word (M-f)</CODE> <DD> -<A NAME="IDX30"></A> +<A NAME="IDX31"></A> Move forward to the end of the next word. Words are composed of letters and digits. <DT><CODE>backward-word (M-b)</CODE> <DD> -<A NAME="IDX31"></A> +<A NAME="IDX32"></A> Move back to the start of the current or previous word. Words are composed of letters and digits. <DT><CODE>clear-screen (C-l)</CODE> <DD> -<A NAME="IDX32"></A> +<A NAME="IDX33"></A> Clear the screen and redraw the current line, leaving the current line at the top of the screen. <DT><CODE>redraw-current-line ()</CODE> <DD> -<A NAME="IDX33"></A> +<A NAME="IDX34"></A> Refresh the current line. By default, this is unbound. </DL> @@ -1063,63 +1103,66 @@ Refresh the current line. By default, this is unbound. <DL COMPACT> -<DT><CODE>accept-line (Newline, Return)</CODE> +<DT><CODE>accept-line (Newline or Return)</CODE> <DD> -<A NAME="IDX34"></A> -Accept the line regardless of where the cursor is. If this line is -non-empty, add it to the history list. If this line was a history -line, then restore the history line to its original state. +<A NAME="IDX35"></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 +<CODE>add_history()</CODE>. +If this line is a modified history line, the history line is restored +to its original state. <DT><CODE>previous-history (C-p)</CODE> <DD> -<A NAME="IDX35"></A> -Move `up' through the history list. +<A NAME="IDX36"></A> +Move `back' through the history list, fetching the previous command. <DT><CODE>next-history (C-n)</CODE> <DD> -<A NAME="IDX36"></A> -Move `down' through the history list. +<A NAME="IDX37"></A> +Move `forward' through the history list, fetching the next command. <DT><CODE>beginning-of-history (M-<)</CODE> <DD> -<A NAME="IDX37"></A> +<A NAME="IDX38"></A> Move to the first line in the history. <DT><CODE>end-of-history (M->)</CODE> <DD> -<A NAME="IDX38"></A> +<A NAME="IDX39"></A> Move to the end of the input history, i.e., the line currently being entered. <DT><CODE>reverse-search-history (C-r)</CODE> <DD> -<A NAME="IDX39"></A> +<A NAME="IDX40"></A> Search backward starting at the current line and moving `up' through the history as necessary. This is an incremental search. <DT><CODE>forward-search-history (C-s)</CODE> <DD> -<A NAME="IDX40"></A> +<A NAME="IDX41"></A> Search forward starting at the current line and moving `down' through the the history as necessary. This is an incremental search. <DT><CODE>non-incremental-reverse-search-history (M-p)</CODE> <DD> -<A NAME="IDX41"></A> +<A NAME="IDX42"></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. <DT><CODE>non-incremental-forward-search-history (M-n)</CODE> <DD> -<A NAME="IDX42"></A> +<A NAME="IDX43"></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. <DT><CODE>history-search-forward ()</CODE> <DD> -<A NAME="IDX43"></A> +<A NAME="IDX44"></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. @@ -1127,23 +1170,24 @@ By default, this command is unbound. <DT><CODE>history-search-backward ()</CODE> <DD> -<A NAME="IDX44"></A> +<A NAME="IDX45"></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. <DT><CODE>yank-nth-arg (M-C-y)</CODE> <DD> -<A NAME="IDX45"></A> +<A NAME="IDX46"></A> Insert the first argument to the previous command (usually -the second word on the previous line). With an argument <VAR>n</VAR>, +the second word on the previous line) at point. +With an argument <VAR>n</VAR>, insert the <VAR>n</VAR>th word from the previous command (the words in the previous command begin with word 0). A negative argument inserts the <VAR>n</VAR>th word from the end of the previous command. -<DT><CODE>yank-last-arg (M-., M-_)</CODE> +<DT><CODE>yank-last-arg (M-. or M-_)</CODE> <DD> -<A NAME="IDX46"></A> +<A NAME="IDX47"></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>. @@ -1160,44 +1204,44 @@ list, inserting the last argument of each line in turn. <DT><CODE>delete-char (C-d)</CODE> <DD> -<A NAME="IDX47"></A> -Delete the character under the cursor. If the cursor is at the +<A NAME="IDX48"></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 <CODE>EOF</CODE>. +return EOF. <DT><CODE>backward-delete-char (Rubout)</CODE> <DD> -<A NAME="IDX48"></A> +<A NAME="IDX49"></A> Delete the character behind the cursor. A numeric argument means to kill the characters instead of deleting them. <DT><CODE>forward-backward-delete-char ()</CODE> <DD> -<A NAME="IDX49"></A> +<A NAME="IDX50"></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. -<DT><CODE>quoted-insert (C-q, C-v)</CODE> +<DT><CODE>quoted-insert (C-q or C-v)</CODE> <DD> -<A NAME="IDX50"></A> +<A NAME="IDX51"></A> Add the next character typed to the line verbatim. This is how to insert key sequences like <KBD>C-q</KBD>, for example. -<DT><CODE>tab-insert (M-TAB)</CODE> +<DT><CODE>tab-insert (M-<KBD>TAB</KBD>)</CODE> <DD> -<A NAME="IDX51"></A> +<A NAME="IDX52"></A> Insert a tab character. <DT><CODE>self-insert (a, b, A, 1, !, ...)</CODE> <DD> -<A NAME="IDX52"></A> +<A NAME="IDX53"></A> Insert yourself. <DT><CODE>transpose-chars (C-t)</CODE> <DD> -<A NAME="IDX53"></A> +<A NAME="IDX54"></A> Drag the character before the cursor forward over the character at the cursor, moving the cursor forward as well. If the insertion point @@ -1207,25 +1251,25 @@ Negative arguments have no effect. <DT><CODE>transpose-words (M-t)</CODE> <DD> -<A NAME="IDX54"></A> +<A NAME="IDX55"></A> Drag the word before point past the word after point, moving point past that word as well. <DT><CODE>upcase-word (M-u)</CODE> <DD> -<A NAME="IDX55"></A> +<A NAME="IDX56"></A> Uppercase the current (or following) word. With a negative argument, uppercase the previous word, but do not move the cursor. <DT><CODE>downcase-word (M-l)</CODE> <DD> -<A NAME="IDX56"></A> +<A NAME="IDX57"></A> Lowercase the current (or following) word. With a negative argument, lowercase the previous word, but do not move the cursor. <DT><CODE>capitalize-word (M-c)</CODE> <DD> -<A NAME="IDX57"></A> +<A NAME="IDX58"></A> Capitalize the current (or following) word. With a negative argument, capitalize the previous word, but do not move the cursor. @@ -1239,86 +1283,85 @@ capitalize the previous word, but do not move the cursor. <DT><CODE>kill-line (C-k)</CODE> <DD> -<A NAME="IDX58"></A> +<A NAME="IDX59"></A> Kill the text from point to the end of the line. <DT><CODE>backward-kill-line (C-x Rubout)</CODE> <DD> -<A NAME="IDX59"></A> +<A NAME="IDX60"></A> Kill backward to the beginning of the line. <DT><CODE>unix-line-discard (C-u)</CODE> <DD> -<A NAME="IDX60"></A> +<A NAME="IDX61"></A> Kill backward from the cursor to the beginning of the current line. <DT><CODE>kill-whole-line ()</CODE> <DD> -<A NAME="IDX61"></A> -Kill all characters on the current line, no matter point is. +<A NAME="IDX62"></A> +Kill all characters on the current line, no matter where point is. By default, this is unbound. <DT><CODE>kill-word (M-d)</CODE> <DD> -<A NAME="IDX62"></A> +<A NAME="IDX63"></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>. -<DT><CODE>backward-kill-word (M-DEL)</CODE> +<DT><CODE>backward-kill-word (M-<KBD>DEL</KBD>)</CODE> <DD> -<A NAME="IDX63"></A> +<A NAME="IDX64"></A> Kill the word behind point. Word boundaries are the same as <CODE>backward-word</CODE>. <DT><CODE>unix-word-rubout (C-w)</CODE> <DD> -<A NAME="IDX64"></A> +<A NAME="IDX65"></A> Kill the word behind point, using white space as a word boundary. The killed text is saved on the kill-ring. <DT><CODE>delete-horizontal-space ()</CODE> <DD> -<A NAME="IDX65"></A> +<A NAME="IDX66"></A> Delete all spaces and tabs around point. By default, this is unbound. <DT><CODE>kill-region ()</CODE> <DD> -<A NAME="IDX66"></A> +<A NAME="IDX67"></A> Kill the text in the current region. By default, this command is unbound. <DT><CODE>copy-region-as-kill ()</CODE> <DD> -<A NAME="IDX67"></A> +<A NAME="IDX68"></A> Copy the text in the region to the kill buffer, so it can be yanked right away. By default, this command is unbound. <DT><CODE>copy-backward-word ()</CODE> <DD> -<A NAME="IDX68"></A> +<A NAME="IDX69"></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. <DT><CODE>copy-forward-word ()</CODE> <DD> -<A NAME="IDX69"></A> +<A NAME="IDX70"></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. <DT><CODE>yank (C-y)</CODE> <DD> -<A NAME="IDX70"></A> -Yank the top of the kill ring into the buffer at the current -cursor position. +<A NAME="IDX71"></A> +Yank the top of the kill ring into the buffer at point. <DT><CODE>yank-pop (M-y)</CODE> <DD> -<A NAME="IDX71"></A> +<A NAME="IDX72"></A> Rotate the kill-ring, and yank the new top. You can only do this if -the prior command is yank or yank-pop. +the prior command is <CODE>yank</CODE> or <CODE>yank-pop</CODE>. </DL> @@ -1326,15 +1369,15 @@ the prior command is yank or yank-pop. <H3><A NAME="SEC18" HREF="rluserman.html#TOC18">Specifying Numeric Arguments</A></H3> <DL COMPACT> -<DT><CODE>digit-argument (M-0, M-1, ... M--)</CODE> +<DT><CODE>digit-argument (<KBD>M-0</KBD>, <KBD>M-1</KBD>, ... <KBD>M--</KBD>)</CODE> <DD> -<A NAME="IDX72"></A> +<A NAME="IDX73"></A> Add this digit to the argument already accumulating, or start a new argument. <KBD>M--</KBD> starts a negative argument. <DT><CODE>universal-argument ()</CODE> <DD> -<A NAME="IDX73"></A> +<A NAME="IDX74"></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. @@ -1355,45 +1398,43 @@ By default, this is not bound to a key. <DL COMPACT> -<DT><CODE>complete (TAB)</CODE> +<DT><CODE>complete (<KBD>TAB</KBD>)</CODE> <DD> -<A NAME="IDX74"></A> -Attempt to do completion on the text before the cursor. This is -application-specific. Generally, if you are typing a filename -argument, you can do filename completion; if you are typing a command, -you can do command completion; if you are typing in a symbol to GDB, you -can do symbol name completion; if you are typing in a variable to Bash, -you can do variable name completion, and so on. +<A NAME="IDX75"></A> +Attempt to perform completion on the text before point. +The actual completion performed is application-specific. +The default is filename completion. <DT><CODE>possible-completions (M-?)</CODE> <DD> -<A NAME="IDX75"></A> -List the possible completions of the text before the cursor. +<A NAME="IDX76"></A> +List the possible completions of the text before point. <DT><CODE>insert-completions (M-*)</CODE> <DD> -<A NAME="IDX76"></A> +<A NAME="IDX77"></A> Insert all completions of the text before point that would have been generated by <CODE>possible-completions</CODE>. <DT><CODE>menu-complete ()</CODE> <DD> -<A NAME="IDX77"></A> +<A NAME="IDX78"></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 of possible completions, inserting each match in turn. -At the end of the list of completions, the bell is rung and the -original text is restored. +At the end of the list of completions, the bell is rung +(subject to the setting of <CODE>bell-style</CODE>) +and the original text is restored. An argument of <VAR>n</VAR> moves <VAR>n</VAR> 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 <CODE>TAB</CODE>, but is unbound +This command is intended to be bound to <KBD>TAB</KBD>, but is unbound by default. <DT><CODE>delete-char-or-list ()</CODE> <DD> -<A NAME="IDX78"></A> +<A NAME="IDX79"></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 @@ -1409,18 +1450,18 @@ This command is unbound by default. <DT><CODE>start-kbd-macro (C-x ()</CODE> <DD> -<A NAME="IDX79"></A> +<A NAME="IDX80"></A> Begin saving the characters typed into the current keyboard macro. <DT><CODE>end-kbd-macro (C-x ))</CODE> <DD> -<A NAME="IDX80"></A> +<A NAME="IDX81"></A> Stop saving the characters typed into the current keyboard macro and save the definition. <DT><CODE>call-last-kbd-macro (C-x e)</CODE> <DD> -<A NAME="IDX81"></A> +<A NAME="IDX82"></A> Re-execute the last keyboard macro defined, by making the characters in the macro appear as if typed at the keyboard. @@ -1433,81 +1474,81 @@ in the macro appear as if typed at the keyboard. <DT><CODE>re-read-init-file (C-x C-r)</CODE> <DD> -<A NAME="IDX82"></A> +<A NAME="IDX83"></A> Read in the contents of the <VAR>inputrc</VAR> file, and incorporate any bindings or variable assignments found there. <DT><CODE>abort (C-g)</CODE> <DD> -<A NAME="IDX83"></A> +<A NAME="IDX84"></A> Abort the current editing command and ring the terminal's bell (subject to the setting of <CODE>bell-style</CODE>). <DT><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, ...)</CODE> <DD> -<A NAME="IDX84"></A> +<A NAME="IDX85"></A> If the metafied character <VAR>x</VAR> is lowercase, run the command that is bound to the corresponding uppercase character. -<DT><CODE>prefix-meta (ESC)</CODE> +<DT><CODE>prefix-meta (<KBD>ESC</KBD>)</CODE> <DD> -<A NAME="IDX85"></A> -Make the next character typed be metafied. This is for keyboards -without a meta key. Typing <SAMP>`ESC f'</SAMP> is equivalent to typing -<SAMP>`M-f'</SAMP>. +<A NAME="IDX86"></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>. -<DT><CODE>undo (C-_, C-x C-u)</CODE> +<DT><CODE>undo (C-_ or C-x C-u)</CODE> <DD> -<A NAME="IDX86"></A> +<A NAME="IDX87"></A> Incremental undo, separately remembered for each line. <DT><CODE>revert-line (M-r)</CODE> <DD> -<A NAME="IDX87"></A> +<A NAME="IDX88"></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. <DT><CODE>tilde-expand (M-~)</CODE> <DD> -<A NAME="IDX88"></A> +<A NAME="IDX89"></A> Perform tilde expansion on the current word. <DT><CODE>set-mark (C-@)</CODE> <DD> -<A NAME="IDX89"></A> -Set the mark to the current point. If a +<A NAME="IDX90"></A> +Set the mark to the point. If a numeric argument is supplied, the mark is set to that position. <DT><CODE>exchange-point-and-mark (C-x C-x)</CODE> <DD> -<A NAME="IDX90"></A> +<A NAME="IDX91"></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. <DT><CODE>character-search (C-])</CODE> <DD> -<A NAME="IDX91"></A> +<A NAME="IDX92"></A> A character is read and point is moved to the next occurrence of that character. A negative count searches for previous occurrences. <DT><CODE>character-search-backward (M-C-])</CODE> <DD> -<A NAME="IDX92"></A> +<A NAME="IDX93"></A> A character is read and point is moved to the previous occurrence of that character. A negative count searches for subsequent occurrences. <DT><CODE>insert-comment (M-#)</CODE> <DD> -<A NAME="IDX93"></A> +<A NAME="IDX94"></A> The value of the <CODE>comment-begin</CODE> variable is inserted at the beginning of the current line, and the line is accepted as if a newline had been typed. <DT><CODE>dump-functions ()</CODE> <DD> -<A NAME="IDX94"></A> +<A NAME="IDX95"></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 @@ -1515,7 +1556,7 @@ of an <VAR>inputrc</VAR> file. This command is unbound by default. <DT><CODE>dump-variables ()</CODE> <DD> -<A NAME="IDX95"></A> +<A NAME="IDX96"></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 @@ -1523,9 +1564,9 @@ of an <VAR>inputrc</VAR> file. This command is unbound by default. <DT><CODE>dump-macros ()</CODE> <DD> -<A NAME="IDX96"></A> +<A NAME="IDX97"></A> Print all of the Readline key sequences bound to macros and the -strings they ouput. If a numeric argument is supplied, +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. @@ -1544,7 +1585,8 @@ the POSIX 1003.2 standard. </P> <P> In order to switch interactively between <CODE>emacs</CODE> and <CODE>vi</CODE> -editing modes, use the command M-C-j (toggle-editing-mode). +editing modes, use the command <KBD>M-C-j</KBD> (bound to emacs-editing-mode +when in <CODE>vi</CODE> mode and to vi-editing-mode in <CODE>emacs</CODE> mode). The Readline default is <CODE>emacs</CODE> mode. </P> @@ -1559,7 +1601,7 @@ so forth. </P> <P><HR><P> -This document was generated on 1 March 2000 using the +This document was generated on 16 April 2001 using the <A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A> translator version 1.52.</P> </BODY> |