From 28ef6c316f1aff914bb95ac09787a3c83c1815fd Mon Sep 17 00:00:00 2001 From: Jari Aalto Date: Fri, 6 Apr 2001 19:14:31 +0000 Subject: Imported from ../bash-2.05.tar.gz. --- lib/readline/doc/hist.texinfo | 4 +- lib/readline/doc/hstech.texinfo | 181 ++++---- lib/readline/doc/hsuser.texinfo | 52 +-- lib/readline/doc/manvers.texinfo | 10 +- lib/readline/doc/rlman.texinfo | 4 +- lib/readline/doc/rltech.texinfo | 879 +++++++++++++++++++++++++------------ lib/readline/doc/rluser.texinfo | 371 +++++++++------- lib/readline/doc/rluserman.texinfo | 6 +- 8 files changed, 970 insertions(+), 537 deletions(-) (limited to 'lib/readline/doc') diff --git a/lib/readline/doc/hist.texinfo b/lib/readline/doc/hist.texinfo index 8a9c9413..90ace3cc 100644 --- a/lib/readline/doc/hist.texinfo +++ b/lib/readline/doc/hist.texinfo @@ -18,7 +18,7 @@ This document describes the GNU History library, a programming tool that provides a consistent user interface for recalling lines of previously typed input. -Copyright (C) 1988-1999 Free Software Foundation, Inc. +Copyright (C) 1988-2001 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -73,7 +73,7 @@ except that this permission notice may be stated in a translation approved by the Free Software Foundation. @vskip 0pt plus 1filll -Copyright @copyright{} 1988-1999 Free Software Foundation, Inc. +Copyright @copyright{} 1988-2001 Free Software Foundation, Inc. @end titlepage @ifinfo diff --git a/lib/readline/doc/hstech.texinfo b/lib/readline/doc/hstech.texinfo index 12fff2c9..e4ac50cb 100644 --- a/lib/readline/doc/hstech.texinfo +++ b/lib/readline/doc/hstech.texinfo @@ -1,7 +1,7 @@ @ignore This file documents the user interface to the GNU History library. -Copyright (C) 1988, 1991, 1994, 1996 Free Software Foundation, Inc. +Copyright (C) 1988-2001 Free Software Foundation, Inc. Authored by Brian Fox and Chet Ramey. Permission is granted to make and distribute verbatim copies of this manual @@ -27,9 +27,9 @@ into another language, under the above conditions for modified versions. @chapter Programming with GNU History This chapter describes how to interface programs that you write -with the GNU History Library. +with the @sc{gnu} History Library. It should be considered a technical guide. -For information on the interactive use of GNU History, @pxref{Using +For information on the interactive use of @sc{gnu} History, @pxref{Using History Interactively}. @menu @@ -43,10 +43,10 @@ History Interactively}. @node Introduction to History @section Introduction to History -Many programs read input from the user a line at a time. The GNU History -library is able to keep track of those lines, associate arbitrary data with -each line, and utilize information from previous lines in composing new -ones. +Many programs read input from the user a line at a time. The @sc{gnu} +History library is able to keep track of those lines, associate arbitrary +data with each line, and utilize information from previous lines in +composing new ones. The programmer using the History library has available functions for remembering lines on a history list, associating arbitrary data @@ -80,9 +80,11 @@ The history list is an array of history entries. A history entry is declared as follows: @example +typedef void *histdata_t; + typedef struct _hist_entry @{ char *line; - char *data; + histdata_t data; @} HIST_ENTRY; @end example @@ -95,12 +97,14 @@ HIST_ENTRY **the_history_list; The state of the History library is encapsulated into a single structure: @example -/* A structure used to pass the current state of the history stuff around. */ +/* + * A structure used to pass around the current state of the history. + */ typedef struct _hist_state @{ - HIST_ENTRY **entries; /* Pointer to the entries themselves. */ - int offset; /* The location pointer within this array. */ - int length; /* Number of elements within this array. */ - int size; /* Number of slots allocated to this array. */ + HIST_ENTRY **entries; /* Pointer to the entries themselves. */ + int offset; /* The location pointer within this array. */ + int length; /* Number of elements within this array. */ + int size; /* Number of slots allocated to this array. */ int flags; @} HISTORY_STATE; @end example @@ -112,7 +116,7 @@ stifled. @section History Functions This section describes the calling sequence for the various functions -present in GNU History. +exported by the @sc{gnu} History library. @menu * Initializing History and State Management:: Functions to call when you @@ -139,12 +143,12 @@ This section describes functions used to initialize and manage the state of the History library when you want to use the history functions in your program. -@deftypefun void using_history () +@deftypefun void using_history (void) Begin a session in which the history functions might be used. This initializes the interactive variables. @end deftypefun -@deftypefun {HISTORY_STATE *} history_get_history_state () +@deftypefun {HISTORY_STATE *} history_get_history_state (void) Return a structure describing the current state of the input history. @end deftypefun @@ -158,7 +162,7 @@ Set the state of the history list according to @var{state}. These functions manage individual entries on the history list, or set parameters managing the list itself. -@deftypefun void add_history (char *string) +@deftypefun void add_history (const char *string) Place @var{string} at the end of the history list. The associated data field (if any) is set to @code{NULL}. @end deftypefun @@ -169,13 +173,13 @@ removed element is returned so you can free the line, data, and containing structure. @end deftypefun -@deftypefun {HIST_ENTRY *} replace_history_entry (int which, char *line, char *data) +@deftypefun {HIST_ENTRY *} replace_history_entry (int which, const char *line, histdata_t data) Make the history entry at offset @var{which} have @var{line} and @var{data}. This returns the old entry so you can dispose of the data. In the case of an invalid @var{which}, a @code{NULL} pointer is returned. @end deftypefun -@deftypefun void clear_history () +@deftypefun void clear_history (void) Clear the history list by deleting all the entries. @end deftypefun @@ -183,13 +187,13 @@ Clear the history list by deleting all the entries. Stifle the history list, remembering only the last @var{max} entries. @end deftypefun -@deftypefun int unstifle_history () +@deftypefun int unstifle_history (void) Stop stifling the history. This returns the previous amount the history was stifled. The value is positive if the history was stifled, negative if it wasn't. @end deftypefun -@deftypefun int history_is_stifled () +@deftypefun int history_is_stifled (void) Returns non-zero if the history is stifled, zero if it is not. @end deftypefun @@ -199,29 +203,30 @@ Returns non-zero if the history is stifled, zero if it is not. These functions return information about the entire history list or individual list entries. -@deftypefun {HIST_ENTRY **} history_list () -Return a @code{NULL} terminated array of @code{HIST_ENTRY} which is the +@deftypefun {HIST_ENTRY **} history_list (void) +Return a @code{NULL} terminated array of @code{HIST_ENTRY *} which is the current input history. Element 0 of this list is the beginning of time. If there is no history, return @code{NULL}. @end deftypefun -@deftypefun int where_history () +@deftypefun int where_history (void) Returns the offset of the current history element. @end deftypefun -@deftypefun {HIST_ENTRY *} current_history () +@deftypefun {HIST_ENTRY *} current_history (void) Return the history entry at the current position, as determined by -@code{where_history ()}. If there is no entry there, return a @code{NULL} +@code{where_history()}. If there is no entry there, return a @code{NULL} pointer. @end deftypefun @deftypefun {HIST_ENTRY *} history_get (int offset) Return the history entry at position @var{offset}, starting from -@code{history_base}. If there is no entry there, or if @var{offset} +@code{history_base} (@pxref{History Variables}). +If there is no entry there, or if @var{offset} is greater than the history length, return a @code{NULL} pointer. @end deftypefun -@deftypefun int history_total_bytes () +@deftypefun int history_total_bytes (void) Return the number of bytes that the primary history entries are using. This function returns the sum of the lengths of all the lines in the history. @@ -234,17 +239,19 @@ These functions allow the current index into the history list to be set or changed. @deftypefun int history_set_pos (int pos) -Set the position in the history list to @var{pos}, an absolute index +Set the current history offset to @var{pos}, an absolute index into the list. +Returns 1 on success, 0 if @var{pos} is less than zero or greater +than the number of history entries. @end deftypefun -@deftypefun {HIST_ENTRY *} previous_history () +@deftypefun {HIST_ENTRY *} previous_history (void) Back up the current history offset to the previous history entry, and return a pointer to that entry. If there is no previous entry, return a @code{NULL} pointer. @end deftypefun -@deftypefun {HIST_ENTRY *} next_history () +@deftypefun {HIST_ENTRY *} next_history (void) Move the current history offset forward to the next history entry, and return the a pointer to that entry. If there is no next entry, return a @code{NULL} pointer. @@ -260,26 +267,28 @@ from the current history position. The search may be @dfn{anchored}, meaning that the string must match at the beginning of the history entry. @cindex anchored search -@deftypefun int history_search (char *string, int direction) -Search the history for @var{string}, starting at the current history -offset. If @var{direction} < 0, then the search is through previous entries, -else through subsequent. If @var{string} is found, then +@deftypefun int history_search (const char *string, int direction) +Search the history for @var{string}, starting at the current history offset. +If @var{direction} is less than 0, then the search is through +previous entries, otherwise through subsequent entries. +If @var{string} is found, then the current history index is set to that history entry, and the value returned is the offset in the line of the entry where @var{string} was found. Otherwise, nothing is changed, and a -1 is returned. @end deftypefun -@deftypefun int history_search_prefix (char *string, int direction) +@deftypefun int history_search_prefix (const char *string, int direction) Search the history for @var{string}, starting at the current history offset. The search is anchored: matching lines must begin with -@var{string}. If @var{direction} < 0, then the search is through previous -entries, else through subsequent. If @var{string} is found, then the +@var{string}. If @var{direction} is less than 0, then the search is +through previous entries, otherwise through subsequent entries. +If @var{string} is found, then the current history index is set to that entry, and the return value is 0. Otherwise, nothing is changed, and a -1 is returned. @end deftypefun -@deftypefun int history_search_pos (char *string, int direction, int pos) +@deftypefun int history_search_pos (const char *string, int direction, int pos) Search for @var{string} in the history list, starting at @var{pos}, an absolute index into the list. If @var{direction} is negative, the search proceeds backward from @var{pos}, otherwise forward. Returns the absolute @@ -292,41 +301,46 @@ index of the history element where @var{string} was found, or -1 otherwise. The History library can read the history from and write it to a file. This section documents the functions for managing a history file. -@deftypefun int read_history (char *filename) -Add the contents of @var{filename} to the history list, a line at a -time. If @var{filename} is @code{NULL}, then read from -@file{~/.history}. Returns 0 if successful, or errno if not. +@deftypefun int read_history (const char *filename) +Add the contents of @var{filename} to the history list, a line at a time. +If @var{filename} is @code{NULL}, then read from @file{~/.history}. +Returns 0 if successful, or @code{errno} if not. @end deftypefun -@deftypefun int read_history_range (char *filename, int from, int to) +@deftypefun int read_history_range (const char *filename, int from, int to) Read a range of lines from @var{filename}, adding them to the history list. -Start reading at line @var{from} and end at @var{to}. If -@var{from} is zero, start at the beginning. If @var{to} is less than +Start reading at line @var{from} and end at @var{to}. +If @var{from} is zero, start at the beginning. If @var{to} is less than @var{from}, then read until the end of the file. If @var{filename} is @code{NULL}, then read from @file{~/.history}. Returns 0 if successful, or @code{errno} if not. @end deftypefun -@deftypefun int write_history (char *filename) +@deftypefun int write_history (const char *filename) Write the current history to @var{filename}, overwriting @var{filename} -if necessary. If @var{filename} is -@code{NULL}, then write the history list to @file{~/.history}. Values -returned are as in @code{read_history ()}. +if necessary. +If @var{filename} is @code{NULL}, then write the history list to +@file{~/.history}. +Returns 0 on success, or @code{errno} on a read or write error. @end deftypefun -@deftypefun int append_history (int nelements, char *filename) +@deftypefun int append_history (int nelements, const char *filename) Append the last @var{nelements} of the history list to @var{filename}. +If @var{filename} is @code{NULL}, then append to @file{~/.history}. +Returns 0 on success, or @code{errno} on a read or write error. @end deftypefun -@deftypefun int history_truncate_file (char *filename, int nlines) +@deftypefun int history_truncate_file (const char *filename, int nlines) Truncate the history file @var{filename}, leaving only the last @var{nlines} lines. +If @var{filename} is @code{NULL}, then @file{~/.history} is truncated. +Returns 0 on success, or @code{errno} on failure. @end deftypefun @node History Expansion @subsection History Expansion -These functions implement @code{csh}-like history expansion. +These functions implement history expansion. @deftypefun int history_expand (char *string, char **output) Expand @var{string}, placing the result into @var{output}, a pointer @@ -334,7 +348,7 @@ to a string (@pxref{History Interaction}). Returns: @table @code @item 0 If no expansions took place (or, if the only change in -the text was the de-slashifying of the history expansion +the text was the removal of escape characters preceding the history expansion character); @item 1 if expansions did take place; @@ -349,12 +363,7 @@ If an error ocurred in expansion, then @var{output} contains a descriptive error message. @end deftypefun -@deftypefun {char *} history_arg_extract (int first, int last, char *string) -Extract a string segment consisting of the @var{first} through @var{last} -arguments present in @var{string}. Arguments are broken up as in Bash. -@end deftypefun - -@deftypefun {char *} get_history_event (char *string, int *cindex, int qchar) +@deftypefun {char *} get_history_event (const char *string, int *cindex, int qchar) Returns the text of the history event beginning at @var{string} + @var{*cindex}. @var{*cindex} is modified to point to after the event specifier. At function entry, @var{cindex} points to the index into @@ -363,18 +372,24 @@ is a character that is allowed to end the event specification in addition to the ``normal'' terminating characters. @end deftypefun -@deftypefun {char **} history_tokenize (char *string) +@deftypefun {char **} history_tokenize (const char *string) Return an array of tokens parsed out of @var{string}, much as the -shell might. The tokens are split on white space and on the -characters @code{()<>;&|$}, and shell quoting conventions are -obeyed. +shell might. The tokens are split on the characters in the +@var{history_word_delimiters} variable, +and shell quoting conventions are obeyed. +@end deftypefun + +@deftypefun {char *} history_arg_extract (int first, int last, const char *string) +Extract a string segment consisting of the @var{first} through @var{last} +arguments present in @var{string}. Arguments are split using +@code{history_tokenize}. @end deftypefun @node History Variables @section History Variables -This section describes the externally visible variables exported by -the GNU History Library. +This section describes the externally-visible variables exported by +the @sc{gnu} History Library. @deftypevar int history_base The logical offset of the first entry in the history list. @@ -384,13 +399,14 @@ The logical offset of the first entry in the history list. The number of entries currently stored in the history list. @end deftypevar -@deftypevar int max_input_history +@deftypevar int history_max_entries The maximum number of history entries. This must be changed using -@code{stifle_history ()}. +@code{stifle_history()}. @end deftypevar @deftypevar char history_expansion_char -The character that starts a history event. The default is @samp{!}. +The character that introduces a history event. The default is @samp{!}. +Setting this to 0 inhibits history expansion. @end deftypevar @deftypevar char history_subst_char @@ -405,15 +421,20 @@ ignored, suppressing history expansion for the remainder of the line. This is disabled by default. @end deftypevar +@deftypevar {char *} history_word_delimiters +The characters that separate tokens for \fBhistory_tokenize()\fP. +The default value is @code{" \t\n()<>;&|"}. +@end deftypevar + @deftypevar {char *} history_no_expand_chars The list of characters which inhibit history expansion if found immediately -following @var{history_expansion_char}. The default is whitespace and -@samp{=}. +following @var{history_expansion_char}. The default is space, tab, newline, +carriage return, and @samp{=}. @end deftypevar @deftypevar {char *} history_search_delimiter_chars The list of additional characters which can delimit a history search -string, in addition to whitespace, @samp{:} and @samp{?} in the case of +string, in addition to space, TAB, @samp{:} and @samp{?} in the case of a substring search. The default is empty. @end deftypevar @@ -422,24 +443,30 @@ If non-zero, single-quoted words are not scanned for the history expansion character. The default value is 0. @end deftypevar -@deftypevar {Function *} history_inhibit_expansion_function +@deftypevar {rl_linebuf_func_t *} history_inhibit_expansion_function This should be set to the address of a function that takes two arguments: -a @code{char *} (@var{string}) and an integer index into that string (@var{i}). +a @code{char *} (@var{string}) +and an @code{int} index into that string (@var{i}). It should return a non-zero value if the history expansion starting at @var{string[i]} should not be performed; zero if the expansion should be done. It is intended for use by applications like Bash that use the history expansion character for additional purposes. -By default, this variable is set to NULL. +By default, this variable is set to @code{NULL}. @end deftypevar @node History Programming Example @section History Programming Example -The following program demonstrates simple use of the GNU History Library. +The following program demonstrates simple use of the @sc{gnu} History Library. @smallexample -main () +#include +#include + +main (argc, argv) + int argc; + char **argv; @{ char line[1024], *t; int len, done = 0; diff --git a/lib/readline/doc/hsuser.texinfo b/lib/readline/doc/hsuser.texinfo index 5f75f5df..6926b26f 100644 --- a/lib/readline/doc/hsuser.texinfo +++ b/lib/readline/doc/hsuser.texinfo @@ -38,9 +38,9 @@ For information on using the @sc{gnu} History Library in other programs, see the @sc{gnu} Readline Library Manual. @end ifset @ifclear BashFeatures -This chapter describes how to use the GNU History Library interactively, +This chapter describes how to use the @sc{gnu} History Library interactively, from a user's standpoint. It should be considered a user's guide. For -information on using the GNU History Library in your own programs, +information on using the @sc{gnu} History Library in your own programs, @pxref{Programming with GNU History}. @end ifclear @@ -65,36 +65,36 @@ information on using the GNU History Library in your own programs, @cindex command history @cindex history list -When the @samp{-o history} option to the @code{set} builtin +When the @option{-o history} option to the @code{set} builtin is enabled (@pxref{The Set Builtin}), -the shell provides access to the @var{command history}, +the shell provides access to the @dfn{command history}, the list of commands previously typed. -The value of the @code{HISTSIZE} shell variable is used as the +The value of the @env{HISTSIZE} shell variable is used as the number of commands to save in a history list. -The text of the last @code{$HISTSIZE} +The text of the last @env{$HISTSIZE} commands (default 500) is saved. The shell stores each command in the history list prior to parameter and variable expansion but after history expansion is performed, subject to the values of the shell variables -@code{HISTIGNORE} and @code{HISTCONTROL}. +@env{HISTIGNORE} and @env{HISTCONTROL}. When the shell starts up, the history is initialized from the -file named by the @code{HISTFILE} variable (default @file{~/.bash_history}). -The file named by the value of @code{HISTFILE} is truncated, if +file named by the @env{HISTFILE} variable (default @file{~/.bash_history}). +The file named by the value of @env{HISTFILE} is truncated, if necessary, to contain no more than the number of lines specified by -the value of the @code{HISTFILESIZE} variable. +the value of the @env{HISTFILESIZE} variable. When an interactive shell exits, the last -@code{$HISTSIZE} lines are copied from the history list to the file -named by @code{$HISTFILE}. +@env{$HISTSIZE} lines are copied from the history list to the file +named by @env{$HISTFILE}. If the @code{histappend} shell option is set (@pxref{Bash Builtins}), the lines are appended to the history file, otherwise the history file is overwritten. -If @code{HISTFILE} +If @env{HISTFILE} is unset, or if the history file is unwritable, the history is not saved. After saving the history, the history file is truncated -to contain no more than @code{$HISTFILESIZE} -lines. If @code{HISTFILESIZE} is not set, no truncation is performed. +to contain no more than @env{$HISTFILESIZE} +lines. If @env{HISTFILESIZE} is not set, no truncation is performed. The builtin command @code{fc} may be used to list or edit and re-execute a portion of the history list. @@ -105,7 +105,7 @@ are available in each editing mode that provide access to the history list (@pxref{Commands For History}). The shell allows control over which commands are saved on the history -list. The @code{HISTCONTROL} and @code{HISTIGNORE} +list. The @env{HISTCONTROL} and @env{HISTIGNORE} variables may be set to cause the shell to save only a subset of the commands entered. The @code{cmdhist} @@ -141,15 +141,15 @@ command beginning with that string) or as a number (an index into the history list, where a negative number is used as an offset from the current command number). If @var{last} is not specified it is set to @var{first}. If @var{first} is not specified it is set to the previous -command for editing and @minus{}16 for listing. If the @samp{-l} flag is -given, the commands are listed on standard output. The @samp{-n} flag -suppresses the command numbers when listing. The @samp{-r} flag +command for editing and @minus{}16 for listing. If the @option{-l} flag is +given, the commands are listed on standard output. The @option{-n} flag +suppresses the command numbers when listing. The @option{-r} flag reverses the order of the listing. Otherwise, the editor given by @var{ename} is invoked on a file containing those commands. If @var{ename} is not given, the value of the following variable expansion is used: @code{$@{FCEDIT:-$@{EDITOR:-vi@}@}}. This says to use the -value of the @code{FCEDIT} variable if set, or the value of the -@code{EDITOR} variable if that is set, or @code{vi} if neither is set. +value of the @env{FCEDIT} variable if set, or the value of the +@env{EDITOR} variable if that is set, or @code{vi} if neither is set. When editing is complete, the edited commands are echoed and executed. In the second form, @var{command} is re-executed after each instance @@ -170,7 +170,7 @@ history -ps @var{arg} @end example With no options, display the history list with line numbers. -Lines prefixed with with a @samp{*} have been modified. +Lines prefixed with a @samp{*} have been modified. An argument of @var{n} lists only the last @var{n} lines. Options, if supplied, have the following meanings: @@ -211,10 +211,10 @@ the history list as a single entry. @end table -When any of the @samp{-w}, @samp{-r}, @samp{-a}, or @samp{-n} options is +When any of the @option{-w}, @option{-r}, @option{-a}, or @option{-n} options is used, if @var{filename} is given, then it is used as the history file. If not, then -the value of the @code{HISTFILE} variable is used. +the value of the @env{HISTFILE} variable is used. @end table @end ifset @@ -260,9 +260,9 @@ editing buffer for further modification. If Readline is being used, and the @code{histreedit} shell option is enabled, a failed history expansion will be reloaded into the Readline editing buffer for correction. -The @samp{-p} option to the @code{history} builtin command +The @option{-p} option to the @code{history} builtin command may be used to see what a history expansion will do before using it. -The @samp{-s} option to the @code{history} builtin may be used to +The @option{-s} option to the @code{history} builtin may be used to add commands to the end of the history list without actually executing them, so that they are available for subsequent recall. This is most useful in conjunction with Readline. diff --git a/lib/readline/doc/manvers.texinfo b/lib/readline/doc/manvers.texinfo index 3122b6c6..23d30730 100644 --- a/lib/readline/doc/manvers.texinfo +++ b/lib/readline/doc/manvers.texinfo @@ -1,6 +1,6 @@ -@set EDITION 4.1 -@set VERSION 4.1 -@set UPDATED 2000 January 19 -@set UPDATE-MONTH January 2000 +@set EDITION 4.2-beta +@set VERSION 4.2-beta +@set UPDATED 2001 Mar 12 +@set UPDATE-MONTH Mar 2001 -@set LASTCHANGE Wed Jan 19 12:16:30 EST 2000 +@set LASTCHANGE Mon Mar 12 05:36:44 EST 2001 diff --git a/lib/readline/doc/rlman.texinfo b/lib/readline/doc/rlman.texinfo index 759f0eb3..894c5163 100644 --- a/lib/readline/doc/rlman.texinfo +++ b/lib/readline/doc/rlman.texinfo @@ -18,7 +18,7 @@ This document describes the GNU Readline Library, a utility which aids in the consistency of user interface across discrete programs that need to provide a command line interface. -Copyright (C) 1988-1999 Free Software Foundation, Inc. +Copyright (C) 1988-2001 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -73,7 +73,7 @@ except that this permission notice may be stated in a translation approved by the Free Software Foundation. @vskip 0pt plus 1filll -Copyright @copyright{} 1988-1999 Free Software Foundation, Inc. +Copyright @copyright{} 1988-2001 Free Software Foundation, Inc. @end titlepage @ifinfo diff --git a/lib/readline/doc/rltech.texinfo b/lib/readline/doc/rltech.texinfo index 51c340a9..acc8d4d4 100644 --- a/lib/readline/doc/rltech.texinfo +++ b/lib/readline/doc/rltech.texinfo @@ -8,7 +8,7 @@ This document describes the GNU Readline Library, a utility for aiding in the consitency of user interface across discrete programs that need to provide a command line interface. -Copyright (C) 1988, 1994, 1996, 1998, 1999 Free Software Foundation, Inc. +Copyright (C) 1988-2001 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -35,9 +35,9 @@ by the Foundation. @node Programming with GNU Readline @chapter Programming with GNU Readline -This chapter describes the interface between the GNU Readline Library and +This chapter describes the interface between the @sc{gnu} Readline Library and other programs. If you are a programmer, and you wish to include the -features found in GNU Readline +features found in @sc{gnu} Readline such as completion, line editing, and interactive history manipulation in your own programs, this section is for you. @@ -61,18 +61,20 @@ Many programs provide a command line interface, such as @code{mail}, @code{ftp}, and @code{sh}. For such programs, the default behaviour of Readline is sufficient. This section describes how to use Readline in the simplest way possible, perhaps to replace calls in your code to -@code{gets()} or @code{fgets ()}. +@code{gets()} or @code{fgets()}. @findex readline @cindex readline, function -The function @code{readline ()} prints a prompt and then reads and returns -a single line of text from the user. The line @code{readline} -returns is allocated with @code{malloc ()}; you should @code{free ()} -the line when you are done with it. The declaration for @code{readline} -in ANSI C is + +The function @code{readline()} prints a prompt @var{prompt} +and then reads and returns a single line of text from the user. +If @var{prompt} is @code{NULL} or the empty string, no prompt is displayed. +The line @code{readline} returns is allocated with @code{malloc()}; +the caller should @code{free()} the line when it has finished with it. +The declaration for @code{readline} in ANSI C is @example -@code{char *readline (char *@var{prompt});} +@code{char *readline (const char *@var{prompt});} @end example @noindent @@ -90,7 +92,7 @@ line is empty at that point, then @code{(char *)NULL} is returned. Otherwise, the line is ended just as if a newline had been typed. If you want the user to be able to get at the line later, (with -@key{C-p} for example), you must call @code{add_history ()} to save the +@key{C-p} for example), you must call @code{add_history()} to save the line away in a @dfn{history} list of such lines. @example @@ -102,7 +104,7 @@ For full details on the GNU History Library, see the associated manual. It is preferable to avoid saving empty lines on the history list, since users rarely have a burning need to reuse a blank line. Here is -a function which usefully replaces the standard @code{gets ()} library +a function which usefully replaces the standard @code{gets()} library function, and has the advantage of no static buffer to overflow: @example @@ -135,17 +137,17 @@ rl_gets () This function gives the user the default behaviour of @key{TAB} completion: completion on file names. If you do not want Readline to complete on filenames, you can change the binding of the @key{TAB} key -with @code{rl_bind_key ()}. +with @code{rl_bind_key()}. @example -@code{int rl_bind_key (int @var{key}, int (*@var{function})());} +@code{int rl_bind_key (int @var{key}, rl_command_func_t *@var{function});} @end example -@code{rl_bind_key ()} takes two arguments: @var{key} is the character that +@code{rl_bind_key()} takes two arguments: @var{key} is the character that you want to bind, and @var{function} is the address of the function to -call when @var{key} is pressed. Binding @key{TAB} to @code{rl_insert ()} +call when @var{key} is pressed. Binding @key{TAB} to @code{rl_insert()} makes @key{TAB} insert itself. -@code{rl_bind_key ()} returns non-zero if @var{key} is not a valid +@code{rl_bind_key()} returns non-zero if @var{key} is not a valid ASCII character code (between 0 and 255). Thus, to disable the default @key{TAB} behavior, the following suffices: @@ -154,7 +156,7 @@ Thus, to disable the default @key{TAB} behavior, the following suffices: @end example This code should be executed once at the start of your program; you -might write a function called @code{initialize_readline ()} which +might write a function called @code{initialize_readline()} which performs this and other desired initializations, such as installing custom completers (@pxref{Custom Completers}). @@ -175,44 +177,71 @@ in @code{readline.h} use the @code{stdio} library, the file @code{} should be included before @code{readline.h}. @menu -* The Function Type:: C declarations to make code readable. +* Readline Typedefs:: C declarations to make code readable. * Function Writing:: Variables and calling conventions. @end menu -@node The Function Type -@subsection The Function Type +@node Readline Typedefs +@subsection Readline Typedefs -For readabilty, we declare a new type of object, called -@dfn{Function}. A @code{Function} is a C function which -returns an @code{int}. The type declaration for @code{Function} is: +For readabilty, we declare a number of new object types, all pointers +to functions. -@noindent -@code{typedef int Function ();} +The reason for declaring these new types is to make it easier to write +code describing pointers to C functions with appropriately prototyped +arguments and return values. -The reason for declaring this new type is to make it easier to write -code describing pointers to C functions. Let us say we had a variable -called @var{func} which was a pointer to a function. Instead of the -classic C declaration +For instance, say we want to declare a variable @var{func} as a pointer +to a function which takes two @code{int} arguments and returns an +@code{int} (this is the type of all of the Readline bindable functions). +Instead of the classic C declaration -@code{int (*)()func;} +@code{int (*func)();} @noindent -we may write +or the ANSI-C style declaration -@code{Function *func;} +@code{int (*func)(int, int);} @noindent -Similarly, there are +we may write -@example -typedef void VFunction (); -typedef char *CPFunction (); @r{and} -typedef char **CPPFunction (); -@end example +@code{rl_command_func_t *func;} -@noindent -for functions returning no value, @code{pointer to char}, and -@code{pointer to pointer to char}, respectively. +The full list of function pointer types available is + +@table @code +@item typedef int rl_command_func_t (int, int); + +@item typedef char *rl_compentry_func_t (const char *, int); + +@item typedef char **rl_completion_func_t (const char *, int, int); + +@item typedef char *rl_quote_func_t (char *, int, char *); + +@item typedef char *rl_dequote_func_t (char *, int); + +@item typedef int rl_compignore_func_t (char **); + +@item typedef void rl_compdisp_func_t (char **, int, int); + +@item typedef int rl_hook_func_t (void); + +@item typedef int rl_getc_func_t (FILE *); + +@item typedef int rl_linebuf_func_t (char *, int); + +@item typedef int rl_intfunc_t (int); +@item #define rl_ivoidfunc_t rl_hook_func_t +@item typedef int rl_icpfunc_t (char *); +@item typedef int rl_icppfunc_t (char **); + +@item typedef void rl_voidfunc_t (void); +@item typedef void rl_vintfunc_t (int); +@item typedef void rl_vcpfunc_t (char *); +@item typedef void rl_vcppfunc_t (char **); + +@end table @node Function Writing @subsection Writing a New Function @@ -265,7 +294,7 @@ The number of characters present in @code{rl_line_buffer}. When @end deftypevar @deftypevar int rl_mark -The mark (saved position) in the current line. If set, the mark +The @var{mark} (saved position) in the current line. If set, the mark and point define a @emph{region}. @end deftypevar @@ -274,11 +303,23 @@ Setting this to a non-zero value causes Readline to return the current line immediately. @end deftypevar +@deftypevar int rl_num_chars_to_read +Setting this to a positive value before calling @code{readline()} causes +Readline to return after accepting that many characters, rather +than reading up to a character bound to @code{accept-line}. +@end deftypevar + @deftypevar int rl_pending_input Setting this to a value makes it the next keystroke read. This is a way to stuff a single character into the input stream. @end deftypevar +@deftypevar int rl_dispatching +Set to a non-zero value if a function is being called from a key binding; +zero otherwise. Application functions can test this to discover whether +they were called directly or by Readline's dispatching mechanism. +@end deftypevar + @deftypevar int rl_erase_empty_line Setting this to a non-zero value causes Readline to completely erase the current line, including any prompt, any time a newline is typed as @@ -288,7 +329,9 @@ the beginning of the newly-blank line. @deftypevar {char *} rl_prompt The prompt Readline uses. This is set from the argument to -@code{readline ()}, and should not be assigned to directly. +@code{readline()}, and should not be assigned to directly. +The @code{rl_set_prompt()} function (@pxref{Redisplay}) may +be used to modify the prompt string after calling @code{readline()}. @end deftypevar @deftypevar int rl_already_prompted @@ -301,15 +344,22 @@ The calling application is responsible for managing the value; Readline never sets it. @end deftypevar -@deftypevar {char *} rl_library_version +@deftypevar {const char *} rl_library_version The version number of this revision of the library. @end deftypevar -@deftypevar {char *} rl_terminal_name -The terminal type, used for initialization. +@deftypevar {int} rl_gnu_readline_p +Always set to 1, denoting that this is @sc{gnu} readline rather than some +emulation. @end deftypevar -@deftypevar {char *} rl_readline_name +@deftypevar {const char *} rl_terminal_name +The terminal type, used for initialization. If not set by the application, +Readline sets this to the value of the @env{TERM} environment variable +the first time it is called. +@end deftypevar + +@deftypevar {const char *} rl_readline_name This variable is set to a unique name by each application using Readline. The value allows conditional parsing of the inputrc file (@pxref{Conditional Init Constructs}). @@ -323,36 +373,60 @@ The stdio stream from which Readline reads input. The stdio stream to which Readline performs output. @end deftypevar -@deftypevar {Function *} rl_startup_hook +@deftypevar {rl_command_func_t *} rl_last_func +The address of the last command function Readline executed. May be used to +test whether or not a function is being executed twice in succession, for +example. +@end deftypevar + +@deftypevar {rl_hook_func_t *} rl_startup_hook If non-zero, this is the address of a function to call just before @code{readline} prints the first prompt. @end deftypevar -@deftypevar {Function *} rl_pre_input_hook +@deftypevar {rl_hook_func_t *} rl_pre_input_hook If non-zero, this is the address of a function to call after the first prompt has been printed and just before @code{readline} starts reading input characters. @end deftypevar -@deftypevar {Function *} rl_event_hook +@deftypevar {rl_hook_func_t *} rl_event_hook If non-zero, this is the address of a function to call periodically -when readline is waiting for terminal input. +when Readline is waiting for terminal input. +By default, this will be called at most ten times a second if there +is no keyboard input. @end deftypevar -@deftypevar {Function *} rl_getc_function -If non-zero, @code{readline} will call indirectly through this pointer +@deftypevar {rl_getc_func_t *} rl_getc_function +If non-zero, Readline will call indirectly through this pointer to get a character from the input stream. By default, it is set to -@code{rl_getc}, the default @code{readline} character input function -(@pxref{Utility Functions}). +@code{rl_getc}, the default Readline character input function +(@pxref{Character Input}). @end deftypevar -@deftypevar {VFunction *} rl_redisplay_function -If non-zero, @code{readline} will call indirectly through this pointer +@deftypevar {rl_voidfunc_t *} rl_redisplay_function +If non-zero, Readline will call indirectly through this pointer to update the display with the current contents of the editing buffer. -By default, it is set to @code{rl_redisplay}, the default @code{readline} +By default, it is set to @code{rl_redisplay}, the default Readline redisplay function (@pxref{Redisplay}). @end deftypevar +@deftypevar {rl_vintfunc_t *} rl_prep_term_function +If non-zero, Readline will call indirectly through this pointer +to initialize the terminal. The function takes a single argument, an +@code{int} flag that says whether or not to use eight-bit characters. +By default, this is set to @code{rl_prep_terminal} +(@pxref{Terminal Management}). +@end deftypevar + +@deftypevar {rl_voidfunc_t *} rl_deprep_term_function +If non-zero, Readline will call indirectly through this pointer +to reset the terminal. This function should undo the effects of +@code{rl_prep_term_function}. +By default, this is set to @code{rl_deprep_terminal} +(@pxref{Terminal Management}). +@end deftypevar + @deftypevar {Keymap} rl_executing_keymap This variable is set to the keymap (@pxref{Keymaps}) in which the currently executing readline function was found. @@ -363,6 +437,79 @@ This variable is set to the keymap (@pxref{Keymaps}) in which the last key binding occurred. @end deftypevar +@deftypevar {char *} rl_executing_macro +This variable is set to the text of any currently-executing macro. +@end deftypevar + +@deftypevar {int} rl_readline_state +A variable with bit values that encapsulate the current Readline state. +A bit is set with the @code{RL_SETSTATE} macro, and unset with the +@code{RL_UNSETSTATE} macro. Use the @code{RL_ISSTATE} macro to test +whether a particular state bit is set. Current state bits include: + +@table @code +@item RL_STATE_NONE +Readline has not yet been called, nor has it begun to intialize. +@item RL_STATE_INITIALIZING +Readline is initializing its internal data structures. +@item RL_STATE_INITIALIZED +Readline has completed its initialization. +@item RL_STATE_TERMPREPPED +Readline has modified the terminal modes to do its own input and redisplay. +@item RL_STATE_READCMD +Readline is reading a command from the keyboard. +@item RL_STATE_METANEXT +Readline is reading more input after reading the meta-prefix character. +@item RL_STATE_DISPATCHING +Readline is dispatching to a command. +@item RL_STATE_MOREINPUT +Readline is reading more input while executing an editing command. +@item RL_STATE_ISEARCH +Readline is performing an incremental history search. +@item RL_STATE_NSEARCH +Readline is performing a non-incremental history search. +@item RL_STATE_SEARCH +Readline is searching backward or forward through the history for a string. +@item RL_STATE_NUMERICARG +Readline is reading a numeric argument. +@item RL_STATE_MACROINPUT +Readline is currently getting its input from a previously-defined keyboard +macro. +@item RL_STATE_MACRODEF +Readline is currently reading characters defining a keyboard macro. +@item RL_STATE_OVERWRITE +Readline is in overwrite mode. +@item RL_STATE_COMPLETING +Readline is performing word completion. +@item RL_STATE_SIGHANDLER +Readline is currently executing the readline signal handler. +@item RL_STATE_UNDOING +Readline is performing an undo. +@item RL_STATE_DONE +Readline has read a key sequence bound to @code{accept-line} +and is about to return the line to the caller. +@end table + +@end deftypevar + +@deftypevar {int} rl_explicit_arg +Set to a non-zero value if an explicit numeric argument was specified by +the user. Only valid in a bindable command function. +@end deftypevar + +@deftypevar {int} rl_numeric_arg +Set to the value of any numeric argument explicitly specified by the user +before executing the current Readline function. Only valid in a bindable +command function. +@end deftypevar + +@deftypevar {int} rl_editing_mode +Set to a value denoting Readline's current editing mode. A value of +@var{1} means Readline is currently in emacs mode; @var{0} +means that vi mode is active. +@end deftypevar + + @node Readline Convenience Functions @section Readline Convenience Functions @@ -375,8 +522,12 @@ last key binding occurred. * Allowing Undoing:: How to make your functions undoable. * Redisplay:: Functions to control line display. * Modifying Text:: Functions to modify @code{rl_line_buffer}. +* Character Input:: Functions to read keyboard input. +* Terminal Management:: Functions to manage terminal settings. * Utility Functions:: Generally useful functions and hooks. +* Miscellaneous Functions:: Functions that don't fall into any category. * Alternate Interface:: Using Readline in a `callback' fashion. +* A Readline Example:: An example Readline function. @end menu @node Function Naming @@ -396,10 +547,10 @@ This binds the keystroke @key{Meta-Rubout} to the function programmer, should bind the functions you write to descriptive names as well. Readline provides a function for doing that: -@deftypefun int rl_add_defun (char *name, Function *function, int key) +@deftypefun int rl_add_defun (const char *name, rl_command_func_t *function, int key) Add @var{name} to the list of named functions. Make @var{function} be the function that gets called. If @var{key} is not -1, then bind it to -@var{function} using @code{rl_bind_key ()}. +@var{function} using @code{rl_bind_key()}. @end deftypefun Using this function alone is sufficient for most applications. It is @@ -416,16 +567,17 @@ association between the keys that the user types and the functions that get run. You can make your own keymaps, copy existing keymaps, and tell Readline which keymap to use. -@deftypefun Keymap rl_make_bare_keymap () +@deftypefun Keymap rl_make_bare_keymap (void) Returns a new, empty keymap. The space for the keymap is allocated with -@code{malloc ()}; you should @code{free ()} it when you are done. +@code{malloc()}; the caller should free it by calling +@code{rl_discard_keymap()} when done. @end deftypefun @deftypefun Keymap rl_copy_keymap (Keymap map) Return a new keymap which is a copy of @var{map}. @end deftypefun -@deftypefun Keymap rl_make_keymap () +@deftypefun Keymap rl_make_keymap (void) Return a new keymap with the printing characters bound to rl_insert, the lowercase Meta characters bound to run their equivalents, and the Meta digits bound to produce numeric arguments. @@ -438,7 +590,7 @@ Free the storage associated with @var{keymap}. Readline has several internal keymaps. These functions allow you to change which keymap is active. -@deftypefun Keymap rl_get_keymap () +@deftypefun Keymap rl_get_keymap (void) Returns the currently active keymap. @end deftypefun @@ -446,7 +598,7 @@ Returns the currently active keymap. Makes @var{keymap} the currently active keymap. @end deftypefun -@deftypefun Keymap rl_get_keymap_by_name (char *name) +@deftypefun Keymap rl_get_keymap_by_name (const char *name) Return the keymap matching @var{name}. @var{name} is one which would be supplied in a @code{set keymap} inputrc line (@pxref{Readline Init File}). @end deftypefun @@ -459,28 +611,28 @@ be supplied in a @code{set keymap} inputrc line (@pxref{Readline Init File}). @node Binding Keys @subsection Binding Keys -You associate keys with functions through the keymap. Readline has -several internal keymaps: @code{emacs_standard_keymap}, +Key sequences are associate with functions through the keymap. +Readline has several internal keymaps: @code{emacs_standard_keymap}, @code{emacs_meta_keymap}, @code{emacs_ctlx_keymap}, @code{vi_movement_keymap}, and @code{vi_insertion_keymap}. @code{emacs_standard_keymap} is the default, and the examples in this manual assume that. -Since @code{readline} installs a set of default key bindings the first +Since @code{readline()} installs a set of default key bindings the first time it is called, there is always the danger that a custom binding -installed before the first call to @code{readline} will be overridden. +installed before the first call to @code{readline()} will be overridden. An alternate mechanism is to install custom key bindings in an initialization function assigned to the @code{rl_startup_hook} variable (@pxref{Readline Variables}). These functions manage key bindings. -@deftypefun int rl_bind_key (int key, Function *function) +@deftypefun int rl_bind_key (int key, rl_command_func_t *function) Binds @var{key} to @var{function} in the currently active keymap. Returns non-zero in the case of an invalid @var{key}. @end deftypefun -@deftypefun int rl_bind_key_in_map (int key, Function *function, Keymap map) +@deftypefun int rl_bind_key_in_map (int key, rl_command_func_t *function, Keymap map) Bind @var{key} to @var{function} in @var{map}. Returns non-zero in the case of an invalid @var{key}. @end deftypefun @@ -495,15 +647,21 @@ Bind @var{key} to the null function in @var{map}. Returns non-zero in case of error. @end deftypefun -@deftypefun int rl_unbind_function_in_map (Function *function, Keymap map) +@deftypefun int rl_unbind_function_in_map (rl_command_func_t *function, Keymap map) Unbind all keys that execute @var{function} in @var{map}. @end deftypefun -@deftypefun int rl_unbind_command_in_map (char *command, Keymap map) +@deftypefun int rl_unbind_command_in_map (const char *command, Keymap map) Unbind all keys that are bound to @var{command} in @var{map}. @end deftypefun -@deftypefun int rl_generic_bind (int type, char *keyseq, char *data, Keymap map) +@deftypefun int rl_set_key (const char *keyseq, rl_command_func_t *function, Keymap map) +Bind the key sequence represented by the string @var{keyseq} to the function +@var{function}. This makes new keymaps as +necessary. The initial keymap in which to do bindings is @var{map}. +@end deftypefun + +@deftypefun int rl_generic_bind (int type, const char *keyseq, char *data, Keymap map) Bind the key sequence represented by the string @var{keyseq} to the arbitrary pointer @var{data}. @var{type} says what kind of data is pointed to by @var{data}; this can be a function (@code{ISFUNC}), a macro @@ -517,7 +675,7 @@ perform any key bindings and variable assignments found (@pxref{Readline Init File}). @end deftypefun -@deftypefun int rl_read_init_file (char *filename) +@deftypefun int rl_read_init_file (const char *filename) Read keybindings and variable assignments from @var{filename} (@pxref{Readline Init File}). @end deftypefun @@ -526,25 +684,26 @@ Read keybindings and variable assignments from @var{filename} @subsection Associating Function Names and Bindings These functions allow you to find out what keys invoke named functions -and the functions invoked by a particular key sequence. +and the functions invoked by a particular key sequence. You may also +associate a new function name with an arbitrary function. -@deftypefun {Function *} rl_named_function (char *name) +@deftypefun {rl_command_func_t *} rl_named_function (const char *name) Return the function with name @var{name}. @end deftypefun -@deftypefun {Function *} rl_function_of_keyseq (char *keyseq, Keymap map, int *type) +@deftypefun {rl_command_func_t *} rl_function_of_keyseq (const char *keyseq, Keymap map, int *type) Return the function invoked by @var{keyseq} in keymap @var{map}. -If @var{map} is NULL, the current keymap is used. If @var{type} is -not NULL, the type of the object is returned in it (one of @code{ISFUNC}, -@code{ISKMAP}, or @code{ISMACR}). +If @var{map} is @code{NULL}, the current keymap is used. If @var{type} is +not @code{NULL}, the type of the object is returned in the @code{int} variable +it points to (one of @code{ISFUNC}, @code{ISKMAP}, or @code{ISMACR}). @end deftypefun -@deftypefun {char **} rl_invoking_keyseqs (Function *function) +@deftypefun {char **} rl_invoking_keyseqs (rl_command_func_t *function) Return an array of strings representing the key sequences used to invoke @var{function} in the current keymap. @end deftypefun -@deftypefun {char **} rl_invoking_keyseqs_in_map (Function *function, Keymap map) +@deftypefun {char **} rl_invoking_keyseqs_in_map (rl_command_func_t *function, Keymap map) Return an array of strings representing the key sequences used to invoke @var{function} in the keymap @var{map}. @end deftypefun @@ -556,14 +715,19 @@ the list is formatted in such a way that it can be made part of an @code{inputrc} file and re-read. @end deftypefun -@deftypefun void rl_list_funmap_names () +@deftypefun void rl_list_funmap_names (void) Print the names of all bindable Readline functions to @code{rl_outstream}. @end deftypefun -@deftypefun {char **} rl_funmap_names () +@deftypefun {const char **} rl_funmap_names (void) Return a NULL terminated array of known function names. The array is sorted. The array itself is allocated, but not the strings inside. You -should free () the array when you done, but not the pointrs. +should @code{free()} the array when you are done, but not the pointers. +@end deftypefun + +@deftypefun int rl_add_funmap_entry (const char *name, rl_command_func_t *function) +Add @var{name} to the list of bindable Readline command names, and make +@var{function} the function to be called when @var{name} is invoked. @end deftypefun @node Allowing Undoing @@ -571,17 +735,16 @@ should free () the array when you done, but not the pointrs. Supporting the undo command is a painless thing, and makes your functions much more useful. It is certainly easy to try -something if you know you can undo it. I could use an undo function for -the stock market. +something if you know you can undo it. If your function simply inserts text once, or deletes text once, and -uses @code{rl_insert_text ()} or @code{rl_delete_text ()} to do it, then +uses @code{rl_insert_text()} or @code{rl_delete_text()} to do it, then undoing is already done for you automatically. If you do multiple insertions or multiple deletions, or any combination of these operations, you should group them together into one operation. -This is done with @code{rl_begin_undo_group ()} and -@code{rl_end_undo_group ()}. +This is done with @code{rl_begin_undo_group()} and +@code{rl_end_undo_group()}. The types of events that can be undone are: @@ -591,21 +754,21 @@ enum undo_code @{ UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END @}; Notice that @code{UNDO_DELETE} means to insert some text, and @code{UNDO_INSERT} means to delete some text. That is, the undo code -tells undo what to undo, not how to undo it. @code{UNDO_BEGIN} and -@code{UNDO_END} are tags added by @code{rl_begin_undo_group ()} and -@code{rl_end_undo_group ()}. +tells what to undo, not how to undo it. @code{UNDO_BEGIN} and +@code{UNDO_END} are tags added by @code{rl_begin_undo_group()} and +@code{rl_end_undo_group()}. -@deftypefun int rl_begin_undo_group () +@deftypefun int rl_begin_undo_group (void) Begins saving undo information in a group construct. The undo -information usually comes from calls to @code{rl_insert_text ()} and -@code{rl_delete_text ()}, but could be the result of calls to -@code{rl_add_undo ()}. +information usually comes from calls to @code{rl_insert_text()} and +@code{rl_delete_text()}, but could be the result of calls to +@code{rl_add_undo()}. @end deftypefun -@deftypefun int rl_end_undo_group () +@deftypefun int rl_end_undo_group (void) Closes the current undo group started with @code{rl_begin_undo_group -()}. There should be one call to @code{rl_end_undo_group ()} -for each call to @code{rl_begin_undo_group ()}. +()}. There should be one call to @code{rl_end_undo_group()} +for each call to @code{rl_begin_undo_group()}. @end deftypefun @deftypefun void rl_add_undo (enum undo_code what, int start, int end, char *text) @@ -613,17 +776,17 @@ Remember how to undo an event (according to @var{what}). The affected text runs from @var{start} to @var{end}, and encompasses @var{text}. @end deftypefun -@deftypefun void free_undo_list () +@deftypefun void rl_free_undo_list (void) Free the existing undo list. @end deftypefun -@deftypefun int rl_do_undo () +@deftypefun int rl_do_undo (void) Undo the first thing on the undo list. Returns @code{0} if there was nothing to undo, non-zero if something was undone. @end deftypefun Finally, if you neither insert nor delete text, but directly modify the -existing text (e.g., change its case), call @code{rl_modifying ()} +existing text (e.g., change its case), call @code{rl_modifying()} once, just before you modify the text. You must supply the indices of the text range that you are going to modify. @@ -636,22 +799,22 @@ that text. @node Redisplay @subsection Redisplay -@deftypefun void rl_redisplay () +@deftypefun void rl_redisplay (void) Change what's displayed on the screen to reflect the current contents of @code{rl_line_buffer}. @end deftypefun -@deftypefun int rl_forced_update_display () +@deftypefun int rl_forced_update_display (void) Force the line to be updated and redisplayed, whether or not Readline thinks the screen display is correct. @end deftypefun -@deftypefun int rl_on_new_line () +@deftypefun int rl_on_new_line (void) Tell the update functions that we have moved onto a new (empty) line, usually after ouputting a newline. @end deftypefun -@deftypefun int rl_on_new_line_with_prompt () +@deftypefun int rl_on_new_line_with_prompt (void) Tell the update functions that we have moved onto a new line, with @var{rl_prompt} already displayed. This could be used by applications that want to output the prompt string @@ -660,35 +823,65 @@ redisplay. It should be used after setting @var{rl_already_prompted}. @end deftypefun -@deftypefun int rl_reset_line_state () +@deftypefun int rl_reset_line_state (void) Reset the display state to a clean state and redisplay the current line starting on a new line. @end deftypefun -@deftypefun int rl_message (va_alist) -The arguments are a string as would be supplied to @code{printf}. The -resulting string is displayed in the @dfn{echo area}. The echo area +@deftypefun int rl_crlf (void) +Move the cursor to the start of the next screen line. +@end deftypefun + +@deftypefun int rl_show_char (int c) +Display character @var{c} on @code{rl_outstream}. +If Readline has not been set to display meta characters directly, this +will convert meta characters to a meta-prefixed key sequence. +This is intended for use by applications which wish to do their own +redisplay. +@end deftypefun + +@deftypefun int rl_message (const char *, @dots{}) +The arguments are a format string as would be supplied to @code{printf}, +possibly containing conversion specifications such as @samp{%d}, and +any additional arguments necessary to satisfy the conversion specifications. +The resulting string is displayed in the @dfn{echo area}. The echo area is also used to display numeric arguments and search strings. @end deftypefun -@deftypefun int rl_clear_message () +@deftypefun int rl_clear_message (void) Clear the message in the echo area. @end deftypefun -@deftypefun void rl_save_prompt () +@deftypefun void rl_save_prompt (void) Save the local Readline prompt display state in preparation for -displaying a new message in the message area with @code{rl_message}. +displaying a new message in the message area with @code{rl_message()}. @end deftypefun -@deftypefun void rl_restore_prompt () +@deftypefun void rl_restore_prompt (void) Restore the local Readline prompt display state saved by the most recent call to @code{rl_save_prompt}. @end deftypefun +@deftypefun int rl_expand_prompt (char *prompt) +Expand any special character sequences in @var{prompt} and set up the +local Readline prompt redisplay variables. +This function is called by @code{readline()}. It may also be called to +expand the primary prompt if the @code{rl_on_new_line_with_prompt()} +function or @code{rl_already_prompted} variable is used. +It returns the number of visible characters on the last line of the +(possibly multi-line) prompt. +@end deftypefun + +@deftypefun int rl_set_prompt (const char *prompt) +Make Readline use @var{prompt} for subsequent redisplay. This calls +@code{rl_expand_prompt()} to expand the prompt and sets @code{rl_prompt} +to the result. +@end deftypefun + @node Modifying Text @subsection Modifying Text -@deftypefun int rl_insert_text (char *text) +@deftypefun int rl_insert_text (const char *text) Insert @var{text} into the line at the current cursor position. @end deftypefun @@ -710,53 +903,104 @@ the text is appended, otherwise prepended. If the last command was not a kill, a new kill ring slot is used. @end deftypefun -@node Utility Functions -@subsection Utility Functions +@deftypefun int rl_push_macro_input (char *macro) +Cause @var{macro} to be inserted into the line, as if it had been invoked +by a key bound to a macro. Not especially useful; use +@code{rl_insert_text()} instead. +@end deftypefun -@deftypefun int rl_read_key () -Return the next character available. This handles input inserted into -the input stream via @var{pending input} (@pxref{Readline Variables}) -and @code{rl_stuff_char ()}, macros, and characters read from the keyboard. +@node Character Input +@subsection Character Input + +@deftypefun int rl_read_key (void) +Return the next character available from Readline's current input stream. +This handles input inserted into +the input stream via @var{rl_pending_input} (@pxref{Readline Variables}) +and @code{rl_stuff_char()}, macros, and characters read from the keyboard. +While waiting for input, this function will call any function assigned to +the @code{rl_event_hook} variable. @end deftypefun -@deftypefun int rl_getc (FILE *) -Return the next character available from the keyboard. +@deftypefun int rl_getc (FILE *stream) +Return the next character available from @var{stream}, which is assumed to +be the keyboard. @end deftypefun @deftypefun int rl_stuff_char (int c) Insert @var{c} into the Readline input stream. It will be "read" before Readline attempts to read characters from the terminal with -@code{rl_read_key ()}. +@code{rl_read_key()}. @end deftypefun -@deftypefun int rl_extend_line_buffer (int len) -Ensure that @code{rl_line_buffer} has enough space to hold @var{len} -characters, possibly reallocating it if necessary. +@deftypefun int rl_execute_next (int c) +Make @var{c} be the next command to be executed when @code{rl_read_key()} +is called. This sets @var{rl_pending_input}. @end deftypefun -@deftypefun int rl_initialize () -Initialize or re-initialize Readline's internal state. +@deftypefun int rl_clear_pending_input (void) +Unset @var{rl_pending_input}, effectively negating the effect of any +previous call to @code{rl_execute_next()}. This works only if the +pending input has not already been read with @code{rl_read_key()}. +@end deftypefun + +@deftypefun int rl_set_keyboard_input_timeout (int u) +While waiting for keyboard input in @code{rl_read_key()}, Readline will +wait for @var{u} microseconds for input before calling any function +assigned to @code{rl_event_hook}. The default waiting period is +one-tenth of a second. Returns the old timeout value. @end deftypefun -@deftypefun int rl_reset_terminal (char *terminal_name) +@node Terminal Management +@subsection Terminal Management + +@deftypefun void rl_prep_terminal (int meta_flag) +Modify the terminal settings for Readline's use, so @code{readline()} +can read a single character at a time from the keyboard. +The @var{meta_flag} argument should be non-zero if Readline should +read eight-bit input. +@end deftypefun + +@deftypefun void rl_deprep_terminal (void) +Undo the effects of @code{rl_prep_terminal()}, leaving the terminal in +the state in which it was before the most recent call to +@code{rl_prep_terminal()}. +@end deftypefun + +@deftypefun void rl_tty_set_default_bindings (Keymap kmap) +Read the operating system's terminal editing characters (as would be displayed +by @code{stty}) to their Readline equivalents. The bindings are performed +in @var{kmap}. +@end deftypefun + +@deftypefun int rl_reset_terminal (const char *terminal_name) Reinitialize Readline's idea of the terminal settings using @var{terminal_name} as the terminal type (e.g., @code{vt100}). -If @var{terminal_name} is NULL, the value of the @code{TERM} +If @var{terminal_name} is @code{NULL}, the value of the @code{TERM} environment variable is used. @end deftypefun -@deftypefun int alphabetic (int c) -Return 1 if @var{c} is an alphabetic character. +@node Utility Functions +@subsection Utility Functions + +@deftypefun int rl_extend_line_buffer (int len) +Ensure that @code{rl_line_buffer} has enough space to hold @var{len} +characters, possibly reallocating it if necessary. @end deftypefun -@deftypefun int numeric (int c) -Return 1 if @var{c} is a numeric character. +@deftypefun int rl_initialize (void) +Initialize or re-initialize Readline's internal state. +It's not strictly necessary to call this; @code{readline()} calls it before +reading any input. @end deftypefun -@deftypefun int ding () +@deftypefun int rl_ding (void) Ring the terminal bell, obeying the setting of @code{bell-style}. @end deftypefun +@deftypefun int rl_alphabetic (int c) +Return 1 if @var{c} is an alphabetic character. +@end deftypefun + @deftypefun void rl_display_match_list (char **matches, int len, int max) A convenience function for displaying a list of strings in columnar format on Readline's output stream. @code{matches} is the list @@ -767,34 +1011,71 @@ the setting of @code{print-completions-horizontally} to select how the matches are displayed (@pxref{Readline Init File Syntax}). @end deftypefun -The following are implemented as macros, defined in @code{chartypes.h}. +The following are implemented as macros, defined in @code{chardefs.h}. +Applications should refrain from using them. -@deftypefun int uppercase_p (int c) +@deftypefun int _rl_uppercase_p (int c) Return 1 if @var{c} is an uppercase alphabetic character. @end deftypefun -@deftypefun int lowercase_p (int c) +@deftypefun int _rl_lowercase_p (int c) Return 1 if @var{c} is a lowercase alphabetic character. @end deftypefun -@deftypefun int digit_p (int c) +@deftypefun int _rl_digit_p (int c) Return 1 if @var{c} is a numeric character. @end deftypefun -@deftypefun int to_upper (int c) +@deftypefun int _rl_to_upper (int c) If @var{c} is a lowercase alphabetic character, return the corresponding uppercase character. @end deftypefun -@deftypefun int to_lower (int c) +@deftypefun int _rl_to_lower (int c) If @var{c} is an uppercase alphabetic character, return the corresponding lowercase character. @end deftypefun -@deftypefun int digit_value (int c) +@deftypefun int _rl_digit_value (int c) If @var{c} is a number, return the value it represents. @end deftypefun +@node Miscellaneous Functions +@subsection Miscellaneous Functions + +@deftypefun int rl_macro_bind (const char *keyseq, const char *macro, Keymap map) +Bind the key sequence @var{keyseq} to invoke the macro @var{macro}. +The binding is performed in @var{map}. When @var{keyseq} is invoked, the +@var{macro} will be inserted into the line. This function is deprecated; +use @code{rl_generic_bind()} instead. +@end deftypefun + +@deftypefun void rl_macro_dumper (int readable) +Print the key sequences bound to macros and their values, using +the current keymap, to @code{rl_outstream}. +If @var{readable} is non-zero, the list is formatted in such a way +that it can be made part of an @code{inputrc} file and re-read. +@end deftypefun + +@deftypefun int rl_variable_bind (const char *variable, const char *value) +Make the Readline variable @var{variable} have @var{value}. +This behaves as if the readline command +@samp{set @var{variable} @var{value}} had been executed in an @code{inputrc} +file (@pxref{Readline Init File Syntax}). +@end deftypefun + +@deftypefun void rl_variable_dumper (int readable) +Print the readline variable names and their current values +to @code{rl_outstream}. +If @var{readable} is non-zero, the list is formatted in such a way +that it can be made part of an @code{inputrc} file and re-read. +@end deftypefun + +@deftypefun int rl_set_paren_blink_timeout (int u) +Set the time interval (in microseconds) that Readline waits when showing +a balancing character when @code{blink-matching-paren} has been enabled. +@end deftypefun + @node Alternate Interface @subsection Alternate Interface @@ -805,13 +1086,14 @@ on various file descriptors. To accomodate this need, readline can also be invoked as a `callback' function from an event loop. There are functions available to make this easy. -@deftypefun void rl_callback_handler_install (char *prompt, Vfunction *lhandler) +@deftypefun void rl_callback_handler_install (const char *prompt, rl_vcpfunc_t *lhandler) Set up the terminal for readline I/O and display the initial expanded value of @var{prompt}. Save the value of @var{lhandler} to -use as a callback when a complete line of input has been entered. +use as a function to call when a complete line of input has been entered. +The function takes the text of the line as an argument. @end deftypefun -@deftypefun void rl_callback_read_char () +@deftypefun void rl_callback_read_char (void) Whenever an application determines that keyboard input is available, it should call @code{rl_callback_read_char()}, which will read the next character from the current input source. If that character completes the @@ -821,12 +1103,13 @@ line. @code{EOF} is indicated by calling @var{lhandler} with a @code{NULL} line. @end deftypefun -@deftypefun void rl_callback_handler_remove () +@deftypefun void rl_callback_handler_remove (void) Restore the terminal to its initial state and remove the line handler. This may be called from within a callback as well as independently. @end deftypefun -@subsection An Example +@node A Readline Example +@subsection A Readline Example Here is a function which changes lowercase characters to their uppercase equivalents, and uppercase characters to lowercase. If @@ -881,10 +1164,10 @@ invert_case_line (count, key) for (i = start; i != end; i++) @{ - if (uppercase_p (rl_line_buffer[i])) - rl_line_buffer[i] = to_lower (rl_line_buffer[i]); - else if (lowercase_p (rl_line_buffer[i])) - rl_line_buffer[i] = to_upper (rl_line_buffer[i]); + if (_rl_uppercase_p (rl_line_buffer[i])) + rl_line_buffer[i] = _rl_to_lower (rl_line_buffer[i]); + else if (_rl_lowercase_p (rl_line_buffer[i])) + rl_line_buffer[i] = _rl_to_upper (rl_line_buffer[i]); @} /* Move point to on top of the last character changed. */ rl_point = (direction == 1) ? end - 1 : start; @@ -897,44 +1180,44 @@ invert_case_line (count, key) Signals are asynchronous events sent to a process by the Unix kernel, sometimes on behalf of another process. They are intended to indicate -exceptional events, like a user pressing the interrupt key on his -terminal, or a network connection being broken. There is a class of -signals that can be sent to the process currently reading input from -the keyboard. Since Readline changes the terminal attributes when it -is called, it needs to perform special processing when a signal is -received to restore the terminal to a sane state, or provide application -writers with functions to do so manually. +exceptional events, like a user pressing the interrupt key on his terminal, +or a network connection being broken. There is a class of signals that can +be sent to the process currently reading input from the keyboard. Since +Readline changes the terminal attributes when it is called, it needs to +perform special processing when such a signal is received in order to +restore the terminal to a sane state, or provide application writers with +functions to do so manually. Readline contains an internal signal handler that is installed for a number of signals (@code{SIGINT}, @code{SIGQUIT}, @code{SIGTERM}, @code{SIGALRM}, @code{SIGTSTP}, @code{SIGTTIN}, and @code{SIGTTOU}). When one of these signals is received, the signal handler will reset the terminal attributes to those that were in effect before -@code{readline ()} was called, reset the signal handling to what it was -before @code{readline ()} was called, and resend the signal to the calling +@code{readline()} was called, reset the signal handling to what it was +before @code{readline()} was called, and resend the signal to the calling application. If and when the calling application's signal handler returns, Readline will reinitialize the terminal and continue to accept input. When a @code{SIGINT} is received, the Readline signal handler performs some additional work, which will cause any partially-entered line to be -aborted (see the description of @code{rl_free_line_state ()}). +aborted (see the description of @code{rl_free_line_state()} below). There is an additional Readline signal handler, for @code{SIGWINCH}, which the kernel sends to a process whenever the terminal's size changes (for example, if a user resizes an @code{xterm}). The Readline @code{SIGWINCH} -handler updates Readline's internal screen size state, and then calls any -@code{SIGWINCH} signal handler the calling application has installed. +handler updates Readline's internal screen size information, and then calls +any @code{SIGWINCH} signal handler the calling application has installed. Readline calls the application's @code{SIGWINCH} signal handler without resetting the terminal to its original state. If the application's signal handler does more than update its idea of the terminal size and return (for example, a @code{longjmp} back to a main processing loop), it @emph{must} -call @code{rl_cleanup_after_signal ()} (described below), to restore the +call @code{rl_cleanup_after_signal()} (described below), to restore the terminal state. Readline provides two variables that allow application writers to control whether or not it will catch certain signals and act on them when they are received. It is important that applications change the -values of these variables only when calling @code{readline ()}, not in +values of these variables only when calling @code{readline()}, not in a signal handler, so Readline's internal signal state is not corrupted. @deftypevar int rl_catch_signals @@ -960,7 +1243,7 @@ and internal state cleanup upon receipt of a signal. @deftypefun void rl_cleanup_after_signal (void) This function will reset the state of the terminal to what it was before -@code{readline ()} was called, and remove the Readline signal handlers for +@code{readline()} was called, and remove the Readline signal handlers for all signals, depending on the values of @code{rl_catch_signals} and @code{rl_catch_sigwinch}. @end deftypefun @@ -969,7 +1252,7 @@ all signals, depending on the values of @code{rl_catch_signals} and This will free any partial state associated with the current input line (undo information, any partial history entry, any partially-entered keyboard macro, and any partially-entered numeric argument). This -should be called before @code{rl_cleanup_after_signal ()}. The +should be called before @code{rl_cleanup_after_signal()}. The Readline signal handler for @code{SIGINT} calls this to abort the current input line. @end deftypefun @@ -981,11 +1264,26 @@ handlers, depending on the values of @code{rl_catch_signals} and @end deftypefun If an application does not wish Readline to catch @code{SIGWINCH}, it may -call @code{rl_resize_terminal ()} to force Readline to update its idea of -the terminal size when a @code{SIGWINCH} is received. +call @code{rl_resize_terminal()} or @code{rl_set_screen_size()} to force +Readline to update its idea of the terminal size when a @code{SIGWINCH} +is received. @deftypefun void rl_resize_terminal (void) -Update Readline's internal screen size. +Update Readline's internal screen size by reading values from the kernel. +@end deftypefun + +@deftypefun void rl_set_screen_size (int rows, int cols) +Set Readline's idea of the terminal size to @var{rows} rows and +@var{cols} columns. +@end deftypefun + +If an application does not want to install a @code{SIGWINCH} handler, but +is still interested in the screen dimensions, Readline's idea of the screen +size may be queried. + +@deftypefun void rl_get_screen_size (int *rows, int *cols) +Return Readline's idea of the terminal's size in the +variables pointed to by the arguments. @end deftypefun The following functions install and remove Readline's signal handlers. @@ -999,7 +1297,7 @@ Install Readline's signal handler for @code{SIGINT}, @code{SIGQUIT}, @deftypefun int rl_clear_signals (void) Remove all of the Readline signal handlers installed by -@code{rl_set_signals ()}. +@code{rl_set_signals()}. @end deftypefun @node Custom Completers @@ -1034,30 +1332,31 @@ There are three major functions used to perform completion: @enumerate @item -The user-interface function @code{rl_complete ()}. This function is -called with the same arguments as other Readline -functions intended for interactive use: @var{count} and -@var{invoking_key}. It isolates the word to be completed and calls -@code{completion_matches ()} to generate a list of possible completions. +The user-interface function @code{rl_complete()}. This function is +called with the same arguments as other bindable Readline functions: +@var{count} and @var{invoking_key}. +It isolates the word to be completed and calls +@code{rl_completion_matches()} to generate a list of possible completions. It then either lists the possible completions, inserts the possible completions, or actually performs the completion, depending on which behavior is desired. @item -The internal function @code{completion_matches ()} uses your -@dfn{generator} function to generate the list of possible matches, and -then returns the array of these matches. You should place the address -of your generator function in @code{rl_completion_entry_function}. +The internal function @code{rl_completion_matches()} uses an +application-supplied @dfn{generator} function to generate the list of +possible matches, and then returns the array of these matches. +The caller should place the address of its generator function in +@code{rl_completion_entry_function}. @item The generator function is called repeatedly from -@code{completion_matches ()}, returning a string each time. The +@code{rl_completion_matches()}, returning a string each time. The arguments to the generator function are @var{text} and @var{state}. @var{text} is the partial word to be completed. @var{state} is zero the first time the function is called, allowing the generator to perform any necessary initialization, and a positive non-zero integer for -each subsequent call. When the generator function returns -@code{(char *)NULL} this signals @code{completion_matches ()} that there are +each subsequent call. The generator function returns +@code{(char *)NULL} to inform @code{rl_completion_matches()} that there are no more possibilities left. Usually the generator function computes the list of possible completions when @var{state} is zero, and returns them one at a time on subsequent calls. Each string the generator function @@ -1069,14 +1368,15 @@ frees the strings when it has finished with them. @deftypefun int rl_complete (int ignore, int invoking_key) Complete the word at or before point. You have supplied the function that does the initial simple matching selection algorithm (see -@code{completion_matches ()}). The default is to do filename completion. +@code{rl_completion_matches()}). The default is to do filename completion. @end deftypefun -@deftypevar {Function *} rl_completion_entry_function -This is a pointer to the generator function for @code{completion_matches -()}. If the value of @code{rl_completion_entry_function} is -@code{(Function *)NULL} then the default filename generator function, -@code{filename_completion_function ()}, is used. +@deftypevar {rl_compentry_func_t *} rl_completion_entry_function +This is a pointer to the generator function for +@code{rl_completion_matches()}. +If the value of @code{rl_completion_entry_function} is +@code{NULL} then the default filename generator +function, @code{rl_filename_completion_function()}, is used. @end deftypevar @node Completion Functions @@ -1097,47 +1397,47 @@ performing partial completion. @deftypefun int rl_complete (int ignore, int invoking_key) Complete the word at or before point. You have supplied the function that does the initial simple matching selection algorithm (see -@code{completion_matches ()} and @code{rl_completion_entry_function}). +@code{rl_completion_matches()} and @code{rl_completion_entry_function}). The default is to do filename -completion. This calls @code{rl_complete_internal ()} with an +completion. This calls @code{rl_complete_internal()} with an argument depending on @var{invoking_key}. @end deftypefun -@deftypefun int rl_possible_completions (int count, int invoking_key)) +@deftypefun int rl_possible_completions (int count, int invoking_key) List the possible completions. See description of @code{rl_complete -()}. This calls @code{rl_complete_internal ()} with an argument of +()}. This calls @code{rl_complete_internal()} with an argument of @samp{?}. @end deftypefun -@deftypefun int rl_insert_completions (int count, int invoking_key)) +@deftypefun int rl_insert_completions (int count, int invoking_key) Insert the list of possible completions into the line, deleting the -partially-completed word. See description of @code{rl_complete ()}. -This calls @code{rl_complete_internal ()} with an argument of @samp{*}. +partially-completed word. See description of @code{rl_complete()}. +This calls @code{rl_complete_internal()} with an argument of @samp{*}. @end deftypefun -@deftypefun {char **} completion_matches (char *text, CPFunction *entry_func) -Returns an array of @code{(char *)} which is a list of completions for -@var{text}. If there are no completions, returns @code{(char **)NULL}. +@deftypefun {char **} rl_completion_matches (const char *text, rl_compentry_func_t *entry_func) +Returns an array of strings which is a list of completions for +@var{text}. If there are no completions, returns @code{NULL}. The first entry in the returned array is the substitution for @var{text}. The remaining entries are the possible completions. The array is terminated with a @code{NULL} pointer. @var{entry_func} is a function of two args, and returns a -@code{(char *)}. The first argument is @var{text}. The second is a +@code{char *}. The first argument is @var{text}. The second is a state argument; it is zero on the first call, and non-zero on subsequent calls. @var{entry_func} returns a @code{NULL} pointer to the caller when there are no more matches. @end deftypefun -@deftypefun {char *} filename_completion_function (char *text, int state) -A generator function for filename completion in the general case. Note -that completion in Bash is a little different because of all -the pathnames that must be followed when looking up completions for a -command. The Bash source is a useful reference for writing custom -completion functions. +@deftypefun {char *} rl_filename_completion_function (const char *text, int state) +A generator function for filename completion in the general case. +@var{text} is a partial filename. +The Bash source is a useful reference for writing custom +completion functions (the Bash completion functions call this and other +Readline functions). @end deftypefun -@deftypefun {char *} username_completion_function (char *text, int state) +@deftypefun {char *} rl_username_completion_function (const char *text, int state) A completion generator for usernames. @var{text} contains a partial username preceded by a random character (usually @samp{~}). As with all completion generators, @var{state} is zero on the first call and non-zero @@ -1147,26 +1447,29 @@ for subsequent calls. @node Completion Variables @subsection Completion Variables -@deftypevar {Function *} rl_completion_entry_function -A pointer to the generator function for @code{completion_matches ()}. -@code{NULL} means to use @code{filename_completion_function ()}, the default +@deftypevar {rl_compentry_func_t *} rl_completion_entry_function +A pointer to the generator function for @code{rl_completion_matches()}. +@code{NULL} means to use @code{rl_filename_completion_function()}, the default filename completer. @end deftypevar -@deftypevar {CPPFunction *} rl_attempted_completion_function +@deftypevar {rl_completion_func_t *} rl_attempted_completion_function A pointer to an alternative function to create matches. The function is called with @var{text}, @var{start}, and @var{end}. -@var{start} and @var{end} are indices in @code{rl_line_buffer} saying -what the boundaries of @var{text} are. If this function exists and -returns @code{NULL}, or if this variable is set to @code{NULL}, then -@code{rl_complete ()} will call the value of +@var{start} and @var{end} are indices in @code{rl_line_buffer} defining +the boundaries of @var{text}, which is a character string. +If this function exists and returns @code{NULL}, or if this variable is +set to @code{NULL}, then @code{rl_complete()} will call the value of @code{rl_completion_entry_function} to generate matches, otherwise the array of strings returned will be used. +If this function sets the @code{rl_attempted_completion_over} +variable to a non-zero value, Readline will not perform its default +completion even if this function returns no matches. @end deftypevar -@deftypevar {CPFunction *} rl_filename_quoting_function -A pointer to a function that will quote a filename in an application- -specific fashion. This is called if filename completion is being +@deftypevar {rl_quote_func_t *} rl_filename_quoting_function +A pointer to a function that will quote a filename in an +application-specific fashion. This is called if filename completion is being attempted and one of the characters in @code{rl_filename_quote_characters} appears in a completed filename. The function is called with @var{text}, @var{match_type}, and @var{quote_pointer}. The @var{text} @@ -1178,7 +1481,7 @@ to any opening quote character the user typed. Some functions choose to reset this character. @end deftypevar -@deftypevar {CPFunction *} rl_filename_dequoting_function +@deftypevar {rl_dequote_func_t *} rl_filename_dequoting_function A pointer to a function that will remove application-specific quoting characters from a filename before completion is attempted, so those characters do not interfere with matching the text against names in @@ -1188,10 +1491,10 @@ that delimits the filename (usually @samp{'} or @samp{"}). If @var{quote_char} is zero, the filename was not in an embedded string. @end deftypevar -@deftypevar {Function *} rl_char_is_quoted_p +@deftypevar {rl_linebuf_func_t *} rl_char_is_quoted_p A pointer to a function to call that determines whether or not a specific character in the line buffer is quoted, according to whatever quoting -mechanism the program calling readline uses. The function is called with +mechanism the program calling Readline uses. The function is called with two arguments: @var{text}, the text of the line, and @var{index}, the index of the character in the line. It is used to decide whether a character found in @code{rl_completer_word_break_characters} should be @@ -1204,36 +1507,36 @@ possible-completions call. After that, we ask the user if she is sure she wants to see them all. The default value is 100. @end deftypevar -@deftypevar {char *} rl_basic_word_break_characters +@deftypevar {const char *} rl_basic_word_break_characters The basic list of characters that signal a break between words for the completer routine. The default value of this variable is the characters -which break words for completion in Bash, i.e., +which break words for completion in Bash: @code{" \t\n\"\\'`@@$><=;|&@{("}. @end deftypevar -@deftypevar {char *} rl_basic_quote_characters -List of quote characters which can cause a word break. +@deftypevar {const char *} rl_basic_quote_characters +A list of quote characters which can cause a word break. @end deftypevar -@deftypevar {char *} rl_completer_word_break_characters +@deftypevar {const char *} rl_completer_word_break_characters The list of characters that signal a break between words for -@code{rl_complete_internal ()}. The default list is the value of +@code{rl_complete_internal()}. The default list is the value of @code{rl_basic_word_break_characters}. @end deftypevar -@deftypevar {char *} rl_completer_quote_characters -List of characters which can be used to quote a substring of the line. +@deftypevar {const char *} rl_completer_quote_characters +A list of characters which can be used to quote a substring of the line. Completion occurs on the entire substring, and within the substring @code{rl_completer_word_break_characters} are treated as any other character, unless they also appear within this list. @end deftypevar -@deftypevar {char *} rl_filename_quote_characters +@deftypevar {const char *} rl_filename_quote_characters A list of characters that cause a filename to be quoted by the completer when they appear in a completed filename. The default is the null string. @end deftypevar -@deftypevar {char *} rl_special_prefixes +@deftypevar {const char *} rl_special_prefixes The list of characters that are word break characters, but should be left in @var{text} when it is passed to the completion function. Programs can use this to help determine what kind of completing to do. @@ -1252,7 +1555,8 @@ an application-specific command line syntax specification. @end deftypevar @deftypevar int rl_ignore_completion_duplicates -If non-zero, then disallow duplicates in the matches. Default is 1. +If non-zero, then duplicates in the matches are removed. +The default is 1. @end deftypevar @deftypevar int rl_filename_completion_desired @@ -1260,8 +1564,9 @@ Non-zero means that the results of the matches are to be treated as filenames. This is @emph{always} zero on entry, and can only be changed within a completion entry generator function. If it is set to a non-zero value, directory names have a slash appended and Readline attempts to -quote completed filenames if they contain any embedded word break -characters. +quote completed filenames if they contain any characters in +@code{rl_filename_quote_characters} and @code{rl_filename_quoting_desired} +is set to a non-zero value. @end deftypevar @deftypevar int rl_filename_quoting_desired @@ -1274,12 +1579,26 @@ function. The quoting is effected via a call to the function pointed to by @code{rl_filename_quoting_function}. @end deftypevar +@deftypevar int rl_attempted_completion_over +If an application-specific completion function assigned to +@code{rl_attempted_completion_function} sets this variable to a non-zero +value, Readline will not perform its default filename completion even +if the application's completion function returns no matches. +It should be set only by an application's completion function. +@end deftypevar + +@deftypevar int rl_completion_type +Set to a character describing the type of completion Readline is currently +attempting; see the description of @code{rl_complete_internal()} +(@pxref{Completion Functions}) for the list of characters. +@end deftypevar + @deftypevar int rl_inhibit_completion -If this variable is non-zero, completion is inhibit #include -extern char *getwd (); extern char *xmalloc (); /* The names of functions that actually do the manipulation. */ -int com_list (), com_view (), com_rename (), com_stat (), com_pwd (); -int com_delete (), com_help (), com_cd (), com_quit (); +int com_list __P((char *)); +int com_view __P((char *)); +int com_rename __P((char *)); +int com_stat __P((char *)); +int com_pwd __P((char *)); +int com_delete __P((char *)); +int com_help __P((char *)); +int com_cd __P((char *)); +int com_quit __P((char *)); /* A structure which contains information on the commands this program can understand. */ typedef struct @{ char *name; /* User printable name of the function. */ - Function *func; /* Function to call to do the job. */ + rl_icpfunc_t *func; /* Function to call to do the job. */ char *doc; /* Documentation for this function. */ @} COMMAND; @@ -1362,7 +1693,7 @@ COMMAND commands[] = @{ @{ "rename", com_rename, "Rename FILE to NEWNAME" @}, @{ "stat", com_stat, "Print out statistics on FILE" @}, @{ "view", com_view, "View the contents of FILE" @}, - @{ (char *)NULL, (Function *)NULL, (char *)NULL @} + @{ (char *)NULL, (rl_icpfunc_t *)NULL, (char *)NULL @} @}; /* Forward declarations. */ @@ -1372,7 +1703,7 @@ COMMAND *find_command (); /* The name of this program, as taken from argv[0]. */ char *progname; -/* When non-zero, this global means the user is done using this program. */ +/* When non-zero, this means the user is done using this program. */ int done; char * @@ -1502,29 +1833,29 @@ stripwhite (string) /* */ /* **************************************************************** */ -char *command_generator (); -char **fileman_completion (); +char *command_generator __P((const char *, int)); +char **fileman_completion __P((const char *, int, int)); -/* Tell the GNU Readline library how to complete. We want to try to complete - on command names if this is the first word in the line, or on filenames - if not. */ +/* Tell the GNU Readline library how to complete. We want to try to + complete on command names if this is the first word in the line, or + on filenames if not. */ initialize_readline () @{ /* Allow conditional parsing of the ~/.inputrc file. */ rl_readline_name = "FileMan"; /* Tell the completer that we want a crack first. */ - rl_attempted_completion_function = (CPPFunction *)fileman_completion; + rl_attempted_completion_function = fileman_completion; @} -/* Attempt to complete on the contents of TEXT. START and END bound the - region of rl_line_buffer that contains the word to complete. TEXT is - the word to complete. We can use the entire contents of rl_line_buffer - in case we want to do some simple parsing. Return the array of matches, - or NULL if there aren't any. */ +/* Attempt to complete on the contents of TEXT. START and END + bound the region of rl_line_buffer that contains the word to + complete. TEXT is the word to complete. We can use the entire + contents of rl_line_buffer in case we want to do some simple + parsing. Returnthe array of matches, or NULL if there aren't any. */ char ** fileman_completion (text, start, end) - char *text; + const char *text; int start, end; @{ char **matches; @@ -1535,32 +1866,33 @@ fileman_completion (text, start, end) to complete. Otherwise it is the name of a file in the current directory. */ if (start == 0) - matches = completion_matches (text, command_generator); + matches = rl_completion_matches (text, command_generator); return (matches); @} -/* Generator function for command completion. STATE lets us know whether - to start from scratch; without any state (i.e. STATE == 0), then we - start at the top of the list. */ +/* Generator function for command completion. STATE lets us + know whether to start from scratch; without any state + (i.e. STATE == 0), then we start at the top of the list. */ char * command_generator (text, state) - char *text; + const char *text; int state; @{ static int list_index, len; char *name; - /* If this is a new word to complete, initialize now. This includes - saving the length of TEXT for efficiency, and initializing the index - variable to 0. */ + /* If this is a new word to complete, initialize now. This + includes saving the length of TEXT for efficiency, and + initializing the index variable to 0. */ if (!state) @{ list_index = 0; len = strlen (text); @} - /* Return the next name which partially matches from the command list. */ + /* Return the next name which partially matches from the + command list. */ while (name = commands[list_index].name) @{ list_index++; @@ -1705,7 +2037,7 @@ com_pwd (ignore) @{ char dir[1024], *s; - s = getwd (dir); + s = getcwd (dir, sizeof(dir) - 1); if (s == 0) @{ printf ("Error getting pwd: %s\n", dir); @@ -1716,7 +2048,8 @@ com_pwd (ignore) return 0; @} -/* The user wishes to quit using this program. Just set DONE non-zero. */ +/* The user wishes to quit using this program. Just set DONE + non-zero. */ com_quit (arg) char *arg; @{ diff --git a/lib/readline/doc/rluser.texinfo b/lib/readline/doc/rluser.texinfo index 9f088ff3..e5bf54d1 100644 --- a/lib/readline/doc/rluser.texinfo +++ b/lib/readline/doc/rluser.texinfo @@ -10,7 +10,7 @@ use these features. There is a document entitled "readline.texinfo" which contains both end-user and programmer documentation for the GNU Readline Library. -Copyright (C) 1988-1999 Free Software Foundation, Inc. +Copyright (C) 1988-2000 Free Software Foundation, Inc. Authored by Brian Fox and Chet Ramey. @@ -72,11 +72,11 @@ used by several different programs, including Bash. The following paragraphs describe the notation used to represent keystrokes. -The text @key{C-k} is read as `Control-K' and describes the character +The text @kbd{C-k} is read as `Control-K' and describes the character produced when the @key{k} key is pressed while the Control key is depressed. -The text @key{M-k} is read as `Meta-K' and describes the character +The text @kbd{M-k} is read as `Meta-K' and describes the character produced when the Meta key (if you have one) is depressed, and the @key{k} key is pressed. The Meta key is labeled @key{ALT} on many keyboards. @@ -89,11 +89,11 @@ Compose key for typing accented characters. If you do not have a Meta or @key{ALT} key, or another key working as a Meta key, the identical keystroke can be generated by typing @key{ESC} -@i{first}, and then typing @key{k}. +@emph{first}, and then typing @key{k}. Either process is known as @dfn{metafying} the @key{k} key. -The text @key{M-C-k} is read as `Meta-Control-k' and describes the -character produced by @dfn{metafying} @key{C-k}. +The text @kbd{M-C-k} is read as `Meta-Control-k' and describes the +character produced by @dfn{metafying} @kbd{C-k}. In addition, several keys have their own names. Specifically, @key{DEL}, @key{ESC}, @key{LFD}, @key{SPC}, @key{RET}, and @key{TAB} all @@ -115,8 +115,8 @@ as you type it in, allowing you to just fix your typo, and not forcing you to retype the majority of the line. Using these editing commands, you move the cursor to the place that needs correction, and delete or insert the text of the corrections. Then, when you are satisfied with -the line, you simply press @key{RETURN}. You do not have to be at the -end of the line to press @key{RETURN}; the entire line is accepted +the line, you simply press @key{RET}. You do not have to be at the +end of the line to press @key{RET}; the entire line is accepted regardless of the location of the cursor within the line. @menu @@ -140,9 +140,9 @@ erase character to back up and delete the mistyped character. Sometimes you may mistype a character, and not notice the error until you have typed several other characters. In -that case, you can type @key{C-b} to move the cursor to the left, and then +that case, you can type @kbd{C-b} to move the cursor to the left, and then correct your mistake. Afterwards, you can move the cursor to the right -with @key{C-f}. +with @kbd{C-f}. When you add text in the middle of a line, you will notice that characters to the right of the cursor are `pushed over' to make room for the text @@ -152,17 +152,17 @@ blank space created by the removal of the text. A list of the bare essentials for editing the text of an input line follows. @table @asis -@item @key{C-b} +@item @kbd{C-b} Move back one character. -@item @key{C-f} +@item @kbd{C-f} Move forward one character. @item @key{DEL} or @key{Backspace} Delete the character to the left of the cursor. -@item @key{C-d} +@item @kbd{C-d} Delete the character underneath the cursor. @item @w{Printing characters} Insert the character into the line at the cursor. -@item @key{C-_} or @key{C-x C-u} +@item @kbd{C-_} or @kbd{C-x C-u} Undo the last editing command. You can undo all the way back to an empty line. @end table @@ -170,7 +170,7 @@ empty line. @noindent (Depending on your configuration, the @key{Backspace} key be set to delete the character to the left of the cursor and the @key{DEL} key set -to delete the character underneath the cursor, like @key{C-d}, rather +to delete the character underneath the cursor, like @kbd{C-d}, rather than the character to the left of the cursor.) @node Readline Movement Commands @@ -179,11 +179,11 @@ than the character to the left of the cursor.) The above table describes the most basic keystrokes that you need in order to do editing of the input line. For your convenience, many -other commands have been added in addition to @key{C-b}, @key{C-f}, -@key{C-d}, and @key{DEL}. Here are some commands for moving more rapidly +other commands have been added in addition to @kbd{C-b}, @kbd{C-f}, +@kbd{C-d}, and @key{DEL}. Here are some commands for moving more rapidly about the line. -@table @key +@table @kbd @item C-a Move to the start of the line. @item C-e @@ -196,7 +196,7 @@ Move backward a word. Clear the screen, reprinting the current line at the top. @end table -Notice how @key{C-f} moves forward a character, while @key{M-f} moves +Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves forward a word. It is a loose convention that control keystrokes operate on characters while meta keystrokes operate on words. @@ -225,36 +225,36 @@ another line. Here is the list of commands for killing text. -@table @key +@table @kbd @item C-k Kill the text from the current cursor position to the end of the line. @item M-d Kill from the cursor to the end of the current word, or, if between words, to the end of the next word. -Word boundaries are the same as those used by @key{M-f}. +Word boundaries are the same as those used by @kbd{M-f}. -@item M-DEL +@item M-@key{DEL} Kill from the cursor the start of the previous word, or, if between words, to the start of the previous word. -Word boundaries are the same as those used by @key{M-b}. +Word boundaries are the same as those used by @kbd{M-b}. @item C-w Kill from the cursor to the previous whitespace. This is different than -@key{M-DEL} because the word boundaries differ. +@kbd{M-@key{DEL}} because the word boundaries differ. @end table Here is how to @dfn{yank} the text back into the line. Yanking means to copy the most-recently-killed text from the kill buffer. -@table @key +@table @kbd @item C-y Yank the most recently killed text back into the buffer at the cursor. @item M-y Rotate the kill-ring, and yank the new top. You can only do this if -the prior command is @key{C-y} or @key{M-y}. +the prior command is @kbd{C-y} or @kbd{M-y}. @end table @node Readline Arguments @@ -272,7 +272,8 @@ digits before the command. If the first `digit' typed is a minus sign (@samp{-}), then the sign of the argument will be negative. Once you have typed one meta digit to get the argument started, you can type the remainder of the digits, and then the command. For example, to give -the @key{C-d} command an argument of 10, you could type @samp{M-1 0 C-d}. +the @kbd{C-d} command an argument of 10, you could type @samp{M-1 0 C-d}, +which will delete the next ten characters on the input line. @node Searching @subsection Searching for Commands in the History @@ -282,7 +283,7 @@ Readline provides commands for searching through the command history (@pxref{Bash History Facilities}) @end ifset for lines containing a specified string. -There are two search modes: @var{incremental} and @var{non-incremental}. +There are two search modes: @dfn{incremental} and @dfn{non-incremental}. Incremental searches begin before the user has finished typing the search string. @@ -291,23 +292,25 @@ the next entry from the history matching the string typed so far. An incremental search requires only as many characters as needed to find the desired history entry. To search backward in the history for a particular string, type -@key{C-r}. Typing @key{C-s} searches forward through the history. +@kbd{C-r}. Typing @kbd{C-s} searches forward through the history. The characters present in the value of the @code{isearch-terminators} variable are used to terminate an incremental search. If that variable has not been assigned a value, the @key{ESC} and -@key{C-J} characters will terminate an incremental search. -@key{C-g} will abort an incremental search and restore the original line. +@kbd{C-J} characters will terminate an incremental search. +@kbd{C-g} will abort an incremental search and restore the original line. When the search is terminated, the history entry containing the search string becomes the current line. -To find other matching entries in the history list, type @key{C-r} or -@key{C-s} as appropriate. +To find other matching entries in the history list, type @kbd{C-r} or +@kbd{C-s} as appropriate. This will search backward or forward in the history for the next entry matching the search string typed so far. Any other key sequence bound to a Readline command will terminate the search and execute that command. For instance, a @key{RET} will terminate the search and accept the line, thereby executing the command from the history list. +A movement command will terminate the search, make the last line found +the current line, and begin editing. Non-incremental searches read the entire search string before starting to search for matching history lines. The search string may be @@ -324,10 +327,10 @@ Any user can customize programs that use Readline by putting commands in an @dfn{inputrc} file, conventionally in his home directory. The name of this @ifset BashFeatures -file is taken from the value of the shell variable @code{INPUTRC}. If +file is taken from the value of the shell variable @env{INPUTRC}. If @end ifset @ifclear BashFeatures -file is taken from the value of the environment variable @code{INPUTRC}. If +file is taken from the value of the environment variable @env{INPUTRC}. If @end ifclear that variable is unset, the default is @file{~/.inputrc}. @@ -359,7 +362,15 @@ denote variable settings and key bindings. @item Variable Settings You can modify the run-time behavior of Readline by altering the values of variables in Readline -using the @code{set} command within the init file. Here is how to +using the @code{set} command within the init file. +The syntax is simple: + +@example +set @var{variable} @var{value} +@end example + +@noindent +Here, for example, is how to change from the default Emacs-like key binding to use @code{vi} line editing commands: @@ -367,6 +378,9 @@ change from the default Emacs-like key binding to use set editing-mode vi @end example +Variable names and values, where appropriate, are recognized without regard +to case. + @ifset BashFeatures The @w{@code{bind -V}} command lists the current Readline variable names and values. @xref{Bash Builtins}. @@ -375,6 +389,7 @@ and values. @xref{Bash Builtins}. A great deal of run-time behavior is changeable with the following variables. +@cindex variables, readline @table @code @item bell-style @@ -402,13 +417,14 @@ The number of possible completions that determines when the user is asked whether he wants to see the list of possibilities. If the number of possible completions is greater than this value, Readline will ask the user whether or not he wishes to view -them; otherwise, they are simply listed. The default limit is -@code{100}. +them; otherwise, they are simply listed. +This variable must be set to an integer value greater than or equal to 0. +The default limit is @code{100}. @item convert-meta @vindex convert-meta If set to @samp{on}, Readline will convert characters with the -eighth bit set to an ASCII key sequence by stripping the eighth +eighth bit set to an @sc{ascii} key sequence by stripping the eighth bit and prefixing an @key{ESC} character, converting them to a meta-prefixed key sequence. The default value is @samp{on}. @@ -448,7 +464,7 @@ this variable is set to @samp{off}. @vindex input-meta @vindex meta-flag If set to @samp{on}, Readline will enable eight-bit input (it -will not strip the eighth bit from the characters it reads), +will not clear the eighth bit in the characters it reads), regardless of what the terminal claims it can support. The default value is @samp{off}. The name @code{meta-flag} is a synonym for this variable. @@ -458,7 +474,7 @@ synonym for this variable. The string of characters that should terminate an incremental search without subsequently executing the character as a command (@pxref{Searching}). If this variable has not been given a value, the characters @key{ESC} and -@key{C-J} will terminate an incremental search. +@kbd{C-J} will terminate an incremental search. @item keymap @vindex keymap @@ -469,6 +485,7 @@ Acceptable @code{keymap} names are @code{emacs-meta}, @code{emacs-ctlx}, @code{vi}, +@code{vi-move}, @code{vi-command}, and @code{vi-insert}. @code{vi} is equivalent to @code{vi-command}; @code{emacs} is @@ -520,11 +537,15 @@ want to change. The following sections contain tables of the command name, the default keybinding, if any, and a short description of what the command does. -Once you know the name of the command, simply place the name of the key +Once you know the name of the command, simply place on a line +in the init file the name of the key you wish to bind the command to, a colon, and then the name of the -command on a line in the init file. The name of the key -can be expressed in different ways, depending on which is most -comfortable for you. +command. The name of the key +can be expressed in different ways, depending on what you find most +comfortable. + +In addition to command names, readline allows keys to be bound +to a string that is inserted when the key is pressed (a @var{macro}). @ifset BashFeatures The @w{@code{bind -p}} command displays Readline function names and @@ -541,11 +562,28 @@ Meta-Rubout: backward-kill-word Control-o: "> output" @end example -In the above example, @key{C-u} is bound to the function -@code{universal-argument}, and @key{C-o} is bound to run the macro +In the above example, @kbd{C-u} is bound to the function +@code{universal-argument}, +@kbd{M-DEL} is bound to the function @code{backward-kill-word}, and +@kbd{C-o} is bound to run the macro expressed on the right hand side (that is, to insert the text @samp{> output} into the line). +A number of symbolic character names are recognized while +processing this key binding syntax: +@var{DEL}, +@var{ESC}, +@var{ESCAPE}, +@var{LFD}, +@var{NEWLINE}, +@var{RET}, +@var{RETURN}, +@var{RUBOUT}, +@var{SPACE}, +@var{SPC}, +and +@var{TAB}. + @item @w{"@var{keyseq}": @var{function-name} or @var{macro}} @var{keyseq} differs from @var{keyname} above in that strings denoting an entire key sequence can be specified, by placing @@ -559,9 +597,9 @@ special character names are not recognized. "\e[11~": "Function Key 1" @end example -In the above example, @key{C-u} is bound to the function +In the above example, @kbd{C-u} is again bound to the function @code{universal-argument} (just as it was in the first example), -@samp{@key{C-x} @key{C-r}} is bound to the function @code{re-read-init-file}, +@samp{@kbd{C-x} @kbd{C-r}} is bound to the function @code{re-read-init-file}, and @samp{@key{ESC} @key{[} @key{1} @key{1} @key{~}} is bound to insert the text @samp{Function Key 1}. @@ -606,10 +644,10 @@ horizontal tab @item \v vertical tab @item \@var{nnn} -the character whose @code{ASCII} code is the octal value @var{nnn} +the character whose @sc{ascii} code is the octal value @var{nnn} (one to three digits) @item \x@var{nnn} -the character whose @code{ASCII} code is the hexadecimal value @var{nnn} +the character whose @sc{ascii} code is the hexadecimal value @var{nnn} (one to three digits) @end table @@ -619,7 +657,7 @@ Unquoted text is assumed to be a function name. In the macro body, the backslash escapes described above are expanded. Backslash will quote any other character in the macro text, including @samp{"} and @samp{'}. -For example, the following binding will make @samp{C-x \} +For example, the following binding will make @samp{@kbd{C-x} \} insert a single @samp{\} into the line: @example "\C-x\\": "\\" @@ -663,7 +701,8 @@ for instance. @item application The @var{application} construct is used to include application-specific settings. Each program using the Readline -library sets the @var{application name}, and you can test for it. +library sets the @var{application name}, and you can test for +a particular value. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word in Bash: @@ -686,6 +725,7 @@ the test fails. @item $include This directive takes a single filename as an argument and reads commands and bindings from that file. +For example, the following directive reads from @file{/etc/inputrc}: @example $include /etc/inputrc @end example @@ -694,7 +734,7 @@ $include /etc/inputrc @node Sample Init File @subsection Sample Init File -Here is an example of an inputrc file. This illustrates key +Here is an example of an @var{inputrc} file. This illustrates key binding, variable assignment, and conditional syntax. @example @@ -819,12 +859,12 @@ You can list your key bindings by executing @w{@code{bind -P}} or, for a more terse format, suitable for an @var{inputrc} file, @w{@code{bind -p}}. (@xref{Bash Builtins}.) @end ifset - Command names without an accompanying key sequence are unbound by default. -In the following descriptions, @var{point} refers to the current cursor -position, and @var{mark} refers to a cursor position saved by the + +In the following descriptions, @dfn{point} refers to the current cursor +position, and @dfn{mark} refers to a cursor position saved by the @code{set-mark} command. -The text between the point and mark is referred to as the @var{region}. +The text between the point and mark is referred to as the @dfn{region}. @node Commands For Moving @subsection Commands For Moving @@ -862,25 +902,29 @@ Refresh the current line. By default, this is unbound. @subsection Commands For Manipulating The History @ftable @code -@item accept-line (Newline, Return) +@item accept-line (Newline or Return) @ifset BashFeatures -Accept the line regardless of where the cursor is. If this line is +Accept the line regardless of where the cursor is. +If this line is non-empty, add it to the history list according to the setting of -the @code{HISTCONTROL} and @code{HISTIGNORE} variables. -If this line was a history line, then restore the history line to its -original state. +the @env{HISTCONTROL} and @env{HISTIGNORE} variables. +If this line is a modified history line, then restore the history line +to its original state. @end ifset @ifclear BashFeatures -Accept the line regardless of where the cursor is. If this line is -non-empty, add it to the history list. If this line was a history -line, then restore the history line to its original state. +Accept the line regardless of where the cursor is. +If this line is +non-empty, it may be added to the history list for future recall with +@code{add_history()}. +If this line is a modified history line, the history line is restored +to its original state. @end ifclear @item previous-history (C-p) -Move `up' through the history list. +Move `back' through the history list, fetching the previous command. @item next-history (C-n) -Move `down' through the history list. +Move `forward' through the history list, fetching the next command. @item beginning-of-history (M-<) Move to the first line in the history. @@ -920,12 +964,13 @@ is a non-incremental search. By default, this command is unbound. @item yank-nth-arg (M-C-y) Insert the first argument to the previous command (usually -the second word on the previous line). With an argument @var{n}, +the second word on the previous line) at point. +With an argument @var{n}, insert the @var{n}th word from the previous command (the words in the previous command begin with word 0). A negative argument inserts the @var{n}th word from the end of the previous command. -@item yank-last-arg (M-., M-_) +@item yank-last-arg (M-. or M-_) Insert last argument to the previous command (the last word of the previous history entry). With an argument, behave exactly like @code{yank-nth-arg}. @@ -939,10 +984,10 @@ list, inserting the last argument of each line in turn. @ftable @code @item delete-char (C-d) -Delete the character under the cursor. If the cursor is at the +Delete the character at point. If point is at the beginning of the line, there are no characters in the line, and the last character typed was not bound to @code{delete-char}, then -return @code{EOF}. +return @sc{eof}. @item backward-delete-char (Rubout) Delete the character behind the cursor. A numeric argument means @@ -953,16 +998,16 @@ Delete the character under the cursor, unless the cursor is at the end of the line, in which case the character behind the cursor is deleted. By default, this is not bound to a key. -@item quoted-insert (C-q, C-v) +@item quoted-insert (C-q or C-v) Add the next character typed to the line verbatim. This is -how to insert key sequences like @key{C-q}, for example. +how to insert key sequences like @kbd{C-q}, for example. @ifclear BashFeatures -@item tab-insert (M-TAB) +@item tab-insert (M-@key{TAB}) Insert a tab character. @end ifclear -@item self-insert (a, b, A, 1, !, ...) +@item self-insert (a, b, A, 1, !, @dots{}) Insert yourself. @item transpose-chars (C-t) @@ -1006,7 +1051,7 @@ Kill backward to the beginning of the line. Kill backward from the cursor to the beginning of the current line. @item kill-whole-line () -Kill all characters on the current line, no matter point is. +Kill all characters on the current line, no matter where point is. By default, this is unbound. @item kill-word (M-d) @@ -1014,7 +1059,7 @@ Kill from point to the end of the current word, or if between words, to the end of the next word. Word boundaries are the same as @code{forward-word}. -@item backward-kill-word (M-DEL) +@item backward-kill-word (M-@key{DEL}) Kill the word behind point. Word boundaries are the same as @code{backward-word}. @@ -1044,21 +1089,20 @@ The word boundaries are the same as @code{forward-word}. By default, this command is unbound. @item yank (C-y) -Yank the top of the kill ring into the buffer at the current -cursor position. +Yank the top of the kill ring into the buffer at point. @item yank-pop (M-y) Rotate the kill-ring, and yank the new top. You can only do this if -the prior command is yank or yank-pop. +the prior command is @code{yank} or @code{yank-pop}. @end ftable @node Numeric Arguments @subsection Specifying Numeric Arguments @ftable @code -@item digit-argument (M-0, M-1, ... M--) +@item digit-argument (@kbd{M-0}, @kbd{M-1}, @dots{} @kbd{M--}) Add this digit to the argument already accumulating, or start a new -argument. @key{M--} starts a negative argument. +argument. @kbd{M--} starts a negative argument. @item universal-argument () This is another way to specify an argument. @@ -1079,13 +1123,9 @@ By default, this is not bound to a key. @subsection Letting Readline Type For You @ftable @code -@item complete (TAB) -Attempt to do completion on the text before the cursor. This is -application-specific. Generally, if you are typing a filename -argument, you can do filename completion; if you are typing a command, -you can do command completion; if you are typing in a symbol to GDB, you -can do symbol name completion; if you are typing in a variable to Bash, -you can do variable name completion, and so on. +@item complete (@key{TAB}) +Attempt to perform completion on the text before point. +The actual completion performed is application-specific. @ifset BashFeatures Bash attempts completion treating the text as a variable (if the text begins with @samp{$}), username (if the text begins with @@ -1093,9 +1133,12 @@ text begins with @samp{$}), username (if the text begins with command (including aliases and functions) in turn. If none of these produces a match, filename completion is attempted. @end ifset +@ifclear BashFeatures +The default is filename completion. +@end ifclear @item possible-completions (M-?) -List the possible completions of the text before the cursor. +List the possible completions of the text before point. @item insert-completions (M-*) Insert all completions of the text before point that would have @@ -1106,12 +1149,13 @@ Similar to @code{complete}, but replaces the word to be completed with a single match from the list of possible completions. Repeated execution of @code{menu-complete} steps through the list of possible completions, inserting each match in turn. -At the end of the list of completions, the bell is rung and the -original text is restored. +At the end of the list of completions, the bell is rung +(subject to the setting of @code{bell-style}) +and the original text is restored. An argument of @var{n} moves @var{n} positions forward in the list of matches; a negative argument may be used to move backward through the list. -This command is intended to be bound to @code{TAB}, but is unbound +This command is intended to be bound to @key{TAB}, but is unbound by default. @item delete-char-or-list () @@ -1164,7 +1208,7 @@ in that order. List the possible completions of the text before point, treating it as a command name. -@item dynamic-complete-history (M-TAB) +@item dynamic-complete-history (M-@key{TAB}) Attempt completion on the text before point, comparing the text against lines from the history list for possible completion matches. @@ -1211,12 +1255,12 @@ ring the terminal's bell (subject to the setting of If the metafied character @var{x} is lowercase, run the command that is bound to the corresponding uppercase character. -@item prefix-meta (ESC) -Make the next character typed be metafied. This is for keyboards -without a meta key. Typing @samp{ESC f} is equivalent to typing -@samp{M-f}. +@item prefix-meta (@key{ESC}) +Metafy the next character typed. This is for keyboards +without a meta key. Typing @samp{@key{ESC} f} is equivalent to typing +@kbd{M-f}. -@item undo (C-_, C-x C-u) +@item undo (C-_ or C-x C-u) Incremental undo, separately remembered for each line. @item revert-line (M-r) @@ -1232,7 +1276,7 @@ command enough times to get back to the beginning. Perform tilde expansion on the current word. @item set-mark (C-@@) -Set the mark to the current point. If a +Set the mark to the point. If a numeric argument is supplied, the mark is set to that position. @item exchange-point-and-mark (C-x C-x) @@ -1271,7 +1315,7 @@ of an @var{inputrc} file. This command is unbound by default. @item dump-macros () Print all of the Readline key sequences bound to macros and the -strings they ouput. If a numeric argument is supplied, +strings they output. If a numeric argument is supplied, the output is formatted in such a way that it can be made part of an @var{inputrc} file. This command is unbound by default. @@ -1305,7 +1349,7 @@ Perform alias expansion on the current line (@pxref{Aliases}). @item history-and-alias-expand-line () Perform history and alias expansion on the current line. -@item insert-last-argument (M-., M-_) +@item insert-last-argument (M-. or M-_) A synonym for @code{yank-last-arg}. @item operate-and-get-next (C-o) @@ -1328,7 +1372,7 @@ been executed. While the Readline library does not have a full set of @code{vi} editing functions, it does contain enough to allow simple editing of the line. The Readline @code{vi} mode behaves as specified in -the @sc{POSIX} 1003.2 standard. +the @sc{posix} 1003.2 standard. @ifset BashFeatures In order to switch interactively between @code{emacs} and @code{vi} @@ -1337,7 +1381,8 @@ commands (@pxref{The Set Builtin}). @end ifset @ifclear BashFeatures In order to switch interactively between @code{emacs} and @code{vi} -editing modes, use the command M-C-j (toggle-editing-mode). +editing modes, use the command @kbd{M-C-j} (bound to emacs-editing-mode +when in @code{vi} mode and to vi-editing-mode in @code{emacs} mode). @end ifclear The Readline default is @code{emacs} mode. @@ -1374,20 +1419,20 @@ described above (@pxref{Commands For Completion}) is performed. First, the actions specified by the compspec are used. Only matches which are prefixed by the word being completed are returned. -When the @samp{-f} or @samp{-d} option is used for filename or -directory name completion, the shell variable @code{FIGNORE} is +When the @option{-f} or @option{-d} option is used for filename or +directory name completion, the shell variable @env{FIGNORE} is used to filter the matches. -@xref{Bash Variables}, for a description of @code{FIGNORE}. +@xref{Bash Variables}, for a description of @env{FIGNORE}. Any completions specified by a filename expansion pattern to the -@samp{-G} option are generated next. +@option{-G} option are generated next. The words generated by the pattern need not match the word being completed. -The @code{GLOBIGNORE} shell variable is not used to filter the matches, -but the @code{FIGNORE} shell variable is used. +The @env{GLOBIGNORE} shell variable is not used to filter the matches, +but the @env{FIGNORE} shell variable is used. -Next, the string specified as the argument to the @samp{-W} option +Next, the string specified as the argument to the @option{-W} option is considered. -The string is first split using the characters in the @code{IFS} +The string is first split using the characters in the @env{IFS} special variable as delimiters. Shell quoting is honored. Each word is then expanded using @@ -1400,12 +1445,12 @@ The results of the expansion are prefix-matched against the word being completed, and the matching words become the possible completions. After these matches have been generated, any shell function or command -specified with the @samp{-F} and @samp{-C} options is invoked. -When the command or function is invoked, the @code{COMP_LINE} and -@code{COMP_POINT} variables are assigned values as described above +specified with the @option{-F} and @option{-C} options is invoked. +When the command or function is invoked, the @env{COMP_LINE} and +@env{COMP_POINT} variables are assigned values as described above (@pxref{Bash Variables}). -If a shell function is being invoked, the @code{COMP_WORDS} and -@code{COMP_CWORD} variables are also set. +If a shell function is being invoked, the @env{COMP_WORDS} and +@env{COMP_CWORD} variables are also set. When the function or command is invoked, the first argument is the name of the command whose arguments are being completed, the second argument is the word being completed, and the third argument @@ -1414,21 +1459,21 @@ No filtering of the generated completions against the word being completed is performed; the function or command has complete freedom in generating the matches. -Any function specified with @samp{-F} is invoked first. +Any function specified with @option{-F} is invoked first. The function may use any of the shell facilities, including the @code{compgen} builtin described below (@pxref{Programmable Completion Builtins}), to generate the matches. -It must put the possible completions in the @code{COMPREPLY} array +It must put the possible completions in the @env{COMPREPLY} array variable. -Next, any command specified with the @samp{-C} option is invoked +Next, any command specified with the @option{-C} option is invoked in an environment equivalent to command substitution. It should print a list of completions, one per line, to the standard output. Backslash may be used to escape a newline, if necessary. After all of the possible completions are generated, any filter -specified with the @samp{-X} option is applied to the list. +specified with the @option{-X} option is applied to the list. The filter is a pattern as used for pathname expansion; a @samp{&} in the pattern is replaced with the text of the word being completed. A literal @samp{&} may be escaped with a backslash; the backslash @@ -1437,15 +1482,22 @@ Any completion that matches the pattern will be removed from the list. A leading @samp{!} negates the pattern; in this case any completion not matching the pattern will be removed. -Finally, any prefix and suffix specified with the @samp{-P} and @samp{-S} +Finally, any prefix and suffix specified with the @option{-P} and @option{-S} options are added to each member of the completion list, and the result is returned to the Readline completion code as the list of possible completions. -If a compspec is found, whatever it generates is returned to the completion -code as the full set of possible completions. -The default Bash completions are not attempted, and the Readline -default of filename completion is disabled. +If the previously-applied actions do not generate any matches, and the +@option{-o dirnames} option was supplied to @code{complete} when the +compspec was defined, directory name completion is attempted. + +By default, if a compspec is found, whatever it generates is returned to +the completion code as the full set of possible completions. +The default Bash completions are not attempted, and the Readline default +of filename completion is disabled. +If the @option{-o default} option was supplied to @code{complete} when the +compspec was defined, Readline's default completion will be performed +if the compspec generates no matches. @node Programmable Completion Builtins @section Programmable Completion Builtins @@ -1464,9 +1516,9 @@ facilities. Generate possible completion matches for @var{word} according to the @var{option}s, which may be any option accepted by the @code{complete} -builtin with the exception of @samp{-p} and @samp{-r}, and write +builtin with the exception of @option{-p} and @option{-r}, and write the matches to the standard output. -When using the @samp{-F} or @samp{-C} options, the various shell variables +When using the @option{-F} or @option{-C} options, the various shell variables set by the programmable completion facilities, while available, will not have useful values. @@ -1482,17 +1534,17 @@ matches were generated. @item complete @btindex complete @example -@code{complete [-abcdefjkvu] [-A @var{action}] [-G @var{globpat}] [-W @var{wordlist}] +@code{complete [-abcdefjkvu] [-o @var{comp-option}] [-A @var{action}] [-G @var{globpat}] [-W @var{wordlist}] [-P @var{prefix}] [-S @var{suffix}] [-X @var{filterpat}] [-F @var{function}] [-C @var{command}] @var{name} [@var{name} @dots{}]} @code{complete -pr [@var{name} @dots{}]} @end example Specify how arguments to each @var{name} should be completed. -If the @samp{-p} option is supplied, or if no options are supplied, existing +If the @option{-p} option is supplied, or if no options are supplied, existing completion specifications are printed in a way that allows them to be reused as input. -The @samp{-r} option removes a completion specification for +The @option{-r} option removes a completion specification for each @var{name}, or, if no @var{name}s are supplied, all completion specifications. @@ -1500,19 +1552,40 @@ The process of applying these completion specifications when word completion is attempted is described above (@pxref{Programmable Completion}). Other options, if specified, have the following meanings. -The arguments to the @samp{-G}, @samp{-W}, and @samp{-X} options -(and, if necessary, the @samp{-P} and @samp{-S} options) +The arguments to the @option{-G}, @option{-W}, and @option{-X} options +(and, if necessary, the @option{-P} and @option{-S} options) should be quoted to protect them from expansion before the @code{complete} builtin is invoked. + +@table @code +@item -o @var{comp-option} +The @var{comp-option} controls several aspects of the compspec's behavior +beyond the simple generation of completions. +@var{comp-option} may be one of: + @table @code + +@item default +Use readline's default completion if the compspec generates no matches. + +@item dirnames +Perform directory name completion if the compspec generates no matches. + +@item filenames +Tell Readline that the compspec generates filenames, so it can perform any +filename\-specific processing (like adding a slash to directory names or +suppressing trailing spaces). This option is intended to be used with +shell functions specified with @option{-F}. +@end table + @item -A @var{action} The @var{action} may be one of the following to generate a list of possible completions: @table @code @item alias -Alias names. May also be specified as @samp{-a}. +Alias names. May also be specified as @option{-a}. @item arrayvar Array variable names. @@ -1521,13 +1594,13 @@ Array variable names. Readline key binding names (@pxref{Bindable Readline Commands}). @item builtin -Names of shell builtin commands. May also be specified as @samp{-b}. +Names of shell builtin commands. May also be specified as @option{-b}. @item command -Command names. May also be specified as @samp{-c}. +Command names. May also be specified as @option{-c}. @item directory -Directory names. May also be specified as @samp{-d}. +Directory names. May also be specified as @option{-d}. @item disabled Names of disabled shell builtins. @@ -1536,10 +1609,10 @@ Names of disabled shell builtins. Names of enabled shell builtins. @item export -Names of exported shell variables. May also be specified as @samp{-e}. +Names of exported shell variables. May also be specified as @option{-e}. @item file -File names. May also be specified as @samp{-f}. +File names. May also be specified as @option{-f}. @item function Names of shell functions. @@ -1549,19 +1622,19 @@ Help topics as accepted by the @code{help} builtin (@pxref{Bash Builtins}). @item hostname Hostnames, as taken from the file specified by the -@code{HOSTFILE} shell variable (@pxref{Bash Variables}). +@env{HOSTFILE} shell variable (@pxref{Bash Variables}). @item job -Job names, if job control is active. May also be specified as @samp{-j}. +Job names, if job control is active. May also be specified as @option{-j}. @item keyword -Shell reserved words. May also be specified as @samp{-k}. +Shell reserved words. May also be specified as @option{-k}. @item running Names of running jobs, if job control is active. @item setopt -Valid arguments for the @samp{-o} option to the @code{set} builtin +Valid arguments for the @option{-o} option to the @code{set} builtin (@pxref{The Set Builtin}). @item shopt @@ -1575,10 +1648,10 @@ Signal names. Names of stopped jobs, if job control is active. @item user -User names. May also be specified as @samp{-u}. +User names. May also be specified as @option{-u}. @item variable -Names of all shell variables. May also be specified as @samp{-v}. +Names of all shell variables. May also be specified as @option{-v}. @end table @item -G @var{globpat} @@ -1587,7 +1660,7 @@ the possible completions. @item -W @var{wordlist} The @var{wordlist} is split using the characters in the -@code{IFS} special variable as delimiters, and each resultant word +@env{IFS} special variable as delimiters, and each resultant word is expanded. The possible completions are the members of the resultant list which match the word being completed. @@ -1600,7 +1673,7 @@ used as the possible completions. The shell function @var{function} is executed in the current shell environment. When it finishes, the possible completions are retrieved from the value -of the @code{COMPREPLY} array variable. +of the @env{COMPREPLY} array variable. @item -X @var{filterpat} @var{filterpat} is a pattern as used for filename expansion. @@ -1620,7 +1693,7 @@ after all other options have been applied. @end table The return value is true unless an invalid option is supplied, an option -other than @samp{-p} or @samp{-r} is supplied without a @var{name} +other than @option{-p} or @option{-r} is supplied without a @var{name} argument, an attempt is made to remove a completion specification for a @var{name} for which no specification exists, or an error occurs adding a completion specification. diff --git a/lib/readline/doc/rluserman.texinfo b/lib/readline/doc/rluserman.texinfo index e6a3dcde..db560b9c 100644 --- a/lib/readline/doc/rluserman.texinfo +++ b/lib/readline/doc/rluserman.texinfo @@ -10,14 +10,14 @@ @ifinfo @dircategory Libraries @direntry -* Readline: (readline). The GNU readline library API +* RLuserman: (rluserman). The GNU readline library User's Manual. @end direntry This document describes the end user interface of the GNU Readline Library, a utility which aids in the consistency of user interface across discrete programs that need to provide a command line interface. -Copyright (C) 1988-1999 Free Software Foundation, Inc. +Copyright (C) 1988-2001 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -72,7 +72,7 @@ except that this permission notice may be stated in a translation approved by the Free Software Foundation. @vskip 0pt plus 1filll -Copyright @copyright{} 1988-1999 Free Software Foundation, Inc. +Copyright @copyright{} 1988-2001 Free Software Foundation, Inc. @end titlepage @ifinfo -- cgit v1.2.1