Annotation of embedaddon/readline/doc/readline.html, revision 1.1.1.1
1.1 misho 1: <HTML>
2: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3: <!-- Created on February, 11 2014 by texi2html 1.64 -->
4: <!--
5: Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
6: Karl Berry <karl@freefriends.org>
7: Olaf Bachmann <obachman@mathematik.uni-kl.de>
8: and many others.
9: Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de>
10: Send bugs and suggestions to <texi2html@mathematik.uni-kl.de>
11:
12: -->
13: <HEAD>
14: <TITLE>GNU Readline Library: </TITLE>
15:
16: <META NAME="description" CONTENT="GNU Readline Library: ">
17: <META NAME="keywords" CONTENT="GNU Readline Library: ">
18: <META NAME="resource-type" CONTENT="document">
19: <META NAME="distribution" CONTENT="global">
20: <META NAME="Generator" CONTENT="texi2html 1.64">
21:
22: </HEAD>
23:
24: <BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
25:
26: <A NAME="SEC_Top"></A>
27: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
28: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD>
29: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
30: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
31: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
32: </TR></TABLE>
33: <H1>GNU Readline Library</H1></P><P>
34:
35: This document describes the GNU Readline Library, a utility which aids
36: in the consistency of user interface across discrete programs which
37: provide a command line interface.
38: The Readline home page is <A HREF="http://www.gnu.org/software/readline/">http://www.gnu.org/software/readline/</A>.
39: </P><P>
40:
41: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
42: <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>
43: <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>
44: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC50">A. GNU Free Documentation License</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">License for copying this manual.</TD></TR>
45: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC52">Concept Index</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Index of concepts described in this manual.</TD></TR>
46: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC53">Function and Variable Index</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Index of externally visible functions
47: and variables.</TD></TR>
48: </TABLE></BLOCKQUOTE>
49: <P>
50:
51: <HR SIZE=1>
52: <A NAME="SEC1"></A>
53: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
54: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> < </A>]</TD>
55: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC2"> > </A>]</TD>
56: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
57: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD>
58: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> >> </A>]</TD>
59: <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>
60: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
61: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
62: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
63: </TR></TABLE>
64: <A NAME="Command Line Editing"></A>
65: <H1> 1. Command Line Editing </H1>
66: <!--docid::SEC1::-->
67: <P>
68:
69: This chapter describes the basic features of the GNU
70: command line editing interface.
71: </P><P>
72:
73: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
74: <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>
75: <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>
76: <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>
77: <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
78: available for binding</TD></TR>
79: <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
80: behave like the vi editor.</TD></TR>
81: </TABLE></BLOCKQUOTE>
82: <P>
83:
84: <A NAME="Introduction and Notation"></A>
85: <HR SIZE="6">
86: <A NAME="SEC2"></A>
87: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
88: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> < </A>]</TD>
89: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> > </A>]</TD>
90: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
91: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD>
92: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> >> </A>]</TD>
93: <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>
94: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
95: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
96: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
97: </TR></TABLE>
98: <H2> 1.1 Introduction to Line Editing </H2>
99: <!--docid::SEC2::-->
100: <P>
101:
102: The following paragraphs describe the notation used to represent
103: keystrokes.
104: </P><P>
105:
106: The text <KBD>C-k</KBD> is read as `Control-K' and describes the character
107: produced when the <KBD>k</KBD> key is pressed while the Control key
108: is depressed.
109: </P><P>
110:
111: The text <KBD>M-k</KBD> is read as `Meta-K' and describes the character
112: produced when the Meta key (if you have one) is depressed, and the <KBD>k</KBD>
113: key is pressed.
114: The Meta key is labeled <KBD>ALT</KBD> on many keyboards.
115: On keyboards with two keys labeled <KBD>ALT</KBD> (usually to either side of
116: the space bar), the <KBD>ALT</KBD> on the left side is generally set to
117: work as a Meta key.
118: The <KBD>ALT</KBD> key on the right may also be configured to work as a
119: Meta key or may be configured as some other modifier, such as a
120: Compose key for typing accented characters.
121: </P><P>
122:
123: If you do not have a Meta or <KBD>ALT</KBD> key, or another key working as
124: a Meta key, the identical keystroke can be generated by typing <KBD>ESC</KBD>
125: <EM>first</EM>, and then typing <KBD>k</KBD>.
126: Either process is known as <EM>metafying</EM> the <KBD>k</KBD> key.
127: </P><P>
128:
129: The text <KBD>M-C-k</KBD> is read as `Meta-Control-k' and describes the
130: character produced by <EM>metafying</EM> <KBD>C-k</KBD>.
131: </P><P>
132:
133: In addition, several keys have their own names. Specifically,
134: <KBD>DEL</KBD>, <KBD>ESC</KBD>, <KBD>LFD</KBD>, <KBD>SPC</KBD>, <KBD>RET</KBD>, and <KBD>TAB</KBD> all
135: stand for themselves when seen in this text, or in an init file
136: (see section <A HREF="readline.html#SEC9">1.3 Readline Init File</A>).
137: If your keyboard lacks a <KBD>LFD</KBD> key, typing <KBD>C-j</KBD> will
138: produce the desired character.
139: The <KBD>RET</KBD> key may be labeled <KBD>Return</KBD> or <KBD>Enter</KBD> on
140: some keyboards.
141: </P><P>
142:
143: <A NAME="Readline Interaction"></A>
144: <HR SIZE="6">
145: <A NAME="SEC3"></A>
146: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
147: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC2"> < </A>]</TD>
148: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC4"> > </A>]</TD>
149: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> << </A>]</TD>
150: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD>
151: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD>
152: <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>
153: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
154: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
155: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
156: </TR></TABLE>
157: <H2> 1.2 Readline Interaction </H2>
158: <!--docid::SEC3::-->
159: <P>
160:
161: Often during an interactive session you type in a long line of text,
162: only to notice that the first word on the line is misspelled. The
163: Readline library gives you a set of commands for manipulating the text
164: as you type it in, allowing you to just fix your typo, and not forcing
165: you to retype the majority of the line. Using these editing commands,
166: you move the cursor to the place that needs correction, and delete or
167: insert the text of the corrections. Then, when you are satisfied with
168: the line, you simply press <KBD>RET</KBD>. You do not have to be at the
169: end of the line to press <KBD>RET</KBD>; the entire line is accepted
170: regardless of the location of the cursor within the line.
171: </P><P>
172:
173: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
174: <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>
175: <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>
176: <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>
177: <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>
178: <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>
179: </TABLE></BLOCKQUOTE>
180: <P>
181:
182: <A NAME="Readline Bare Essentials"></A>
183: <HR SIZE="6">
184: <A NAME="SEC4"></A>
185: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
186: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> < </A>]</TD>
187: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC5"> > </A>]</TD>
188: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> << </A>]</TD>
189: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD>
190: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD>
191: <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>
192: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
193: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
194: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
195: </TR></TABLE>
196: <H3> 1.2.1 Readline Bare Essentials </H3>
197: <!--docid::SEC4::-->
198: <P>
199:
200: In order to enter characters into the line, simply type them. The typed
201: character appears where the cursor was, and then the cursor moves one
202: space to the right. If you mistype a character, you can use your
203: erase character to back up and delete the mistyped character.
204: </P><P>
205:
206: Sometimes you may mistype a character, and
207: not notice the error until you have typed several other characters. In
208: that case, you can type <KBD>C-b</KBD> to move the cursor to the left, and then
209: correct your mistake. Afterwards, you can move the cursor to the right
210: with <KBD>C-f</KBD>.
211: </P><P>
212:
213: When you add text in the middle of a line, you will notice that characters
214: to the right of the cursor are `pushed over' to make room for the text
215: that you have inserted. Likewise, when you delete text behind the cursor,
216: characters to the right of the cursor are `pulled back' to fill in the
217: blank space created by the removal of the text. A list of the bare
218: essentials for editing the text of an input line follows.
219: </P><P>
220:
221: <DL COMPACT>
222: <DT><KBD>C-b</KBD>
223: <DD>Move back one character.
224: <DT><KBD>C-f</KBD>
225: <DD>Move forward one character.
226: <DT><KBD>DEL</KBD> or <KBD>Backspace</KBD>
227: <DD>Delete the character to the left of the cursor.
228: <DT><KBD>C-d</KBD>
229: <DD>Delete the character underneath the cursor.
230: <DT>Printing characters
231: <DD>Insert the character into the line at the cursor.
232: <DT><KBD>C-_</KBD> or <KBD>C-x C-u</KBD>
233: <DD>Undo the last editing command. You can undo all the way back to an
234: empty line.
235: </DL>
236: <P>
237:
238: (Depending on your configuration, the <KBD>Backspace</KBD> key be set to
239: delete the character to the left of the cursor and the <KBD>DEL</KBD> key set
240: to delete the character underneath the cursor, like <KBD>C-d</KBD>, rather
241: than the character to the left of the cursor.)
242: </P><P>
243:
244: <A NAME="Readline Movement Commands"></A>
245: <HR SIZE="6">
246: <A NAME="SEC5"></A>
247: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
248: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC4"> < </A>]</TD>
249: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC6"> > </A>]</TD>
250: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC6"> << </A>]</TD>
251: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD>
252: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD>
253: <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>
254: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
255: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
256: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
257: </TR></TABLE>
258: <H3> 1.2.2 Readline Movement Commands </H3>
259: <!--docid::SEC5::-->
260: <P>
261:
262: The above table describes the most basic keystrokes that you need
263: in order to do editing of the input line. For your convenience, many
264: other commands have been added in addition to <KBD>C-b</KBD>, <KBD>C-f</KBD>,
265: <KBD>C-d</KBD>, and <KBD>DEL</KBD>. Here are some commands for moving more rapidly
266: about the line.
267: </P><P>
268:
269: <DL COMPACT>
270: <DT><KBD>C-a</KBD>
271: <DD>Move to the start of the line.
272: <DT><KBD>C-e</KBD>
273: <DD>Move to the end of the line.
274: <DT><KBD>M-f</KBD>
275: <DD>Move forward a word, where a word is composed of letters and digits.
276: <DT><KBD>M-b</KBD>
277: <DD>Move backward a word.
278: <DT><KBD>C-l</KBD>
279: <DD>Clear the screen, reprinting the current line at the top.
280: </DL>
281: <P>
282:
283: Notice how <KBD>C-f</KBD> moves forward a character, while <KBD>M-f</KBD> moves
284: forward a word. It is a loose convention that control keystrokes
285: operate on characters while meta keystrokes operate on words.
286: </P><P>
287:
288: <A NAME="Readline Killing Commands"></A>
289: <HR SIZE="6">
290: <A NAME="SEC6"></A>
291: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
292: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC5"> < </A>]</TD>
293: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC7"> > </A>]</TD>
294: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC7"> << </A>]</TD>
295: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD>
296: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD>
297: <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>
298: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
299: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
300: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
301: </TR></TABLE>
302: <H3> 1.2.3 Readline Killing Commands </H3>
303: <!--docid::SEC6::-->
304: <P>
305:
306: <A NAME="IDX1"></A>
307: <A NAME="IDX2"></A>
308: </P><P>
309:
310: <EM>Killing</EM> text means to delete the text from the line, but to save
311: it away for later use, usually by <EM>yanking</EM> (re-inserting)
312: it back into the line.
313: (`Cut' and `paste' are more recent jargon for `kill' and `yank'.)
314: </P><P>
315:
316: If the description for a command says that it `kills' text, then you can
317: be sure that you can get the text back in a different (or the same)
318: place later.
319: </P><P>
320:
321: When you use a kill command, the text is saved in a <EM>kill-ring</EM>.
322: Any number of consecutive kills save all of the killed text together, so
323: that when you yank it back, you get it all. The kill
324: ring is not line specific; the text that you killed on a previously
325: typed line is available to be yanked back later, when you are typing
326: another line.
327: <A NAME="IDX3"></A>
328: </P><P>
329:
330: Here is the list of commands for killing text.
331: </P><P>
332:
333: <DL COMPACT>
334: <DT><KBD>C-k</KBD>
335: <DD>Kill the text from the current cursor position to the end of the line.
336: <P>
337:
338: <DT><KBD>M-d</KBD>
339: <DD>Kill from the cursor to the end of the current word, or, if between
340: words, to the end of the next word.
341: Word boundaries are the same as those used by <KBD>M-f</KBD>.
342: <P>
343:
344: <DT><KBD>M-<KBD>DEL</KBD></KBD>
345: <DD>Kill from the cursor the start of the current word, or, if between
346: words, to the start of the previous word.
347: Word boundaries are the same as those used by <KBD>M-b</KBD>.
348: <P>
349:
350: <DT><KBD>C-w</KBD>
351: <DD>Kill from the cursor to the previous whitespace. This is different than
352: <KBD>M-<KBD>DEL</KBD></KBD> because the word boundaries differ.
353: <P>
354:
355: </DL>
356: <P>
357:
358: Here is how to <EM>yank</EM> the text back into the line. Yanking
359: means to copy the most-recently-killed text from the kill buffer.
360: </P><P>
361:
362: <DL COMPACT>
363: <DT><KBD>C-y</KBD>
364: <DD>Yank the most recently killed text back into the buffer at the cursor.
365: <P>
366:
367: <DT><KBD>M-y</KBD>
368: <DD>Rotate the kill-ring, and yank the new top. You can only do this if
369: the prior command is <KBD>C-y</KBD> or <KBD>M-y</KBD>.
370: </DL>
371: <P>
372:
373: <A NAME="Readline Arguments"></A>
374: <HR SIZE="6">
375: <A NAME="SEC7"></A>
376: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
377: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC6"> < </A>]</TD>
378: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC8"> > </A>]</TD>
379: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC8"> << </A>]</TD>
380: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD>
381: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD>
382: <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>
383: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
384: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
385: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
386: </TR></TABLE>
387: <H3> 1.2.4 Readline Arguments </H3>
388: <!--docid::SEC7::-->
389: <P>
390:
391: You can pass numeric arguments to Readline commands. Sometimes the
392: argument acts as a repeat count, other times it is the <I>sign</I> of the
393: argument that is significant. If you pass a negative argument to a
394: command which normally acts in a forward direction, that command will
395: act in a backward direction. For example, to kill text back to the
396: start of the line, you might type <SAMP>`M-- C-k'</SAMP>.
397: </P><P>
398:
399: The general way to pass numeric arguments to a command is to type meta
400: digits before the command. If the first `digit' typed is a minus
401: sign (<SAMP>`-'</SAMP>), then the sign of the argument will be negative. Once
402: you have typed one meta digit to get the argument started, you can type
403: the remainder of the digits, and then the command. For example, to give
404: the <KBD>C-d</KBD> command an argument of 10, you could type <SAMP>`M-1 0 C-d'</SAMP>,
405: which will delete the next ten characters on the input line.
406: </P><P>
407:
408: <A NAME="Searching"></A>
409: <HR SIZE="6">
410: <A NAME="SEC8"></A>
411: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
412: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC7"> < </A>]</TD>
413: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> > </A>]</TD>
414: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> << </A>]</TD>
415: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC3"> Up </A>]</TD>
416: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> >> </A>]</TD>
417: <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>
418: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
419: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
420: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
421: </TR></TABLE>
422: <H3> 1.2.5 Searching for Commands in the History </H3>
423: <!--docid::SEC8::-->
424: <P>
425:
426: Readline provides commands for searching through the command history
427: for lines containing a specified string.
428: There are two search modes: <EM>incremental</EM> and <EM>non-incremental</EM>.
429: </P><P>
430:
431: Incremental searches begin before the user has finished typing the
432: search string.
433: As each character of the search string is typed, Readline displays
434: the next entry from the history matching the string typed so far.
435: An incremental search requires only as many characters as needed to
436: find the desired history entry.
437: To search backward in the history for a particular string, type
438: <KBD>C-r</KBD>. Typing <KBD>C-s</KBD> searches forward through the history.
439: The characters present in the value of the <CODE>isearch-terminators</CODE> variable
440: are used to terminate an incremental search.
441: If that variable has not been assigned a value, the <KBD>ESC</KBD> and
442: <KBD>C-J</KBD> characters will terminate an incremental search.
443: <KBD>C-g</KBD> will abort an incremental search and restore the original line.
444: When the search is terminated, the history entry containing the
445: search string becomes the current line.
446: </P><P>
447:
448: To find other matching entries in the history list, type <KBD>C-r</KBD> or
449: <KBD>C-s</KBD> as appropriate.
450: This will search backward or forward in the history for the next
451: entry matching the search string typed so far.
452: Any other key sequence bound to a Readline command will terminate
453: the search and execute that command.
454: For instance, a <KBD>RET</KBD> will terminate the search and accept
455: the line, thereby executing the command from the history list.
456: A movement command will terminate the search, make the last line found
457: the current line, and begin editing.
458: </P><P>
459:
460: Readline remembers the last incremental search string. If two
461: <KBD>C-r</KBD>s are typed without any intervening characters defining a new
462: search string, any remembered search string is used.
463: </P><P>
464:
465: Non-incremental searches read the entire search string before starting
466: to search for matching history lines. The search string may be
467: typed by the user or be part of the contents of the current line.
468: </P><P>
469:
470: <A NAME="Readline Init File"></A>
471: <HR SIZE="6">
472: <A NAME="SEC9"></A>
473: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
474: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC8"> < </A>]</TD>
475: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC10"> > </A>]</TD>
476: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> << </A>]</TD>
477: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD>
478: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD>
479: <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>
480: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
481: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
482: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
483: </TR></TABLE>
484: <H2> 1.3 Readline Init File </H2>
485: <!--docid::SEC9::-->
486: <P>
487:
488: Although the Readline library comes with a set of Emacs-like
489: keybindings installed by default, it is possible to use a different set
490: of keybindings.
491: Any user can customize programs that use Readline by putting
492: commands in an <EM>inputrc</EM> file, conventionally in his home directory.
493: The name of this
494: file is taken from the value of the environment variable <CODE>INPUTRC</CODE>. If
495: that variable is unset, the default is <TT>`~/.inputrc'</TT>. If that
496: file does not exist or cannot be read, the ultimate default is
497: <TT>`/etc/inputrc'</TT>.
498: </P><P>
499:
500: When a program which uses the Readline library starts up, the
501: init file is read, and the key bindings are set.
502: </P><P>
503:
504: In addition, the <CODE>C-x C-r</CODE> command re-reads this init file, thus
505: incorporating any changes that you might have made to it.
506: </P><P>
507:
508: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
509: <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>
510: </TABLE>
511:
512: <br>
513: <TABLE BORDER=0 CELLSPACING=0>
514: <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>
515: </TABLE>
516:
517: <br>
518: <TABLE BORDER=0 CELLSPACING=0>
519: <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>
520: </TABLE></BLOCKQUOTE>
521: <P>
522:
523: <A NAME="Readline Init File Syntax"></A>
524: <HR SIZE="6">
525: <A NAME="SEC10"></A>
526: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
527: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> < </A>]</TD>
528: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC11"> > </A>]</TD>
529: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> << </A>]</TD>
530: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> Up </A>]</TD>
531: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD>
532: <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>
533: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
534: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
535: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
536: </TR></TABLE>
537: <H3> 1.3.1 Readline Init File Syntax </H3>
538: <!--docid::SEC10::-->
539: <P>
540:
541: There are only a few basic constructs allowed in the
542: Readline init file. Blank lines are ignored.
543: Lines beginning with a <SAMP>`#'</SAMP> are comments.
544: Lines beginning with a <SAMP>`$'</SAMP> indicate conditional
545: constructs (see section <A HREF="readline.html#SEC11">1.3.2 Conditional Init Constructs</A>). Other lines
546: denote variable settings and key bindings.
547: </P><P>
548:
549: <DL COMPACT>
550: <DT>Variable Settings
551: <DD>You can modify the run-time behavior of Readline by
552: altering the values of variables in Readline
553: using the <CODE>set</CODE> command within the init file.
554: The syntax is simple:
555: <P>
556:
557: <TABLE><tr><td> </td><td class=example><pre>set <VAR>variable</VAR> <VAR>value</VAR>
558: </pre></td></tr></table></P><P>
559:
560: Here, for example, is how to
561: change from the default Emacs-like key binding to use
562: <CODE>vi</CODE> line editing commands:
563: </P><P>
564:
565: <TABLE><tr><td> </td><td class=example><pre>set editing-mode vi
566: </pre></td></tr></table></P><P>
567:
568: Variable names and values, where appropriate, are recognized without regard
569: to case. Unrecognized variable names are ignored.
570: </P><P>
571:
572: Boolean variables (those that can be set to on or off) are set to on if
573: the value is null or empty, <VAR>on</VAR> (case-insensitive), or 1. Any other
574: value results in the variable being set to off.
575: </P><P>
576:
577: A great deal of run-time behavior is changeable with the following
578: variables.
579: </P><P>
580:
581: <A NAME="IDX4"></A>
582: <DL COMPACT>
583:
584: <DT><CODE>bell-style</CODE>
585: <DD><A NAME="IDX5"></A>
586: Controls what happens when Readline wants to ring the terminal bell.
587: If set to <SAMP>`none'</SAMP>, Readline never rings the bell. If set to
588: <SAMP>`visible'</SAMP>, Readline uses a visible bell if one is available.
589: If set to <SAMP>`audible'</SAMP> (the default), Readline attempts to ring
590: the terminal's bell.
591: <P>
592:
593: <DT><CODE>bind-tty-special-chars</CODE>
594: <DD><A NAME="IDX6"></A>
595: If set to <SAMP>`on'</SAMP>, Readline attempts to bind the control characters
596: treated specially by the kernel's terminal driver to their Readline
597: equivalents.
598: <P>
599:
600: <DT><CODE>colored-stats</CODE>
601: <DD><A NAME="IDX7"></A>
602: If set to <SAMP>`on'</SAMP>, Readline displays possible completions using different
603: colors to indicate their file type.
604: The color definitions are taken from the value of the <CODE>LS_COLORS</CODE>
605: environment variable.
606: The default is <SAMP>`off'</SAMP>.
607: <P>
608:
609: <DT><CODE>comment-begin</CODE>
610: <DD><A NAME="IDX8"></A>
611: The string to insert at the beginning of the line when the
612: <CODE>insert-comment</CODE> command is executed. The default value
613: is <CODE>"#"</CODE>.
614: <P>
615:
616: <DT><CODE>completion-display-width</CODE>
617: <DD><A NAME="IDX9"></A>
618: The number of screen columns used to display possible matches
619: when performing completion.
620: The value is ignored if it is less than 0 or greater than the terminal
621: screen width.
622: A value of 0 will cause matches to be displayed one per line.
623: The default value is -1.
624: <P>
625:
626: <DT><CODE>completion-ignore-case</CODE>
627: <DD><A NAME="IDX10"></A>
628: If set to <SAMP>`on'</SAMP>, Readline performs filename matching and completion
629: in a case-insensitive fashion.
630: The default value is <SAMP>`off'</SAMP>.
631: <P>
632:
633: <DT><CODE>completion-map-case</CODE>
634: <DD><A NAME="IDX11"></A>
635: If set to <SAMP>`on'</SAMP>, and <VAR>completion-ignore-case</VAR> is enabled, Readline
636: treats hyphens (<SAMP>`-'</SAMP>) and underscores (<SAMP>`_'</SAMP>) as equivalent when
637: performing case-insensitive filename matching and completion.
638: <P>
639:
640: <DT><CODE>completion-prefix-display-length</CODE>
641: <DD><A NAME="IDX12"></A>
642: The length in characters of the common prefix of a list of possible
643: completions that is displayed without modification. When set to a
644: value greater than zero, common prefixes longer than this value are
645: replaced with an ellipsis when displaying possible completions.
646: <P>
647:
648: <DT><CODE>completion-query-items</CODE>
649: <DD><A NAME="IDX13"></A>
650: The number of possible completions that determines when the user is
651: asked whether the list of possibilities should be displayed.
652: If the number of possible completions is greater than this value,
653: Readline will ask the user whether or not he wishes to view
654: them; otherwise, they are simply listed.
655: This variable must be set to an integer value greater than or equal to 0.
656: A negative value means Readline should never ask.
657: The default limit is <CODE>100</CODE>.
658: <P>
659:
660: <DT><CODE>convert-meta</CODE>
661: <DD><A NAME="IDX14"></A>
662: If set to <SAMP>`on'</SAMP>, Readline will convert characters with the
663: eighth bit set to an ASCII key sequence by stripping the eighth
664: bit and prefixing an <KBD>ESC</KBD> character, converting them to a
665: meta-prefixed key sequence. The default value is <SAMP>`on'</SAMP>.
666: <P>
667:
668: <DT><CODE>disable-completion</CODE>
669: <DD><A NAME="IDX15"></A>
670: If set to <SAMP>`On'</SAMP>, Readline will inhibit word completion.
671: Completion characters will be inserted into the line as if they had
672: been mapped to <CODE>self-insert</CODE>. The default is <SAMP>`off'</SAMP>.
673: <P>
674:
675: <DT><CODE>editing-mode</CODE>
676: <DD><A NAME="IDX16"></A>
677: The <CODE>editing-mode</CODE> variable controls which default set of
678: key bindings is used. By default, Readline starts up in Emacs editing
679: mode, where the keystrokes are most similar to Emacs. This variable can be
680: set to either <SAMP>`emacs'</SAMP> or <SAMP>`vi'</SAMP>.
681: <P>
682:
683: <DT><CODE>echo-control-characters</CODE>
684: <DD>When set to <SAMP>`on'</SAMP>, on operating systems that indicate they support it,
685: readline echoes a character corresponding to a signal generated from the
686: keyboard. The default is <SAMP>`on'</SAMP>.
687: <P>
688:
689: <DT><CODE>enable-keypad</CODE>
690: <DD><A NAME="IDX17"></A>
691: When set to <SAMP>`on'</SAMP>, Readline will try to enable the application
692: keypad when it is called. Some systems need this to enable the
693: arrow keys. The default is <SAMP>`off'</SAMP>.
694: <P>
695:
696: <DT><CODE>enable-meta-key</CODE>
697: <DD>When set to <SAMP>`on'</SAMP>, Readline will try to enable any meta modifier
698: key the terminal claims to support when it is called. On many terminals,
699: the meta key is used to send eight-bit characters.
700: The default is <SAMP>`on'</SAMP>.
701: <P>
702:
703: <DT><CODE>expand-tilde</CODE>
704: <DD><A NAME="IDX18"></A>
705: If set to <SAMP>`on'</SAMP>, tilde expansion is performed when Readline
706: attempts word completion. The default is <SAMP>`off'</SAMP>.
707: <P>
708:
709: <DT><CODE>history-preserve-point</CODE>
710: <DD><A NAME="IDX19"></A>
711: If set to <SAMP>`on'</SAMP>, the history code attempts to place the point (the
712: current cursor position) at the
713: same location on each history line retrieved with <CODE>previous-history</CODE>
714: or <CODE>next-history</CODE>. The default is <SAMP>`off'</SAMP>.
715: <P>
716:
717: <DT><CODE>history-size</CODE>
718: <DD><A NAME="IDX20"></A>
719: Set the maximum number of history entries saved in the history list.
720: If set to zero, any existing history entries are deleted and no new entries
721: are saved.
722: If set to a value less than zero, the number of history entries is not
723: limited.
724: By default, the number of history entries is not limited.
725: <P>
726:
727: <DT><CODE>horizontal-scroll-mode</CODE>
728: <DD><A NAME="IDX21"></A>
729: This variable can be set to either <SAMP>`on'</SAMP> or <SAMP>`off'</SAMP>. Setting it
730: to <SAMP>`on'</SAMP> means that the text of the lines being edited will scroll
731: horizontally on a single screen line when they are longer than the width
732: of the screen, instead of wrapping onto a new screen line. By default,
733: this variable is set to <SAMP>`off'</SAMP>.
734: <P>
735:
736: <DT><CODE>input-meta</CODE>
737: <DD><A NAME="IDX22"></A>
738: <A NAME="IDX23"></A>
739: If set to <SAMP>`on'</SAMP>, Readline will enable eight-bit input (it
740: will not clear the eighth bit in the characters it reads),
741: regardless of what the terminal claims it can support. The
742: default value is <SAMP>`off'</SAMP>. The name <CODE>meta-flag</CODE> is a
743: synonym for this variable.
744: <P>
745:
746: <DT><CODE>isearch-terminators</CODE>
747: <DD><A NAME="IDX24"></A>
748: The string of characters that should terminate an incremental search without
749: subsequently executing the character as a command (see section <A HREF="readline.html#SEC8">1.2.5 Searching for Commands in the History</A>).
750: If this variable has not been given a value, the characters <KBD>ESC</KBD> and
751: <KBD>C-J</KBD> will terminate an incremental search.
752: <P>
753:
754: <DT><CODE>keymap</CODE>
755: <DD><A NAME="IDX25"></A>
756: Sets Readline's idea of the current keymap for key binding commands.
757: Acceptable <CODE>keymap</CODE> names are
758: <CODE>emacs</CODE>,
759: <CODE>emacs-standard</CODE>,
760: <CODE>emacs-meta</CODE>,
761: <CODE>emacs-ctlx</CODE>,
762: <CODE>vi</CODE>,
763: <CODE>vi-move</CODE>,
764: <CODE>vi-command</CODE>, and
765: <CODE>vi-insert</CODE>.
766: <CODE>vi</CODE> is equivalent to <CODE>vi-command</CODE>; <CODE>emacs</CODE> is
767: equivalent to <CODE>emacs-standard</CODE>. The default value is <CODE>emacs</CODE>.
768: The value of the <CODE>editing-mode</CODE> variable also affects the
769: default keymap.
770: <P>
771:
772: <DT><CODE>keyseq-timeout</CODE>
773: <DD>Specifies the duration Readline will wait for a character when reading an
774: ambiguous key sequence (one that can form a complete key sequence using
775: the input read so far, or can take additional input to complete a longer
776: key sequence).
777: If no input is received within the timeout, Readline will use the shorter
778: but complete key sequence.
779: Readline uses this value to determine whether or not input is
780: available on the current input source (<CODE>rl_instream</CODE> by default).
781: The value is specified in milliseconds, so a value of 1000 means that
782: Readline will wait one second for additional input.
783: If this variable is set to a value less than or equal to zero, or to a
784: non-numeric value, Readline will wait until another key is pressed to
785: decide which key sequence to complete.
786: The default value is <CODE>500</CODE>.
787: <P>
788:
789: <DT><CODE>mark-directories</CODE>
790: <DD>If set to <SAMP>`on'</SAMP>, completed directory names have a slash
791: appended. The default is <SAMP>`on'</SAMP>.
792: <P>
793:
794: <DT><CODE>mark-modified-lines</CODE>
795: <DD><A NAME="IDX26"></A>
796: This variable, when set to <SAMP>`on'</SAMP>, causes Readline to display an
797: asterisk (<SAMP>`*'</SAMP>) at the start of history lines which have been modified.
798: This variable is <SAMP>`off'</SAMP> by default.
799: <P>
800:
801: <DT><CODE>mark-symlinked-directories</CODE>
802: <DD><A NAME="IDX27"></A>
803: If set to <SAMP>`on'</SAMP>, completed names which are symbolic links
804: to directories have a slash appended (subject to the value of
805: <CODE>mark-directories</CODE>).
806: The default is <SAMP>`off'</SAMP>.
807: <P>
808:
809: <DT><CODE>match-hidden-files</CODE>
810: <DD><A NAME="IDX28"></A>
811: This variable, when set to <SAMP>`on'</SAMP>, causes Readline to match files whose
812: names begin with a <SAMP>`.'</SAMP> (hidden files) when performing filename
813: completion.
814: If set to <SAMP>`off'</SAMP>, the leading <SAMP>`.'</SAMP> must be
815: supplied by the user in the filename to be completed.
816: This variable is <SAMP>`on'</SAMP> by default.
817: <P>
818:
819: <DT><CODE>menu-complete-display-prefix</CODE>
820: <DD><A NAME="IDX29"></A>
821: If set to <SAMP>`on'</SAMP>, menu completion displays the common prefix of the
822: list of possible completions (which may be empty) before cycling through
823: the list. The default is <SAMP>`off'</SAMP>.
824: <P>
825:
826: <DT><CODE>output-meta</CODE>
827: <DD><A NAME="IDX30"></A>
828: If set to <SAMP>`on'</SAMP>, Readline will display characters with the
829: eighth bit set directly rather than as a meta-prefixed escape
830: sequence. The default is <SAMP>`off'</SAMP>.
831: <P>
832:
833: <DT><CODE>page-completions</CODE>
834: <DD><A NAME="IDX31"></A>
835: If set to <SAMP>`on'</SAMP>, Readline uses an internal <CODE>more</CODE>-like pager
836: to display a screenful of possible completions at a time.
837: This variable is <SAMP>`on'</SAMP> by default.
838: <P>
839:
840: <DT><CODE>print-completions-horizontally</CODE>
841: <DD>If set to <SAMP>`on'</SAMP>, Readline will display completions with matches
842: sorted horizontally in alphabetical order, rather than down the screen.
843: The default is <SAMP>`off'</SAMP>.
844: <P>
845:
846: <DT><CODE>revert-all-at-newline</CODE>
847: <DD><A NAME="IDX32"></A>
848: If set to <SAMP>`on'</SAMP>, Readline will undo all changes to history lines
849: before returning when <CODE>accept-line</CODE> is executed. By default,
850: history lines may be modified and retain individual undo lists across
851: calls to <CODE>readline</CODE>. The default is <SAMP>`off'</SAMP>.
852: <P>
853:
854: <DT><CODE>show-all-if-ambiguous</CODE>
855: <DD><A NAME="IDX33"></A>
856: This alters the default behavior of the completion functions. If
857: set to <SAMP>`on'</SAMP>,
858: words which have more than one possible completion cause the
859: matches to be listed immediately instead of ringing the bell.
860: The default value is <SAMP>`off'</SAMP>.
861: <P>
862:
863: <DT><CODE>show-all-if-unmodified</CODE>
864: <DD><A NAME="IDX34"></A>
865: This alters the default behavior of the completion functions in
866: a fashion similar to <VAR>show-all-if-ambiguous</VAR>.
867: If set to <SAMP>`on'</SAMP>,
868: words which have more than one possible completion without any
869: possible partial completion (the possible completions don't share
870: a common prefix) cause the matches to be listed immediately instead
871: of ringing the bell.
872: The default value is <SAMP>`off'</SAMP>.
873: <P>
874:
875: <DT><CODE>show-mode-in-prompt</CODE>
876: <DD><A NAME="IDX35"></A>
877: If set to <SAMP>`on'</SAMP>, add a character to the beginning of the prompt
878: indicating the editing mode: emacs (<SAMP>`@'</SAMP>), vi command (<SAMP>`:'</SAMP>),
879: or vi insertion (<SAMP>`+'</SAMP>).
880: The default value is <SAMP>`off'</SAMP>.
881: <P>
882:
883: <DT><CODE>skip-completed-text</CODE>
884: <DD><A NAME="IDX36"></A>
885: If set to <SAMP>`on'</SAMP>, this alters the default completion behavior when
886: inserting a single match into the line. It's only active when
887: performing completion in the middle of a word. If enabled, readline
888: does not insert characters from the completion that match characters
889: after point in the word being completed, so portions of the word
890: following the cursor are not duplicated.
891: For instance, if this is enabled, attempting completion when the cursor
892: is after the <SAMP>`e'</SAMP> in <SAMP>`Makefile'</SAMP> will result in <SAMP>`Makefile'</SAMP>
893: rather than <SAMP>`Makefilefile'</SAMP>, assuming there is a single possible
894: completion.
895: The default value is <SAMP>`off'</SAMP>.
896: <P>
897:
898: <DT><CODE>visible-stats</CODE>
899: <DD><A NAME="IDX37"></A>
900: If set to <SAMP>`on'</SAMP>, a character denoting a file's type
901: is appended to the filename when listing possible
902: completions. The default is <SAMP>`off'</SAMP>.
903: <P>
904:
905: </DL>
906: <P>
907:
908: <DT>Key Bindings
909: <DD>The syntax for controlling key bindings in the init file is
910: simple. First you need to find the name of the command that you
911: want to change. The following sections contain tables of the command
912: name, the default keybinding, if any, and a short description of what
913: the command does.
914: <P>
915:
916: Once you know the name of the command, simply place on a line
917: in the init file the name of the key
918: you wish to bind the command to, a colon, and then the name of the
919: command.
920: There can be no space between the key name and the colon -- that will be
921: interpreted as part of the key name.
922: The name of the key can be expressed in different ways, depending on
923: what you find most comfortable.
924: </P><P>
925:
926: In addition to command names, readline allows keys to be bound
927: to a string that is inserted when the key is pressed (a <VAR>macro</VAR>).
928: </P><P>
929:
930: <DL COMPACT>
931: <DT><VAR>keyname</VAR>: <VAR>function-name</VAR> or <VAR>macro</VAR>
932: <DD><VAR>keyname</VAR> is the name of a key spelled out in English. For example:
933: <TABLE><tr><td> </td><td class=example><pre>Control-u: universal-argument
934: Meta-Rubout: backward-kill-word
935: Control-o: "> output"
936: </pre></td></tr></table><P>
937:
938: In the above example, <KBD>C-u</KBD> is bound to the function
939: <CODE>universal-argument</CODE>,
940: <KBD>M-DEL</KBD> is bound to the function <CODE>backward-kill-word</CODE>, and
941: <KBD>C-o</KBD> is bound to run the macro
942: expressed on the right hand side (that is, to insert the text
943: <SAMP>`> output'</SAMP> into the line).
944: </P><P>
945:
946: A number of symbolic character names are recognized while
947: processing this key binding syntax:
948: <VAR>DEL</VAR>,
949: <VAR>ESC</VAR>,
950: <VAR>ESCAPE</VAR>,
951: <VAR>LFD</VAR>,
952: <VAR>NEWLINE</VAR>,
953: <VAR>RET</VAR>,
954: <VAR>RETURN</VAR>,
955: <VAR>RUBOUT</VAR>,
956: <VAR>SPACE</VAR>,
957: <VAR>SPC</VAR>,
958: and
959: <VAR>TAB</VAR>.
960: </P><P>
961:
962: <DT>"<VAR>keyseq</VAR>": <VAR>function-name</VAR> or <VAR>macro</VAR>
963: <DD><VAR>keyseq</VAR> differs from <VAR>keyname</VAR> above in that strings
964: denoting an entire key sequence can be specified, by placing
965: the key sequence in double quotes. Some GNU Emacs style key
966: escapes can be used, as in the following example, but the
967: special character names are not recognized.
968: <P>
969:
970: <TABLE><tr><td> </td><td class=example><pre>"\C-u": universal-argument
971: "\C-x\C-r": re-read-init-file
972: "\e[11~": "Function Key 1"
973: </pre></td></tr></table></P><P>
974:
975: In the above example, <KBD>C-u</KBD> is again bound to the function
976: <CODE>universal-argument</CODE> (just as it was in the first example),
977: <SAMP>`<KBD>C-x</KBD> <KBD>C-r</KBD>'</SAMP> is bound to the function <CODE>re-read-init-file</CODE>,
978: and <SAMP>`<KBD>ESC</KBD> <KBD>[</KBD> <KBD>1</KBD> <KBD>1</KBD> <KBD>~</KBD>'</SAMP> is bound to insert
979: the text <SAMP>`Function Key 1'</SAMP>.
980: </P><P>
981:
982: </DL>
983: <P>
984:
985: The following GNU Emacs style escape sequences are available when
986: specifying key sequences:
987: </P><P>
988:
989: <DL COMPACT>
990: <DT><CODE><KBD>\C-</KBD></CODE>
991: <DD>control prefix
992: <DT><CODE><KBD>\M-</KBD></CODE>
993: <DD>meta prefix
994: <DT><CODE><KBD>\e</KBD></CODE>
995: <DD>an escape character
996: <DT><CODE><KBD>\\</KBD></CODE>
997: <DD>backslash
998: <DT><CODE><KBD>\"</KBD></CODE>
999: <DD><KBD>"</KBD>, a double quotation mark
1000: <DT><CODE><KBD>\'</KBD></CODE>
1001: <DD><KBD>'</KBD>, a single quote or apostrophe
1002: </DL>
1003: <P>
1004:
1005: In addition to the GNU Emacs style escape sequences, a second
1006: set of backslash escapes is available:
1007: </P><P>
1008:
1009: <DL COMPACT>
1010: <DT><CODE>\a</CODE>
1011: <DD>alert (bell)
1012: <DT><CODE>\b</CODE>
1013: <DD>backspace
1014: <DT><CODE>\d</CODE>
1015: <DD>delete
1016: <DT><CODE>\f</CODE>
1017: <DD>form feed
1018: <DT><CODE>\n</CODE>
1019: <DD>newline
1020: <DT><CODE>\r</CODE>
1021: <DD>carriage return
1022: <DT><CODE>\t</CODE>
1023: <DD>horizontal tab
1024: <DT><CODE>\v</CODE>
1025: <DD>vertical tab
1026: <DT><CODE>\<VAR>nnn</VAR></CODE>
1027: <DD>the eight-bit character whose value is the octal value <VAR>nnn</VAR>
1028: (one to three digits)
1029: <DT><CODE>\x<VAR>HH</VAR></CODE>
1030: <DD>the eight-bit character whose value is the hexadecimal value <VAR>HH</VAR>
1031: (one or two hex digits)
1032: </DL>
1033: <P>
1034:
1035: When entering the text of a macro, single or double quotes must
1036: be used to indicate a macro definition.
1037: Unquoted text is assumed to be a function name.
1038: In the macro body, the backslash escapes described above are expanded.
1039: Backslash will quote any other character in the macro text,
1040: including <SAMP>`"'</SAMP> and <SAMP>`''</SAMP>.
1041: For example, the following binding will make <SAMP>`<KBD>C-x</KBD> \'</SAMP>
1042: insert a single <SAMP>`\'</SAMP> into the line:
1043: <TABLE><tr><td> </td><td class=example><pre>"\C-x\\": "\\"
1044: </pre></td></tr></table></P><P>
1045:
1046: </DL>
1047: <P>
1048:
1049: <A NAME="Conditional Init Constructs"></A>
1050: <HR SIZE="6">
1051: <A NAME="SEC11"></A>
1052: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1053: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC10"> < </A>]</TD>
1054: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC12"> > </A>]</TD>
1055: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC12"> << </A>]</TD>
1056: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> Up </A>]</TD>
1057: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD>
1058: <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>
1059: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1060: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1061: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1062: </TR></TABLE>
1063: <H3> 1.3.2 Conditional Init Constructs </H3>
1064: <!--docid::SEC11::-->
1065: <P>
1066:
1067: Readline implements a facility similar in spirit to the conditional
1068: compilation features of the C preprocessor which allows key
1069: bindings and variable settings to be performed as the result
1070: of tests. There are four parser directives used.
1071: </P><P>
1072:
1073: <DL COMPACT>
1074: <DT><CODE>$if</CODE>
1075: <DD>The <CODE>$if</CODE> construct allows bindings to be made based on the
1076: editing mode, the terminal being used, or the application using
1077: Readline. The text of the test extends to the end of the line;
1078: no characters are required to isolate it.
1079: <P>
1080:
1081: <DL COMPACT>
1082: <DT><CODE>mode</CODE>
1083: <DD>The <CODE>mode=</CODE> form of the <CODE>$if</CODE> directive is used to test
1084: whether Readline is in <CODE>emacs</CODE> or <CODE>vi</CODE> mode.
1085: This may be used in conjunction
1086: with the <SAMP>`set keymap'</SAMP> command, for instance, to set bindings in
1087: the <CODE>emacs-standard</CODE> and <CODE>emacs-ctlx</CODE> keymaps only if
1088: Readline is starting out in <CODE>emacs</CODE> mode.
1089: <P>
1090:
1091: <DT><CODE>term</CODE>
1092: <DD>The <CODE>term=</CODE> form may be used to include terminal-specific
1093: key bindings, perhaps to bind the key sequences output by the
1094: terminal's function keys. The word on the right side of the
1095: <SAMP>`='</SAMP> is tested against both the full name of the terminal and
1096: the portion of the terminal name before the first <SAMP>`-'</SAMP>. This
1097: allows <CODE>sun</CODE> to match both <CODE>sun</CODE> and <CODE>sun-cmd</CODE>,
1098: for instance.
1099: <P>
1100:
1101: <DT><CODE>application</CODE>
1102: <DD>The <VAR>application</VAR> construct is used to include
1103: application-specific settings. Each program using the Readline
1104: library sets the <VAR>application name</VAR>, and you can test for
1105: a particular value.
1106: This could be used to bind key sequences to functions useful for
1107: a specific program. For instance, the following command adds a
1108: key sequence that quotes the current or previous word in Bash:
1109: <TABLE><tr><td> </td><td class=example><pre>$if Bash
1110: # Quote the current or previous word
1111: "\C-xq": "\eb\"\ef\""
1112: $endif
1113: </pre></td></tr></table></DL>
1114: <P>
1115:
1116: <DT><CODE>$endif</CODE>
1117: <DD>This command, as seen in the previous example, terminates an
1118: <CODE>$if</CODE> command.
1119: <P>
1120:
1121: <DT><CODE>$else</CODE>
1122: <DD>Commands in this branch of the <CODE>$if</CODE> directive are executed if
1123: the test fails.
1124: <P>
1125:
1126: <DT><CODE>$include</CODE>
1127: <DD>This directive takes a single filename as an argument and reads commands
1128: and bindings from that file.
1129: For example, the following directive reads from <TT>`/etc/inputrc'</TT>:
1130: <TABLE><tr><td> </td><td class=example><pre>$include /etc/inputrc
1131: </pre></td></tr></table></DL>
1132: <P>
1133:
1134: <A NAME="Sample Init File"></A>
1135: <HR SIZE="6">
1136: <A NAME="SEC12"></A>
1137: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1138: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC11"> < </A>]</TD>
1139: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> > </A>]</TD>
1140: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> << </A>]</TD>
1141: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC9"> Up </A>]</TD>
1142: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> >> </A>]</TD>
1143: <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>
1144: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1145: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1146: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1147: </TR></TABLE>
1148: <H3> 1.3.3 Sample Init File </H3>
1149: <!--docid::SEC12::-->
1150: <P>
1151:
1152: Here is an example of an <VAR>inputrc</VAR> file. This illustrates key
1153: binding, variable assignment, and conditional syntax.
1154: </P><P>
1155:
1156: <TABLE><tr><td> </td><td class=example><pre># This file controls the behaviour of line input editing for
1157: # programs that use the GNU Readline library. Existing
1158: # programs include FTP, Bash, and GDB.
1159: #
1160: # You can re-read the inputrc file with C-x C-r.
1161: # Lines beginning with '#' are comments.
1162: #
1163: # First, include any system-wide bindings and variable
1164: # assignments from /etc/Inputrc
1165: $include /etc/Inputrc
1166:
1167: #
1168: # Set various bindings for emacs mode.
1169:
1170: set editing-mode emacs
1171:
1172: $if mode=emacs
1173:
1174: Meta-Control-h: backward-kill-word Text after the function name is ignored
1175:
1176: #
1177: # Arrow keys in keypad mode
1178: #
1179: #"\M-OD": backward-char
1180: #"\M-OC": forward-char
1181: #"\M-OA": previous-history
1182: #"\M-OB": next-history
1183: #
1184: # Arrow keys in ANSI mode
1185: #
1186: "\M-[D": backward-char
1187: "\M-[C": forward-char
1188: "\M-[A": previous-history
1189: "\M-[B": next-history
1190: #
1191: # Arrow keys in 8 bit keypad mode
1192: #
1193: #"\M-\C-OD": backward-char
1194: #"\M-\C-OC": forward-char
1195: #"\M-\C-OA": previous-history
1196: #"\M-\C-OB": next-history
1197: #
1198: # Arrow keys in 8 bit ANSI mode
1199: #
1200: #"\M-\C-[D": backward-char
1201: #"\M-\C-[C": forward-char
1202: #"\M-\C-[A": previous-history
1203: #"\M-\C-[B": next-history
1204:
1205: C-q: quoted-insert
1206:
1207: $endif
1208:
1209: # An old-style binding. This happens to be the default.
1210: TAB: complete
1211:
1212: # Macros that are convenient for shell interaction
1213: $if Bash
1214: # edit the path
1215: "\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f"
1216: # prepare to type a quoted word --
1217: # insert open and close double quotes
1218: # and move to just after the open quote
1219: "\C-x\"": "\"\"\C-b"
1220: # insert a backslash (testing backslash escapes
1221: # in sequences and macros)
1222: "\C-x\\": "\\"
1223: # Quote the current or previous word
1224: "\C-xq": "\eb\"\ef\""
1225: # Add a binding to refresh the line, which is unbound
1226: "\C-xr": redraw-current-line
1227: # Edit variable on current line.
1228: "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
1229: $endif
1230:
1231: # use a visible bell if one is available
1232: set bell-style visible
1233:
1234: # don't strip characters to 7 bits when reading
1235: set input-meta on
1236:
1237: # allow iso-latin1 characters to be inserted rather
1238: # than converted to prefix-meta sequences
1239: set convert-meta off
1240:
1241: # display characters with the eighth bit set directly
1242: # rather than as meta-prefixed characters
1243: set output-meta on
1244:
1245: # if there are more than 150 possible completions for
1246: # a word, ask the user if he wants to see all of them
1247: set completion-query-items 150
1248:
1249: # For FTP
1250: $if Ftp
1251: "\C-xg": "get \M-?"
1252: "\C-xt": "put \M-?"
1253: "\M-.": yank-last-arg
1254: $endif
1255: </pre></td></tr></table></P><P>
1256:
1257: <A NAME="Bindable Readline Commands"></A>
1258: <HR SIZE="6">
1259: <A NAME="SEC13"></A>
1260: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1261: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC12"> < </A>]</TD>
1262: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC14"> > </A>]</TD>
1263: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> << </A>]</TD>
1264: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD>
1265: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1266: <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>
1267: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1268: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1269: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1270: </TR></TABLE>
1271: <H2> 1.4 Bindable Readline Commands </H2>
1272: <!--docid::SEC13::-->
1273: <P>
1274:
1275: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
1276: <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>
1277: <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>
1278: <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>
1279: <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>
1280: <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>
1281: <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>
1282: <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>
1283: <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>
1284: </TABLE></BLOCKQUOTE>
1285: <P>
1286:
1287: This section describes Readline commands that may be bound to key
1288: sequences.
1289: Command names without an accompanying key sequence are unbound by default.
1290: </P><P>
1291:
1292: In the following descriptions, <EM>point</EM> refers to the current cursor
1293: position, and <EM>mark</EM> refers to a cursor position saved by the
1294: <CODE>set-mark</CODE> command.
1295: The text between the point and mark is referred to as the <EM>region</EM>.
1296: </P><P>
1297:
1298: <A NAME="Commands For Moving"></A>
1299: <HR SIZE="6">
1300: <A NAME="SEC14"></A>
1301: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1302: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> < </A>]</TD>
1303: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC15"> > </A>]</TD>
1304: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> << </A>]</TD>
1305: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1306: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1307: <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>
1308: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1309: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1310: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1311: </TR></TABLE>
1312: <H3> 1.4.1 Commands For Moving </H3>
1313: <!--docid::SEC14::-->
1314: <DL COMPACT>
1315: <A NAME="IDX38"></A>
1316: <DT><CODE>beginning-of-line (C-a)</CODE>
1317: <DD><A NAME="IDX39"></A>
1318: Move to the start of the current line.
1319: <P>
1320:
1321: <A NAME="IDX40"></A>
1322: <DT><CODE>end-of-line (C-e)</CODE>
1323: <DD><A NAME="IDX41"></A>
1324: Move to the end of the line.
1325: <P>
1326:
1327: <A NAME="IDX42"></A>
1328: <DT><CODE>forward-char (C-f)</CODE>
1329: <DD><A NAME="IDX43"></A>
1330: Move forward a character.
1331: <P>
1332:
1333: <A NAME="IDX44"></A>
1334: <DT><CODE>backward-char (C-b)</CODE>
1335: <DD><A NAME="IDX45"></A>
1336: Move back a character.
1337: <P>
1338:
1339: <A NAME="IDX46"></A>
1340: <DT><CODE>forward-word (M-f)</CODE>
1341: <DD><A NAME="IDX47"></A>
1342: Move forward to the end of the next word.
1343: Words are composed of letters and digits.
1344: <P>
1345:
1346: <A NAME="IDX48"></A>
1347: <DT><CODE>backward-word (M-b)</CODE>
1348: <DD><A NAME="IDX49"></A>
1349: Move back to the start of the current or previous word.
1350: Words are composed of letters and digits.
1351: <P>
1352:
1353: <A NAME="IDX50"></A>
1354: <DT><CODE>clear-screen (C-l)</CODE>
1355: <DD><A NAME="IDX51"></A>
1356: Clear the screen and redraw the current line,
1357: leaving the current line at the top of the screen.
1358: <P>
1359:
1360: <A NAME="IDX52"></A>
1361: <DT><CODE>redraw-current-line ()</CODE>
1362: <DD><A NAME="IDX53"></A>
1363: Refresh the current line. By default, this is unbound.
1364: <P>
1365:
1366: </DL>
1367: <P>
1368:
1369: <A NAME="Commands For History"></A>
1370: <HR SIZE="6">
1371: <A NAME="SEC15"></A>
1372: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1373: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC14"> < </A>]</TD>
1374: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC16"> > </A>]</TD>
1375: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC16"> << </A>]</TD>
1376: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1377: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1378: <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>
1379: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1380: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1381: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1382: </TR></TABLE>
1383: <H3> 1.4.2 Commands For Manipulating The History </H3>
1384: <!--docid::SEC15::-->
1385: <P>
1386:
1387: <DL COMPACT>
1388: <A NAME="IDX54"></A>
1389: <DT><CODE>accept-line (Newline or Return)</CODE>
1390: <DD><A NAME="IDX55"></A>
1391: Accept the line regardless of where the cursor is.
1392: If this line is
1393: non-empty, it may be added to the history list for future recall with
1394: <CODE>add_history()</CODE>.
1395: If this line is a modified history line, the history line is restored
1396: to its original state.
1397: <P>
1398:
1399: <A NAME="IDX56"></A>
1400: <DT><CODE>previous-history (C-p)</CODE>
1401: <DD><A NAME="IDX57"></A>
1402: Move `back' through the history list, fetching the previous command.
1403: <P>
1404:
1405: <A NAME="IDX58"></A>
1406: <DT><CODE>next-history (C-n)</CODE>
1407: <DD><A NAME="IDX59"></A>
1408: Move `forward' through the history list, fetching the next command.
1409: <P>
1410:
1411: <A NAME="IDX60"></A>
1412: <DT><CODE>beginning-of-history (M-<)</CODE>
1413: <DD><A NAME="IDX61"></A>
1414: Move to the first line in the history.
1415: <P>
1416:
1417: <A NAME="IDX62"></A>
1418: <DT><CODE>end-of-history (M->)</CODE>
1419: <DD><A NAME="IDX63"></A>
1420: Move to the end of the input history, i.e., the line currently
1421: being entered.
1422: <P>
1423:
1424: <A NAME="IDX64"></A>
1425: <DT><CODE>reverse-search-history (C-r)</CODE>
1426: <DD><A NAME="IDX65"></A>
1427: Search backward starting at the current line and moving `up' through
1428: the history as necessary. This is an incremental search.
1429: <P>
1430:
1431: <A NAME="IDX66"></A>
1432: <DT><CODE>forward-search-history (C-s)</CODE>
1433: <DD><A NAME="IDX67"></A>
1434: Search forward starting at the current line and moving `down' through
1435: the the history as necessary. This is an incremental search.
1436: <P>
1437:
1438: <A NAME="IDX68"></A>
1439: <DT><CODE>non-incremental-reverse-search-history (M-p)</CODE>
1440: <DD><A NAME="IDX69"></A>
1441: Search backward starting at the current line and moving `up'
1442: through the history as necessary using a non-incremental search
1443: for a string supplied by the user.
1444: <P>
1445:
1446: <A NAME="IDX70"></A>
1447: <DT><CODE>non-incremental-forward-search-history (M-n)</CODE>
1448: <DD><A NAME="IDX71"></A>
1449: Search forward starting at the current line and moving `down'
1450: through the the history as necessary using a non-incremental search
1451: for a string supplied by the user.
1452: <P>
1453:
1454: <A NAME="IDX72"></A>
1455: <DT><CODE>history-search-forward ()</CODE>
1456: <DD><A NAME="IDX73"></A>
1457: Search forward through the history for the string of characters
1458: between the start of the current line and the point.
1459: The search string must match at the beginning of a history line.
1460: This is a non-incremental search.
1461: By default, this command is unbound.
1462: <P>
1463:
1464: <A NAME="IDX74"></A>
1465: <DT><CODE>history-search-backward ()</CODE>
1466: <DD><A NAME="IDX75"></A>
1467: Search backward through the history for the string of characters
1468: between the start of the current line and the point.
1469: The search string must match at the beginning of a history line.
1470: This is a non-incremental search.
1471: By default, this command is unbound.
1472: <P>
1473:
1474: <A NAME="IDX76"></A>
1475: <DT><CODE>history-substr-search-forward ()</CODE>
1476: <DD><A NAME="IDX77"></A>
1477: Search forward through the history for the string of characters
1478: between the start of the current line and the point.
1479: The search string may match anywhere in a history line.
1480: This is a non-incremental search.
1481: By default, this command is unbound.
1482: <P>
1483:
1484: <A NAME="IDX78"></A>
1485: <DT><CODE>history-substr-search-backward ()</CODE>
1486: <DD><A NAME="IDX79"></A>
1487: Search backward through the history for the string of characters
1488: between the start of the current line and the point.
1489: The search string may match anywhere in a history line.
1490: This is a non-incremental search.
1491: By default, this command is unbound.
1492: <P>
1493:
1494: <A NAME="IDX80"></A>
1495: <DT><CODE>yank-nth-arg (M-C-y)</CODE>
1496: <DD><A NAME="IDX81"></A>
1497: Insert the first argument to the previous command (usually
1498: the second word on the previous line) at point.
1499: With an argument <VAR>n</VAR>,
1500: insert the <VAR>n</VAR>th word from the previous command (the words
1501: in the previous command begin with word 0). A negative argument
1502: inserts the <VAR>n</VAR>th word from the end of the previous command.
1503: Once the argument <VAR>n</VAR> is computed, the argument is extracted
1504: as if the <SAMP>`!<VAR>n</VAR>'</SAMP> history expansion had been specified.
1505: <P>
1506:
1507: <A NAME="IDX82"></A>
1508: <DT><CODE>yank-last-arg (M-. or M-_)</CODE>
1509: <DD><A NAME="IDX83"></A>
1510: Insert last argument to the previous command (the last word of the
1511: previous history entry).
1512: With a numeric argument, behave exactly like <CODE>yank-nth-arg</CODE>.
1513: Successive calls to <CODE>yank-last-arg</CODE> move back through the history
1514: list, inserting the last word (or the word specified by the argument to
1515: the first call) of each line in turn.
1516: Any numeric argument supplied to these successive calls determines
1517: the direction to move through the history. A negative argument switches
1518: the direction through the history (back or forward).
1519: The history expansion facilities are used to extract the last argument,
1520: as if the <SAMP>`!$'</SAMP> history expansion had been specified.
1521: <P>
1522:
1523: </DL>
1524: <P>
1525:
1526: <A NAME="Commands For Text"></A>
1527: <HR SIZE="6">
1528: <A NAME="SEC16"></A>
1529: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1530: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC15"> < </A>]</TD>
1531: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC17"> > </A>]</TD>
1532: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC17"> << </A>]</TD>
1533: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1534: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1535: <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>
1536: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1537: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1538: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1539: </TR></TABLE>
1540: <H3> 1.4.3 Commands For Changing Text </H3>
1541: <!--docid::SEC16::-->
1542: <P>
1543:
1544: <DL COMPACT>
1545:
1546: <A NAME="IDX84"></A>
1547: <DT><CODE><I>end-of-file</I> (usually C-d)</CODE>
1548: <DD><A NAME="IDX85"></A>
1549: The character indicating end-of-file as set, for example, by
1550: <CODE>stty</CODE>. If this character is read when there are no characters
1551: on the line, and point is at the beginning of the line, Readline
1552: interprets it as the end of input and returns EOF.
1553: <P>
1554:
1555: <A NAME="IDX86"></A>
1556: <DT><CODE>delete-char (C-d)</CODE>
1557: <DD><A NAME="IDX87"></A>
1558: Delete the character at point. If this function is bound to the
1559: same character as the tty EOF character, as <KBD>C-d</KBD>
1560: commonly is, see above for the effects.
1561: <P>
1562:
1563: <A NAME="IDX88"></A>
1564: <DT><CODE>backward-delete-char (Rubout)</CODE>
1565: <DD><A NAME="IDX89"></A>
1566: Delete the character behind the cursor. A numeric argument means
1567: to kill the characters instead of deleting them.
1568: <P>
1569:
1570: <A NAME="IDX90"></A>
1571: <DT><CODE>forward-backward-delete-char ()</CODE>
1572: <DD><A NAME="IDX91"></A>
1573: Delete the character under the cursor, unless the cursor is at the
1574: end of the line, in which case the character behind the cursor is
1575: deleted. By default, this is not bound to a key.
1576: <P>
1577:
1578: <A NAME="IDX92"></A>
1579: <DT><CODE>quoted-insert (C-q or C-v)</CODE>
1580: <DD><A NAME="IDX93"></A>
1581: Add the next character typed to the line verbatim. This is
1582: how to insert key sequences like <KBD>C-q</KBD>, for example.
1583: <P>
1584:
1585: <A NAME="IDX94"></A>
1586: <DT><CODE>tab-insert (M-<KBD>TAB</KBD>)</CODE>
1587: <DD><A NAME="IDX95"></A>
1588: Insert a tab character.
1589: <P>
1590:
1591: <A NAME="IDX96"></A>
1592: <DT><CODE>self-insert (a, b, A, 1, !, <small>...</small>)</CODE>
1593: <DD><A NAME="IDX97"></A>
1594: Insert yourself.
1595: <P>
1596:
1597: <A NAME="IDX98"></A>
1598: <DT><CODE>transpose-chars (C-t)</CODE>
1599: <DD><A NAME="IDX99"></A>
1600: Drag the character before the cursor forward over
1601: the character at the cursor, moving the
1602: cursor forward as well. If the insertion point
1603: is at the end of the line, then this
1604: transposes the last two characters of the line.
1605: Negative arguments have no effect.
1606: <P>
1607:
1608: <A NAME="IDX100"></A>
1609: <DT><CODE>transpose-words (M-t)</CODE>
1610: <DD><A NAME="IDX101"></A>
1611: Drag the word before point past the word after point,
1612: moving point past that word as well.
1613: If the insertion point is at the end of the line, this transposes
1614: the last two words on the line.
1615: <P>
1616:
1617: <A NAME="IDX102"></A>
1618: <DT><CODE>upcase-word (M-u)</CODE>
1619: <DD><A NAME="IDX103"></A>
1620: Uppercase the current (or following) word. With a negative argument,
1621: uppercase the previous word, but do not move the cursor.
1622: <P>
1623:
1624: <A NAME="IDX104"></A>
1625: <DT><CODE>downcase-word (M-l)</CODE>
1626: <DD><A NAME="IDX105"></A>
1627: Lowercase the current (or following) word. With a negative argument,
1628: lowercase the previous word, but do not move the cursor.
1629: <P>
1630:
1631: <A NAME="IDX106"></A>
1632: <DT><CODE>capitalize-word (M-c)</CODE>
1633: <DD><A NAME="IDX107"></A>
1634: Capitalize the current (or following) word. With a negative argument,
1635: capitalize the previous word, but do not move the cursor.
1636: <P>
1637:
1638: <A NAME="IDX108"></A>
1639: <DT><CODE>overwrite-mode ()</CODE>
1640: <DD><A NAME="IDX109"></A>
1641: Toggle overwrite mode. With an explicit positive numeric argument,
1642: switches to overwrite mode. With an explicit non-positive numeric
1643: argument, switches to insert mode. This command affects only
1644: <CODE>emacs</CODE> mode; <CODE>vi</CODE> mode does overwrite differently.
1645: Each call to <CODE>readline()</CODE> starts in insert mode.
1646: <P>
1647:
1648: In overwrite mode, characters bound to <CODE>self-insert</CODE> replace
1649: the text at point rather than pushing the text to the right.
1650: Characters bound to <CODE>backward-delete-char</CODE> replace the character
1651: before point with a space.
1652: </P><P>
1653:
1654: By default, this command is unbound.
1655: </P><P>
1656:
1657: </DL>
1658: <P>
1659:
1660: <A NAME="Commands For Killing"></A>
1661: <HR SIZE="6">
1662: <A NAME="SEC17"></A>
1663: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1664: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC16"> < </A>]</TD>
1665: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC18"> > </A>]</TD>
1666: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC18"> << </A>]</TD>
1667: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1668: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1669: <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>
1670: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1671: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1672: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1673: </TR></TABLE>
1674: <H3> 1.4.4 Killing And Yanking </H3>
1675: <!--docid::SEC17::-->
1676: <P>
1677:
1678: <DL COMPACT>
1679:
1680: <A NAME="IDX110"></A>
1681: <DT><CODE>kill-line (C-k)</CODE>
1682: <DD><A NAME="IDX111"></A>
1683: Kill the text from point to the end of the line.
1684: <P>
1685:
1686: <A NAME="IDX112"></A>
1687: <DT><CODE>backward-kill-line (C-x Rubout)</CODE>
1688: <DD><A NAME="IDX113"></A>
1689: Kill backward to the beginning of the line.
1690: <P>
1691:
1692: <A NAME="IDX114"></A>
1693: <DT><CODE>unix-line-discard (C-u)</CODE>
1694: <DD><A NAME="IDX115"></A>
1695: Kill backward from the cursor to the beginning of the current line.
1696: <P>
1697:
1698: <A NAME="IDX116"></A>
1699: <DT><CODE>kill-whole-line ()</CODE>
1700: <DD><A NAME="IDX117"></A>
1701: Kill all characters on the current line, no matter where point is.
1702: By default, this is unbound.
1703: <P>
1704:
1705: <A NAME="IDX118"></A>
1706: <DT><CODE>kill-word (M-d)</CODE>
1707: <DD><A NAME="IDX119"></A>
1708: Kill from point to the end of the current word, or if between
1709: words, to the end of the next word.
1710: Word boundaries are the same as <CODE>forward-word</CODE>.
1711: <P>
1712:
1713: <A NAME="IDX120"></A>
1714: <DT><CODE>backward-kill-word (M-<KBD>DEL</KBD>)</CODE>
1715: <DD><A NAME="IDX121"></A>
1716: Kill the word behind point.
1717: Word boundaries are the same as <CODE>backward-word</CODE>.
1718: <P>
1719:
1720: <A NAME="IDX122"></A>
1721: <DT><CODE>unix-word-rubout (C-w)</CODE>
1722: <DD><A NAME="IDX123"></A>
1723: Kill the word behind point, using white space as a word boundary.
1724: The killed text is saved on the kill-ring.
1725: <P>
1726:
1727: <A NAME="IDX124"></A>
1728: <DT><CODE>unix-filename-rubout ()</CODE>
1729: <DD><A NAME="IDX125"></A>
1730: Kill the word behind point, using white space and the slash character
1731: as the word boundaries.
1732: The killed text is saved on the kill-ring.
1733: <P>
1734:
1735: <A NAME="IDX126"></A>
1736: <DT><CODE>delete-horizontal-space ()</CODE>
1737: <DD><A NAME="IDX127"></A>
1738: Delete all spaces and tabs around point. By default, this is unbound.
1739: <P>
1740:
1741: <A NAME="IDX128"></A>
1742: <DT><CODE>kill-region ()</CODE>
1743: <DD><A NAME="IDX129"></A>
1744: Kill the text in the current region.
1745: By default, this command is unbound.
1746: <P>
1747:
1748: <A NAME="IDX130"></A>
1749: <DT><CODE>copy-region-as-kill ()</CODE>
1750: <DD><A NAME="IDX131"></A>
1751: Copy the text in the region to the kill buffer, so it can be yanked
1752: right away. By default, this command is unbound.
1753: <P>
1754:
1755: <A NAME="IDX132"></A>
1756: <DT><CODE>copy-backward-word ()</CODE>
1757: <DD><A NAME="IDX133"></A>
1758: Copy the word before point to the kill buffer.
1759: The word boundaries are the same as <CODE>backward-word</CODE>.
1760: By default, this command is unbound.
1761: <P>
1762:
1763: <A NAME="IDX134"></A>
1764: <DT><CODE>copy-forward-word ()</CODE>
1765: <DD><A NAME="IDX135"></A>
1766: Copy the word following point to the kill buffer.
1767: The word boundaries are the same as <CODE>forward-word</CODE>.
1768: By default, this command is unbound.
1769: <P>
1770:
1771: <A NAME="IDX136"></A>
1772: <DT><CODE>yank (C-y)</CODE>
1773: <DD><A NAME="IDX137"></A>
1774: Yank the top of the kill ring into the buffer at point.
1775: <P>
1776:
1777: <A NAME="IDX138"></A>
1778: <DT><CODE>yank-pop (M-y)</CODE>
1779: <DD><A NAME="IDX139"></A>
1780: Rotate the kill-ring, and yank the new top. You can only do this if
1781: the prior command is <CODE>yank</CODE> or <CODE>yank-pop</CODE>.
1782: </DL>
1783: <P>
1784:
1785: <A NAME="Numeric Arguments"></A>
1786: <HR SIZE="6">
1787: <A NAME="SEC18"></A>
1788: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1789: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC17"> < </A>]</TD>
1790: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC19"> > </A>]</TD>
1791: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC19"> << </A>]</TD>
1792: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1793: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1794: <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>
1795: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1796: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1797: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1798: </TR></TABLE>
1799: <H3> 1.4.5 Specifying Numeric Arguments </H3>
1800: <!--docid::SEC18::-->
1801: <DL COMPACT>
1802:
1803: <A NAME="IDX140"></A>
1804: <DT><CODE>digit-argument (<KBD>M-0</KBD>, <KBD>M-1</KBD>, <small>...</small> <KBD>M--</KBD>)</CODE>
1805: <DD><A NAME="IDX141"></A>
1806: Add this digit to the argument already accumulating, or start a new
1807: argument. <KBD>M--</KBD> starts a negative argument.
1808: <P>
1809:
1810: <A NAME="IDX142"></A>
1811: <DT><CODE>universal-argument ()</CODE>
1812: <DD><A NAME="IDX143"></A>
1813: This is another way to specify an argument.
1814: If this command is followed by one or more digits, optionally with a
1815: leading minus sign, those digits define the argument.
1816: If the command is followed by digits, executing <CODE>universal-argument</CODE>
1817: again ends the numeric argument, but is otherwise ignored.
1818: As a special case, if this command is immediately followed by a
1819: character that is neither a digit or minus sign, the argument count
1820: for the next command is multiplied by four.
1821: The argument count is initially one, so executing this function the
1822: first time makes the argument count four, a second time makes the
1823: argument count sixteen, and so on.
1824: By default, this is not bound to a key.
1825: </DL>
1826: <P>
1827:
1828: <A NAME="Commands For Completion"></A>
1829: <HR SIZE="6">
1830: <A NAME="SEC19"></A>
1831: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1832: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC18"> < </A>]</TD>
1833: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC20"> > </A>]</TD>
1834: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC20"> << </A>]</TD>
1835: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1836: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1837: <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>
1838: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1839: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1840: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1841: </TR></TABLE>
1842: <H3> 1.4.6 Letting Readline Type For You </H3>
1843: <!--docid::SEC19::-->
1844: <P>
1845:
1846: <DL COMPACT>
1847: <A NAME="IDX144"></A>
1848: <DT><CODE>complete (<KBD>TAB</KBD>)</CODE>
1849: <DD><A NAME="IDX145"></A>
1850: Attempt to perform completion on the text before point.
1851: The actual completion performed is application-specific.
1852: The default is filename completion.
1853: <P>
1854:
1855: <A NAME="IDX146"></A>
1856: <DT><CODE>possible-completions (M-?)</CODE>
1857: <DD><A NAME="IDX147"></A>
1858: List the possible completions of the text before point.
1859: When displaying completions, Readline sets the number of columns used
1860: for display to the value of <CODE>completion-display-width</CODE>, the value of
1861: the environment variable <CODE>COLUMNS</CODE>, or the screen width, in that order.
1862: <P>
1863:
1864: <A NAME="IDX148"></A>
1865: <DT><CODE>insert-completions (M-*)</CODE>
1866: <DD><A NAME="IDX149"></A>
1867: Insert all completions of the text before point that would have
1868: been generated by <CODE>possible-completions</CODE>.
1869: <P>
1870:
1871: <A NAME="IDX150"></A>
1872: <DT><CODE>menu-complete ()</CODE>
1873: <DD><A NAME="IDX151"></A>
1874: Similar to <CODE>complete</CODE>, but replaces the word to be completed
1875: with a single match from the list of possible completions.
1876: Repeated execution of <CODE>menu-complete</CODE> steps through the list
1877: of possible completions, inserting each match in turn.
1878: At the end of the list of completions, the bell is rung
1879: (subject to the setting of <CODE>bell-style</CODE>)
1880: and the original text is restored.
1881: An argument of <VAR>n</VAR> moves <VAR>n</VAR> positions forward in the list
1882: of matches; a negative argument may be used to move backward
1883: through the list.
1884: This command is intended to be bound to <KBD>TAB</KBD>, but is unbound
1885: by default.
1886: <P>
1887:
1888: <A NAME="IDX152"></A>
1889: <DT><CODE>menu-complete-backward ()</CODE>
1890: <DD><A NAME="IDX153"></A>
1891: Identical to <CODE>menu-complete</CODE>, but moves backward through the list
1892: of possible completions, as if <CODE>menu-complete</CODE> had been given a
1893: negative argument.
1894: <P>
1895:
1896: <A NAME="IDX154"></A>
1897: <DT><CODE>delete-char-or-list ()</CODE>
1898: <DD><A NAME="IDX155"></A>
1899: Deletes the character under the cursor if not at the beginning or
1900: end of the line (like <CODE>delete-char</CODE>).
1901: If at the end of the line, behaves identically to
1902: <CODE>possible-completions</CODE>.
1903: This command is unbound by default.
1904: <P>
1905:
1906: </DL>
1907: <P>
1908:
1909: <A NAME="Keyboard Macros"></A>
1910: <HR SIZE="6">
1911: <A NAME="SEC20"></A>
1912: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1913: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC19"> < </A>]</TD>
1914: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC21"> > </A>]</TD>
1915: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC21"> << </A>]</TD>
1916: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1917: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1918: <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>
1919: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1920: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1921: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1922: </TR></TABLE>
1923: <H3> 1.4.7 Keyboard Macros </H3>
1924: <!--docid::SEC20::-->
1925: <DL COMPACT>
1926:
1927: <A NAME="IDX156"></A>
1928: <DT><CODE>start-kbd-macro (C-x ()</CODE>
1929: <DD><A NAME="IDX157"></A>
1930: Begin saving the characters typed into the current keyboard macro.
1931: <P>
1932:
1933: <A NAME="IDX158"></A>
1934: <DT><CODE>end-kbd-macro (C-x ))</CODE>
1935: <DD><A NAME="IDX159"></A>
1936: Stop saving the characters typed into the current keyboard macro
1937: and save the definition.
1938: <P>
1939:
1940: <A NAME="IDX160"></A>
1941: <DT><CODE>call-last-kbd-macro (C-x e)</CODE>
1942: <DD><A NAME="IDX161"></A>
1943: Re-execute the last keyboard macro defined, by making the characters
1944: in the macro appear as if typed at the keyboard.
1945: <P>
1946:
1947: <A NAME="IDX162"></A>
1948: <DT><CODE>print-last-kbd-macro ()</CODE>
1949: <DD><A NAME="IDX163"></A>
1950: Print the last keboard macro defined in a format suitable for the
1951: <VAR>inputrc</VAR> file.
1952: <P>
1953:
1954: </DL>
1955: <P>
1956:
1957: <A NAME="Miscellaneous Commands"></A>
1958: <HR SIZE="6">
1959: <A NAME="SEC21"></A>
1960: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
1961: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC20"> < </A>]</TD>
1962: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> > </A>]</TD>
1963: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> << </A>]</TD>
1964: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC13"> Up </A>]</TD>
1965: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> >> </A>]</TD>
1966: <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>
1967: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
1968: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
1969: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
1970: </TR></TABLE>
1971: <H3> 1.4.8 Some Miscellaneous Commands </H3>
1972: <!--docid::SEC21::-->
1973: <DL COMPACT>
1974:
1975: <A NAME="IDX164"></A>
1976: <DT><CODE>re-read-init-file (C-x C-r)</CODE>
1977: <DD><A NAME="IDX165"></A>
1978: Read in the contents of the <VAR>inputrc</VAR> file, and incorporate
1979: any bindings or variable assignments found there.
1980: <P>
1981:
1982: <A NAME="IDX166"></A>
1983: <DT><CODE>abort (C-g)</CODE>
1984: <DD><A NAME="IDX167"></A>
1985: Abort the current editing command and
1986: ring the terminal's bell (subject to the setting of
1987: <CODE>bell-style</CODE>).
1988: <P>
1989:
1990: <A NAME="IDX168"></A>
1991: <DT><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, <small>...</small>)</CODE>
1992: <DD><A NAME="IDX169"></A>
1993: If the metafied character <VAR>x</VAR> is lowercase, run the command
1994: that is bound to the corresponding uppercase character.
1995: <P>
1996:
1997: <A NAME="IDX170"></A>
1998: <DT><CODE>prefix-meta (<KBD>ESC</KBD>)</CODE>
1999: <DD><A NAME="IDX171"></A>
2000: Metafy the next character typed. This is for keyboards
2001: without a meta key. Typing <SAMP>`<KBD>ESC</KBD> f'</SAMP> is equivalent to typing
2002: <KBD>M-f</KBD>.
2003: <P>
2004:
2005: <A NAME="IDX172"></A>
2006: <DT><CODE>undo (C-_ or C-x C-u)</CODE>
2007: <DD><A NAME="IDX173"></A>
2008: Incremental undo, separately remembered for each line.
2009: <P>
2010:
2011: <A NAME="IDX174"></A>
2012: <DT><CODE>revert-line (M-r)</CODE>
2013: <DD><A NAME="IDX175"></A>
2014: Undo all changes made to this line. This is like executing the <CODE>undo</CODE>
2015: command enough times to get back to the beginning.
2016: <P>
2017:
2018: <A NAME="IDX176"></A>
2019: <DT><CODE>tilde-expand (M-~)</CODE>
2020: <DD><A NAME="IDX177"></A>
2021: Perform tilde expansion on the current word.
2022: <P>
2023:
2024: <A NAME="IDX178"></A>
2025: <DT><CODE>set-mark (C-@)</CODE>
2026: <DD><A NAME="IDX179"></A>
2027: Set the mark to the point. If a
2028: numeric argument is supplied, the mark is set to that position.
2029: <P>
2030:
2031: <A NAME="IDX180"></A>
2032: <DT><CODE>exchange-point-and-mark (C-x C-x)</CODE>
2033: <DD><A NAME="IDX181"></A>
2034: Swap the point with the mark. The current cursor position is set to
2035: the saved position, and the old cursor position is saved as the mark.
2036: <P>
2037:
2038: <A NAME="IDX182"></A>
2039: <DT><CODE>character-search (C-])</CODE>
2040: <DD><A NAME="IDX183"></A>
2041: A character is read and point is moved to the next occurrence of that
2042: character. A negative count searches for previous occurrences.
2043: <P>
2044:
2045: <A NAME="IDX184"></A>
2046: <DT><CODE>character-search-backward (M-C-])</CODE>
2047: <DD><A NAME="IDX185"></A>
2048: A character is read and point is moved to the previous occurrence
2049: of that character. A negative count searches for subsequent
2050: occurrences.
2051: <P>
2052:
2053: <A NAME="IDX186"></A>
2054: <DT><CODE>skip-csi-sequence ()</CODE>
2055: <DD><A NAME="IDX187"></A>
2056: Read enough characters to consume a multi-key sequence such as those
2057: defined for keys like Home and End. Such sequences begin with a
2058: Control Sequence Indicator (CSI), usually ESC-[. If this sequence is
2059: bound to "\e[", keys producing such sequences will have no effect
2060: unless explicitly bound to a readline command, instead of inserting
2061: stray characters into the editing buffer. This is unbound by default,
2062: but usually bound to ESC-[.
2063: <P>
2064:
2065: <A NAME="IDX188"></A>
2066: <DT><CODE>insert-comment (M-#)</CODE>
2067: <DD><A NAME="IDX189"></A>
2068: Without a numeric argument, the value of the <CODE>comment-begin</CODE>
2069: variable is inserted at the beginning of the current line.
2070: If a numeric argument is supplied, this command acts as a toggle: if
2071: the characters at the beginning of the line do not match the value
2072: of <CODE>comment-begin</CODE>, the value is inserted, otherwise
2073: the characters in <CODE>comment-begin</CODE> are deleted from the beginning of
2074: the line.
2075: In either case, the line is accepted as if a newline had been typed.
2076: <P>
2077:
2078: <A NAME="IDX190"></A>
2079: <DT><CODE>dump-functions ()</CODE>
2080: <DD><A NAME="IDX191"></A>
2081: Print all of the functions and their key bindings to the
2082: Readline output stream. If a numeric argument is supplied,
2083: the output is formatted in such a way that it can be made part
2084: of an <VAR>inputrc</VAR> file. This command is unbound by default.
2085: <P>
2086:
2087: <A NAME="IDX192"></A>
2088: <DT><CODE>dump-variables ()</CODE>
2089: <DD><A NAME="IDX193"></A>
2090: Print all of the settable variables and their values to the
2091: Readline output stream. If a numeric argument is supplied,
2092: the output is formatted in such a way that it can be made part
2093: of an <VAR>inputrc</VAR> file. This command is unbound by default.
2094: <P>
2095:
2096: <A NAME="IDX194"></A>
2097: <DT><CODE>dump-macros ()</CODE>
2098: <DD><A NAME="IDX195"></A>
2099: Print all of the Readline key sequences bound to macros and the
2100: strings they output. If a numeric argument is supplied,
2101: the output is formatted in such a way that it can be made part
2102: of an <VAR>inputrc</VAR> file. This command is unbound by default.
2103: <P>
2104:
2105: <A NAME="IDX196"></A>
2106: <DT><CODE>emacs-editing-mode (C-e)</CODE>
2107: <DD><A NAME="IDX197"></A>
2108: When in <CODE>vi</CODE> command mode, this causes a switch to <CODE>emacs</CODE>
2109: editing mode.
2110: <P>
2111:
2112: <A NAME="IDX198"></A>
2113: <DT><CODE>vi-editing-mode (M-C-j)</CODE>
2114: <DD><A NAME="IDX199"></A>
2115: When in <CODE>emacs</CODE> editing mode, this causes a switch to <CODE>vi</CODE>
2116: editing mode.
2117: <P>
2118:
2119: </DL>
2120: <P>
2121:
2122: <A NAME="Readline vi Mode"></A>
2123: <HR SIZE="6">
2124: <A NAME="SEC22"></A>
2125: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
2126: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC21"> < </A>]</TD>
2127: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> > </A>]</TD>
2128: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
2129: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC1"> Up </A>]</TD>
2130: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> >> </A>]</TD>
2131: <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>
2132: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
2133: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
2134: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
2135: </TR></TABLE>
2136: <H2> 1.5 Readline vi Mode </H2>
2137: <!--docid::SEC22::-->
2138: <P>
2139:
2140: While the Readline library does not have a full set of <CODE>vi</CODE>
2141: editing functions, it does contain enough to allow simple editing
2142: of the line. The Readline <CODE>vi</CODE> mode behaves as specified in
2143: the POSIX standard.
2144: </P><P>
2145:
2146: In order to switch interactively between <CODE>emacs</CODE> and <CODE>vi</CODE>
2147: editing modes, use the command <KBD>M-C-j</KBD> (bound to emacs-editing-mode
2148: when in <CODE>vi</CODE> mode and to vi-editing-mode in <CODE>emacs</CODE> mode).
2149: The Readline default is <CODE>emacs</CODE> mode.
2150: </P><P>
2151:
2152: When you enter a line in <CODE>vi</CODE> mode, you are already placed in
2153: `insertion' mode, as if you had typed an <SAMP>`i'</SAMP>. Pressing <KBD>ESC</KBD>
2154: switches you into `command' mode, where you can edit the text of the
2155: line with the standard <CODE>vi</CODE> movement keys, move to previous
2156: history lines with <SAMP>`k'</SAMP> and subsequent lines with <SAMP>`j'</SAMP>, and
2157: so forth.
2158: </P><P>
2159:
2160: This document describes the GNU Readline Library, a utility for aiding
2161: in the consistency of user interface across discrete programs that need
2162: to provide a command line interface.
2163: </P><P>
2164:
2165: Copyright (C) 1988--2014 Free Software Foundation, Inc.
2166: </P><P>
2167:
2168: Permission is granted to make and distribute verbatim copies of
2169: this manual provided the copyright notice and this permission notice
2170: pare preserved on all copies.
2171: </P><P>
2172:
2173: Permission is granted to copy and distribute modified versions of this
2174: manual under the conditions for verbatim copying, provided that the entire
2175: resulting derived work is distributed under the terms of a permission
2176: notice identical to this one.
2177: </P><P>
2178:
2179: Permission is granted to copy and distribute translations of this manual
2180: into another language, under the above conditions for modified versions,
2181: except that this permission notice may be stated in a translation approved
2182: by the Foundation.
2183: </P><P>
2184:
2185: <A NAME="Programming with GNU Readline"></A>
2186: <HR SIZE="6">
2187: <A NAME="SEC23"></A>
2188: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
2189: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC22"> < </A>]</TD>
2190: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC24"> > </A>]</TD>
2191: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
2192: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD>
2193: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
2194: <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>
2195: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
2196: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
2197: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
2198: </TR></TABLE>
2199: <H1> 2. Programming with GNU Readline </H1>
2200: <!--docid::SEC23::-->
2201: <P>
2202:
2203: This chapter describes the interface between the GNU Readline Library and
2204: other programs. If you are a programmer, and you wish to include the
2205: features found in GNU Readline
2206: such as completion, line editing, and interactive history manipulation
2207: in your own programs, this section is for you.
2208: </P><P>
2209:
2210: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
2211: <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>
2212: <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>
2213: <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
2214: functions.</TD></TR>
2215: <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
2216: aid in writing your own custom
2217: functions.</TD></TR>
2218: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">How Readline behaves when it receives signals.</TD></TR>
2219: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC45">2.6 Custom Completers</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Supplanting or supplementing Readline's
2220: completion functions.</TD></TR>
2221: </TABLE></BLOCKQUOTE>
2222: <P>
2223:
2224: <A NAME="Basic Behavior"></A>
2225: <HR SIZE="6">
2226: <A NAME="SEC24"></A>
2227: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
2228: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> < </A>]</TD>
2229: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> > </A>]</TD>
2230: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
2231: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD>
2232: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
2233: <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>
2234: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
2235: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
2236: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
2237: </TR></TABLE>
2238: <H2> 2.1 Basic Behavior </H2>
2239: <!--docid::SEC24::-->
2240: <P>
2241:
2242: Many programs provide a command line interface, such as <CODE>mail</CODE>,
2243: <CODE>ftp</CODE>, and <CODE>sh</CODE>. For such programs, the default behaviour of
2244: Readline is sufficient. This section describes how to use Readline in
2245: the simplest way possible, perhaps to replace calls in your code to
2246: <CODE>gets()</CODE> or <CODE>fgets()</CODE>.
2247: </P><P>
2248:
2249: <A NAME="IDX200"></A>
2250: <A NAME="IDX201"></A>
2251: </P><P>
2252:
2253: The function <CODE>readline()</CODE> prints a prompt <VAR>prompt</VAR>
2254: and then reads and returns a single line of text from the user.
2255: If <VAR>prompt</VAR> is <CODE>NULL</CODE> or the empty string, no prompt is displayed.
2256: The line <CODE>readline</CODE> returns is allocated with <CODE>malloc()</CODE>;
2257: the caller should <CODE>free()</CODE> the line when it has finished with it.
2258: The declaration for <CODE>readline</CODE> in ANSI C is
2259: </P><P>
2260:
2261: <TABLE><tr><td> </td><td class=example><pre><CODE>char *readline (const char *<VAR>prompt</VAR>);</CODE>
2262: </pre></td></tr></table></P><P>
2263:
2264: So, one might say
2265: <TABLE><tr><td> </td><td class=example><pre><CODE>char *line = readline ("Enter a line: ");</CODE>
2266: </pre></td></tr></table>in order to read a line of text from the user.
2267: The line returned has the final newline removed, so only the
2268: text remains.
2269: </P><P>
2270:
2271: If <CODE>readline</CODE> encounters an <CODE>EOF</CODE> while reading the line, and the
2272: line is empty at that point, then <CODE>(char *)NULL</CODE> is returned.
2273: Otherwise, the line is ended just as if a newline had been typed.
2274: </P><P>
2275:
2276: If you want the user to be able to get at the line later, (with
2277: <KBD>C-p</KBD> for example), you must call <CODE>add_history()</CODE> to save the
2278: line away in a <EM>history</EM> list of such lines.
2279: </P><P>
2280:
2281: <TABLE><tr><td> </td><td class=example><pre><CODE>add_history (line)</CODE>;
2282: </pre></td></tr></table></P><P>
2283:
2284: For full details on the GNU History Library, see the associated manual.
2285: </P><P>
2286:
2287: It is preferable to avoid saving empty lines on the history list, since
2288: users rarely have a burning need to reuse a blank line. Here is
2289: a function which usefully replaces the standard <CODE>gets()</CODE> library
2290: function, and has the advantage of no static buffer to overflow:
2291: </P><P>
2292:
2293: <TABLE><tr><td> </td><td class=example><pre>/* A static variable for holding the line. */
2294: static char *line_read = (char *)NULL;
2295:
2296: /* Read a string, and return a pointer to it.
2297: Returns NULL on EOF. */
2298: char *
2299: rl_gets ()
2300: {
2301: /* If the buffer has already been allocated,
2302: return the memory to the free pool. */
2303: if (line_read)
2304: {
2305: free (line_read);
2306: line_read = (char *)NULL;
2307: }
2308:
2309: /* Get a line from the user. */
2310: line_read = readline ("");
2311:
2312: /* If the line has any text in it,
2313: save it on the history. */
2314: if (line_read && *line_read)
2315: add_history (line_read);
2316:
2317: return (line_read);
2318: }
2319: </pre></td></tr></table></P><P>
2320:
2321: This function gives the user the default behaviour of <KBD>TAB</KBD>
2322: completion: completion on file names. If you do not want Readline to
2323: complete on filenames, you can change the binding of the <KBD>TAB</KBD> key
2324: with <CODE>rl_bind_key()</CODE>.
2325: </P><P>
2326:
2327: <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>
2328: </pre></td></tr></table></P><P>
2329:
2330: <CODE>rl_bind_key()</CODE> takes two arguments: <VAR>key</VAR> is the character that
2331: you want to bind, and <VAR>function</VAR> is the address of the function to
2332: call when <VAR>key</VAR> is pressed. Binding <KBD>TAB</KBD> to <CODE>rl_insert()</CODE>
2333: makes <KBD>TAB</KBD> insert itself.
2334: <CODE>rl_bind_key()</CODE> returns non-zero if <VAR>key</VAR> is not a valid
2335: ASCII character code (between 0 and 255).
2336: </P><P>
2337:
2338: Thus, to disable the default <KBD>TAB</KBD> behavior, the following suffices:
2339: <TABLE><tr><td> </td><td class=example><pre><CODE>rl_bind_key ('\t', rl_insert);</CODE>
2340: </pre></td></tr></table></P><P>
2341:
2342: This code should be executed once at the start of your program; you
2343: might write a function called <CODE>initialize_readline()</CODE> which
2344: performs this and other desired initializations, such as installing
2345: custom completers (see section <A HREF="readline.html#SEC45">2.6 Custom Completers</A>).
2346: </P><P>
2347:
2348: <A NAME="Custom Functions"></A>
2349: <HR SIZE="6">
2350: <A NAME="SEC25"></A>
2351: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
2352: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC24"> < </A>]</TD>
2353: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC26"> > </A>]</TD>
2354: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> << </A>]</TD>
2355: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD>
2356: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> >> </A>]</TD>
2357: <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>
2358: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
2359: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
2360: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
2361: </TR></TABLE>
2362: <H2> 2.2 Custom Functions </H2>
2363: <!--docid::SEC25::-->
2364: <P>
2365:
2366: Readline provides many functions for manipulating the text of
2367: the line, but it isn't possible to anticipate the needs of all
2368: programs. This section describes the various functions and variables
2369: defined within the Readline library which allow a user program to add
2370: customized functionality to Readline.
2371: </P><P>
2372:
2373: Before declaring any functions that customize Readline's behavior, or
2374: using any functionality Readline provides in other code, an
2375: application writer should include the file <CODE><readline/readline.h></CODE>
2376: in any file that uses Readline's features. Since some of the definitions
2377: in <CODE>readline.h</CODE> use the <CODE>stdio</CODE> library, the file
2378: <CODE><stdio.h></CODE> should be included before <CODE>readline.h</CODE>.
2379: </P><P>
2380:
2381: <CODE>readline.h</CODE> defines a C preprocessor variable that should
2382: be treated as an integer, <CODE>RL_READLINE_VERSION</CODE>, which may
2383: be used to conditionally compile application code depending on
2384: the installed Readline version. The value is a hexadecimal
2385: encoding of the major and minor version numbers of the library,
2386: of the form 0x<VAR>MMmm</VAR>. <VAR>MM</VAR> is the two-digit major
2387: version number; <VAR>mm</VAR> is the two-digit minor version number.
2388: For Readline 4.2, for example, the value of
2389: <CODE>RL_READLINE_VERSION</CODE> would be <CODE>0x0402</CODE>.
2390: </P><P>
2391:
2392: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
2393: <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>
2394: <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>
2395: </TABLE></BLOCKQUOTE>
2396: <P>
2397:
2398: <A NAME="Readline Typedefs"></A>
2399: <HR SIZE="6">
2400: <A NAME="SEC26"></A>
2401: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
2402: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> < </A>]</TD>
2403: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC27"> > </A>]</TD>
2404: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> << </A>]</TD>
2405: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> Up </A>]</TD>
2406: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> >> </A>]</TD>
2407: <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>
2408: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
2409: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
2410: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
2411: </TR></TABLE>
2412: <H3> 2.2.1 Readline Typedefs </H3>
2413: <!--docid::SEC26::-->
2414: <P>
2415:
2416: For readability, we declare a number of new object types, all pointers
2417: to functions.
2418: </P><P>
2419:
2420: The reason for declaring these new types is to make it easier to write
2421: code describing pointers to C functions with appropriately prototyped
2422: arguments and return values.
2423: </P><P>
2424:
2425: For instance, say we want to declare a variable <VAR>func</VAR> as a pointer
2426: to a function which takes two <CODE>int</CODE> arguments and returns an
2427: <CODE>int</CODE> (this is the type of all of the Readline bindable functions).
2428: Instead of the classic C declaration
2429: </P><P>
2430:
2431: <CODE>int (*func)();</CODE>
2432: </P><P>
2433:
2434: or the ANSI-C style declaration
2435: </P><P>
2436:
2437: <CODE>int (*func)(int, int);</CODE>
2438: </P><P>
2439:
2440: we may write
2441: </P><P>
2442:
2443: <CODE>rl_command_func_t *func;</CODE>
2444: </P><P>
2445:
2446: The full list of function pointer types available is
2447: </P><P>
2448:
2449: <DL COMPACT>
2450: <DT><CODE>typedef int rl_command_func_t (int, int);</CODE>
2451: <DD><P>
2452:
2453: <DT><CODE>typedef char *rl_compentry_func_t (const char *, int);</CODE>
2454: <DD><P>
2455:
2456: <DT><CODE>typedef char **rl_completion_func_t (const char *, int, int);</CODE>
2457: <DD><P>
2458:
2459: <DT><CODE>typedef char *rl_quote_func_t (char *, int, char *);</CODE>
2460: <DD><P>
2461:
2462: <DT><CODE>typedef char *rl_dequote_func_t (char *, int);</CODE>
2463: <DD><P>
2464:
2465: <DT><CODE>typedef int rl_compignore_func_t (char **);</CODE>
2466: <DD><P>
2467:
2468: <DT><CODE>typedef void rl_compdisp_func_t (char **, int, int);</CODE>
2469: <DD><P>
2470:
2471: <DT><CODE>typedef int rl_hook_func_t (void);</CODE>
2472: <DD><P>
2473:
2474: <DT><CODE>typedef int rl_getc_func_t (FILE *);</CODE>
2475: <DD><P>
2476:
2477: <DT><CODE>typedef int rl_linebuf_func_t (char *, int);</CODE>
2478: <DD><P>
2479:
2480: <DT><CODE>typedef int rl_intfunc_t (int);</CODE>
2481: <DD><DT><CODE>#define rl_ivoidfunc_t rl_hook_func_t</CODE>
2482: <DD><DT><CODE>typedef int rl_icpfunc_t (char *);</CODE>
2483: <DD><DT><CODE>typedef int rl_icppfunc_t (char **);</CODE>
2484: <DD><P>
2485:
2486: <DT><CODE>typedef void rl_voidfunc_t (void);</CODE>
2487: <DD><DT><CODE>typedef void rl_vintfunc_t (int);</CODE>
2488: <DD><DT><CODE>typedef void rl_vcpfunc_t (char *);</CODE>
2489: <DD><DT><CODE>typedef void rl_vcppfunc_t (char **);</CODE>
2490: <DD><P>
2491:
2492: </DL>
2493: <P>
2494:
2495: <A NAME="Function Writing"></A>
2496: <HR SIZE="6">
2497: <A NAME="SEC27"></A>
2498: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
2499: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC26"> < </A>]</TD>
2500: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> > </A>]</TD>
2501: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> << </A>]</TD>
2502: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC25"> Up </A>]</TD>
2503: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> >> </A>]</TD>
2504: <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>
2505: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
2506: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
2507: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
2508: </TR></TABLE>
2509: <H3> 2.2.2 Writing a New Function </H3>
2510: <!--docid::SEC27::-->
2511: <P>
2512:
2513: In order to write new functions for Readline, you need to know the
2514: calling conventions for keyboard-invoked functions, and the names of the
2515: variables that describe the current state of the line read so far.
2516: </P><P>
2517:
2518: The calling sequence for a command <CODE>foo</CODE> looks like
2519: </P><P>
2520:
2521: <TABLE><tr><td> </td><td class=example><pre><CODE>int foo (int count, int key)</CODE>
2522: </pre></td></tr></table></P><P>
2523:
2524: where <VAR>count</VAR> is the numeric argument (or 1 if defaulted) and
2525: <VAR>key</VAR> is the key that invoked this function.
2526: </P><P>
2527:
2528: It is completely up to the function as to what should be done with the
2529: numeric argument. Some functions use it as a repeat count, some
2530: as a flag, and others to choose alternate behavior (refreshing the current
2531: line as opposed to refreshing the screen, for example). Some choose to
2532: ignore it. In general, if a
2533: function uses the numeric argument as a repeat count, it should be able
2534: to do something useful with both negative and positive arguments.
2535: At the very least, it should be aware that it can be passed a
2536: negative argument.
2537: </P><P>
2538:
2539: A command function should return 0 if its action completes successfully,
2540: and a non-zero value if some error occurs.
2541: This is the convention obeyed by all of the builtin Readline bindable
2542: command functions.
2543: </P><P>
2544:
2545: <A NAME="Readline Variables"></A>
2546: <HR SIZE="6">
2547: <A NAME="SEC28"></A>
2548: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
2549: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC27"> < </A>]</TD>
2550: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> > </A>]</TD>
2551: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> << </A>]</TD>
2552: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD>
2553: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
2554: <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>
2555: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
2556: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
2557: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
2558: </TR></TABLE>
2559: <H2> 2.3 Readline Variables </H2>
2560: <!--docid::SEC28::-->
2561: <P>
2562:
2563: These variables are available to function writers.
2564: </P><P>
2565:
2566: <A NAME="IDX202"></A>
2567: <DL>
2568: <DT><U>Variable:</U> char * <B>rl_line_buffer</B>
2569: <DD>This is the line gathered so far. You are welcome to modify the
2570: contents of the line, but see <A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A>. The
2571: function <CODE>rl_extend_line_buffer</CODE> is available to increase
2572: the memory allocated to <CODE>rl_line_buffer</CODE>.
2573: </DL>
2574: </P><P>
2575:
2576: <A NAME="IDX203"></A>
2577: <DL>
2578: <DT><U>Variable:</U> int <B>rl_point</B>
2579: <DD>The offset of the current cursor position in <CODE>rl_line_buffer</CODE>
2580: (the <EM>point</EM>).
2581: </DL>
2582: </P><P>
2583:
2584: <A NAME="IDX204"></A>
2585: <DL>
2586: <DT><U>Variable:</U> int <B>rl_end</B>
2587: <DD>The number of characters present in <CODE>rl_line_buffer</CODE>. When
2588: <CODE>rl_point</CODE> is at the end of the line, <CODE>rl_point</CODE> and
2589: <CODE>rl_end</CODE> are equal.
2590: </DL>
2591: </P><P>
2592:
2593: <A NAME="IDX205"></A>
2594: <DL>
2595: <DT><U>Variable:</U> int <B>rl_mark</B>
2596: <DD>The <VAR>mark</VAR> (saved position) in the current line. If set, the mark
2597: and point define a <EM>region</EM>.
2598: </DL>
2599: </P><P>
2600:
2601: <A NAME="IDX206"></A>
2602: <DL>
2603: <DT><U>Variable:</U> int <B>rl_done</B>
2604: <DD>Setting this to a non-zero value causes Readline to return the current
2605: line immediately.
2606: </DL>
2607: </P><P>
2608:
2609: <A NAME="IDX207"></A>
2610: <DL>
2611: <DT><U>Variable:</U> int <B>rl_num_chars_to_read</B>
2612: <DD>Setting this to a positive value before calling <CODE>readline()</CODE> causes
2613: Readline to return after accepting that many characters, rather
2614: than reading up to a character bound to <CODE>accept-line</CODE>.
2615: </DL>
2616: </P><P>
2617:
2618: <A NAME="IDX208"></A>
2619: <DL>
2620: <DT><U>Variable:</U> int <B>rl_pending_input</B>
2621: <DD>Setting this to a value makes it the next keystroke read. This is a
2622: way to stuff a single character into the input stream.
2623: </DL>
2624: </P><P>
2625:
2626: <A NAME="IDX209"></A>
2627: <DL>
2628: <DT><U>Variable:</U> int <B>rl_dispatching</B>
2629: <DD>Set to a non-zero value if a function is being called from a key binding;
2630: zero otherwise. Application functions can test this to discover whether
2631: they were called directly or by Readline's dispatching mechanism.
2632: </DL>
2633: </P><P>
2634:
2635: <A NAME="IDX210"></A>
2636: <DL>
2637: <DT><U>Variable:</U> int <B>rl_erase_empty_line</B>
2638: <DD>Setting this to a non-zero value causes Readline to completely erase
2639: the current line, including any prompt, any time a newline is typed as
2640: the only character on an otherwise-empty line. The cursor is moved to
2641: the beginning of the newly-blank line.
2642: </DL>
2643: </P><P>
2644:
2645: <A NAME="IDX211"></A>
2646: <DL>
2647: <DT><U>Variable:</U> char * <B>rl_prompt</B>
2648: <DD>The prompt Readline uses. This is set from the argument to
2649: <CODE>readline()</CODE>, and should not be assigned to directly.
2650: The <CODE>rl_set_prompt()</CODE> function (see section <A HREF="readline.html#SEC35">2.4.6 Redisplay</A>) may
2651: be used to modify the prompt string after calling <CODE>readline()</CODE>.
2652: </DL>
2653: </P><P>
2654:
2655: <A NAME="IDX212"></A>
2656: <DL>
2657: <DT><U>Variable:</U> char * <B>rl_display_prompt</B>
2658: <DD>The string displayed as the prompt. This is usually identical to
2659: <VAR>rl_prompt</VAR>, but may be changed temporarily by functions that
2660: use the prompt string as a message area, such as incremental search.
2661: </DL>
2662: </P><P>
2663:
2664: <A NAME="IDX213"></A>
2665: <DL>
2666: <DT><U>Variable:</U> int <B>rl_already_prompted</B>
2667: <DD>If an application wishes to display the prompt itself, rather than have
2668: Readline do it the first time <CODE>readline()</CODE> is called, it should set
2669: this variable to a non-zero value after displaying the prompt.
2670: The prompt must also be passed as the argument to <CODE>readline()</CODE> so
2671: the redisplay functions can update the display properly.
2672: The calling application is responsible for managing the value; Readline
2673: never sets it.
2674: </DL>
2675: </P><P>
2676:
2677: <A NAME="IDX214"></A>
2678: <DL>
2679: <DT><U>Variable:</U> const char * <B>rl_library_version</B>
2680: <DD>The version number of this revision of the library.
2681: </DL>
2682: </P><P>
2683:
2684: <A NAME="IDX215"></A>
2685: <DL>
2686: <DT><U>Variable:</U> int <B>rl_readline_version</B>
2687: <DD>An integer encoding the current version of the library. The encoding is
2688: of the form 0x<VAR>MMmm</VAR>, where <VAR>MM</VAR> is the two-digit major version
2689: number, and <VAR>mm</VAR> is the two-digit minor version number.
2690: For example, for Readline-4.2, <CODE>rl_readline_version</CODE> would have the
2691: value 0x0402.
2692: </DL>
2693: </P><P>
2694:
2695: <A NAME="IDX216"></A>
2696: <DL>
2697: <DT><U>Variable:</U> int <B>rl_gnu_readline_p</B>
2698: <DD>Always set to 1, denoting that this is GNU readline rather than some
2699: emulation.
2700: </DL>
2701: </P><P>
2702:
2703: <A NAME="IDX217"></A>
2704: <DL>
2705: <DT><U>Variable:</U> const char * <B>rl_terminal_name</B>
2706: <DD>The terminal type, used for initialization. If not set by the application,
2707: Readline sets this to the value of the <CODE>TERM</CODE> environment variable
2708: the first time it is called.
2709: </DL>
2710: </P><P>
2711:
2712: <A NAME="IDX218"></A>
2713: <DL>
2714: <DT><U>Variable:</U> const char * <B>rl_readline_name</B>
2715: <DD>This variable is set to a unique name by each application using Readline.
2716: The value allows conditional parsing of the inputrc file
2717: (see section <A HREF="readline.html#SEC11">1.3.2 Conditional Init Constructs</A>).
2718: </DL>
2719: </P><P>
2720:
2721: <A NAME="IDX219"></A>
2722: <DL>
2723: <DT><U>Variable:</U> FILE * <B>rl_instream</B>
2724: <DD>The stdio stream from which Readline reads input.
2725: If <CODE>NULL</CODE>, Readline defaults to <VAR>stdin</VAR>.
2726: </DL>
2727: </P><P>
2728:
2729: <A NAME="IDX220"></A>
2730: <DL>
2731: <DT><U>Variable:</U> FILE * <B>rl_outstream</B>
2732: <DD>The stdio stream to which Readline performs output.
2733: If <CODE>NULL</CODE>, Readline defaults to <VAR>stdout</VAR>.
2734: </DL>
2735: </P><P>
2736:
2737: <A NAME="IDX221"></A>
2738: <DL>
2739: <DT><U>Variable:</U> int <B>rl_prefer_env_winsize</B>
2740: <DD>If non-zero, Readline gives values found in the <CODE>LINES</CODE> and
2741: <CODE>COLUMNS</CODE> environment variables greater precedence than values fetched
2742: from the kernel when computing the screen dimensions.
2743: </DL>
2744: </P><P>
2745:
2746: <A NAME="IDX222"></A>
2747: <DL>
2748: <DT><U>Variable:</U> rl_command_func_t * <B>rl_last_func</B>
2749: <DD>The address of the last command function Readline executed. May be used to
2750: test whether or not a function is being executed twice in succession, for
2751: example.
2752: </DL>
2753: </P><P>
2754:
2755: <A NAME="IDX223"></A>
2756: <DL>
2757: <DT><U>Variable:</U> rl_hook_func_t * <B>rl_startup_hook</B>
2758: <DD>If non-zero, this is the address of a function to call just
2759: before <CODE>readline</CODE> prints the first prompt.
2760: </DL>
2761: </P><P>
2762:
2763: <A NAME="IDX224"></A>
2764: <DL>
2765: <DT><U>Variable:</U> rl_hook_func_t * <B>rl_pre_input_hook</B>
2766: <DD>If non-zero, this is the address of a function to call after
2767: the first prompt has been printed and just before <CODE>readline</CODE>
2768: starts reading input characters.
2769: </DL>
2770: </P><P>
2771:
2772: <A NAME="IDX225"></A>
2773: <DL>
2774: <DT><U>Variable:</U> rl_hook_func_t * <B>rl_event_hook</B>
2775: <DD>If non-zero, this is the address of a function to call periodically
2776: when Readline is waiting for terminal input.
2777: By default, this will be called at most ten times a second if there
2778: is no keyboard input.
2779: </DL>
2780: </P><P>
2781:
2782: <A NAME="IDX226"></A>
2783: <DL>
2784: <DT><U>Variable:</U> rl_getc_func_t * <B>rl_getc_function</B>
2785: <DD>If non-zero, Readline will call indirectly through this pointer
2786: to get a character from the input stream. By default, it is set to
2787: <CODE>rl_getc</CODE>, the default Readline character input function
2788: (see section <A HREF="readline.html#SEC37">2.4.8 Character Input</A>).
2789: In general, an application that sets <VAR>rl_getc_function</VAR> should consider
2790: setting <VAR>rl_input_available_hook</VAR> as well.
2791: </DL>
2792: </P><P>
2793:
2794: <A NAME="IDX227"></A>
2795: <DL>
2796: <DT><U>Variable:</U> rl_hook_func_t * <B>rl_signal_event_hook</B>
2797: <DD>If non-zero, this is the address of a function to call if a read system
2798: call is interrupted when Readline is reading terminal input.
2799: </DL>
2800: </P><P>
2801:
2802: <A NAME="IDX228"></A>
2803: <DL>
2804: <DT><U>Variable:</U> rl_hook_func_t * <B>rl_input_available_hook</B>
2805: <DD>If non-zero, Readline will use this function's return value when it needs
2806: to determine whether or not there is available input on the current input
2807: source.
2808: The default hook checks <CODE>rl_instream</CODE>; if an application is using a
2809: different input source, it should set the hook appropriately.
2810: Readline queries for available input when implementing intra-key-sequence
2811: timeouts during input and incremental searches.
2812: This may use an application-specific timeout before returning a value;
2813: Readline uses the value passed to <CODE>rl_set_keyboard_input_timeout()</CODE>
2814: or the value of the user-settable <VAR>keyseq-timeout</VAR> variable.
2815: This is designed for use by applications using Readline's callback interface
2816: (see section <A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A>), which may not use the traditional
2817: <CODE>read(2)</CODE> and file descriptor interface, or other applications using
2818: a different input mechanism.
2819: If an application uses an input mechanism or hook that can potentially exceed
2820: the value of <VAR>keyseq-timeout</VAR>, it should increase the timeout or set
2821: this hook appropriately even when not using the callback interface.
2822: In general, an application that sets <VAR>rl_getc_function</VAR> should consider
2823: setting <VAR>rl_input_available_hook</VAR> as well.
2824: </DL>
2825: </P><P>
2826:
2827: <A NAME="IDX229"></A>
2828: <DL>
2829: <DT><U>Variable:</U> rl_voidfunc_t * <B>rl_redisplay_function</B>
2830: <DD>If non-zero, Readline will call indirectly through this pointer
2831: to update the display with the current contents of the editing buffer.
2832: By default, it is set to <CODE>rl_redisplay</CODE>, the default Readline
2833: redisplay function (see section <A HREF="readline.html#SEC35">2.4.6 Redisplay</A>).
2834: </DL>
2835: </P><P>
2836:
2837: <A NAME="IDX230"></A>
2838: <DL>
2839: <DT><U>Variable:</U> rl_vintfunc_t * <B>rl_prep_term_function</B>
2840: <DD>If non-zero, Readline will call indirectly through this pointer
2841: to initialize the terminal. The function takes a single argument, an
2842: <CODE>int</CODE> flag that says whether or not to use eight-bit characters.
2843: By default, this is set to <CODE>rl_prep_terminal</CODE>
2844: (see section <A HREF="readline.html#SEC38">2.4.9 Terminal Management</A>).
2845: </DL>
2846: </P><P>
2847:
2848: <A NAME="IDX231"></A>
2849: <DL>
2850: <DT><U>Variable:</U> rl_voidfunc_t * <B>rl_deprep_term_function</B>
2851: <DD>If non-zero, Readline will call indirectly through this pointer
2852: to reset the terminal. This function should undo the effects of
2853: <CODE>rl_prep_term_function</CODE>.
2854: By default, this is set to <CODE>rl_deprep_terminal</CODE>
2855: (see section <A HREF="readline.html#SEC38">2.4.9 Terminal Management</A>).
2856: </DL>
2857: </P><P>
2858:
2859: <A NAME="IDX232"></A>
2860: <DL>
2861: <DT><U>Variable:</U> Keymap <B>rl_executing_keymap</B>
2862: <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
2863: currently executing readline function was found.
2864: </DL>
2865: </P><P>
2866:
2867: <A NAME="IDX233"></A>
2868: <DL>
2869: <DT><U>Variable:</U> Keymap <B>rl_binding_keymap</B>
2870: <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
2871: last key binding occurred.
2872: </DL>
2873: </P><P>
2874:
2875: <A NAME="IDX234"></A>
2876: <DL>
2877: <DT><U>Variable:</U> char * <B>rl_executing_macro</B>
2878: <DD>This variable is set to the text of any currently-executing macro.
2879: </DL>
2880: </P><P>
2881:
2882: <A NAME="IDX235"></A>
2883: <DL>
2884: <DT><U>Variable:</U> int <B>rl_executing_key</B>
2885: <DD>The key that caused the dispatch to the currently-executing Readline function.
2886: </DL>
2887: </P><P>
2888:
2889: <A NAME="IDX236"></A>
2890: <DL>
2891: <DT><U>Variable:</U> char * <B>rl_executing_keyseq</B>
2892: <DD>The full key sequence that caused the dispatch to the currently-executing
2893: Readline function.
2894: </DL>
2895: </P><P>
2896:
2897: <A NAME="IDX237"></A>
2898: <DL>
2899: <DT><U>Variable:</U> int <B>rl_key_sequence_length</B>
2900: <DD>The number of characters in <VAR>rl_executing_keyseq</VAR>.
2901: </DL>
2902: </P><P>
2903:
2904: <A NAME="IDX238"></A>
2905: <DL>
2906: <DT><U>Variable:</U> int <B>rl_readline_state</B>
2907: <DD>A variable with bit values that encapsulate the current Readline state.
2908: A bit is set with the <CODE>RL_SETSTATE</CODE> macro, and unset with the
2909: <CODE>RL_UNSETSTATE</CODE> macro. Use the <CODE>RL_ISSTATE</CODE> macro to test
2910: whether a particular state bit is set. Current state bits include:
2911: </P><P>
2912:
2913: <DL COMPACT>
2914: <DT><CODE>RL_STATE_NONE</CODE>
2915: <DD>Readline has not yet been called, nor has it begun to initialize.
2916: <DT><CODE>RL_STATE_INITIALIZING</CODE>
2917: <DD>Readline is initializing its internal data structures.
2918: <DT><CODE>RL_STATE_INITIALIZED</CODE>
2919: <DD>Readline has completed its initialization.
2920: <DT><CODE>RL_STATE_TERMPREPPED</CODE>
2921: <DD>Readline has modified the terminal modes to do its own input and redisplay.
2922: <DT><CODE>RL_STATE_READCMD</CODE>
2923: <DD>Readline is reading a command from the keyboard.
2924: <DT><CODE>RL_STATE_METANEXT</CODE>
2925: <DD>Readline is reading more input after reading the meta-prefix character.
2926: <DT><CODE>RL_STATE_DISPATCHING</CODE>
2927: <DD>Readline is dispatching to a command.
2928: <DT><CODE>RL_STATE_MOREINPUT</CODE>
2929: <DD>Readline is reading more input while executing an editing command.
2930: <DT><CODE>RL_STATE_ISEARCH</CODE>
2931: <DD>Readline is performing an incremental history search.
2932: <DT><CODE>RL_STATE_NSEARCH</CODE>
2933: <DD>Readline is performing a non-incremental history search.
2934: <DT><CODE>RL_STATE_SEARCH</CODE>
2935: <DD>Readline is searching backward or forward through the history for a string.
2936: <DT><CODE>RL_STATE_NUMERICARG</CODE>
2937: <DD>Readline is reading a numeric argument.
2938: <DT><CODE>RL_STATE_MACROINPUT</CODE>
2939: <DD>Readline is currently getting its input from a previously-defined keyboard
2940: macro.
2941: <DT><CODE>RL_STATE_MACRODEF</CODE>
2942: <DD>Readline is currently reading characters defining a keyboard macro.
2943: <DT><CODE>RL_STATE_OVERWRITE</CODE>
2944: <DD>Readline is in overwrite mode.
2945: <DT><CODE>RL_STATE_COMPLETING</CODE>
2946: <DD>Readline is performing word completion.
2947: <DT><CODE>RL_STATE_SIGHANDLER</CODE>
2948: <DD>Readline is currently executing the readline signal handler.
2949: <DT><CODE>RL_STATE_UNDOING</CODE>
2950: <DD>Readline is performing an undo.
2951: <DT><CODE>RL_STATE_INPUTPENDING</CODE>
2952: <DD>Readline has input pending due to a call to <CODE>rl_execute_next()</CODE>.
2953: <DT><CODE>RL_STATE_TTYCSAVED</CODE>
2954: <DD>Readline has saved the values of the terminal's special characters.
2955: <DT><CODE>RL_STATE_CALLBACK</CODE>
2956: <DD>Readline is currently using the alternate (callback) interface
2957: (see section <A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A>).
2958: <DT><CODE>RL_STATE_VIMOTION</CODE>
2959: <DD>Readline is reading the argument to a vi-mode "motion" command.
2960: <DT><CODE>RL_STATE_MULTIKEY</CODE>
2961: <DD>Readline is reading a multiple-keystroke command.
2962: <DT><CODE>RL_STATE_VICMDONCE</CODE>
2963: <DD>Readline has entered vi command (movement) mode at least one time during
2964: the current call to <CODE>readline()</CODE>.
2965: <DT><CODE>RL_STATE_DONE</CODE>
2966: <DD>Readline has read a key sequence bound to <CODE>accept-line</CODE>
2967: and is about to return the line to the caller.
2968: </DL>
2969: <P>
2970:
2971: </DL>
2972: </P><P>
2973:
2974: <A NAME="IDX239"></A>
2975: <DL>
2976: <DT><U>Variable:</U> int <B>rl_explicit_arg</B>
2977: <DD>Set to a non-zero value if an explicit numeric argument was specified by
2978: the user. Only valid in a bindable command function.
2979: </DL>
2980: </P><P>
2981:
2982: <A NAME="IDX240"></A>
2983: <DL>
2984: <DT><U>Variable:</U> int <B>rl_numeric_arg</B>
2985: <DD>Set to the value of any numeric argument explicitly specified by the user
2986: before executing the current Readline function. Only valid in a bindable
2987: command function.
2988: </DL>
2989: </P><P>
2990:
2991: <A NAME="IDX241"></A>
2992: <DL>
2993: <DT><U>Variable:</U> int <B>rl_editing_mode</B>
2994: <DD>Set to a value denoting Readline's current editing mode. A value of
2995: <VAR>1</VAR> means Readline is currently in emacs mode; <VAR>0</VAR>
2996: means that vi mode is active.
2997: </DL>
2998: </P><P>
2999:
3000: <A NAME="Readline Convenience Functions"></A>
3001: <HR SIZE="6">
3002: <A NAME="SEC29"></A>
3003: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3004: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC28"> < </A>]</TD>
3005: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC30"> > </A>]</TD>
3006: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> << </A>]</TD>
3007: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD>
3008: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3009: <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>
3010: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3011: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3012: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3013: </TR></TABLE>
3014: <H2> 2.4 Readline Convenience Functions </H2>
3015: <!--docid::SEC29::-->
3016: <P>
3017:
3018: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
3019: <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>
3020: <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>
3021: <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>
3022: <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
3023: key sequences.</TD></TR>
3024: <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>
3025: <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>
3026: <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>
3027: <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>
3028: <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>
3029: <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>
3030: <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>
3031: <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>
3032: <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>
3033: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC43">2.4.14 Alternate Interface Example</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">An example program using the alternate interface.</TD></TR>
3034: </TABLE></BLOCKQUOTE>
3035: <P>
3036:
3037: <A NAME="Function Naming"></A>
3038: <HR SIZE="6">
3039: <A NAME="SEC30"></A>
3040: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3041: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> < </A>]</TD>
3042: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> > </A>]</TD>
3043: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> << </A>]</TD>
3044: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3045: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3046: <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>
3047: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3048: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3049: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3050: </TR></TABLE>
3051: <H3> 2.4.1 Naming a Function </H3>
3052: <!--docid::SEC30::-->
3053: <P>
3054:
3055: The user can dynamically change the bindings of keys while using
3056: Readline. This is done by representing the function with a descriptive
3057: name. The user is able to type the descriptive name when referring to
3058: the function. Thus, in an init file, one might find
3059: </P><P>
3060:
3061: <TABLE><tr><td> </td><td class=example><pre>Meta-Rubout: backward-kill-word
3062: </pre></td></tr></table></P><P>
3063:
3064: This binds the keystroke <KBD>Meta-Rubout</KBD> to the function
3065: <EM>descriptively</EM> named <CODE>backward-kill-word</CODE>. You, as the
3066: programmer, should bind the functions you write to descriptive names as
3067: well. Readline provides a function for doing that:
3068: </P><P>
3069:
3070: <A NAME="IDX242"></A>
3071: <DL>
3072: <DT><U>Function:</U> int <B>rl_add_defun</B> <I>(const char *name, rl_command_func_t *function, int key)</I>
3073: <DD>Add <VAR>name</VAR> to the list of named functions. Make <VAR>function</VAR> be
3074: the function that gets called. If <VAR>key</VAR> is not -1, then bind it to
3075: <VAR>function</VAR> using <CODE>rl_bind_key()</CODE>.
3076: </DL>
3077: </P><P>
3078:
3079: Using this function alone is sufficient for most applications.
3080: It is the recommended way to add a few functions to the default
3081: functions that Readline has built in.
3082: If you need to do something other than adding a function to Readline,
3083: you may need to use the underlying functions described below.
3084: </P><P>
3085:
3086: <A NAME="Keymaps"></A>
3087: <HR SIZE="6">
3088: <A NAME="SEC31"></A>
3089: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3090: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC30"> < </A>]</TD>
3091: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC32"> > </A>]</TD>
3092: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC32"> << </A>]</TD>
3093: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3094: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3095: <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>
3096: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3097: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3098: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3099: </TR></TABLE>
3100: <H3> 2.4.2 Selecting a Keymap </H3>
3101: <!--docid::SEC31::-->
3102: <P>
3103:
3104: Key bindings take place on a <EM>keymap</EM>. The keymap is the
3105: association between the keys that the user types and the functions that
3106: get run. You can make your own keymaps, copy existing keymaps, and tell
3107: Readline which keymap to use.
3108: </P><P>
3109:
3110: <A NAME="IDX243"></A>
3111: <DL>
3112: <DT><U>Function:</U> Keymap <B>rl_make_bare_keymap</B> <I>(void)</I>
3113: <DD>Returns a new, empty keymap. The space for the keymap is allocated with
3114: <CODE>malloc()</CODE>; the caller should free it by calling
3115: <CODE>rl_free_keymap()</CODE> when done.
3116: </DL>
3117: </P><P>
3118:
3119: <A NAME="IDX244"></A>
3120: <DL>
3121: <DT><U>Function:</U> Keymap <B>rl_copy_keymap</B> <I>(Keymap map)</I>
3122: <DD>Return a new keymap which is a copy of <VAR>map</VAR>.
3123: </DL>
3124: </P><P>
3125:
3126: <A NAME="IDX245"></A>
3127: <DL>
3128: <DT><U>Function:</U> Keymap <B>rl_make_keymap</B> <I>(void)</I>
3129: <DD>Return a new keymap with the printing characters bound to rl_insert,
3130: the lowercase Meta characters bound to run their equivalents, and
3131: the Meta digits bound to produce numeric arguments.
3132: </DL>
3133: </P><P>
3134:
3135: <A NAME="IDX246"></A>
3136: <DL>
3137: <DT><U>Function:</U> void <B>rl_discard_keymap</B> <I>(Keymap keymap)</I>
3138: <DD>Free the storage associated with the data in <VAR>keymap</VAR>.
3139: The caller should free <VAR>keymap</VAR>.
3140: </DL>
3141: </P><P>
3142:
3143: <A NAME="IDX247"></A>
3144: <DL>
3145: <DT><U>Function:</U> void <B>rl_free_keymap</B> <I>(Keymap keymap)</I>
3146: <DD>Free all storage associated with <VAR>keymap</VAR>. This calls
3147: <CODE>rl_discard_keymap</CODE> to free subordindate keymaps and macros.
3148: </DL>
3149: </P><P>
3150:
3151: Readline has several internal keymaps. These functions allow you to
3152: change which keymap is active.
3153: </P><P>
3154:
3155: <A NAME="IDX248"></A>
3156: <DL>
3157: <DT><U>Function:</U> Keymap <B>rl_get_keymap</B> <I>(void)</I>
3158: <DD>Returns the currently active keymap.
3159: </DL>
3160: </P><P>
3161:
3162: <A NAME="IDX249"></A>
3163: <DL>
3164: <DT><U>Function:</U> void <B>rl_set_keymap</B> <I>(Keymap keymap)</I>
3165: <DD>Makes <VAR>keymap</VAR> the currently active keymap.
3166: </DL>
3167: </P><P>
3168:
3169: <A NAME="IDX250"></A>
3170: <DL>
3171: <DT><U>Function:</U> Keymap <B>rl_get_keymap_by_name</B> <I>(const char *name)</I>
3172: <DD>Return the keymap matching <VAR>name</VAR>. <VAR>name</VAR> is one which would
3173: be supplied in a <CODE>set keymap</CODE> inputrc line (see section <A HREF="readline.html#SEC9">1.3 Readline Init File</A>).
3174: </DL>
3175: </P><P>
3176:
3177: <A NAME="IDX251"></A>
3178: <DL>
3179: <DT><U>Function:</U> char * <B>rl_get_keymap_name</B> <I>(Keymap keymap)</I>
3180: <DD>Return the name matching <VAR>keymap</VAR>. <VAR>name</VAR> is one which would
3181: be supplied in a <CODE>set keymap</CODE> inputrc line (see section <A HREF="readline.html#SEC9">1.3 Readline Init File</A>).
3182: </DL>
3183: </P><P>
3184:
3185: <A NAME="Binding Keys"></A>
3186: <HR SIZE="6">
3187: <A NAME="SEC32"></A>
3188: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3189: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> < </A>]</TD>
3190: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC33"> > </A>]</TD>
3191: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC33"> << </A>]</TD>
3192: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3193: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3194: <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>
3195: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3196: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3197: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3198: </TR></TABLE>
3199: <H3> 2.4.3 Binding Keys </H3>
3200: <!--docid::SEC32::-->
3201: <P>
3202:
3203: Key sequences are associate with functions through the keymap.
3204: Readline has several internal keymaps: <CODE>emacs_standard_keymap</CODE>,
3205: <CODE>emacs_meta_keymap</CODE>, <CODE>emacs_ctlx_keymap</CODE>,
3206: <CODE>vi_movement_keymap</CODE>, and <CODE>vi_insertion_keymap</CODE>.
3207: <CODE>emacs_standard_keymap</CODE> is the default, and the examples in
3208: this manual assume that.
3209: </P><P>
3210:
3211: Since <CODE>readline()</CODE> installs a set of default key bindings the first
3212: time it is called, there is always the danger that a custom binding
3213: installed before the first call to <CODE>readline()</CODE> will be overridden.
3214: An alternate mechanism is to install custom key bindings in an
3215: initialization function assigned to the <CODE>rl_startup_hook</CODE> variable
3216: (see section <A HREF="readline.html#SEC28">2.3 Readline Variables</A>).
3217: </P><P>
3218:
3219: These functions manage key bindings.
3220: </P><P>
3221:
3222: <A NAME="IDX252"></A>
3223: <DL>
3224: <DT><U>Function:</U> int <B>rl_bind_key</B> <I>(int key, rl_command_func_t *function)</I>
3225: <DD>Binds <VAR>key</VAR> to <VAR>function</VAR> in the currently active keymap.
3226: Returns non-zero in the case of an invalid <VAR>key</VAR>.
3227: </DL>
3228: </P><P>
3229:
3230: <A NAME="IDX253"></A>
3231: <DL>
3232: <DT><U>Function:</U> int <B>rl_bind_key_in_map</B> <I>(int key, rl_command_func_t *function, Keymap map)</I>
3233: <DD>Bind <VAR>key</VAR> to <VAR>function</VAR> in <VAR>map</VAR>.
3234: Returns non-zero in the case of an invalid <VAR>key</VAR>.
3235: </DL>
3236: </P><P>
3237:
3238: <A NAME="IDX254"></A>
3239: <DL>
3240: <DT><U>Function:</U> int <B>rl_bind_key_if_unbound</B> <I>(int key, rl_command_func_t *function)</I>
3241: <DD>Binds <VAR>key</VAR> to <VAR>function</VAR> if it is not already bound in the
3242: currently active keymap.
3243: Returns non-zero in the case of an invalid <VAR>key</VAR> or if <VAR>key</VAR> is
3244: already bound.
3245: </DL>
3246: </P><P>
3247:
3248: <A NAME="IDX255"></A>
3249: <DL>
3250: <DT><U>Function:</U> int <B>rl_bind_key_if_unbound_in_map</B> <I>(int key, rl_command_func_t *function, Keymap map)</I>
3251: <DD>Binds <VAR>key</VAR> to <VAR>function</VAR> if it is not already bound in <VAR>map</VAR>.
3252: Returns non-zero in the case of an invalid <VAR>key</VAR> or if <VAR>key</VAR> is
3253: already bound.
3254: </DL>
3255: </P><P>
3256:
3257: <A NAME="IDX256"></A>
3258: <DL>
3259: <DT><U>Function:</U> int <B>rl_unbind_key</B> <I>(int key)</I>
3260: <DD>Bind <VAR>key</VAR> to the null function in the currently active keymap.
3261: Returns non-zero in case of error.
3262: </DL>
3263: </P><P>
3264:
3265: <A NAME="IDX257"></A>
3266: <DL>
3267: <DT><U>Function:</U> int <B>rl_unbind_key_in_map</B> <I>(int key, Keymap map)</I>
3268: <DD>Bind <VAR>key</VAR> to the null function in <VAR>map</VAR>.
3269: Returns non-zero in case of error.
3270: </DL>
3271: </P><P>
3272:
3273: <A NAME="IDX258"></A>
3274: <DL>
3275: <DT><U>Function:</U> int <B>rl_unbind_function_in_map</B> <I>(rl_command_func_t *function, Keymap map)</I>
3276: <DD>Unbind all keys that execute <VAR>function</VAR> in <VAR>map</VAR>.
3277: </DL>
3278: </P><P>
3279:
3280: <A NAME="IDX259"></A>
3281: <DL>
3282: <DT><U>Function:</U> int <B>rl_unbind_command_in_map</B> <I>(const char *command, Keymap map)</I>
3283: <DD>Unbind all keys that are bound to <VAR>command</VAR> in <VAR>map</VAR>.
3284: </DL>
3285: </P><P>
3286:
3287: <A NAME="IDX260"></A>
3288: <DL>
3289: <DT><U>Function:</U> int <B>rl_bind_keyseq</B> <I>(const char *keyseq, rl_command_func_t *function)</I>
3290: <DD>Bind the key sequence represented by the string <VAR>keyseq</VAR> to the function
3291: <VAR>function</VAR>, beginning in the current keymap.
3292: This makes new keymaps as necessary.
3293: The return value is non-zero if <VAR>keyseq</VAR> is invalid.
3294: </DL>
3295: </P><P>
3296:
3297: <A NAME="IDX261"></A>
3298: <DL>
3299: <DT><U>Function:</U> int <B>rl_bind_keyseq_in_map</B> <I>(const char *keyseq, rl_command_func_t *function, Keymap map)</I>
3300: <DD>Bind the key sequence represented by the string <VAR>keyseq</VAR> to the function
3301: <VAR>function</VAR>. This makes new keymaps as necessary.
3302: Initial bindings are performed in <VAR>map</VAR>.
3303: The return value is non-zero if <VAR>keyseq</VAR> is invalid.
3304: </DL>
3305: </P><P>
3306:
3307: <A NAME="IDX262"></A>
3308: <DL>
3309: <DT><U>Function:</U> int <B>rl_set_key</B> <I>(const char *keyseq, rl_command_func_t *function, Keymap map)</I>
3310: <DD>Equivalent to <CODE>rl_bind_keyseq_in_map</CODE>.
3311: </DL>
3312: </P><P>
3313:
3314: <A NAME="IDX263"></A>
3315: <DL>
3316: <DT><U>Function:</U> int <B>rl_bind_keyseq_if_unbound</B> <I>(const char *keyseq, rl_command_func_t *function)</I>
3317: <DD>Binds <VAR>keyseq</VAR> to <VAR>function</VAR> if it is not already bound in the
3318: currently active keymap.
3319: Returns non-zero in the case of an invalid <VAR>keyseq</VAR> or if <VAR>keyseq</VAR> is
3320: already bound.
3321: </DL>
3322: </P><P>
3323:
3324: <A NAME="IDX264"></A>
3325: <DL>
3326: <DT><U>Function:</U> int <B>rl_bind_keyseq_if_unbound_in_map</B> <I>(const char *keyseq, rl_command_func_t *function, Keymap map)</I>
3327: <DD>Binds <VAR>keyseq</VAR> to <VAR>function</VAR> if it is not already bound in <VAR>map</VAR>.
3328: Returns non-zero in the case of an invalid <VAR>keyseq</VAR> or if <VAR>keyseq</VAR> is
3329: already bound.
3330: </DL>
3331: </P><P>
3332:
3333: <A NAME="IDX265"></A>
3334: <DL>
3335: <DT><U>Function:</U> int <B>rl_generic_bind</B> <I>(int type, const char *keyseq, char *data, Keymap map)</I>
3336: <DD>Bind the key sequence represented by the string <VAR>keyseq</VAR> to the arbitrary
3337: pointer <VAR>data</VAR>. <VAR>type</VAR> says what kind of data is pointed to by
3338: <VAR>data</VAR>; this can be a function (<CODE>ISFUNC</CODE>), a macro
3339: (<CODE>ISMACR</CODE>), or a keymap (<CODE>ISKMAP</CODE>). This makes new keymaps as
3340: necessary. The initial keymap in which to do bindings is <VAR>map</VAR>.
3341: </DL>
3342: </P><P>
3343:
3344: <A NAME="IDX266"></A>
3345: <DL>
3346: <DT><U>Function:</U> int <B>rl_parse_and_bind</B> <I>(char *line)</I>
3347: <DD>Parse <VAR>line</VAR> as if it had been read from the <CODE>inputrc</CODE> file and
3348: perform any key bindings and variable assignments found
3349: (see section <A HREF="readline.html#SEC9">1.3 Readline Init File</A>).
3350: </DL>
3351: </P><P>
3352:
3353: <A NAME="IDX267"></A>
3354: <DL>
3355: <DT><U>Function:</U> int <B>rl_read_init_file</B> <I>(const char *filename)</I>
3356: <DD>Read keybindings and variable assignments from <VAR>filename</VAR>
3357: (see section <A HREF="readline.html#SEC9">1.3 Readline Init File</A>).
3358: </DL>
3359: </P><P>
3360:
3361: <A NAME="Associating Function Names and Bindings"></A>
3362: <HR SIZE="6">
3363: <A NAME="SEC33"></A>
3364: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3365: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC32"> < </A>]</TD>
3366: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC34"> > </A>]</TD>
3367: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC34"> << </A>]</TD>
3368: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3369: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3370: <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>
3371: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3372: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3373: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3374: </TR></TABLE>
3375: <H3> 2.4.4 Associating Function Names and Bindings </H3>
3376: <!--docid::SEC33::-->
3377: <P>
3378:
3379: These functions allow you to find out what keys invoke named functions
3380: and the functions invoked by a particular key sequence. You may also
3381: associate a new function name with an arbitrary function.
3382: </P><P>
3383:
3384: <A NAME="IDX268"></A>
3385: <DL>
3386: <DT><U>Function:</U> rl_command_func_t * <B>rl_named_function</B> <I>(const char *name)</I>
3387: <DD>Return the function with name <VAR>name</VAR>.
3388: </DL>
3389: </P><P>
3390:
3391: <A NAME="IDX269"></A>
3392: <DL>
3393: <DT><U>Function:</U> rl_command_func_t * <B>rl_function_of_keyseq</B> <I>(const char *keyseq, Keymap map, int *type)</I>
3394: <DD>Return the function invoked by <VAR>keyseq</VAR> in keymap <VAR>map</VAR>.
3395: If <VAR>map</VAR> is <CODE>NULL</CODE>, the current keymap is used. If <VAR>type</VAR> is
3396: not <CODE>NULL</CODE>, the type of the object is returned in the <CODE>int</CODE> variable
3397: it points to (one of <CODE>ISFUNC</CODE>, <CODE>ISKMAP</CODE>, or <CODE>ISMACR</CODE>).
3398: </DL>
3399: </P><P>
3400:
3401: <A NAME="IDX270"></A>
3402: <DL>
3403: <DT><U>Function:</U> char ** <B>rl_invoking_keyseqs</B> <I>(rl_command_func_t *function)</I>
3404: <DD>Return an array of strings representing the key sequences used to
3405: invoke <VAR>function</VAR> in the current keymap.
3406: </DL>
3407: </P><P>
3408:
3409: <A NAME="IDX271"></A>
3410: <DL>
3411: <DT><U>Function:</U> char ** <B>rl_invoking_keyseqs_in_map</B> <I>(rl_command_func_t *function, Keymap map)</I>
3412: <DD>Return an array of strings representing the key sequences used to
3413: invoke <VAR>function</VAR> in the keymap <VAR>map</VAR>.
3414: </DL>
3415: </P><P>
3416:
3417: <A NAME="IDX272"></A>
3418: <DL>
3419: <DT><U>Function:</U> void <B>rl_function_dumper</B> <I>(int readable)</I>
3420: <DD>Print the readline function names and the key sequences currently
3421: bound to them to <CODE>rl_outstream</CODE>. If <VAR>readable</VAR> is non-zero,
3422: the list is formatted in such a way that it can be made part of an
3423: <CODE>inputrc</CODE> file and re-read.
3424: </DL>
3425: </P><P>
3426:
3427: <A NAME="IDX273"></A>
3428: <DL>
3429: <DT><U>Function:</U> void <B>rl_list_funmap_names</B> <I>(void)</I>
3430: <DD>Print the names of all bindable Readline functions to <CODE>rl_outstream</CODE>.
3431: </DL>
3432: </P><P>
3433:
3434: <A NAME="IDX274"></A>
3435: <DL>
3436: <DT><U>Function:</U> const char ** <B>rl_funmap_names</B> <I>(void)</I>
3437: <DD>Return a NULL terminated array of known function names. The array is
3438: sorted. The array itself is allocated, but not the strings inside. You
3439: should free the array, but not the pointers, using <CODE>free</CODE> or
3440: <CODE>rl_free</CODE> when you are done.
3441: </DL>
3442: </P><P>
3443:
3444: <A NAME="IDX275"></A>
3445: <DL>
3446: <DT><U>Function:</U> int <B>rl_add_funmap_entry</B> <I>(const char *name, rl_command_func_t *function)</I>
3447: <DD>Add <VAR>name</VAR> to the list of bindable Readline command names, and make
3448: <VAR>function</VAR> the function to be called when <VAR>name</VAR> is invoked.
3449: </DL>
3450: </P><P>
3451:
3452: <A NAME="Allowing Undoing"></A>
3453: <HR SIZE="6">
3454: <A NAME="SEC34"></A>
3455: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3456: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC33"> < </A>]</TD>
3457: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC35"> > </A>]</TD>
3458: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC35"> << </A>]</TD>
3459: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3460: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3461: <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>
3462: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3463: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3464: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3465: </TR></TABLE>
3466: <H3> 2.4.5 Allowing Undoing </H3>
3467: <!--docid::SEC34::-->
3468: <P>
3469:
3470: Supporting the undo command is a painless thing, and makes your
3471: functions much more useful. It is certainly easy to try
3472: something if you know you can undo it.
3473: </P><P>
3474:
3475: If your function simply inserts text once, or deletes text once, and
3476: uses <CODE>rl_insert_text()</CODE> or <CODE>rl_delete_text()</CODE> to do it, then
3477: undoing is already done for you automatically.
3478: </P><P>
3479:
3480: If you do multiple insertions or multiple deletions, or any combination
3481: of these operations, you should group them together into one operation.
3482: This is done with <CODE>rl_begin_undo_group()</CODE> and
3483: <CODE>rl_end_undo_group()</CODE>.
3484: </P><P>
3485:
3486: The types of events that can be undone are:
3487: </P><P>
3488:
3489: <TABLE><tr><td> </td><td class=smallexample><FONT SIZE=-1><pre>enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
3490: </FONT></pre></td></tr></table></P><P>
3491:
3492: Notice that <CODE>UNDO_DELETE</CODE> means to insert some text, and
3493: <CODE>UNDO_INSERT</CODE> means to delete some text. That is, the undo code
3494: tells what to undo, not how to undo it. <CODE>UNDO_BEGIN</CODE> and
3495: <CODE>UNDO_END</CODE> are tags added by <CODE>rl_begin_undo_group()</CODE> and
3496: <CODE>rl_end_undo_group()</CODE>.
3497: </P><P>
3498:
3499: <A NAME="IDX276"></A>
3500: <DL>
3501: <DT><U>Function:</U> int <B>rl_begin_undo_group</B> <I>(void)</I>
3502: <DD>Begins saving undo information in a group construct. The undo
3503: information usually comes from calls to <CODE>rl_insert_text()</CODE> and
3504: <CODE>rl_delete_text()</CODE>, but could be the result of calls to
3505: <CODE>rl_add_undo()</CODE>.
3506: </DL>
3507: </P><P>
3508:
3509: <A NAME="IDX277"></A>
3510: <DL>
3511: <DT><U>Function:</U> int <B>rl_end_undo_group</B> <I>(void)</I>
3512: <DD>Closes the current undo group started with <CODE>rl_begin_undo_group
3513: ()</CODE>. There should be one call to <CODE>rl_end_undo_group()</CODE>
3514: for each call to <CODE>rl_begin_undo_group()</CODE>.
3515: </DL>
3516: </P><P>
3517:
3518: <A NAME="IDX278"></A>
3519: <DL>
3520: <DT><U>Function:</U> void <B>rl_add_undo</B> <I>(enum undo_code what, int start, int end, char *text)</I>
3521: <DD>Remember how to undo an event (according to <VAR>what</VAR>). The affected
3522: text runs from <VAR>start</VAR> to <VAR>end</VAR>, and encompasses <VAR>text</VAR>.
3523: </DL>
3524: </P><P>
3525:
3526: <A NAME="IDX279"></A>
3527: <DL>
3528: <DT><U>Function:</U> void <B>rl_free_undo_list</B> <I>(void)</I>
3529: <DD>Free the existing undo list.
3530: </DL>
3531: </P><P>
3532:
3533: <A NAME="IDX280"></A>
3534: <DL>
3535: <DT><U>Function:</U> int <B>rl_do_undo</B> <I>(void)</I>
3536: <DD>Undo the first thing on the undo list. Returns <CODE>0</CODE> if there was
3537: nothing to undo, non-zero if something was undone.
3538: </DL>
3539: </P><P>
3540:
3541: Finally, if you neither insert nor delete text, but directly modify the
3542: existing text (e.g., change its case), call <CODE>rl_modifying()</CODE>
3543: once, just before you modify the text. You must supply the indices of
3544: the text range that you are going to modify.
3545: </P><P>
3546:
3547: <A NAME="IDX281"></A>
3548: <DL>
3549: <DT><U>Function:</U> int <B>rl_modifying</B> <I>(int start, int end)</I>
3550: <DD>Tell Readline to save the text between <VAR>start</VAR> and <VAR>end</VAR> as a
3551: single undo unit. It is assumed that you will subsequently modify
3552: that text.
3553: </DL>
3554: </P><P>
3555:
3556: <A NAME="Redisplay"></A>
3557: <HR SIZE="6">
3558: <A NAME="SEC35"></A>
3559: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3560: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC34"> < </A>]</TD>
3561: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC36"> > </A>]</TD>
3562: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC36"> << </A>]</TD>
3563: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3564: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3565: <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>
3566: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3567: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3568: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3569: </TR></TABLE>
3570: <H3> 2.4.6 Redisplay </H3>
3571: <!--docid::SEC35::-->
3572: <P>
3573:
3574: <A NAME="IDX282"></A>
3575: <DL>
3576: <DT><U>Function:</U> void <B>rl_redisplay</B> <I>(void)</I>
3577: <DD>Change what's displayed on the screen to reflect the current contents
3578: of <CODE>rl_line_buffer</CODE>.
3579: </DL>
3580: </P><P>
3581:
3582: <A NAME="IDX283"></A>
3583: <DL>
3584: <DT><U>Function:</U> int <B>rl_forced_update_display</B> <I>(void)</I>
3585: <DD>Force the line to be updated and redisplayed, whether or not
3586: Readline thinks the screen display is correct.
3587: </DL>
3588: </P><P>
3589:
3590: <A NAME="IDX284"></A>
3591: <DL>
3592: <DT><U>Function:</U> int <B>rl_on_new_line</B> <I>(void)</I>
3593: <DD>Tell the update functions that we have moved onto a new (empty) line,
3594: usually after outputting a newline.
3595: </DL>
3596: </P><P>
3597:
3598: <A NAME="IDX285"></A>
3599: <DL>
3600: <DT><U>Function:</U> int <B>rl_on_new_line_with_prompt</B> <I>(void)</I>
3601: <DD>Tell the update functions that we have moved onto a new line, with
3602: <VAR>rl_prompt</VAR> already displayed.
3603: This could be used by applications that want to output the prompt string
3604: themselves, but still need Readline to know the prompt string length for
3605: redisplay.
3606: It should be used after setting <VAR>rl_already_prompted</VAR>.
3607: </DL>
3608: </P><P>
3609:
3610: <A NAME="IDX286"></A>
3611: <DL>
3612: <DT><U>Function:</U> int <B>rl_reset_line_state</B> <I>(void)</I>
3613: <DD>Reset the display state to a clean state and redisplay the current line
3614: starting on a new line.
3615: </DL>
3616: </P><P>
3617:
3618: <A NAME="IDX287"></A>
3619: <DL>
3620: <DT><U>Function:</U> int <B>rl_crlf</B> <I>(void)</I>
3621: <DD>Move the cursor to the start of the next screen line.
3622: </DL>
3623: </P><P>
3624:
3625: <A NAME="IDX288"></A>
3626: <DL>
3627: <DT><U>Function:</U> int <B>rl_show_char</B> <I>(int c)</I>
3628: <DD>Display character <VAR>c</VAR> on <CODE>rl_outstream</CODE>.
3629: If Readline has not been set to display meta characters directly, this
3630: will convert meta characters to a meta-prefixed key sequence.
3631: This is intended for use by applications which wish to do their own
3632: redisplay.
3633: </DL>
3634: </P><P>
3635:
3636: <A NAME="IDX289"></A>
3637: <DL>
3638: <DT><U>Function:</U> int <B>rl_message</B> <I>(const char *, <small>...</small>)</I>
3639: <DD>The arguments are a format string as would be supplied to <CODE>printf</CODE>,
3640: possibly containing conversion specifications such as <SAMP>`%d'</SAMP>, and
3641: any additional arguments necessary to satisfy the conversion specifications.
3642: The resulting string is displayed in the <EM>echo area</EM>. The echo area
3643: is also used to display numeric arguments and search strings.
3644: You should call <CODE>rl_save_prompt</CODE> to save the prompt information
3645: before calling this function.
3646: </DL>
3647: </P><P>
3648:
3649: <A NAME="IDX290"></A>
3650: <DL>
3651: <DT><U>Function:</U> int <B>rl_clear_message</B> <I>(void)</I>
3652: <DD>Clear the message in the echo area. If the prompt was saved with a call to
3653: <CODE>rl_save_prompt</CODE> before the last call to <CODE>rl_message</CODE>,
3654: call <CODE>rl_restore_prompt</CODE> before calling this function.
3655: </DL>
3656: </P><P>
3657:
3658: <A NAME="IDX291"></A>
3659: <DL>
3660: <DT><U>Function:</U> void <B>rl_save_prompt</B> <I>(void)</I>
3661: <DD>Save the local Readline prompt display state in preparation for
3662: displaying a new message in the message area with <CODE>rl_message()</CODE>.
3663: </DL>
3664: </P><P>
3665:
3666: <A NAME="IDX292"></A>
3667: <DL>
3668: <DT><U>Function:</U> void <B>rl_restore_prompt</B> <I>(void)</I>
3669: <DD>Restore the local Readline prompt display state saved by the most
3670: recent call to <CODE>rl_save_prompt</CODE>.
3671: if <CODE>rl_save_prompt</CODE> was called to save the prompt before a call
3672: to <CODE>rl_message</CODE>, this function should be called before the
3673: corresponding call to <CODE>rl_clear_message</CODE>.
3674: </DL>
3675: </P><P>
3676:
3677: <A NAME="IDX293"></A>
3678: <DL>
3679: <DT><U>Function:</U> int <B>rl_expand_prompt</B> <I>(char *prompt)</I>
3680: <DD>Expand any special character sequences in <VAR>prompt</VAR> and set up the
3681: local Readline prompt redisplay variables.
3682: This function is called by <CODE>readline()</CODE>. It may also be called to
3683: expand the primary prompt if the <CODE>rl_on_new_line_with_prompt()</CODE>
3684: function or <CODE>rl_already_prompted</CODE> variable is used.
3685: It returns the number of visible characters on the last line of the
3686: (possibly multi-line) prompt.
3687: Applications may indicate that the prompt contains characters that take
3688: up no physical screen space when displayed by bracketing a sequence of
3689: such characters with the special markers <CODE>RL_PROMPT_START_IGNORE</CODE>
3690: and <CODE>RL_PROMPT_END_IGNORE</CODE> (declared in <TT>`readline.h'</TT>. This may
3691: be used to embed terminal-specific escape sequences in prompts.
3692: </DL>
3693: </P><P>
3694:
3695: <A NAME="IDX294"></A>
3696: <DL>
3697: <DT><U>Function:</U> int <B>rl_set_prompt</B> <I>(const char *prompt)</I>
3698: <DD>Make Readline use <VAR>prompt</VAR> for subsequent redisplay. This calls
3699: <CODE>rl_expand_prompt()</CODE> to expand the prompt and sets <CODE>rl_prompt</CODE>
3700: to the result.
3701: </DL>
3702: </P><P>
3703:
3704: <A NAME="Modifying Text"></A>
3705: <HR SIZE="6">
3706: <A NAME="SEC36"></A>
3707: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3708: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC35"> < </A>]</TD>
3709: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC37"> > </A>]</TD>
3710: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC37"> << </A>]</TD>
3711: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3712: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3713: <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>
3714: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3715: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3716: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3717: </TR></TABLE>
3718: <H3> 2.4.7 Modifying Text </H3>
3719: <!--docid::SEC36::-->
3720: <P>
3721:
3722: <A NAME="IDX295"></A>
3723: <DL>
3724: <DT><U>Function:</U> int <B>rl_insert_text</B> <I>(const char *text)</I>
3725: <DD>Insert <VAR>text</VAR> into the line at the current cursor position.
3726: Returns the number of characters inserted.
3727: </DL>
3728: </P><P>
3729:
3730: <A NAME="IDX296"></A>
3731: <DL>
3732: <DT><U>Function:</U> int <B>rl_delete_text</B> <I>(int start, int end)</I>
3733: <DD>Delete the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line.
3734: Returns the number of characters deleted.
3735: </DL>
3736: </P><P>
3737:
3738: <A NAME="IDX297"></A>
3739: <DL>
3740: <DT><U>Function:</U> char * <B>rl_copy_text</B> <I>(int start, int end)</I>
3741: <DD>Return a copy of the text between <VAR>start</VAR> and <VAR>end</VAR> in
3742: the current line.
3743: </DL>
3744: </P><P>
3745:
3746: <A NAME="IDX298"></A>
3747: <DL>
3748: <DT><U>Function:</U> int <B>rl_kill_text</B> <I>(int start, int end)</I>
3749: <DD>Copy the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line
3750: to the kill ring, appending or prepending to the last kill if the
3751: last command was a kill command. The text is deleted.
3752: If <VAR>start</VAR> is less than <VAR>end</VAR>,
3753: the text is appended, otherwise prepended. If the last command was
3754: not a kill, a new kill ring slot is used.
3755: </DL>
3756: </P><P>
3757:
3758: <A NAME="IDX299"></A>
3759: <DL>
3760: <DT><U>Function:</U> int <B>rl_push_macro_input</B> <I>(char *macro)</I>
3761: <DD>Cause <VAR>macro</VAR> to be inserted into the line, as if it had been invoked
3762: by a key bound to a macro. Not especially useful; use
3763: <CODE>rl_insert_text()</CODE> instead.
3764: </DL>
3765: </P><P>
3766:
3767: <A NAME="Character Input"></A>
3768: <HR SIZE="6">
3769: <A NAME="SEC37"></A>
3770: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3771: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC36"> < </A>]</TD>
3772: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC38"> > </A>]</TD>
3773: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC38"> << </A>]</TD>
3774: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3775: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3776: <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>
3777: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3778: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3779: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3780: </TR></TABLE>
3781: <H3> 2.4.8 Character Input </H3>
3782: <!--docid::SEC37::-->
3783: <P>
3784:
3785: <A NAME="IDX300"></A>
3786: <DL>
3787: <DT><U>Function:</U> int <B>rl_read_key</B> <I>(void)</I>
3788: <DD>Return the next character available from Readline's current input stream.
3789: This handles input inserted into
3790: the input stream via <VAR>rl_pending_input</VAR> (see section <A HREF="readline.html#SEC28">2.3 Readline Variables</A>)
3791: and <CODE>rl_stuff_char()</CODE>, macros, and characters read from the keyboard.
3792: While waiting for input, this function will call any function assigned to
3793: the <CODE>rl_event_hook</CODE> variable.
3794: </DL>
3795: </P><P>
3796:
3797: <A NAME="IDX301"></A>
3798: <DL>
3799: <DT><U>Function:</U> int <B>rl_getc</B> <I>(FILE *stream)</I>
3800: <DD>Return the next character available from <VAR>stream</VAR>, which is assumed to
3801: be the keyboard.
3802: </DL>
3803: </P><P>
3804:
3805: <A NAME="IDX302"></A>
3806: <DL>
3807: <DT><U>Function:</U> int <B>rl_stuff_char</B> <I>(int c)</I>
3808: <DD>Insert <VAR>c</VAR> into the Readline input stream. It will be "read"
3809: before Readline attempts to read characters from the terminal with
3810: <CODE>rl_read_key()</CODE>. Up to 512 characters may be pushed back.
3811: <CODE>rl_stuff_char</CODE> returns 1 if the character was successfully inserted;
3812: 0 otherwise.
3813: </DL>
3814: </P><P>
3815:
3816: <A NAME="IDX303"></A>
3817: <DL>
3818: <DT><U>Function:</U> int <B>rl_execute_next</B> <I>(int c)</I>
3819: <DD>Make <VAR>c</VAR> be the next command to be executed when <CODE>rl_read_key()</CODE>
3820: is called. This sets <VAR>rl_pending_input</VAR>.
3821: </DL>
3822: </P><P>
3823:
3824: <A NAME="IDX304"></A>
3825: <DL>
3826: <DT><U>Function:</U> int <B>rl_clear_pending_input</B> <I>(void)</I>
3827: <DD>Unset <VAR>rl_pending_input</VAR>, effectively negating the effect of any
3828: previous call to <CODE>rl_execute_next()</CODE>. This works only if the
3829: pending input has not already been read with <CODE>rl_read_key()</CODE>.
3830: </DL>
3831: </P><P>
3832:
3833: <A NAME="IDX305"></A>
3834: <DL>
3835: <DT><U>Function:</U> int <B>rl_set_keyboard_input_timeout</B> <I>(int u)</I>
3836: <DD>While waiting for keyboard input in <CODE>rl_read_key()</CODE>, Readline will
3837: wait for <VAR>u</VAR> microseconds for input before calling any function
3838: assigned to <CODE>rl_event_hook</CODE>. <VAR>u</VAR> must be greater than or equal
3839: to zero (a zero-length timeout is equivalent to a poll).
3840: The default waiting period is one-tenth of a second.
3841: Returns the old timeout value.
3842: </DL>
3843: </P><P>
3844:
3845: <A NAME="Terminal Management"></A>
3846: <HR SIZE="6">
3847: <A NAME="SEC38"></A>
3848: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3849: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC37"> < </A>]</TD>
3850: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC39"> > </A>]</TD>
3851: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> << </A>]</TD>
3852: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3853: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3854: <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>
3855: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3856: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3857: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3858: </TR></TABLE>
3859: <H3> 2.4.9 Terminal Management </H3>
3860: <!--docid::SEC38::-->
3861: <P>
3862:
3863: <A NAME="IDX306"></A>
3864: <DL>
3865: <DT><U>Function:</U> void <B>rl_prep_terminal</B> <I>(int meta_flag)</I>
3866: <DD>Modify the terminal settings for Readline's use, so <CODE>readline()</CODE>
3867: can read a single character at a time from the keyboard.
3868: The <VAR>meta_flag</VAR> argument should be non-zero if Readline should
3869: read eight-bit input.
3870: </DL>
3871: </P><P>
3872:
3873: <A NAME="IDX307"></A>
3874: <DL>
3875: <DT><U>Function:</U> void <B>rl_deprep_terminal</B> <I>(void)</I>
3876: <DD>Undo the effects of <CODE>rl_prep_terminal()</CODE>, leaving the terminal in
3877: the state in which it was before the most recent call to
3878: <CODE>rl_prep_terminal()</CODE>.
3879: </DL>
3880: </P><P>
3881:
3882: <A NAME="IDX308"></A>
3883: <DL>
3884: <DT><U>Function:</U> void <B>rl_tty_set_default_bindings</B> <I>(Keymap kmap)</I>
3885: <DD>Read the operating system's terminal editing characters (as would be
3886: displayed by <CODE>stty</CODE>) to their Readline equivalents.
3887: The bindings are performed in <VAR>kmap</VAR>.
3888: </DL>
3889: </P><P>
3890:
3891: <A NAME="IDX309"></A>
3892: <DL>
3893: <DT><U>Function:</U> void <B>rl_tty_unset_default_bindings</B> <I>(Keymap kmap)</I>
3894: <DD>Reset the bindings manipulated by <CODE>rl_tty_set_default_bindings</CODE> so
3895: that the terminal editing characters are bound to <CODE>rl_insert</CODE>.
3896: The bindings are performed in <VAR>kmap</VAR>.
3897: </DL>
3898: </P><P>
3899:
3900: <A NAME="IDX310"></A>
3901: <DL>
3902: <DT><U>Function:</U> int <B>rl_reset_terminal</B> <I>(const char *terminal_name)</I>
3903: <DD>Reinitialize Readline's idea of the terminal settings using
3904: <VAR>terminal_name</VAR> as the terminal type (e.g., <CODE>vt100</CODE>).
3905: If <VAR>terminal_name</VAR> is <CODE>NULL</CODE>, the value of the <CODE>TERM</CODE>
3906: environment variable is used.
3907: </DL>
3908: </P><P>
3909:
3910: <A NAME="Utility Functions"></A>
3911: <HR SIZE="6">
3912: <A NAME="SEC39"></A>
3913: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
3914: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC38"> < </A>]</TD>
3915: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC40"> > </A>]</TD>
3916: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD>
3917: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
3918: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
3919: <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>
3920: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
3921: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
3922: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
3923: </TR></TABLE>
3924: <H3> 2.4.10 Utility Functions </H3>
3925: <!--docid::SEC39::-->
3926: <P>
3927:
3928: <A NAME="IDX311"></A>
3929: <DL>
3930: <DT><U>Function:</U> int <B>rl_save_state</B> <I>(struct readline_state *sp)</I>
3931: <DD>Save a snapshot of Readline's internal state to <VAR>sp</VAR>.
3932: The contents of the <VAR>readline_state</VAR> structure are documented
3933: in <TT>`readline.h'</TT>.
3934: The caller is responsible for allocating the structure.
3935: </DL>
3936: </P><P>
3937:
3938: <A NAME="IDX312"></A>
3939: <DL>
3940: <DT><U>Function:</U> int <B>rl_restore_state</B> <I>(struct readline_state *sp)</I>
3941: <DD>Restore Readline's internal state to that stored in <VAR>sp</VAR>, which must
3942: have been saved by a call to <CODE>rl_save_state</CODE>.
3943: The contents of the <VAR>readline_state</VAR> structure are documented
3944: in <TT>`readline.h'</TT>.
3945: The caller is responsible for freeing the structure.
3946: </DL>
3947: </P><P>
3948:
3949: <A NAME="IDX313"></A>
3950: <DL>
3951: <DT><U>Function:</U> void <B>rl_free</B> <I>(void *mem)</I>
3952: <DD>Deallocate the memory pointed to by <VAR>mem</VAR>. <VAR>mem</VAR> must have been
3953: allocated by <CODE>malloc</CODE>.
3954: </DL>
3955: </P><P>
3956:
3957: <A NAME="IDX314"></A>
3958: <DL>
3959: <DT><U>Function:</U> void <B>rl_replace_line</B> <I>(const char *text, int clear_undo)</I>
3960: <DD>Replace the contents of <CODE>rl_line_buffer</CODE> with <VAR>text</VAR>.
3961: The point and mark are preserved, if possible.
3962: If <VAR>clear_undo</VAR> is non-zero, the undo list associated with the
3963: current line is cleared.
3964: </DL>
3965: </P><P>
3966:
3967: <A NAME="IDX315"></A>
3968: <DL>
3969: <DT><U>Function:</U> void <B>rl_extend_line_buffer</B> <I>(int len)</I>
3970: <DD>Ensure that <CODE>rl_line_buffer</CODE> has enough space to hold <VAR>len</VAR>
3971: characters, possibly reallocating it if necessary.
3972: </DL>
3973: </P><P>
3974:
3975: <A NAME="IDX316"></A>
3976: <DL>
3977: <DT><U>Function:</U> int <B>rl_initialize</B> <I>(void)</I>
3978: <DD>Initialize or re-initialize Readline's internal state.
3979: It's not strictly necessary to call this; <CODE>readline()</CODE> calls it before
3980: reading any input.
3981: </DL>
3982: </P><P>
3983:
3984: <A NAME="IDX317"></A>
3985: <DL>
3986: <DT><U>Function:</U> int <B>rl_ding</B> <I>(void)</I>
3987: <DD>Ring the terminal bell, obeying the setting of <CODE>bell-style</CODE>.
3988: </DL>
3989: </P><P>
3990:
3991: <A NAME="IDX318"></A>
3992: <DL>
3993: <DT><U>Function:</U> int <B>rl_alphabetic</B> <I>(int c)</I>
3994: <DD>Return 1 if <VAR>c</VAR> is an alphabetic character.
3995: </DL>
3996: </P><P>
3997:
3998: <A NAME="IDX319"></A>
3999: <DL>
4000: <DT><U>Function:</U> void <B>rl_display_match_list</B> <I>(char **matches, int len, int max)</I>
4001: <DD>A convenience function for displaying a list of strings in
4002: columnar format on Readline's output stream. <CODE>matches</CODE> is the list
4003: of strings, in argv format, such as a list of completion matches.
4004: <CODE>len</CODE> is the number of strings in <CODE>matches</CODE>, and <CODE>max</CODE>
4005: is the length of the longest string in <CODE>matches</CODE>. This function uses
4006: the setting of <CODE>print-completions-horizontally</CODE> to select how the
4007: matches are displayed (see section <A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A>).
4008: When displaying completions, this function sets the number of columns used
4009: for display to the value of <CODE>completion-display-width</CODE>, the value of
4010: the environment variable <CODE>COLUMNS</CODE>, or the screen width, in that order.
4011: </DL>
4012: </P><P>
4013:
4014: The following are implemented as macros, defined in <CODE>chardefs.h</CODE>.
4015: Applications should refrain from using them.
4016: </P><P>
4017:
4018: <A NAME="IDX320"></A>
4019: <DL>
4020: <DT><U>Function:</U> int <B>_rl_uppercase_p</B> <I>(int c)</I>
4021: <DD>Return 1 if <VAR>c</VAR> is an uppercase alphabetic character.
4022: </DL>
4023: </P><P>
4024:
4025: <A NAME="IDX321"></A>
4026: <DL>
4027: <DT><U>Function:</U> int <B>_rl_lowercase_p</B> <I>(int c)</I>
4028: <DD>Return 1 if <VAR>c</VAR> is a lowercase alphabetic character.
4029: </DL>
4030: </P><P>
4031:
4032: <A NAME="IDX322"></A>
4033: <DL>
4034: <DT><U>Function:</U> int <B>_rl_digit_p</B> <I>(int c)</I>
4035: <DD>Return 1 if <VAR>c</VAR> is a numeric character.
4036: </DL>
4037: </P><P>
4038:
4039: <A NAME="IDX323"></A>
4040: <DL>
4041: <DT><U>Function:</U> int <B>_rl_to_upper</B> <I>(int c)</I>
4042: <DD>If <VAR>c</VAR> is a lowercase alphabetic character, return the corresponding
4043: uppercase character.
4044: </DL>
4045: </P><P>
4046:
4047: <A NAME="IDX324"></A>
4048: <DL>
4049: <DT><U>Function:</U> int <B>_rl_to_lower</B> <I>(int c)</I>
4050: <DD>If <VAR>c</VAR> is an uppercase alphabetic character, return the corresponding
4051: lowercase character.
4052: </DL>
4053: </P><P>
4054:
4055: <A NAME="IDX325"></A>
4056: <DL>
4057: <DT><U>Function:</U> int <B>_rl_digit_value</B> <I>(int c)</I>
4058: <DD>If <VAR>c</VAR> is a number, return the value it represents.
4059: </DL>
4060: </P><P>
4061:
4062: <A NAME="Miscellaneous Functions"></A>
4063: <HR SIZE="6">
4064: <A NAME="SEC40"></A>
4065: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4066: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC39"> < </A>]</TD>
4067: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC41"> > </A>]</TD>
4068: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD>
4069: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
4070: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
4071: <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>
4072: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4073: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4074: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4075: </TR></TABLE>
4076: <H3> 2.4.11 Miscellaneous Functions </H3>
4077: <!--docid::SEC40::-->
4078: <P>
4079:
4080: <A NAME="IDX326"></A>
4081: <DL>
4082: <DT><U>Function:</U> int <B>rl_macro_bind</B> <I>(const char *keyseq, const char *macro, Keymap map)</I>
4083: <DD>Bind the key sequence <VAR>keyseq</VAR> to invoke the macro <VAR>macro</VAR>.
4084: The binding is performed in <VAR>map</VAR>. When <VAR>keyseq</VAR> is invoked, the
4085: <VAR>macro</VAR> will be inserted into the line. This function is deprecated;
4086: use <CODE>rl_generic_bind()</CODE> instead.
4087: </DL>
4088: </P><P>
4089:
4090: <A NAME="IDX327"></A>
4091: <DL>
4092: <DT><U>Function:</U> void <B>rl_macro_dumper</B> <I>(int readable)</I>
4093: <DD>Print the key sequences bound to macros and their values, using
4094: the current keymap, to <CODE>rl_outstream</CODE>.
4095: If <VAR>readable</VAR> is non-zero, the list is formatted in such a way
4096: that it can be made part of an <CODE>inputrc</CODE> file and re-read.
4097: </DL>
4098: </P><P>
4099:
4100: <A NAME="IDX328"></A>
4101: <DL>
4102: <DT><U>Function:</U> int <B>rl_variable_bind</B> <I>(const char *variable, const char *value)</I>
4103: <DD>Make the Readline variable <VAR>variable</VAR> have <VAR>value</VAR>.
4104: This behaves as if the readline command
4105: <SAMP>`set <VAR>variable</VAR> <VAR>value</VAR>'</SAMP> had been executed in an <CODE>inputrc</CODE>
4106: file (see section <A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A>).
4107: </DL>
4108: </P><P>
4109:
4110: <A NAME="IDX329"></A>
4111: <DL>
4112: <DT><U>Function:</U> char * <B>rl_variable_value</B> <I>(const char *variable)</I>
4113: <DD>Return a string representing the value of the Readline variable <VAR>variable</VAR>.
4114: For boolean variables, this string is either <SAMP>`on'</SAMP> or <SAMP>`off'</SAMP>.
4115: </DL>
4116: </P><P>
4117:
4118: <A NAME="IDX330"></A>
4119: <DL>
4120: <DT><U>Function:</U> void <B>rl_variable_dumper</B> <I>(int readable)</I>
4121: <DD>Print the readline variable names and their current values
4122: to <CODE>rl_outstream</CODE>.
4123: If <VAR>readable</VAR> is non-zero, the list is formatted in such a way
4124: that it can be made part of an <CODE>inputrc</CODE> file and re-read.
4125: </DL>
4126: </P><P>
4127:
4128: <A NAME="IDX331"></A>
4129: <DL>
4130: <DT><U>Function:</U> int <B>rl_set_paren_blink_timeout</B> <I>(int u)</I>
4131: <DD>Set the time interval (in microseconds) that Readline waits when showing
4132: a balancing character when <CODE>blink-matching-paren</CODE> has been enabled.
4133: </DL>
4134: </P><P>
4135:
4136: <A NAME="IDX332"></A>
4137: <DL>
4138: <DT><U>Function:</U> char * <B>rl_get_termcap</B> <I>(const char *cap)</I>
4139: <DD>Retrieve the string value of the termcap capability <VAR>cap</VAR>.
4140: Readline fetches the termcap entry for the current terminal name and
4141: uses those capabilities to move around the screen line and perform other
4142: terminal-specific operations, like erasing a line. Readline does not
4143: use all of a terminal's capabilities, and this function will return
4144: values for only those capabilities Readline uses.
4145: </DL>
4146: </P><P>
4147:
4148: <A NAME="IDX333"></A>
4149: <DL>
4150: <DT><U>Function:</U> void <B>rl_clear_history</B> <I>(void)</I>
4151: <DD>Clear the history list by deleting all of the entries, in the same manner
4152: as the History library's <CODE>clear_history()</CODE> function.
4153: This differs from <CODE>clear_history</CODE> because it frees private data
4154: Readline saves in the history list.
4155: </DL>
4156: </P><P>
4157:
4158: <A NAME="Alternate Interface"></A>
4159: <HR SIZE="6">
4160: <A NAME="SEC41"></A>
4161: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4162: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC40"> < </A>]</TD>
4163: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC42"> > </A>]</TD>
4164: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD>
4165: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
4166: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
4167: <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>
4168: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4169: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4170: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4171: </TR></TABLE>
4172: <H3> 2.4.12 Alternate Interface </H3>
4173: <!--docid::SEC41::-->
4174: <P>
4175:
4176: An alternate interface is available to plain <CODE>readline()</CODE>. Some
4177: applications need to interleave keyboard I/O with file, device, or
4178: window system I/O, typically by using a main loop to <CODE>select()</CODE>
4179: on various file descriptors. To accommodate this need, readline can
4180: also be invoked as a `callback' function from an event loop. There
4181: are functions available to make this easy.
4182: </P><P>
4183:
4184: <A NAME="IDX334"></A>
4185: <DL>
4186: <DT><U>Function:</U> void <B>rl_callback_handler_install</B> <I>(const char *prompt, rl_vcpfunc_t *lhandler)</I>
4187: <DD>Set up the terminal for readline I/O and display the initial
4188: expanded value of <VAR>prompt</VAR>. Save the value of <VAR>lhandler</VAR> to
4189: use as a handler function to call when a complete line of input has been
4190: entered.
4191: The handler function receives the text of the line as an argument.
4192: </DL>
4193: </P><P>
4194:
4195: <A NAME="IDX335"></A>
4196: <DL>
4197: <DT><U>Function:</U> void <B>rl_callback_read_char</B> <I>(void)</I>
4198: <DD>Whenever an application determines that keyboard input is available, it
4199: should call <CODE>rl_callback_read_char()</CODE>, which will read the next
4200: character from the current input source.
4201: If that character completes the line, <CODE>rl_callback_read_char</CODE> will
4202: invoke the <VAR>lhandler</VAR> function installed by
4203: <CODE>rl_callback_handler_install</CODE> to process the line.
4204: Before calling the <VAR>lhandler</VAR> function, the terminal settings are
4205: reset to the values they had before calling
4206: <CODE>rl_callback_handler_install</CODE>.
4207: If the <VAR>lhandler</VAR> function returns,
4208: and the line handler remains installed,
4209: the terminal settings are modified for Readline's use again.
4210: <CODE>EOF</CODE> is indicated by calling <VAR>lhandler</VAR> with a
4211: <CODE>NULL</CODE> line.
4212: </DL>
4213: </P><P>
4214:
4215: <A NAME="IDX336"></A>
4216: <DL>
4217: <DT><U>Function:</U> void <B>rl_callback_handler_remove</B> <I>(void)</I>
4218: <DD>Restore the terminal to its initial state and remove the line handler.
4219: This may be called from within a callback as well as independently.
4220: If the <VAR>lhandler</VAR> installed by <CODE>rl_callback_handler_install</CODE>
4221: does not exit the program, either this function or the function referred
4222: to by the value of <CODE>rl_deprep_term_function</CODE> should be called before
4223: the program exits to reset the terminal settings.
4224: </DL>
4225: </P><P>
4226:
4227: <A NAME="A Readline Example"></A>
4228: <HR SIZE="6">
4229: <A NAME="SEC42"></A>
4230: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4231: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC41"> < </A>]</TD>
4232: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> > </A>]</TD>
4233: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD>
4234: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
4235: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
4236: <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>
4237: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4238: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4239: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4240: </TR></TABLE>
4241: <H3> 2.4.13 A Readline Example </H3>
4242: <!--docid::SEC42::-->
4243: <P>
4244:
4245: Here is a function which changes lowercase characters to their uppercase
4246: equivalents, and uppercase characters to lowercase. If
4247: this function was bound to <SAMP>`M-c'</SAMP>, then typing <SAMP>`M-c'</SAMP> would
4248: change the case of the character under point. Typing <SAMP>`M-1 0 M-c'</SAMP>
4249: would change the case of the following 10 characters, leaving the cursor on
4250: the last character changed.
4251: </P><P>
4252:
4253: <TABLE><tr><td> </td><td class=example><pre>/* Invert the case of the COUNT following characters. */
4254: int
4255: invert_case_line (count, key)
4256: int count, key;
4257: {
4258: register int start, end, i;
4259:
4260: start = rl_point;
4261:
4262: if (rl_point >= rl_end)
4263: return (0);
4264:
4265: if (count < 0)
4266: {
4267: direction = -1;
4268: count = -count;
4269: }
4270: else
4271: direction = 1;
4272:
4273: /* Find the end of the range to modify. */
4274: end = start + (count * direction);
4275:
4276: /* Force it to be within range. */
4277: if (end > rl_end)
4278: end = rl_end;
4279: else if (end < 0)
4280: end = 0;
4281:
4282: if (start == end)
4283: return (0);
4284:
4285: if (start > end)
4286: {
4287: int temp = start;
4288: start = end;
4289: end = temp;
4290: }
4291:
4292: /* Tell readline that we are modifying the line,
4293: so it will save the undo information. */
4294: rl_modifying (start, end);
4295:
4296: for (i = start; i != end; i++)
4297: {
4298: if (_rl_uppercase_p (rl_line_buffer[i]))
4299: rl_line_buffer[i] = _rl_to_lower (rl_line_buffer[i]);
4300: else if (_rl_lowercase_p (rl_line_buffer[i]))
4301: rl_line_buffer[i] = _rl_to_upper (rl_line_buffer[i]);
4302: }
4303: /* Move point to on top of the last character changed. */
4304: rl_point = (direction == 1) ? end - 1 : start;
4305: return (0);
4306: }
4307: </pre></td></tr></table></P><P>
4308:
4309: <A NAME="Alternate Interface Example"></A>
4310: <HR SIZE="6">
4311: <A NAME="SEC43"></A>
4312: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4313: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC42"> < </A>]</TD>
4314: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> > </A>]</TD>
4315: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC31"> << </A>]</TD>
4316: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC29"> Up </A>]</TD>
4317: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> >> </A>]</TD>
4318: <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>
4319: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4320: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4321: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4322: </TR></TABLE>
4323: <H3> 2.4.14 Alternate Interface Example </H3>
4324: <!--docid::SEC43::-->
4325: <P>
4326:
4327: Here is a complete program that illustrates Readline's alternate interface.
4328: It reads lines from the terminal and displays them, providing the
4329: standard history and TAB completion functions.
4330: It understands the EOF character or "exit" to exit the program.
4331: </P><P>
4332:
4333: <TABLE><tr><td> </td><td class=example><pre>/* Standard include files. stdio.h is required. */
4334: #include <stdlib.h>
4335: #include <unistd.h>
4336:
4337: /* Used for select(2) */
4338: #include <sys/types.h>
4339: #include <sys/select.h>
4340:
4341: #include <stdio.h>
4342:
4343: /* Standard readline include files. */
4344: #include <readline/readline.h>
4345: #include <readline/history.h>
4346:
4347: static void cb_linehandler (char *);
4348:
4349: int running;
4350: const char *prompt = "rltest$ ";
4351:
4352: /* Callback function called for each line when accept-line executed, EOF
4353: seen, or EOF character read. This sets a flag and returns; it could
4354: also call exit(3). */
4355: static void
4356: cb_linehandler (char *line)
4357: {
4358: /* Can use ^D (stty eof) or `exit' to exit. */
4359: if (line == NULL || strcmp (line, "exit") == 0)
4360: {
4361: if (line == 0)
4362: printf ("\n");
4363: printf ("exit\n");
4364: /* This function needs to be called to reset the terminal settings,
4365: and calling it from the line handler keeps one extra prompt from
4366: being displayed. */
4367: rl_callback_handler_remove ();
4368:
4369: running = 0;
4370: }
4371: else
4372: {
4373: if (*line)
4374: add_history (line);
4375: printf ("input line: %s\n", line);
4376: free (line);
4377: }
4378: }
4379:
4380: int
4381: main (int c, char **v)
4382: {
4383: fd_set fds;
4384: int r;
4385:
4386: /* Install the line handler. */
4387: rl_callback_handler_install (prompt, cb_linehandler);
4388:
4389: /* Enter a simple event loop. This waits until something is available
4390: to read on readline's input stream (defaults to standard input) and
4391: calls the builtin character read callback to read it. It does not
4392: have to modify the user's terminal settings. */
4393: running = 1;
4394: while (running)
4395: {
4396: FD_ZERO (&fds);
4397: FD_SET (fileno (rl_instream), &fds);
4398:
4399: r = select (FD_SETSIZE, &fds, NULL, NULL, NULL);
4400: if (r < 0)
4401: {
4402: perror ("rltest: select");
4403: rl_callback_handler_remove ();
4404: break;
4405: }
4406:
4407: if (FD_ISSET (fileno (rl_instream), &fds))
4408: rl_callback_read_char ();
4409: }
4410:
4411: printf ("rltest: Event loop has exited\n");
4412: return 0;
4413: }
4414: </pre></td></tr></table></P><P>
4415:
4416: <A NAME="Readline Signal Handling"></A>
4417: <HR SIZE="6">
4418: <A NAME="SEC44"></A>
4419: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4420: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC43"> < </A>]</TD>
4421: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> > </A>]</TD>
4422: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> << </A>]</TD>
4423: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD>
4424: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
4425: <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>
4426: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4427: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4428: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4429: </TR></TABLE>
4430: <H2> 2.5 Readline Signal Handling </H2>
4431: <!--docid::SEC44::-->
4432: <P>
4433:
4434: Signals are asynchronous events sent to a process by the Unix kernel,
4435: sometimes on behalf of another process. They are intended to indicate
4436: exceptional events, like a user pressing the interrupt key on his terminal,
4437: or a network connection being broken. There is a class of signals that can
4438: be sent to the process currently reading input from the keyboard. Since
4439: Readline changes the terminal attributes when it is called, it needs to
4440: perform special processing when such a signal is received in order to
4441: restore the terminal to a sane state, or provide application writers with
4442: functions to do so manually.
4443: </P><P>
4444:
4445: Readline contains an internal signal handler that is installed for a
4446: number of signals (<CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <CODE>SIGTERM</CODE>,
4447: <CODE>SIGHUP</CODE>,
4448: <CODE>SIGALRM</CODE>, <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>, and <CODE>SIGTTOU</CODE>).
4449: When one of these signals is received, the signal handler
4450: will reset the terminal attributes to those that were in effect before
4451: <CODE>readline()</CODE> was called, reset the signal handling to what it was
4452: before <CODE>readline()</CODE> was called, and resend the signal to the calling
4453: application.
4454: If and when the calling application's signal handler returns, Readline
4455: will reinitialize the terminal and continue to accept input.
4456: When a <CODE>SIGINT</CODE> is received, the Readline signal handler performs
4457: some additional work, which will cause any partially-entered line to be
4458: aborted (see the description of <CODE>rl_free_line_state()</CODE> below).
4459: </P><P>
4460:
4461: There is an additional Readline signal handler, for <CODE>SIGWINCH</CODE>, which
4462: the kernel sends to a process whenever the terminal's size changes (for
4463: example, if a user resizes an <CODE>xterm</CODE>). The Readline <CODE>SIGWINCH</CODE>
4464: handler updates Readline's internal screen size information, and then calls
4465: any <CODE>SIGWINCH</CODE> signal handler the calling application has installed.
4466: Readline calls the application's <CODE>SIGWINCH</CODE> signal handler without
4467: resetting the terminal to its original state. If the application's signal
4468: handler does more than update its idea of the terminal size and return (for
4469: example, a <CODE>longjmp</CODE> back to a main processing loop), it <EM>must</EM>
4470: call <CODE>rl_cleanup_after_signal()</CODE> (described below), to restore the
4471: terminal state.
4472: </P><P>
4473:
4474: Readline provides two variables that allow application writers to
4475: control whether or not it will catch certain signals and act on them
4476: when they are received. It is important that applications change the
4477: values of these variables only when calling <CODE>readline()</CODE>, not in
4478: a signal handler, so Readline's internal signal state is not corrupted.
4479: </P><P>
4480:
4481: <A NAME="IDX337"></A>
4482: <DL>
4483: <DT><U>Variable:</U> int <B>rl_catch_signals</B>
4484: <DD>If this variable is non-zero, Readline will install signal handlers for
4485: <CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <CODE>SIGTERM</CODE>, <CODE>SIGHUP</CODE>, <CODE>SIGALRM</CODE>,
4486: <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>, and <CODE>SIGTTOU</CODE>.
4487: </P><P>
4488:
4489: The default value of <CODE>rl_catch_signals</CODE> is 1.
4490: </DL>
4491: </P><P>
4492:
4493: <A NAME="IDX338"></A>
4494: <DL>
4495: <DT><U>Variable:</U> int <B>rl_catch_sigwinch</B>
4496: <DD>If this variable is set to a non-zero value,
4497: Readline will install a signal handler for <CODE>SIGWINCH</CODE>.
4498: </P><P>
4499:
4500: The default value of <CODE>rl_catch_sigwinch</CODE> is 1.
4501: </DL>
4502: </P><P>
4503:
4504: <A NAME="IDX339"></A>
4505: <DL>
4506: <DT><U>Variable:</U> int <B>rl_change_environment</B>
4507: <DD>If this variable is set to a non-zero value,
4508: and Readline is handling <CODE>SIGWINCH</CODE>, Readline will modify the
4509: <VAR>LINES</VAR> and <VAR>COLUMNS</VAR> environment variables upon receipt of a
4510: <CODE>SIGWINCH</CODE>
4511: </P><P>
4512:
4513: The default value of <CODE>rl_change_environment</CODE> is 1.
4514: </DL>
4515: </P><P>
4516:
4517: If an application does not wish to have Readline catch any signals, or
4518: to handle signals other than those Readline catches (<CODE>SIGHUP</CODE>,
4519: for example),
4520: Readline provides convenience functions to do the necessary terminal
4521: and internal state cleanup upon receipt of a signal.
4522: </P><P>
4523:
4524: <A NAME="IDX340"></A>
4525: <DL>
4526: <DT><U>Function:</U> void <B>rl_cleanup_after_signal</B> <I>(void)</I>
4527: <DD>This function will reset the state of the terminal to what it was before
4528: <CODE>readline()</CODE> was called, and remove the Readline signal handlers for
4529: all signals, depending on the values of <CODE>rl_catch_signals</CODE> and
4530: <CODE>rl_catch_sigwinch</CODE>.
4531: </DL>
4532: </P><P>
4533:
4534: <A NAME="IDX341"></A>
4535: <DL>
4536: <DT><U>Function:</U> void <B>rl_free_line_state</B> <I>(void)</I>
4537: <DD>This will free any partial state associated with the current input line
4538: (undo information, any partial history entry, any partially-entered
4539: keyboard macro, and any partially-entered numeric argument). This
4540: should be called before <CODE>rl_cleanup_after_signal()</CODE>. The
4541: Readline signal handler for <CODE>SIGINT</CODE> calls this to abort the
4542: current input line.
4543: </DL>
4544: </P><P>
4545:
4546: <A NAME="IDX342"></A>
4547: <DL>
4548: <DT><U>Function:</U> void <B>rl_reset_after_signal</B> <I>(void)</I>
4549: <DD>This will reinitialize the terminal and reinstall any Readline signal
4550: handlers, depending on the values of <CODE>rl_catch_signals</CODE> and
4551: <CODE>rl_catch_sigwinch</CODE>.
4552: </DL>
4553: </P><P>
4554:
4555: If an application does not wish Readline to catch <CODE>SIGWINCH</CODE>, it may
4556: call <CODE>rl_resize_terminal()</CODE> or <CODE>rl_set_screen_size()</CODE> to force
4557: Readline to update its idea of the terminal size when a <CODE>SIGWINCH</CODE>
4558: is received.
4559: </P><P>
4560:
4561: <A NAME="IDX343"></A>
4562: <DL>
4563: <DT><U>Function:</U> void <B>rl_echo_signal_char</B> <I>(int sig)</I>
4564: <DD>If an application wishes to install its own signal handlers, but still
4565: have readline display characters that generate signals, calling this
4566: function with <VAR>sig</VAR> set to <CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, or
4567: <CODE>SIGTSTP</CODE> will display the character generating that signal.
4568: </DL>
4569: </P><P>
4570:
4571: <A NAME="IDX344"></A>
4572: <DL>
4573: <DT><U>Function:</U> void <B>rl_resize_terminal</B> <I>(void)</I>
4574: <DD>Update Readline's internal screen size by reading values from the kernel.
4575: </DL>
4576: </P><P>
4577:
4578: <A NAME="IDX345"></A>
4579: <DL>
4580: <DT><U>Function:</U> void <B>rl_set_screen_size</B> <I>(int rows, int cols)</I>
4581: <DD>Set Readline's idea of the terminal size to <VAR>rows</VAR> rows and
4582: <VAR>cols</VAR> columns. If either <VAR>rows</VAR> or <VAR>columns</VAR> is less than
4583: or equal to 0, Readline's idea of that terminal dimension is unchanged.
4584: </DL>
4585: </P><P>
4586:
4587: If an application does not want to install a <CODE>SIGWINCH</CODE> handler, but
4588: is still interested in the screen dimensions, Readline's idea of the screen
4589: size may be queried.
4590: </P><P>
4591:
4592: <A NAME="IDX346"></A>
4593: <DL>
4594: <DT><U>Function:</U> void <B>rl_get_screen_size</B> <I>(int *rows, int *cols)</I>
4595: <DD>Return Readline's idea of the terminal's size in the
4596: variables pointed to by the arguments.
4597: </DL>
4598: </P><P>
4599:
4600: <A NAME="IDX347"></A>
4601: <DL>
4602: <DT><U>Function:</U> void <B>rl_reset_screen_size</B> <I>(void)</I>
4603: <DD>Cause Readline to reobtain the screen size and recalculate its dimensions.
4604: </DL>
4605: </P><P>
4606:
4607: The following functions install and remove Readline's signal handlers.
4608: </P><P>
4609:
4610: <A NAME="IDX348"></A>
4611: <DL>
4612: <DT><U>Function:</U> int <B>rl_set_signals</B> <I>(void)</I>
4613: <DD>Install Readline's signal handler for <CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>,
4614: <CODE>SIGTERM</CODE>, <CODE>SIGHUP</CODE>, <CODE>SIGALRM</CODE>, <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>,
4615: <CODE>SIGTTOU</CODE>, and <CODE>SIGWINCH</CODE>, depending on the values of
4616: <CODE>rl_catch_signals</CODE> and <CODE>rl_catch_sigwinch</CODE>.
4617: </DL>
4618: </P><P>
4619:
4620: <A NAME="IDX349"></A>
4621: <DL>
4622: <DT><U>Function:</U> int <B>rl_clear_signals</B> <I>(void)</I>
4623: <DD>Remove all of the Readline signal handlers installed by
4624: <CODE>rl_set_signals()</CODE>.
4625: </DL>
4626: </P><P>
4627:
4628: <A NAME="Custom Completers"></A>
4629: <HR SIZE="6">
4630: <A NAME="SEC45"></A>
4631: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4632: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC44"> < </A>]</TD>
4633: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC46"> > </A>]</TD>
4634: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
4635: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> Up </A>]</TD>
4636: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
4637: <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>
4638: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4639: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4640: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4641: </TR></TABLE>
4642: <H2> 2.6 Custom Completers </H2>
4643: <!--docid::SEC45::-->
4644: <P>
4645:
4646: Typically, a program that reads commands from the user has a way of
4647: disambiguating commands and data. If your program is one of these, then
4648: it can provide completion for commands, data, or both.
4649: The following sections describe how your program and Readline
4650: cooperate to provide this service.
4651: </P><P>
4652:
4653: <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>
4654: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC46">2.6.1 How Completing Works</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">The logic used to do completion.</TD></TR>
4655: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Functions provided by Readline.</TD></TR>
4656: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">Variables which control completion.</TD></TR>
4657: <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="readline.html#SEC49">2.6.4 A Short Completion Example</A></TD><TD> </TD><TD ALIGN="left" VALIGN="TOP">An example of writing completer subroutines.</TD></TR>
4658: </TABLE></BLOCKQUOTE>
4659: <P>
4660:
4661: <A NAME="How Completing Works"></A>
4662: <HR SIZE="6">
4663: <A NAME="SEC46"></A>
4664: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4665: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> < </A>]</TD>
4666: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC47"> > </A>]</TD>
4667: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
4668: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> Up </A>]</TD>
4669: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
4670: <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>
4671: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4672: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4673: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4674: </TR></TABLE>
4675: <H3> 2.6.1 How Completing Works </H3>
4676: <!--docid::SEC46::-->
4677: <P>
4678:
4679: In order to complete some text, the full list of possible completions
4680: must be available. That is, it is not possible to accurately
4681: expand a partial word without knowing all of the possible words
4682: which make sense in that context. The Readline library provides
4683: the user interface to completion, and two of the most common
4684: completion functions: filename and username. For completing other types
4685: of text, you must write your own completion function. This section
4686: describes exactly what such functions must do, and provides an example.
4687: </P><P>
4688:
4689: There are three major functions used to perform completion:
4690: </P><P>
4691:
4692: <OL>
4693: <LI>
4694: The user-interface function <CODE>rl_complete()</CODE>. This function is
4695: called with the same arguments as other bindable Readline functions:
4696: <VAR>count</VAR> and <VAR>invoking_key</VAR>.
4697: It isolates the word to be completed and calls
4698: <CODE>rl_completion_matches()</CODE> to generate a list of possible completions.
4699: It then either lists the possible completions, inserts the possible
4700: completions, or actually performs the
4701: completion, depending on which behavior is desired.
4702: <P>
4703:
4704: <LI>
4705: The internal function <CODE>rl_completion_matches()</CODE> uses an
4706: application-supplied <EM>generator</EM> function to generate the list of
4707: possible matches, and then returns the array of these matches.
4708: The caller should place the address of its generator function in
4709: <CODE>rl_completion_entry_function</CODE>.
4710: <P>
4711:
4712: <LI>
4713: The generator function is called repeatedly from
4714: <CODE>rl_completion_matches()</CODE>, returning a string each time. The
4715: arguments to the generator function are <VAR>text</VAR> and <VAR>state</VAR>.
4716: <VAR>text</VAR> is the partial word to be completed. <VAR>state</VAR> is zero the
4717: first time the function is called, allowing the generator to perform
4718: any necessary initialization, and a positive non-zero integer for
4719: each subsequent call. The generator function returns
4720: <CODE>(char *)NULL</CODE> to inform <CODE>rl_completion_matches()</CODE> that there are
4721: no more possibilities left. Usually the generator function computes the
4722: list of possible completions when <VAR>state</VAR> is zero, and returns them
4723: one at a time on subsequent calls. Each string the generator function
4724: returns as a match must be allocated with <CODE>malloc()</CODE>; Readline
4725: frees the strings when it has finished with them.
4726: Such a generator function is referred to as an
4727: <EM>application-specific completion function</EM>.
4728: <P>
4729:
4730: </OL>
4731: <P>
4732:
4733: <A NAME="IDX350"></A>
4734: <DL>
4735: <DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I>
4736: <DD>Complete the word at or before point. You have supplied the function
4737: that does the initial simple matching selection algorithm (see
4738: <CODE>rl_completion_matches()</CODE>). The default is to do filename completion.
4739: </DL>
4740: </P><P>
4741:
4742: <A NAME="IDX351"></A>
4743: <DL>
4744: <DT><U>Variable:</U> rl_compentry_func_t * <B>rl_completion_entry_function</B>
4745: <DD>This is a pointer to the generator function for
4746: <CODE>rl_completion_matches()</CODE>.
4747: If the value of <CODE>rl_completion_entry_function</CODE> is
4748: <CODE>NULL</CODE> then the default filename generator
4749: function, <CODE>rl_filename_completion_function()</CODE>, is used.
4750: An <EM>application-specific completion function</EM> is a function whose
4751: address is assigned to <CODE>rl_completion_entry_function</CODE> and whose
4752: return values are used to generate possible completions.
4753: </DL>
4754: </P><P>
4755:
4756: <A NAME="Completion Functions"></A>
4757: <HR SIZE="6">
4758: <A NAME="SEC47"></A>
4759: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4760: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC46"> < </A>]</TD>
4761: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC48"> > </A>]</TD>
4762: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC48"> << </A>]</TD>
4763: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> Up </A>]</TD>
4764: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
4765: <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>
4766: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4767: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4768: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4769: </TR></TABLE>
4770: <H3> 2.6.2 Completion Functions </H3>
4771: <!--docid::SEC47::-->
4772: <P>
4773:
4774: Here is the complete list of callable completion functions present in
4775: Readline.
4776: </P><P>
4777:
4778: <A NAME="IDX352"></A>
4779: <DL>
4780: <DT><U>Function:</U> int <B>rl_complete_internal</B> <I>(int what_to_do)</I>
4781: <DD>Complete the word at or before point. <VAR>what_to_do</VAR> says what to do
4782: with the completion. A value of <SAMP>`?'</SAMP> means list the possible
4783: completions. <SAMP>`TAB'</SAMP> means do standard completion. <SAMP>`*'</SAMP> means
4784: insert all of the possible completions. <SAMP>`!'</SAMP> means to display
4785: all of the possible completions, if there is more than one, as well as
4786: performing partial completion. <SAMP>`@'</SAMP> is similar to <SAMP>`!'</SAMP>, but
4787: possible completions are not listed if the possible completions share
4788: a common prefix.
4789: </DL>
4790: </P><P>
4791:
4792: <A NAME="IDX353"></A>
4793: <DL>
4794: <DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I>
4795: <DD>Complete the word at or before point. You have supplied the function
4796: that does the initial simple matching selection algorithm (see
4797: <CODE>rl_completion_matches()</CODE> and <CODE>rl_completion_entry_function</CODE>).
4798: The default is to do filename
4799: completion. This calls <CODE>rl_complete_internal()</CODE> with an
4800: argument depending on <VAR>invoking_key</VAR>.
4801: </DL>
4802: </P><P>
4803:
4804: <A NAME="IDX354"></A>
4805: <DL>
4806: <DT><U>Function:</U> int <B>rl_possible_completions</B> <I>(int count, int invoking_key)</I>
4807: <DD>List the possible completions. See description of <CODE>rl_complete
4808: ()</CODE>. This calls <CODE>rl_complete_internal()</CODE> with an argument of
4809: <SAMP>`?'</SAMP>.
4810: </DL>
4811: </P><P>
4812:
4813: <A NAME="IDX355"></A>
4814: <DL>
4815: <DT><U>Function:</U> int <B>rl_insert_completions</B> <I>(int count, int invoking_key)</I>
4816: <DD>Insert the list of possible completions into the line, deleting the
4817: partially-completed word. See description of <CODE>rl_complete()</CODE>.
4818: This calls <CODE>rl_complete_internal()</CODE> with an argument of <SAMP>`*'</SAMP>.
4819: </DL>
4820: </P><P>
4821:
4822: <A NAME="IDX356"></A>
4823: <DL>
4824: <DT><U>Function:</U> int <B>rl_completion_mode</B> <I>(rl_command_func_t *cfunc)</I>
4825: <DD>Returns the appropriate value to pass to <CODE>rl_complete_internal()</CODE>
4826: depending on whether <VAR>cfunc</VAR> was called twice in succession and
4827: the values of the <CODE>show-all-if-ambiguous</CODE> and
4828: <CODE>show-all-if-unmodified</CODE> variables.
4829: Application-specific completion functions may use this function to present
4830: the same interface as <CODE>rl_complete()</CODE>.
4831: </DL>
4832: </P><P>
4833:
4834: <A NAME="IDX357"></A>
4835: <DL>
4836: <DT><U>Function:</U> char ** <B>rl_completion_matches</B> <I>(const char *text, rl_compentry_func_t *entry_func)</I>
4837: <DD>Returns an array of strings which is a list of completions for
4838: <VAR>text</VAR>. If there are no completions, returns <CODE>NULL</CODE>.
4839: The first entry in the returned array is the substitution for <VAR>text</VAR>.
4840: The remaining entries are the possible completions. The array is
4841: terminated with a <CODE>NULL</CODE> pointer.
4842: </P><P>
4843:
4844: <VAR>entry_func</VAR> is a function of two args, and returns a
4845: <CODE>char *</CODE>. The first argument is <VAR>text</VAR>. The second is a
4846: state argument; it is zero on the first call, and non-zero on subsequent
4847: calls. <VAR>entry_func</VAR> returns a <CODE>NULL</CODE> pointer to the caller
4848: when there are no more matches.
4849: </DL>
4850: </P><P>
4851:
4852: <A NAME="IDX358"></A>
4853: <DL>
4854: <DT><U>Function:</U> char * <B>rl_filename_completion_function</B> <I>(const char *text, int state)</I>
4855: <DD>A generator function for filename completion in the general case.
4856: <VAR>text</VAR> is a partial filename.
4857: The Bash source is a useful reference for writing application-specific
4858: completion functions (the Bash completion functions call this and other
4859: Readline functions).
4860: </DL>
4861: </P><P>
4862:
4863: <A NAME="IDX359"></A>
4864: <DL>
4865: <DT><U>Function:</U> char * <B>rl_username_completion_function</B> <I>(const char *text, int state)</I>
4866: <DD>A completion generator for usernames. <VAR>text</VAR> contains a partial
4867: username preceded by a random character (usually <SAMP>`~'</SAMP>). As with all
4868: completion generators, <VAR>state</VAR> is zero on the first call and non-zero
4869: for subsequent calls.
4870: </DL>
4871: </P><P>
4872:
4873: <A NAME="Completion Variables"></A>
4874: <HR SIZE="6">
4875: <A NAME="SEC48"></A>
4876: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
4877: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC47"> < </A>]</TD>
4878: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49"> > </A>]</TD>
4879: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49"> << </A>]</TD>
4880: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> Up </A>]</TD>
4881: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
4882: <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>
4883: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
4884: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
4885: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
4886: </TR></TABLE>
4887: <H3> 2.6.3 Completion Variables </H3>
4888: <!--docid::SEC48::-->
4889: <P>
4890:
4891: <A NAME="IDX360"></A>
4892: <DL>
4893: <DT><U>Variable:</U> rl_compentry_func_t * <B>rl_completion_entry_function</B>
4894: <DD>A pointer to the generator function for <CODE>rl_completion_matches()</CODE>.
4895: <CODE>NULL</CODE> means to use <CODE>rl_filename_completion_function()</CODE>,
4896: the default filename completer.
4897: </DL>
4898: </P><P>
4899:
4900: <A NAME="IDX361"></A>
4901: <DL>
4902: <DT><U>Variable:</U> rl_completion_func_t * <B>rl_attempted_completion_function</B>
4903: <DD>A pointer to an alternative function to create matches.
4904: The function is called with <VAR>text</VAR>, <VAR>start</VAR>, and <VAR>end</VAR>.
4905: <VAR>start</VAR> and <VAR>end</VAR> are indices in <CODE>rl_line_buffer</CODE> defining
4906: the boundaries of <VAR>text</VAR>, which is a character string.
4907: If this function exists and returns <CODE>NULL</CODE>, or if this variable is
4908: set to <CODE>NULL</CODE>, then <CODE>rl_complete()</CODE> will call the value of
4909: <CODE>rl_completion_entry_function</CODE> to generate matches, otherwise the
4910: array of strings returned will be used.
4911: If this function sets the <CODE>rl_attempted_completion_over</CODE>
4912: variable to a non-zero value, Readline will not perform its default
4913: completion even if this function returns no matches.
4914: </DL>
4915: </P><P>
4916:
4917: <A NAME="IDX362"></A>
4918: <DL>
4919: <DT><U>Variable:</U> rl_quote_func_t * <B>rl_filename_quoting_function</B>
4920: <DD>A pointer to a function that will quote a filename in an
4921: application-specific fashion. This is called if filename completion is being
4922: attempted and one of the characters in <CODE>rl_filename_quote_characters</CODE>
4923: appears in a completed filename. The function is called with
4924: <VAR>text</VAR>, <VAR>match_type</VAR>, and <VAR>quote_pointer</VAR>. The <VAR>text</VAR>
4925: is the filename to be quoted. The <VAR>match_type</VAR> is either
4926: <CODE>SINGLE_MATCH</CODE>, if there is only one completion match, or
4927: <CODE>MULT_MATCH</CODE>. Some functions use this to decide whether or not to
4928: insert a closing quote character. The <VAR>quote_pointer</VAR> is a pointer
4929: to any opening quote character the user typed. Some functions choose
4930: to reset this character.
4931: </DL>
4932: </P><P>
4933:
4934: <A NAME="IDX363"></A>
4935: <DL>
4936: <DT><U>Variable:</U> rl_dequote_func_t * <B>rl_filename_dequoting_function</B>
4937: <DD>A pointer to a function that will remove application-specific quoting
4938: characters from a filename before completion is attempted, so those
4939: characters do not interfere with matching the text against names in
4940: the filesystem. It is called with <VAR>text</VAR>, the text of the word
4941: to be dequoted, and <VAR>quote_char</VAR>, which is the quoting character
4942: that delimits the filename (usually <SAMP>`''</SAMP> or <SAMP>`"'</SAMP>). If
4943: <VAR>quote_char</VAR> is zero, the filename was not in an embedded string.
4944: </DL>
4945: </P><P>
4946:
4947: <A NAME="IDX364"></A>
4948: <DL>
4949: <DT><U>Variable:</U> rl_linebuf_func_t * <B>rl_char_is_quoted_p</B>
4950: <DD>A pointer to a function to call that determines whether or not a specific
4951: character in the line buffer is quoted, according to whatever quoting
4952: mechanism the program calling Readline uses. The function is called with
4953: two arguments: <VAR>text</VAR>, the text of the line, and <VAR>index</VAR>, the
4954: index of the character in the line. It is used to decide whether a
4955: character found in <CODE>rl_completer_word_break_characters</CODE> should be
4956: used to break words for the completer.
4957: </DL>
4958: </P><P>
4959:
4960: <A NAME="IDX365"></A>
4961: <DL>
4962: <DT><U>Variable:</U> rl_compignore_func_t * <B>rl_ignore_some_completions_function</B>
4963: <DD>This function, if defined, is called by the completer when real filename
4964: completion is done, after all the matching names have been generated.
4965: It is passed a <CODE>NULL</CODE> terminated array of matches.
4966: The first element (<CODE>matches[0]</CODE>) is the
4967: maximal substring common to all matches. This function can
4968: re-arrange the list of matches as required, but each element deleted
4969: from the array must be freed.
4970: </DL>
4971: </P><P>
4972:
4973: <A NAME="IDX366"></A>
4974: <DL>
4975: <DT><U>Variable:</U> rl_icppfunc_t * <B>rl_directory_completion_hook</B>
4976: <DD>This function, if defined, is allowed to modify the directory portion
4977: of filenames Readline completes.
4978: It could be used to expand symbolic links or shell variables in pathnames.
4979: It is called with the address of a string (the current directory name) as an
4980: argument, and may modify that string.
4981: If the string is replaced with a new string, the old value should be freed.
4982: Any modified directory name should have a trailing slash.
4983: The modified value will be used as part of the completion, replacing
4984: the directory portion of the pathname the user typed.
4985: At the least, even if no other expansion is performed, this function should
4986: remove any quote characters from the directory name, because its result will
4987: be passed directly to <CODE>opendir()</CODE>.
4988: </P><P>
4989:
4990: The directory completion hook returns an integer that should be non-zero if
4991: the function modifies its directory argument.
4992: The function should not modify the directory argument if it returns 0.
4993: </DL>
4994: </P><P>
4995:
4996: <A NAME="IDX367"></A>
4997: <DL>
4998: <DT><U>Variable:</U> rl_icppfunc_t * <B>rl_directory_rewrite_hook;</B>
4999: <DD>If non-zero, this is the address of a function to call when completing
5000: a directory name. This function takes the address of the directory name
5001: to be modified as an argument. Unlike <CODE>rl_directory_completion_hook</CODE>,
5002: it only modifies the directory name used in <CODE>opendir</CODE>, not what is
5003: displayed when the possible completions are printed or inserted. It is
5004: called before rl_directory_completion_hook.
5005: At the least, even if no other expansion is performed, this function should
5006: remove any quote characters from the directory name, because its result will
5007: be passed directly to <CODE>opendir()</CODE>.
5008: </P><P>
5009:
5010: The directory rewrite hook returns an integer that should be non-zero if
5011: the function modfies its directory argument.
5012: The function should not modify the directory argument if it returns 0.
5013: </DL>
5014: </P><P>
5015:
5016: <A NAME="IDX368"></A>
5017: <DL>
5018: <DT><U>Variable:</U> rl_icppfunc_t * <B>rl_filename_stat_hook</B>
5019: <DD>If non-zero, this is the address of a function for the completer to
5020: call before deciding which character to append to a completed name.
5021: This function modifies its filename name argument, and the modified value
5022: is passed to <CODE>stat()</CODE> to determine the file's type and characteristics.
5023: This function does not need to remove quote characters from the filename.
5024: </P><P>
5025:
5026: The stat hook returns an integer that should be non-zero if
5027: the function modfies its directory argument.
5028: The function should not modify the directory argument if it returns 0.
5029: </DL>
5030: </P><P>
5031:
5032: <A NAME="IDX369"></A>
5033: <DL>
5034: <DT><U>Variable:</U> rl_dequote_func_t * <B>rl_filename_rewrite_hook</B>
5035: <DD>If non-zero, this is the address of a function called when reading
5036: directory entries from the filesystem for completion and comparing
5037: them to the partial word to be completed. The function should
5038: perform any necessary application or system-specific conversion on
5039: the filename, such as converting between character sets or converting
5040: from a filesystem format to a character input format.
5041: The function takes two arguments: <VAR>fname</VAR>, the filename to be converted,
5042: and <VAR>fnlen</VAR>, its length in bytes.
5043: It must either return its first argument (if no conversion takes place)
5044: or the converted filename in newly-allocated memory. The converted
5045: form is used to compare against the word to be completed, and, if it
5046: matches, is added to the list of matches. Readline will free the
5047: allocated string.
5048: </DL>
5049: </P><P>
5050:
5051: <A NAME="IDX370"></A>
5052: <DL>
5053: <DT><U>Variable:</U> rl_compdisp_func_t * <B>rl_completion_display_matches_hook</B>
5054: <DD>If non-zero, then this is the address of a function to call when
5055: completing a word would normally display the list of possible matches.
5056: This function is called in lieu of Readline displaying the list.
5057: It takes three arguments:
5058: (<CODE>char **</CODE><VAR>matches</VAR>, <CODE>int</CODE> <VAR>num_matches</VAR>, <CODE>int</CODE> <VAR>max_length</VAR>)
5059: where <VAR>matches</VAR> is the array of matching strings,
5060: <VAR>num_matches</VAR> is the number of strings in that array, and
5061: <VAR>max_length</VAR> is the length of the longest string in that array.
5062: Readline provides a convenience function, <CODE>rl_display_match_list</CODE>,
5063: that takes care of doing the display to Readline's output stream. That
5064: function may be called from this hook.
5065: </DL>
5066: </P><P>
5067:
5068: <A NAME="IDX371"></A>
5069: <DL>
5070: <DT><U>Variable:</U> const char * <B>rl_basic_word_break_characters</B>
5071: <DD>The basic list of characters that signal a break between words for the
5072: completer routine. The default value of this variable is the characters
5073: which break words for completion in Bash:
5074: <CODE>" \t\n\"\\'`@$><=;|&{("</CODE>.
5075: </DL>
5076: </P><P>
5077:
5078: <A NAME="IDX372"></A>
5079: <DL>
5080: <DT><U>Variable:</U> const char * <B>rl_basic_quote_characters</B>
5081: <DD>A list of quote characters which can cause a word break.
5082: </DL>
5083: </P><P>
5084:
5085: <A NAME="IDX373"></A>
5086: <DL>
5087: <DT><U>Variable:</U> const char * <B>rl_completer_word_break_characters</B>
5088: <DD>The list of characters that signal a break between words for
5089: <CODE>rl_complete_internal()</CODE>. The default list is the value of
5090: <CODE>rl_basic_word_break_characters</CODE>.
5091: </DL>
5092: </P><P>
5093:
5094: <A NAME="IDX374"></A>
5095: <DL>
5096: <DT><U>Variable:</U> rl_cpvfunc_t * <B>rl_completion_word_break_hook</B>
5097: <DD>If non-zero, this is the address of a function to call when Readline is
5098: deciding where to separate words for word completion. It should return
5099: a character string like <CODE>rl_completer_word_break_characters</CODE> to be
5100: used to perform the current completion. The function may choose to set
5101: <CODE>rl_completer_word_break_characters</CODE> itself. If the function
5102: returns <CODE>NULL</CODE>, <CODE>rl_completer_word_break_characters</CODE> is used.
5103: </DL>
5104: </P><P>
5105:
5106: <A NAME="IDX375"></A>
5107: <DL>
5108: <DT><U>Variable:</U> const char * <B>rl_completer_quote_characters</B>
5109: <DD>A list of characters which can be used to quote a substring of the line.
5110: Completion occurs on the entire substring, and within the substring
5111: <CODE>rl_completer_word_break_characters</CODE> are treated as any other character,
5112: unless they also appear within this list.
5113: </DL>
5114: </P><P>
5115:
5116: <A NAME="IDX376"></A>
5117: <DL>
5118: <DT><U>Variable:</U> const char * <B>rl_filename_quote_characters</B>
5119: <DD>A list of characters that cause a filename to be quoted by the completer
5120: when they appear in a completed filename. The default is the null string.
5121: </DL>
5122: </P><P>
5123:
5124: <A NAME="IDX377"></A>
5125: <DL>
5126: <DT><U>Variable:</U> const char * <B>rl_special_prefixes</B>
5127: <DD>The list of characters that are word break characters, but should be
5128: left in <VAR>text</VAR> when it is passed to the completion function.
5129: Programs can use this to help determine what kind of completing to do.
5130: For instance, Bash sets this variable to "$@" so that it can complete
5131: shell variables and hostnames.
5132: </DL>
5133: </P><P>
5134:
5135: <A NAME="IDX378"></A>
5136: <DL>
5137: <DT><U>Variable:</U> int <B>rl_completion_query_items</B>
5138: <DD>Up to this many items will be displayed in response to a
5139: possible-completions call. After that, readline asks the user if she is sure
5140: she wants to see them all. The default value is 100. A negative value
5141: indicates that Readline should never ask the user.
5142: </DL>
5143: </P><P>
5144:
5145: <A NAME="IDX379"></A>
5146: <DL>
5147: <DT><U>Variable:</U> int <B>rl_completion_append_character</B>
5148: <DD>When a single completion alternative matches at the end of the command
5149: line, this character is appended to the inserted completion text. The
5150: default is a space character (<SAMP>` '</SAMP>). Setting this to the null
5151: character (<SAMP>`\0'</SAMP>) prevents anything being appended automatically.
5152: This can be changed in application-specific completion functions to
5153: provide the "most sensible word separator character" according to
5154: an application-specific command line syntax specification.
5155: </DL>
5156: </P><P>
5157:
5158: <A NAME="IDX380"></A>
5159: <DL>
5160: <DT><U>Variable:</U> int <B>rl_completion_suppress_append</B>
5161: <DD>If non-zero, <VAR>rl_completion_append_character</VAR> is not appended to
5162: matches at the end of the command line, as described above.
5163: It is set to 0 before any application-specific completion function
5164: is called, and may only be changed within such a function.
5165: </DL>
5166: </P><P>
5167:
5168: <A NAME="IDX381"></A>
5169: <DL>
5170: <DT><U>Variable:</U> int <B>rl_completion_quote_character</B>
5171: <DD>When Readline is completing quoted text, as delimited by one of the
5172: characters in <VAR>rl_completer_quote_characters</VAR>, it sets this variable
5173: to the quoting character found.
5174: This is set before any application-specific completion function is called.
5175: </DL>
5176: </P><P>
5177:
5178: <A NAME="IDX382"></A>
5179: <DL>
5180: <DT><U>Variable:</U> int <B>rl_completion_suppress_quote</B>
5181: <DD>If non-zero, Readline does not append a matching quote character when
5182: performing completion on a quoted string.
5183: It is set to 0 before any application-specific completion function
5184: is called, and may only be changed within such a function.
5185: </DL>
5186: </P><P>
5187:
5188: <A NAME="IDX383"></A>
5189: <DL>
5190: <DT><U>Variable:</U> int <B>rl_completion_found_quote</B>
5191: <DD>When Readline is completing quoted text, it sets this variable
5192: to a non-zero value if the word being completed contains or is delimited
5193: by any quoting characters, including backslashes.
5194: This is set before any application-specific completion function is called.
5195: </DL>
5196: </P><P>
5197:
5198: <A NAME="IDX384"></A>
5199: <DL>
5200: <DT><U>Variable:</U> int <B>rl_completion_mark_symlink_dirs</B>
5201: <DD>If non-zero, a slash will be appended to completed filenames that are
5202: symbolic links to directory names, subject to the value of the
5203: user-settable <VAR>mark-directories</VAR> variable.
5204: This variable exists so that application-specific completion functions
5205: can override the user's global preference (set via the
5206: <VAR>mark-symlinked-directories</VAR> Readline variable) if appropriate.
5207: This variable is set to the user's preference before any
5208: application-specific completion function is called, so unless that
5209: function modifies the value, the user's preferences are honored.
5210: </DL>
5211: </P><P>
5212:
5213: <A NAME="IDX385"></A>
5214: <DL>
5215: <DT><U>Variable:</U> int <B>rl_ignore_completion_duplicates</B>
5216: <DD>If non-zero, then duplicates in the matches are removed.
5217: The default is 1.
5218: </DL>
5219: </P><P>
5220:
5221: <A NAME="IDX386"></A>
5222: <DL>
5223: <DT><U>Variable:</U> int <B>rl_filename_completion_desired</B>
5224: <DD>Non-zero means that the results of the matches are to be treated as
5225: filenames. This is <EM>always</EM> zero when completion is attempted,
5226: and can only be changed
5227: within an application-specific completion function. If it is set to a
5228: non-zero value by such a function, directory names have a slash appended
5229: and Readline attempts to quote completed filenames if they contain any
5230: characters in <CODE>rl_filename_quote_characters</CODE> and
5231: <CODE>rl_filename_quoting_desired</CODE> is set to a non-zero value.
5232: </DL>
5233: </P><P>
5234:
5235: <A NAME="IDX387"></A>
5236: <DL>
5237: <DT><U>Variable:</U> int <B>rl_filename_quoting_desired</B>
5238: <DD>Non-zero means that the results of the matches are to be quoted using
5239: double quotes (or an application-specific quoting mechanism) if the
5240: completed filename contains any characters in
5241: <CODE>rl_filename_quote_chars</CODE>. This is <EM>always</EM> non-zero
5242: when completion is attempted, and can only be changed within an
5243: application-specific completion function.
5244: The quoting is effected via a call to the function pointed to
5245: by <CODE>rl_filename_quoting_function</CODE>.
5246: </DL>
5247: </P><P>
5248:
5249: <A NAME="IDX388"></A>
5250: <DL>
5251: <DT><U>Variable:</U> int <B>rl_attempted_completion_over</B>
5252: <DD>If an application-specific completion function assigned to
5253: <CODE>rl_attempted_completion_function</CODE> sets this variable to a non-zero
5254: value, Readline will not perform its default filename completion even
5255: if the application's completion function returns no matches.
5256: It should be set only by an application's completion function.
5257: </DL>
5258: </P><P>
5259:
5260: <A NAME="IDX389"></A>
5261: <DL>
5262: <DT><U>Variable:</U> int <B>rl_sort_completion_matches</B>
5263: <DD>If an application sets this variable to 0, Readline will not sort the
5264: list of completions (which implies that it cannot remove any duplicate
5265: completions). The default value is 1, which means that Readline will
5266: sort the completions and, depending on the value of
5267: <CODE>rl_ignore_completion_duplicates</CODE>, will attempt to remove duplicate
5268: matches.
5269: </DL>
5270: </P><P>
5271:
5272: <A NAME="IDX390"></A>
5273: <DL>
5274: <DT><U>Variable:</U> int <B>rl_completion_type</B>
5275: <DD>Set to a character describing the type of completion Readline is currently
5276: attempting; see the description of <CODE>rl_complete_internal()</CODE>
5277: (see section <A HREF="readline.html#SEC47">2.6.2 Completion Functions</A>) for the list of characters.
5278: This is set to the appropriate value before any application-specific
5279: completion function is called, allowing such functions to present
5280: the same interface as <CODE>rl_complete()</CODE>.
5281: </DL>
5282: </P><P>
5283:
5284: <A NAME="IDX391"></A>
5285: <DL>
5286: <DT><U>Variable:</U> int <B>rl_completion_invoking_key</B>
5287: <DD>Set to the final character in the key sequence that invoked one of the
5288: completion functions that call <CODE>rl_complete_internal()</CODE>. This is
5289: set to the appropriate value before any application-specific completion
5290: function is called.
5291: </DL>
5292: </P><P>
5293:
5294: <A NAME="IDX392"></A>
5295: <DL>
5296: <DT><U>Variable:</U> int <B>rl_inhibit_completion</B>
5297: <DD>If this variable is non-zero, completion is inhibited. The completion
5298: character will be inserted as any other bound to <CODE>self-insert</CODE>.
5299: </DL>
5300: </P><P>
5301:
5302: <A NAME="A Short Completion Example"></A>
5303: <HR SIZE="6">
5304: <A NAME="SEC49"></A>
5305: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
5306: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC48"> < </A>]</TD>
5307: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> > </A>]</TD>
5308: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
5309: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC45"> Up </A>]</TD>
5310: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> >> </A>]</TD>
5311: <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>
5312: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
5313: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
5314: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
5315: </TR></TABLE>
5316: <H3> 2.6.4 A Short Completion Example </H3>
5317: <!--docid::SEC49::-->
5318: <P>
5319:
5320: Here is a small application demonstrating the use of the GNU Readline
5321: library. It is called <CODE>fileman</CODE>, and the source code resides in
5322: <TT>`examples/fileman.c'</TT>. This sample application provides
5323: completion of command names, line editing features, and access to the
5324: history list.
5325: </P><P>
5326:
5327: <TABLE><tr><td> </td><td class=smallexample><FONT SIZE=-1><pre>/* fileman.c -- A tiny application which demonstrates how to use the
5328: GNU Readline library. This application interactively allows users
5329: to manipulate files and their modes. */
5330:
5331: #ifdef HAVE_CONFIG_H
5332: # include <config.h>
5333: #endif
5334:
5335: #include <sys/types.h>
5336: #ifdef HAVE_SYS_FILE_H
5337: # include <sys/file.h>
5338: #endif
5339: #include <sys/stat.h>
5340:
5341: #ifdef HAVE_UNISTD_H
5342: # include <unistd.h>
5343: #endif
5344:
5345: #include <fcntl.h>
5346: #include <stdio.h>
5347: #include <errno.h>
5348:
5349: #if defined (HAVE_STRING_H)
5350: # include <string.h>
5351: #else /* !HAVE_STRING_H */
5352: # include <strings.h>
5353: #endif /* !HAVE_STRING_H */
5354:
5355: #ifdef HAVE_STDLIB_H
5356: # include <stdlib.h>
5357: #endif
5358:
5359: #include <time.h>
5360:
5361: #include <readline/readline.h>
5362: #include <readline/history.h>
5363:
5364: extern char *xmalloc PARAMS((size_t));
5365:
5366: /* The names of functions that actually do the manipulation. */
5367: int com_list PARAMS((char *));
5368: int com_view PARAMS((char *));
5369: int com_rename PARAMS((char *));
5370: int com_stat PARAMS((char *));
5371: int com_pwd PARAMS((char *));
5372: int com_delete PARAMS((char *));
5373: int com_help PARAMS((char *));
5374: int com_cd PARAMS((char *));
5375: int com_quit PARAMS((char *));
5376:
5377: /* A structure which contains information on the commands this program
5378: can understand. */
5379:
5380: typedef struct {
5381: char *name; /* User printable name of the function. */
5382: rl_icpfunc_t *func; /* Function to call to do the job. */
5383: char *doc; /* Documentation for this function. */
5384: } COMMAND;
5385:
5386: COMMAND commands[] = {
5387: { "cd", com_cd, "Change to directory DIR" },
5388: { "delete", com_delete, "Delete FILE" },
5389: { "help", com_help, "Display this text" },
5390: { "?", com_help, "Synonym for `help'" },
5391: { "list", com_list, "List files in DIR" },
5392: { "ls", com_list, "Synonym for `list'" },
5393: { "pwd", com_pwd, "Print the current working directory" },
5394: { "quit", com_quit, "Quit using Fileman" },
5395: { "rename", com_rename, "Rename FILE to NEWNAME" },
5396: { "stat", com_stat, "Print out statistics on FILE" },
5397: { "view", com_view, "View the contents of FILE" },
5398: { (char *)NULL, (rl_icpfunc_t *)NULL, (char *)NULL }
5399: };
5400:
5401: /* Forward declarations. */
5402: char *stripwhite ();
5403: COMMAND *find_command ();
5404:
5405: /* The name of this program, as taken from argv[0]. */
5406: char *progname;
5407:
5408: /* When non-zero, this global means the user is done using this program. */
5409: int done;
5410:
5411: char *
5412: dupstr (s)
5413: char *s;
5414: {
5415: char *r;
5416:
5417: r = xmalloc (strlen (s) + 1);
5418: strcpy (r, s);
5419: return (r);
5420: }
5421:
5422: main (argc, argv)
5423: int argc;
5424: char **argv;
5425: {
5426: char *line, *s;
5427:
5428: progname = argv[0];
5429:
5430: initialize_readline (); /* Bind our completer. */
5431:
5432: /* Loop reading and executing lines until the user quits. */
5433: for ( ; done == 0; )
5434: {
5435: line = readline ("FileMan: ");
5436:
5437: if (!line)
5438: break;
5439:
5440: /* Remove leading and trailing whitespace from the line.
5441: Then, if there is anything left, add it to the history list
5442: and execute it. */
5443: s = stripwhite (line);
5444:
5445: if (*s)
5446: {
5447: add_history (s);
5448: execute_line (s);
5449: }
5450:
5451: free (line);
5452: }
5453: exit (0);
5454: }
5455:
5456: /* Execute a command line. */
5457: int
5458: execute_line (line)
5459: char *line;
5460: {
5461: register int i;
5462: COMMAND *command;
5463: char *word;
5464:
5465: /* Isolate the command word. */
5466: i = 0;
5467: while (line[i] && whitespace (line[i]))
5468: i++;
5469: word = line + i;
5470:
5471: while (line[i] && !whitespace (line[i]))
5472: i++;
5473:
5474: if (line[i])
5475: line[i++] = '\0';
5476:
5477: command = find_command (word);
5478:
5479: if (!command)
5480: {
5481: fprintf (stderr, "%s: No such command for FileMan.\n", word);
5482: return (-1);
5483: }
5484:
5485: /* Get argument to command, if any. */
5486: while (whitespace (line[i]))
5487: i++;
5488:
5489: word = line + i;
5490:
5491: /* Call the function. */
5492: return ((*(command->func)) (word));
5493: }
5494:
5495: /* Look up NAME as the name of a command, and return a pointer to that
5496: command. Return a NULL pointer if NAME isn't a command name. */
5497: COMMAND *
5498: find_command (name)
5499: char *name;
5500: {
5501: register int i;
5502:
5503: for (i = 0; commands[i].name; i++)
5504: if (strcmp (name, commands[i].name) == 0)
5505: return (&commands[i]);
5506:
5507: return ((COMMAND *)NULL);
5508: }
5509:
5510: /* Strip whitespace from the start and end of STRING. Return a pointer
5511: into STRING. */
5512: char *
5513: stripwhite (string)
5514: char *string;
5515: {
5516: register char *s, *t;
5517:
5518: for (s = string; whitespace (*s); s++)
5519: ;
5520:
5521: if (*s == 0)
5522: return (s);
5523:
5524: t = s + strlen (s) - 1;
5525: while (t > s && whitespace (*t))
5526: t--;
5527: *++t = '\0';
5528:
5529: return s;
5530: }
5531:
5532: /* **************************************************************** */
5533: /* */
5534: /* Interface to Readline Completion */
5535: /* */
5536: /* **************************************************************** */
5537:
5538: char *command_generator PARAMS((const char *, int));
5539: char **fileman_completion PARAMS((const char *, int, int));
5540:
5541: /* Tell the GNU Readline library how to complete. We want to try to complete
5542: on command names if this is the first word in the line, or on filenames
5543: if not. */
5544: initialize_readline ()
5545: {
5546: /* Allow conditional parsing of the ~/.inputrc file. */
5547: rl_readline_name = "FileMan";
5548:
5549: /* Tell the completer that we want a crack first. */
5550: rl_attempted_completion_function = fileman_completion;
5551: }
5552:
5553: /* Attempt to complete on the contents of TEXT. START and END bound the
5554: region of rl_line_buffer that contains the word to complete. TEXT is
5555: the word to complete. We can use the entire contents of rl_line_buffer
5556: in case we want to do some simple parsing. Return the array of matches,
5557: or NULL if there aren't any. */
5558: char **
5559: fileman_completion (text, start, end)
5560: const char *text;
5561: int start, end;
5562: {
5563: char **matches;
5564:
5565: matches = (char **)NULL;
5566:
5567: /* If this word is at the start of the line, then it is a command
5568: to complete. Otherwise it is the name of a file in the current
5569: directory. */
5570: if (start == 0)
5571: matches = rl_completion_matches (text, command_generator);
5572:
5573: return (matches);
5574: }
5575:
5576: /* Generator function for command completion. STATE lets us know whether
5577: to start from scratch; without any state (i.e. STATE == 0), then we
5578: start at the top of the list. */
5579: char *
5580: command_generator (text, state)
5581: const char *text;
5582: int state;
5583: {
5584: static int list_index, len;
5585: char *name;
5586:
5587: /* If this is a new word to complete, initialize now. This includes
5588: saving the length of TEXT for efficiency, and initializing the index
5589: variable to 0. */
5590: if (!state)
5591: {
5592: list_index = 0;
5593: len = strlen (text);
5594: }
5595:
5596: /* Return the next name which partially matches from the command list. */
5597: while (name = commands[list_index].name)
5598: {
5599: list_index++;
5600:
5601: if (strncmp (name, text, len) == 0)
5602: return (dupstr(name));
5603: }
5604:
5605: /* If no names matched, then return NULL. */
5606: return ((char *)NULL);
5607: }
5608:
5609: /* **************************************************************** */
5610: /* */
5611: /* FileMan Commands */
5612: /* */
5613: /* **************************************************************** */
5614:
5615: /* String to pass to system (). This is for the LIST, VIEW and RENAME
5616: commands. */
5617: static char syscom[1024];
5618:
5619: /* List the file(s) named in arg. */
5620: com_list (arg)
5621: char *arg;
5622: {
5623: if (!arg)
5624: arg = "";
5625:
5626: sprintf (syscom, "ls -FClg %s", arg);
5627: return (system (syscom));
5628: }
5629:
5630: com_view (arg)
5631: char *arg;
5632: {
5633: if (!valid_argument ("view", arg))
5634: return 1;
5635:
5636: #if defined (__MSDOS__)
5637: /* more.com doesn't grok slashes in pathnames */
5638: sprintf (syscom, "less %s", arg);
5639: #else
5640: sprintf (syscom, "more %s", arg);
5641: #endif
5642: return (system (syscom));
5643: }
5644:
5645: com_rename (arg)
5646: char *arg;
5647: {
5648: too_dangerous ("rename");
5649: return (1);
5650: }
5651:
5652: com_stat (arg)
5653: char *arg;
5654: {
5655: struct stat finfo;
5656:
5657: if (!valid_argument ("stat", arg))
5658: return (1);
5659:
5660: if (stat (arg, &finfo) == -1)
5661: {
5662: perror (arg);
5663: return (1);
5664: }
5665:
5666: printf ("Statistics for `%s':\n", arg);
5667:
5668: printf ("%s has %d link%s, and is %d byte%s in length.\n",
5669: arg,
5670: finfo.st_nlink,
5671: (finfo.st_nlink == 1) ? "" : "s",
5672: finfo.st_size,
5673: (finfo.st_size == 1) ? "" : "s");
5674: printf ("Inode Last Change at: %s", ctime (&finfo.st_ctime));
5675: printf (" Last access at: %s", ctime (&finfo.st_atime));
5676: printf (" Last modified at: %s", ctime (&finfo.st_mtime));
5677: return (0);
5678: }
5679:
5680: com_delete (arg)
5681: char *arg;
5682: {
5683: too_dangerous ("delete");
5684: return (1);
5685: }
5686:
5687: /* Print out help for ARG, or for all of the commands if ARG is
5688: not present. */
5689: com_help (arg)
5690: char *arg;
5691: {
5692: register int i;
5693: int printed = 0;
5694:
5695: for (i = 0; commands[i].name; i++)
5696: {
5697: if (!*arg || (strcmp (arg, commands[i].name) == 0))
5698: {
5699: printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc);
5700: printed++;
5701: }
5702: }
5703:
5704: if (!printed)
5705: {
5706: printf ("No commands match `%s'. Possibilties are:\n", arg);
5707:
5708: for (i = 0; commands[i].name; i++)
5709: {
5710: /* Print in six columns. */
5711: if (printed == 6)
5712: {
5713: printed = 0;
5714: printf ("\n");
5715: }
5716:
5717: printf ("%s\t", commands[i].name);
5718: printed++;
5719: }
5720:
5721: if (printed)
5722: printf ("\n");
5723: }
5724: return (0);
5725: }
5726:
5727: /* Change to the directory ARG. */
5728: com_cd (arg)
5729: char *arg;
5730: {
5731: if (chdir (arg) == -1)
5732: {
5733: perror (arg);
5734: return 1;
5735: }
5736:
5737: com_pwd ("");
5738: return (0);
5739: }
5740:
5741: /* Print out the current working directory. */
5742: com_pwd (ignore)
5743: char *ignore;
5744: {
5745: char dir[1024], *s;
5746:
5747: s = getcwd (dir, sizeof(dir) - 1);
5748: if (s == 0)
5749: {
5750: printf ("Error getting pwd: %s\n", dir);
5751: return 1;
5752: }
5753:
5754: printf ("Current directory is %s\n", dir);
5755: return 0;
5756: }
5757:
5758: /* The user wishes to quit using this program. Just set DONE non-zero. */
5759: com_quit (arg)
5760: char *arg;
5761: {
5762: done = 1;
5763: return (0);
5764: }
5765:
5766: /* Function which tells you that you can't do this. */
5767: too_dangerous (caller)
5768: char *caller;
5769: {
5770: fprintf (stderr,
5771: "%s: Too dangerous for me to distribute. Write it yourself.\n",
5772: caller);
5773: }
5774:
5775: /* Return non-zero if ARG is a valid argument for CALLER, else print
5776: an error message and return zero. */
5777: int
5778: valid_argument (caller, arg)
5779: char *caller, *arg;
5780: {
5781: if (!arg || !*arg)
5782: {
5783: fprintf (stderr, "%s: Argument required.\n", caller);
5784: return (0);
5785: }
5786:
5787: return (1);
5788: }
5789: </FONT></pre></td></tr></table></P><P>
5790:
5791: <A NAME="GNU Free Documentation License"></A>
5792: <HR SIZE="6">
5793: <A NAME="SEC50"></A>
5794: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
5795: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC49"> < </A>]</TD>
5796: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52"> > </A>]</TD>
5797: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC23"> << </A>]</TD>
5798: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD>
5799: <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD>
5800: <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>
5801: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
5802: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
5803: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
5804: </TR></TABLE>
5805: <H1> A. GNU Free Documentation License </H1>
5806: <!--docid::SEC50::-->
5807: <P>
5808:
5809: <center>
5810: Version 1.3, 3 November 2008
5811: </center>
5812: </P><P>
5813:
5814: <TABLE><tr><td> </td><td class=display><pre style="font-family: serif">Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
5815: <A HREF="http://fsf.org/">http://fsf.org/</A>
5816:
5817: Everyone is permitted to copy and distribute verbatim copies
5818: of this license document, but changing it is not allowed.
5819: </pre></td></tr></table></P><P>
5820:
5821: <OL>
5822: <LI>
5823: PREAMBLE
5824: <P>
5825:
5826: The purpose of this License is to make a manual, textbook, or other
5827: functional and useful document <EM>free</EM> in the sense of freedom: to
5828: assure everyone the effective freedom to copy and redistribute it,
5829: with or without modifying it, either commercially or noncommercially.
5830: Secondarily, this License preserves for the author and publisher a way
5831: to get credit for their work, while not being considered responsible
5832: for modifications made by others.
5833: </P><P>
5834:
5835: This License is a kind of "copyleft", which means that derivative
5836: works of the document must themselves be free in the same sense. It
5837: complements the GNU General Public License, which is a copyleft
5838: license designed for free software.
5839: </P><P>
5840:
5841: We have designed this License in order to use it for manuals for free
5842: software, because free software needs free documentation: a free
5843: program should come with manuals providing the same freedoms that the
5844: software does. But this License is not limited to software manuals;
5845: it can be used for any textual work, regardless of subject matter or
5846: whether it is published as a printed book. We recommend this License
5847: principally for works whose purpose is instruction or reference.
5848: </P><P>
5849:
5850: <LI>
5851: APPLICABILITY AND DEFINITIONS
5852: <P>
5853:
5854: This License applies to any manual or other work, in any medium, that
5855: contains a notice placed by the copyright holder saying it can be
5856: distributed under the terms of this License. Such a notice grants a
5857: world-wide, royalty-free license, unlimited in duration, to use that
5858: work under the conditions stated herein. The "Document", below,
5859: refers to any such manual or work. Any member of the public is a
5860: licensee, and is addressed as "you". You accept the license if you
5861: copy, modify or distribute the work in a way requiring permission
5862: under copyright law.
5863: </P><P>
5864:
5865: A "Modified Version" of the Document means any work containing the
5866: Document or a portion of it, either copied verbatim, or with
5867: modifications and/or translated into another language.
5868: </P><P>
5869:
5870: A "Secondary Section" is a named appendix or a front-matter section
5871: of the Document that deals exclusively with the relationship of the
5872: publishers or authors of the Document to the Document's overall
5873: subject (or to related matters) and contains nothing that could fall
5874: directly within that overall subject. (Thus, if the Document is in
5875: part a textbook of mathematics, a Secondary Section may not explain
5876: any mathematics.) The relationship could be a matter of historical
5877: connection with the subject or with related matters, or of legal,
5878: commercial, philosophical, ethical or political position regarding
5879: them.
5880: </P><P>
5881:
5882: The "Invariant Sections" are certain Secondary Sections whose titles
5883: are designated, as being those of Invariant Sections, in the notice
5884: that says that the Document is released under this License. If a
5885: section does not fit the above definition of Secondary then it is not
5886: allowed to be designated as Invariant. The Document may contain zero
5887: Invariant Sections. If the Document does not identify any Invariant
5888: Sections then there are none.
5889: </P><P>
5890:
5891: The "Cover Texts" are certain short passages of text that are listed,
5892: as Front-Cover Texts or Back-Cover Texts, in the notice that says that
5893: the Document is released under this License. A Front-Cover Text may
5894: be at most 5 words, and a Back-Cover Text may be at most 25 words.
5895: </P><P>
5896:
5897: A "Transparent" copy of the Document means a machine-readable copy,
5898: represented in a format whose specification is available to the
5899: general public, that is suitable for revising the document
5900: straightforwardly with generic text editors or (for images composed of
5901: pixels) generic paint programs or (for drawings) some widely available
5902: drawing editor, and that is suitable for input to text formatters or
5903: for automatic translation to a variety of formats suitable for input
5904: to text formatters. A copy made in an otherwise Transparent file
5905: format whose markup, or absence of markup, has been arranged to thwart
5906: or discourage subsequent modification by readers is not Transparent.
5907: An image format is not Transparent if used for any substantial amount
5908: of text. A copy that is not "Transparent" is called "Opaque".
5909: </P><P>
5910:
5911: Examples of suitable formats for Transparent copies include plain
5912: ASCII without markup, Texinfo input format, LaTeX input
5913: format, <FONT SIZE="-1">SGML</FONT> or <FONT SIZE="-1">XML</FONT> using a publicly available
5914: <FONT SIZE="-1">DTD</FONT>, and standard-conforming simple <FONT SIZE="-1">HTML</FONT>,
5915: PostScript or <FONT SIZE="-1">PDF</FONT> designed for human modification. Examples
5916: of transparent image formats include <FONT SIZE="-1">PNG</FONT>, <FONT SIZE="-1">XCF</FONT> and
5917: <FONT SIZE="-1">JPG</FONT>. Opaque formats include proprietary formats that can be
5918: read and edited only by proprietary word processors, <FONT SIZE="-1">SGML</FONT> or
5919: <FONT SIZE="-1">XML</FONT> for which the <FONT SIZE="-1">DTD</FONT> and/or processing tools are
5920: not generally available, and the machine-generated <FONT SIZE="-1">HTML</FONT>,
5921: PostScript or <FONT SIZE="-1">PDF</FONT> produced by some word processors for
5922: output purposes only.
5923: </P><P>
5924:
5925: The "Title Page" means, for a printed book, the title page itself,
5926: plus such following pages as are needed to hold, legibly, the material
5927: this License requires to appear in the title page. For works in
5928: formats which do not have any title page as such, "Title Page" means
5929: the text near the most prominent appearance of the work's title,
5930: preceding the beginning of the body of the text.
5931: </P><P>
5932:
5933: The "publisher" means any person or entity that distributes copies
5934: of the Document to the public.
5935: </P><P>
5936:
5937: A section "Entitled XYZ" means a named subunit of the Document whose
5938: title either is precisely XYZ or contains XYZ in parentheses following
5939: text that translates XYZ in another language. (Here XYZ stands for a
5940: specific section name mentioned below, such as "Acknowledgements",
5941: "Dedications", "Endorsements", or "History".) To "Preserve the Title"
5942: of such a section when you modify the Document means that it remains a
5943: section "Entitled XYZ" according to this definition.
5944: </P><P>
5945:
5946: The Document may include Warranty Disclaimers next to the notice which
5947: states that this License applies to the Document. These Warranty
5948: Disclaimers are considered to be included by reference in this
5949: License, but only as regards disclaiming warranties: any other
5950: implication that these Warranty Disclaimers may have is void and has
5951: no effect on the meaning of this License.
5952: </P><P>
5953:
5954: <LI>
5955: VERBATIM COPYING
5956: <P>
5957:
5958: You may copy and distribute the Document in any medium, either
5959: commercially or noncommercially, provided that this License, the
5960: copyright notices, and the license notice saying this License applies
5961: to the Document are reproduced in all copies, and that you add no other
5962: conditions whatsoever to those of this License. You may not use
5963: technical measures to obstruct or control the reading or further
5964: copying of the copies you make or distribute. However, you may accept
5965: compensation in exchange for copies. If you distribute a large enough
5966: number of copies you must also follow the conditions in section 3.
5967: </P><P>
5968:
5969: You may also lend copies, under the same conditions stated above, and
5970: you may publicly display copies.
5971: </P><P>
5972:
5973: <LI>
5974: COPYING IN QUANTITY
5975: <P>
5976:
5977: If you publish printed copies (or copies in media that commonly have
5978: printed covers) of the Document, numbering more than 100, and the
5979: Document's license notice requires Cover Texts, you must enclose the
5980: copies in covers that carry, clearly and legibly, all these Cover
5981: Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
5982: the back cover. Both covers must also clearly and legibly identify
5983: you as the publisher of these copies. The front cover must present
5984: the full title with all words of the title equally prominent and
5985: visible. You may add other material on the covers in addition.
5986: Copying with changes limited to the covers, as long as they preserve
5987: the title of the Document and satisfy these conditions, can be treated
5988: as verbatim copying in other respects.
5989: </P><P>
5990:
5991: If the required texts for either cover are too voluminous to fit
5992: legibly, you should put the first ones listed (as many as fit
5993: reasonably) on the actual cover, and continue the rest onto adjacent
5994: pages.
5995: </P><P>
5996:
5997: If you publish or distribute Opaque copies of the Document numbering
5998: more than 100, you must either include a machine-readable Transparent
5999: copy along with each Opaque copy, or state in or with each Opaque copy
6000: a computer-network location from which the general network-using
6001: public has access to download using public-standard network protocols
6002: a complete Transparent copy of the Document, free of added material.
6003: If you use the latter option, you must take reasonably prudent steps,
6004: when you begin distribution of Opaque copies in quantity, to ensure
6005: that this Transparent copy will remain thus accessible at the stated
6006: location until at least one year after the last time you distribute an
6007: Opaque copy (directly or through your agents or retailers) of that
6008: edition to the public.
6009: </P><P>
6010:
6011: It is requested, but not required, that you contact the authors of the
6012: Document well before redistributing any large number of copies, to give
6013: them a chance to provide you with an updated version of the Document.
6014: </P><P>
6015:
6016: <LI>
6017: MODIFICATIONS
6018: <P>
6019:
6020: You may copy and distribute a Modified Version of the Document under
6021: the conditions of sections 2 and 3 above, provided that you release
6022: the Modified Version under precisely this License, with the Modified
6023: Version filling the role of the Document, thus licensing distribution
6024: and modification of the Modified Version to whoever possesses a copy
6025: of it. In addition, you must do these things in the Modified Version:
6026: </P><P>
6027:
6028: <OL>
6029: <LI>
6030: Use in the Title Page (and on the covers, if any) a title distinct
6031: from that of the Document, and from those of previous versions
6032: (which should, if there were any, be listed in the History section
6033: of the Document). You may use the same title as a previous version
6034: if the original publisher of that version gives permission.
6035: <P>
6036:
6037: <LI>
6038: List on the Title Page, as authors, one or more persons or entities
6039: responsible for authorship of the modifications in the Modified
6040: Version, together with at least five of the principal authors of the
6041: Document (all of its principal authors, if it has fewer than five),
6042: unless they release you from this requirement.
6043: <P>
6044:
6045: <LI>
6046: State on the Title page the name of the publisher of the
6047: Modified Version, as the publisher.
6048: <P>
6049:
6050: <LI>
6051: Preserve all the copyright notices of the Document.
6052: <P>
6053:
6054: <LI>
6055: Add an appropriate copyright notice for your modifications
6056: adjacent to the other copyright notices.
6057: <P>
6058:
6059: <LI>
6060: Include, immediately after the copyright notices, a license notice
6061: giving the public permission to use the Modified Version under the
6062: terms of this License, in the form shown in the Addendum below.
6063: <P>
6064:
6065: <LI>
6066: Preserve in that license notice the full lists of Invariant Sections
6067: and required Cover Texts given in the Document's license notice.
6068: <P>
6069:
6070: <LI>
6071: Include an unaltered copy of this License.
6072: <P>
6073:
6074: <LI>
6075: Preserve the section Entitled "History", Preserve its Title, and add
6076: to it an item stating at least the title, year, new authors, and
6077: publisher of the Modified Version as given on the Title Page. If
6078: there is no section Entitled "History" in the Document, create one
6079: stating the title, year, authors, and publisher of the Document as
6080: given on its Title Page, then add an item describing the Modified
6081: Version as stated in the previous sentence.
6082: <P>
6083:
6084: <LI>
6085: Preserve the network location, if any, given in the Document for
6086: public access to a Transparent copy of the Document, and likewise
6087: the network locations given in the Document for previous versions
6088: it was based on. These may be placed in the "History" section.
6089: You may omit a network location for a work that was published at
6090: least four years before the Document itself, or if the original
6091: publisher of the version it refers to gives permission.
6092: <P>
6093:
6094: <LI>
6095: For any section Entitled "Acknowledgements" or "Dedications", Preserve
6096: the Title of the section, and preserve in the section all the
6097: substance and tone of each of the contributor acknowledgements and/or
6098: dedications given therein.
6099: <P>
6100:
6101: <LI>
6102: Preserve all the Invariant Sections of the Document,
6103: unaltered in their text and in their titles. Section numbers
6104: or the equivalent are not considered part of the section titles.
6105: <P>
6106:
6107: <LI>
6108: Delete any section Entitled "Endorsements". Such a section
6109: may not be included in the Modified Version.
6110: <P>
6111:
6112: <LI>
6113: Do not retitle any existing section to be Entitled "Endorsements" or
6114: to conflict in title with any Invariant Section.
6115: <P>
6116:
6117: <LI>
6118: Preserve any Warranty Disclaimers.
6119: </OL>
6120: <P>
6121:
6122: If the Modified Version includes new front-matter sections or
6123: appendices that qualify as Secondary Sections and contain no material
6124: copied from the Document, you may at your option designate some or all
6125: of these sections as invariant. To do this, add their titles to the
6126: list of Invariant Sections in the Modified Version's license notice.
6127: These titles must be distinct from any other section titles.
6128: </P><P>
6129:
6130: You may add a section Entitled "Endorsements", provided it contains
6131: nothing but endorsements of your Modified Version by various
6132: parties--for example, statements of peer review or that the text has
6133: been approved by an organization as the authoritative definition of a
6134: standard.
6135: </P><P>
6136:
6137: You may add a passage of up to five words as a Front-Cover Text, and a
6138: passage of up to 25 words as a Back-Cover Text, to the end of the list
6139: of Cover Texts in the Modified Version. Only one passage of
6140: Front-Cover Text and one of Back-Cover Text may be added by (or
6141: through arrangements made by) any one entity. If the Document already
6142: includes a cover text for the same cover, previously added by you or
6143: by arrangement made by the same entity you are acting on behalf of,
6144: you may not add another; but you may replace the old one, on explicit
6145: permission from the previous publisher that added the old one.
6146: </P><P>
6147:
6148: The author(s) and publisher(s) of the Document do not by this License
6149: give permission to use their names for publicity for or to assert or
6150: imply endorsement of any Modified Version.
6151: </P><P>
6152:
6153: <LI>
6154: COMBINING DOCUMENTS
6155: <P>
6156:
6157: You may combine the Document with other documents released under this
6158: License, under the terms defined in section 4 above for modified
6159: versions, provided that you include in the combination all of the
6160: Invariant Sections of all of the original documents, unmodified, and
6161: list them all as Invariant Sections of your combined work in its
6162: license notice, and that you preserve all their Warranty Disclaimers.
6163: </P><P>
6164:
6165: The combined work need only contain one copy of this License, and
6166: multiple identical Invariant Sections may be replaced with a single
6167: copy. If there are multiple Invariant Sections with the same name but
6168: different contents, make the title of each such section unique by
6169: adding at the end of it, in parentheses, the name of the original
6170: author or publisher of that section if known, or else a unique number.
6171: Make the same adjustment to the section titles in the list of
6172: Invariant Sections in the license notice of the combined work.
6173: </P><P>
6174:
6175: In the combination, you must combine any sections Entitled "History"
6176: in the various original documents, forming one section Entitled
6177: "History"; likewise combine any sections Entitled "Acknowledgements",
6178: and any sections Entitled "Dedications". You must delete all
6179: sections Entitled "Endorsements."
6180: </P><P>
6181:
6182: <LI>
6183: COLLECTIONS OF DOCUMENTS
6184: <P>
6185:
6186: You may make a collection consisting of the Document and other documents
6187: released under this License, and replace the individual copies of this
6188: License in the various documents with a single copy that is included in
6189: the collection, provided that you follow the rules of this License for
6190: verbatim copying of each of the documents in all other respects.
6191: </P><P>
6192:
6193: You may extract a single document from such a collection, and distribute
6194: it individually under this License, provided you insert a copy of this
6195: License into the extracted document, and follow this License in all
6196: other respects regarding verbatim copying of that document.
6197: </P><P>
6198:
6199: <LI>
6200: AGGREGATION WITH INDEPENDENT WORKS
6201: <P>
6202:
6203: A compilation of the Document or its derivatives with other separate
6204: and independent documents or works, in or on a volume of a storage or
6205: distribution medium, is called an "aggregate" if the copyright
6206: resulting from the compilation is not used to limit the legal rights
6207: of the compilation's users beyond what the individual works permit.
6208: When the Document is included in an aggregate, this License does not
6209: apply to the other works in the aggregate which are not themselves
6210: derivative works of the Document.
6211: </P><P>
6212:
6213: If the Cover Text requirement of section 3 is applicable to these
6214: copies of the Document, then if the Document is less than one half of
6215: the entire aggregate, the Document's Cover Texts may be placed on
6216: covers that bracket the Document within the aggregate, or the
6217: electronic equivalent of covers if the Document is in electronic form.
6218: Otherwise they must appear on printed covers that bracket the whole
6219: aggregate.
6220: </P><P>
6221:
6222: <LI>
6223: TRANSLATION
6224: <P>
6225:
6226: Translation is considered a kind of modification, so you may
6227: distribute translations of the Document under the terms of section 4.
6228: Replacing Invariant Sections with translations requires special
6229: permission from their copyright holders, but you may include
6230: translations of some or all Invariant Sections in addition to the
6231: original versions of these Invariant Sections. You may include a
6232: translation of this License, and all the license notices in the
6233: Document, and any Warranty Disclaimers, provided that you also include
6234: the original English version of this License and the original versions
6235: of those notices and disclaimers. In case of a disagreement between
6236: the translation and the original version of this License or a notice
6237: or disclaimer, the original version will prevail.
6238: </P><P>
6239:
6240: If a section in the Document is Entitled "Acknowledgements",
6241: "Dedications", or "History", the requirement (section 4) to Preserve
6242: its Title (section 1) will typically require changing the actual
6243: title.
6244: </P><P>
6245:
6246: <LI>
6247: TERMINATION
6248: <P>
6249:
6250: You may not copy, modify, sublicense, or distribute the Document
6251: except as expressly provided under this License. Any attempt
6252: otherwise to copy, modify, sublicense, or distribute it is void, and
6253: will automatically terminate your rights under this License.
6254: </P><P>
6255:
6256: However, if you cease all violation of this License, then your license
6257: from a particular copyright holder is reinstated (a) provisionally,
6258: unless and until the copyright holder explicitly and finally
6259: terminates your license, and (b) permanently, if the copyright holder
6260: fails to notify you of the violation by some reasonable means prior to
6261: 60 days after the cessation.
6262: </P><P>
6263:
6264: Moreover, your license from a particular copyright holder is
6265: reinstated permanently if the copyright holder notifies you of the
6266: violation by some reasonable means, this is the first time you have
6267: received notice of violation of this License (for any work) from that
6268: copyright holder, and you cure the violation prior to 30 days after
6269: your receipt of the notice.
6270: </P><P>
6271:
6272: Termination of your rights under this section does not terminate the
6273: licenses of parties who have received copies or rights from you under
6274: this License. If your rights have been terminated and not permanently
6275: reinstated, receipt of a copy of some or all of the same material does
6276: not give you any rights to use it.
6277: </P><P>
6278:
6279: <LI>
6280: FUTURE REVISIONS OF THIS LICENSE
6281: <P>
6282:
6283: The Free Software Foundation may publish new, revised versions
6284: of the GNU Free Documentation License from time to time. Such new
6285: versions will be similar in spirit to the present version, but may
6286: differ in detail to address new problems or concerns. See
6287: <A HREF="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</A>.
6288: </P><P>
6289:
6290: Each version of the License is given a distinguishing version number.
6291: If the Document specifies that a particular numbered version of this
6292: License "or any later version" applies to it, you have the option of
6293: following the terms and conditions either of that specified version or
6294: of any later version that has been published (not as a draft) by the
6295: Free Software Foundation. If the Document does not specify a version
6296: number of this License, you may choose any version ever published (not
6297: as a draft) by the Free Software Foundation. If the Document
6298: specifies that a proxy can decide which future versions of this
6299: License can be used, that proxy's public statement of acceptance of a
6300: version permanently authorizes you to choose that version for the
6301: Document.
6302: </P><P>
6303:
6304: <LI>
6305: RELICENSING
6306: <P>
6307:
6308: "Massive Multiauthor Collaboration Site" (or "MMC Site") means any
6309: World Wide Web server that publishes copyrightable works and also
6310: provides prominent facilities for anybody to edit those works. A
6311: public wiki that anybody can edit is an example of such a server. A
6312: "Massive Multiauthor Collaboration" (or "MMC") contained in the
6313: site means any set of copyrightable works thus published on the MMC
6314: site.
6315: </P><P>
6316:
6317: "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
6318: license published by Creative Commons Corporation, a not-for-profit
6319: corporation with a principal place of business in San Francisco,
6320: California, as well as future copyleft versions of that license
6321: published by that same organization.
6322: </P><P>
6323:
6324: "Incorporate" means to publish or republish a Document, in whole or
6325: in part, as part of another Document.
6326: </P><P>
6327:
6328: An MMC is "eligible for relicensing" if it is licensed under this
6329: License, and if all works that were first published under this License
6330: somewhere other than this MMC, and subsequently incorporated in whole
6331: or in part into the MMC, (1) had no cover texts or invariant sections,
6332: and (2) were thus incorporated prior to November 1, 2008.
6333: </P><P>
6334:
6335: The operator of an MMC Site may republish an MMC contained in the site
6336: under CC-BY-SA on the same site at any time before August 1, 2009,
6337: provided the MMC is eligible for relicensing.
6338: </P><P>
6339:
6340: </OL>
6341: <P>
6342:
6343: <A NAME="SEC51"></A>
6344: <H2> ADDENDUM: How to use this License for your documents </H2>
6345: <!--docid::SEC51::-->
6346: <P>
6347:
6348: To use this License in a document you have written, include a copy of
6349: the License in the document and put the following copyright and
6350: license notices just after the title page:
6351: </P><P>
6352:
6353: <TABLE><tr><td> </td><td class=smallexample><FONT SIZE=-1><pre> Copyright (C) <VAR>year</VAR> <VAR>your name</VAR>.
6354: Permission is granted to copy, distribute and/or modify this document
6355: under the terms of the GNU Free Documentation License, Version 1.3
6356: or any later version published by the Free Software Foundation;
6357: with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
6358: Texts. A copy of the license is included in the section entitled ``GNU
6359: Free Documentation License''.
6360: </FONT></pre></td></tr></table></P><P>
6361:
6362: If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
6363: replace the "with<small>...</small>Texts." line with this:
6364: </P><P>
6365:
6366: <TABLE><tr><td> </td><td class=smallexample><FONT SIZE=-1><pre> with the Invariant Sections being <VAR>list their titles</VAR>, with
6367: the Front-Cover Texts being <VAR>list</VAR>, and with the Back-Cover Texts
6368: being <VAR>list</VAR>.
6369: </FONT></pre></td></tr></table></P><P>
6370:
6371: If you have Invariant Sections without Cover Texts, or some other
6372: combination of the three, merge those two alternatives to suit the
6373: situation.
6374: </P><P>
6375:
6376: If your document contains nontrivial examples of program code, we
6377: recommend releasing these examples in parallel under your choice of
6378: free software license, such as the GNU General Public License,
6379: to permit their use in free software.
6380: </P><P>
6381:
6382: <A NAME="Concept Index"></A>
6383: <HR SIZE="6">
6384: <A NAME="SEC52"></A>
6385: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
6386: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC50"> < </A>]</TD>
6387: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC53"> > </A>]</TD>
6388: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
6389: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD>
6390: <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD>
6391: <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>
6392: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
6393: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
6394: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
6395: </TR></TABLE>
6396: <H1> Concept Index </H1>
6397: <!--docid::SEC52::-->
6398: <table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#cp_A" style="text-decoration:none"><b>A</b></A>
6399:
6400: <A HREF="readline.html#cp_C" style="text-decoration:none"><b>C</b></A>
6401:
6402: <A HREF="readline.html#cp_E" style="text-decoration:none"><b>E</b></A>
6403:
6404: <A HREF="readline.html#cp_I" style="text-decoration:none"><b>I</b></A>
6405:
6406: <A HREF="readline.html#cp_K" style="text-decoration:none"><b>K</b></A>
6407:
6408: <A HREF="readline.html#cp_N" style="text-decoration:none"><b>N</b></A>
6409:
6410: <A HREF="readline.html#cp_R" style="text-decoration:none"><b>R</b></A>
6411:
6412: <A HREF="readline.html#cp_V" style="text-decoration:none"><b>V</b></A>
6413:
6414: <A HREF="readline.html#cp_Y" style="text-decoration:none"><b>Y</b></A>
6415:
6416: </td></tr></table><br><P></P>
6417: <TABLE border=0>
6418: <TR><TD></TD><TH ALIGN=LEFT>Index Entry</TH><TH ALIGN=LEFT> Section</TH></TR>
6419: <TR><TD COLSPAN=3> <HR></TD></TR>
6420: <TR><TH><A NAME="cp_A"></A>A</TH><TD></TD><TD></TD></TR>
6421: <TR><TD></TD><TD valign=top><A HREF="readline.html#SEC45">application-specific completion functions</A></TD><TD valign=top><A HREF="readline.html#SEC45">2.6 Custom Completers</A></TD></TR>
6422: <TR><TD COLSPAN=3> <HR></TD></TR>
6423: <TR><TH><A NAME="cp_C"></A>C</TH><TD></TD><TD></TD></TR>
6424: <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>
6425: <TR><TD COLSPAN=3> <HR></TD></TR>
6426: <TR><TH><A NAME="cp_E"></A>E</TH><TD></TD><TD></TD></TR>
6427: <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>
6428: <TR><TD COLSPAN=3> <HR></TD></TR>
6429: <TR><TH><A NAME="cp_I"></A>I</TH><TD></TD><TD></TD></TR>
6430: <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>
6431: <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>
6432: <TR><TD COLSPAN=3> <HR></TD></TR>
6433: <TR><TH><A NAME="cp_K"></A>K</TH><TD></TD><TD></TD></TR>
6434: <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>
6435: <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>
6436: <TR><TD COLSPAN=3> <HR></TD></TR>
6437: <TR><TH><A NAME="cp_N"></A>N</TH><TD></TD><TD></TD></TR>
6438: <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>
6439: <TR><TD COLSPAN=3> <HR></TD></TR>
6440: <TR><TH><A NAME="cp_R"></A>R</TH><TD></TD><TD></TD></TR>
6441: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX201">readline, function</A></TD><TD valign=top><A HREF="readline.html#SEC24">2.1 Basic Behavior</A></TD></TR>
6442: <TR><TD COLSPAN=3> <HR></TD></TR>
6443: <TR><TH><A NAME="cp_V"></A>V</TH><TD></TD><TD></TD></TR>
6444: <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>
6445: <TR><TD COLSPAN=3> <HR></TD></TR>
6446: <TR><TH><A NAME="cp_Y"></A>Y</TH><TD></TD><TD></TD></TR>
6447: <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>
6448: <TR><TD COLSPAN=3> <HR></TD></TR>
6449: </TABLE><P></P><table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#cp_A" style="text-decoration:none"><b>A</b></A>
6450:
6451: <A HREF="readline.html#cp_C" style="text-decoration:none"><b>C</b></A>
6452:
6453: <A HREF="readline.html#cp_E" style="text-decoration:none"><b>E</b></A>
6454:
6455: <A HREF="readline.html#cp_I" style="text-decoration:none"><b>I</b></A>
6456:
6457: <A HREF="readline.html#cp_K" style="text-decoration:none"><b>K</b></A>
6458:
6459: <A HREF="readline.html#cp_N" style="text-decoration:none"><b>N</b></A>
6460:
6461: <A HREF="readline.html#cp_R" style="text-decoration:none"><b>R</b></A>
6462:
6463: <A HREF="readline.html#cp_V" style="text-decoration:none"><b>V</b></A>
6464:
6465: <A HREF="readline.html#cp_Y" style="text-decoration:none"><b>Y</b></A>
6466:
6467: </td></tr></table><br><P>
6468:
6469: <A NAME="Function and Variable Index"></A>
6470: <HR SIZE="6">
6471: <A NAME="SEC53"></A>
6472: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
6473: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52"> < </A>]</TD>
6474: <TD VALIGN="MIDDLE" ALIGN="LEFT">[ > ]</TD>
6475: <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[ << ]</TD>
6476: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top"> Up </A>]</TD>
6477: <TD VALIGN="MIDDLE" ALIGN="LEFT">[ >> ]</TD>
6478: <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>
6479: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
6480: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
6481: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
6482: </TR></TABLE>
6483: <H1> Function and Variable Index </H1>
6484: <!--docid::SEC53::-->
6485: <table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#fn__" style="text-decoration:none"><b>_</b></A>
6486:
6487: <BR>
6488: <A HREF="readline.html#fn_A" style="text-decoration:none"><b>A</b></A>
6489:
6490: <A HREF="readline.html#fn_B" style="text-decoration:none"><b>B</b></A>
6491:
6492: <A HREF="readline.html#fn_C" style="text-decoration:none"><b>C</b></A>
6493:
6494: <A HREF="readline.html#fn_D" style="text-decoration:none"><b>D</b></A>
6495:
6496: <A HREF="readline.html#fn_E" style="text-decoration:none"><b>E</b></A>
6497:
6498: <A HREF="readline.html#fn_F" style="text-decoration:none"><b>F</b></A>
6499:
6500: <A HREF="readline.html#fn_H" style="text-decoration:none"><b>H</b></A>
6501:
6502: <A HREF="readline.html#fn_I" style="text-decoration:none"><b>I</b></A>
6503:
6504: <A HREF="readline.html#fn_K" style="text-decoration:none"><b>K</b></A>
6505:
6506: <A HREF="readline.html#fn_M" style="text-decoration:none"><b>M</b></A>
6507:
6508: <A HREF="readline.html#fn_N" style="text-decoration:none"><b>N</b></A>
6509:
6510: <A HREF="readline.html#fn_O" style="text-decoration:none"><b>O</b></A>
6511:
6512: <A HREF="readline.html#fn_P" style="text-decoration:none"><b>P</b></A>
6513:
6514: <A HREF="readline.html#fn_Q" style="text-decoration:none"><b>Q</b></A>
6515:
6516: <A HREF="readline.html#fn_R" style="text-decoration:none"><b>R</b></A>
6517:
6518: <A HREF="readline.html#fn_S" style="text-decoration:none"><b>S</b></A>
6519:
6520: <A HREF="readline.html#fn_T" style="text-decoration:none"><b>T</b></A>
6521:
6522: <A HREF="readline.html#fn_U" style="text-decoration:none"><b>U</b></A>
6523:
6524: <A HREF="readline.html#fn_V" style="text-decoration:none"><b>V</b></A>
6525:
6526: <A HREF="readline.html#fn_Y" style="text-decoration:none"><b>Y</b></A>
6527:
6528: </td></tr></table><br><P></P>
6529: <TABLE border=0>
6530: <TR><TD></TD><TH ALIGN=LEFT>Index Entry</TH><TH ALIGN=LEFT> Section</TH></TR>
6531: <TR><TD COLSPAN=3> <HR></TD></TR>
6532: <TR><TH><A NAME="fn__"></A>_</TH><TD></TD><TD></TD></TR>
6533: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX322"><CODE>_rl_digit_p</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6534: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX325"><CODE>_rl_digit_value</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6535: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX321"><CODE>_rl_lowercase_p</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6536: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX324"><CODE>_rl_to_lower</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6537: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX323"><CODE>_rl_to_upper</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6538: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX320"><CODE>_rl_uppercase_p</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6539: <TR><TD COLSPAN=3> <HR></TD></TR>
6540: <TR><TH><A NAME="fn_A"></A>A</TH><TD></TD><TD></TD></TR>
6541: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX166"><CODE>abort (C-g)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6542: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX167"><CODE>abort (C-g)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6543: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX54"><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>
6544: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX55"><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>
6545: <TR><TD COLSPAN=3> <HR></TD></TR>
6546: <TR><TH><A NAME="fn_B"></A>B</TH><TD></TD><TD></TD></TR>
6547: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX44"><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>
6548: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX45"><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>
6549: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX88"><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>
6550: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX89"><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>
6551: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX112"><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>
6552: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX113"><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>
6553: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX120"><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>
6554: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX121"><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>
6555: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX48"><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>
6556: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX49"><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>
6557: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX60"><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>
6558: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX61"><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>
6559: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX38"><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>
6560: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX39"><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>
6561: <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>
6562: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX6">bind-tty-special-chars</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6563: <TR><TD COLSPAN=3> <HR></TD></TR>
6564: <TR><TH><A NAME="fn_C"></A>C</TH><TD></TD><TD></TD></TR>
6565: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX160"><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>
6566: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX161"><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>
6567: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX106"><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>
6568: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX107"><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>
6569: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX182"><CODE>character-search (C-])</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6570: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX183"><CODE>character-search (C-])</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6571: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX184"><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>
6572: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX185"><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>
6573: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX50"><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>
6574: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX51"><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>
6575: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX7">colored-stats</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6576: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX8">comment-begin</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6577: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX144"><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>
6578: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX145"><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>
6579: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX9">completion-display-width</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6580: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX10">completion-ignore-case</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6581: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX11">completion-map-case</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6582: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX12">completion-prefix-display-length</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6583: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX13">completion-query-items</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6584: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX14">convert-meta</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6585: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX132"><CODE>copy-backward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6586: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX133"><CODE>copy-backward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6587: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX134"><CODE>copy-forward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6588: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX135"><CODE>copy-forward-word ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6589: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX130"><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>
6590: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX131"><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>
6591: <TR><TD COLSPAN=3> <HR></TD></TR>
6592: <TR><TH><A NAME="fn_D"></A>D</TH><TD></TD><TD></TD></TR>
6593: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX86"><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>
6594: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX87"><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>
6595: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX154"><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>
6596: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX155"><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>
6597: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX126"><CODE>delete-horizontal-space ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6598: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX127"><CODE>delete-horizontal-space ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6599: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX140"><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>
6600: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX141"><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>
6601: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX15">disable-completion</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6602: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX168"><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>
6603: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX169"><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>
6604: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX104"><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>
6605: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX105"><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>
6606: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX190"><CODE>dump-functions ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6607: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX191"><CODE>dump-functions ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6608: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX194"><CODE>dump-macros ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6609: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX195"><CODE>dump-macros ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6610: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX192"><CODE>dump-variables ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6611: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX193"><CODE>dump-variables ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6612: <TR><TD COLSPAN=3> <HR></TD></TR>
6613: <TR><TH><A NAME="fn_E"></A>E</TH><TD></TD><TD></TD></TR>
6614: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX16">editing-mode</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6615: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX196"><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>
6616: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX197"><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>
6617: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX17">enable-keypad</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6618: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX158"><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>
6619: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX159"><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>
6620: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX84"><CODE><I>end-of-file</I> (usually C-d)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR>
6621: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX85"><CODE><I>end-of-file</I> (usually C-d)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR>
6622: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX62"><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>
6623: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX63"><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>
6624: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX40"><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>
6625: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX41"><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>
6626: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX180"><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>
6627: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX181"><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>
6628: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX18">expand-tilde</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6629: <TR><TD COLSPAN=3> <HR></TD></TR>
6630: <TR><TH><A NAME="fn_F"></A>F</TH><TD></TD><TD></TD></TR>
6631: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX90"><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>
6632: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX91"><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>
6633: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX42"><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>
6634: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX43"><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>
6635: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX66"><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>
6636: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX67"><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>
6637: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX46"><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>
6638: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX47"><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>
6639: <TR><TD COLSPAN=3> <HR></TD></TR>
6640: <TR><TH><A NAME="fn_H"></A>H</TH><TD></TD><TD></TD></TR>
6641: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX19">history-preserve-point</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6642: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX74"><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>
6643: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX75"><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>
6644: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX72"><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>
6645: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX73"><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>
6646: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX20">history-size</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6647: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX78"><CODE>history-substr-search-backward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR>
6648: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX79"><CODE>history-substr-search-backward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR>
6649: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX76"><CODE>history-substr-search-forward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR>
6650: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX77"><CODE>history-substr-search-forward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A></TD></TR>
6651: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX21">horizontal-scroll-mode</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6652: <TR><TD COLSPAN=3> <HR></TD></TR>
6653: <TR><TH><A NAME="fn_I"></A>I</TH><TD></TD><TD></TD></TR>
6654: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX22">input-meta</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6655: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX188"><CODE>insert-comment (M-#)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6656: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX189"><CODE>insert-comment (M-#)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6657: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX148"><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>
6658: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX149"><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>
6659: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX24">isearch-terminators</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6660: <TR><TD COLSPAN=3> <HR></TD></TR>
6661: <TR><TH><A NAME="fn_K"></A>K</TH><TD></TD><TD></TD></TR>
6662: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX25">keymap</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6663: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX110"><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>
6664: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX111"><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>
6665: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX128"><CODE>kill-region ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6666: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX129"><CODE>kill-region ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6667: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX116"><CODE>kill-whole-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6668: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX117"><CODE>kill-whole-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6669: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX118"><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>
6670: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX119"><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>
6671: <TR><TD COLSPAN=3> <HR></TD></TR>
6672: <TR><TH><A NAME="fn_M"></A>M</TH><TD></TD><TD></TD></TR>
6673: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX26">mark-modified-lines</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6674: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX27">mark-symlinked-directories</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6675: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX28">match-hidden-files</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6676: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX150"><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>
6677: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX151"><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>
6678: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX152"><CODE>menu-complete-backward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR>
6679: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX153"><CODE>menu-complete-backward ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A></TD></TR>
6680: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX29">menu-complete-display-prefix</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6681: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX23">meta-flag</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6682: <TR><TD COLSPAN=3> <HR></TD></TR>
6683: <TR><TH><A NAME="fn_N"></A>N</TH><TD></TD><TD></TD></TR>
6684: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX58"><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>
6685: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX59"><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>
6686: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX70"><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>
6687: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX71"><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>
6688: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX68"><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>
6689: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX69"><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>
6690: <TR><TD COLSPAN=3> <HR></TD></TR>
6691: <TR><TH><A NAME="fn_O"></A>O</TH><TD></TD><TD></TD></TR>
6692: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX30">output-meta</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6693: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX108"><CODE>overwrite-mode ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR>
6694: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX109"><CODE>overwrite-mode ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A></TD></TR>
6695: <TR><TD COLSPAN=3> <HR></TD></TR>
6696: <TR><TH><A NAME="fn_P"></A>P</TH><TD></TD><TD></TD></TR>
6697: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX31">page-completions</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6698: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX146"><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>
6699: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX147"><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>
6700: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX170"><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>
6701: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX171"><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>
6702: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX56"><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>
6703: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX57"><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>
6704: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX162"><CODE>print-last-kbd-macro ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR>
6705: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX163"><CODE>print-last-kbd-macro ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A></TD></TR>
6706: <TR><TD COLSPAN=3> <HR></TD></TR>
6707: <TR><TH><A NAME="fn_Q"></A>Q</TH><TD></TD><TD></TD></TR>
6708: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX92"><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>
6709: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX93"><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>
6710: <TR><TD COLSPAN=3> <HR></TD></TR>
6711: <TR><TH><A NAME="fn_R"></A>R</TH><TD></TD><TD></TD></TR>
6712: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX164"><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>
6713: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX165"><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>
6714: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX200"><CODE>readline</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC24">2.1 Basic Behavior</A></TD></TR>
6715: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX52"><CODE>redraw-current-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR>
6716: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX53"><CODE>redraw-current-line ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC14">1.4.1 Commands For Moving</A></TD></TR>
6717: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX64"><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>
6718: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX65"><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>
6719: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX32">revert-all-at-newline</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6720: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX174"><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>
6721: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX175"><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>
6722: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX242"><CODE>rl_add_defun</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC30">2.4.1 Naming a Function</A></TD></TR>
6723: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX275"><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>
6724: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX278"><CODE>rl_add_undo</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR>
6725: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX318"><CODE>rl_alphabetic</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6726: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX213">rl_already_prompted</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6727: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX361">rl_attempted_completion_function</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6728: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX388">rl_attempted_completion_over</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6729: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX372">rl_basic_quote_characters</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6730: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX371">rl_basic_word_break_characters</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6731: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX276"><CODE>rl_begin_undo_group</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR>
6732: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX252"><CODE>rl_bind_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6733: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX254"><CODE>rl_bind_key_if_unbound</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6734: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX255"><CODE>rl_bind_key_if_unbound_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6735: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX253"><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>
6736: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX260"><CODE>rl_bind_keyseq</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6737: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX263"><CODE>rl_bind_keyseq_if_unbound</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6738: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX264"><CODE>rl_bind_keyseq_if_unbound_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6739: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX261"><CODE>rl_bind_keyseq_in_map</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6740: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX233">rl_binding_keymap</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6741: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX334"><CODE>rl_callback_handler_install</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A></TD></TR>
6742: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX336"><CODE>rl_callback_handler_remove</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A></TD></TR>
6743: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX335"><CODE>rl_callback_read_char</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC41">2.4.12 Alternate Interface</A></TD></TR>
6744: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX337">rl_catch_signals</A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6745: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX338">rl_catch_sigwinch</A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6746: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX339">rl_change_environment</A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6747: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX364">rl_char_is_quoted_p</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6748: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX340"><CODE>rl_cleanup_after_signal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6749: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX333"><CODE>rl_clear_history</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR>
6750: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX290"><CODE>rl_clear_message</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6751: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX304"><CODE>rl_clear_pending_input</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR>
6752: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX349"><CODE>rl_clear_signals</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6753: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX350"><CODE>rl_complete</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.1 How Completing Works</A></TD></TR>
6754: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX353"><CODE>rl_complete</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6755: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX352"><CODE>rl_complete_internal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6756: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX375">rl_completer_quote_characters</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6757: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX373">rl_completer_word_break_characters</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6758: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX379">rl_completion_append_character</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6759: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX370">rl_completion_display_matches_hook</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6760: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX351">rl_completion_entry_function</A></TD><TD valign=top><A HREF="readline.html#SEC46">2.6.1 How Completing Works</A></TD></TR>
6761: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX360">rl_completion_entry_function</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6762: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX383">rl_completion_found_quote</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6763: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX391">rl_completion_invoking_key</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6764: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX384">rl_completion_mark_symlink_dirs</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6765: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX357"><CODE>rl_completion_matches</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6766: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX356"><CODE>rl_completion_mode</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6767: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX378">rl_completion_query_items</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6768: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX381">rl_completion_quote_character</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6769: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX380">rl_completion_suppress_append</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6770: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX382">rl_completion_suppress_quote</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6771: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX390">rl_completion_type</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6772: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX374">rl_completion_word_break_hook</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6773: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX244"><CODE>rl_copy_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR>
6774: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX297"><CODE>rl_copy_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR>
6775: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX287"><CODE>rl_crlf</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6776: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX296"><CODE>rl_delete_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR>
6777: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX231">rl_deprep_term_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6778: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX307"><CODE>rl_deprep_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR>
6779: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX317"><CODE>rl_ding</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6780: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX366">rl_directory_completion_hook</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6781: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX367">rl_directory_rewrite_hook;</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6782: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX246"><CODE>rl_discard_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR>
6783: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX209">rl_dispatching</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6784: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX319"><CODE>rl_display_match_list</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6785: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX212">rl_display_prompt</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6786: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX280"><CODE>rl_do_undo</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR>
6787: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX206">rl_done</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6788: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX343"><CODE>rl_echo_signal_char</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6789: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX241">rl_editing_mode</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6790: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX204">rl_end</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6791: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX277"><CODE>rl_end_undo_group</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR>
6792: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX210">rl_erase_empty_line</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6793: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX225">rl_event_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6794: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX303"><CODE>rl_execute_next</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR>
6795: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX235">rl_executing_key</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6796: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX232">rl_executing_keymap</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6797: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX236">rl_executing_keyseq</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6798: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX234">rl_executing_macro</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6799: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX293"><CODE>rl_expand_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6800: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX239">rl_explicit_arg</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6801: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX315"><CODE>rl_extend_line_buffer</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6802: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX386">rl_filename_completion_desired</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6803: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX358"><CODE>rl_filename_completion_function</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6804: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX363">rl_filename_dequoting_function</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6805: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX376">rl_filename_quote_characters</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6806: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX387">rl_filename_quoting_desired</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6807: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX362">rl_filename_quoting_function</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6808: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX369">rl_filename_rewrite_hook</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6809: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX368">rl_filename_stat_hook</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6810: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX283"><CODE>rl_forced_update_display</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6811: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX313"><CODE>rl_free</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6812: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX247"><CODE>rl_free_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR>
6813: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX341"><CODE>rl_free_line_state</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6814: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX279"><CODE>rl_free_undo_list</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR>
6815: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX272"><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>
6816: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX269"><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>
6817: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX274"><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>
6818: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX265"><CODE>rl_generic_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6819: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX248"><CODE>rl_get_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR>
6820: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX250"><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>
6821: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX251"><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>
6822: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX346"><CODE>rl_get_screen_size</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6823: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX332"><CODE>rl_get_termcap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR>
6824: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX301"><CODE>rl_getc</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR>
6825: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX226">rl_getc_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6826: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX216">rl_gnu_readline_p</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6827: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX385">rl_ignore_completion_duplicates</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6828: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX365">rl_ignore_some_completions_function</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6829: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX392">rl_inhibit_completion</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6830: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX316"><CODE>rl_initialize</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6831: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX228">rl_input_available_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6832: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX355"><CODE>rl_insert_completions</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6833: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX295"><CODE>rl_insert_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR>
6834: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX219">rl_instream</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6835: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX270"><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>
6836: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX271"><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>
6837: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX237">rl_key_sequence_length</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6838: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX298"><CODE>rl_kill_text</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR>
6839: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX222">rl_last_func</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6840: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX214">rl_library_version</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6841: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX202">rl_line_buffer</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6842: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX273"><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>
6843: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX326"><CODE>rl_macro_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR>
6844: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX327"><CODE>rl_macro_dumper</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR>
6845: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX243"><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>
6846: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX245"><CODE>rl_make_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR>
6847: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX205">rl_mark</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6848: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX289"><CODE>rl_message</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6849: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX281"><CODE>rl_modifying</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A></TD></TR>
6850: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX268"><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>
6851: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX207">rl_num_chars_to_read</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6852: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX240">rl_numeric_arg</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6853: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX284"><CODE>rl_on_new_line</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6854: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX285"><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>
6855: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX220">rl_outstream</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6856: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX266"><CODE>rl_parse_and_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6857: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX208">rl_pending_input</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6858: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX203">rl_point</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6859: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX354"><CODE>rl_possible_completions</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6860: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX224">rl_pre_input_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6861: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX221">rl_prefer_env_winsize</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6862: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX230">rl_prep_term_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6863: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX306"><CODE>rl_prep_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR>
6864: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX211">rl_prompt</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6865: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX299"><CODE>rl_push_macro_input</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC36">2.4.7 Modifying Text</A></TD></TR>
6866: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX267"><CODE>rl_read_init_file</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6867: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX300"><CODE>rl_read_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR>
6868: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX218">rl_readline_name</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6869: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX238">rl_readline_state</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6870: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX215">rl_readline_version</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6871: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX282"><CODE>rl_redisplay</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6872: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX229">rl_redisplay_function</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6873: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX314"><CODE>rl_replace_line</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6874: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX342"><CODE>rl_reset_after_signal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6875: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX286"><CODE>rl_reset_line_state</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6876: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX347"><CODE>rl_reset_screen_size</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6877: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX310"><CODE>rl_reset_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR>
6878: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX344"><CODE>rl_resize_terminal</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6879: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX292"><CODE>rl_restore_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6880: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX312"><CODE>rl_restore_state</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6881: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX291"><CODE>rl_save_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6882: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX311"><CODE>rl_save_state</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC39">2.4.10 Utility Functions</A></TD></TR>
6883: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX262"><CODE>rl_set_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6884: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX305"><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>
6885: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX249"><CODE>rl_set_keymap</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A></TD></TR>
6886: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX331"><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>
6887: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX294"><CODE>rl_set_prompt</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6888: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX345"><CODE>rl_set_screen_size</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6889: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX348"><CODE>rl_set_signals</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC44">2.5 Readline Signal Handling</A></TD></TR>
6890: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX288"><CODE>rl_show_char</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC35">2.4.6 Redisplay</A></TD></TR>
6891: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX227">rl_signal_event_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6892: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX389">rl_sort_completion_matches</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6893: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX377">rl_special_prefixes</A></TD><TD valign=top><A HREF="readline.html#SEC48">2.6.3 Completion Variables</A></TD></TR>
6894: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX223">rl_startup_hook</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6895: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX302"><CODE>rl_stuff_char</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC37">2.4.8 Character Input</A></TD></TR>
6896: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX217">rl_terminal_name</A></TD><TD valign=top><A HREF="readline.html#SEC28">2.3 Readline Variables</A></TD></TR>
6897: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX308"><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>
6898: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX309"><CODE>rl_tty_unset_default_bindings</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC38">2.4.9 Terminal Management</A></TD></TR>
6899: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX259"><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>
6900: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX258"><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>
6901: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX256"><CODE>rl_unbind_key</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC32">2.4.3 Binding Keys</A></TD></TR>
6902: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX257"><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>
6903: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX359"><CODE>rl_username_completion_function</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC47">2.6.2 Completion Functions</A></TD></TR>
6904: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX328"><CODE>rl_variable_bind</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR>
6905: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX330"><CODE>rl_variable_dumper</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR>
6906: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX329"><CODE>rl_variable_value</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A></TD></TR>
6907: <TR><TD COLSPAN=3> <HR></TD></TR>
6908: <TR><TH><A NAME="fn_S"></A>S</TH><TD></TD><TD></TD></TR>
6909: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX96"><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>
6910: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX97"><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>
6911: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX178"><CODE>set-mark (C-@)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6912: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX179"><CODE>set-mark (C-@)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6913: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX33">show-all-if-ambiguous</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6914: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX34">show-all-if-unmodified</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6915: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX35">show-mode-in-prompt</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6916: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX36">skip-completed-text</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6917: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX186"><CODE>skip-csi-sequence ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6918: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX187"><CODE>skip-csi-sequence ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6919: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX156"><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>
6920: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX157"><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>
6921: <TR><TD COLSPAN=3> <HR></TD></TR>
6922: <TR><TH><A NAME="fn_T"></A>T</TH><TD></TD><TD></TD></TR>
6923: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX94"><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>
6924: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX95"><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>
6925: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX176"><CODE>tilde-expand (M-~)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6926: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX177"><CODE>tilde-expand (M-~)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A></TD></TR>
6927: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX98"><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>
6928: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX99"><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>
6929: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX100"><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>
6930: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX101"><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>
6931: <TR><TD COLSPAN=3> <HR></TD></TR>
6932: <TR><TH><A NAME="fn_U"></A>U</TH><TD></TD><TD></TD></TR>
6933: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX172"><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>
6934: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX173"><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>
6935: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX142"><CODE>universal-argument ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A></TD></TR>
6936: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX143"><CODE>universal-argument ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A></TD></TR>
6937: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX124"><CODE>unix-filename-rubout ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6938: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX125"><CODE>unix-filename-rubout ()</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6939: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX114"><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>
6940: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX115"><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>
6941: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX122"><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>
6942: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX123"><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>
6943: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX102"><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>
6944: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX103"><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>
6945: <TR><TD COLSPAN=3> <HR></TD></TR>
6946: <TR><TH><A NAME="fn_V"></A>V</TH><TD></TD><TD></TD></TR>
6947: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX198"><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>
6948: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX199"><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>
6949: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX37">visible-stats</A></TD><TD valign=top><A HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A></TD></TR>
6950: <TR><TD COLSPAN=3> <HR></TD></TR>
6951: <TR><TH><A NAME="fn_Y"></A>Y</TH><TD></TD><TD></TD></TR>
6952: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX136"><CODE>yank (C-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6953: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX137"><CODE>yank (C-y)</CODE></A></TD><TD valign=top><A HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A></TD></TR>
6954: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX82"><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>
6955: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX83"><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>
6956: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX80"><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>
6957: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX81"><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>
6958: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX138"><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>
6959: <TR><TD></TD><TD valign=top><A HREF="readline.html#IDX139"><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>
6960: <TR><TD COLSPAN=3> <HR></TD></TR>
6961: </TABLE><P></P><table><tr><th valign=top>Jump to: </th><td><A HREF="readline.html#fn__" style="text-decoration:none"><b>_</b></A>
6962:
6963: <BR>
6964: <A HREF="readline.html#fn_A" style="text-decoration:none"><b>A</b></A>
6965:
6966: <A HREF="readline.html#fn_B" style="text-decoration:none"><b>B</b></A>
6967:
6968: <A HREF="readline.html#fn_C" style="text-decoration:none"><b>C</b></A>
6969:
6970: <A HREF="readline.html#fn_D" style="text-decoration:none"><b>D</b></A>
6971:
6972: <A HREF="readline.html#fn_E" style="text-decoration:none"><b>E</b></A>
6973:
6974: <A HREF="readline.html#fn_F" style="text-decoration:none"><b>F</b></A>
6975:
6976: <A HREF="readline.html#fn_H" style="text-decoration:none"><b>H</b></A>
6977:
6978: <A HREF="readline.html#fn_I" style="text-decoration:none"><b>I</b></A>
6979:
6980: <A HREF="readline.html#fn_K" style="text-decoration:none"><b>K</b></A>
6981:
6982: <A HREF="readline.html#fn_M" style="text-decoration:none"><b>M</b></A>
6983:
6984: <A HREF="readline.html#fn_N" style="text-decoration:none"><b>N</b></A>
6985:
6986: <A HREF="readline.html#fn_O" style="text-decoration:none"><b>O</b></A>
6987:
6988: <A HREF="readline.html#fn_P" style="text-decoration:none"><b>P</b></A>
6989:
6990: <A HREF="readline.html#fn_Q" style="text-decoration:none"><b>Q</b></A>
6991:
6992: <A HREF="readline.html#fn_R" style="text-decoration:none"><b>R</b></A>
6993:
6994: <A HREF="readline.html#fn_S" style="text-decoration:none"><b>S</b></A>
6995:
6996: <A HREF="readline.html#fn_T" style="text-decoration:none"><b>T</b></A>
6997:
6998: <A HREF="readline.html#fn_U" style="text-decoration:none"><b>U</b></A>
6999:
7000: <A HREF="readline.html#fn_V" style="text-decoration:none"><b>V</b></A>
7001:
7002: <A HREF="readline.html#fn_Y" style="text-decoration:none"><b>Y</b></A>
7003:
7004: </td></tr></table><br><P>
7005:
7006: <HR SIZE="6">
7007: <A NAME="SEC_Contents"></A>
7008: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
7009: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD>
7010: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
7011: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
7012: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
7013: </TR></TABLE>
7014: <H1>Table of Contents</H1>
7015: <UL>
7016: <A NAME="TOC1" HREF="readline.html#SEC1">1. Command Line Editing</A>
7017: <BR>
7018: <UL>
7019: <A NAME="TOC2" HREF="readline.html#SEC2">1.1 Introduction to Line Editing</A>
7020: <BR>
7021: <A NAME="TOC3" HREF="readline.html#SEC3">1.2 Readline Interaction</A>
7022: <BR>
7023: <UL>
7024: <A NAME="TOC4" HREF="readline.html#SEC4">1.2.1 Readline Bare Essentials</A>
7025: <BR>
7026: <A NAME="TOC5" HREF="readline.html#SEC5">1.2.2 Readline Movement Commands</A>
7027: <BR>
7028: <A NAME="TOC6" HREF="readline.html#SEC6">1.2.3 Readline Killing Commands</A>
7029: <BR>
7030: <A NAME="TOC7" HREF="readline.html#SEC7">1.2.4 Readline Arguments</A>
7031: <BR>
7032: <A NAME="TOC8" HREF="readline.html#SEC8">1.2.5 Searching for Commands in the History</A>
7033: <BR>
7034: </UL>
7035: <A NAME="TOC9" HREF="readline.html#SEC9">1.3 Readline Init File</A>
7036: <BR>
7037: <UL>
7038: <A NAME="TOC10" HREF="readline.html#SEC10">1.3.1 Readline Init File Syntax</A>
7039: <BR>
7040: <A NAME="TOC11" HREF="readline.html#SEC11">1.3.2 Conditional Init Constructs</A>
7041: <BR>
7042: <A NAME="TOC12" HREF="readline.html#SEC12">1.3.3 Sample Init File</A>
7043: <BR>
7044: </UL>
7045: <A NAME="TOC13" HREF="readline.html#SEC13">1.4 Bindable Readline Commands</A>
7046: <BR>
7047: <UL>
7048: <A NAME="TOC14" HREF="readline.html#SEC14">1.4.1 Commands For Moving</A>
7049: <BR>
7050: <A NAME="TOC15" HREF="readline.html#SEC15">1.4.2 Commands For Manipulating The History</A>
7051: <BR>
7052: <A NAME="TOC16" HREF="readline.html#SEC16">1.4.3 Commands For Changing Text</A>
7053: <BR>
7054: <A NAME="TOC17" HREF="readline.html#SEC17">1.4.4 Killing And Yanking</A>
7055: <BR>
7056: <A NAME="TOC18" HREF="readline.html#SEC18">1.4.5 Specifying Numeric Arguments</A>
7057: <BR>
7058: <A NAME="TOC19" HREF="readline.html#SEC19">1.4.6 Letting Readline Type For You</A>
7059: <BR>
7060: <A NAME="TOC20" HREF="readline.html#SEC20">1.4.7 Keyboard Macros</A>
7061: <BR>
7062: <A NAME="TOC21" HREF="readline.html#SEC21">1.4.8 Some Miscellaneous Commands</A>
7063: <BR>
7064: </UL>
7065: <A NAME="TOC22" HREF="readline.html#SEC22">1.5 Readline vi Mode</A>
7066: <BR>
7067: </UL>
7068: <A NAME="TOC23" HREF="readline.html#SEC23">2. Programming with GNU Readline</A>
7069: <BR>
7070: <UL>
7071: <A NAME="TOC24" HREF="readline.html#SEC24">2.1 Basic Behavior</A>
7072: <BR>
7073: <A NAME="TOC25" HREF="readline.html#SEC25">2.2 Custom Functions</A>
7074: <BR>
7075: <UL>
7076: <A NAME="TOC26" HREF="readline.html#SEC26">2.2.1 Readline Typedefs</A>
7077: <BR>
7078: <A NAME="TOC27" HREF="readline.html#SEC27">2.2.2 Writing a New Function</A>
7079: <BR>
7080: </UL>
7081: <A NAME="TOC28" HREF="readline.html#SEC28">2.3 Readline Variables</A>
7082: <BR>
7083: <A NAME="TOC29" HREF="readline.html#SEC29">2.4 Readline Convenience Functions</A>
7084: <BR>
7085: <UL>
7086: <A NAME="TOC30" HREF="readline.html#SEC30">2.4.1 Naming a Function</A>
7087: <BR>
7088: <A NAME="TOC31" HREF="readline.html#SEC31">2.4.2 Selecting a Keymap</A>
7089: <BR>
7090: <A NAME="TOC32" HREF="readline.html#SEC32">2.4.3 Binding Keys</A>
7091: <BR>
7092: <A NAME="TOC33" HREF="readline.html#SEC33">2.4.4 Associating Function Names and Bindings</A>
7093: <BR>
7094: <A NAME="TOC34" HREF="readline.html#SEC34">2.4.5 Allowing Undoing</A>
7095: <BR>
7096: <A NAME="TOC35" HREF="readline.html#SEC35">2.4.6 Redisplay</A>
7097: <BR>
7098: <A NAME="TOC36" HREF="readline.html#SEC36">2.4.7 Modifying Text</A>
7099: <BR>
7100: <A NAME="TOC37" HREF="readline.html#SEC37">2.4.8 Character Input</A>
7101: <BR>
7102: <A NAME="TOC38" HREF="readline.html#SEC38">2.4.9 Terminal Management</A>
7103: <BR>
7104: <A NAME="TOC39" HREF="readline.html#SEC39">2.4.10 Utility Functions</A>
7105: <BR>
7106: <A NAME="TOC40" HREF="readline.html#SEC40">2.4.11 Miscellaneous Functions</A>
7107: <BR>
7108: <A NAME="TOC41" HREF="readline.html#SEC41">2.4.12 Alternate Interface</A>
7109: <BR>
7110: <A NAME="TOC42" HREF="readline.html#SEC42">2.4.13 A Readline Example</A>
7111: <BR>
7112: <A NAME="TOC43" HREF="readline.html#SEC43">2.4.14 Alternate Interface Example</A>
7113: <BR>
7114: </UL>
7115: <A NAME="TOC44" HREF="readline.html#SEC44">2.5 Readline Signal Handling</A>
7116: <BR>
7117: <A NAME="TOC45" HREF="readline.html#SEC45">2.6 Custom Completers</A>
7118: <BR>
7119: <UL>
7120: <A NAME="TOC46" HREF="readline.html#SEC46">2.6.1 How Completing Works</A>
7121: <BR>
7122: <A NAME="TOC47" HREF="readline.html#SEC47">2.6.2 Completion Functions</A>
7123: <BR>
7124: <A NAME="TOC48" HREF="readline.html#SEC48">2.6.3 Completion Variables</A>
7125: <BR>
7126: <A NAME="TOC49" HREF="readline.html#SEC49">2.6.4 A Short Completion Example</A>
7127: <BR>
7128: </UL>
7129: </UL>
7130: <A NAME="TOC50" HREF="readline.html#SEC50">A. GNU Free Documentation License</A>
7131: <BR>
7132: <A NAME="TOC52" HREF="readline.html#SEC52">Concept Index</A>
7133: <BR>
7134: <A NAME="TOC53" HREF="readline.html#SEC53">Function and Variable Index</A>
7135: <BR>
7136: </UL>
7137: <HR SIZE=1>
7138: <A NAME="SEC_OVERVIEW"></A>
7139: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
7140: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD>
7141: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
7142: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
7143: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
7144: </TR></TABLE>
7145: <H1>Short Table of Contents</H1>
7146: <BLOCKQUOTE>
7147: <A NAME="TOC1" HREF="readline.html#SEC1">1. Command Line Editing</A>
7148: <BR>
7149: <A NAME="TOC23" HREF="readline.html#SEC23">2. Programming with GNU Readline</A>
7150: <BR>
7151: <A NAME="TOC50" HREF="readline.html#SEC50">A. GNU Free Documentation License</A>
7152: <BR>
7153: <A NAME="TOC52" HREF="readline.html#SEC52">Concept Index</A>
7154: <BR>
7155: <A NAME="TOC53" HREF="readline.html#SEC53">Function and Variable Index</A>
7156: <BR>
7157:
7158: </BLOCKQUOTE>
7159: <HR SIZE=1>
7160: <A NAME="SEC_About"></A>
7161: <TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
7162: <TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Top">Top</A>]</TD>
7163: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_Contents">Contents</A>]</TD>
7164: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC52">Index</A>]</TD>
7165: <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
7166: </TR></TABLE>
7167: <H1>About this document</H1>
7168: This document was generated by <I>Chet Ramey</I> on <I>February, 11 2014</I>
7169: using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
7170: "><I>texi2html</I></A>
7171: <P></P>
7172: The buttons in the navigation panels have the following meaning:
7173: <P></P>
7174: <table border = "1">
7175: <TR>
7176: <TH> Button </TH>
7177: <TH> Name </TH>
7178: <TH> Go to </TH>
7179: <TH> From 1.2.3 go to</TH>
7180: </TR>
7181: <TR>
7182: <TD ALIGN="CENTER">
7183: [ < ] </TD>
7184: <TD ALIGN="CENTER">
7185: Back
7186: </TD>
7187: <TD>
7188: previous section in reading order
7189: </TD>
7190: <TD>
7191: 1.2.2
7192: </TD>
7193: </TR>
7194: <TR>
7195: <TD ALIGN="CENTER">
7196: [ > ] </TD>
7197: <TD ALIGN="CENTER">
7198: Forward
7199: </TD>
7200: <TD>
7201: next section in reading order
7202: </TD>
7203: <TD>
7204: 1.2.4
7205: </TD>
7206: </TR>
7207: <TR>
7208: <TD ALIGN="CENTER">
7209: [ << ] </TD>
7210: <TD ALIGN="CENTER">
7211: FastBack
7212: </TD>
7213: <TD>
7214: previous or up-and-previous section
7215: </TD>
7216: <TD>
7217: 1.1
7218: </TD>
7219: </TR>
7220: <TR>
7221: <TD ALIGN="CENTER">
7222: [ Up ] </TD>
7223: <TD ALIGN="CENTER">
7224: Up
7225: </TD>
7226: <TD>
7227: up section
7228: </TD>
7229: <TD>
7230: 1.2
7231: </TD>
7232: </TR>
7233: <TR>
7234: <TD ALIGN="CENTER">
7235: [ >> ] </TD>
7236: <TD ALIGN="CENTER">
7237: FastForward
7238: </TD>
7239: <TD>
7240: next or up-and-next section
7241: </TD>
7242: <TD>
7243: 1.3
7244: </TD>
7245: </TR>
7246: <TR>
7247: <TD ALIGN="CENTER">
7248: [Top] </TD>
7249: <TD ALIGN="CENTER">
7250: Top
7251: </TD>
7252: <TD>
7253: cover (top) of document
7254: </TD>
7255: <TD>
7256:
7257: </TD>
7258: </TR>
7259: <TR>
7260: <TD ALIGN="CENTER">
7261: [Contents] </TD>
7262: <TD ALIGN="CENTER">
7263: Contents
7264: </TD>
7265: <TD>
7266: table of contents
7267: </TD>
7268: <TD>
7269:
7270: </TD>
7271: </TR>
7272: <TR>
7273: <TD ALIGN="CENTER">
7274: [Index] </TD>
7275: <TD ALIGN="CENTER">
7276: Index
7277: </TD>
7278: <TD>
7279: concept index
7280: </TD>
7281: <TD>
7282:
7283: </TD>
7284: </TR>
7285: <TR>
7286: <TD ALIGN="CENTER">
7287: [ ? ] </TD>
7288: <TD ALIGN="CENTER">
7289: About
7290: </TD>
7291: <TD>
7292: this page
7293: </TD>
7294: <TD>
7295:
7296: </TD>
7297: </TR>
7298: </TABLE>
7299: <P></P>
7300: where the <STRONG> Example </STRONG> assumes that the current position
7301: is at <STRONG> Subsubsection One-Two-Three </STRONG> of a document of
7302: the following structure:
7303: <UL>
7304: <LI> 1. Section One </LI>
7305: <UL>
7306: <LI>1.1 Subsection One-One</LI>
7307: <UL>
7308: <LI> ... </LI>
7309: </UL>
7310: <LI>1.2 Subsection One-Two</LI>
7311: <UL>
7312: <LI>1.2.1 Subsubsection One-Two-One
7313: </LI><LI>1.2.2 Subsubsection One-Two-Two
7314: </LI><LI>1.2.3 Subsubsection One-Two-Three <STRONG>
7315: <== Current Position </STRONG>
7316: </LI><LI>1.2.4 Subsubsection One-Two-Four
7317: </LI></UL>
7318: <LI>1.3 Subsection One-Three</LI>
7319: <UL>
7320: <LI> ... </LI>
7321: </UL>
7322: <LI>1.4 Subsection One-Four</LI>
7323: </UL>
7324: </UL>
7325:
7326: <HR SIZE=1>
7327: <BR>
7328: <FONT SIZE="-1">
7329: This document was generated
7330: by <I>Chet Ramey</I> on <I>February, 11 2014</I>
7331: using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
7332: "><I>texi2html</I></A>
7333:
7334: </BODY>
7335: </HTML>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to readline.html CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / readline / doc