| <HTML> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <!-- Created on June, 27 2002 by texi2html 1.64 --> |
| <!-- |
| Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author) |
| Karl Berry <karl@freefriends.org> |
| Olaf Bachmann <obachman@mathematik.uni-kl.de> |
| and many others. |
| Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de> |
| Send bugs and suggestions to <texi2html@mathematik.uni-kl.de> |
| |
| --> |
| <HEAD> |
| <TITLE>GNU Readline Library: </TITLE> |
| |
| <META NAME="description" CONTENT="GNU Readline Library: "> |
| <META NAME="keywords" CONTENT="GNU Readline Library: "> |
| <META NAME="resource-type" CONTENT="document"> |
| <META NAME="distribution" CONTENT="global"> |
| <META NAME="Generator" CONTENT="texi2html 1.64"> |
| |
| </HEAD> |
| |
| <BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000"> |
| |
| <A NAME="SEC_Top"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H1>GNU Readline Library</H1></P><P> |
| |
| This document describes the GNU Readline Library, a utility which aids |
| in the consistency of user interface across discrete programs that need |
| to provide a command line interface. |
| </P><P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC1">1. Command Line Editing</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">GNU Readline User's Manual.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC23">2. Programming with GNU Readline</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">GNU Readline Programmer's Manual.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC49">Concept Index</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Index of concepts described in this manual.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC50">Function and Variable Index</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Index of externally visible functions |
| and variables.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <HR SIZE=1> |
| <A NAME="SEC1"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC2"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <A NAME="Command Line Editing"></A> |
| <H1> 1. Command Line Editing </H1> |
| <!--docid::SEC1::--> |
| <P> |
| |
| This chapter describes the basic features of the GNU |
| command line editing interface. |
| </P><P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC2">1.1 Introduction to Line Editing</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Notation used in this text.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC3">1.2 Readline Interaction</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">The minimum set of commands for editing a line.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC9">1.3 Readline Init File</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Customizing Readline from a user's view.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC13">1.4 Bindable Readline Commands</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">A description of most of the Readline commands |
| available for binding</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC22">1.5 Readline vi Mode</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">A short description of how to make Readline |
| behave like the vi editor.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <A NAME="Introduction and Notation"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC2"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 1.1 Introduction to Line Editing </H2> |
| <!--docid::SEC2::--> |
| <P> |
| |
| The following paragraphs describe the notation used to represent |
| keystrokes. |
| </P><P> |
| |
| The text <KBD>C-k</KBD> is read as `Control-K' and describes the character |
| produced when the <KBD>k</KBD> key is pressed while the Control key |
| 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. |
| 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> |
| <EM>first</EM>, and then typing <KBD>k</KBD>. |
| Either process is known as <EM>metafying</EM> the <KBD>k</KBD> key. |
| </P><P> |
| |
| The text <KBD>M-C-k</KBD> is read as `Meta-Control-k' and describes the |
| character produced by <EM>metafying</EM> <KBD>C-k</KBD>. |
| </P><P> |
| |
| 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">1.3 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><P> |
| |
| <A NAME="Readline Interaction"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC3"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC2"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC4"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 1.2 Readline Interaction </H2> |
| <!--docid::SEC3::--> |
| <P> |
| |
| Often during an interactive session you type in a long line of text, |
| only to notice that the first word on the line is misspelled. The |
| Readline library gives you a set of commands for manipulating the text |
| as you type it in, allowing you to just fix your typo, and not forcing |
| you to retype the majority of the line. Using these editing commands, |
| you move the cursor to the place that needs correction, and delete or |
| insert the text of the corrections. Then, when you are satisfied with |
| the line, you simply press <KBD>RET</KBD>. You do not have to be at the |
| end of the line to press <KBD>RET</KBD>; the entire line is accepted |
| regardless of the location of the cursor within the line. |
| </P><P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC4">1.2.1 Readline Bare Essentials</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">The least you need to know about Readline.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC5">1.2.2 Readline Movement Commands</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Moving about the input line.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC6">1.2.3 Readline Killing Commands</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">How to delete text, and how to get it back!</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC7">1.2.4 Readline Arguments</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Giving numeric arguments to commands.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC8">1.2.5 Searching for Commands in the History</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Searching through previous lines.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <A NAME="Readline Bare Essentials"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC4"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC5"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.2.1 Readline Bare Essentials </H3> |
| <!--docid::SEC4::--> |
| <P> |
| |
| In order to enter characters into the line, simply type them. The typed |
| character appears where the cursor was, and then the cursor moves one |
| space to the right. If you mistype a character, you can use your |
| erase character to back up and delete the mistyped character. |
| </P><P> |
| |
| 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>. |
| </P><P> |
| |
| 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 bare |
| essentials for editing the text of an input line follows. |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><KBD>C-b</KBD> |
| <DD>Move back one character. |
| <DT><KBD>C-f</KBD> |
| <DD>Move forward one character. |
| <DT><KBD>DEL</KBD> or <KBD>Backspace</KBD> |
| <DD>Delete the character to the left of the cursor. |
| <DT><KBD>C-d</KBD> |
| <DD>Delete the character underneath the cursor. |
| <DT>Printing characters |
| <DD>Insert the character into the line at the cursor. |
| <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><P> |
| |
| <A NAME="Readline Movement Commands"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC5"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC4"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC6"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC6"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.2.2 Readline Movement Commands </H3> |
| <!--docid::SEC5::--> |
| <P> |
| |
| 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 |
| about the line. |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><KBD>C-a</KBD> |
| <DD>Move to the start of the line. |
| <DT><KBD>C-e</KBD> |
| <DD>Move to the end of the line. |
| <DT><KBD>M-f</KBD> |
| <DD>Move forward a word, where a word is composed of letters and digits. |
| <DT><KBD>M-b</KBD> |
| <DD>Move backward a word. |
| <DT><KBD>C-l</KBD> |
| <DD>Clear the screen, reprinting the current line at the top. |
| </DL> |
| <P> |
| |
| Notice how <KBD>C-f</KBD> moves forward a character, while <KBD>M-f</KBD> moves |
| forward a word. It is a loose convention that control keystrokes |
| operate on characters while meta keystrokes operate on words. |
| </P><P> |
| |
| <A NAME="Readline Killing Commands"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC6"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC5"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC7"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC7"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.2.3 Readline Killing Commands </H3> |
| <!--docid::SEC6::--> |
| <P> |
| |
| <A NAME="IDX1"></A> |
| <A NAME="IDX2"></A> |
| </P><P> |
| |
| <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. |
| </P><P> |
| |
| When you use a kill command, the text is saved in a <EM>kill-ring</EM>. |
| Any number of consecutive kills save all of the killed text together, so |
| that when you yank it back, you get it all. The kill |
| ring is not line specific; the text that you killed on a previously |
| typed line is available to be yanked back later, when you are typing |
| another line. |
| <A NAME="IDX3"></A> |
| </P><P> |
| |
| Here is the list of commands for killing text. |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><KBD>C-k</KBD> |
| <DD>Kill the text from the current cursor position to the end of the line. |
| <P> |
| |
| <DT><KBD>M-d</KBD> |
| <DD>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>. |
| <P> |
| |
| <DT><KBD>M-<KBD>DEL</KBD></KBD> |
| <DD>Kill from the cursor the start of the current word, or, if between |
| words, to the start of the previous word. |
| Word boundaries are the same as those used by <KBD>M-b</KBD>. |
| <P> |
| |
| <DT><KBD>C-w</KBD> |
| <DD>Kill from the cursor to the previous whitespace. This is different than |
| <KBD>M-<KBD>DEL</KBD></KBD> because the word boundaries differ. |
| <P> |
| |
| </DL> |
| <P> |
| |
| Here is how to <EM>yank</EM> the text back into the line. Yanking |
| means to copy the most-recently-killed text from the kill buffer. |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><KBD>C-y</KBD> |
| <DD>Yank the most recently killed text back into the buffer at the cursor. |
| <P> |
| |
| <DT><KBD>M-y</KBD> |
| <DD>Rotate the kill-ring, and yank the new top. You can only do this if |
| the prior command is <KBD>C-y</KBD> or <KBD>M-y</KBD>. |
| </DL> |
| <P> |
| |
| <A NAME="Readline Arguments"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC7"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC6"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC8"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC8"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.2.4 Readline Arguments </H3> |
| <!--docid::SEC7::--> |
| <P> |
| |
| You can pass numeric arguments to Readline commands. Sometimes the |
| argument acts as a repeat count, other times it is the <I>sign</I> of the |
| argument that is significant. If you pass a negative argument to a |
| command which normally acts in a forward direction, that command will |
| act in a backward direction. For example, to kill text back to the |
| start of the line, you might type <SAMP>`M-- C-k'</SAMP>. |
| </P><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 (<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>, |
| which will delete the next ten characters on the input line. |
| </P><P> |
| |
| <A NAME="Searching"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC8"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC7"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.2.5 Searching for Commands in the History </H3> |
| <!--docid::SEC8::--> |
| <P> |
| |
| Readline provides commands for searching through the command history |
| for lines containing a specified string. |
| There are two search modes: <EM>incremental</EM> and <EM>non-incremental</EM>. |
| </P><P> |
| |
| Incremental searches begin before the user has finished typing the |
| search string. |
| As each character of the search string is typed, Readline displays |
| the next entry from the history matching the string typed so far. |
| An incremental search requires only as many characters as needed to |
| find the desired history entry. |
| To search backward in the history for a particular string, type |
| <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. |
| </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 |
| the search and execute that command. |
| For instance, a <KBD>RET</KBD> will terminate the search and accept |
| the line, thereby executing the command from the history list. |
| A movement command will terminate the search, make the last line found |
| the current line, and begin editing. |
| </P><P> |
| |
| Readline remembers the last incremental search string. If two |
| <KBD>C-r</KBD>s are typed without any intervening characters defining a new |
| search string, any remembered search string is used. |
| </P><P> |
| |
| Non-incremental searches read the entire search string before starting |
| to search for matching history lines. The search string may be |
| typed by the user or be part of the contents of the current line. |
| </P><P> |
| |
| <A NAME="Readline Init File"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC9"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC8"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC10"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 1.3 Readline Init File </H2> |
| <!--docid::SEC9::--> |
| <P> |
| |
| 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, 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>. |
| </P><P> |
| |
| When a program which uses the Readline library starts up, the |
| init file is read, and the key bindings are set. |
| </P><P> |
| |
| In addition, the <CODE>C-x C-r</CODE> command re-reads this init file, thus |
| incorporating any changes that you might have made to it. |
| </P><P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Syntax for the commands in the inputrc file.</TD></TR> |
| </TABLE> |
| |
| <br> |
| <TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC11">1.3.2 Conditional Init Constructs</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Conditional key bindings in the inputrc file.</TD></TR> |
| </TABLE> |
| |
| <br> |
| <TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC12">1.3.3 Sample Init File</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">An example inputrc file.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <A NAME="Readline Init File Syntax"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC10"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC11"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.3.1 Readline Init File Syntax </H3> |
| <!--docid::SEC10::--> |
| <P> |
| |
| There are only a few basic constructs allowed in the |
| Readline init file. Blank lines are ignored. |
| Lines beginning with a <SAMP>`#'</SAMP> are comments. |
| Lines beginning with a <SAMP>`$'</SAMP> indicate conditional |
| constructs (see section <A HREF="readline.html#SEC11">1.3.2 Conditional Init Constructs</A>). Other lines |
| denote variable settings and key bindings. |
| </P><P> |
| |
| <DL COMPACT> |
| <DT>Variable Settings |
| <DD>You can modify the run-time behavior of Readline by |
| altering the values of variables in Readline |
| using the <CODE>set</CODE> command within the init file. |
| The syntax is simple: |
| <P> |
| |
| <TABLE><tr><td> </td><td class=example><pre>set <VAR>variable</VAR> <VAR>value</VAR> |
| </pre></td></tr></table></P><P> |
| |
| Here, for example, is how to |
| change from the default Emacs-like key binding to use |
| <CODE>vi</CODE> line editing commands: |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre>set editing-mode vi |
| </pre></td></tr></table></P><P> |
| |
| Variable names and values, where appropriate, are recognized without regard |
| to case. |
| </P><P> |
| |
| A great deal of run-time behavior is changeable with the following |
| variables. |
| </P><P> |
| |
| <A NAME="IDX4"></A> |
| <DL COMPACT> |
| |
| <DT><CODE>bell-style</CODE> |
| <DD><A NAME="IDX5"></A> |
| Controls what happens when Readline wants to ring the terminal bell. |
| If set to <SAMP>`none'</SAMP>, Readline never rings the bell. If set to |
| <SAMP>`visible'</SAMP>, Readline uses a visible bell if one is available. |
| If set to <SAMP>`audible'</SAMP> (the default), Readline attempts to ring |
| the terminal's bell. |
| <P> |
| |
| <DT><CODE>comment-begin</CODE> |
| <DD><A NAME="IDX6"></A> |
| The string to insert at the beginning of the line when the |
| <CODE>insert-comment</CODE> command is executed. The default value |
| is <CODE>"#"</CODE>. |
| <P> |
| |
| <DT><CODE>completion-ignore-case</CODE> |
| <DD>If set to <SAMP>`on'</SAMP>, Readline performs filename matching and completion |
| in a case-insensitive fashion. |
| The default value is <SAMP>`off'</SAMP>. |
| <P> |
| |
| <DT><CODE>completion-query-items</CODE> |
| <DD><A NAME="IDX7"></A> |
| The number of possible completions that determines when the user is |
| asked whether he wants to see the list of possibilities. If the |
| number of possible completions is greater than this value, |
| Readline will ask the user whether or not he wishes to view |
| them; otherwise, they are simply listed. |
| This variable must be set to an integer value greater than or equal to 0. |
| The default limit is <CODE>100</CODE>. |
| <P> |
| |
| <DT><CODE>convert-meta</CODE> |
| <DD><A NAME="IDX8"></A> |
| If set to <SAMP>`on'</SAMP>, Readline will convert characters with the |
| eighth bit set to an ASCII key sequence by stripping the eighth |
| bit and prefixing an <KBD>ESC</KBD> character, converting them to a |
| meta-prefixed key sequence. The default value is <SAMP>`on'</SAMP>. |
| <P> |
| |
| <DT><CODE>disable-completion</CODE> |
| <DD><A NAME="IDX9"></A> |
| If set to <SAMP>`On'</SAMP>, Readline will inhibit word completion. |
| Completion characters will be inserted into the line as if they had |
| been mapped to <CODE>self-insert</CODE>. The default is <SAMP>`off'</SAMP>. |
| <P> |
| |
| <DT><CODE>editing-mode</CODE> |
| <DD><A NAME="IDX10"></A> |
| The <CODE>editing-mode</CODE> variable controls which default set of |
| key bindings is used. By default, Readline starts up in Emacs editing |
| mode, where the keystrokes are most similar to Emacs. This variable can be |
| set to either <SAMP>`emacs'</SAMP> or <SAMP>`vi'</SAMP>. |
| <P> |
| |
| <DT><CODE>enable-keypad</CODE> |
| <DD><A NAME="IDX11"></A> |
| When set to <SAMP>`on'</SAMP>, Readline will try to enable the application |
| keypad when it is called. Some systems need this to enable the |
| arrow keys. The default is <SAMP>`off'</SAMP>. |
| <P> |
| |
| <DT><CODE>expand-tilde</CODE> |
| <DD><A NAME="IDX12"></A> |
| If set to <SAMP>`on'</SAMP>, tilde expansion is performed when Readline |
| attempts word completion. The default is <SAMP>`off'</SAMP>. |
| <P> |
| |
| <A NAME="IDX13"></A> |
| If set to <SAMP>`on'</SAMP>, the history code attempts to place point at the |
| same location on each history line retrived with <CODE>previous-history</CODE> |
| or <CODE>next-history</CODE>. |
| </P><P> |
| |
| <DT><CODE>horizontal-scroll-mode</CODE> |
| <DD><A NAME="IDX14"></A> |
| This variable can be set to either <SAMP>`on'</SAMP> or <SAMP>`off'</SAMP>. Setting it |
| to <SAMP>`on'</SAMP> means that the text of the lines being edited will scroll |
| horizontally on a single screen line when they are longer than the width |
| of the screen, instead of wrapping onto a new screen line. By default, |
| this variable is set to <SAMP>`off'</SAMP>. |
| <P> |
| |
| <DT><CODE>input-meta</CODE> |
| <DD><A NAME="IDX15"></A> |
| <A NAME="IDX16"></A> |
| If set to <SAMP>`on'</SAMP>, Readline will enable eight-bit input (it |
| will not clear the eighth bit in the characters it reads), |
| regardless of what the terminal claims it can support. The |
| default value is <SAMP>`off'</SAMP>. The name <CODE>meta-flag</CODE> is a |
| synonym for this variable. |
| <P> |
| |
| <DT><CODE>isearch-terminators</CODE> |
| <DD><A NAME="IDX17"></A> |
| The string of characters that should terminate an incremental search without |
| subsequently executing the character as a command (see section <A HREF="readline.html#SEC8">1.2.5 Searching for Commands in the History</A>). |
| If this variable has not been given a value, the characters <KBD>ESC</KBD> and |
| <KBD>C-J</KBD> will terminate an incremental search. |
| <P> |
| |
| <DT><CODE>keymap</CODE> |
| <DD><A NAME="IDX18"></A> |
| Sets Readline's idea of the current keymap for key binding commands. |
| Acceptable <CODE>keymap</CODE> names are |
| <CODE>emacs</CODE>, |
| <CODE>emacs-standard</CODE>, |
| <CODE>emacs-meta</CODE>, |
| <CODE>emacs-ctlx</CODE>, |
| <CODE>vi</CODE>, |
| <CODE>vi-move</CODE>, |
| <CODE>vi-command</CODE>, and |
| <CODE>vi-insert</CODE>. |
| <CODE>vi</CODE> is equivalent to <CODE>vi-command</CODE>; <CODE>emacs</CODE> is |
| equivalent to <CODE>emacs-standard</CODE>. The default value is <CODE>emacs</CODE>. |
| The value of the <CODE>editing-mode</CODE> variable also affects the |
| default keymap. |
| <P> |
| |
| <DT><CODE>mark-directories</CODE> |
| <DD>If set to <SAMP>`on'</SAMP>, completed directory names have a slash |
| appended. The default is <SAMP>`on'</SAMP>. |
| <P> |
| |
| <DT><CODE>mark-modified-lines</CODE> |
| <DD><A NAME="IDX19"></A> |
| This variable, when set to <SAMP>`on'</SAMP>, causes Readline to display an |
| asterisk (<SAMP>`*'</SAMP>) at the start of history lines which have been modified. |
| This variable is <SAMP>`off'</SAMP> by default. |
| <P> |
| |
| <DT><CODE>mark-symlinked-directories</CODE> |
| <DD><A NAME="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 |
| supplied by the user in the filename to be completed. |
| This variable is <SAMP>`on'</SAMP> by default. |
| <P> |
| |
| <DT><CODE>output-meta</CODE> |
| <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. |
| The default is <SAMP>`off'</SAMP>. |
| <P> |
| |
| <DT><CODE>show-all-if-ambiguous</CODE> |
| <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 |
| matches to be listed immediately instead of ringing the bell. |
| The default value is <SAMP>`off'</SAMP>. |
| <P> |
| |
| <DT><CODE>visible-stats</CODE> |
| <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>. |
| <P> |
| |
| </DL> |
| <P> |
| |
| <DT>Key Bindings |
| <DD>The syntax for controlling key bindings in the init file is |
| 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. |
| <P> |
| |
| Once you know the name of the command, simply place on a line |
| in the init file the name of the key |
| you wish to bind the command to, a colon, and then the name of the |
| command. The name of the key |
| can be expressed in different ways, depending on what you find most |
| comfortable. |
| </P><P> |
| |
| In addition to command names, readline allows keys to be bound |
| to a string that is inserted when the key is pressed (a <VAR>macro</VAR>). |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><VAR>keyname</VAR>: <VAR>function-name</VAR> or <VAR>macro</VAR> |
| <DD><VAR>keyname</VAR> is the name of a key spelled out in English. For example: |
| <TABLE><tr><td> </td><td class=example><pre>Control-u: universal-argument |
| Meta-Rubout: backward-kill-word |
| Control-o: "> output" |
| </pre></td></tr></table><P> |
| |
| In the above example, <KBD>C-u</KBD> is bound to the function |
| <CODE>universal-argument</CODE>, |
| <KBD>M-DEL</KBD> is bound to the function <CODE>backward-kill-word</CODE>, and |
| <KBD>C-o</KBD> is bound to run the macro |
| expressed on the right hand side (that is, to insert the text |
| <SAMP>`> output'</SAMP> into the line). |
| </P><P> |
| |
| A number of symbolic character names are recognized while |
| processing this key binding syntax: |
| <VAR>DEL</VAR>, |
| <VAR>ESC</VAR>, |
| <VAR>ESCAPE</VAR>, |
| <VAR>LFD</VAR>, |
| <VAR>NEWLINE</VAR>, |
| <VAR>RET</VAR>, |
| <VAR>RETURN</VAR>, |
| <VAR>RUBOUT</VAR>, |
| <VAR>SPACE</VAR>, |
| <VAR>SPC</VAR>, |
| and |
| <VAR>TAB</VAR>. |
| </P><P> |
| |
| <DT>"<VAR>keyseq</VAR>": <VAR>function-name</VAR> or <VAR>macro</VAR> |
| <DD><VAR>keyseq</VAR> differs from <VAR>keyname</VAR> above in that strings |
| denoting an entire key sequence can be specified, by placing |
| the key sequence in double quotes. Some GNU Emacs style key |
| escapes can be used, as in the following example, but the |
| special character names are not recognized. |
| <P> |
| |
| <TABLE><tr><td> </td><td class=example><pre>"\C-u": universal-argument |
| "\C-x\C-r": re-read-init-file |
| "\e[11~": "Function Key 1" |
| </pre></td></tr></table></P><P> |
| |
| In the above example, <KBD>C-u</KBD> is again bound to the function |
| <CODE>universal-argument</CODE> (just as it was in the first example), |
| <SAMP>`<KBD>C-x</KBD> <KBD>C-r</KBD>'</SAMP> is bound to the function <CODE>re-read-init-file</CODE>, |
| and <SAMP>`<KBD>ESC</KBD> <KBD>[</KBD> <KBD>1</KBD> <KBD>1</KBD> <KBD>~</KBD>'</SAMP> is bound to insert |
| the text <SAMP>`Function Key 1'</SAMP>. |
| </P><P> |
| |
| </DL> |
| <P> |
| |
| The following GNU Emacs style escape sequences are available when |
| specifying key sequences: |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><CODE><KBD>\C-</KBD></CODE> |
| <DD>control prefix |
| <DT><CODE><KBD>\M-</KBD></CODE> |
| <DD>meta prefix |
| <DT><CODE><KBD>\e</KBD></CODE> |
| <DD>an escape character |
| <DT><CODE><KBD>\\</KBD></CODE> |
| <DD>backslash |
| <DT><CODE><KBD>\"</KBD></CODE> |
| <DD><KBD>"</KBD>, a double quotation mark |
| <DT><CODE><KBD>\'</KBD></CODE> |
| <DD><KBD>'</KBD>, a single quote or apostrophe |
| </DL> |
| <P> |
| |
| In addition to the GNU Emacs style escape sequences, a second |
| set of backslash escapes is available: |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><CODE>\a</CODE> |
| <DD>alert (bell) |
| <DT><CODE>\b</CODE> |
| <DD>backspace |
| <DT><CODE>\d</CODE> |
| <DD>delete |
| <DT><CODE>\f</CODE> |
| <DD>form feed |
| <DT><CODE>\n</CODE> |
| <DD>newline |
| <DT><CODE>\r</CODE> |
| <DD>carriage return |
| <DT><CODE>\t</CODE> |
| <DD>horizontal tab |
| <DT><CODE>\v</CODE> |
| <DD>vertical tab |
| <DT><CODE>\<VAR>nnn</VAR></CODE> |
| <DD>the eight-bit character whose value is the octal value <VAR>nnn</VAR> |
| (one to three digits) |
| <DT><CODE>\x<VAR>HH</VAR></CODE> |
| <DD>the eight-bit character whose value is the hexadecimal value <VAR>HH</VAR> |
| (one or two hex digits) |
| </DL> |
| <P> |
| |
| When entering the text of a macro, single or double quotes must |
| be used to indicate a macro definition. |
| Unquoted text is assumed to be a function name. |
| In the macro body, the backslash escapes described above are expanded. |
| Backslash will quote any other character in the macro text, |
| including <SAMP>`"'</SAMP> and <SAMP>`''</SAMP>. |
| For example, the following binding will make <SAMP>`<KBD>C-x</KBD> \'</SAMP> |
| insert a single <SAMP>`\'</SAMP> into the line: |
| <TABLE><tr><td> </td><td class=example><pre>"\C-x\\": "\\" |
| </pre></td></tr></table></P><P> |
| |
| </DL> |
| <P> |
| |
| <A NAME="Conditional Init Constructs"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC11"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC10"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC12"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC12"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.3.2 Conditional Init Constructs </H3> |
| <!--docid::SEC11::--> |
| <P> |
| |
| Readline implements a facility similar in spirit to the conditional |
| compilation features of the C preprocessor which allows key |
| bindings and variable settings to be performed as the result |
| of tests. There are four parser directives used. |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><CODE>$if</CODE> |
| <DD>The <CODE>$if</CODE> construct allows bindings to be made based on the |
| editing mode, the terminal being used, or the application using |
| Readline. The text of the test extends to the end of the line; |
| no characters are required to isolate it. |
| <P> |
| |
| <DL COMPACT> |
| <DT><CODE>mode</CODE> |
| <DD>The <CODE>mode=</CODE> form of the <CODE>$if</CODE> directive is used to test |
| whether Readline is in <CODE>emacs</CODE> or <CODE>vi</CODE> mode. |
| This may be used in conjunction |
| with the <SAMP>`set keymap'</SAMP> command, for instance, to set bindings in |
| the <CODE>emacs-standard</CODE> and <CODE>emacs-ctlx</CODE> keymaps only if |
| Readline is starting out in <CODE>emacs</CODE> mode. |
| <P> |
| |
| <DT><CODE>term</CODE> |
| <DD>The <CODE>term=</CODE> form may be used to include terminal-specific |
| key bindings, perhaps to bind the key sequences output by the |
| terminal's function keys. The word on the right side of the |
| <SAMP>`='</SAMP> is tested against both the full name of the terminal and |
| the portion of the terminal name before the first <SAMP>`-'</SAMP>. This |
| allows <CODE>sun</CODE> to match both <CODE>sun</CODE> and <CODE>sun-cmd</CODE>, |
| for instance. |
| <P> |
| |
| <DT><CODE>application</CODE> |
| <DD>The <VAR>application</VAR> construct is used to include |
| application-specific settings. Each program using the Readline |
| library sets the <VAR>application name</VAR>, and you can test for |
| a particular value. |
| This could be used to bind key sequences to functions useful for |
| a specific program. For instance, the following command adds a |
| key sequence that quotes the current or previous word in Bash: |
| <TABLE><tr><td> </td><td class=example><pre>$if Bash |
| # Quote the current or previous word |
| "\C-xq": "\eb\"\ef\"" |
| $endif |
| </pre></td></tr></table></DL> |
| <P> |
| |
| <DT><CODE>$endif</CODE> |
| <DD>This command, as seen in the previous example, terminates an |
| <CODE>$if</CODE> command. |
| <P> |
| |
| <DT><CODE>$else</CODE> |
| <DD>Commands in this branch of the <CODE>$if</CODE> directive are executed if |
| the test fails. |
| <P> |
| |
| <DT><CODE>$include</CODE> |
| <DD>This directive takes a single filename as an argument and reads commands |
| and bindings from that file. |
| For example, the following directive reads from <TT>`/etc/inputrc'</TT>: |
| <TABLE><tr><td> </td><td class=example><pre>$include /etc/inputrc |
| </pre></td></tr></table></DL> |
| <P> |
| |
| <A NAME="Sample Init File"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC12"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC11"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.3.3 Sample Init File </H3> |
| <!--docid::SEC12::--> |
| <P> |
| |
| Here is an example of an <VAR>inputrc</VAR> file. This illustrates key |
| binding, variable assignment, and conditional syntax. |
| </P><P> |
| |
| <TABLE><tr><td> </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. |
| # |
| # 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 |
| $include /etc/Inputrc |
| |
| # |
| # Set various bindings for emacs mode. |
| |
| set editing-mode emacs |
| |
| $if mode=emacs |
| |
| Meta-Control-h: backward-kill-word Text after the function name is ignored |
| |
| # |
| # Arrow keys in keypad mode |
| # |
| #"\M-OD": backward-char |
| #"\M-OC": forward-char |
| #"\M-OA": previous-history |
| #"\M-OB": next-history |
| # |
| # Arrow keys in ANSI mode |
| # |
| "\M-[D": backward-char |
| "\M-[C": forward-char |
| "\M-[A": previous-history |
| "\M-[B": next-history |
| # |
| # Arrow keys in 8 bit keypad mode |
| # |
| #"\M-\C-OD": backward-char |
| #"\M-\C-OC": forward-char |
| #"\M-\C-OA": previous-history |
| #"\M-\C-OB": next-history |
| # |
| # Arrow keys in 8 bit ANSI mode |
| # |
| #"\M-\C-[D": backward-char |
| #"\M-\C-[C": forward-char |
| #"\M-\C-[A": previous-history |
| #"\M-\C-[B": next-history |
| |
| C-q: quoted-insert |
| |
| $endif |
| |
| # An old-style binding. This happens to be the default. |
| TAB: complete |
| |
| # Macros that are convenient for shell interaction |
| $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 |
| # and move to just after the open quote |
| "\C-x\"": "\"\"\C-b" |
| # insert a backslash (testing backslash escapes |
| # in sequences and macros) |
| "\C-x\\": "\\" |
| # Quote the current or previous word |
| "\C-xq": "\eb\"\ef\"" |
| # Add a binding to refresh the line, which is unbound |
| "\C-xr": redraw-current-line |
| # Edit variable on current line. |
| "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y=" |
| $endif |
| |
| # use a visible bell if one is available |
| 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 |
| set convert-meta off |
| |
| # 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 |
| set completion-query-items 150 |
| |
| # For FTP |
| $if Ftp |
| "\C-xg": "get \M-?" |
| "\C-xt": "put \M-?" |
| "\M-.": yank-last-arg |
| $endif |
| </pre></td></tr></table></P><P> |
| |
| <A NAME="Bindable Readline Commands"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC13"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC12"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC14"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 1.4 Bindable Readline Commands </H2> |
| <!--docid::SEC13::--> |
| <P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Moving about the line.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Getting at previous lines.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Commands for changing text.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Commands for killing and yanking.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Specifying numeric arguments, repeat counts.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Getting Readline to do the typing for you.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Saving and re-executing typed characters</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Other miscellaneous commands.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| This section describes Readline commands that may be bound to key |
| sequences. |
| Command names without an accompanying key sequence are unbound by default. |
| </P><P> |
| |
| In the following descriptions, <EM>point</EM> refers to the current cursor |
| position, and <EM>mark</EM> refers to a cursor position saved by the |
| <CODE>set-mark</CODE> command. |
| The text between the point and mark is referred to as the <EM>region</EM>. |
| </P><P> |
| |
| <A NAME="Commands For Moving"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC14"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC15"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.1 Commands For Moving </H3> |
| <!--docid::SEC14::--> |
| <DL COMPACT> |
| <A NAME="IDX26"></A> |
| <DT><CODE>beginning-of-line (C-a)</CODE> |
| <DD><A NAME="IDX27"></A> |
| Move to the start of the current line. |
| <P> |
| |
| <A NAME="IDX28"></A> |
| <DT><CODE>end-of-line (C-e)</CODE> |
| <DD><A NAME="IDX29"></A> |
| Move to the end of the line. |
| <P> |
| |
| <A NAME="IDX30"></A> |
| <DT><CODE>forward-char (C-f)</CODE> |
| <DD><A NAME="IDX31"></A> |
| Move forward a character. |
| <P> |
| |
| <A NAME="IDX32"></A> |
| <DT><CODE>backward-char (C-b)</CODE> |
| <DD><A NAME="IDX33"></A> |
| Move back a character. |
| <P> |
| |
| <A NAME="IDX34"></A> |
| <DT><CODE>forward-word (M-f)</CODE> |
| <DD><A NAME="IDX35"></A> |
| Move forward to the end of the next word. Words are composed of |
| letters and digits. |
| <P> |
| |
| <A NAME="IDX36"></A> |
| <DT><CODE>backward-word (M-b)</CODE> |
| <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="IDX38"></A> |
| <DT><CODE>clear-screen (C-l)</CODE> |
| <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="IDX40"></A> |
| <DT><CODE>redraw-current-line ()</CODE> |
| <DD><A NAME="IDX41"></A> |
| Refresh the current line. By default, this is unbound. |
| <P> |
| |
| </DL> |
| <P> |
| |
| <A NAME="Commands For History"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC15"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC14"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC16"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC16"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.2 Commands For Manipulating The History </H3> |
| <!--docid::SEC15::--> |
| <P> |
| |
| <DL COMPACT> |
| <A NAME="IDX42"></A> |
| <DT><CODE>accept-line (Newline or Return)</CODE> |
| <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 |
| <CODE>add_history()</CODE>. |
| If this line is a modified history line, the history line is restored |
| to its original state. |
| <P> |
| |
| <A NAME="IDX44"></A> |
| <DT><CODE>previous-history (C-p)</CODE> |
| <DD><A NAME="IDX45"></A> |
| Move `back' through the history list, fetching the previous command. |
| <P> |
| |
| <A NAME="IDX46"></A> |
| <DT><CODE>next-history (C-n)</CODE> |
| <DD><A NAME="IDX47"></A> |
| Move `forward' through the history list, fetching the next command. |
| <P> |
| |
| <A NAME="IDX48"></A> |
| <DT><CODE>beginning-of-history (M-<)</CODE> |
| <DD><A NAME="IDX49"></A> |
| Move to the first line in the history. |
| <P> |
| |
| <A NAME="IDX50"></A> |
| <DT><CODE>end-of-history (M->)</CODE> |
| <DD><A NAME="IDX51"></A> |
| Move to the end of the input history, i.e., the line currently |
| being entered. |
| <P> |
| |
| <A NAME="IDX52"></A> |
| <DT><CODE>reverse-search-history (C-r)</CODE> |
| <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="IDX54"></A> |
| <DT><CODE>forward-search-history (C-s)</CODE> |
| <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="IDX56"></A> |
| <DT><CODE>non-incremental-reverse-search-history (M-p)</CODE> |
| <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="IDX58"></A> |
| <DT><CODE>non-incremental-forward-search-history (M-n)</CODE> |
| <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="IDX60"></A> |
| <DT><CODE>history-search-forward ()</CODE> |
| <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="IDX62"></A> |
| <DT><CODE>history-search-backward ()</CODE> |
| <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="IDX64"></A> |
| <DT><CODE>yank-nth-arg (M-C-y)</CODE> |
| <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>, |
| insert the <VAR>n</VAR>th word from the previous command (the words |
| in the previous command begin with word 0). A negative argument |
| inserts the <VAR>n</VAR>th word from the end of the previous command. |
| <P> |
| |
| <A NAME="IDX66"></A> |
| <DT><CODE>yank-last-arg (M-. or M-_)</CODE> |
| <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>. |
| Successive calls to <CODE>yank-last-arg</CODE> move back through the history |
| list, inserting the last argument of each line in turn. |
| <P> |
| |
| </DL> |
| <P> |
| |
| <A NAME="Commands For Text"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC16"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC15"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC17"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC17"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.3 Commands For Changing Text </H3> |
| <!--docid::SEC16::--> |
| <P> |
| |
| <DL COMPACT> |
| <A NAME="IDX68"></A> |
| <DT><CODE>delete-char (C-d)</CODE> |
| <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="IDX70"></A> |
| <DT><CODE>backward-delete-char (Rubout)</CODE> |
| <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="IDX72"></A> |
| <DT><CODE>forward-backward-delete-char ()</CODE> |
| <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="IDX74"></A> |
| <DT><CODE>quoted-insert (C-q or C-v)</CODE> |
| <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="IDX76"></A> |
| <DT><CODE>tab-insert (M-<KBD>TAB</KBD>)</CODE> |
| <DD><A NAME="IDX77"></A> |
| Insert a tab character. |
| <P> |
| |
| <A NAME="IDX78"></A> |
| <DT><CODE>self-insert (a, b, A, 1, !, <small>...</small>)</CODE> |
| <DD><A NAME="IDX79"></A> |
| Insert yourself. |
| <P> |
| |
| <A NAME="IDX80"></A> |
| <DT><CODE>transpose-chars (C-t)</CODE> |
| <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 |
| is at the end of the line, then this |
| transposes the last two characters of the line. |
| Negative arguments have no effect. |
| <P> |
| |
| <A NAME="IDX82"></A> |
| <DT><CODE>transpose-words (M-t)</CODE> |
| <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="IDX84"></A> |
| <DT><CODE>upcase-word (M-u)</CODE> |
| <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="IDX86"></A> |
| <DT><CODE>downcase-word (M-l)</CODE> |
| <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="IDX88"></A> |
| <DT><CODE>capitalize-word (M-c)</CODE> |
| <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> |
| |
| <A NAME="Commands For Killing"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC17"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC16"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC18"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC18"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.4 Killing And Yanking </H3> |
| <!--docid::SEC17::--> |
| <P> |
| |
| <DL COMPACT> |
| |
| <A NAME="IDX92"></A> |
| <DT><CODE>kill-line (C-k)</CODE> |
| <DD><A NAME="IDX93"></A> |
| Kill the text from point to the end of the line. |
| <P> |
| |
| <A NAME="IDX94"></A> |
| <DT><CODE>backward-kill-line (C-x Rubout)</CODE> |
| <DD><A NAME="IDX95"></A> |
| Kill backward to the beginning of the line. |
| <P> |
| |
| <A NAME="IDX96"></A> |
| <DT><CODE>unix-line-discard (C-u)</CODE> |
| <DD><A NAME="IDX97"></A> |
| Kill backward from the cursor to the beginning of the current line. |
| <P> |
| |
| <A NAME="IDX98"></A> |
| <DT><CODE>kill-whole-line ()</CODE> |
| <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="IDX100"></A> |
| <DT><CODE>kill-word (M-d)</CODE> |
| <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="IDX102"></A> |
| <DT><CODE>backward-kill-word (M-<KBD>DEL</KBD>)</CODE> |
| <DD><A NAME="IDX103"></A> |
| Kill the word behind point. |
| Word boundaries are the same as <CODE>backward-word</CODE>. |
| <P> |
| |
| <A NAME="IDX104"></A> |
| <DT><CODE>unix-word-rubout (C-w)</CODE> |
| <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="IDX106"></A> |
| <DT><CODE>delete-horizontal-space ()</CODE> |
| <DD><A NAME="IDX107"></A> |
| Delete all spaces and tabs around point. By default, this is unbound. |
| <P> |
| |
| <A NAME="IDX108"></A> |
| <DT><CODE>kill-region ()</CODE> |
| <DD><A NAME="IDX109"></A> |
| Kill the text in the current region. |
| By default, this command is unbound. |
| <P> |
| |
| <A NAME="IDX110"></A> |
| <DT><CODE>copy-region-as-kill ()</CODE> |
| <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="IDX112"></A> |
| <DT><CODE>copy-backward-word ()</CODE> |
| <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="IDX114"></A> |
| <DT><CODE>copy-forward-word ()</CODE> |
| <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="IDX116"></A> |
| <DT><CODE>yank (C-y)</CODE> |
| <DD><A NAME="IDX117"></A> |
| Yank the top of the kill ring into the buffer at point. |
| <P> |
| |
| <A NAME="IDX118"></A> |
| <DT><CODE>yank-pop (M-y)</CODE> |
| <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> |
| <P> |
| |
| <A NAME="Numeric Arguments"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC18"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC17"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC19"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC19"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.5 Specifying Numeric Arguments </H3> |
| <!--docid::SEC18::--> |
| <DL COMPACT> |
| |
| <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="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="IDX122"></A> |
| <DT><CODE>universal-argument ()</CODE> |
| <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. |
| If the command is followed by digits, executing <CODE>universal-argument</CODE> |
| again ends the numeric argument, but is otherwise ignored. |
| As a special case, if this command is immediately followed by a |
| character that is neither a digit or minus sign, the argument count |
| for the next command is multiplied by four. |
| The argument count is initially one, so executing this function the |
| first time makes the argument count four, a second time makes the |
| argument count sixteen, and so on. |
| By default, this is not bound to a key. |
| </DL> |
| <P> |
| |
| <A NAME="Commands For Completion"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC19"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC18"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC20"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC20"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.6 Letting Readline Type For You </H3> |
| <!--docid::SEC19::--> |
| <P> |
| |
| <DL COMPACT> |
| <A NAME="IDX124"></A> |
| <DT><CODE>complete (<KBD>TAB</KBD>)</CODE> |
| <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="IDX126"></A> |
| <DT><CODE>possible-completions (M-?)</CODE> |
| <DD><A NAME="IDX127"></A> |
| List the possible completions of the text before point. |
| <P> |
| |
| <A NAME="IDX128"></A> |
| <DT><CODE>insert-completions (M-*)</CODE> |
| <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="IDX130"></A> |
| <DT><CODE>menu-complete ()</CODE> |
| <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 |
| of possible completions, inserting each match in turn. |
| At the end of the list of completions, the bell is rung |
| (subject to the setting of <CODE>bell-style</CODE>) |
| and the original text is restored. |
| An argument of <VAR>n</VAR> moves <VAR>n</VAR> positions forward in the list |
| of matches; a negative argument may be used to move backward |
| through the list. |
| This command is intended to be bound to <KBD>TAB</KBD>, but is unbound |
| by default. |
| <P> |
| |
| <A NAME="IDX132"></A> |
| <DT><CODE>delete-char-or-list ()</CODE> |
| <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 |
| <CODE>possible-completions</CODE>. |
| This command is unbound by default. |
| <P> |
| |
| </DL> |
| <P> |
| |
| <A NAME="Keyboard Macros"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC20"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC19"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC21"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC21"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.7 Keyboard Macros </H3> |
| <!--docid::SEC20::--> |
| <DL COMPACT> |
| |
| <A NAME="IDX134"></A> |
| <DT><CODE>start-kbd-macro (C-x ()</CODE> |
| <DD><A NAME="IDX135"></A> |
| Begin saving the characters typed into the current keyboard macro. |
| <P> |
| |
| <A NAME="IDX136"></A> |
| <DT><CODE>end-kbd-macro (C-x ))</CODE> |
| <DD><A NAME="IDX137"></A> |
| Stop saving the characters typed into the current keyboard macro |
| and save the definition. |
| <P> |
| |
| <A NAME="IDX138"></A> |
| <DT><CODE>call-last-kbd-macro (C-x e)</CODE> |
| <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> |
| |
| </DL> |
| <P> |
| |
| <A NAME="Miscellaneous Commands"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC21"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC20"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 1.4.8 Some Miscellaneous Commands </H3> |
| <!--docid::SEC21::--> |
| <DL COMPACT> |
| |
| <A NAME="IDX140"></A> |
| <DT><CODE>re-read-init-file (C-x C-r)</CODE> |
| <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="IDX142"></A> |
| <DT><CODE>abort (C-g)</CODE> |
| <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="IDX144"></A> |
| <DT><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, <small>...</small>)</CODE> |
| <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="IDX146"></A> |
| <DT><CODE>prefix-meta (<KBD>ESC</KBD>)</CODE> |
| <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="IDX148"></A> |
| <DT><CODE>undo (C-_ or C-x C-u)</CODE> |
| <DD><A NAME="IDX149"></A> |
| Incremental undo, separately remembered for each line. |
| <P> |
| |
| <A NAME="IDX150"></A> |
| <DT><CODE>revert-line (M-r)</CODE> |
| <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="IDX152"></A> |
| <DT><CODE>tilde-expand (M-~)</CODE> |
| <DD><A NAME="IDX153"></A> |
| Perform tilde expansion on the current word. |
| <P> |
| |
| <A NAME="IDX154"></A> |
| <DT><CODE>set-mark (C-@)</CODE> |
| <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="IDX156"></A> |
| <DT><CODE>exchange-point-and-mark (C-x C-x)</CODE> |
| <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="IDX158"></A> |
| <DT><CODE>character-search (C-])</CODE> |
| <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="IDX160"></A> |
| <DT><CODE>character-search-backward (M-C-])</CODE> |
| <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="IDX162"></A> |
| <DT><CODE>insert-comment (M-#)</CODE> |
| <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="IDX164"></A> |
| <DT><CODE>dump-functions ()</CODE> |
| <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="IDX166"></A> |
| <DT><CODE>dump-variables ()</CODE> |
| <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="IDX168"></A> |
| <DT><CODE>dump-macros ()</CODE> |
| <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> |
| |
| <A NAME="Readline vi Mode"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC22"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC21"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 1.5 Readline vi Mode </H2> |
| <!--docid::SEC22::--> |
| <P> |
| |
| While the Readline library does not have a full set of <CODE>vi</CODE> |
| editing functions, it does contain enough to allow simple editing |
| of the line. The Readline <CODE>vi</CODE> mode behaves as specified in |
| the POSIX 1003.2 standard. |
| </P><P> |
| |
| In order to switch interactively between <CODE>emacs</CODE> and <CODE>vi</CODE> |
| editing modes, use the command <KBD>M-C-j</KBD> (bound to emacs-editing-mode |
| when in <CODE>vi</CODE> mode and to vi-editing-mode in <CODE>emacs</CODE> mode). |
| The Readline default is <CODE>emacs</CODE> mode. |
| </P><P> |
| |
| When you enter a line in <CODE>vi</CODE> mode, you are already placed in |
| `insertion' mode, as if you had typed an <SAMP>`i'</SAMP>. Pressing <KBD>ESC</KBD> |
| switches you into `command' mode, where you can edit the text of the |
| line with the standard <CODE>vi</CODE> movement keys, move to previous |
| history lines with <SAMP>`k'</SAMP> and subsequent lines with <SAMP>`j'</SAMP>, and |
| so forth. |
| </P><P> |
| |
| This document describes the GNU Readline Library, a utility for aiding |
| in the consitency of user interface across discrete programs that need |
| to provide a command line interface. |
| </P><P> |
| |
| Copyright (C) 1988-2002 Free Software Foundation, Inc. |
| </P><P> |
| |
| Permission is granted to make and distribute verbatim copies of |
| this manual provided the copyright notice and this permission notice |
| pare preserved on all copies. |
| </P><P> |
| |
| Permission is granted to copy and distribute modified versions of this |
| manual under the conditions for verbatim copying, provided that the entire |
| resulting derived work is distributed under the terms of a permission |
| notice identical to this one. |
| </P><P> |
| |
| Permission is granted to copy and distribute translations of this manual |
| into another language, under the above conditions for modified versions, |
| except that this permission notice may be stated in a translation approved |
| by the Foundation. |
| </P><P> |
| |
| <A NAME="Programming with GNU Readline"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC23"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC24"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H1> 2. Programming with GNU Readline </H1> |
| <!--docid::SEC23::--> |
| <P> |
| |
| This chapter describes the interface between the GNU Readline Library and |
| other programs. If you are a programmer, and you wish to include the |
| features found in GNU Readline |
| such as completion, line editing, and interactive history manipulation |
| in your own programs, this section is for you. |
| </P><P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC24">2.1 Basic Behavior</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Using the default behavior of Readline.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC25">2.2 Custom Functions</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Adding your own functions to Readline.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Variables accessible to custom |
| functions.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC29">2.4 Readline Convenience Functions</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions which Readline supplies to |
| aid in writing your own custom |
| functions.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">How Readline behaves when it receives signals.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC44">2.6 Custom Completers</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Supplanting or supplementing Readline's |
| completion functions.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <A NAME="Basic Behavior"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC24"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 2.1 Basic Behavior </H2> |
| <!--docid::SEC24::--> |
| <P> |
| |
| Many programs provide a command line interface, such as <CODE>mail</CODE>, |
| <CODE>ftp</CODE>, and <CODE>sh</CODE>. For such programs, the default behaviour of |
| Readline is sufficient. This section describes how to use Readline in |
| the simplest way possible, perhaps to replace calls in your code to |
| <CODE>gets()</CODE> or <CODE>fgets()</CODE>. |
| </P><P> |
| |
| <A NAME="IDX174"></A> |
| <A NAME="IDX175"></A> |
| </P><P> |
| |
| The function <CODE>readline()</CODE> prints a prompt <VAR>prompt</VAR> |
| and then reads and returns a single line of text from the user. |
| If <VAR>prompt</VAR> is <CODE>NULL</CODE> or the empty string, no prompt is displayed. |
| The line <CODE>readline</CODE> returns is allocated with <CODE>malloc()</CODE>; |
| the caller should <CODE>free()</CODE> the line when it has finished with it. |
| The declaration for <CODE>readline</CODE> in ANSI C is |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre><CODE>char *readline (const char *<VAR>prompt</VAR>);</CODE> |
| </pre></td></tr></table></P><P> |
| |
| So, one might say |
| <TABLE><tr><td> </td><td class=example><pre><CODE>char *line = readline ("Enter a line: ");</CODE> |
| </pre></td></tr></table>in order to read a line of text from the user. |
| The line returned has the final newline removed, so only the |
| text remains. |
| </P><P> |
| |
| If <CODE>readline</CODE> encounters an <CODE>EOF</CODE> while reading the line, and the |
| line is empty at that point, then <CODE>(char *)NULL</CODE> is returned. |
| Otherwise, the line is ended just as if a newline had been typed. |
| </P><P> |
| |
| If you want the user to be able to get at the line later, (with |
| <KBD>C-p</KBD> for example), you must call <CODE>add_history()</CODE> to save the |
| line away in a <EM>history</EM> list of such lines. |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre><CODE>add_history (line)</CODE>; |
| </pre></td></tr></table></P><P> |
| |
| For full details on the GNU History Library, see the associated manual. |
| </P><P> |
| |
| It is preferable to avoid saving empty lines on the history list, since |
| users rarely have a burning need to reuse a blank line. Here is |
| a function which usefully replaces the standard <CODE>gets()</CODE> library |
| function, and has the advantage of no static buffer to overflow: |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre>/* A static variable for holding the line. */ |
| static char *line_read = (char *)NULL; |
| |
| /* Read a string, and return a pointer to it. |
| Returns NULL on EOF. */ |
| char * |
| rl_gets () |
| { |
| /* If the buffer has already been allocated, |
| return the memory to the free pool. */ |
| if (line_read) |
| { |
| free (line_read); |
| line_read = (char *)NULL; |
| } |
| |
| /* Get a line from the user. */ |
| line_read = readline (""); |
| |
| /* If the line has any text in it, |
| save it on the history. */ |
| if (line_read && *line_read) |
| add_history (line_read); |
| |
| return (line_read); |
| } |
| </pre></td></tr></table></P><P> |
| |
| This function gives the user the default behaviour of <KBD>TAB</KBD> |
| completion: completion on file names. If you do not want Readline to |
| complete on filenames, you can change the binding of the <KBD>TAB</KBD> key |
| with <CODE>rl_bind_key()</CODE>. |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre><CODE>int rl_bind_key (int <VAR>key</VAR>, rl_command_func_t *<VAR>function</VAR>);</CODE> |
| </pre></td></tr></table></P><P> |
| |
| <CODE>rl_bind_key()</CODE> takes two arguments: <VAR>key</VAR> is the character that |
| you want to bind, and <VAR>function</VAR> is the address of the function to |
| call when <VAR>key</VAR> is pressed. Binding <KBD>TAB</KBD> to <CODE>rl_insert()</CODE> |
| makes <KBD>TAB</KBD> insert itself. |
| <CODE>rl_bind_key()</CODE> returns non-zero if <VAR>key</VAR> is not a valid |
| ASCII character code (between 0 and 255). |
| </P><P> |
| |
| Thus, to disable the default <KBD>TAB</KBD> behavior, the following suffices: |
| <TABLE><tr><td> </td><td class=example><pre><CODE>rl_bind_key ('\t', rl_insert);</CODE> |
| </pre></td></tr></table></P><P> |
| |
| This code should be executed once at the start of your program; you |
| might write a function called <CODE>initialize_readline()</CODE> which |
| performs this and other desired initializations, such as installing |
| custom completers (see section <A HREF="readline.html#SEC44">2.6 Custom Completers</A>). |
| </P><P> |
| |
| <A NAME="Custom Functions"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC25"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC24"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC26"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 2.2 Custom Functions </H2> |
| <!--docid::SEC25::--> |
| <P> |
| |
| Readline provides many functions for manipulating the text of |
| the line, but it isn't possible to anticipate the needs of all |
| programs. This section describes the various functions and variables |
| 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><P> |
| |
| <CODE>readline.h</CODE> defines a C preprocessor variable that should |
| be treated as an integer, <CODE>RL_READLINE_VERSION</CODE>, which may |
| be used to conditionally compile application code depending on |
| the installed Readline version. The value is a hexadecimal |
| encoding of the major and minor version numbers of the library, |
| of the form 0x<VAR>MMmm</VAR>. <VAR>MM</VAR> is the two-digit major |
| version number; <VAR>mm</VAR> is the two-digit minor version number. |
| For Readline 4.2, for example, the value of |
| <CODE>RL_READLINE_VERSION</CODE> would be <CODE>0x0402</CODE>. |
| </P><P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC26">2.2.1 Readline Typedefs</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">C declarations to make code readable.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC27">2.2.2 Writing a New Function</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Variables and calling conventions.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <A NAME="Readline Typedefs"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC26"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC27"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.2.1 Readline Typedefs </H3> |
| <!--docid::SEC26::--> |
| <P> |
| |
| For readabilty, we declare a number of new object types, all pointers |
| to functions. |
| </P><P> |
| |
| The reason for declaring these new types is to make it easier to write |
| code describing pointers to C functions with appropriately prototyped |
| arguments and return values. |
| </P><P> |
| |
| For instance, say we want to declare a variable <VAR>func</VAR> as a pointer |
| to a function which takes two <CODE>int</CODE> arguments and returns an |
| <CODE>int</CODE> (this is the type of all of the Readline bindable functions). |
| Instead of the classic C declaration |
| </P><P> |
| |
| <CODE>int (*func)();</CODE> |
| </P><P> |
| |
| or the ANSI-C style declaration |
| </P><P> |
| |
| <CODE>int (*func)(int, int);</CODE> |
| </P><P> |
| |
| we may write |
| </P><P> |
| |
| <CODE>rl_command_func_t *func;</CODE> |
| </P><P> |
| |
| The full list of function pointer types available is |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><CODE>typedef int rl_command_func_t (int, int);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef char *rl_compentry_func_t (const char *, int);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef char **rl_completion_func_t (const char *, int, int);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef char *rl_quote_func_t (char *, int, char *);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef char *rl_dequote_func_t (char *, int);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef int rl_compignore_func_t (char **);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef void rl_compdisp_func_t (char **, int, int);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef int rl_hook_func_t (void);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef int rl_getc_func_t (FILE *);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef int rl_linebuf_func_t (char *, int);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef int rl_intfunc_t (int);</CODE> |
| <DD><DT><CODE>#define rl_ivoidfunc_t rl_hook_func_t</CODE> |
| <DD><DT><CODE>typedef int rl_icpfunc_t (char *);</CODE> |
| <DD><DT><CODE>typedef int rl_icppfunc_t (char **);</CODE> |
| <DD><P> |
| |
| <DT><CODE>typedef void rl_voidfunc_t (void);</CODE> |
| <DD><DT><CODE>typedef void rl_vintfunc_t (int);</CODE> |
| <DD><DT><CODE>typedef void rl_vcpfunc_t (char *);</CODE> |
| <DD><DT><CODE>typedef void rl_vcppfunc_t (char **);</CODE> |
| <DD><P> |
| |
| </DL> |
| <P> |
| |
| <A NAME="Function Writing"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC27"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC26"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.2.2 Writing a New Function </H3> |
| <!--docid::SEC27::--> |
| <P> |
| |
| In order to write new functions for Readline, you need to know the |
| calling conventions for keyboard-invoked functions, and the names of the |
| variables that describe the current state of the line read so far. |
| </P><P> |
| |
| The calling sequence for a command <CODE>foo</CODE> looks like |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre><CODE>int foo (int count, int key)</CODE> |
| </pre></td></tr></table></P><P> |
| |
| where <VAR>count</VAR> is the numeric argument (or 1 if defaulted) and |
| <VAR>key</VAR> is the key that invoked this function. |
| </P><P> |
| |
| It is completely up to the function as to what should be done with the |
| numeric argument. Some functions use it as a repeat count, some |
| as a flag, and others to choose alternate behavior (refreshing the current |
| line as opposed to refreshing the screen, for example). Some choose to |
| ignore it. In general, if a |
| function uses the numeric argument as a repeat count, it should be able |
| to do something useful with both negative and positive arguments. |
| At the very least, it should be aware that it can be passed a |
| negative argument. |
| </P><P> |
| |
| A command function should return 0 if its action completes successfully, |
| and a non-zero value if some error occurs. |
| </P><P> |
| |
| <A NAME="Readline Variables"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC28"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC27"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 2.3 Readline Variables </H2> |
| <!--docid::SEC28::--> |
| <P> |
| |
| These variables are available to function writers. |
| </P><P> |
| |
| <A NAME="IDX176"></A> |
| <DL> |
| <DT><U>Variable:</U> char * <B>rl_line_buffer</B> |
| <DD>This is the line gathered so far. You are welcome to modify the |
| contents of the line, but see <A HREF="readline.html#SEC34">2.4.5 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><P> |
| |
| <A NAME="IDX177"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_point</B> |
| <DD>The offset of the current cursor position in <CODE>rl_line_buffer</CODE> |
| (the <EM>point</EM>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX178"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_end</B> |
| <DD>The number of characters present in <CODE>rl_line_buffer</CODE>. When |
| <CODE>rl_point</CODE> is at the end of the line, <CODE>rl_point</CODE> and |
| <CODE>rl_end</CODE> are equal. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX179"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_mark</B> |
| <DD>The <VAR>mark</VAR> (saved position) in the current line. If set, the mark |
| and point define a <EM>region</EM>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX180"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_done</B> |
| <DD>Setting this to a non-zero value causes Readline to return the current |
| line immediately. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX181"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_num_chars_to_read</B> |
| <DD>Setting this to a positive value before calling <CODE>readline()</CODE> causes |
| Readline to return after accepting that many characters, rather |
| than reading up to a character bound to <CODE>accept-line</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX182"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_pending_input</B> |
| <DD>Setting this to a value makes it the next keystroke read. This is a |
| way to stuff a single character into the input stream. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX183"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_dispatching</B> |
| <DD>Set to a non-zero value if a function is being called from a key binding; |
| zero otherwise. Application functions can test this to discover whether |
| they were called directly or by Readline's dispatching mechanism. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX184"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_erase_empty_line</B> |
| <DD>Setting this to a non-zero value causes Readline to completely erase |
| the current line, including any prompt, any time a newline is typed as |
| the only character on an otherwise-empty line. The cursor is moved to |
| the beginning of the newly-blank line. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX185"></A> |
| <DL> |
| <DT><U>Variable:</U> char * <B>rl_prompt</B> |
| <DD>The prompt Readline uses. This is set from the argument to |
| <CODE>readline()</CODE>, and should not be assigned to directly. |
| The <CODE>rl_set_prompt()</CODE> function (see section <A HREF="readline.html#SEC35">2.4.6 Redisplay</A>) may |
| be used to modify the prompt string after calling <CODE>readline()</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX186"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_already_prompted</B> |
| <DD>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> |
| |
| <A NAME="IDX187"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_library_version</B> |
| <DD>The version number of this revision of the library. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX188"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_readline_version</B> |
| <DD>An integer encoding the current version of the library. The encoding is |
| of the form 0x<VAR>MMmm</VAR>, where <VAR>MM</VAR> is the two-digit major version |
| number, and <VAR>mm</VAR> is the two-digit minor version number. |
| For example, for Readline-4.2, <CODE>rl_readline_version</CODE> would have the |
| value 0x0402. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX189"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_gnu_readline_p</B> |
| <DD>Always set to 1, denoting that this is GNU readline rather than some |
| emulation. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX190"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_terminal_name</B> |
| <DD>The terminal type, used for initialization. If not set by the application, |
| Readline sets this to the value of the <CODE>TERM</CODE> environment variable |
| the first time it is called. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX191"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_readline_name</B> |
| <DD>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">1.3.2 Conditional Init Constructs</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX192"></A> |
| <DL> |
| <DT><U>Variable:</U> FILE * <B>rl_instream</B> |
| <DD>The stdio stream from which Readline reads input. |
| If <CODE>NULL</CODE>, Readline defaults to <VAR>stdin</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX193"></A> |
| <DL> |
| <DT><U>Variable:</U> FILE * <B>rl_outstream</B> |
| <DD>The stdio stream to which Readline performs output. |
| If <CODE>NULL</CODE>, Readline defaults to <VAR>stdout</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX194"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_command_func_t * <B>rl_last_func</B> |
| <DD>The address of the last command function Readline executed. May be used to |
| test whether or not a function is being executed twice in succession, for |
| example. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX195"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_hook_func_t * <B>rl_startup_hook</B> |
| <DD>If non-zero, this is the address of a function to call just |
| before <CODE>readline</CODE> prints the first prompt. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX196"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_hook_func_t * <B>rl_pre_input_hook</B> |
| <DD>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. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX197"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_hook_func_t * <B>rl_event_hook</B> |
| <DD>If non-zero, this is the address of a function to call periodically |
| when Readline is waiting for terminal input. |
| By default, this will be called at most ten times a second if there |
| is no keyboard input. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX198"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_getc_func_t * <B>rl_getc_function</B> |
| <DD>If non-zero, Readline 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 Readline character input function |
| (see section <A HREF="readline.html#SEC37">2.4.8 Character Input</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX199"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_voidfunc_t * <B>rl_redisplay_function</B> |
| <DD>If non-zero, Readline 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 Readline |
| redisplay function (see section <A HREF="readline.html#SEC35">2.4.6 Redisplay</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX200"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_vintfunc_t * <B>rl_prep_term_function</B> |
| <DD>If non-zero, Readline will call indirectly through this pointer |
| to initialize the terminal. The function takes a single argument, an |
| <CODE>int</CODE> flag that says whether or not to use eight-bit characters. |
| By default, this is set to <CODE>rl_prep_terminal</CODE> |
| (see section <A HREF="readline.html#SEC38">2.4.9 Terminal Management</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX201"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_voidfunc_t * <B>rl_deprep_term_function</B> |
| <DD>If non-zero, Readline will call indirectly through this pointer |
| to reset the terminal. This function should undo the effects of |
| <CODE>rl_prep_term_function</CODE>. |
| By default, this is set to <CODE>rl_deprep_terminal</CODE> |
| (see section <A HREF="readline.html#SEC38">2.4.9 Terminal Management</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX202"></A> |
| <DL> |
| <DT><U>Variable:</U> Keymap <B>rl_executing_keymap</B> |
| <DD>This variable is set to the keymap (see section <A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A>) in which the |
| currently executing readline function was found. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX203"></A> |
| <DL> |
| <DT><U>Variable:</U> Keymap <B>rl_binding_keymap</B> |
| <DD>This variable is set to the keymap (see section <A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A>) in which the |
| last key binding occurred. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX204"></A> |
| <DL> |
| <DT><U>Variable:</U> char * <B>rl_executing_macro</B> |
| <DD>This variable is set to the text of any currently-executing macro. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX205"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_readline_state</B> |
| <DD>A variable with bit values that encapsulate the current Readline state. |
| A bit is set with the <CODE>RL_SETSTATE</CODE> macro, and unset with the |
| <CODE>RL_UNSETSTATE</CODE> macro. Use the <CODE>RL_ISSTATE</CODE> macro to test |
| whether a particular state bit is set. Current state bits include: |
| </P><P> |
| |
| <DL COMPACT> |
| <DT><CODE>RL_STATE_NONE</CODE> |
| <DD>Readline has not yet been called, nor has it begun to intialize. |
| <DT><CODE>RL_STATE_INITIALIZING</CODE> |
| <DD>Readline is initializing its internal data structures. |
| <DT><CODE>RL_STATE_INITIALIZED</CODE> |
| <DD>Readline has completed its initialization. |
| <DT><CODE>RL_STATE_TERMPREPPED</CODE> |
| <DD>Readline has modified the terminal modes to do its own input and redisplay. |
| <DT><CODE>RL_STATE_READCMD</CODE> |
| <DD>Readline is reading a command from the keyboard. |
| <DT><CODE>RL_STATE_METANEXT</CODE> |
| <DD>Readline is reading more input after reading the meta-prefix character. |
| <DT><CODE>RL_STATE_DISPATCHING</CODE> |
| <DD>Readline is dispatching to a command. |
| <DT><CODE>RL_STATE_MOREINPUT</CODE> |
| <DD>Readline is reading more input while executing an editing command. |
| <DT><CODE>RL_STATE_ISEARCH</CODE> |
| <DD>Readline is performing an incremental history search. |
| <DT><CODE>RL_STATE_NSEARCH</CODE> |
| <DD>Readline is performing a non-incremental history search. |
| <DT><CODE>RL_STATE_SEARCH</CODE> |
| <DD>Readline is searching backward or forward through the history for a string. |
| <DT><CODE>RL_STATE_NUMERICARG</CODE> |
| <DD>Readline is reading a numeric argument. |
| <DT><CODE>RL_STATE_MACROINPUT</CODE> |
| <DD>Readline is currently getting its input from a previously-defined keyboard |
| macro. |
| <DT><CODE>RL_STATE_MACRODEF</CODE> |
| <DD>Readline is currently reading characters defining a keyboard macro. |
| <DT><CODE>RL_STATE_OVERWRITE</CODE> |
| <DD>Readline is in overwrite mode. |
| <DT><CODE>RL_STATE_COMPLETING</CODE> |
| <DD>Readline is performing word completion. |
| <DT><CODE>RL_STATE_SIGHANDLER</CODE> |
| <DD>Readline is currently executing the readline signal handler. |
| <DT><CODE>RL_STATE_UNDOING</CODE> |
| <DD>Readline is performing an undo. |
| <DT><CODE>RL_STATE_DONE</CODE> |
| <DD>Readline has read a key sequence bound to <CODE>accept-line</CODE> |
| and is about to return the line to the caller. |
| </DL> |
| <P> |
| |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX206"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_explicit_arg</B> |
| <DD>Set to a non-zero value if an explicit numeric argument was specified by |
| the user. Only valid in a bindable command function. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX207"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_numeric_arg</B> |
| <DD>Set to the value of any numeric argument explicitly specified by the user |
| before executing the current Readline function. Only valid in a bindable |
| command function. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX208"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_editing_mode</B> |
| <DD>Set to a value denoting Readline's current editing mode. A value of |
| <VAR>1</VAR> means Readline is currently in emacs mode; <VAR>0</VAR> |
| means that vi mode is active. |
| </DL> |
| </P><P> |
| |
| <A NAME="Readline Convenience Functions"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC29"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC30"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 2.4 Readline Convenience Functions </H2> |
| <!--docid::SEC29::--> |
| <P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC30">2.4.1 Naming a Function</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">How to give a function you write a name.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Making keymaps.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Changing Keymaps.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Translate function names to |
| key sequences.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">How to make your functions undoable.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions to control line display.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions to modify <CODE>rl_line_buffer</CODE>.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions to read keyboard input.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions to manage terminal settings.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Generally useful functions and hooks.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions that don't fall into any category.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Using Readline in a `callback' fashion.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC42">2.4.13 A Readline Example</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">An example Readline function.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <A NAME="Function Naming"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC30"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.1 Naming a Function </H3> |
| <!--docid::SEC30::--> |
| <P> |
| |
| The user can dynamically change the bindings of keys while using |
| Readline. This is done by representing the function with a descriptive |
| name. The user is able to type the descriptive name when referring to |
| the function. Thus, in an init file, one might find |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre>Meta-Rubout: backward-kill-word |
| </pre></td></tr></table></P><P> |
| |
| This binds the keystroke <KBD>Meta-Rubout</KBD> to the function |
| <EM>descriptively</EM> named <CODE>backward-kill-word</CODE>. You, as the |
| programmer, should bind the functions you write to descriptive names as |
| well. Readline provides a function for doing that: |
| </P><P> |
| |
| <A NAME="IDX209"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_add_defun</B> <I>(const char *name, rl_command_func_t *function, int key)</I> |
| <DD>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>. |
| </DL> |
| </P><P> |
| |
| Using this function alone is sufficient for most applications. It is |
| the recommended way to add a few functions to the default functions that |
| Readline has built in. If you need to do something other |
| than adding a function to Readline, you may need to use the |
| underlying functions described below. |
| </P><P> |
| |
| <A NAME="Keymaps"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC31"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC30"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC32"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC32"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.2 Selecting a Keymap </H3> |
| <!--docid::SEC31::--> |
| <P> |
| |
| Key bindings take place on a <EM>keymap</EM>. The keymap is the |
| association between the keys that the user types and the functions that |
| get run. You can make your own keymaps, copy existing keymaps, and tell |
| Readline which keymap to use. |
| </P><P> |
| |
| <A NAME="IDX210"></A> |
| <DL> |
| <DT><U>Function:</U> Keymap <B>rl_make_bare_keymap</B> <I>(void)</I> |
| <DD>Returns a new, empty keymap. The space for the keymap is allocated with |
| <CODE>malloc()</CODE>; the caller should free it by calling |
| <CODE>rl_discard_keymap()</CODE> when done. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX211"></A> |
| <DL> |
| <DT><U>Function:</U> Keymap <B>rl_copy_keymap</B> <I>(Keymap map)</I> |
| <DD>Return a new keymap which is a copy of <VAR>map</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX212"></A> |
| <DL> |
| <DT><U>Function:</U> Keymap <B>rl_make_keymap</B> <I>(void)</I> |
| <DD>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. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX213"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_discard_keymap</B> <I>(Keymap keymap)</I> |
| <DD>Free the storage associated with <VAR>keymap</VAR>. |
| </DL> |
| </P><P> |
| |
| Readline has several internal keymaps. These functions allow you to |
| change which keymap is active. |
| </P><P> |
| |
| <A NAME="IDX214"></A> |
| <DL> |
| <DT><U>Function:</U> Keymap <B>rl_get_keymap</B> <I>(void)</I> |
| <DD>Returns the currently active keymap. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX215"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_set_keymap</B> <I>(Keymap keymap)</I> |
| <DD>Makes <VAR>keymap</VAR> the currently active keymap. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX216"></A> |
| <DL> |
| <DT><U>Function:</U> Keymap <B>rl_get_keymap_by_name</B> <I>(const char *name)</I> |
| <DD>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">1.3 Readline Init File</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX217"></A> |
| <DL> |
| <DT><U>Function:</U> char * <B>rl_get_keymap_name</B> <I>(Keymap keymap)</I> |
| <DD>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">1.3 Readline Init File</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="Binding Keys"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC32"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC33"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC33"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.3 Binding Keys </H3> |
| <!--docid::SEC32::--> |
| <P> |
| |
| Key sequences are associate with functions through the keymap. |
| Readline has several internal keymaps: <CODE>emacs_standard_keymap</CODE>, |
| <CODE>emacs_meta_keymap</CODE>, <CODE>emacs_ctlx_keymap</CODE>, |
| <CODE>vi_movement_keymap</CODE>, and <CODE>vi_insertion_keymap</CODE>. |
| <CODE>emacs_standard_keymap</CODE> is the default, and the examples in |
| 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">2.3 Readline Variables</A>). |
| </P><P> |
| |
| These functions manage key bindings. |
| </P><P> |
| |
| <A NAME="IDX218"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_bind_key</B> <I>(int key, rl_command_func_t *function)</I> |
| <DD>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> |
| </P><P> |
| |
| <A NAME="IDX219"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_bind_key_in_map</B> <I>(int key, rl_command_func_t *function, Keymap map)</I> |
| <DD>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> |
| </P><P> |
| |
| <A NAME="IDX220"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_unbind_key</B> <I>(int key)</I> |
| <DD>Bind <VAR>key</VAR> to the null function in the currently active keymap. |
| Returns non-zero in case of error. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX221"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_unbind_key_in_map</B> <I>(int key, Keymap map)</I> |
| <DD>Bind <VAR>key</VAR> to the null function in <VAR>map</VAR>. |
| Returns non-zero in case of error. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX222"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_unbind_function_in_map</B> <I>(rl_command_func_t *function, Keymap map)</I> |
| <DD>Unbind all keys that execute <VAR>function</VAR> in <VAR>map</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX223"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_unbind_command_in_map</B> <I>(const char *command, Keymap map)</I> |
| <DD>Unbind all keys that are bound to <VAR>command</VAR> in <VAR>map</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX224"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_set_key</B> <I>(const char *keyseq, rl_command_func_t *function, Keymap map)</I> |
| <DD>Bind the key sequence represented by the string <VAR>keyseq</VAR> to the function |
| <VAR>function</VAR>. This makes new keymaps as |
| necessary. The initial keymap in which to do bindings is <VAR>map</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX225"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_generic_bind</B> <I>(int type, const char *keyseq, char *data, Keymap map)</I> |
| <DD>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 |
| (<CODE>ISMACR</CODE>), or a keymap (<CODE>ISKMAP</CODE>). This makes new keymaps as |
| necessary. The initial keymap in which to do bindings is <VAR>map</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX226"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_parse_and_bind</B> <I>(char *line)</I> |
| <DD>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">1.3 Readline Init File</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX227"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_read_init_file</B> <I>(const char *filename)</I> |
| <DD>Read keybindings and variable assignments from <VAR>filename</VAR> |
| (see section <A HREF="readline.html#SEC9">1.3 Readline Init File</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="Associating Function Names and Bindings"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC33"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC32"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC34"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC34"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.4 Associating Function Names and Bindings </H3> |
| <!--docid::SEC33::--> |
| <P> |
| |
| These functions allow you to find out what keys invoke named functions |
| and the functions invoked by a particular key sequence. You may also |
| associate a new function name with an arbitrary function. |
| </P><P> |
| |
| <A NAME="IDX228"></A> |
| <DL> |
| <DT><U>Function:</U> rl_command_func_t * <B>rl_named_function</B> <I>(const char *name)</I> |
| <DD>Return the function with name <VAR>name</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX229"></A> |
| <DL> |
| <DT><U>Function:</U> rl_command_func_t * <B>rl_function_of_keyseq</B> <I>(const char *keyseq, Keymap map, int *type)</I> |
| <DD>Return the function invoked by <VAR>keyseq</VAR> in keymap <VAR>map</VAR>. |
| If <VAR>map</VAR> is <CODE>NULL</CODE>, the current keymap is used. If <VAR>type</VAR> is |
| not <CODE>NULL</CODE>, the type of the object is returned in the <CODE>int</CODE> variable |
| it points to (one of <CODE>ISFUNC</CODE>, <CODE>ISKMAP</CODE>, or <CODE>ISMACR</CODE>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX230"></A> |
| <DL> |
| <DT><U>Function:</U> char ** <B>rl_invoking_keyseqs</B> <I>(rl_command_func_t *function)</I> |
| <DD>Return an array of strings representing the key sequences used to |
| invoke <VAR>function</VAR> in the current keymap. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX231"></A> |
| <DL> |
| <DT><U>Function:</U> char ** <B>rl_invoking_keyseqs_in_map</B> <I>(rl_command_func_t *function, Keymap map)</I> |
| <DD>Return an array of strings representing the key sequences used to |
| invoke <VAR>function</VAR> in the keymap <VAR>map</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX232"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_function_dumper</B> <I>(int readable)</I> |
| <DD>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 |
| <CODE>inputrc</CODE> file and re-read. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX233"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_list_funmap_names</B> <I>(void)</I> |
| <DD>Print the names of all bindable Readline functions to <CODE>rl_outstream</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX234"></A> |
| <DL> |
| <DT><U>Function:</U> const char ** <B>rl_funmap_names</B> <I>(void)</I> |
| <DD>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 <CODE>free()</CODE> the array when you are done, but not the pointers. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX235"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_add_funmap_entry</B> <I>(const char *name, rl_command_func_t *function)</I> |
| <DD>Add <VAR>name</VAR> to the list of bindable Readline command names, and make |
| <VAR>function</VAR> the function to be called when <VAR>name</VAR> is invoked. |
| </DL> |
| </P><P> |
| |
| <A NAME="Allowing Undoing"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC34"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC33"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC35"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC35"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.5 Allowing Undoing </H3> |
| <!--docid::SEC34::--> |
| <P> |
| |
| Supporting the undo command is a painless thing, and makes your |
| functions much more useful. It is certainly easy to try |
| something if you know you can undo it. |
| </P><P> |
| |
| If your function simply inserts text once, or deletes text once, and |
| uses <CODE>rl_insert_text()</CODE> or <CODE>rl_delete_text()</CODE> to do it, then |
| undoing is already done for you automatically. |
| </P><P> |
| |
| If you do multiple insertions or multiple deletions, or any combination |
| of these operations, you should group them together into one operation. |
| This is done with <CODE>rl_begin_undo_group()</CODE> and |
| <CODE>rl_end_undo_group()</CODE>. |
| </P><P> |
| |
| The types of events that can be undone are: |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=smallexample><FONT SIZE=-1><pre>enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; |
| </FONT></pre></td></tr></table></P><P> |
| |
| Notice that <CODE>UNDO_DELETE</CODE> means to insert some text, and |
| <CODE>UNDO_INSERT</CODE> means to delete some text. That is, the undo code |
| tells what to undo, not how to undo it. <CODE>UNDO_BEGIN</CODE> and |
| <CODE>UNDO_END</CODE> are tags added by <CODE>rl_begin_undo_group()</CODE> and |
| <CODE>rl_end_undo_group()</CODE>. |
| </P><P> |
| |
| <A NAME="IDX236"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_begin_undo_group</B> <I>(void)</I> |
| <DD>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 |
| <CODE>rl_add_undo()</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX237"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_end_undo_group</B> <I>(void)</I> |
| <DD>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>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX238"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_add_undo</B> <I>(enum undo_code what, int start, int end, char *text)</I> |
| <DD>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> |
| </P><P> |
| |
| <A NAME="IDX239"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_free_undo_list</B> <I>(void)</I> |
| <DD>Free the existing undo list. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX240"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_do_undo</B> <I>(void)</I> |
| <DD>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> |
| </P><P> |
| |
| Finally, if you neither insert nor delete text, but directly modify the |
| existing text (e.g., change its case), call <CODE>rl_modifying()</CODE> |
| once, just before you modify the text. You must supply the indices of |
| the text range that you are going to modify. |
| </P><P> |
| |
| <A NAME="IDX241"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_modifying</B> <I>(int start, int end)</I> |
| <DD>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. |
| </DL> |
| </P><P> |
| |
| <A NAME="Redisplay"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC35"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC34"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC36"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC36"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.6 Redisplay </H3> |
| <!--docid::SEC35::--> |
| <P> |
| |
| <A NAME="IDX242"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_redisplay</B> <I>(void)</I> |
| <DD>Change what's displayed on the screen to reflect the current contents |
| of <CODE>rl_line_buffer</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX243"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_forced_update_display</B> <I>(void)</I> |
| <DD>Force the line to be updated and redisplayed, whether or not |
| Readline thinks the screen display is correct. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX244"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_on_new_line</B> <I>(void)</I> |
| <DD>Tell the update functions that we have moved onto a new (empty) line, |
| usually after ouputting a newline. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX245"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_on_new_line_with_prompt</B> <I>(void)</I> |
| <DD>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> |
| |
| <A NAME="IDX246"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_reset_line_state</B> <I>(void)</I> |
| <DD>Reset the display state to a clean state and redisplay the current line |
| starting on a new line. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX247"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_crlf</B> <I>(void)</I> |
| <DD>Move the cursor to the start of the next screen line. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX248"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_show_char</B> <I>(int c)</I> |
| <DD>Display character <VAR>c</VAR> on <CODE>rl_outstream</CODE>. |
| If Readline has not been set to display meta characters directly, this |
| will convert meta characters to a meta-prefixed key sequence. |
| This is intended for use by applications which wish to do their own |
| redisplay. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX249"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_message</B> <I>(const char *, <small>...</small>)</I> |
| <DD>The arguments are a format string as would be supplied to <CODE>printf</CODE>, |
| possibly containing conversion specifications such as <SAMP>`%d'</SAMP>, and |
| any additional arguments necessary to satisfy the conversion specifications. |
| The resulting string is displayed in the <EM>echo area</EM>. The echo area |
| is also used to display numeric arguments and search strings. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX250"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_clear_message</B> <I>(void)</I> |
| <DD>Clear the message in the echo area. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX251"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_save_prompt</B> <I>(void)</I> |
| <DD>Save the local Readline prompt display state in preparation for |
| displaying a new message in the message area with <CODE>rl_message()</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX252"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_restore_prompt</B> <I>(void)</I> |
| <DD>Restore the local Readline prompt display state saved by the most |
| recent call to <CODE>rl_save_prompt</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX253"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_expand_prompt</B> <I>(char *prompt)</I> |
| <DD>Expand any special character sequences in <VAR>prompt</VAR> and set up the |
| local Readline prompt redisplay variables. |
| This function is called by <CODE>readline()</CODE>. It may also be called to |
| expand the primary prompt if the <CODE>rl_on_new_line_with_prompt()</CODE> |
| function or <CODE>rl_already_prompted</CODE> variable is used. |
| It returns the number of visible characters on the last line of the |
| (possibly multi-line) prompt. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX254"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_set_prompt</B> <I>(const char *prompt)</I> |
| <DD>Make Readline use <VAR>prompt</VAR> for subsequent redisplay. This calls |
| <CODE>rl_expand_prompt()</CODE> to expand the prompt and sets <CODE>rl_prompt</CODE> |
| to the result. |
| </DL> |
| </P><P> |
| |
| <A NAME="Modifying Text"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC36"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC35"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC37"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC37"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.7 Modifying Text </H3> |
| <!--docid::SEC36::--> |
| <P> |
| |
| <A NAME="IDX255"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_insert_text</B> <I>(const char *text)</I> |
| <DD>Insert <VAR>text</VAR> into the line at the current cursor position. |
| Returns the number of characters inserted. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX256"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_delete_text</B> <I>(int start, int end)</I> |
| <DD>Delete the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line. |
| Returns the number of characters deleted. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX257"></A> |
| <DL> |
| <DT><U>Function:</U> char * <B>rl_copy_text</B> <I>(int start, int end)</I> |
| <DD>Return a copy of the text between <VAR>start</VAR> and <VAR>end</VAR> in |
| the current line. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX258"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_kill_text</B> <I>(int start, int end)</I> |
| <DD>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. |
| If <VAR>start</VAR> is less than <VAR>end</VAR>, |
| the text is appended, otherwise prepended. If the last command was |
| not a kill, a new kill ring slot is used. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX259"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_push_macro_input</B> <I>(char *macro)</I> |
| <DD>Cause <VAR>macro</VAR> to be inserted into the line, as if it had been invoked |
| by a key bound to a macro. Not especially useful; use |
| <CODE>rl_insert_text()</CODE> instead. |
| </DL> |
| </P><P> |
| |
| <A NAME="Character Input"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC37"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC36"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC38"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC38"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.8 Character Input </H3> |
| <!--docid::SEC37::--> |
| <P> |
| |
| <A NAME="IDX260"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_read_key</B> <I>(void)</I> |
| <DD>Return the next character available from Readline's current input stream. |
| This handles input inserted into |
| the input stream via <VAR>rl_pending_input</VAR> (see section <A HREF="readline.html#SEC28">2.3 Readline Variables</A>) |
| and <CODE>rl_stuff_char()</CODE>, macros, and characters read from the keyboard. |
| While waiting for input, this function will call any function assigned to |
| the <CODE>rl_event_hook</CODE> variable. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX261"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_getc</B> <I>(FILE *stream)</I> |
| <DD>Return the next character available from <VAR>stream</VAR>, which is assumed to |
| be the keyboard. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX262"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_stuff_char</B> <I>(int c)</I> |
| <DD>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>. Up to 512 characters may be pushed back. |
| <CODE>rl_stuff_char</CODE> returns 1 if the character was successfully inserted; |
| 0 otherwise. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX263"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_execute_next</B> <I>(int c)</I> |
| <DD>Make <VAR>c</VAR> be the next command to be executed when <CODE>rl_read_key()</CODE> |
| is called. This sets <VAR>rl_pending_input</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX264"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_clear_pending_input</B> <I>(void)</I> |
| <DD>Unset <VAR>rl_pending_input</VAR>, effectively negating the effect of any |
| previous call to <CODE>rl_execute_next()</CODE>. This works only if the |
| pending input has not already been read with <CODE>rl_read_key()</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX265"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_set_keyboard_input_timeout</B> <I>(int u)</I> |
| <DD>While waiting for keyboard input in <CODE>rl_read_key()</CODE>, Readline will |
| wait for <VAR>u</VAR> microseconds for input before calling any function |
| assigned to <CODE>rl_event_hook</CODE>. The default waiting period is |
| one-tenth of a second. Returns the old timeout value. |
| </DL> |
| </P><P> |
| |
| <A NAME="Terminal Management"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC38"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC37"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC39"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.9 Terminal Management </H3> |
| <!--docid::SEC38::--> |
| <P> |
| |
| <A NAME="IDX266"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_prep_terminal</B> <I>(int meta_flag)</I> |
| <DD>Modify the terminal settings for Readline's use, so <CODE>readline()</CODE> |
| can read a single character at a time from the keyboard. |
| The <VAR>meta_flag</VAR> argument should be non-zero if Readline should |
| read eight-bit input. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX267"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_deprep_terminal</B> <I>(void)</I> |
| <DD>Undo the effects of <CODE>rl_prep_terminal()</CODE>, leaving the terminal in |
| the state in which it was before the most recent call to |
| <CODE>rl_prep_terminal()</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX268"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_tty_set_default_bindings</B> <I>(Keymap kmap)</I> |
| <DD>Read the operating system's terminal editing characters (as would be displayed |
| by <CODE>stty</CODE>) to their Readline equivalents. The bindings are performed |
| in <VAR>kmap</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX269"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_reset_terminal</B> <I>(const char *terminal_name)</I> |
| <DD>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 <CODE>NULL</CODE>, the value of the <CODE>TERM</CODE> |
| environment variable is used. |
| </DL> |
| </P><P> |
| |
| <A NAME="Utility Functions"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC39"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC38"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC40"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.10 Utility Functions </H3> |
| <!--docid::SEC39::--> |
| <P> |
| |
| <A NAME="IDX270"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_replace_line</B> <I>(const char *text, int clear_undo)</I> |
| <DD>Replace the contents of <CODE>rl_line_buffer</CODE> with <VAR>text</VAR>. |
| The point and mark are preserved, if possible. |
| If <VAR>clear_undo</VAR> is non-zero, the undo list associated with the |
| current line is cleared. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX271"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_extend_line_buffer</B> <I>(int len)</I> |
| <DD>Ensure that <CODE>rl_line_buffer</CODE> has enough space to hold <VAR>len</VAR> |
| characters, possibly reallocating it if necessary. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX272"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_initialize</B> <I>(void)</I> |
| <DD>Initialize or re-initialize Readline's internal state. |
| It's not strictly necessary to call this; <CODE>readline()</CODE> calls it before |
| reading any input. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX273"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_ding</B> <I>(void)</I> |
| <DD>Ring the terminal bell, obeying the setting of <CODE>bell-style</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX274"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_alphabetic</B> <I>(int c)</I> |
| <DD>Return 1 if <VAR>c</VAR> is an alphabetic character. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX275"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_display_match_list</B> <I>(char **matches, int len, int max)</I> |
| <DD>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. |
| <CODE>len</CODE> is the number of strings in <CODE>matches</CODE>, and <CODE>max</CODE> |
| is the length of the longest string in <CODE>matches</CODE>. This function uses |
| the setting of <CODE>print-completions-horizontally</CODE> to select how the |
| matches are displayed (see section <A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A>). |
| </DL> |
| </P><P> |
| |
| The following are implemented as macros, defined in <CODE>chardefs.h</CODE>. |
| Applications should refrain from using them. |
| </P><P> |
| |
| <A NAME="IDX276"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>_rl_uppercase_p</B> <I>(int c)</I> |
| <DD>Return 1 if <VAR>c</VAR> is an uppercase alphabetic character. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX277"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>_rl_lowercase_p</B> <I>(int c)</I> |
| <DD>Return 1 if <VAR>c</VAR> is a lowercase alphabetic character. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX278"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>_rl_digit_p</B> <I>(int c)</I> |
| <DD>Return 1 if <VAR>c</VAR> is a numeric character. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX279"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>_rl_to_upper</B> <I>(int c)</I> |
| <DD>If <VAR>c</VAR> is a lowercase alphabetic character, return the corresponding |
| uppercase character. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX280"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>_rl_to_lower</B> <I>(int c)</I> |
| <DD>If <VAR>c</VAR> is an uppercase alphabetic character, return the corresponding |
| lowercase character. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX281"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>_rl_digit_value</B> <I>(int c)</I> |
| <DD>If <VAR>c</VAR> is a number, return the value it represents. |
| </DL> |
| </P><P> |
| |
| <A NAME="Miscellaneous Functions"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC40"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC39"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC41"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.11 Miscellaneous Functions </H3> |
| <!--docid::SEC40::--> |
| <P> |
| |
| <A NAME="IDX282"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_macro_bind</B> <I>(const char *keyseq, const char *macro, Keymap map)</I> |
| <DD>Bind the key sequence <VAR>keyseq</VAR> to invoke the macro <VAR>macro</VAR>. |
| The binding is performed in <VAR>map</VAR>. When <VAR>keyseq</VAR> is invoked, the |
| <VAR>macro</VAR> will be inserted into the line. This function is deprecated; |
| use <CODE>rl_generic_bind()</CODE> instead. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX283"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_macro_dumper</B> <I>(int readable)</I> |
| <DD>Print the key sequences bound to macros and their values, using |
| the current keymap, 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 <CODE>inputrc</CODE> file and re-read. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX284"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_variable_bind</B> <I>(const char *variable, const char *value)</I> |
| <DD>Make the Readline variable <VAR>variable</VAR> have <VAR>value</VAR>. |
| This behaves as if the readline command |
| <SAMP>`set <VAR>variable</VAR> <VAR>value</VAR>'</SAMP> had been executed in an <CODE>inputrc</CODE> |
| file (see section <A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A>). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX285"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_variable_dumper</B> <I>(int readable)</I> |
| <DD>Print the readline variable names and their current values |
| 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 <CODE>inputrc</CODE> file and re-read. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX286"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_set_paren_blink_timeout</B> <I>(int u)</I> |
| <DD>Set the time interval (in microseconds) that Readline waits when showing |
| a balancing character when <CODE>blink-matching-paren</CODE> has been enabled. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX287"></A> |
| <DL> |
| <DT><U>Function:</U> char * <B>rl_get_termcap</B> <I>(const char *cap)</I> |
| <DD>Retrieve the string value of the termcap capability <VAR>cap</VAR>. |
| Readline fetches the termcap entry for the current terminal name and |
| uses those capabilities to move around the screen line and perform other |
| terminal-specific operations, like erasing a line. Readline does not |
| use all of a terminal's capabilities, and this function will return |
| values for only those capabilities Readline uses. |
| </DL> |
| </P><P> |
| |
| <A NAME="Alternate Interface"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC41"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC40"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC42"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.12 Alternate Interface </H3> |
| <!--docid::SEC41::--> |
| <P> |
| |
| An alternate interface is available to plain <CODE>readline()</CODE>. Some |
| applications need to interleave keyboard I/O with file, device, or |
| window system I/O, typically by using a main loop to <CODE>select()</CODE> |
| on various file descriptors. To accomodate this need, readline can |
| also be invoked as a `callback' function from an event loop. There |
| are functions available to make this easy. |
| </P><P> |
| |
| <A NAME="IDX288"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_callback_handler_install</B> <I>(const char *prompt, rl_vcpfunc_t *lhandler)</I> |
| <DD>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 function to call when a complete line of input has been entered. |
| The function takes the text of the line as an argument. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX289"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_callback_read_char</B> <I>(void)</I> |
| <DD>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 line, <CODE>rl_callback_read_char</CODE> will |
| invoke the <VAR>lhandler</VAR> function saved by <CODE>rl_callback_handler_install</CODE> |
| to process the line. |
| Before calling the <VAR>lhandler</VAR> function, the terminal settings are |
| reset to the values they had before calling |
| <CODE>rl_callback_handler_install</CODE>. |
| If the <VAR>lhandler</VAR> function returns, |
| the terminal settings are modified for Readline's use again. |
| <CODE>EOF</CODE> is indicated by calling <VAR>lhandler</VAR> with a |
| <CODE>NULL</CODE> line. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX290"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_callback_handler_remove</B> <I>(void)</I> |
| <DD>Restore the terminal to its initial state and remove the line handler. |
| This may be called from within a callback as well as independently. |
| If the <VAR>lhandler</VAR> installed by <CODE>rl_callback_handler_install</CODE> |
| does not exit the program, either this function or the function referred |
| to by the value of <CODE>rl_deprep_term_function</CODE> should be called before |
| the program exits to reset the terminal settings. |
| </DL> |
| </P><P> |
| |
| <A NAME="A Readline Example"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC42"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC41"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> >> </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.4.13 A Readline Example </H3> |
| <!--docid::SEC42::--> |
| <P> |
| |
| Here is a function which changes lowercase characters to their uppercase |
| equivalents, and uppercase characters to lowercase. If |
| this function was bound to <SAMP>`M-c'</SAMP>, then typing <SAMP>`M-c'</SAMP> would |
| change the case of the character under point. Typing <SAMP>`M-1 0 M-c'</SAMP> |
| would change the case of the following 10 characters, leaving the cursor on |
| the last character changed. |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=example><pre>/* Invert the case of the COUNT following characters. */ |
| int |
| invert_case_line (count, key) |
| int count, key; |
| { |
| register int start, end, i; |
| |
| start = rl_point; |
| |
| if (rl_point >= rl_end) |
| return (0); |
| |
| if (count < 0) |
| { |
| direction = -1; |
| count = -count; |
| } |
| else |
| direction = 1; |
| |
| /* Find the end of the range to modify. */ |
| end = start + (count * direction); |
| |
| /* Force it to be within range. */ |
| if (end > rl_end) |
| end = rl_end; |
| else if (end < 0) |
| end = 0; |
| |
| if (start == end) |
| return (0); |
| |
| if (start > end) |
| { |
| int temp = start; |
| start = end; |
| end = temp; |
| } |
| |
| /* Tell readline that we are modifying the line, |
| so it will save the undo information. */ |
| rl_modifying (start, end); |
| |
| for (i = start; i != end; i++) |
| { |
| if (_rl_uppercase_p (rl_line_buffer[i])) |
| rl_line_buffer[i] = _rl_to_lower (rl_line_buffer[i]); |
| else if (_rl_lowercase_p (rl_line_buffer[i])) |
| rl_line_buffer[i] = _rl_to_upper (rl_line_buffer[i]); |
| } |
| /* Move point to on top of the last character changed. */ |
| rl_point = (direction == 1) ? end - 1 : start; |
| return (0); |
| } |
| </pre></td></tr></table></P><P> |
| |
| <A NAME="Readline Signal Handling"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC43"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC42"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 2.5 Readline Signal Handling </H2> |
| <!--docid::SEC43::--> |
| <P> |
| |
| Signals are asynchronous events sent to a process by the Unix kernel, |
| sometimes on behalf of another process. They are intended to indicate |
| exceptional events, like a user pressing the interrupt key on his terminal, |
| or a network connection being broken. There is a class of signals that can |
| be sent to the process currently reading input from the keyboard. Since |
| Readline changes the terminal attributes when it is called, it needs to |
| perform special processing when such a signal is received in order to |
| restore the terminal to a sane state, or provide application writers with |
| functions to do so manually. |
| </P><P> |
| |
| Readline contains an internal signal handler that is installed for a |
| number of signals (<CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <CODE>SIGTERM</CODE>, |
| <CODE>SIGALRM</CODE>, <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>, and <CODE>SIGTTOU</CODE>). |
| When one of these signals is received, the signal handler |
| will reset the terminal attributes to those that were in effect before |
| <CODE>readline()</CODE> was called, reset the signal handling to what it was |
| before <CODE>readline()</CODE> was called, and resend the signal to the calling |
| application. |
| If and when the calling application's signal handler returns, Readline |
| will reinitialize the terminal and continue to accept input. |
| When a <CODE>SIGINT</CODE> is received, the Readline signal handler performs |
| some additional work, which will cause any partially-entered line to be |
| aborted (see the description of <CODE>rl_free_line_state()</CODE> below). |
| </P><P> |
| |
| There is an additional Readline signal handler, for <CODE>SIGWINCH</CODE>, which |
| the kernel sends to a process whenever the terminal's size changes (for |
| example, if a user resizes an <CODE>xterm</CODE>). The Readline <CODE>SIGWINCH</CODE> |
| handler updates Readline's internal screen size information, and then calls |
| any <CODE>SIGWINCH</CODE> signal handler the calling application has installed. |
| Readline calls the application's <CODE>SIGWINCH</CODE> signal handler without |
| resetting the terminal to its original state. If the application's signal |
| handler does more than update its idea of the terminal size and return (for |
| example, a <CODE>longjmp</CODE> back to a main processing loop), it <EM>must</EM> |
| call <CODE>rl_cleanup_after_signal()</CODE> (described below), to restore the |
| terminal state. |
| </P><P> |
| |
| Readline provides two variables that allow application writers to |
| control whether or not it will catch certain signals and act on them |
| when they are received. It is important that applications change the |
| values of these variables only when calling <CODE>readline()</CODE>, not in |
| a signal handler, so Readline's internal signal state is not corrupted. |
| </P><P> |
| |
| <A NAME="IDX291"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_catch_signals</B> |
| <DD>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>. |
| </P><P> |
| |
| The default value of <CODE>rl_catch_signals</CODE> is 1. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX292"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_catch_sigwinch</B> |
| <DD>If this variable is non-zero, Readline will install a signal handler for |
| <CODE>SIGWINCH</CODE>. |
| </P><P> |
| |
| The default value of <CODE>rl_catch_sigwinch</CODE> is 1. |
| </DL> |
| </P><P> |
| |
| If an application does not wish to have Readline catch any signals, or |
| to handle signals other than those Readline catches (<CODE>SIGHUP</CODE>, |
| for example), |
| Readline provides convenience functions to do the necessary terminal |
| and internal state cleanup upon receipt of a signal. |
| </P><P> |
| |
| <A NAME="IDX293"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_cleanup_after_signal</B> <I>(void)</I> |
| <DD>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 |
| <CODE>rl_catch_sigwinch</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX294"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_free_line_state</B> <I>(void)</I> |
| <DD>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 |
| should be called before <CODE>rl_cleanup_after_signal()</CODE>. The |
| Readline signal handler for <CODE>SIGINT</CODE> calls this to abort the |
| current input line. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX295"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_reset_after_signal</B> <I>(void)</I> |
| <DD>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>. |
| </DL> |
| </P><P> |
| |
| If an application does not wish Readline to catch <CODE>SIGWINCH</CODE>, it may |
| call <CODE>rl_resize_terminal()</CODE> or <CODE>rl_set_screen_size()</CODE> to force |
| Readline to update its idea of the terminal size when a <CODE>SIGWINCH</CODE> |
| is received. |
| </P><P> |
| |
| <A NAME="IDX296"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_resize_terminal</B> <I>(void)</I> |
| <DD>Update Readline's internal screen size by reading values from the kernel. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX297"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_set_screen_size</B> <I>(int rows, int cols)</I> |
| <DD>Set Readline's idea of the terminal size to <VAR>rows</VAR> rows and |
| <VAR>cols</VAR> columns. |
| </DL> |
| </P><P> |
| |
| If an application does not want to install a <CODE>SIGWINCH</CODE> handler, but |
| is still interested in the screen dimensions, Readline's idea of the screen |
| size may be queried. |
| </P><P> |
| |
| <A NAME="IDX298"></A> |
| <DL> |
| <DT><U>Function:</U> void <B>rl_get_screen_size</B> <I>(int *rows, int *cols)</I> |
| <DD>Return Readline's idea of the terminal's size in the |
| variables pointed to by the arguments. |
| </DL> |
| </P><P> |
| |
| The following functions install and remove Readline's signal handlers. |
| </P><P> |
| |
| <A NAME="IDX299"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_set_signals</B> <I>(void)</I> |
| <DD>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 |
| <CODE>rl_catch_signals</CODE> and <CODE>rl_catch_sigwinch</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX300"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_clear_signals</B> <I>(void)</I> |
| <DD>Remove all of the Readline signal handlers installed by |
| <CODE>rl_set_signals()</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="Custom Completers"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC44"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H2> 2.6 Custom Completers </H2> |
| <!--docid::SEC44::--> |
| <P> |
| |
| Typically, a program that reads commands from the user has a way of |
| disambiguating commands and data. If your program is one of these, then |
| it can provide completion for commands, data, or both. |
| The following sections describe how your program and Readline |
| cooperate to provide this service. |
| </P><P> |
| |
| <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC45">2.6.1 How Completing Works</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">The logic used to do completion.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions provided by Readline.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Variables which control completion.</TD></TR> |
| <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC48">2.6.4 A Short Completion Example</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">An example of writing completer subroutines.</TD></TR> |
| </TABLE></BLOCKQUOTE> |
| <P> |
| |
| <A NAME="How Completing Works"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC45"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC46"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.6.1 How Completing Works </H3> |
| <!--docid::SEC45::--> |
| <P> |
| |
| In order to complete some text, the full list of possible completions |
| must be available. That is, it is not possible to accurately |
| expand a partial word without knowing all of the possible words |
| which make sense in that context. The Readline library provides |
| the user interface to completion, and two of the most common |
| completion functions: filename and username. For completing other types |
| of text, you must write your own completion function. This section |
| describes exactly what such functions must do, and provides an example. |
| </P><P> |
| |
| There are three major functions used to perform completion: |
| </P><P> |
| |
| <OL> |
| <LI> |
| The user-interface function <CODE>rl_complete()</CODE>. This function is |
| called with the same arguments as other bindable Readline functions: |
| <VAR>count</VAR> and <VAR>invoking_key</VAR>. |
| It isolates the word to be completed and calls |
| <CODE>rl_completion_matches()</CODE> to generate a list of possible completions. |
| It then either lists the possible completions, inserts the possible |
| completions, or actually performs the |
| completion, depending on which behavior is desired. |
| <P> |
| |
| <LI> |
| The internal function <CODE>rl_completion_matches()</CODE> uses an |
| application-supplied <EM>generator</EM> function to generate the list of |
| possible matches, and then returns the array of these matches. |
| The caller should place the address of its generator function in |
| <CODE>rl_completion_entry_function</CODE>. |
| <P> |
| |
| <LI> |
| The generator function is called repeatedly from |
| <CODE>rl_completion_matches()</CODE>, returning a string each time. The |
| arguments to the generator function are <VAR>text</VAR> and <VAR>state</VAR>. |
| <VAR>text</VAR> is the partial word to be completed. <VAR>state</VAR> is zero the |
| first time the function is called, allowing the generator to perform |
| any necessary initialization, and a positive non-zero integer for |
| each subsequent call. The generator function returns |
| <CODE>(char *)NULL</CODE> to inform <CODE>rl_completion_matches()</CODE> that there are |
| no more possibilities left. Usually the generator function computes the |
| list of possible completions when <VAR>state</VAR> is zero, and returns them |
| one at a time on subsequent calls. Each string the generator function |
| returns as a match must be allocated with <CODE>malloc()</CODE>; Readline |
| frees the strings when it has finished with them. |
| <P> |
| |
| </OL> |
| <P> |
| |
| <A NAME="IDX301"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I> |
| <DD>Complete the word at or before point. You have supplied the function |
| that does the initial simple matching selection algorithm (see |
| <CODE>rl_completion_matches()</CODE>). The default is to do filename completion. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX302"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_compentry_func_t * <B>rl_completion_entry_function</B> |
| <DD>This is a pointer to the generator function for |
| <CODE>rl_completion_matches()</CODE>. |
| If the value of <CODE>rl_completion_entry_function</CODE> is |
| <CODE>NULL</CODE> then the default filename generator |
| function, <CODE>rl_filename_completion_function()</CODE>, is used. |
| </DL> |
| </P><P> |
| |
| <A NAME="Completion Functions"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC46"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC47"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC47"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.6.2 Completion Functions </H3> |
| <!--docid::SEC46::--> |
| <P> |
| |
| Here is the complete list of callable completion functions present in |
| Readline. |
| </P><P> |
| |
| <A NAME="IDX303"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_complete_internal</B> <I>(int what_to_do)</I> |
| <DD>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 |
| insert all of the possible completions. <SAMP>`!'</SAMP> means to display |
| all of the possible completions, if there is more than one, as well as |
| performing partial completion. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX304"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I> |
| <DD>Complete the word at or before point. You have supplied the function |
| that does the initial simple matching selection algorithm (see |
| <CODE>rl_completion_matches()</CODE> and <CODE>rl_completion_entry_function</CODE>). |
| The default is to do filename |
| completion. This calls <CODE>rl_complete_internal()</CODE> with an |
| argument depending on <VAR>invoking_key</VAR>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX305"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_possible_completions</B> <I>(int count, int invoking_key)</I> |
| <DD>List the possible completions. See description of <CODE>rl_complete |
| ()</CODE>. This calls <CODE>rl_complete_internal()</CODE> with an argument of |
| <SAMP>`?'</SAMP>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX306"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_insert_completions</B> <I>(int count, int invoking_key)</I> |
| <DD>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>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX307"></A> |
| <DL> |
| <DT><U>Function:</U> int <B>rl_completion_mode</B> <I>(rl_command_func_t *cfunc)</I> |
| <DD>Returns the apppriate value to pass to <CODE>rl_complete_internal()</CODE> |
| depending on whether <VAR>cfunc</VAR> was called twice in succession and |
| the value of the <CODE>show-all-if-ambiguous</CODE> variable. |
| Application-specific completion functions may use this function to present |
| the same interface as <CODE>rl_complete()</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX308"></A> |
| <DL> |
| <DT><U>Function:</U> char ** <B>rl_completion_matches</B> <I>(const char *text, rl_compentry_func_t *entry_func)</I> |
| <DD>Returns an array of strings which is a list of completions for |
| <VAR>text</VAR>. If there are no completions, returns <CODE>NULL</CODE>. |
| The first entry in the returned array is the substitution for <VAR>text</VAR>. |
| The remaining entries are the possible completions. The array is |
| terminated with a <CODE>NULL</CODE> pointer. |
| </P><P> |
| |
| <VAR>entry_func</VAR> is a function of two args, and returns a |
| <CODE>char *</CODE>. The first argument is <VAR>text</VAR>. The second is a |
| state argument; it is zero on the first call, and non-zero on subsequent |
| calls. <VAR>entry_func</VAR> returns a <CODE>NULL</CODE> pointer to the caller |
| when there are no more matches. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX309"></A> |
| <DL> |
| <DT><U>Function:</U> char * <B>rl_filename_completion_function</B> <I>(const char *text, int state)</I> |
| <DD>A generator function for filename completion in the general case. |
| <VAR>text</VAR> is a partial filename. |
| The Bash source is a useful reference for writing custom |
| completion functions (the Bash completion functions call this and other |
| Readline functions). |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX310"></A> |
| <DL> |
| <DT><U>Function:</U> char * <B>rl_username_completion_function</B> <I>(const char *text, int state)</I> |
| <DD>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 |
| for subsequent calls. |
| </DL> |
| </P><P> |
| |
| <A NAME="Completion Variables"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC47"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC46"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC48"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC48"> << </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.6.3 Completion Variables </H3> |
| <!--docid::SEC47::--> |
| <P> |
| |
| <A NAME="IDX311"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_compentry_func_t * <B>rl_completion_entry_function</B> |
| <DD>A pointer to the generator function for <CODE>rl_completion_matches()</CODE>. |
| <CODE>NULL</CODE> means to use <CODE>rl_filename_completion_function()</CODE>, the default |
| filename completer. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX312"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_completion_func_t * <B>rl_attempted_completion_function</B> |
| <DD>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> defining |
| the boundaries of <VAR>text</VAR>, which is a character string. |
| If this function exists and returns <CODE>NULL</CODE>, or if this variable is |
| set to <CODE>NULL</CODE>, then <CODE>rl_complete()</CODE> will call the value of |
| <CODE>rl_completion_entry_function</CODE> to generate matches, otherwise the |
| array of strings returned will be used. |
| If this function sets the <CODE>rl_attempted_completion_over</CODE> |
| variable to a non-zero value, Readline will not perform its default |
| completion even if this function returns no matches. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX313"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_quote_func_t * <B>rl_filename_quoting_function</B> |
| <DD>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> |
| appears in a completed filename. The function is called with |
| <VAR>text</VAR>, <VAR>match_type</VAR>, and <VAR>quote_pointer</VAR>. The <VAR>text</VAR> |
| is the filename to be quoted. The <VAR>match_type</VAR> is either |
| <CODE>SINGLE_MATCH</CODE>, if there is only one completion match, or |
| <CODE>MULT_MATCH</CODE>. Some functions use this to decide whether or not to |
| insert a closing quote character. The <VAR>quote_pointer</VAR> is a pointer |
| to any opening quote character the user typed. Some functions choose |
| to reset this character. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX314"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_dequote_func_t * <B>rl_filename_dequoting_function</B> |
| <DD>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 |
| the filesystem. It is called with <VAR>text</VAR>, the text of the word |
| to be dequoted, and <VAR>quote_char</VAR>, which is the quoting character |
| that delimits the filename (usually <SAMP>`''</SAMP> or <SAMP>`"'</SAMP>). If |
| <VAR>quote_char</VAR> is zero, the filename was not in an embedded string. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX315"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_linebuf_func_t * <B>rl_char_is_quoted_p</B> |
| <DD>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 |
| two arguments: <VAR>text</VAR>, the text of the line, and <VAR>index</VAR>, the |
| index of the character in the line. It is used to decide whether a |
| character found in <CODE>rl_completer_word_break_characters</CODE> should be |
| used to break words for the completer. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX316"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_compignore_func_t * <B>rl_ignore_some_completions_function</B> |
| <DD>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. |
| The first element (<CODE>matches[0]</CODE>) is the |
| maximal substring common to all matches. This function can |
| re-arrange the list of matches as required, but each element deleted |
| from the array must be freed. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX317"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_icppfunc_t * <B>rl_directory_completion_hook</B> |
| <DD>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, and may modify that string. |
| If the string is replaced with a new string, the old value should be freed. |
| Any modified directory name should have a trailing slash. |
| The modified value will be displayed as part of the completion, replacing |
| the directory portion of the pathname the user typed. |
| It returns an integer that should be non-zero if the function modifies |
| its directory argument. |
| It could be used to expand symbolic links or shell variables in pathnames. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX318"></A> |
| <DL> |
| <DT><U>Variable:</U> rl_compdisp_func_t * <B>rl_completion_display_matches_hook</B> |
| <DD>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. |
| It takes three arguments: |
| (<CODE>char **</CODE><VAR>matches</VAR>, <CODE>int</CODE> <VAR>num_matches</VAR>, <CODE>int</CODE> <VAR>max_length</VAR>) |
| where <VAR>matches</VAR> is the array of matching strings, |
| <VAR>num_matches</VAR> is the number of strings in that array, and |
| <VAR>max_length</VAR> is the length of the longest string in that array. |
| Readline provides a convenience function, <CODE>rl_display_match_list</CODE>, |
| that takes care of doing the display to Readline's output stream. That |
| function may be called from this hook. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX319"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_basic_word_break_characters</B> |
| <DD>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: |
| <CODE>" \t\n\"\\'`@$><=;|&{("</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX320"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_basic_quote_characters</B> |
| <DD>A list of quote characters which can cause a word break. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX321"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_completer_word_break_characters</B> |
| <DD>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>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX322"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_completer_quote_characters</B> |
| <DD>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, |
| unless they also appear within this list. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX323"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_filename_quote_characters</B> |
| <DD>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> |
| </P><P> |
| |
| <A NAME="IDX324"></A> |
| <DL> |
| <DT><U>Variable:</U> const char * <B>rl_special_prefixes</B> |
| <DD>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. |
| For instance, Bash sets this variable to "$@" so that it can complete |
| shell variables and hostnames. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX325"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_completion_query_items</B> |
| <DD>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. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX326"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_completion_append_character</B> |
| <DD>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 |
| character (<SAMP>`\0'</SAMP>) prevents anything being appended automatically. |
| This can be changed in custom completion functions to |
| provide the "most sensible word separator character" according to |
| an application-specific command line syntax specification. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX327"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_completion_suppress_append</B> |
| <DD>If non-zero, <VAR>rl_completion_append_character</VAR> is not appended to |
| matches at the end of the command line, as described above. It is |
| set to 0 before any application-specific completion function is called. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX328"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_completion_mark_symlink_dirs</B> |
| <DD>If non-zero, a slash will be appended to completed filenames that are |
| symbolic links to directory names, subject to the value of the |
| user-settable <VAR>mark-directories</VAR> variable. |
| This variable exists so that application completion functions can |
| override the user's global preference (set via the |
| <VAR>mark-symlinked-directories</VAR> Readline variable) if appropriate. |
| This variable is set to the user's preference before any |
| application completion function is called, so unless that function |
| modifies the value, the user's preferences are honored. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX329"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_ignore_completion_duplicates</B> |
| <DD>If non-zero, then duplicates in the matches are removed. |
| The default is 1. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX330"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_filename_completion_desired</B> |
| <DD>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 |
| value, directory names have a slash appended and Readline attempts to |
| quote completed filenames if they contain any characters in |
| <CODE>rl_filename_quote_characters</CODE> and <CODE>rl_filename_quoting_desired</CODE> |
| is set to a non-zero value. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX331"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_filename_quoting_desired</B> |
| <DD>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 |
| <CODE>rl_filename_quote_chars</CODE>. This is <EM>always</EM> non-zero |
| on entry, and can only be changed within a completion entry generator |
| function. The quoting is effected via a call to the function pointed to |
| by <CODE>rl_filename_quoting_function</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX332"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_attempted_completion_over</B> |
| <DD>If an application-specific completion function assigned to |
| <CODE>rl_attempted_completion_function</CODE> sets this variable to a non-zero |
| value, Readline will not perform its default filename completion even |
| if the application's completion function returns no matches. |
| It should be set only by an application's completion function. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX333"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_completion_type</B> |
| <DD>Set to a character describing the type of completion Readline is currently |
| attempting; see the description of <CODE>rl_complete_internal()</CODE> |
| (see section <A HREF="readline.html#SEC46">2.6.2 Completion Functions</A>) for the list of characters. |
| </DL> |
| </P><P> |
| |
| <A NAME="IDX334"></A> |
| <DL> |
| <DT><U>Variable:</U> int <B>rl_inhibit_completion</B> |
| <DD>If this variable is non-zero, completion is inhibited. The completion |
| character will be inserted as any other bound to <CODE>self-insert</CODE>. |
| </DL> |
| </P><P> |
| |
| <A NAME="A Short Completion Example"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC48"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC47"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H3> 2.6.4 A Short Completion Example </H3> |
| <!--docid::SEC48::--> |
| <P> |
| |
| Here is a small application demonstrating the use of the GNU Readline |
| library. It is called <CODE>fileman</CODE>, and the source code resides in |
| <TT>`examples/fileman.c'</TT>. This sample application provides |
| completion of command names, line editing features, and access to the |
| history list. |
| </P><P> |
| |
| <TABLE><tr><td> </td><td class=smallexample><FONT SIZE=-1><pre>/* fileman.c -- A tiny application which demonstrates how to use the |
| GNU Readline library. This application interactively allows users |
| to manipulate files and their modes. */ |
| |
| #include <stdio.h> |
| #include <sys/types.h> |
| #include <sys/file.h> |
| #include <sys/stat.h> |
| #include <sys/errno.h> |
| |
| #include <readline/readline.h> |
| #include <readline/history.h> |
| |
| extern char *xmalloc (); |
| |
| /* The names of functions that actually do the manipulation. */ |
| int com_list __P((char *)); |
| int com_view __P((char *)); |
| int com_rename __P((char *)); |
| int com_stat __P((char *)); |
| int com_pwd __P((char *)); |
| int com_delete __P((char *)); |
| int com_help __P((char *)); |
| int com_cd __P((char *)); |
| int com_quit __P((char *)); |
| |
| /* A structure which contains information on the commands this program |
| can understand. */ |
| |
| typedef struct { |
| char *name; /* User printable name of the function. */ |
| rl_icpfunc_t *func; /* Function to call to do the job. */ |
| char *doc; /* Documentation for this function. */ |
| } COMMAND; |
| |
| COMMAND commands[] = { |
| { "cd", com_cd, "Change to directory DIR" }, |
| { "delete", com_delete, "Delete FILE" }, |
| { "help", com_help, "Display this text" }, |
| { "?", com_help, "Synonym for `help'" }, |
| { "list", com_list, "List files in DIR" }, |
| { "ls", com_list, "Synonym for `list'" }, |
| { "pwd", com_pwd, "Print the current working directory" }, |
| { "quit", com_quit, "Quit using Fileman" }, |
| { "rename", com_rename, "Rename FILE to NEWNAME" }, |
| { "stat", com_stat, "Print out statistics on FILE" }, |
| { "view", com_view, "View the contents of FILE" }, |
| { (char *)NULL, (rl_icpfunc_t *)NULL, (char *)NULL } |
| }; |
| |
| /* Forward declarations. */ |
| char *stripwhite (); |
| COMMAND *find_command (); |
| |
| /* The name of this program, as taken from argv[0]. */ |
| char *progname; |
| |
| /* When non-zero, this means the user is done using this program. */ |
| int done; |
| |
| char * |
| dupstr (s) |
| int s; |
| { |
| char *r; |
| |
| r = xmalloc (strlen (s) + 1); |
| strcpy (r, s); |
| return (r); |
| } |
| |
| main (argc, argv) |
| int argc; |
| char **argv; |
| { |
| char *line, *s; |
| |
| progname = argv[0]; |
| |
| initialize_readline (); /* Bind our completer. */ |
| |
| /* Loop reading and executing lines until the user quits. */ |
| for ( ; done == 0; ) |
| { |
| line = readline ("FileMan: "); |
| |
| if (!line) |
| break; |
| |
| /* Remove leading and trailing whitespace from the line. |
| Then, if there is anything left, add it to the history list |
| and execute it. */ |
| s = stripwhite (line); |
| |
| if (*s) |
| { |
| add_history (s); |
| execute_line (s); |
| } |
| |
| free (line); |
| } |
| exit (0); |
| } |
| |
| /* Execute a command line. */ |
| int |
| execute_line (line) |
| char *line; |
| { |
| register int i; |
| COMMAND *command; |
| char *word; |
| |
| /* Isolate the command word. */ |
| i = 0; |
| while (line[i] && whitespace (line[i])) |
| i++; |
| word = line + i; |
| |
| while (line[i] && !whitespace (line[i])) |
| i++; |
| |
| if (line[i]) |
| line[i++] = '\0'; |
| |
| command = find_command (word); |
| |
| if (!command) |
| { |
| fprintf (stderr, "%s: No such command for FileMan.\n", word); |
| return (-1); |
| } |
| |
| /* Get argument to command, if any. */ |
| while (whitespace (line[i])) |
| i++; |
| |
| word = line + i; |
| |
| /* Call the function. */ |
| return ((*(command->func)) (word)); |
| } |
| |
| /* Look up NAME as the name of a command, and return a pointer to that |
| command. Return a NULL pointer if NAME isn't a command name. */ |
| COMMAND * |
| find_command (name) |
| char *name; |
| { |
| register int i; |
| |
| for (i = 0; commands[i].name; i++) |
| if (strcmp (name, commands[i].name) == 0) |
| return (&commands[i]); |
| |
| return ((COMMAND *)NULL); |
| } |
| |
| /* Strip whitespace from the start and end of STRING. Return a pointer |
| into STRING. */ |
| char * |
| stripwhite (string) |
| char *string; |
| { |
| register char *s, *t; |
| |
| for (s = string; whitespace (*s); s++) |
| ; |
| |
| if (*s == 0) |
| return (s); |
| |
| t = s + strlen (s) - 1; |
| while (t > s && whitespace (*t)) |
| t--; |
| *++t = '\0'; |
| |
| return s; |
| } |
| |
| /* **************************************************************** */ |
| /* */ |
| /* Interface to Readline Completion */ |
| /* */ |
| /* **************************************************************** */ |
| |
| char *command_generator __P((const char *, int)); |
| char **fileman_completion __P((const char *, int, int)); |
| |
| /* Tell the GNU Readline library how to complete. We want to try to |
| complete on command names if this is the first word in the line, or |
| on filenames if not. */ |
| initialize_readline () |
| { |
| /* Allow conditional parsing of the ~/.inputrc file. */ |
| rl_readline_name = "FileMan"; |
| |
| /* Tell the completer that we want a crack first. */ |
| rl_attempted_completion_function = fileman_completion; |
| } |
| |
| /* Attempt to complete on the contents of TEXT. START and END |
| bound the region of rl_line_buffer that contains the word to |
| complete. TEXT is the word to complete. We can use the entire |
| contents of rl_line_buffer in case we want to do some simple |
| parsing. Returnthe array of matches, or NULL if there aren't any. */ |
| char ** |
| fileman_completion (text, start, end) |
| const char *text; |
| int start, end; |
| { |
| char **matches; |
| |
| matches = (char **)NULL; |
| |
| /* If this word is at the start of the line, then it is a command |
| to complete. Otherwise it is the name of a file in the current |
| directory. */ |
| if (start == 0) |
| matches = rl_completion_matches (text, command_generator); |
| |
| return (matches); |
| } |
| |
| /* Generator function for command completion. STATE lets us |
| know whether to start from scratch; without any state |
| (i.e. STATE == 0), then we start at the top of the list. */ |
| char * |
| command_generator (text, state) |
| const char *text; |
| int state; |
| { |
| static int list_index, len; |
| char *name; |
| |
| /* If this is a new word to complete, initialize now. This |
| includes saving the length of TEXT for efficiency, and |
| initializing the index variable to 0. */ |
| if (!state) |
| { |
| list_index = 0; |
| len = strlen (text); |
| } |
| |
| /* Return the next name which partially matches from the |
| command list. */ |
| while (name = commands[list_index].name) |
| { |
| list_index++; |
| |
| if (strncmp (name, text, len) == 0) |
| return (dupstr(name)); |
| } |
| |
| /* If no names matched, then return NULL. */ |
| return ((char *)NULL); |
| } |
| |
| /* **************************************************************** */ |
| /* */ |
| /* FileMan Commands */ |
| /* */ |
| /* **************************************************************** */ |
| |
| /* String to pass to system (). This is for the LIST, VIEW and RENAME |
| commands. */ |
| static char syscom[1024]; |
| |
| /* List the file(s) named in arg. */ |
| com_list (arg) |
| char *arg; |
| { |
| if (!arg) |
| arg = ""; |
| |
| sprintf (syscom, "ls -FClg %s", arg); |
| return (system (syscom)); |
| } |
| |
| com_view (arg) |
| char *arg; |
| { |
| if (!valid_argument ("view", arg)) |
| return 1; |
| |
| sprintf (syscom, "more %s", arg); |
| return (system (syscom)); |
| } |
| |
| com_rename (arg) |
| char *arg; |
| { |
| too_dangerous ("rename"); |
| return (1); |
| } |
| |
| com_stat (arg) |
| char *arg; |
| { |
| struct stat finfo; |
| |
| if (!valid_argument ("stat", arg)) |
| return (1); |
| |
| if (stat (arg, &finfo) == -1) |
| { |
| perror (arg); |
| return (1); |
| } |
| |
| printf ("Statistics for `%s':\n", arg); |
| |
| printf ("%s has %d link%s, and is %d byte%s in length.\n", arg, |
| finfo.st_nlink, |
| (finfo.st_nlink == 1) ? "" : "s", |
| finfo.st_size, |
| (finfo.st_size == 1) ? "" : "s"); |
| printf ("Inode Last Change at: %s", ctime (&finfo.st_ctime)); |
| printf (" Last access at: %s", ctime (&finfo.st_atime)); |
| printf (" Last modified at: %s", ctime (&finfo.st_mtime)); |
| return (0); |
| } |
| |
| com_delete (arg) |
| char *arg; |
| { |
| too_dangerous ("delete"); |
| return (1); |
| } |
| |
| /* Print out help for ARG, or for all of the commands if ARG is |
| not present. */ |
| com_help (arg) |
| char *arg; |
| { |
| register int i; |
| int printed = 0; |
| |
| for (i = 0; commands[i].name; i++) |
| { |
| if (!*arg || (strcmp (arg, commands[i].name) == 0)) |
| { |
| printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc); |
| printed++; |
| } |
| } |
| |
| if (!printed) |
| { |
| printf ("No commands match `%s'. Possibilties are:\n", arg); |
| |
| for (i = 0; commands[i].name; i++) |
| { |
| /* Print in six columns. */ |
| if (printed == 6) |
| { |
| printed = 0; |
| printf ("\n"); |
| } |
| |
| printf ("%s\t", commands[i].name); |
| printed++; |
| } |
| |
| if (printed) |
| printf ("\n"); |
| } |
| return (0); |
| } |
| |
| /* Change to the directory ARG. */ |
| com_cd (arg) |
| char *arg; |
| { |
| if (chdir (arg) == -1) |
| { |
| perror (arg); |
| return 1; |
| } |
| |
| com_pwd (""); |
| return (0); |
| } |
| |
| /* Print out the current working directory. */ |
| com_pwd (ignore) |
| char *ignore; |
| { |
| char dir[1024], *s; |
| |
| s = getcwd (dir, sizeof(dir) - 1); |
| if (s == 0) |
| { |
| printf ("Error getting pwd: %s\n", dir); |
| return 1; |
| } |
| |
| printf ("Current directory is %s\n", dir); |
| return 0; |
| } |
| |
| /* The user wishes to quit using this program. Just set DONE |
| non-zero. */ |
| com_quit (arg) |
| char *arg; |
| { |
| done = 1; |
| return (0); |
| } |
| |
| /* Function which tells you that you can't do this. */ |
| too_dangerous (caller) |
| char *caller; |
| { |
| fprintf (stderr, |
| "%s: Too dangerous for me to distribute.\n" |
| caller); |
| fprintf (stderr, "Write it yourself.\n"); |
| } |
| |
| /* Return non-zero if ARG is a valid argument for CALLER, |
| else print an error message and return zero. */ |
| int |
| valid_argument (caller, arg) |
| char *caller, *arg; |
| { |
| if (!arg || !*arg) |
| { |
| fprintf (stderr, "%s: Argument required.\n", caller); |
| return (0); |
| } |
| |
| return (1); |
| } |
| </FONT></pre></td></tr></table></P><P> |
| |
| <A NAME="Concept Index"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC49"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC48"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> > </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H1> Concept Index </H1> |
| <!--docid::SEC49::--> |
| <table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#cp_C" style="text-decoration:none"><b>C</b></A> |
| |
| <A HREF="readline.html#cp_E" style="text-decoration:none"><b>E</b></A> |
| |
| <A HREF="readline.html#cp_I" style="text-decoration:none"><b>I</b></A> |
| |
| <A HREF="readline.html#cp_K" style="text-decoration:none"><b>K</b></A> |
| |
| <A HREF="readline.html#cp_N" style="text-decoration:none"><b>N</b></A> |
| |
| <A HREF="readline.html#cp_R" style="text-decoration:none"><b>R</b></A> |
| |
| <A HREF="readline.html#cp_V" style="text-decoration:none"><b>V</b></A> |
| |
| <A HREF="readline.html#cp_Y" style="text-decoration:none"><b>Y</b></A> |
| |
| </td></tr></table><br><P></P> |
| <TABLE border=0> |
| <TR><TD></TD><TH ALIGN=LEFT>Index Entry</TH><TH ALIGN=LEFT> Section</TH></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_C"></A>C</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#SEC4">command editing</A></TD><TD valign=top><A HREF="readline.html#SEC4">1.2.1 Readline Bare Essentials</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_E"></A>E</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#SEC4">editing command lines</A></TD><TD valign=top><A HREF="readline.html#SEC4">1.2.1 Readline Bare Essentials</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_I"></A>I</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#SEC9">initialization file, readline</A></TD><TD valign=top><A HREF="readline.html#SEC9">1.3 Readline Init File</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#SEC3">interaction, readline</A></TD><TD valign=top><A HREF="readline.html#SEC3">1.2 Readline Interaction</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_K"></A>K</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX3">kill ring</A></TD><TD valign=top><A HREF="readline.html#SEC6">1.2.3 Readline Killing Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX1">killing text</A></TD><TD valign=top><A HREF="readline.html#SEC6">1.2.3 Readline Killing Commands</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_N"></A>N</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#SEC4">notation, readline</A></TD><TD valign=top><A HREF="readline.html#SEC4">1.2.1 Readline Bare Essentials</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_R"></A>R</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX175">readline, function</A></TD><TD valign=top><A HREF="readline.html#SEC24">2.1 Basic Behavior</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_V"></A>V</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX4">variables, readline</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="cp_Y"></A>Y</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX2">yanking text</A></TD><TD valign=top><A HREF="readline.html#SEC6">1.2.3 Readline Killing Commands</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| </TABLE><P></P><table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#cp_C" style="text-decoration:none"><b>C</b></A> |
| |
| <A HREF="readline.html#cp_E" style="text-decoration:none"><b>E</b></A> |
| |
| <A HREF="readline.html#cp_I" style="text-decoration:none"><b>I</b></A> |
| |
| <A HREF="readline.html#cp_K" style="text-decoration:none"><b>K</b></A> |
| |
| <A HREF="readline.html#cp_N" style="text-decoration:none"><b>N</b></A> |
| |
| <A HREF="readline.html#cp_R" style="text-decoration:none"><b>R</b></A> |
| |
| <A HREF="readline.html#cp_V" style="text-decoration:none"><b>V</b></A> |
| |
| <A HREF="readline.html#cp_Y" style="text-decoration:none"><b>Y</b></A> |
| |
| </td></tr></table><br><P> |
| |
| <A NAME="Function and Variable Index"></A> |
| <HR SIZE="6"> |
| <A NAME="SEC50"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49"> < </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ > ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H1> Function and Variable Index </H1> |
| <!--docid::SEC50::--> |
| <table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#fn__" style="text-decoration:none"><b>_</b></A> |
| |
| <BR> |
| <A HREF="readline.html#fn_A" style="text-decoration:none"><b>A</b></A> |
| |
| <A HREF="readline.html#fn_B" style="text-decoration:none"><b>B</b></A> |
| |
| <A HREF="readline.html#fn_C" style="text-decoration:none"><b>C</b></A> |
| |
| <A HREF="readline.html#fn_D" style="text-decoration:none"><b>D</b></A> |
| |
| <A HREF="readline.html#fn_E" style="text-decoration:none"><b>E</b></A> |
| |
| <A HREF="readline.html#fn_F" style="text-decoration:none"><b>F</b></A> |
| |
| <A HREF="readline.html#fn_H" style="text-decoration:none"><b>H</b></A> |
| |
| <A HREF="readline.html#fn_I" style="text-decoration:none"><b>I</b></A> |
| |
| <A HREF="readline.html#fn_K" style="text-decoration:none"><b>K</b></A> |
| |
| <A HREF="readline.html#fn_M" style="text-decoration:none"><b>M</b></A> |
| |
| <A HREF="readline.html#fn_N" style="text-decoration:none"><b>N</b></A> |
| |
| <A HREF="readline.html#fn_O" style="text-decoration:none"><b>O</b></A> |
| |
| <A HREF="readline.html#fn_P" style="text-decoration:none"><b>P</b></A> |
| |
| <A HREF="readline.html#fn_Q" style="text-decoration:none"><b>Q</b></A> |
| |
| <A HREF="readline.html#fn_R" style="text-decoration:none"><b>R</b></A> |
| |
| <A HREF="readline.html#fn_S" style="text-decoration:none"><b>S</b></A> |
| |
| <A HREF="readline.html#fn_T" style="text-decoration:none"><b>T</b></A> |
| |
| <A HREF="readline.html#fn_U" style="text-decoration:none"><b>U</b></A> |
| |
| <A HREF="readline.html#fn_V" style="text-decoration:none"><b>V</b></A> |
| |
| <A HREF="readline.html#fn_Y" style="text-decoration:none"><b>Y</b></A> |
| |
| </td></tr></table><br><P></P> |
| <TABLE border=0> |
| <TR><TD></TD><TH ALIGN=LEFT>Index Entry</TH><TH ALIGN=LEFT> Section</TH></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn__"></A>_</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX278"><CODE>_rl_digit_p</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX281"><CODE>_rl_digit_value</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX277"><CODE>_rl_lowercase_p</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX280"><CODE>_rl_to_lower</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX279"><CODE>_rl_to_upper</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX276"><CODE>_rl_uppercase_p</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_A"></A>A</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX142"><CODE>abort (C-g)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX143"><CODE>abort (C-g)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX42"><CODE>accept-line (Newline or Return)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX43"><CODE>accept-line (Newline or Return)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_B"></A>B</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX32"><CODE>backward-char (C-b)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX33"><CODE>backward-char (C-b)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX70"><CODE>backward-delete-char (Rubout)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX71"><CODE>backward-delete-char (Rubout)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX94"><CODE>backward-kill-line (C-x Rubout)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX95"><CODE>backward-kill-line (C-x Rubout)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX102"><CODE>backward-kill-word (M-<KBD>DEL</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX103"><CODE>backward-kill-word (M-<KBD>DEL</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX36"><CODE>backward-word (M-b)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX37"><CODE>backward-word (M-b)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX48"><CODE>beginning-of-history (M-&#60;)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX49"><CODE>beginning-of-history (M-&#60;)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX26"><CODE>beginning-of-line (C-a)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX27"><CODE>beginning-of-line (C-a)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX5">bell-style</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_C"></A>C</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX138"><CODE>call-last-kbd-macro (C-x e)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX139"><CODE>call-last-kbd-macro (C-x e)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX88"><CODE>capitalize-word (M-c)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX89"><CODE>capitalize-word (M-c)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX158"><CODE>character-search (C-])</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX159"><CODE>character-search (C-])</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX160"><CODE>character-search-backward (M-C-])</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX161"><CODE>character-search-backward (M-C-])</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX38"><CODE>clear-screen (C-l)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX39"><CODE>clear-screen (C-l)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX6">comment-begin</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX124"><CODE>complete (<KBD>TAB</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX125"><CODE>complete (<KBD>TAB</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX7">completion-query-items</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX8">convert-meta</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX112"><CODE>copy-backward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX113"><CODE>copy-backward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX114"><CODE>copy-forward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX115"><CODE>copy-forward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX110"><CODE>copy-region-as-kill ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX111"><CODE>copy-region-as-kill ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_D"></A>D</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX68"><CODE>delete-char (C-d)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX69"><CODE>delete-char (C-d)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX132"><CODE>delete-char-or-list ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX133"><CODE>delete-char-or-list ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX106"><CODE>delete-horizontal-space ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX107"><CODE>delete-horizontal-space ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX120"><CODE>digit-argument (<KBD>M-0</KBD>, <KBD>M-1</KBD>, <small>...</small> <KBD>M--</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX121"><CODE>digit-argument (<KBD>M-0</KBD>, <KBD>M-1</KBD>, <small>...</small> <KBD>M--</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX9">disable-completion</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX144"><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, <small>...</small>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX145"><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, <small>...</small>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX86"><CODE>downcase-word (M-l)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX87"><CODE>downcase-word (M-l)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX164"><CODE>dump-functions ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX165"><CODE>dump-functions ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX168"><CODE>dump-macros ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX169"><CODE>dump-macros ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX166"><CODE>dump-variables ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX167"><CODE>dump-variables ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_E"></A>E</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX10">editing-mode</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX170"><CODE>emacs-editing-mode (C-e)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX171"><CODE>emacs-editing-mode (C-e)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX11">enable-keypad</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX136"><CODE>end-kbd-macro (C-x ))</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX137"><CODE>end-kbd-macro (C-x ))</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX50"><CODE>end-of-history (M-&#62;)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX51"><CODE>end-of-history (M-&#62;)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX28"><CODE>end-of-line (C-e)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX29"><CODE>end-of-line (C-e)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX156"><CODE>exchange-point-and-mark (C-x C-x)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX157"><CODE>exchange-point-and-mark (C-x C-x)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX12">expand-tilde</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_F"></A>F</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX72"><CODE>forward-backward-delete-char ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX73"><CODE>forward-backward-delete-char ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX30"><CODE>forward-char (C-f)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX31"><CODE>forward-char (C-f)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX54"><CODE>forward-search-history (C-s)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX55"><CODE>forward-search-history (C-s)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX34"><CODE>forward-word (M-f)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX35"><CODE>forward-word (M-f)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_H"></A>H</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX13">history-preserve-point</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX62"><CODE>history-search-backward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX63"><CODE>history-search-backward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX60"><CODE>history-search-forward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX61"><CODE>history-search-forward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX14">horizontal-scroll-mode</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_I"></A>I</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX15">input-meta</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX162"><CODE>insert-comment (M-#)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX163"><CODE>insert-comment (M-#)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX128"><CODE>insert-completions (M-*)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX129"><CODE>insert-completions (M-*)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX17">isearch-terminators</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_K"></A>K</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX18">keymap</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX92"><CODE>kill-line (C-k)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX93"><CODE>kill-line (C-k)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX108"><CODE>kill-region ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX109"><CODE>kill-region ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX98"><CODE>kill-whole-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX99"><CODE>kill-whole-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX100"><CODE>kill-word (M-d)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX101"><CODE>kill-word (M-d)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_M"></A>M</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX19">mark-modified-lines</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX20">mark-symlinked-directories</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX21">match-hidden-files</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX130"><CODE>menu-complete ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX131"><CODE>menu-complete ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX16">meta-flag</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_N"></A>N</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX46"><CODE>next-history (C-n)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX47"><CODE>next-history (C-n)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX58"><CODE>non-incremental-forward-search-history (M-n)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX59"><CODE>non-incremental-forward-search-history (M-n)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX56"><CODE>non-incremental-reverse-search-history (M-p)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX57"><CODE>non-incremental-reverse-search-history (M-p)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_O"></A>O</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX22">output-meta</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX90"><CODE>overwrite-mode ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX91"><CODE>overwrite-mode ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_P"></A>P</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX23">page-completions</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX126"><CODE>possible-completions (M-?)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX127"><CODE>possible-completions (M-?)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX146"><CODE>prefix-meta (<KBD>ESC</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX147"><CODE>prefix-meta (<KBD>ESC</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX44"><CODE>previous-history (C-p)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX45"><CODE>previous-history (C-p)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_Q"></A>Q</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX74"><CODE>quoted-insert (C-q or C-v)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX75"><CODE>quoted-insert (C-q or C-v)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_R"></A>R</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX140"><CODE>re-read-init-file (C-x C-r)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX141"><CODE>re-read-init-file (C-x C-r)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX174"><CODE>readline</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC24">2.1 Basic Behavior</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX40"><CODE>redraw-current-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX41"><CODE>redraw-current-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX52"><CODE>reverse-search-history (C-r)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX53"><CODE>reverse-search-history (C-r)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX150"><CODE>revert-line (M-r)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX151"><CODE>revert-line (M-r)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX209"><CODE>rl_add_defun</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC30">2.4.1 Naming a Function</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX235"><CODE>rl_add_funmap_entry</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX238"><CODE>rl_add_undo</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX274"><CODE>rl_alphabetic</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX186">rl_already_prompted</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX312">rl_attempted_completion_function</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX332">rl_attempted_completion_over</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX320">rl_basic_quote_characters</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX319">rl_basic_word_break_characters</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX236"><CODE>rl_begin_undo_group</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX218"><CODE>rl_bind_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX219"><CODE>rl_bind_key_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX203">rl_binding_keymap</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX288"><CODE>rl_callback_handler_install</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX290"><CODE>rl_callback_handler_remove</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX289"><CODE>rl_callback_read_char</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX291">rl_catch_signals</A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX292">rl_catch_sigwinch</A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX315">rl_char_is_quoted_p</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX293"><CODE>rl_cleanup_after_signal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX250"><CODE>rl_clear_message</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX264"><CODE>rl_clear_pending_input</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX300"><CODE>rl_clear_signals</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX301"><CODE>rl_complete</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC45">2.6.1 How Completing Works</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX304"><CODE>rl_complete</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX303"><CODE>rl_complete_internal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX322">rl_completer_quote_characters</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX321">rl_completer_word_break_characters</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX326">rl_completion_append_character</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX318">rl_completion_display_matches_hook</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX302">rl_completion_entry_function</A></TD><TD valign=top><A HREF="readline.html#SEC45">2.6.1 How Completing Works</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX311">rl_completion_entry_function</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX328">rl_completion_mark_symlink_dirs</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX308"><CODE>rl_completion_matches</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX307"><CODE>rl_completion_mode</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX325">rl_completion_query_items</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX327">rl_completion_suppress_append</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX333">rl_completion_type</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX211"><CODE>rl_copy_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX257"><CODE>rl_copy_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX247"><CODE>rl_crlf</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX256"><CODE>rl_delete_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX201">rl_deprep_term_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX267"><CODE>rl_deprep_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX273"><CODE>rl_ding</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX317">rl_directory_completion_hook</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX213"><CODE>rl_discard_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX183">rl_dispatching</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX275"><CODE>rl_display_match_list</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX240"><CODE>rl_do_undo</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX180">rl_done</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX208">rl_editing_mode</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX178">rl_end</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX237"><CODE>rl_end_undo_group</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX184">rl_erase_empty_line</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX197">rl_event_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX263"><CODE>rl_execute_next</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX202">rl_executing_keymap</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX204">rl_executing_macro</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX253"><CODE>rl_expand_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX206">rl_explicit_arg</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX271"><CODE>rl_extend_line_buffer</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX330">rl_filename_completion_desired</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX309"><CODE>rl_filename_completion_function</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX314">rl_filename_dequoting_function</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX323">rl_filename_quote_characters</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX331">rl_filename_quoting_desired</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX313">rl_filename_quoting_function</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX243"><CODE>rl_forced_update_display</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX294"><CODE>rl_free_line_state</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX239"><CODE>rl_free_undo_list</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX232"><CODE>rl_function_dumper</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX229"><CODE>rl_function_of_keyseq</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX234"><CODE>rl_funmap_names</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX225"><CODE>rl_generic_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX214"><CODE>rl_get_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX216"><CODE>rl_get_keymap_by_name</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX217"><CODE>rl_get_keymap_name</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX298"><CODE>rl_get_screen_size</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX287"><CODE>rl_get_termcap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX261"><CODE>rl_getc</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX198">rl_getc_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX189">rl_gnu_readline_p</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX329">rl_ignore_completion_duplicates</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX316">rl_ignore_some_completions_function</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX334">rl_inhibit_completion</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX272"><CODE>rl_initialize</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX306"><CODE>rl_insert_completions</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX255"><CODE>rl_insert_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX192">rl_instream</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX230"><CODE>rl_invoking_keyseqs</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX231"><CODE>rl_invoking_keyseqs_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX258"><CODE>rl_kill_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX194">rl_last_func</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX187">rl_library_version</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX176">rl_line_buffer</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX233"><CODE>rl_list_funmap_names</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX282"><CODE>rl_macro_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX283"><CODE>rl_macro_dumper</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX210"><CODE>rl_make_bare_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX212"><CODE>rl_make_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX179">rl_mark</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX249"><CODE>rl_message</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX241"><CODE>rl_modifying</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX228"><CODE>rl_named_function</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX181">rl_num_chars_to_read</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX207">rl_numeric_arg</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX244"><CODE>rl_on_new_line</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX245"><CODE>rl_on_new_line_with_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX193">rl_outstream</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX226"><CODE>rl_parse_and_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX182">rl_pending_input</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX177">rl_point</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX305"><CODE>rl_possible_completions</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX196">rl_pre_input_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX200">rl_prep_term_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX266"><CODE>rl_prep_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX185">rl_prompt</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX259"><CODE>rl_push_macro_input</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX227"><CODE>rl_read_init_file</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX260"><CODE>rl_read_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX191">rl_readline_name</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX205">rl_readline_state</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX188">rl_readline_version</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX242"><CODE>rl_redisplay</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX199">rl_redisplay_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX270"><CODE>rl_replace_line</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX295"><CODE>rl_reset_after_signal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX246"><CODE>rl_reset_line_state</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX269"><CODE>rl_reset_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX296"><CODE>rl_resize_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX252"><CODE>rl_restore_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX251"><CODE>rl_save_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX224"><CODE>rl_set_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX265"><CODE>rl_set_keyboard_input_timeout</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX215"><CODE>rl_set_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX286"><CODE>rl_set_paren_blink_timeout</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX254"><CODE>rl_set_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX297"><CODE>rl_set_screen_size</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX299"><CODE>rl_set_signals</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC43">2.5 Readline Signal Handling</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX248"><CODE>rl_show_char</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX324">rl_special_prefixes</A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.3 Completion Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX195">rl_startup_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX262"><CODE>rl_stuff_char</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX190">rl_terminal_name</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX268"><CODE>rl_tty_set_default_bindings</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX223"><CODE>rl_unbind_command_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX222"><CODE>rl_unbind_function_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX220"><CODE>rl_unbind_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX221"><CODE>rl_unbind_key_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX310"><CODE>rl_username_completion_function</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.2 Completion Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX284"><CODE>rl_variable_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX285"><CODE>rl_variable_dumper</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_S"></A>S</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX78"><CODE>self-insert (a, b, A, 1, !, <small>...</small>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX79"><CODE>self-insert (a, b, A, 1, !, <small>...</small>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX154"><CODE>set-mark (C-@)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX155"><CODE>set-mark (C-@)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX24">show-all-if-ambiguous</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX134"><CODE>start-kbd-macro (C-x ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX135"><CODE>start-kbd-macro (C-x ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_T"></A>T</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX76"><CODE>tab-insert (M-<KBD>TAB</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX77"><CODE>tab-insert (M-<KBD>TAB</KBD>)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX152"><CODE>tilde-expand (M-~)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX153"><CODE>tilde-expand (M-~)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX80"><CODE>transpose-chars (C-t)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX81"><CODE>transpose-chars (C-t)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX82"><CODE>transpose-words (M-t)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX83"><CODE>transpose-words (M-t)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_U"></A>U</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX148"><CODE>undo (C-_ or C-x C-u)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX149"><CODE>undo (C-_ or C-x C-u)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX122"><CODE>universal-argument ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX123"><CODE>universal-argument ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX96"><CODE>unix-line-discard (C-u)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX97"><CODE>unix-line-discard (C-u)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX104"><CODE>unix-word-rubout (C-w)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX105"><CODE>unix-word-rubout (C-w)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX84"><CODE>upcase-word (M-u)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX85"><CODE>upcase-word (M-u)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_V"></A>V</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX172"><CODE>vi-editing-mode (M-C-j)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX173"><CODE>vi-editing-mode (M-C-j)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX25">visible-stats</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| <TR><TH><A NAME="fn_Y"></A>Y</TH><TD></TD><TD></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX116"><CODE>yank (C-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX117"><CODE>yank (C-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX66"><CODE>yank-last-arg (M-. or M-_)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX67"><CODE>yank-last-arg (M-. or M-_)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX64"><CODE>yank-nth-arg (M-C-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX65"><CODE>yank-nth-arg (M-C-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX118"><CODE>yank-pop (M-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX119"><CODE>yank-pop (M-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR> |
| <TR><TD COLSPAN=3> <HR></TD></TR> |
| </TABLE><P></P><table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#fn__" style="text-decoration:none"><b>_</b></A> |
| |
| <BR> |
| <A HREF="readline.html#fn_A" style="text-decoration:none"><b>A</b></A> |
| |
| <A HREF="readline.html#fn_B" style="text-decoration:none"><b>B</b></A> |
| |
| <A HREF="readline.html#fn_C" style="text-decoration:none"><b>C</b></A> |
| |
| <A HREF="readline.html#fn_D" style="text-decoration:none"><b>D</b></A> |
| |
| <A HREF="readline.html#fn_E" style="text-decoration:none"><b>E</b></A> |
| |
| <A HREF="readline.html#fn_F" style="text-decoration:none"><b>F</b></A> |
| |
| <A HREF="readline.html#fn_H" style="text-decoration:none"><b>H</b></A> |
| |
| <A HREF="readline.html#fn_I" style="text-decoration:none"><b>I</b></A> |
| |
| <A HREF="readline.html#fn_K" style="text-decoration:none"><b>K</b></A> |
| |
| <A HREF="readline.html#fn_M" style="text-decoration:none"><b>M</b></A> |
| |
| <A HREF="readline.html#fn_N" style="text-decoration:none"><b>N</b></A> |
| |
| <A HREF="readline.html#fn_O" style="text-decoration:none"><b>O</b></A> |
| |
| <A HREF="readline.html#fn_P" style="text-decoration:none"><b>P</b></A> |
| |
| <A HREF="readline.html#fn_Q" style="text-decoration:none"><b>Q</b></A> |
| |
| <A HREF="readline.html#fn_R" style="text-decoration:none"><b>R</b></A> |
| |
| <A HREF="readline.html#fn_S" style="text-decoration:none"><b>S</b></A> |
| |
| <A HREF="readline.html#fn_T" style="text-decoration:none"><b>T</b></A> |
| |
| <A HREF="readline.html#fn_U" style="text-decoration:none"><b>U</b></A> |
| |
| <A HREF="readline.html#fn_V" style="text-decoration:none"><b>V</b></A> |
| |
| <A HREF="readline.html#fn_Y" style="text-decoration:none"><b>Y</b></A> |
| |
| </td></tr></table><br><P> |
| |
| <HR SIZE="6"> |
| <A NAME="SEC_Contents"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H1>Table of Contents</H1> |
| <UL> |
| <A NAME="TOC1" HREF="readline.html#SEC1">1. Command Line Editing</A> |
| <BR> |
| <UL> |
| <A NAME="TOC2" HREF="readline.html#SEC2">1.1 Introduction to Line Editing</A> |
| <BR> |
| <A NAME="TOC3" HREF="readline.html#SEC3">1.2 Readline Interaction</A> |
| <BR> |
| <UL> |
| <A NAME="TOC4" HREF="readline.html#SEC4">1.2.1 Readline Bare Essentials</A> |
| <BR> |
| <A NAME="TOC5" HREF="readline.html#SEC5">1.2.2 Readline Movement Commands</A> |
| <BR> |
| <A NAME="TOC6" HREF="readline.html#SEC6">1.2.3 Readline Killing Commands</A> |
| <BR> |
| <A NAME="TOC7" HREF="readline.html#SEC7">1.2.4 Readline Arguments</A> |
| <BR> |
| <A NAME="TOC8" HREF="readline.html#SEC8">1.2.5 Searching for Commands in the History</A> |
| <BR> |
| </UL> |
| <A NAME="TOC9" HREF="readline.html#SEC9">1.3 Readline Init File</A> |
| <BR> |
| <UL> |
| <A NAME="TOC10" HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A> |
| <BR> |
| <A NAME="TOC11" HREF="readline.html#SEC11">1.3.2 Conditional Init Constructs</A> |
| <BR> |
| <A NAME="TOC12" HREF="readline.html#SEC12">1.3.3 Sample Init File</A> |
| <BR> |
| </UL> |
| <A NAME="TOC13" HREF="readline.html#SEC13">1.4 Bindable Readline Commands</A> |
| <BR> |
| <UL> |
| <A NAME="TOC14" HREF="readline.html#SEC14">1.4.1 Commands For Moving</A> |
| <BR> |
| <A NAME="TOC15" HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A> |
| <BR> |
| <A NAME="TOC16" HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A> |
| <BR> |
| <A NAME="TOC17" HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A> |
| <BR> |
| <A NAME="TOC18" HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A> |
| <BR> |
| <A NAME="TOC19" HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A> |
| <BR> |
| <A NAME="TOC20" HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A> |
| <BR> |
| <A NAME="TOC21" HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A> |
| <BR> |
| </UL> |
| <A NAME="TOC22" HREF="readline.html#SEC22">1.5 Readline vi Mode</A> |
| <BR> |
| </UL> |
| <A NAME="TOC23" HREF="readline.html#SEC23">2. Programming with GNU Readline</A> |
| <BR> |
| <UL> |
| <A NAME="TOC24" HREF="readline.html#SEC24">2.1 Basic Behavior</A> |
| <BR> |
| <A NAME="TOC25" HREF="readline.html#SEC25">2.2 Custom Functions</A> |
| <BR> |
| <UL> |
| <A NAME="TOC26" HREF="readline.html#SEC26">2.2.1 Readline Typedefs</A> |
| <BR> |
| <A NAME="TOC27" HREF="readline.html#SEC27">2.2.2 Writing a New Function</A> |
| <BR> |
| </UL> |
| <A NAME="TOC28" HREF="readline.html#SEC28">2.3 Readline Variables</A> |
| <BR> |
| <A NAME="TOC29" HREF="readline.html#SEC29">2.4 Readline Convenience Functions</A> |
| <BR> |
| <UL> |
| <A NAME="TOC30" HREF="readline.html#SEC30">2.4.1 Naming a Function</A> |
| <BR> |
| <A NAME="TOC31" HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A> |
| <BR> |
| <A NAME="TOC32" HREF="readline.html#SEC32">2.4.3 Binding Keys</A> |
| <BR> |
| <A NAME="TOC33" HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A> |
| <BR> |
| <A NAME="TOC34" HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A> |
| <BR> |
| <A NAME="TOC35" HREF="readline.html#SEC35">2.4.6 Redisplay</A> |
| <BR> |
| <A NAME="TOC36" HREF="readline.html#SEC36">2.4.7 Modifying Text</A> |
| <BR> |
| <A NAME="TOC37" HREF="readline.html#SEC37">2.4.8 Character Input</A> |
| <BR> |
| <A NAME="TOC38" HREF="readline.html#SEC38">2.4.9 Terminal Management</A> |
| <BR> |
| <A NAME="TOC39" HREF="readline.html#SEC39">2.4.10 Utility Functions</A> |
| <BR> |
| <A NAME="TOC40" HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A> |
| <BR> |
| <A NAME="TOC41" HREF="readline.html#SEC41">2.4.12 Alternate Interface</A> |
| <BR> |
| <A NAME="TOC42" HREF="readline.html#SEC42">2.4.13 A Readline Example</A> |
| <BR> |
| </UL> |
| <A NAME="TOC43" HREF="readline.html#SEC43">2.5 Readline Signal Handling</A> |
| <BR> |
| <A NAME="TOC44" HREF="readline.html#SEC44">2.6 Custom Completers</A> |
| <BR> |
| <UL> |
| <A NAME="TOC45" HREF="readline.html#SEC45">2.6.1 How Completing Works</A> |
| <BR> |
| <A NAME="TOC46" HREF="readline.html#SEC46">2.6.2 Completion Functions</A> |
| <BR> |
| <A NAME="TOC47" HREF="readline.html#SEC47">2.6.3 Completion Variables</A> |
| <BR> |
| <A NAME="TOC48" HREF="readline.html#SEC48">2.6.4 A Short Completion Example</A> |
| <BR> |
| </UL> |
| </UL> |
| <A NAME="TOC49" HREF="readline.html#SEC49">Concept Index</A> |
| <BR> |
| <A NAME="TOC50" HREF="readline.html#SEC50">Function and Variable Index</A> |
| <BR> |
| </UL> |
| <HR SIZE=1> |
| <A NAME="SEC_OVERVIEW"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H1>Short Table of Contents</H1> |
| <BLOCKQUOTE> |
| <A NAME="TOC1" HREF="readline.html#SEC1">1. Command Line Editing</A> |
| <BR> |
| <A NAME="TOC23" HREF="readline.html#SEC23">2. Programming with GNU Readline</A> |
| <BR> |
| <A NAME="TOC49" HREF="readline.html#SEC49">Concept Index</A> |
| <BR> |
| <A NAME="TOC50" HREF="readline.html#SEC50">Function and Variable Index</A> |
| <BR> |
| |
| </BLOCKQUOTE> |
| <HR SIZE=1> |
| <A NAME="SEC_About"></A> |
| <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0> |
| <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49">Index</A>]</TD> |
| <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD> |
| </TR></TABLE> |
| <H1>About this document</H1> |
| 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> |
| The buttons in the navigation panels have the following meaning: |
| <P></P> |
| <table border = "1"> |
| <TR> |
| <TH> Button </TH> |
| <TH> Name </TH> |
| <TH> Go to </TH> |
| <TH> From 1.2.3 go to</TH> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [ < ] </TD> |
| <TD ALIGN="CENTER"> |
| Back |
| </TD> |
| <TD> |
| previous section in reading order |
| </TD> |
| <TD> |
| 1.2.2 |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [ > ] </TD> |
| <TD ALIGN="CENTER"> |
| Forward |
| </TD> |
| <TD> |
| next section in reading order |
| </TD> |
| <TD> |
| 1.2.4 |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [ << ] </TD> |
| <TD ALIGN="CENTER"> |
| FastBack |
| </TD> |
| <TD> |
| previous or up-and-previous section |
| </TD> |
| <TD> |
| 1.1 |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [ Up ] </TD> |
| <TD ALIGN="CENTER"> |
| Up |
| </TD> |
| <TD> |
| up section |
| </TD> |
| <TD> |
| 1.2 |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [ >> ] </TD> |
| <TD ALIGN="CENTER"> |
| FastForward |
| </TD> |
| <TD> |
| next or up-and-next section |
| </TD> |
| <TD> |
| 1.3 |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [Top] </TD> |
| <TD ALIGN="CENTER"> |
| Top |
| </TD> |
| <TD> |
| cover (top) of document |
| </TD> |
| <TD> |
| |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [Contents] </TD> |
| <TD ALIGN="CENTER"> |
| Contents |
| </TD> |
| <TD> |
| table of contents |
| </TD> |
| <TD> |
| |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [Index] </TD> |
| <TD ALIGN="CENTER"> |
| Index |
| </TD> |
| <TD> |
| concept index |
| </TD> |
| <TD> |
| |
| </TD> |
| </TR> |
| <TR> |
| <TD ALIGN="CENTER"> |
| [ ? ] </TD> |
| <TD ALIGN="CENTER"> |
| About |
| </TD> |
| <TD> |
| this page |
| </TD> |
| <TD> |
| |
| </TD> |
| </TR> |
| </TABLE> |
| <P></P> |
| where the <STRONG> Example </STRONG> assumes that the current position |
| is at <STRONG> Subsubsection One-Two-Three </STRONG> of a document of |
| the following structure: |
| <UL> |
| <LI> 1. Section One </LI> |
| <UL> |
| <LI>1.1 Subsection One-One</LI> |
| <UL> |
| <LI> ... </LI> |
| </UL> |
| <LI>1.2 Subsection One-Two</LI> |
| <UL> |
| <LI>1.2.1 Subsubsection One-Two-One |
| </LI><LI>1.2.2 Subsubsection One-Two-Two |
| </LI><LI>1.2.3 Subsubsection One-Two-Three <STRONG> |
| <== Current Position </STRONG> |
| </LI><LI>1.2.4 Subsubsection One-Two-Four |
| </LI></UL> |
| <LI>1.3 Subsection One-Three</LI> |
| <UL> |
| <LI> ... </LI> |
| </UL> |
| <LI>1.4 Subsection One-Four</LI> |
| </UL> |
| </UL> |
| |
| <HR SIZE=1> |
| <BR> |
| <FONT SIZE="-1"> |
| 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> |
| |
| </BODY> |
| </HTML> |
