diff options
Diffstat (limited to 'doc/readline.html')
| -rw-r--r-- | doc/readline.html | 763 |
1 files changed, 430 insertions, 333 deletions
diff --git a/doc/readline.html b/doc/readline.html index f4ea74d..d8a2eda 100644 --- a/doc/readline.html +++ b/doc/readline.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/rlman.texinfo on 31 December 1998 --> + from /usr/homes/chet/src/bash/readline-src/doc/rlman.texinfo on 1 March 2000 --> <TITLE>GNU Readline Library</TITLE> </HEAD> <BODY> <H1>GNU Readline Library</H1> -<H2>Edition 4.0, for <CODE>Readline Library</CODE> Version 4.0.</H2> -<H2>December 1998</H2> +<H2>Edition 4.1, for <CODE>Readline Library</CODE> Version 4.1.</H2> +<H2>January 2000</H2> <ADDRESS>Brian Fox, Free Software Foundation</ADDRESS> <ADDRESS>Chet Ramey, Case Western Reserve University</ADDRESS> <P> @@ -89,8 +89,8 @@ to provide a command line interface. </P> <P> Published by the Free Software Foundation <BR> -675 Massachusetts Avenue, <BR> -Cambridge, MA 02139 USA +59 Temple Place, Suite 330, <BR> +Boston, MA 02111 USA </P> <P> @@ -155,9 +155,21 @@ is depressed. </P> <P> The text <KBD>M-k</KBD> is read as `Meta-K' and describes the character -produced when the meta key (if you have one) is depressed, and the <KBD>k</KBD> -key is pressed. If you do not have a meta key, the identical keystroke -can be generated by typing <KBD>ESC</KBD> <I>first</I>, and then typing <KBD>k</KBD>. +produced when the Meta key (if you have one) is depressed, and the <KBD>k</KBD> +key is pressed. +The Meta key is labeled <KBD>ALT</KBD> on many keyboards. +On keyboards with two keys labeled <KBD>ALT</KBD> (usually to either side of +the space bar), the <KBD>ALT</KBD> on the left side is generally set to +work as a Meta key. +The <KBD>ALT</KBD> key on the right may also be configured to work as a +Meta key or may be configured as some other modifier, such as a +Compose key for typing accented characters. + +</P> +<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>. Either process is known as <EM>metafying</EM> the <KBD>k</KBD> key. </P> @@ -171,6 +183,10 @@ In addition, several keys have their own names. Specifically, <KBD>DEL</KBD>, <KBD>ESC</KBD>, <KBD>LFD</KBD>, <KBD>SPC</KBD>, <KBD>RET</KBD>, and <KBD>TAB</KBD> all stand for themselves when seen in this text, or in an init file (see section <A HREF="readline.html#SEC9">Readline Init File</A>). +If your keyboard lacks a <KBD>LFD</KBD> key, typing <KBD>C-j</KBD> will +produce the desired character. +The <KBD>RET</KBD> key may be labeled <KBD>Return</KBD> or <KBD>Enter</KBD> on +some keyboards. </P> @@ -219,8 +235,8 @@ erase character to back up and delete the mistyped character. </P> <P> -Sometimes you may miss typing a character that you wanted to type, and -not notice your error until you have typed several other characters. In +Sometimes you may mistype a character, and +not notice the error until you have typed several other characters. In that case, you can type <KBD>C-b</KBD> to move the cursor to the left, and then correct your mistake. Afterwards, you can move the cursor to the right with <KBD>C-f</KBD>. @@ -231,7 +247,7 @@ When you add text in the middle of a line, you will notice that characters to the right of the cursor are `pushed over' to make room for the text that you have inserted. Likewise, when you delete text behind the cursor, characters to the right of the cursor are `pulled back' to fill in the -blank space created by the removal of the text. A list of the basic bare +blank space created by the removal of the text. A list of the bare essentials for editing the text of an input line follows. </P> @@ -243,7 +259,7 @@ Move back one character. <DT><KBD>C-f</KBD> <DD> Move forward one character. -<DT><KBD>DEL</KBD> +<DT><KBD>DEL</KBD> or <KBD>Backspace</KBD> <DD> Delete the character to the left of the cursor. <DT><KBD>C-d</KBD> @@ -252,18 +268,25 @@ Delete the character underneath the cursor. <DT>Printing characters <DD> Insert the character into the line at the cursor. -<DT><KBD>C-_</KBD> +<DT><KBD>C-_</KBD> or <KBD>C-x C-u</KBD> <DD> Undo the last editing command. You can undo all the way back to an empty line. </DL> +<P> +(Depending on your configuration, the <KBD>Backspace</KBD> key be set to +delete the character to the left of the cursor and the <KBD>DEL</KBD> key set +to delete the character underneath the cursor, like <KBD>C-d</KBD>, rather +than the character to the left of the cursor.) + +</P> <H3><A NAME="SEC5" HREF="readline.html#TOC5">Readline Movement Commands</A></H3> <P> -The above table describes the most basic possible keystrokes that you need +The above table describes the most basic keystrokes that you need in order to do editing of the input line. For your convenience, many other commands have been added in addition to <KBD>C-b</KBD>, <KBD>C-f</KBD>, <KBD>C-d</KBD>, and <KBD>DEL</KBD>. Here are some commands for moving more rapidly @@ -308,6 +331,10 @@ operate on characters while meta keystrokes operate on words. <EM>Killing</EM> text means to delete the text from the line, but to save it away for later use, usually by <EM>yanking</EM> (re-inserting) it back into the line. +(`Cut' and `paste' are more recent jargon for `kill' and `yank'.) + +</P> +<P> If the description for a command says that it `kills' text, then you can be sure that you can get the text back in a different (or the same) place later. @@ -335,13 +362,15 @@ Kill the text from the current cursor position to the end of the line. <DT><KBD>M-d</KBD> <DD> -Kill from the cursor to the end of the current word, or if between +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> <DD> -Kill from the cursor the start of the previous word, or if between +Kill from the cursor the start of the previous word, or, if between words, to the start of the previous word. +Word boundaries are the same as those used by <KBD>M-b</KBD>. <DT><KBD>C-w</KBD> <DD> @@ -383,7 +412,7 @@ start of the line, you might type <SAMP>`M-- C-k'</SAMP>. <P> The general way to pass numeric arguments to a command is to type meta digits before the command. If the first `digit' typed is a minus -sign (<KBD>-</KBD>), then the sign of the argument will be negative. Once +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>. @@ -406,15 +435,20 @@ As each character of the search string is typed, Readline displays the next entry from the history matching the string typed so far. An incremental search requires only as many characters as needed to find the desired history entry. -The characters present in the value of the <VAR>isearch-terminators</VAR> variable +To search backward in the history for a particular string, type +<KBD>C-r</KBD>. Typing <KBD>C-s</KBD> searches forward through the history. +The characters present in the value of the <CODE>isearch-terminators</CODE> variable are used to terminate an incremental search. If that variable has not been assigned a value, the <KBD>ESC</KBD> and <KBD>C-J</KBD> characters will terminate an incremental search. <KBD>C-g</KBD> will abort an incremental search and restore the original line. When the search is terminated, the history entry containing the search string becomes the current line. -To find other matching entries in the history list, type <KBD>C-s</KBD> or -<KBD>C-r</KBD> as appropriate. + +</P> +<P> +To find other matching entries in the history list, type <KBD>C-r</KBD> or +<KBD>C-s</KBD> as appropriate. This will search backward or forward in the history for the next entry matching the search string typed so far. Any other key sequence bound to a Readline command will terminate @@ -437,11 +471,11 @@ typed by the user or be part of the contents of the current line. </P> <P> -Although the Readline library comes with a set of <CODE>emacs</CODE>-like +Although the Readline library comes with a set of Emacs-like keybindings installed by default, it is possible to use a different set of keybindings. Any user can customize programs that use Readline by putting -commands in an <EM>inputrc</EM> file in his home directory. +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 that variable is unset, the default is <TT>`~/.inputrc'</TT>. @@ -536,7 +570,7 @@ them; otherwise, they are simply listed. The default limit is <A NAME="IDX12"></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 prepending an <KBD>ESC</KBD> character, converting them to a +bit and prefixing an <KBD>ESC</KBD> character, converting them to a meta-prefixed key sequence. The default value is <SAMP>`on'</SAMP>. <DT><CODE>disable-completion</CODE> @@ -657,7 +691,7 @@ completions. The default is <SAMP>`off'</SAMP>. <DT>Key Bindings <DD> The syntax for controlling key bindings in the init file is -simple. First you have to know the name of the command that you +simple. First you need to find the name of the command that you 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. @@ -727,10 +761,10 @@ an escape character backslash <DT><CODE><KBD>\"</KBD></CODE> <DD> -<KBD>"</KBD> +<KBD>"</KBD>, a double quotation mark <DT><CODE><KBD>\'</KBD></CODE> <DD> -<KBD>'</KBD> +<KBD>'</KBD>, a single quote or apostrophe </DL> In addition to the GNU Emacs style escape sequences, a second @@ -764,11 +798,11 @@ horizontal tab vertical tab <DT><CODE>\<VAR>nnn</VAR></CODE> <DD> -the character whose ASCII code is the octal value <VAR>nnn</VAR> +the character whose <CODE>ASCII</CODE> code is the octal value <VAR>nnn</VAR> (one to three digits) <DT><CODE>\x<VAR>nnn</VAR></CODE> <DD> -the character whose ASCII code is the hexadecimal value <VAR>nnn</VAR> +the character whose <CODE>ASCII</CODE> code is the hexadecimal value <VAR>nnn</VAR> (one to three digits) </DL> @@ -998,6 +1032,14 @@ This section describes Readline commands that may be bound to key sequences. </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 +<CODE>set-mark</CODE> command. +The text between the point and mark is referred to as the <VAR>region</VAR>. + +</P> <H3><A NAME="SEC14" HREF="readline.html#TOC14">Commands For Moving</A></H3> @@ -1032,7 +1074,7 @@ letters and digits. <DT><CODE>backward-word (M-b)</CODE> <DD> <A NAME="IDX31"></A> -Move back to the start of this, or the previous, word. Words are +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> @@ -1112,9 +1154,9 @@ for a string supplied by the user. <DD> <A NAME="IDX43"></A> Search forward through the history for the string of characters -between the start of the current line and the current cursor -position (the <VAR>point</VAR>). This is a non-incremental search. By -default, this command is unbound. +between the start of the current line and the point. +This is a non-incremental search. +By default, this command is unbound. <DT><CODE>history-search-backward ()</CODE> <DD> @@ -1194,13 +1236,13 @@ the character at the cursor, moving the cursor forward as well. If the insertion point is at the end of the line, then this transposes the last two characters of the line. -Negative arguments don't work. +Negative arguments have no effect. <DT><CODE>transpose-words (M-t)</CODE> <DD> <A NAME="IDX54"></A> -Drag the word behind the cursor past the word in front of the cursor -moving the cursor over that word as well. +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> @@ -1231,7 +1273,7 @@ capitalize the previous word, but do not move the cursor. <DT><CODE>kill-line (C-k)</CODE> <DD> <A NAME="IDX58"></A> -Kill the text from the current cursor position to the end of the line. +Kill the text from point to the end of the line. <DT><CODE>backward-kill-line (C-x Rubout)</CODE> <DD> @@ -1242,32 +1284,31 @@ Kill backward to the beginning of the line. <DD> <A NAME="IDX60"></A> Kill backward from the cursor to the beginning of the current line. -The killed text is saved on the kill-ring. <DT><CODE>kill-whole-line ()</CODE> <DD> <A NAME="IDX61"></A> -Kill all characters on the current line, no matter where the -cursor is. By default, this is unbound. +Kill all characters on the current line, no matter point is. +By default, this is unbound. <DT><CODE>kill-word (M-d)</CODE> <DD> <A NAME="IDX62"></A> -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 <CODE>forward-word</CODE>. +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> <DD> <A NAME="IDX63"></A> -Kill the word behind the cursor. Word boundaries are the same -as <CODE>backward-word</CODE>. +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> -Kill the word behind the cursor, using white space as a word -boundary. The killed text is saved on the kill-ring. +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> @@ -1277,8 +1318,7 @@ Delete all spaces and tabs around point. By default, this is unbound. <DT><CODE>kill-region ()</CODE> <DD> <A NAME="IDX66"></A> -Kill the text between the point and the <EM>mark</EM> (saved -cursor position). This text is referred to as the <VAR>region</VAR>. +Kill the text in the current region. By default, this command is unbound. <DT><CODE>copy-region-as-kill ()</CODE> @@ -1427,7 +1467,7 @@ 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> -Read in the contents of the inputrc file, and incorporate +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> @@ -1720,6 +1760,15 @@ defined within the Readline library which allow a user program to add customized functionality to Readline. </P> +<P> +Before declaring any functions that customize Readline's behavior, or +using any functionality Readline provides in other code, an +application writer should include the file <CODE><readline/readline.h></CODE> +in any file that uses Readline's features. Since some of the definitions +in <CODE>readline.h</CODE> use the <CODE>stdio</CODE> library, the file +<CODE><stdio.h></CODE> should be included before <CODE>readline.h</CODE>. + +</P> <UL> <LI><A HREF="readline.html#SEC26">The Function Type</A>: C declarations to make code readable. @@ -1824,7 +1873,9 @@ These variables are available to function writers. <DT><U>Variable:</U> char * <B>rl_line_buffer</B> <DD><A NAME="IDX99"></A> This is the line gathered so far. You are welcome to modify the -contents of the line, but see section <A HREF="readline.html#SEC34">Allowing Undoing</A>. +contents of the line, but see section <A HREF="readline.html#SEC34">Allowing Undoing</A>. The +function <CODE>rl_extend_line_buffer</CODE> is available to increase +the memory allocated to <CODE>rl_line_buffer</CODE>. </DL> </P> @@ -1896,8 +1947,22 @@ The prompt Readline uses. This is set from the argument to </P> <P> <DL> -<DT><U>Variable:</U> char * <B>rl_library_version</B> +<DT><U>Variable:</U> int <B>rl_already_prompted</B> <DD><A NAME="IDX107"></A> +If an application wishes to display the prompt itself, rather than have +Readline do it the first time <CODE>readline()</CODE> is called, it should set +this variable to a non-zero value after displaying the prompt. +The prompt must also be passed as the argument to <CODE>readline()</CODE> so +the redisplay functions can update the display properly. +The calling application is responsible for managing the value; Readline +never sets it. +</DL> + +</P> +<P> +<DL> +<DT><U>Variable:</U> char * <B>rl_library_version</B> +<DD><A NAME="IDX108"></A> The version number of this revision of the library. </DL> @@ -1905,7 +1970,7 @@ The version number of this revision of the library. <P> <DL> <DT><U>Variable:</U> char * <B>rl_terminal_name</B> -<DD><A NAME="IDX108"></A> +<DD><A NAME="IDX109"></A> The terminal type, used for initialization. </DL> @@ -1913,7 +1978,7 @@ The terminal type, used for initialization. <P> <DL> <DT><U>Variable:</U> char * <B>rl_readline_name</B> -<DD><A NAME="IDX109"></A> +<DD><A NAME="IDX110"></A> This variable is set to a unique name by each application using Readline. The value allows conditional parsing of the inputrc file (see section <A HREF="readline.html#SEC11">Conditional Init Constructs</A>). @@ -1923,7 +1988,7 @@ The value allows conditional parsing of the inputrc file <P> <DL> <DT><U>Variable:</U> FILE * <B>rl_instream</B> -<DD><A NAME="IDX110"></A> +<DD><A NAME="IDX111"></A> The stdio stream from which Readline reads input. </DL> @@ -1931,7 +1996,7 @@ The stdio stream from which Readline reads input. <P> <DL> <DT><U>Variable:</U> FILE * <B>rl_outstream</B> -<DD><A NAME="IDX111"></A> +<DD><A NAME="IDX112"></A> The stdio stream to which Readline performs output. </DL> @@ -1939,7 +2004,7 @@ The stdio stream to which Readline performs output. <P> <DL> <DT><U>Variable:</U> Function * <B>rl_startup_hook</B> -<DD><A NAME="IDX112"></A> +<DD><A NAME="IDX113"></A> If non-zero, this is the address of a function to call just before <CODE>readline</CODE> prints the first prompt. </DL> @@ -1948,7 +2013,7 @@ before <CODE>readline</CODE> prints the first prompt. <P> <DL> <DT><U>Variable:</U> Function * <B>rl_pre_input_hook</B> -<DD><A NAME="IDX113"></A> +<DD><A NAME="IDX114"></A> If non-zero, this is the address of a function to call after the first prompt has been printed and just before <CODE>readline</CODE> starts reading input characters. @@ -1958,7 +2023,7 @@ starts reading input characters. <P> <DL> <DT><U>Variable:</U> Function * <B>rl_event_hook</B> -<DD><A NAME="IDX114"></A> +<DD><A NAME="IDX115"></A> If non-zero, this is the address of a function to call periodically when readline is waiting for terminal input. </DL> @@ -1967,7 +2032,7 @@ when readline is waiting for terminal input. <P> <DL> <DT><U>Variable:</U> Function * <B>rl_getc_function</B> -<DD><A NAME="IDX115"></A> +<DD><A NAME="IDX116"></A> If non-zero, <CODE>readline</CODE> will call indirectly through this pointer to get a character from the input stream. By default, it is set to <CODE>rl_getc</CODE>, the default <CODE>readline</CODE> character input function @@ -1978,7 +2043,7 @@ to get a character from the input stream. By default, it is set to <P> <DL> <DT><U>Variable:</U> VFunction * <B>rl_redisplay_function</B> -<DD><A NAME="IDX116"></A> +<DD><A NAME="IDX117"></A> If non-zero, <CODE>readline</CODE> will call indirectly through this pointer to update the display with the current contents of the editing buffer. By default, it is set to <CODE>rl_redisplay</CODE>, the default <CODE>readline</CODE> @@ -1989,7 +2054,7 @@ redisplay function (see section <A HREF="readline.html#SEC35">Redisplay</A>). <P> <DL> <DT><U>Variable:</U> Keymap <B>rl_executing_keymap</B> -<DD><A NAME="IDX117"></A> +<DD><A NAME="IDX118"></A> This variable is set to the keymap (see section <A HREF="readline.html#SEC31">Selecting a Keymap</A>) in which the currently executing readline function was found. </DL> @@ -1998,7 +2063,7 @@ currently executing readline function was found. <P> <DL> <DT><U>Variable:</U> Keymap <B>rl_binding_keymap</B> -<DD><A NAME="IDX118"></A> +<DD><A NAME="IDX119"></A> This variable is set to the keymap (see section <A HREF="readline.html#SEC31">Selecting a Keymap</A>) in which the last key binding occurred. </DL> @@ -2048,7 +2113,7 @@ well. Readline provides a function for doing that: <P> <DL> <DT><U>Function:</U> int <B>rl_add_defun</B> <I>(char *name, Function *function, int key)</I> -<DD><A NAME="IDX119"></A> +<DD><A NAME="IDX120"></A> Add <VAR>name</VAR> to the list of named functions. Make <VAR>function</VAR> be the function that gets called. If <VAR>key</VAR> is not -1, then bind it to <VAR>function</VAR> using <CODE>rl_bind_key ()</CODE>. @@ -2077,7 +2142,7 @@ Readline which keymap to use. <P> <DL> <DT><U>Function:</U> Keymap <B>rl_make_bare_keymap</B> <I>()</I> -<DD><A NAME="IDX120"></A> +<DD><A NAME="IDX121"></A> Returns a new, empty keymap. The space for the keymap is allocated with <CODE>malloc ()</CODE>; you should <CODE>free ()</CODE> it when you are done. </DL> @@ -2086,7 +2151,7 @@ Returns a new, empty keymap. The space for the keymap is allocated with <P> <DL> <DT><U>Function:</U> Keymap <B>rl_copy_keymap</B> <I>(Keymap map)</I> -<DD><A NAME="IDX121"></A> +<DD><A NAME="IDX122"></A> Return a new keymap which is a copy of <VAR>map</VAR>. </DL> @@ -2094,7 +2159,7 @@ Return a new keymap which is a copy of <VAR>map</VAR>. <P> <DL> <DT><U>Function:</U> Keymap <B>rl_make_keymap</B> <I>()</I> -<DD><A NAME="IDX122"></A> +<DD><A NAME="IDX123"></A> Return a new keymap with the printing characters bound to rl_insert, the lowercase Meta characters bound to run their equivalents, and the Meta digits bound to produce numeric arguments. @@ -2104,7 +2169,7 @@ the Meta digits bound to produce numeric arguments. <P> <DL> <DT><U>Function:</U> void <B>rl_discard_keymap</B> <I>(Keymap keymap)</I> -<DD><A NAME="IDX123"></A> +<DD><A NAME="IDX124"></A> Free the storage associated with <VAR>keymap</VAR>. </DL> @@ -2117,7 +2182,7 @@ change which keymap is active. <P> <DL> <DT><U>Function:</U> Keymap <B>rl_get_keymap</B> <I>()</I> -<DD><A NAME="IDX124"></A> +<DD><A NAME="IDX125"></A> Returns the currently active keymap. </DL> @@ -2125,7 +2190,7 @@ Returns the currently active keymap. <P> <DL> <DT><U>Function:</U> void <B>rl_set_keymap</B> <I>(Keymap keymap)</I> -<DD><A NAME="IDX125"></A> +<DD><A NAME="IDX126"></A> Makes <VAR>keymap</VAR> the currently active keymap. </DL> @@ -2133,7 +2198,7 @@ Makes <VAR>keymap</VAR> the currently active keymap. <P> <DL> <DT><U>Function:</U> Keymap <B>rl_get_keymap_by_name</B> <I>(char *name)</I> -<DD><A NAME="IDX126"></A> +<DD><A NAME="IDX127"></A> Return the keymap matching <VAR>name</VAR>. <VAR>name</VAR> is one which would be supplied in a <CODE>set keymap</CODE> inputrc line (see section <A HREF="readline.html#SEC9">Readline Init File</A>). </DL> @@ -2142,7 +2207,7 @@ be supplied in a <CODE>set keymap</CODE> inputrc line (see section <A HREF="read <P> <DL> <DT><U>Function:</U> char * <B>rl_get_keymap_name</B> <I>(Keymap keymap)</I> -<DD><A NAME="IDX127"></A> +<DD><A NAME="IDX128"></A> Return the name matching <VAR>keymap</VAR>. <VAR>name</VAR> is one which would be supplied in a <CODE>set keymap</CODE> inputrc line (see section <A HREF="readline.html#SEC9">Readline Init File</A>). </DL> @@ -2162,13 +2227,22 @@ this manual assume that. </P> <P> +Since <CODE>readline</CODE> installs a set of default key bindings the first +time it is called, there is always the danger that a custom binding +installed before the first call to <CODE>readline</CODE> will be overridden. +An alternate mechanism is to install custom key bindings in an +initialization function assigned to the <CODE>rl_startup_hook</CODE> variable +(see section <A HREF="readline.html#SEC28">Readline Variables</A>). + +</P> +<P> These functions manage key bindings. </P> <P> <DL> <DT><U>Function:</U> int <B>rl_bind_key</B> <I>(int key, Function *function)</I> -<DD><A NAME="IDX128"></A> +<DD><A NAME="IDX129"></A> Binds <VAR>key</VAR> to <VAR>function</VAR> in the currently active keymap. Returns non-zero in the case of an invalid <VAR>key</VAR>. </DL> @@ -2177,7 +2251,7 @@ Returns non-zero in the case of an invalid <VAR>key</VAR>. <P> <DL> <DT><U>Function:</U> int <B>rl_bind_key_in_map</B> <I>(int key, Function *function, Keymap map)</I> -<DD><A NAME="IDX129"></A> +<DD><A NAME="IDX130"></A> Bind <VAR>key</VAR> to <VAR>function</VAR> in <VAR>map</VAR>. Returns non-zero in the case of an invalid <VAR>key</VAR>. </DL> @@ -2186,7 +2260,7 @@ of an invalid <VAR>key</VAR>. <P> <DL> <DT><U>Function:</U> int <B>rl_unbind_key</B> <I>(int key)</I> -<DD><A NAME="IDX130"></A> +<DD><A NAME="IDX131"></A> Bind <VAR>key</VAR> to the null function in the currently active keymap. Returns non-zero in case of error. </DL> @@ -2195,7 +2269,7 @@ Returns non-zero in case of error. <P> <DL> <DT><U>Function:</U> int <B>rl_unbind_key_in_map</B> <I>(int key, Keymap map)</I> -<DD><A NAME="IDX131"></A> +<DD><A NAME="IDX132"></A> Bind <VAR>key</VAR> to the null function in <VAR>map</VAR>. Returns non-zero in case of error. </DL> @@ -2204,7 +2278,7 @@ Returns non-zero in case of error. <P> <DL> <DT><U>Function:</U> int <B>rl_unbind_function_in_map</B> <I>(Function *function, Keymap map)</I> -<DD><A NAME="IDX132"></A> +<DD><A NAME="IDX133"></A> Unbind all keys that execute <VAR>function</VAR> in <VAR>map</VAR>. </DL> @@ -2212,7 +2286,7 @@ Unbind all keys that execute <VAR>function</VAR> in <VAR>map</VAR>. <P> <DL> <DT><U>Function:</U> int <B>rl_unbind_command_in_map</B> <I>(char *command, Keymap map)</I> -<DD><A NAME="IDX133"></A> +<DD><A NAME="IDX134"></A> Unbind all keys that are bound to <VAR>command</VAR> in <VAR>map</VAR>. </DL> @@ -2220,7 +2294,7 @@ Unbind all keys that are bound to <VAR>command</VAR> in <VAR>map</VAR>. <P> <DL> <DT><U>Function:</U> int <B>rl_generic_bind</B> <I>(int type, char *keyseq, char *data, Keymap map)</I> -<DD><A NAME="IDX134"></A> +<DD><A NAME="IDX135"></A> Bind the key sequence represented by the string <VAR>keyseq</VAR> to the arbitrary pointer <VAR>data</VAR>. <VAR>type</VAR> says what kind of data is pointed to by <VAR>data</VAR>; this can be a function (<CODE>ISFUNC</CODE>), a macro @@ -2232,7 +2306,7 @@ necessary. The initial keymap in which to do bindings is <VAR>map</VAR>. <P> <DL> <DT><U>Function:</U> int <B>rl_parse_and_bind</B> <I>(char *line)</I> -<DD><A NAME="IDX135"></A> +<DD><A NAME="IDX136"></A> Parse <VAR>line</VAR> as if it had been read from the <CODE>inputrc</CODE> file and perform any key bindings and variable assignments found (see section <A HREF="readline.html#SEC9">Readline Init File</A>). @@ -2242,7 +2316,7 @@ perform any key bindings and variable assignments found <P> <DL> <DT><U>Function:</U> int <B>rl_read_init_file</B> <I>(char *filename)</I> -<DD><A NAME="IDX136"></A> +<DD><A NAME="IDX137"></A> Read keybindings and variable assignments from <VAR>filename</VAR> (see section <A HREF="readline.html#SEC9">Readline Init File</A>). </DL> @@ -2260,7 +2334,7 @@ and the functions invoked by a particular key sequence. <P> <DL> <DT><U>Function:</U> Function * <B>rl_named_function</B> <I>(char *name)</I> -<DD><A NAME="IDX137"></A> +<DD><A NAME="IDX138"></A> Return the function with name <VAR>name</VAR>. </DL> @@ -2268,7 +2342,7 @@ Return the function with name <VAR>name</VAR>. <P> <DL> <DT><U>Function:</U> Function * <B>rl_function_of_keyseq</B> <I>(char *keyseq, Keymap map, int *type)</I> -<DD><A NAME="IDX138"></A> +<DD><A NAME="IDX139"></A> Return the function invoked by <VAR>keyseq</VAR> in keymap <VAR>map</VAR>. If <VAR>map</VAR> is NULL, the current keymap is used. If <VAR>type</VAR> is not NULL, the type of the object is returned in it (one of <CODE>ISFUNC</CODE>, @@ -2279,7 +2353,7 @@ not NULL, the type of the object is returned in it (one of <CODE>ISFUNC</CODE>, <P> <DL> <DT><U>Function:</U> char ** <B>rl_invoking_keyseqs</B> <I>(Function *function)</I> -<DD><A NAME="IDX139"></A> +<DD><A NAME="IDX140"></A> Return an array of strings representing the key sequences used to invoke <VAR>function</VAR> in the current keymap. </DL> @@ -2288,7 +2362,7 @@ invoke <VAR>function</VAR> in the current keymap. <P> <DL> <DT><U>Function:</U> char ** <B>rl_invoking_keyseqs_in_map</B> <I>(Function *function, Keymap map)</I> -<DD><A NAME="IDX140"></A> +<DD><A NAME="IDX141"></A> Return an array of strings representing the key sequences used to invoke <VAR>function</VAR> in the keymap <VAR>map</VAR>. </DL> @@ -2297,7 +2371,7 @@ invoke <VAR>function</VAR> in the keymap <VAR>map</VAR>. <P> <DL> <DT><U>Function:</U> void <B>rl_function_dumper</B> <I>(int readable)</I> -<DD><A NAME="IDX141"></A> +<DD><A NAME="IDX142"></A> Print the readline function names and the key sequences currently bound to them to <CODE>rl_outstream</CODE>. If <VAR>readable</VAR> is non-zero, the list is formatted in such a way that it can be made part of an @@ -2308,11 +2382,21 @@ the list is formatted in such a way that it can be made part of an <P> <DL> <DT><U>Function:</U> void <B>rl_list_funmap_names</B> <I>()</I> -<DD><A NAME="IDX142"></A> +<DD><A NAME="IDX143"></A> Print the names of all bindable Readline functions to <CODE>rl_outstream</CODE>. </DL> </P> +<P> +<DL> +<DT><U>Function:</U> char ** <B>rl_funmap_names</B> <I>()</I> +<DD><A NAME="IDX144"></A> +Return a NULL terminated array of known function names. The array is +sorted. The array itself is allocated, but not the strings inside. You +should free () the array when you done, but not the pointrs. +</DL> + +</P> <H3><A NAME="SEC34" HREF="readline.html#TOC34">Allowing Undoing</A></H3> @@ -2357,7 +2441,7 @@ tells undo what to undo, not how to undo it. <CODE>UNDO_BEGIN</CODE> and <P> <DL> <DT><U>Function:</U> int <B>rl_begin_undo_group</B> <I>()</I> -<DD><A NAME="IDX143"></A> +<DD><A NAME="IDX145"></A> Begins saving undo information in a group construct. The undo information usually comes from calls to <CODE>rl_insert_text ()</CODE> and <CODE>rl_delete_text ()</CODE>, but could be the result of calls to @@ -2368,7 +2452,7 @@ information usually comes from calls to <CODE>rl_insert_text ()</CODE> and <P> <DL> <DT><U>Function:</U> int <B>rl_end_undo_group</B> <I>()</I> -<DD><A NAME="IDX144"></A> +<DD><A NAME="IDX146"></A> Closes the current undo group started with <CODE>rl_begin_undo_group ()</CODE>. There should be one call to <CODE>rl_end_undo_group ()</CODE> for each call to <CODE>rl_begin_undo_group ()</CODE>. @@ -2378,7 +2462,7 @@ for each call to <CODE>rl_begin_undo_group ()</CODE>. <P> <DL> <DT><U>Function:</U> void <B>rl_add_undo</B> <I>(enum undo_code what, int start, int end, char *text)</I> -<DD><A NAME="IDX145"></A> +<DD><A NAME="IDX147"></A> Remember how to undo an event (according to <VAR>what</VAR>). The affected text runs from <VAR>start</VAR> to <VAR>end</VAR>, and encompasses <VAR>text</VAR>. </DL> @@ -2387,7 +2471,7 @@ text runs from <VAR>start</VAR> to <VAR>end</VAR>, and encompasses <VAR>text</VA <P> <DL> <DT><U>Function:</U> void <B>free_undo_list</B> <I>()</I> -<DD><A NAME="IDX146"></A> +<DD><A NAME="IDX148"></A> Free the existing undo list. </DL> @@ -2395,7 +2479,7 @@ Free the existing undo list. <P> <DL> <DT><U>Function:</U> int <B>rl_do_undo</B> <I>()</I> -<DD><A NAME="IDX147"></A> +<DD><A NAME="IDX149"></A> Undo the first thing on the undo list. Returns <CODE>0</CODE> if there was nothing to undo, non-zero if something was undone. </DL> @@ -2411,7 +2495,7 @@ the text range that you are going to modify. <P> <DL> <DT><U>Function:</U> int <B>rl_modifying</B> <I>(int start, int end)</I> -<DD><A NAME="IDX148"></A> +<DD><A NAME="IDX150"></A> Tell Readline to save the text between <VAR>start</VAR> and <VAR>end</VAR> as a single undo unit. It is assumed that you will subsequently modify that text. @@ -2425,7 +2509,7 @@ that text. <P> <DL> <DT><U>Function:</U> void <B>rl_redisplay</B> <I>()</I> -<DD><A NAME="IDX149"></A> +<DD><A NAME="IDX151"></A> Change what's displayed on the screen to reflect the current contents of <CODE>rl_line_buffer</CODE>. </DL> @@ -2434,7 +2518,7 @@ of <CODE>rl_line_buffer</CODE>. <P> <DL> <DT><U>Function:</U> int <B>rl_forced_update_display</B> <I>()</I> -<DD><A NAME="IDX150"></A> +<DD><A NAME="IDX152"></A> Force the line to be updated and redisplayed, whether or not Readline thinks the screen display is correct. </DL> @@ -2443,16 +2527,29 @@ Readline thinks the screen display is correct. <P> <DL> <DT><U>Function:</U> int <B>rl_on_new_line</B> <I>()</I> -<DD><A NAME="IDX151"></A> -Tell the update routines that we have moved onto a new (empty) line, +<DD><A NAME="IDX153"></A> +Tell the update functions that we have moved onto a new (empty) line, usually after ouputting a newline. </DL> </P> <P> <DL> +<DT><U>Function:</U> int <B>rl_on_new_line_with_prompt</B> <I>()</I> +<DD><A NAME="IDX154"></A> +Tell the update functions that we have moved onto a new line, with +<VAR>rl_prompt</VAR> already displayed. +This could be used by applications that want to output the prompt string +themselves, but still need Readline to know the prompt string length for +redisplay. +It should be used after setting <VAR>rl_already_prompted</VAR>. +</DL> + +</P> +<P> +<DL> <DT><U>Function:</U> int <B>rl_reset_line_state</B> <I>()</I> -<DD><A NAME="IDX152"></A> +<DD><A NAME="IDX155"></A> Reset the display state to a clean state and redisplay the current line starting on a new line. </DL> @@ -2461,7 +2558,7 @@ starting on a new line. <P> <DL> <DT><U>Function:</U> int <B>rl_message</B> <I>(va_alist)</I> -<DD><A NAME="IDX153"></A> +<DD><A NAME="IDX156"></A> The arguments are a string as would be supplied to <CODE>printf</CODE>. The resulting string is displayed in the <EM>echo area</EM>. The echo area is also used to display numeric arguments and search strings. @@ -2471,7 +2568,7 @@ is also used to display numeric arguments and search strings. <P> <DL> <DT><U>Function:</U> int <B>rl_clear_message</B> <I>()</I> -<DD><A NAME="IDX154"></A> +<DD><A NAME="IDX157"></A> Clear the message in the echo area. </DL> @@ -2479,7 +2576,7 @@ Clear the message in the echo area. <P> <DL> <DT><U>Function:</U> void <B>rl_save_prompt</B> <I>()</I> -<DD><A NAME="IDX155"></A> +<DD><A NAME="IDX158"></A> Save the local Readline prompt display state in preparation for displaying a new message in the message area with <CODE>rl_message</CODE>. </DL> @@ -2488,7 +2585,7 @@ displaying a new message in the message area with <CODE>rl_message</CODE>. <P> <DL> <DT><U>Function:</U> void <B>rl_restore_prompt</B> <I>()</I> -<DD><A NAME="IDX156"></A> +<DD><A NAME="IDX159"></A> Restore the local Readline prompt display state saved by the most recent call to <CODE>rl_save_prompt</CODE>. </DL> @@ -2501,7 +2598,7 @@ recent call to <CODE>rl_save_prompt</CODE>. <P> <DL> <DT><U>Function:</U> int <B>rl_insert_text</B> <I>(char *text)</I> -<DD><A NAME="IDX157"></A> +<DD><A NAME="IDX160"></A> Insert <VAR>text</VAR> into the line at the current cursor position. </DL> @@ -2509,7 +2606,7 @@ Insert <VAR>text</VAR> into the line at the current cursor position. <P> <DL> <DT><U>Function:</U> int <B>rl_delete_text</B> <I>(int start, int end)</I> -<DD><A NAME="IDX158"></A> +<DD><A NAME="IDX161"></A> Delete the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line. </DL> @@ -2517,7 +2614,7 @@ Delete the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line. <P> <DL> <DT><U>Function:</U> char * <B>rl_copy_text</B> <I>(int start, int end)</I> -<DD><A NAME="IDX159"></A> +<DD><A NAME="IDX162"></A> Return a copy of the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line. </DL> @@ -2526,7 +2623,7 @@ the current line. <P> <DL> <DT><U>Function:</U> int <B>rl_kill_text</B> <I>(int start, int end)</I> -<DD><A NAME="IDX160"></A> +<DD><A NAME="IDX163"></A> Copy the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line to the kill ring, appending or prepending to the last kill if the last command was a kill command. The text is deleted. @@ -2543,7 +2640,7 @@ not a kill, a new kill ring slot is used. <P> <DL> <DT><U>Function:</U> int <B>rl_read_key</B> <I>()</I> -<DD><A NAME="IDX161"></A> +<DD><A NAME="IDX164"></A> Return the next character available. This handles input inserted into the input stream via <VAR>pending input</VAR> (see section <A HREF="readline.html#SEC28">Readline Variables</A>) and <CODE>rl_stuff_char ()</CODE>, macros, and characters read from the keyboard. @@ -2553,7 +2650,7 @@ and <CODE>rl_stuff_char ()</CODE>, macros, and characters read from the keyboard <P> <DL> <DT><U>Function:</U> int <B>rl_getc</B> <I>(FILE *)</I> -<DD><A NAME="IDX162"></A> +<DD><A NAME="IDX165"></A> Return the next character available from the keyboard. </DL> @@ -2561,7 +2658,7 @@ Return the next character available from the keyboard. <P> <DL> <DT><U>Function:</U> int <B>rl_stuff_char</B> <I>(int c)</I> -<DD><A NAME="IDX163"></A> +<DD><A NAME="IDX166"></A> Insert <VAR>c</VAR> into the Readline input stream. It will be "read" before Readline attempts to read characters from the terminal with <CODE>rl_read_key ()</CODE>. @@ -2570,8 +2667,8 @@ before Readline attempts to read characters from the terminal with </P> <P> <DL> -<DT><U>Function:</U> rl_extend_line_buffer <B>(int</B> <I>len)</I> -<DD><A NAME="IDX164"></A> +<DT><U>Function:</U> int <B>rl_extend_line_buffer</B> <I>(int len)</I> +<DD><A NAME="IDX167"></A> Ensure that <CODE>rl_line_buffer</CODE> has enough space to hold <VAR>len</VAR> characters, possibly reallocating it if necessary. </DL> @@ -2580,7 +2677,7 @@ characters, possibly reallocating it if necessary. <P> <DL> <DT><U>Function:</U> int <B>rl_initialize</B> <I>()</I> -<DD><A NAME="IDX165"></A> +<DD><A NAME="IDX168"></A> Initialize or re-initialize Readline's internal state. </DL> @@ -2588,16 +2685,18 @@ Initialize or re-initialize Readline's internal state. <P> <DL> <DT><U>Function:</U> int <B>rl_reset_terminal</B> <I>(char *terminal_name)</I> -<DD><A NAME="IDX166"></A> +<DD><A NAME="IDX169"></A> Reinitialize Readline's idea of the terminal settings using <VAR>terminal_name</VAR> as the terminal type (e.g., <CODE>vt100</CODE>). +If <VAR>terminal_name</VAR> is NULL, the value of the <CODE>TERM</CODE> +environment variable is used. </DL> </P> <P> <DL> <DT><U>Function:</U> int <B>alphabetic</B> <I>(int c)</I> -<DD><A NAME="IDX167"></A> +<DD><A NAME="IDX170"></A> Return 1 if <VAR>c</VAR> is an alphabetic character. </DL> @@ -2605,7 +2704,7 @@ Return 1 if <VAR>c</VAR> is an alphabetic character. <P> <DL> <DT><U>Function:</U> int <B>numeric</B> <I>(int c)</I> -<DD><A NAME="IDX168"></A> +<DD><A NAME="IDX171"></A> Return 1 if <VAR>c</VAR> is a numeric character. </DL> @@ -2613,7 +2712,7 @@ Return 1 if <VAR>c</VAR> is a numeric character. <P> <DL> <DT><U>Function:</U> int <B>ding</B> <I>()</I> -<DD><A NAME="IDX169"></A> +<DD><A NAME="IDX172"></A> Ring the terminal bell, obeying the setting of <CODE>bell-style</CODE>. </DL> @@ -2621,7 +2720,7 @@ Ring the terminal bell, obeying the setting of <CODE>bell-style</CODE>. <P> <DL> <DT><U>Function:</U> void <B>rl_display_match_list</B> <I>(char **matches, int len, int max)</I> -<DD><A NAME="IDX170"></A> +<DD><A NAME="IDX173"></A> A convenience function for displaying a list of strings in columnar format on Readline's output stream. <CODE>matches</CODE> is the list of strings, in argv format, such as a list of completion matches. @@ -2639,7 +2738,7 @@ The following are implemented as macros, defined in <CODE>chartypes.h</CODE>. <P> <DL> <DT><U>Function:</U> int <B>uppercase_p</B> <I>(int c)</I> -<DD><A NAME="IDX171"></A> +<DD><A NAME="IDX174"></A> Return 1 if <VAR>c</VAR> is an uppercase alphabetic character. </DL> @@ -2647,7 +2746,7 @@ Return 1 if <VAR>c</VAR> is an uppercase alphabetic character. <P> <DL> <DT><U>Function:</U> int <B>lowercase_p</B> <I>(int c)</I> -<DD><A NAME="IDX172"></A> +<DD><A NAME="IDX175"></A> Return 1 if <VAR>c</VAR> is a lowercase alphabetic character. </DL> @@ -2655,7 +2754,7 @@ Return 1 if <VAR>c</VAR> is a lowercase alphabetic character. <P> <DL> <DT><U>Function:</U> int <B>digit_p</B> <I>(int c)</I> -<DD><A NAME="IDX173"></A> +<DD><A NAME="IDX176"></A> Return 1 if <VAR>c</VAR> is a numeric character. </DL> @@ -2663,7 +2762,7 @@ Return 1 if <VAR>c</VAR> is a numeric character. <P> <DL> <DT><U>Function:</U> int <B>to_upper</B> <I>(int c)</I> -<DD><A NAME="IDX174"></A> +<DD><A NAME="IDX177"></A> If <VAR>c</VAR> is a lowercase alphabetic character, return the corresponding uppercase character. </DL> @@ -2672,7 +2771,7 @@ uppercase character. <P> <DL> <DT><U>Function:</U> int <B>to_lower</B> <I>(int c)</I> -<DD><A NAME="IDX175"></A> +<DD><A NAME="IDX178"></A> If <VAR>c</VAR> is an uppercase alphabetic character, return the corresponding lowercase character. </DL> @@ -2681,7 +2780,7 @@ lowercase character. <P> <DL> <DT><U>Function:</U> int <B>digit_value</B> <I>(int c)</I> -<DD><A NAME="IDX176"></A> +<DD><A NAME="IDX179"></A> If <VAR>c</VAR> is a number, return the value it represents. </DL> @@ -2702,7 +2801,7 @@ are functions available to make this easy. <P> <DL> <DT><U>Function:</U> void <B>rl_callback_handler_install</B> <I>(char *prompt, Vfunction *lhandler)</I> -<DD><A NAME="IDX177"></A> +<DD><A NAME="IDX180"></A> Set up the terminal for readline I/O and display the initial expanded value of <VAR>prompt</VAR>. Save the value of <VAR>lhandler</VAR> to use as a callback when a complete line of input has been entered. @@ -2712,7 +2811,7 @@ use as a callback when a complete line of input has been entered. <P> <DL> <DT><U>Function:</U> void <B>rl_callback_read_char</B> <I>()</I> -<DD><A NAME="IDX178"></A> +<DD><A NAME="IDX181"></A> Whenever an application determines that keyboard input is available, it should call <CODE>rl_callback_read_char()</CODE>, which will read the next character from the current input source. If that character completes the @@ -2726,7 +2825,7 @@ line. <CODE>EOF</CODE> is indicated by calling <VAR>lhandler</VAR> with a <P> <DL> <DT><U>Function:</U> void <B>rl_callback_handler_remove</B> <I>()</I> -<DD><A NAME="IDX179"></A> +<DD><A NAME="IDX182"></A> Restore the terminal to its initial state and remove the line handler. This may be called from within a callback as well as independently. </DL> @@ -2860,7 +2959,7 @@ a signal handler, so Readline's internal signal state is not corrupted. <P> <DL> <DT><U>Variable:</U> int <B>rl_catch_signals</B> -<DD><A NAME="IDX180"></A> +<DD><A NAME="IDX183"></A> If this variable is non-zero, Readline will install signal handlers for <CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <CODE>SIGTERM</CODE>, <CODE>SIGALRM</CODE>, <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>, and <CODE>SIGTTOU</CODE>. @@ -2874,7 +2973,7 @@ The default value of <CODE>rl_catch_signals</CODE> is 1. <P> <DL> <DT><U>Variable:</U> int <B>rl_catch_sigwinch</B> -<DD><A NAME="IDX181"></A> +<DD><A NAME="IDX184"></A> If this variable is non-zero, Readline will install a signal handler for <CODE>SIGWINCH</CODE>. @@ -2895,7 +2994,7 @@ and internal state cleanup upon receipt of a signal. <P> <DL> <DT><U>Function:</U> void <B>rl_cleanup_after_signal</B> <I>(void)</I> -<DD><A NAME="IDX182"></A> +<DD><A NAME="IDX185"></A> This function will reset the state of the terminal to what it was before <CODE>readline ()</CODE> was called, and remove the Readline signal handlers for all signals, depending on the values of <CODE>rl_catch_signals</CODE> and @@ -2906,7 +3005,7 @@ all signals, depending on the values of <CODE>rl_catch_signals</CODE> and <P> <DL> <DT><U>Function:</U> void <B>rl_free_line_state</B> <I>(void)</I> -<DD><A NAME="IDX183"></A> +<DD><A NAME="IDX186"></A> This will free any partial state associated with the current input line (undo information, any partial history entry, any partially-entered keyboard macro, and any partially-entered numeric argument). This @@ -2919,7 +3018,7 @@ current input line. <P> <DL> <DT><U>Function:</U> void <B>rl_reset_after_signal</B> <I>(void)</I> -<DD><A NAME="IDX184"></A> +<DD><A NAME="IDX187"></A> This will reinitialize the terminal and reinstall any Readline signal handlers, depending on the values of <CODE>rl_catch_signals</CODE> and <CODE>rl_catch_sigwinch</CODE>. @@ -2935,7 +3034,7 @@ the terminal size when a <CODE>SIGWINCH</CODE> is received. <P> <DL> <DT><U>Function:</U> void <B>rl_resize_terminal</B> <I>(void)</I> -<DD><A NAME="IDX185"></A> +<DD><A NAME="IDX188"></A> Update Readline's internal screen size. </DL> @@ -2947,7 +3046,7 @@ The following functions install and remove Readline's signal handlers. <P> <DL> <DT><U>Function:</U> int <B>rl_set_signals</B> <I>(void)</I> -<DD><A NAME="IDX186"></A> +<DD><A NAME="IDX189"></A> Install Readline's signal handler for <CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <CODE>SIGTERM</CODE>, <CODE>SIGALRM</CODE>, <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>, <CODE>SIGTTOU</CODE>, and <CODE>SIGWINCH</CODE>, depending on the values of @@ -2958,7 +3057,7 @@ Install Readline's signal handler for <CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <P> <DL> <DT><U>Function:</U> int <B>rl_clear_signals</B> <I>(void)</I> -<DD><A NAME="IDX187"></A> +<DD><A NAME="IDX190"></A> Remove all of the Readline signal handlers installed by <CODE>rl_set_signals ()</CODE>. </DL> @@ -3044,7 +3143,7 @@ frees the strings when it has finished with them. <P> <DL> <DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I> -<DD><A NAME="IDX188"></A> +<DD><A NAME="IDX191"></A> Complete the word at or before point. You have supplied the function that does the initial simple matching selection algorithm (see <CODE>completion_matches ()</CODE>). The default is to do filename completion. @@ -3054,7 +3153,7 @@ that does the initial simple matching selection algorithm (see <P> <DL> <DT><U>Variable:</U> Function * <B>rl_completion_entry_function</B> -<DD><A NAME="IDX189"></A> +<DD><A NAME="IDX192"></A> This is a pointer to the generator function for <CODE>completion_matches ()</CODE>. If the value of <CODE>rl_completion_entry_function</CODE> is <CODE>(Function *)NULL</CODE> then the default filename generator function, @@ -3074,7 +3173,7 @@ Readline. <P> <DL> <DT><U>Function:</U> int <B>rl_complete_internal</B> <I>(int what_to_do)</I> -<DD><A NAME="IDX190"></A> +<DD><A NAME="IDX193"></A> Complete the word at or before point. <VAR>what_to_do</VAR> says what to do with the completion. A value of <SAMP>`?'</SAMP> means list the possible completions. <SAMP>`TAB'</SAMP> means do standard completion. <SAMP>`*'</SAMP> means @@ -3087,7 +3186,7 @@ performing partial completion. <P> <DL> <DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I> -<DD><A NAME="IDX191"></A> +<DD><A NAME="IDX194"></A> Complete the word at or before point. You have supplied the function that does the initial simple matching selection algorithm (see <CODE>completion_matches ()</CODE> and <CODE>rl_completion_entry_function</CODE>). @@ -3100,7 +3199,7 @@ argument depending on <VAR>invoking_key</VAR>. <P> <DL> <DT><U>Function:</U> int <B>rl_possible_completions</B> <I>(int count, int invoking_key))</I> -<DD><A NAME="IDX192"></A> +<DD><A NAME="IDX195"></A> List the possible completions. See description of <CODE>rl_complete ()</CODE>. This calls <CODE>rl_complete_internal ()</CODE> with an argument of <SAMP>`?'</SAMP>. @@ -3110,7 +3209,7 @@ List the possible completions. See description of <CODE>rl_complete <P> <DL> <DT><U>Function:</U> int <B>rl_insert_completions</B> <I>(int count, int invoking_key))</I> -<DD><A NAME="IDX193"></A> +<DD><A NAME="IDX196"></A> Insert the list of possible completions into the line, deleting the partially-completed word. See description of <CODE>rl_complete ()</CODE>. This calls <CODE>rl_complete_internal ()</CODE> with an argument of <SAMP>`*'</SAMP>. @@ -3120,7 +3219,7 @@ This calls <CODE>rl_complete_internal ()</CODE> with an argument of <SAMP>`*'</S <P> <DL> <DT><U>Function:</U> char ** <B>completion_matches</B> <I>(char *text, CPFunction *entry_func)</I> -<DD><A NAME="IDX194"></A> +<DD><A NAME="IDX197"></A> Returns an array of <CODE>(char *)</CODE> which is a list of completions for <VAR>text</VAR>. If there are no completions, returns <CODE>(char **)NULL</CODE>. The first entry in the returned array is the substitution for <VAR>text</VAR>. @@ -3140,7 +3239,7 @@ when there are no more matches. <P> <DL> <DT><U>Function:</U> char * <B>filename_completion_function</B> <I>(char *text, int state)</I> -<DD><A NAME="IDX195"></A> +<DD><A NAME="IDX198"></A> A generator function for filename completion in the general case. Note that completion in Bash is a little different because of all the pathnames that must be followed when looking up completions for a @@ -3152,7 +3251,7 @@ completion functions. <P> <DL> <DT><U>Function:</U> char * <B>username_completion_function</B> <I>(char *text, int state)</I> -<DD><A NAME="IDX196"></A> +<DD><A NAME="IDX199"></A> A completion generator for usernames. <VAR>text</VAR> contains a partial username preceded by a random character (usually <SAMP>`~'</SAMP>). As with all completion generators, <VAR>state</VAR> is zero on the first call and non-zero @@ -3167,9 +3266,9 @@ for subsequent calls. <P> <DL> <DT><U>Variable:</U> Function * <B>rl_completion_entry_function</B> -<DD><A NAME="IDX197"></A> +<DD><A NAME="IDX200"></A> A pointer to the generator function for <CODE>completion_matches ()</CODE>. -<CODE>NULL</CODE> means to use <CODE>filename_entry_function ()</CODE>, the default +<CODE>NULL</CODE> means to use <CODE>filename_completion_function ()</CODE>, the default filename completer. </DL> @@ -3177,7 +3276,7 @@ filename completer. <P> <DL> <DT><U>Variable:</U> CPPFunction * <B>rl_attempted_completion_function</B> -<DD><A NAME="IDX198"></A> +<DD><A NAME="IDX201"></A> A pointer to an alternative function to create matches. The function is called with <VAR>text</VAR>, <VAR>start</VAR>, and <VAR>end</VAR>. <VAR>start</VAR> and <VAR>end</VAR> are indices in <CODE>rl_line_buffer</CODE> saying @@ -3192,7 +3291,7 @@ array of strings returned will be used. <P> <DL> <DT><U>Variable:</U> CPFunction * <B>rl_filename_quoting_function</B> -<DD><A NAME="IDX199"></A> +<DD><A NAME="IDX202"></A> A pointer to a function that will quote a filename in an application- specific fashion. This is called if filename completion is being attempted and one of the characters in <CODE>rl_filename_quote_characters</CODE> @@ -3210,7 +3309,7 @@ to reset this character. <P> <DL> <DT><U>Variable:</U> CPFunction * <B>rl_filename_dequoting_function</B> -<DD><A NAME="IDX200"></A> +<DD><A NAME="IDX203"></A> A pointer to a function that will remove application-specific quoting characters from a filename before completion is attempted, so those characters do not interfere with matching the text against names in @@ -3224,7 +3323,7 @@ that delimits the filename (usually <SAMP>`''</SAMP> or <SAMP>`"'</SAMP>). If <P> <DL> <DT><U>Variable:</U> Function * <B>rl_char_is_quoted_p</B> -<DD><A NAME="IDX201"></A> +<DD><A NAME="IDX204"></A> A pointer to a function to call that determines whether or not a specific character in the line buffer is quoted, according to whatever quoting mechanism the program calling readline uses. The function is called with @@ -3238,7 +3337,7 @@ used to break words for the completer. <P> <DL> <DT><U>Variable:</U> int <B>rl_completion_query_items</B> -<DD><A NAME="IDX202"></A> +<DD><A NAME="IDX205"></A> Up to this many items will be displayed in response to a possible-completions call. After that, we ask the user if she is sure she wants to see them all. The default value is 100. @@ -3248,7 +3347,7 @@ she wants to see them all. The default value is 100. <P> <DL> <DT><U>Variable:</U> char * <B>rl_basic_word_break_characters</B> -<DD><A NAME="IDX203"></A> +<DD><A NAME="IDX206"></A> The basic list of characters that signal a break between words for the completer routine. The default value of this variable is the characters which break words for completion in Bash, i.e., @@ -3259,7 +3358,7 @@ which break words for completion in Bash, i.e., <P> <DL> <DT><U>Variable:</U> char * <B>rl_basic_quote_characters</B> -<DD><A NAME="IDX204"></A> +<DD><A NAME="IDX207"></A> List of quote characters which can cause a word break. </DL> @@ -3267,7 +3366,7 @@ List of quote characters which can cause a word break. <P> <DL> <DT><U>Variable:</U> char * <B>rl_completer_word_break_characters</B> -<DD><A NAME="IDX205"></A> +<DD><A NAME="IDX208"></A> The list of characters that signal a break between words for <CODE>rl_complete_internal ()</CODE>. The default list is the value of <CODE>rl_basic_word_break_characters</CODE>. @@ -3277,7 +3376,7 @@ The list of characters that signal a break between words for <P> <DL> <DT><U>Variable:</U> char * <B>rl_completer_quote_characters</B> -<DD><A NAME="IDX206"></A> +<DD><A NAME="IDX209"></A> List of characters which can be used to quote a substring of the line. Completion occurs on the entire substring, and within the substring <CODE>rl_completer_word_break_characters</CODE> are treated as any other character, @@ -3288,7 +3387,7 @@ unless they also appear within this list. <P> <DL> <DT><U>Variable:</U> char * <B>rl_filename_quote_characters</B> -<DD><A NAME="IDX207"></A> +<DD><A NAME="IDX210"></A> A list of characters that cause a filename to be quoted by the completer when they appear in a completed filename. The default is the null string. </DL> @@ -3297,7 +3396,7 @@ when they appear in a completed filename. The default is the null string. <P> <DL> <DT><U>Variable:</U> char * <B>rl_special_prefixes</B> -<DD><A NAME="IDX208"></A> +<DD><A NAME="IDX211"></A> The list of characters that are word break characters, but should be left in <VAR>text</VAR> when it is passed to the completion function. Programs can use this to help determine what kind of completing to do. @@ -3309,7 +3408,7 @@ shell variables and hostnames. <P> <DL> <DT><U>Variable:</U> int <B>rl_completion_append_character</B> -<DD><A NAME="IDX209"></A> +<DD><A NAME="IDX212"></A> When a single completion alternative matches at the end of the command line, this character is appended to the inserted completion text. The default is a space character (<SAMP>` '</SAMP>). Setting this to the null @@ -3323,7 +3422,7 @@ an application-specific command line syntax specification. <P> <DL> <DT><U>Variable:</U> int <B>rl_ignore_completion_duplicates</B> -<DD><A NAME="IDX210"></A> +<DD><A NAME="IDX213"></A> If non-zero, then disallow duplicates in the matches. Default is 1. </DL> @@ -3331,7 +3430,7 @@ If non-zero, then disallow duplicates in the matches. Default is 1. <P> <DL> <DT><U>Variable:</U> int <B>rl_filename_completion_desired</B> -<DD><A NAME="IDX211"></A> +<DD><A NAME="IDX214"></A> Non-zero means that the results of the matches are to be treated as filenames. This is <EM>always</EM> zero on entry, and can only be changed within a completion entry generator function. If it is set to a non-zero @@ -3344,7 +3443,7 @@ characters. <P> <DL> <DT><U>Variable:</U> int <B>rl_filename_quoting_desired</B> -<DD><A NAME="IDX212"></A> +<DD><A NAME="IDX215"></A> Non-zero means that the results of the matches are to be quoted using double quotes (or an application-specific quoting mechanism) if the completed filename contains any characters in @@ -3358,7 +3457,7 @@ by <CODE>rl_filename_quoting_function</CODE>. <P> <DL> <DT><U>Variable:</U> int <B>rl_inhibit_completion</B> -<DD><A NAME="IDX213"></A> +<DD><A NAME="IDX216"></A> If this variable is non-zero, completion is inhibit<ed. The completion character will be inserted as any other bound to <CODE>self-insert</CODE>. </DL> @@ -3367,7 +3466,7 @@ character will be inserted as any other bound to <CODE>self-insert</CODE>. <P> <DL> <DT><U>Variable:</U> Function * <B>rl_ignore_some_completions_function</B> -<DD><A NAME="IDX214"></A> +<DD><A NAME="IDX217"></A> This function, if defined, is called by the completer when real filename completion is done, after all the matching names have been generated. It is passed a <CODE>NULL</CODE> terminated array of matches. @@ -3381,7 +3480,7 @@ from the array must be freed. <P> <DL> <DT><U>Variable:</U> Function * <B>rl_directory_completion_hook</B> -<DD><A NAME="IDX215"></A> +<DD><A NAME="IDX218"></A> This function, if defined, is allowed to modify the directory portion of filenames Readline completes. It is called with the address of a string (the current directory name) as an argument. It could be used @@ -3392,7 +3491,7 @@ to expand symbolic links or shell variables in pathnames. <P> <DL> <DT><U>Variable:</U> VFunction * <B>rl_completion_display_matches_hook</B> -<DD><A NAME="IDX216"></A> +<DD><A NAME="IDX219"></A> If non-zero, then this is the address of a function to call when completing a word would normally display the list of possible matches. This function is called in lieu of Readline displaying the list. @@ -3854,47 +3953,47 @@ valid_argument (caller, arg) <H1><A NAME="SEC46" HREF="readline.html#TOC46">Concept Index</A></H1> <P> Jump to: -<A HREF="#c">c</A> +<A HREF="#cindex_c">c</A> - -<A HREF="#e">e</A> +<A HREF="#cindex_e">e</A> - -<A HREF="#i">i</A> +<A HREF="#cindex_i">i</A> - -<A HREF="#k">k</A> +<A HREF="#cindex_k">k</A> - -<A HREF="#n">n</A> +<A HREF="#cindex_n">n</A> - -<A HREF="#r">r</A> +<A HREF="#cindex_r">r</A> - -<A HREF="#y">y</A> +<A HREF="#cindex_y">y</A> <P> -<H2><A NAME="c">c</A></H2> +<H2><A NAME="cindex_c">c</A></H2> <DIR> <LI><A HREF="readline.html#IDX3">command editing</A> </DIR> -<H2><A NAME="e">e</A></H2> +<H2><A NAME="cindex_e">e</A></H2> <DIR> <LI><A HREF="readline.html#IDX4">editing command lines</A> </DIR> -<H2><A NAME="i">i</A></H2> +<H2><A NAME="cindex_i">i</A></H2> <DIR> <LI><A HREF="readline.html#IDX8">initialization file, readline</A> <LI><A HREF="readline.html#IDX1">interaction, readline</A> </DIR> -<H2><A NAME="k">k</A></H2> +<H2><A NAME="cindex_k">k</A></H2> <DIR> <LI><A HREF="readline.html#IDX7">kill ring</A> <LI><A HREF="readline.html#IDX5">killing text</A> </DIR> -<H2><A NAME="n">n</A></H2> +<H2><A NAME="cindex_n">n</A></H2> <DIR> <LI><A HREF="readline.html#IDX2">notation, readline</A> </DIR> -<H2><A NAME="r">r</A></H2> +<H2><A NAME="cindex_r">r</A></H2> <DIR> <LI><A HREF="readline.html#IDX98">readline, function</A> </DIR> -<H2><A NAME="y">y</A></H2> +<H2><A NAME="cindex_y">y</A></H2> <DIR> <LI><A HREF="readline.html#IDX6">yanking text</A> </DIR> @@ -3905,61 +4004,55 @@ Jump to: <H1><A NAME="SEC47" HREF="readline.html#TOC47">Function and Variable Index</A></H1> <P> Jump to: -<A HREF="#(">(</A> -- -<A HREF="#a">a</A> +<A HREF="#findex_a">a</A> - -<A HREF="#b">b</A> +<A HREF="#findex_b">b</A> - -<A HREF="#c">c</A> +<A HREF="#findex_c">c</A> - -<A HREF="#d">d</A> +<A HREF="#findex_d">d</A> - -<A HREF="#e">e</A> +<A HREF="#findex_e">e</A> - -<A HREF="#f">f</A> +<A HREF="#findex_f">f</A> - -<A HREF="#h">h</A> +<A HREF="#findex_h">h</A> - -<A HREF="#i">i</A> +<A HREF="#findex_i">i</A> - -<A HREF="#k">k</A> +<A HREF="#findex_k">k</A> - -<A HREF="#l">l</A> +<A HREF="#findex_l">l</A> - -<A HREF="#m">m</A> +<A HREF="#findex_m">m</A> - -<A HREF="#n">n</A> +<A HREF="#findex_n">n</A> - -<A HREF="#o">o</A> +<A HREF="#findex_o">o</A> - -<A HREF="#p">p</A> +<A HREF="#findex_p">p</A> - -<A HREF="#q">q</A> +<A HREF="#findex_q">q</A> - -<A HREF="#r">r</A> +<A HREF="#findex_r">r</A> - -<A HREF="#s">s</A> +<A HREF="#findex_s">s</A> - -<A HREF="#t">t</A> +<A HREF="#findex_t">t</A> - -<A HREF="#u">u</A> +<A HREF="#findex_u">u</A> - -<A HREF="#v">v</A> +<A HREF="#findex_v">v</A> - -<A HREF="#y">y</A> +<A HREF="#findex_y">y</A> <P> -<H2><A NAME="(">(</A></H2> -<DIR> -<LI><A HREF="readline.html#IDX164">(int</A> -</DIR> -<H2><A NAME="a">a</A></H2> +<H2><A NAME="findex_a">a</A></H2> <DIR> <LI><A HREF="readline.html#IDX83">abort (C-g)</A> <LI><A HREF="readline.html#IDX34">accept-line (Newline, Return)</A> -<LI><A HREF="readline.html#IDX167">alphabetic</A> +<LI><A HREF="readline.html#IDX170">alphabetic</A> </DIR> -<H2><A NAME="b">b</A></H2> +<H2><A NAME="findex_b">b</A></H2> <DIR> <LI><A HREF="readline.html#IDX29">backward-char (C-b)</A> <LI><A HREF="readline.html#IDX48">backward-delete-char (Rubout)</A> @@ -3970,7 +4063,7 @@ Jump to: <LI><A HREF="readline.html#IDX26">beginning-of-line (C-a)</A> <LI><A HREF="readline.html#IDX9">bell-style</A> </DIR> -<H2><A NAME="c">c</A></H2> +<H2><A NAME="findex_c">c</A></H2> <DIR> <LI><A HREF="readline.html#IDX81">call-last-kbd-macro (C-x e)</A> <LI><A HREF="readline.html#IDX57">capitalize-word (M-c)</A> @@ -3980,21 +4073,21 @@ Jump to: <LI><A HREF="readline.html#IDX10">comment-begin</A> <LI><A HREF="readline.html#IDX74">complete (TAB)</A> <LI><A HREF="readline.html#IDX11">completion-query-items</A> -<LI><A HREF="readline.html#IDX194">completion_matches</A> +<LI><A HREF="readline.html#IDX197">completion_matches</A> <LI><A HREF="readline.html#IDX12">convert-meta</A> <LI><A HREF="readline.html#IDX68">copy-backward-word ()</A> <LI><A HREF="readline.html#IDX69">copy-forward-word ()</A> <LI><A HREF="readline.html#IDX67">copy-region-as-kill ()</A> </DIR> -<H2><A NAME="d">d</A></H2> +<H2><A NAME="findex_d">d</A></H2> <DIR> <LI><A HREF="readline.html#IDX47">delete-char (C-d)</A> <LI><A HREF="readline.html#IDX78">delete-char-or-list ()</A> <LI><A HREF="readline.html#IDX65">delete-horizontal-space ()</A> <LI><A HREF="readline.html#IDX72">digit-argument (M-0, M-1, ... M--)</A> -<LI><A HREF="readline.html#IDX173">digit_p</A> -<LI><A HREF="readline.html#IDX176">digit_value</A> -<LI><A HREF="readline.html#IDX169">ding</A> +<LI><A HREF="readline.html#IDX176">digit_p</A> +<LI><A HREF="readline.html#IDX179">digit_value</A> +<LI><A HREF="readline.html#IDX172">ding</A> <LI><A HREF="readline.html#IDX13">disable-completion</A> <LI><A HREF="readline.html#IDX84">do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, ...)</A> <LI><A HREF="readline.html#IDX56">downcase-word (M-l)</A> @@ -4002,7 +4095,7 @@ Jump to: <LI><A HREF="readline.html#IDX96">dump-macros ()</A> <LI><A HREF="readline.html#IDX95">dump-variables ()</A> </DIR> -<H2><A NAME="e">e</A></H2> +<H2><A NAME="findex_e">e</A></H2> <DIR> <LI><A HREF="readline.html#IDX14">editing-mode</A> <LI><A HREF="readline.html#IDX15">enable-keypad</A> @@ -4012,29 +4105,29 @@ Jump to: <LI><A HREF="readline.html#IDX90">exchange-point-and-mark (C-x C-x)</A> <LI><A HREF="readline.html#IDX16">expand-tilde</A> </DIR> -<H2><A NAME="f">f</A></H2> +<H2><A NAME="findex_f">f</A></H2> <DIR> -<LI><A HREF="readline.html#IDX195">filename_completion_function</A> +<LI><A HREF="readline.html#IDX198">filename_completion_function</A> <LI><A HREF="readline.html#IDX49">forward-backward-delete-char ()</A> <LI><A HREF="readline.html#IDX28">forward-char (C-f)</A> <LI><A HREF="readline.html#IDX40">forward-search-history (C-s)</A> <LI><A HREF="readline.html#IDX30">forward-word (M-f)</A> -<LI><A HREF="readline.html#IDX146">free_undo_list</A> +<LI><A HREF="readline.html#IDX148">free_undo_list</A> </DIR> -<H2><A NAME="h">h</A></H2> +<H2><A NAME="findex_h">h</A></H2> <DIR> <LI><A HREF="readline.html#IDX44">history-search-backward ()</A> <LI><A HREF="readline.html#IDX43">history-search-forward ()</A> <LI><A HREF="readline.html#IDX17">horizontal-scroll-mode</A> </DIR> -<H2><A NAME="i">i</A></H2> +<H2><A NAME="findex_i">i</A></H2> <DIR> <LI><A HREF="readline.html#IDX18">input-meta</A> <LI><A HREF="readline.html#IDX93">insert-comment (M-#)</A> <LI><A HREF="readline.html#IDX76">insert-completions (M-*)</A> <LI><A HREF="readline.html#IDX20">isearch-terminators</A> </DIR> -<H2><A NAME="k">k</A></H2> +<H2><A NAME="findex_k">k</A></H2> <DIR> <LI><A HREF="readline.html#IDX21">keymap</A> <LI><A HREF="readline.html#IDX58">kill-line (C-k)</A> @@ -4042,178 +4135,182 @@ Jump to: <LI><A HREF="readline.html#IDX61">kill-whole-line ()</A> <LI><A HREF="readline.html#IDX62">kill-word (M-d)</A> </DIR> -<H2><A NAME="l">l</A></H2> +<H2><A NAME="findex_l">l</A></H2> <DIR> -<LI><A HREF="readline.html#IDX172">lowercase_p</A> +<LI><A HREF="readline.html#IDX175">lowercase_p</A> </DIR> -<H2><A NAME="m">m</A></H2> +<H2><A NAME="findex_m">m</A></H2> <DIR> <LI><A HREF="readline.html#IDX22">mark-modified-lines</A> <LI><A HREF="readline.html#IDX77">menu-complete ()</A> <LI><A HREF="readline.html#IDX19">meta-flag</A> </DIR> -<H2><A NAME="n">n</A></H2> +<H2><A NAME="findex_n">n</A></H2> <DIR> <LI><A HREF="readline.html#IDX36">next-history (C-n)</A> <LI><A HREF="readline.html#IDX42">non-incremental-forward-search-history (M-n)</A> <LI><A HREF="readline.html#IDX41">non-incremental-reverse-search-history (M-p)</A> -<LI><A HREF="readline.html#IDX168">numeric</A> +<LI><A HREF="readline.html#IDX171">numeric</A> </DIR> -<H2><A NAME="o">o</A></H2> +<H2><A NAME="findex_o">o</A></H2> <DIR> <LI><A HREF="readline.html#IDX23">output-meta</A> </DIR> -<H2><A NAME="p">p</A></H2> +<H2><A NAME="findex_p">p</A></H2> <DIR> <LI><A HREF="readline.html#IDX75">possible-completions (M-?)</A> <LI><A HREF="readline.html#IDX85">prefix-meta (ESC)</A> <LI><A HREF="readline.html#IDX35">previous-history (C-p)</A> </DIR> -<H2><A NAME="q">q</A></H2> +<H2><A NAME="findex_q">q</A></H2> <DIR> <LI><A HREF="readline.html#IDX50">quoted-insert (C-q, C-v)</A> </DIR> -<H2><A NAME="r">r</A></H2> +<H2><A NAME="findex_r">r</A></H2> <DIR> <LI><A HREF="readline.html#IDX82">re-read-init-file (C-x C-r)</A> <LI><A HREF="readline.html#IDX97">readline</A> <LI><A HREF="readline.html#IDX33">redraw-current-line ()</A> <LI><A HREF="readline.html#IDX39">reverse-search-history (C-r)</A> <LI><A HREF="readline.html#IDX87">revert-line (M-r)</A> -<LI><A HREF="readline.html#IDX119">rl_add_defun</A> -<LI><A HREF="readline.html#IDX145">rl_add_undo</A> -<LI><A HREF="readline.html#IDX198">rl_attempted_completion_function</A> -<LI><A HREF="readline.html#IDX204">rl_basic_quote_characters</A> -<LI><A HREF="readline.html#IDX203">rl_basic_word_break_characters</A> -<LI><A HREF="readline.html#IDX143">rl_begin_undo_group</A> -<LI><A HREF="readline.html#IDX128">rl_bind_key</A> -<LI><A HREF="readline.html#IDX129">rl_bind_key_in_map</A> -<LI><A HREF="readline.html#IDX118">rl_binding_keymap</A> -<LI><A HREF="readline.html#IDX177">rl_callback_handler_install</A> -<LI><A HREF="readline.html#IDX179">rl_callback_handler_remove</A> -<LI><A HREF="readline.html#IDX178">rl_callback_read_char</A> -<LI><A HREF="readline.html#IDX180">rl_catch_signals</A> -<LI><A HREF="readline.html#IDX181">rl_catch_sigwinch</A> -<LI><A HREF="readline.html#IDX201">rl_char_is_quoted_p</A> -<LI><A HREF="readline.html#IDX182">rl_cleanup_after_signal</A> -<LI><A HREF="readline.html#IDX154">rl_clear_message</A> -<LI><A HREF="readline.html#IDX187">rl_clear_signals</A> -<LI><A HREF="readline.html#IDX188">rl_complete</A>, <A HREF="rlman.html#IDX191">rl_complete</A> -<LI><A HREF="readline.html#IDX190">rl_complete_internal</A> -<LI><A HREF="readline.html#IDX206">rl_completer_quote_characters</A> -<LI><A HREF="readline.html#IDX205">rl_completer_word_break_characters</A> -<LI><A HREF="readline.html#IDX209">rl_completion_append_character</A> -<LI><A HREF="readline.html#IDX216">rl_completion_display_matches_hook</A> -<LI><A HREF="readline.html#IDX189">rl_completion_entry_function</A>, <A HREF="rlman.html#IDX197">rl_completion_entry_function</A> -<LI><A HREF="readline.html#IDX202">rl_completion_query_items</A> -<LI><A HREF="readline.html#IDX121">rl_copy_keymap</A> -<LI><A HREF="readline.html#IDX159">rl_copy_text</A> -<LI><A HREF="readline.html#IDX158">rl_delete_text</A> -<LI><A HREF="readline.html#IDX215">rl_directory_completion_hook</A> -<LI><A HREF="readline.html#IDX123">rl_discard_keymap</A> -<LI><A HREF="readline.html#IDX170">rl_display_match_list</A> -<LI><A HREF="readline.html#IDX147">rl_do_undo</A> +<LI><A HREF="readline.html#IDX120">rl_add_defun</A> +<LI><A HREF="readline.html#IDX147">rl_add_undo</A> +<LI><A HREF="readline.html#IDX107">rl_already_prompted</A> +<LI><A HREF="readline.html#IDX201">rl_attempted_completion_function</A> +<LI><A HREF="readline.html#IDX207">rl_basic_quote_characters</A> +<LI><A HREF="readline.html#IDX206">rl_basic_word_break_characters</A> +<LI><A HREF="readline.html#IDX145">rl_begin_undo_group</A> +<LI><A HREF="readline.html#IDX129">rl_bind_key</A> +<LI><A HREF="readline.html#IDX130">rl_bind_key_in_map</A> +<LI><A HREF="readline.html#IDX119">rl_binding_keymap</A> +<LI><A HREF="readline.html#IDX180">rl_callback_handler_install</A> +<LI><A HREF="readline.html#IDX182">rl_callback_handler_remove</A> +<LI><A HREF="readline.html#IDX181">rl_callback_read_char</A> +<LI><A HREF="readline.html#IDX183">rl_catch_signals</A> +<LI><A HREF="readline.html#IDX184">rl_catch_sigwinch</A> +<LI><A HREF="readline.html#IDX204">rl_char_is_quoted_p</A> +<LI><A HREF="readline.html#IDX185">rl_cleanup_after_signal</A> +<LI><A HREF="readline.html#IDX157">rl_clear_message</A> +<LI><A HREF="readline.html#IDX190">rl_clear_signals</A> +<LI><A HREF="readline.html#IDX191">rl_complete</A>, <A HREF="readline.html#IDX194">rl_complete</A> +<LI><A HREF="readline.html#IDX193">rl_complete_internal</A> +<LI><A HREF="readline.html#IDX209">rl_completer_quote_characters</A> +<LI><A HREF="readline.html#IDX208">rl_completer_word_break_characters</A> +<LI><A HREF="readline.html#IDX212">rl_completion_append_character</A> +<LI><A HREF="readline.html#IDX219">rl_completion_display_matches_hook</A> +<LI><A HREF="readline.html#IDX192">rl_completion_entry_function</A>, <A HREF="readline.html#IDX200">rl_completion_entry_function</A> +<LI><A HREF="readline.html#IDX205">rl_completion_query_items</A> +<LI><A HREF="readline.html#IDX122">rl_copy_keymap</A> +<LI><A HREF="readline.html#IDX162">rl_copy_text</A> +<LI><A HREF="readline.html#IDX161">rl_delete_text</A> +<LI><A HREF="readline.html#IDX218">rl_directory_completion_hook</A> +<LI><A HREF="readline.html#IDX124">rl_discard_keymap</A> +<LI><A HREF="readline.html#IDX173">rl_display_match_list</A> +<LI><A HREF="readline.html#IDX149">rl_do_undo</A> <LI><A HREF="readline.html#IDX103">rl_done</A> <LI><A HREF="readline.html#IDX101">rl_end</A> -<LI><A HREF="readline.html#IDX144">rl_end_undo_group</A> +<LI><A HREF="readline.html#IDX146">rl_end_undo_group</A> <LI><A HREF="readline.html#IDX105">rl_erase_empty_line</A> -<LI><A HREF="readline.html#IDX114">rl_event_hook</A> -<LI><A HREF="readline.html#IDX117">rl_executing_keymap</A> -<LI><A HREF="readline.html#IDX211">rl_filename_completion_desired</A> -<LI><A HREF="readline.html#IDX200">rl_filename_dequoting_function</A> -<LI><A HREF="readline.html#IDX207">rl_filename_quote_characters</A> -<LI><A HREF="readline.html#IDX212">rl_filename_quoting_desired</A> -<LI><A HREF="readline.html#IDX199">rl_filename_quoting_function</A> -<LI><A HREF="readline.html#IDX150">rl_forced_update_display</A> -<LI><A HREF="readline.html#IDX183">rl_free_line_state</A> -<LI><A HREF="readline.html#IDX141">rl_function_dumper</A> -<LI><A HREF="readline.html#IDX138">rl_function_of_keyseq</A> -<LI><A HREF="readline.html#IDX134">rl_generic_bind</A> -<LI><A HREF="readline.html#IDX124">rl_get_keymap</A> -<LI><A HREF="readline.html#IDX126">rl_get_keymap_by_name</A> -<LI><A HREF="readline.html#IDX127">rl_get_keymap_name</A> -<LI><A HREF="readline.html#IDX162">rl_getc</A> -<LI><A HREF="readline.html#IDX115">rl_getc_function</A> -<LI><A HREF="readline.html#IDX210">rl_ignore_completion_duplicates</A> -<LI><A HREF="readline.html#IDX214">rl_ignore_some_completions_function</A> -<LI><A HREF="readline.html#IDX213">rl_inhibit_completion</A> -<LI><A HREF="readline.html#IDX165">rl_initialize</A> -<LI><A HREF="readline.html#IDX193">rl_insert_completions</A> -<LI><A HREF="readline.html#IDX157">rl_insert_text</A> -<LI><A HREF="readline.html#IDX110">rl_instream</A> -<LI><A HREF="readline.html#IDX139">rl_invoking_keyseqs</A> -<LI><A HREF="readline.html#IDX140">rl_invoking_keyseqs_in_map</A> -<LI><A HREF="readline.html#IDX160">rl_kill_text</A> -<LI><A HREF="readline.html#IDX107">rl_library_version</A> +<LI><A HREF="readline.html#IDX115">rl_event_hook</A> +<LI><A HREF="readline.html#IDX118">rl_executing_keymap</A> +<LI><A HREF="readline.html#IDX167">rl_extend_line_buffer</A> +<LI><A HREF="readline.html#IDX214">rl_filename_completion_desired</A> +<LI><A HREF="readline.html#IDX203">rl_filename_dequoting_function</A> +<LI><A HREF="readline.html#IDX210">rl_filename_quote_characters</A> +<LI><A HREF="readline.html#IDX215">rl_filename_quoting_desired</A> +<LI><A HREF="readline.html#IDX202">rl_filename_quoting_function</A> +<LI><A HREF="readline.html#IDX152">rl_forced_update_display</A> +<LI><A HREF="readline.html#IDX186">rl_free_line_state</A> +<LI><A HREF="readline.html#IDX142">rl_function_dumper</A> +<LI><A HREF="readline.html#IDX139">rl_function_of_keyseq</A> +<LI><A HREF="readline.html#IDX144">rl_funmap_names</A> +<LI><A HREF="readline.html#IDX135">rl_generic_bind</A> +<LI><A HREF="readline.html#IDX125">rl_get_keymap</A> +<LI><A HREF="readline.html#IDX127">rl_get_keymap_by_name</A> +<LI><A HREF="readline.html#IDX128">rl_get_keymap_name</A> +<LI><A HREF="readline.html#IDX165">rl_getc</A> +<LI><A HREF="readline.html#IDX116">rl_getc_function</A> +<LI><A HREF="readline.html#IDX213">rl_ignore_completion_duplicates</A> +<LI><A HREF="readline.html#IDX217">rl_ignore_some_completions_function</A> +<LI><A HREF="readline.html#IDX216">rl_inhibit_completion</A> +<LI><A HREF="readline.html#IDX168">rl_initialize</A> +<LI><A HREF="readline.html#IDX196">rl_insert_completions</A> +<LI><A HREF="readline.html#IDX160">rl_insert_text</A> +<LI><A HREF="readline.html#IDX111">rl_instream</A> +<LI><A HREF="readline.html#IDX140">rl_invoking_keyseqs</A> +<LI><A HREF="readline.html#IDX141">rl_invoking_keyseqs_in_map</A> +<LI><A HREF="readline.html#IDX163">rl_kill_text</A> +<LI><A HREF="readline.html#IDX108">rl_library_version</A> <LI><A HREF="readline.html#IDX99">rl_line_buffer</A> -<LI><A HREF="readline.html#IDX142">rl_list_funmap_names</A> -<LI><A HREF="readline.html#IDX120">rl_make_bare_keymap</A> -<LI><A HREF="readline.html#IDX122">rl_make_keymap</A> +<LI><A HREF="readline.html#IDX143">rl_list_funmap_names</A> +<LI><A HREF="readline.html#IDX121">rl_make_bare_keymap</A> +<LI><A HREF="readline.html#IDX123">rl_make_keymap</A> <LI><A HREF="readline.html#IDX102">rl_mark</A> -<LI><A HREF="readline.html#IDX153">rl_message</A> -<LI><A HREF="readline.html#IDX148">rl_modifying</A> -<LI><A HREF="readline.html#IDX137">rl_named_function</A> -<LI><A HREF="readline.html#IDX151">rl_on_new_line</A> -<LI><A HREF="readline.html#IDX111">rl_outstream</A> -<LI><A HREF="readline.html#IDX135">rl_parse_and_bind</A> +<LI><A HREF="readline.html#IDX156">rl_message</A> +<LI><A HREF="readline.html#IDX150">rl_modifying</A> +<LI><A HREF="readline.html#IDX138">rl_named_function</A> +<LI><A HREF="readline.html#IDX153">rl_on_new_line</A> +<LI><A HREF="readline.html#IDX154">rl_on_new_line_with_prompt</A> +<LI><A HREF="readline.html#IDX112">rl_outstream</A> +<LI><A HREF="readline.html#IDX136">rl_parse_and_bind</A> <LI><A HREF="readline.html#IDX104">rl_pending_input</A> <LI><A HREF="readline.html#IDX100">rl_point</A> -<LI><A HREF="readline.html#IDX192">rl_possible_completions</A> -<LI><A HREF="readline.html#IDX113">rl_pre_input_hook</A> +<LI><A HREF="readline.html#IDX195">rl_possible_completions</A> +<LI><A HREF="readline.html#IDX114">rl_pre_input_hook</A> <LI><A HREF="readline.html#IDX106">rl_prompt</A> -<LI><A HREF="readline.html#IDX136">rl_read_init_file</A> -<LI><A HREF="readline.html#IDX161">rl_read_key</A> -<LI><A HREF="readline.html#IDX109">rl_readline_name</A> -<LI><A HREF="readline.html#IDX149">rl_redisplay</A> -<LI><A HREF="readline.html#IDX116">rl_redisplay_function</A> -<LI><A HREF="readline.html#IDX184">rl_reset_after_signal</A> -<LI><A HREF="readline.html#IDX152">rl_reset_line_state</A> -<LI><A HREF="readline.html#IDX166">rl_reset_terminal</A> -<LI><A HREF="readline.html#IDX185">rl_resize_terminal</A> -<LI><A HREF="readline.html#IDX156">rl_restore_prompt</A> -<LI><A HREF="readline.html#IDX155">rl_save_prompt</A> -<LI><A HREF="readline.html#IDX125">rl_set_keymap</A> -<LI><A HREF="readline.html#IDX186">rl_set_signals</A> -<LI><A HREF="readline.html#IDX208">rl_special_prefixes</A> -<LI><A HREF="readline.html#IDX112">rl_startup_hook</A> -<LI><A HREF="readline.html#IDX163">rl_stuff_char</A> -<LI><A HREF="readline.html#IDX108">rl_terminal_name</A> -<LI><A HREF="readline.html#IDX133">rl_unbind_command_in_map</A> -<LI><A HREF="readline.html#IDX132">rl_unbind_function_in_map</A> -<LI><A HREF="readline.html#IDX130">rl_unbind_key</A> -<LI><A HREF="readline.html#IDX131">rl_unbind_key_in_map</A> +<LI><A HREF="readline.html#IDX137">rl_read_init_file</A> +<LI><A HREF="readline.html#IDX164">rl_read_key</A> +<LI><A HREF="readline.html#IDX110">rl_readline_name</A> +<LI><A HREF="readline.html#IDX151">rl_redisplay</A> +<LI><A HREF="readline.html#IDX117">rl_redisplay_function</A> +<LI><A HREF="readline.html#IDX187">rl_reset_after_signal</A> +<LI><A HREF="readline.html#IDX155">rl_reset_line_state</A> +<LI><A HREF="readline.html#IDX169">rl_reset_terminal</A> +<LI><A HREF="readline.html#IDX188">rl_resize_terminal</A> +<LI><A HREF="readline.html#IDX159">rl_restore_prompt</A> +<LI><A HREF="readline.html#IDX158">rl_save_prompt</A> +<LI><A HREF="readline.html#IDX126">rl_set_keymap</A> +<LI><A HREF="readline.html#IDX189">rl_set_signals</A> +<LI><A HREF="readline.html#IDX211">rl_special_prefixes</A> +<LI><A HREF="readline.html#IDX113">rl_startup_hook</A> +<LI><A HREF="readline.html#IDX166">rl_stuff_char</A> +<LI><A HREF="readline.html#IDX109">rl_terminal_name</A> +<LI><A HREF="readline.html#IDX134">rl_unbind_command_in_map</A> +<LI><A HREF="readline.html#IDX133">rl_unbind_function_in_map</A> +<LI><A HREF="readline.html#IDX131">rl_unbind_key</A> +<LI><A HREF="readline.html#IDX132">rl_unbind_key_in_map</A> </DIR> -<H2><A NAME="s">s</A></H2> +<H2><A NAME="findex_s">s</A></H2> <DIR> <LI><A HREF="readline.html#IDX52">self-insert (a, b, A, 1, !, ...)</A> <LI><A HREF="readline.html#IDX89">set-mark (C-@)</A> <LI><A HREF="readline.html#IDX24">show-all-if-ambiguous</A> <LI><A HREF="readline.html#IDX79">start-kbd-macro (C-x ()</A> </DIR> -<H2><A NAME="t">t</A></H2> +<H2><A NAME="findex_t">t</A></H2> <DIR> <LI><A HREF="readline.html#IDX51">tab-insert (M-TAB)</A> <LI><A HREF="readline.html#IDX88">tilde-expand (M-~)</A> -<LI><A HREF="readline.html#IDX175">to_lower</A> -<LI><A HREF="readline.html#IDX174">to_upper</A> +<LI><A HREF="readline.html#IDX178">to_lower</A> +<LI><A HREF="readline.html#IDX177">to_upper</A> <LI><A HREF="readline.html#IDX53">transpose-chars (C-t)</A> <LI><A HREF="readline.html#IDX54">transpose-words (M-t)</A> </DIR> -<H2><A NAME="u">u</A></H2> +<H2><A NAME="findex_u">u</A></H2> <DIR> <LI><A HREF="readline.html#IDX86">undo (C-_, C-x C-u)</A> <LI><A HREF="readline.html#IDX73">universal-argument ()</A> <LI><A HREF="readline.html#IDX60">unix-line-discard (C-u)</A> <LI><A HREF="readline.html#IDX64">unix-word-rubout (C-w)</A> <LI><A HREF="readline.html#IDX55">upcase-word (M-u)</A> -<LI><A HREF="readline.html#IDX171">uppercase_p</A> -<LI><A HREF="readline.html#IDX196">username_completion_function</A> +<LI><A HREF="readline.html#IDX174">uppercase_p</A> +<LI><A HREF="readline.html#IDX199">username_completion_function</A> </DIR> -<H2><A NAME="v">v</A></H2> +<H2><A NAME="findex_v">v</A></H2> <DIR> <LI><A HREF="readline.html#IDX25">visible-stats</A> </DIR> -<H2><A NAME="y">y</A></H2> +<H2><A NAME="findex_y">y</A></H2> <DIR> <LI><A HREF="readline.html#IDX70">yank (C-y)</A> <LI><A HREF="readline.html#IDX46">yank-last-arg (M-., M-_)</A> @@ -4223,7 +4320,7 @@ Jump to: </P> <P><HR><P> -This document was generated on 31 December 1998 using the +This document was generated on 1 March 2000 using the <A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A> translator version 1.52.</P> </BODY> |