Readline-4.3 import

author: Chet Ramey <chet.ramey@case.edu> 2011-11-23 19:10:13 -0500
committer: Chet Ramey <chet.ramey@case.edu> 2011-11-23 19:10:13 -0500
commit: 1e4e5d08e95b810dc5bcec9a3b9b296a0c3afa85 (patch)
tree: 3972ebdded0214475d2a402a1cd836da41f7bf2b /doc/rluserman.html
parent: abde3125f6228a63e22de708b9edaef62cab0ac3 (diff)
download: readline-1e4e5d08e95b810dc5bcec9a3b9b296a0c3afa85.tar.gz
1 files changed, 219 insertions, 164 deletions
diff --git a/doc/rluserman.html b/doc/rluserman.html
index 93bfe63..ac8bfbd 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, 9  2001 by texi2html 1.64 -->
+<!-- Created on June, 27  2002 by texi2html 1.64 -->
 <!-- 
 Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
             Karl Berry  <karl@freefriends.org>
@@ -700,8 +700,16 @@ asterisk (<SAMP>`*'</SAMP>) at the start of history lines which have been modifi
 This variable is <SAMP>`off'</SAMP> by default.
 <P>
 
-<DT><CODE>match-hidden-files</CODE>
+<DT><CODE>mark-symlinked-directories</CODE>
 <DD><A NAME="IDX20"></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>).
+The default is <SAMP>`off'</SAMP>.
+<P>
+
+<DT><CODE>match-hidden-files</CODE>
+<DD><A NAME="IDX21"></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
@@ -710,12 +718,19 @@ This variable is <SAMP>`on'</SAMP> by default.
 <P>
 
 <DT><CODE>output-meta</CODE>
-<DD><A NAME="IDX21"></A>
+<DD><A NAME="IDX22"></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="IDX23"></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.
+<P>
+
 <DT><CODE>print-completions-horizontally</CODE>
 <DD>If set to <SAMP>`on'</SAMP>, Readline will display completions with matches
 sorted horizontally in alphabetical order, rather than down the screen.
@@ -723,7 +738,7 @@ The default is <SAMP>`off'</SAMP>.
 <P>
 
 <DT><CODE>show-all-if-ambiguous</CODE>
-<DD><A NAME="IDX22"></A>
+<DD><A NAME="IDX24"></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
@@ -732,7 +747,7 @@ The default value is <SAMP>`off'</SAMP>.
 <P>
 
 <DT><CODE>visible-stats</CODE>
-<DD><A NAME="IDX23"></A>
+<DD><A NAME="IDX25"></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>.
@@ -988,14 +1003,14 @@ binding, variable assignment, and conditional syntax.
 </P><P>
 
 <TABLE><tr><td>&nbsp;</td><td class=example><pre># This file controls the behaviour of line input editing for
-# programs that use the Gnu Readline library.  Existing programs
-# include FTP, Bash, and Gdb.
+# programs that use the GNU Readline library.  Existing
+# programs include FTP, Bash, and GDB.
 #
 # You can re-read the inputrc file with C-x C-r.
 # Lines beginning with '#' are comments.
 #
-# First, include any systemwide bindings and variable assignments from
-# /etc/Inputrc
+# First, include any systemwide bindings and variable
+# assignments from /etc/Inputrc
 $include /etc/Inputrc
 
 #
@@ -1047,10 +1062,12 @@ TAB: complete
 $if Bash
 # edit the path
 "\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f"
-# prepare to type a quoted word -- insert open and close double quotes
+# prepare to type a quoted word --
+# insert open and close double quotes
 # and move to just after the open quote
 "\C-x\"": "\"\"\C-b"
-# insert a backslash (testing backslash escapes in sequences and macros)
+# insert a backslash (testing backslash escapes
+# in sequences and macros)
 "\C-x\\": "\\"
 # Quote the current or previous word
 "\C-xq": "\eb\"\ef\""
@@ -1066,16 +1083,16 @@ set bell-style visible
 # don't strip characters to 7 bits when reading
 set input-meta on
 
-# allow iso-latin1 characters to be inserted rather than converted to
-# prefix-meta sequences
+# allow iso-latin1 characters to be inserted rather
+# than converted to prefix-meta sequences
 set convert-meta off
 
-# display characters with the eighth bit set directly rather than
-# as meta-prefixed characters
+# display characters with the eighth bit set directly
+# rather than as meta-prefixed characters
 set output-meta on
 
-# if there are more than 150 possible completions for a word, ask the
-# user if he wants to see all of them
+# if there are more than 150 possible completions for
+# a word, ask the user if he wants to see all of them
 set completion-query-items 150
 
 # For FTP
@@ -1144,54 +1161,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="IDX24"></A>
+<A NAME="IDX26"></A>
 <DT><CODE>beginning-of-line (C-a)</CODE>
-<DD><A NAME="IDX25"></A>
+<DD><A NAME="IDX27"></A>
 Move to the start of the current line.
 <P>
 
-<A NAME="IDX26"></A>
+<A NAME="IDX28"></A>
 <DT><CODE>end-of-line (C-e)</CODE>
-<DD><A NAME="IDX27"></A>
+<DD><A NAME="IDX29"></A>
 Move to the end of the line.
 <P>
 
-<A NAME="IDX28"></A>
+<A NAME="IDX30"></A>
 <DT><CODE>forward-char (C-f)</CODE>
-<DD><A NAME="IDX29"></A>
+<DD><A NAME="IDX31"></A>
 Move forward a character.
 <P>
 
-<A NAME="IDX30"></A>
+<A NAME="IDX32"></A>
 <DT><CODE>backward-char (C-b)</CODE>
-<DD><A NAME="IDX31"></A>
+<DD><A NAME="IDX33"></A>
 Move back a character.
 <P>
 
-<A NAME="IDX32"></A>
+<A NAME="IDX34"></A>
 <DT><CODE>forward-word (M-f)</CODE>
-<DD><A NAME="IDX33"></A>
+<DD><A NAME="IDX35"></A>
 Move forward to the end of the next word.  Words are composed of
 letters and digits.
 <P>
 
-<A NAME="IDX34"></A>
+<A NAME="IDX36"></A>
 <DT><CODE>backward-word (M-b)</CODE>
-<DD><A NAME="IDX35"></A>
+<DD><A NAME="IDX37"></A>
 Move back to the start of the current or previous word.  Words are
 composed of letters and digits.
 <P>
 
-<A NAME="IDX36"></A>
+<A NAME="IDX38"></A>
 <DT><CODE>clear-screen (C-l)</CODE>
-<DD><A NAME="IDX37"></A>
+<DD><A NAME="IDX39"></A>
 Clear the screen and redraw the current line,
 leaving the current line at the top of the screen.
 <P>
 
-<A NAME="IDX38"></A>
+<A NAME="IDX40"></A>
 <DT><CODE>redraw-current-line ()</CODE>
-<DD><A NAME="IDX39"></A>
+<DD><A NAME="IDX41"></A>
 Refresh the current line.  By default, this is unbound.
 <P>
 
@@ -1217,9 +1234,9 @@ Refresh the current line.  By default, this is unbound.
 <P>
 
 <DL COMPACT>
-<A NAME="IDX40"></A>
+<A NAME="IDX42"></A>
 <DT><CODE>accept-line (Newline or Return)</CODE>
-<DD><A NAME="IDX41"></A>
+<DD><A NAME="IDX43"></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
@@ -1228,81 +1245,81 @@ If this line is a modified history line, the history line is restored
 to its original state.
 <P>
 
-<A NAME="IDX42"></A>
+<A NAME="IDX44"></A>
 <DT><CODE>previous-history (C-p)</CODE>
-<DD><A NAME="IDX43"></A>
+<DD><A NAME="IDX45"></A>
 Move `back' through the history list, fetching the previous command.
 <P>
 
-<A NAME="IDX44"></A>
+<A NAME="IDX46"></A>
 <DT><CODE>next-history (C-n)</CODE>
-<DD><A NAME="IDX45"></A>
+<DD><A NAME="IDX47"></A>
 Move `forward' through the history list, fetching the next command.
 <P>
 
-<A NAME="IDX46"></A>
+<A NAME="IDX48"></A>
 <DT><CODE>beginning-of-history (M-&#60;)</CODE>
-<DD><A NAME="IDX47"></A>
+<DD><A NAME="IDX49"></A>
 Move to the first line in the history.
 <P>
 
-<A NAME="IDX48"></A>
+<A NAME="IDX50"></A>
 <DT><CODE>end-of-history (M-&#62;)</CODE>
-<DD><A NAME="IDX49"></A>
+<DD><A NAME="IDX51"></A>
 Move to the end of the input history, i.e., the line currently
 being entered.
 <P>
 
-<A NAME="IDX50"></A>
+<A NAME="IDX52"></A>
 <DT><CODE>reverse-search-history (C-r)</CODE>
-<DD><A NAME="IDX51"></A>
+<DD><A NAME="IDX53"></A>
 Search backward starting at the current line and moving `up' through
 the history as necessary.  This is an incremental search.
 <P>
 
-<A NAME="IDX52"></A>
+<A NAME="IDX54"></A>
 <DT><CODE>forward-search-history (C-s)</CODE>
-<DD><A NAME="IDX53"></A>
+<DD><A NAME="IDX55"></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="IDX54"></A>
+<A NAME="IDX56"></A>
 <DT><CODE>non-incremental-reverse-search-history (M-p)</CODE>
-<DD><A NAME="IDX55"></A>
+<DD><A NAME="IDX57"></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="IDX56"></A>
+<A NAME="IDX58"></A>
 <DT><CODE>non-incremental-forward-search-history (M-n)</CODE>
-<DD><A NAME="IDX57"></A>
+<DD><A NAME="IDX59"></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="IDX58"></A>
+<A NAME="IDX60"></A>
 <DT><CODE>history-search-forward ()</CODE>
-<DD><A NAME="IDX59"></A>
+<DD><A NAME="IDX61"></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="IDX60"></A>
+<A NAME="IDX62"></A>
 <DT><CODE>history-search-backward ()</CODE>
-<DD><A NAME="IDX61"></A>
+<DD><A NAME="IDX63"></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="IDX62"></A>
+<A NAME="IDX64"></A>
 <DT><CODE>yank-nth-arg (M-C-y)</CODE>
-<DD><A NAME="IDX63"></A>
+<DD><A NAME="IDX65"></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>,
@@ -1311,9 +1328,9 @@ 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.
 <P>
 
-<A NAME="IDX64"></A>
+<A NAME="IDX66"></A>
 <DT><CODE>yank-last-arg (M-. or M-_)</CODE>
-<DD><A NAME="IDX65"></A>
+<DD><A NAME="IDX67"></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>.
@@ -1343,52 +1360,52 @@ list, inserting the last argument of each line in turn.
 <P>
 
 <DL COMPACT>
-<A NAME="IDX66"></A>
+<A NAME="IDX68"></A>
 <DT><CODE>delete-char (C-d)</CODE>
-<DD><A NAME="IDX67"></A>
+<DD><A NAME="IDX69"></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="IDX68"></A>
+<A NAME="IDX70"></A>
 <DT><CODE>backward-delete-char (Rubout)</CODE>
-<DD><A NAME="IDX69"></A>
+<DD><A NAME="IDX71"></A>
 Delete the character behind the cursor.  A numeric argument means
 to kill the characters instead of deleting them.
 <P>
 
-<A NAME="IDX70"></A>
+<A NAME="IDX72"></A>
 <DT><CODE>forward-backward-delete-char ()</CODE>
-<DD><A NAME="IDX71"></A>
+<DD><A NAME="IDX73"></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="IDX72"></A>
+<A NAME="IDX74"></A>
 <DT><CODE>quoted-insert (C-q or C-v)</CODE>
-<DD><A NAME="IDX73"></A>
+<DD><A NAME="IDX75"></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="IDX74"></A>
+<A NAME="IDX76"></A>
 <DT><CODE>tab-insert (M-<KBD>TAB</KBD>)</CODE>
-<DD><A NAME="IDX75"></A>
+<DD><A NAME="IDX77"></A>
 Insert a tab character.
 <P>
 
-<A NAME="IDX76"></A>
+<A NAME="IDX78"></A>
 <DT><CODE>self-insert (a, b, A, 1, !, <small>...</small>)</CODE>
-<DD><A NAME="IDX77"></A>
+<DD><A NAME="IDX79"></A>
 Insert yourself.
 <P>
 
-<A NAME="IDX78"></A>
+<A NAME="IDX80"></A>
 <DT><CODE>transpose-chars (C-t)</CODE>
-<DD><A NAME="IDX79"></A>
+<DD><A NAME="IDX81"></A>
 Drag the character before the cursor forward over
 the character at the cursor, moving the
 cursor forward as well.  If the insertion point
@@ -1397,36 +1414,55 @@ transposes the last two characters of the line.
 Negative arguments have no effect.
 <P>
 
-<A NAME="IDX80"></A>
+<A NAME="IDX82"></A>
 <DT><CODE>transpose-words (M-t)</CODE>
-<DD><A NAME="IDX81"></A>
+<DD><A NAME="IDX83"></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="IDX82"></A>
+<A NAME="IDX84"></A>
 <DT><CODE>upcase-word (M-u)</CODE>
-<DD><A NAME="IDX83"></A>
+<DD><A NAME="IDX85"></A>
 Uppercase the current (or following) word.  With a negative argument,
 uppercase the previous word, but do not move the cursor.
 <P>
 
-<A NAME="IDX84"></A>
+<A NAME="IDX86"></A>
 <DT><CODE>downcase-word (M-l)</CODE>
-<DD><A NAME="IDX85"></A>
+<DD><A NAME="IDX87"></A>
 Lowercase the current (or following) word.  With a negative argument,
 lowercase the previous word, but do not move the cursor.
 <P>
 
-<A NAME="IDX86"></A>
+<A NAME="IDX88"></A>
 <DT><CODE>capitalize-word (M-c)</CODE>
-<DD><A NAME="IDX87"></A>
+<DD><A NAME="IDX89"></A>
 Capitalize the current (or following) word.  With a negative argument,
 capitalize the previous word, but do not move the cursor.
 <P>
 
+<A NAME="IDX90"></A>
+<DT><CODE>overwrite-mode ()</CODE>
+<DD><A NAME="IDX91"></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
+<CODE>emacs</CODE> mode; <CODE>vi</CODE> mode does overwrite differently.
+Each call to <CODE>readline()</CODE> starts in insert mode.
+<P>
+
+In overwrite mode, characters bound to <CODE>self-insert</CODE> replace
+the text at point rather than pushing the text to the right.
+Characters bound to <CODE>backward-delete-char</CODE> replace the character
+before point with a space.
+</P><P>
+
+By default, this command is unbound.
+</P><P>
+
 </DL>
 <P>
 
@@ -1450,98 +1486,98 @@ capitalize the previous word, but do not move the cursor.
 
 <DL COMPACT>
 
-<A NAME="IDX88"></A>
+<A NAME="IDX92"></A>
 <DT><CODE>kill-line (C-k)</CODE>
-<DD><A NAME="IDX89"></A>
+<DD><A NAME="IDX93"></A>
 Kill the text from point to the end of the line.
 <P>
 
-<A NAME="IDX90"></A>
+<A NAME="IDX94"></A>
 <DT><CODE>backward-kill-line (C-x Rubout)</CODE>
-<DD><A NAME="IDX91"></A>
+<DD><A NAME="IDX95"></A>
 Kill backward to the beginning of the line.
 <P>
 
-<A NAME="IDX92"></A>
+<A NAME="IDX96"></A>
 <DT><CODE>unix-line-discard (C-u)</CODE>
-<DD><A NAME="IDX93"></A>
+<DD><A NAME="IDX97"></A>
 Kill backward from the cursor to the beginning of the current line.
 <P>
 
-<A NAME="IDX94"></A>
+<A NAME="IDX98"></A>
 <DT><CODE>kill-whole-line ()</CODE>
-<DD><A NAME="IDX95"></A>
+<DD><A NAME="IDX99"></A>
 Kill all characters on the current line, no matter where point is.
 By default, this is unbound.
 <P>
 
-<A NAME="IDX96"></A>
+<A NAME="IDX100"></A>
 <DT><CODE>kill-word (M-d)</CODE>
-<DD><A NAME="IDX97"></A>
+<DD><A NAME="IDX101"></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="IDX98"></A>
+<A NAME="IDX102"></A>
 <DT><CODE>backward-kill-word (M-<KBD>DEL</KBD>)</CODE>
-<DD><A NAME="IDX99"></A>
+<DD><A NAME="IDX103"></A>
 Kill the word behind point.
 Word boundaries are the same as <CODE>backward-word</CODE>.
 <P>
 
-<A NAME="IDX100"></A>
+<A NAME="IDX104"></A>
 <DT><CODE>unix-word-rubout (C-w)</CODE>
-<DD><A NAME="IDX101"></A>
+<DD><A NAME="IDX105"></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="IDX102"></A>
+<A NAME="IDX106"></A>
 <DT><CODE>delete-horizontal-space ()</CODE>
-<DD><A NAME="IDX103"></A>
+<DD><A NAME="IDX107"></A>
 Delete all spaces and tabs around point.  By default, this is unbound.
 <P>
 
-<A NAME="IDX104"></A>
+<A NAME="IDX108"></A>
 <DT><CODE>kill-region ()</CODE>
-<DD><A NAME="IDX105"></A>
+<DD><A NAME="IDX109"></A>
 Kill the text in the current region.
 By default, this command is unbound.
 <P>
 
-<A NAME="IDX106"></A>
+<A NAME="IDX110"></A>
 <DT><CODE>copy-region-as-kill ()</CODE>
-<DD><A NAME="IDX107"></A>
+<DD><A NAME="IDX111"></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="IDX108"></A>
+<A NAME="IDX112"></A>
 <DT><CODE>copy-backward-word ()</CODE>
-<DD><A NAME="IDX109"></A>
+<DD><A NAME="IDX113"></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="IDX110"></A>
+<A NAME="IDX114"></A>
 <DT><CODE>copy-forward-word ()</CODE>
-<DD><A NAME="IDX111"></A>
+<DD><A NAME="IDX115"></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="IDX112"></A>
+<A NAME="IDX116"></A>
 <DT><CODE>yank (C-y)</CODE>
-<DD><A NAME="IDX113"></A>
+<DD><A NAME="IDX117"></A>
 Yank the top of the kill ring into the buffer at point.
 <P>
 
-<A NAME="IDX114"></A>
+<A NAME="IDX118"></A>
 <DT><CODE>yank-pop (M-y)</CODE>
-<DD><A NAME="IDX115"></A>
+<DD><A NAME="IDX119"></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>
@@ -1565,16 +1601,16 @@ the prior command is <CODE>yank</CODE> or <CODE>yank-pop</CODE>.
 <!--docid::SEC18::-->
 <DL COMPACT>
 
-<A NAME="IDX116"></A>
+<A NAME="IDX120"></A>
 <DT><CODE>digit-argument (<KBD>M-0</KBD>, <KBD>M-1</KBD>, <small>...</small> <KBD>M--</KBD>)</CODE>
-<DD><A NAME="IDX117"></A>
+<DD><A NAME="IDX121"></A>
 Add this digit to the argument already accumulating, or start a new
 argument.  <KBD>M--</KBD> starts a negative argument.
 <P>
 
-<A NAME="IDX118"></A>
+<A NAME="IDX122"></A>
 <DT><CODE>universal-argument ()</CODE>
-<DD><A NAME="IDX119"></A>
+<DD><A NAME="IDX123"></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.
@@ -1609,30 +1645,30 @@ By default, this is not bound to a key.
 <P>
 
 <DL COMPACT>
-<A NAME="IDX120"></A>
+<A NAME="IDX124"></A>
 <DT><CODE>complete (<KBD>TAB</KBD>)</CODE>
-<DD><A NAME="IDX121"></A>
+<DD><A NAME="IDX125"></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="IDX122"></A>
+<A NAME="IDX126"></A>
 <DT><CODE>possible-completions (M-?)</CODE>
-<DD><A NAME="IDX123"></A>
+<DD><A NAME="IDX127"></A>
 List the possible completions of the text before point.
 <P>
 
-<A NAME="IDX124"></A>
+<A NAME="IDX128"></A>
 <DT><CODE>insert-completions (M-*)</CODE>
-<DD><A NAME="IDX125"></A>
+<DD><A NAME="IDX129"></A>
 Insert all completions of the text before point that would have
 been generated by <CODE>possible-completions</CODE>.
 <P>
 
-<A NAME="IDX126"></A>
+<A NAME="IDX130"></A>
 <DT><CODE>menu-complete ()</CODE>
-<DD><A NAME="IDX127"></A>
+<DD><A NAME="IDX131"></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
@@ -1647,9 +1683,9 @@ This command is intended to be bound to <KBD>TAB</KBD>, but is unbound
 by default.
 <P>
 
-<A NAME="IDX128"></A>
+<A NAME="IDX132"></A>
 <DT><CODE>delete-char-or-list ()</CODE>
-<DD><A NAME="IDX129"></A>
+<DD><A NAME="IDX133"></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
@@ -1678,22 +1714,22 @@ This command is unbound by default.
 <!--docid::SEC20::-->
 <DL COMPACT>
 
-<A NAME="IDX130"></A>
+<A NAME="IDX134"></A>
 <DT><CODE>start-kbd-macro (C-x ()</CODE>
-<DD><A NAME="IDX131"></A>
+<DD><A NAME="IDX135"></A>
 Begin saving the characters typed into the current keyboard macro.
 <P>
 
-<A NAME="IDX132"></A>
+<A NAME="IDX136"></A>
 <DT><CODE>end-kbd-macro (C-x ))</CODE>
-<DD><A NAME="IDX133"></A>
+<DD><A NAME="IDX137"></A>
 Stop saving the characters typed into the current keyboard macro
 and save the definition.
 <P>
 
-<A NAME="IDX134"></A>
+<A NAME="IDX138"></A>
 <DT><CODE>call-last-kbd-macro (C-x e)</CODE>
-<DD><A NAME="IDX135"></A>
+<DD><A NAME="IDX139"></A>
 Re-execute the last keyboard macro defined, by making the characters
 in the macro appear as if typed at the keyboard.
 <P>
@@ -1719,119 +1755,138 @@ in the macro appear as if typed at the keyboard.
 <!--docid::SEC21::-->
 <DL COMPACT>
 
-<A NAME="IDX136"></A>
+<A NAME="IDX140"></A>
 <DT><CODE>re-read-init-file (C-x C-r)</CODE>
-<DD><A NAME="IDX137"></A>
+<DD><A NAME="IDX141"></A>
 Read in the contents of the <VAR>inputrc</VAR> file, and incorporate
 any bindings or variable assignments found there.
 <P>
 
-<A NAME="IDX138"></A>
+<A NAME="IDX142"></A>
 <DT><CODE>abort (C-g)</CODE>
-<DD><A NAME="IDX139"></A>
+<DD><A NAME="IDX143"></A>
 Abort the current editing command and
 ring the terminal's bell (subject to the setting of
 <CODE>bell-style</CODE>).
 <P>
 
-<A NAME="IDX140"></A>
+<A NAME="IDX144"></A>
 <DT><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, <small>...</small>)</CODE>
-<DD><A NAME="IDX141"></A>
+<DD><A NAME="IDX145"></A>
 If the metafied character <VAR>x</VAR> is lowercase, run the command
 that is bound to the corresponding uppercase character.
 <P>
 
-<A NAME="IDX142"></A>
+<A NAME="IDX146"></A>
 <DT><CODE>prefix-meta (<KBD>ESC</KBD>)</CODE>
-<DD><A NAME="IDX143"></A>
+<DD><A NAME="IDX147"></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="IDX144"></A>
+<A NAME="IDX148"></A>
 <DT><CODE>undo (C-_ or C-x C-u)</CODE>
-<DD><A NAME="IDX145"></A>
+<DD><A NAME="IDX149"></A>
 Incremental undo, separately remembered for each line.
 <P>
 
-<A NAME="IDX146"></A>
+<A NAME="IDX150"></A>
 <DT><CODE>revert-line (M-r)</CODE>
-<DD><A NAME="IDX147"></A>
+<DD><A NAME="IDX151"></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="IDX148"></A>
+<A NAME="IDX152"></A>
 <DT><CODE>tilde-expand (M-~)</CODE>
-<DD><A NAME="IDX149"></A>
+<DD><A NAME="IDX153"></A>
 Perform tilde expansion on the current word.
 <P>
 
-<A NAME="IDX150"></A>
+<A NAME="IDX154"></A>
 <DT><CODE>set-mark (C-@)</CODE>
-<DD><A NAME="IDX151"></A>
+<DD><A NAME="IDX155"></A>
 Set the mark to the point.  If a
 numeric argument is supplied, the mark is set to that position.
 <P>
 
-<A NAME="IDX152"></A>
+<A NAME="IDX156"></A>
 <DT><CODE>exchange-point-and-mark (C-x C-x)</CODE>
-<DD><A NAME="IDX153"></A>
+<DD><A NAME="IDX157"></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="IDX154"></A>
+<A NAME="IDX158"></A>
 <DT><CODE>character-search (C-])</CODE>
-<DD><A NAME="IDX155"></A>
+<DD><A NAME="IDX159"></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="IDX156"></A>
+<A NAME="IDX160"></A>
 <DT><CODE>character-search-backward (M-C-])</CODE>
-<DD><A NAME="IDX157"></A>
+<DD><A NAME="IDX161"></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="IDX158"></A>
+<A NAME="IDX162"></A>
 <DT><CODE>insert-comment (M-#)</CODE>
-<DD><A NAME="IDX159"></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.
+<DD><A NAME="IDX163"></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
+the characters at the beginning of the line do not match the value
+of <CODE>comment-begin</CODE>, the value is inserted, otherwise
+the characters in <CODE>comment-begin</CODE> are deleted from the beginning of
+the line.
+In either case, the line is accepted as if a newline had been typed.
 <P>
 
-<A NAME="IDX160"></A>
+<A NAME="IDX164"></A>
 <DT><CODE>dump-functions ()</CODE>
-<DD><A NAME="IDX161"></A>
+<DD><A NAME="IDX165"></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="IDX162"></A>
+<A NAME="IDX166"></A>
 <DT><CODE>dump-variables ()</CODE>
-<DD><A NAME="IDX163"></A>
+<DD><A NAME="IDX167"></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="IDX164"></A>
+<A NAME="IDX168"></A>
 <DT><CODE>dump-macros ()</CODE>
-<DD><A NAME="IDX165"></A>
+<DD><A NAME="IDX169"></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="IDX170"></A>
+<DT><CODE>emacs-editing-mode (C-e)</CODE>
+<DD><A NAME="IDX171"></A>
+When in <CODE>vi</CODE> command mode, this causes a switch to <CODE>emacs</CODE>
+editing mode.
+<P>
+
+<A NAME="IDX172"></A>
+<DT><CODE>vi-editing-mode (M-C-j)</CODE>
+<DD><A NAME="IDX173"></A>
+When in <CODE>emacs</CODE> editing mode, this causes a switch to <CODE>vi</CODE>
+editing mode.
+<P>
+
 </DL>
 <P>
 
@@ -1959,7 +2014,7 @@ so forth.
 <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, 9  2001</I>
+This document was generated by <I>Chet Ramey</I> on <I>June, 27  2002</I>
 using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
 "><I>texi2html</I></A>
 <P></P>  
@@ -2121,7 +2176,7 @@ the following structure:
 <BR>  
 <FONT SIZE="-1">
 This document was generated
-by <I>Chet Ramey</I> on <I>October, 9  2001</I>
+by <I>Chet Ramey</I> on <I>June, 27  2002</I>
 using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
 "><I>texi2html</I></A>
author	Chet Ramey <chet.ramey@case.edu>	2011-11-23 19:10:13 -0500
committer	Chet Ramey <chet.ramey@case.edu>	2011-11-23 19:10:13 -0500
commit	1e4e5d08e95b810dc5bcec9a3b9b296a0c3afa85 (patch)
tree	3972ebdded0214475d2a402a1cd836da41f7bf2b /doc/rluserman.html
parent	abde3125f6228a63e22de708b9edaef62cab0ac3 (diff)
download	readline-1e4e5d08e95b810dc5bcec9a3b9b296a0c3afa85.tar.gz