Virgin import of GNU Readline 5.1

5 files changed, 84 insertions, 23 deletions

diff --git a/contrib/libreadline/doc/readline.3 b/contrib/libreadline/doc/readline.3
index 560bbe72bc50..90cd9971e8e9 100644
--- a/contrib/libreadline/doc/readline.3
+++ b/contrib/libreadline/doc/readline.3
@@ -6,9 +6,9 @@
 .\"	Case Western Reserve University
 .\"	chet@ins.CWRU.Edu
 .\"
-.\"	Last Change: Wed Jan 28 15:43:53 EST 2004
+.\"	Last Change: Tue Sep 13 12:07:26 EDT 2005
 .\"
-.TH READLINE 3 "2004 January 28" "GNU Readline 5.0"
+.TH READLINE 3 "2005 Sep 13" "GNU Readline 5.1-beta1"
 .\"
 .\" File Name macro.  This used to be `.PN', for Path Name,
 .\" but Sun doesn't seem to like that very much.
@@ -328,6 +328,10 @@ Except where noted, readline variables can take the values
 or
 .B Off
 (without regard to case).
+Unrecognized variable names are ignored.
+When a variable value is read, empty or null values, "on" (case-insensitive),
+and "1" are equivalent to \fBOn\fP.  All other values are equivalent to
+\fBOff\fP.
 The variables and their default values are:
 .PP
 .PD 0
@@ -338,6 +342,11 @@ If set to \fBnone\fP, readline never rings the bell.  If set to
 \fBvisible\fP, readline uses a visible bell if one is available.
 If set to \fBaudible\fP, readline attempts to ring the terminal's bell.
 .TP
+.B bind\-tty\-special\-chars (On)
+If set to \fBOn\fP, readline attempts to bind the control characters  
+treated specially by the kernel's terminal driver to their readline
+equivalents.
+.TP
 .B comment\-begin (``#'')
 The string that is inserted in \fBvi\fP mode when the
 .B insert\-comment
@@ -360,7 +369,7 @@ It may be set to any integer value greater than or equal to
 zero.  If the number of possible completions is greater than
 or equal to the value of this variable, the user is asked whether
 or not he wishes to view them; otherwise they are simply listed
-on the terminal.
+on the terminal.  A negative value causes readline to never ask.
 .TP
 .B convert\-meta (On)
 If set to \fBOn\fP, readline will convert characters with the
@@ -391,9 +400,9 @@ arrow keys.
 If set to \fBon\fP, tilde expansion is performed when readline
 attempts word completion.
 .TP
-.B history-preserve-point     
+.B history\-preserve\-point (Off)
 If set to \fBon\fP, the history code attempts to place point at the 
-same location on each history line retrived with \fBprevious-history\fP 
+same location on each history line retrieved with \fBprevious-history\fP 
 or \fBnext-history\fP.
 .TP
 .B horizontal\-scroll\-mode (Off)
@@ -691,6 +700,8 @@ With an argument
 insert the \fIn\fPth word from the previous command (the words
 in the previous command begin with word 0).  A negative argument
 inserts the \fIn\fPth word from the end of the previous command.
+Once the argument \fIn\fP is computed, the argument is extracted
+as if the "!\fIn\fP" history expansion had been specified.
 .TP
 .B
 yank\-last\-arg (M\-.\^, M\-_\^)
@@ -699,6 +710,8 @@ the previous history entry).  With an argument,
 behave exactly like \fByank\-nth\-arg\fP.
 Successive calls to \fByank\-last\-arg\fP move back through the history
 list, inserting the last argument of each line in turn.
+The history expansion facilities are used to extract the last argument,
+as if the "!$" history expansion had been specified.
 .PD
 .SS Commands for Changing Text
 .PP
diff --git a/contrib/libreadline/doc/rltech.texi b/contrib/libreadline/doc/rltech.texi
index af9bc530a7ed..6f2e2ee2d345 100644
--- a/contrib/libreadline/doc/rltech.texi
+++ b/contrib/libreadline/doc/rltech.texi
@@ -5,10 +5,10 @@
 
 @ifinfo
 This document describes the GNU Readline Library, a utility for aiding
-in the consitency of user interface across discrete programs that need
+in the consistency of user interface across discrete programs that need
 to provide a command line interface.
 
-Copyright (C) 1988-2004 Free Software Foundation, Inc.
+Copyright (C) 1988-2005 Free Software Foundation, Inc.
 
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
@@ -284,6 +284,8 @@ negative argument.
 
 A command function should return 0 if its action completes successfully,
 and a non-zero value if some error occurs.
+This is the convention obeyed by all of the builtin Readline bindable
+command functions.
 
 @node Readline Variables
 @section Readline Variables
@@ -398,6 +400,12 @@ The stdio stream to which Readline performs output.
 If @code{NULL}, Readline defaults to @var{stdout}.
 @end deftypevar
 
+@deftypevar int rl_prefer_env_winsize
+If non-zero, Readline gives values found in the @env{LINES} and
+@env{COLUMNS} environment variables greater precedence than values fetched
+from the kernel when computing the screen dimensions.
+@end deftypevar
+
 @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
@@ -909,10 +917,14 @@ 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.
+You should call @code{rl_save_prompt} to save the prompt information
+before calling this function.
 @end deftypefun
 
 @deftypefun int rl_clear_message (void)
-Clear the message in the echo area.
+Clear the message in the echo area.  If the prompt was saved with a call to
+@code{rl_save_prompt} before the last call to @code{rl_message},
+call @code{rl_restore_prompt} before calling this function.
 @end deftypefun
 
 @deftypefun void rl_save_prompt (void)
@@ -923,6 +935,9 @@ displaying a new message in the message area with @code{rl_message()}.
 @deftypefun void rl_restore_prompt (void)
 Restore the local Readline prompt display state saved by the most
 recent call to @code{rl_save_prompt}.
+if @code{rl_save_prompt} was called to save the prompt before a call
+to @code{rl_message}, this function should be called before the
+corresponding call to @code{rl_clear_message}.
 @end deftypefun
 
 @deftypefun int rl_expand_prompt (char *prompt)
@@ -1149,6 +1164,11 @@ This behaves as if the readline command
 file (@pxref{Readline Init File Syntax}).
 @end deftypefun
 
+@deftypefun {char *} rl_variable_value (const char *variable)
+Return a string representing the value of the Readline variable @var{variable}.
+For boolean variables, this string is either @samp{on} or @samp{off}.
+@end deftypefun
+
 @deftypefun void rl_variable_dumper (int readable)
 Print the readline variable names and their current values
 to @code{rl_outstream}.
@@ -1378,7 +1398,8 @@ Update Readline's internal screen size by reading values from the kernel.
 
 @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.
+@var{cols} columns.  If either @var{rows} or @var{columns} is less than
+or equal to 0, Readline's idea of that terminal dimension is unchanged.
 @end deftypefun
 
 If an application does not want to install a @code{SIGWINCH} handler, but
@@ -1390,6 +1411,10 @@ Return Readline's idea of the terminal's size in the
 variables pointed to by the arguments.
 @end deftypefun
 
+@deftypefun void rl_reset_screen_size (void)
+Cause Readline to reobtain the screen size and recalculate its dimensions.
+@end deftypefun
+
 The following functions install and remove Readline's signal handlers.
 
 @deftypefun int rl_set_signals (void)
@@ -1707,8 +1732,9 @@ shell variables and hostnames.
 
 @deftypevar int rl_completion_query_items
 Up to this many items will be displayed in response to a
-possible-completions call.  After that, we ask the user if she is sure
-she wants to see them all.  The default value is 100.
+possible-completions call.  After that, readline asks the user if she is sure
+she wants to see them all.  The default value is 100.  A negative value 
+indicates that Readline should never ask the user.
 @end deftypevar
 
 @deftypevar {int} rl_completion_append_character
@@ -2237,7 +2263,7 @@ too_dangerous (caller)
      char *caller;
 @{
   fprintf (stderr,
-           "%s: Too dangerous for me to distribute.\n"
+           "%s: Too dangerous for me to distribute.\n",
            caller);
   fprintf (stderr, "Write it yourself.\n");
 @}
diff --git a/contrib/libreadline/doc/rluser.texi b/contrib/libreadline/doc/rluser.texi
index 6fa935075fec..478b41fac3c7 100644
--- a/contrib/libreadline/doc/rluser.texi
+++ b/contrib/libreadline/doc/rluser.texi
@@ -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-2004 Free Software Foundation, Inc.
+Copyright (C) 1988-2005 Free Software Foundation, Inc.
 
 Authored by Brian Fox and Chet Ramey.
 
@@ -383,7 +383,11 @@ set editing-mode vi
 @end example
 
 Variable names and values, where appropriate, are recognized without regard
-to case. 
+to case.  Unrecognized variable names are ignored.
+
+Boolean variables (those that can be set to on or off) are set to on if
+the value is null or empty, @var{on} (case-insensitive), or 1.  Any other
+value results in the variable being set to off.
 
 @ifset BashFeatures
 The @w{@code{bind -V}} command lists the current Readline variable names
@@ -404,6 +408,12 @@ If set to @samp{none}, Readline never rings the bell.  If set to
 If set to @samp{audible} (the default), Readline attempts to ring
 the terminal's bell.
 
+@item bind-tty-special-chars
+@vindex bind-tty-special-chars
+If set to @samp{on}, Readline attempts to bind the control characters  
+treated specially by the kernel's terminal driver to their Readline
+equivalents.
+
 @item comment-begin
 @vindex comment-begin
 The string to insert at the beginning of the line when the
@@ -423,6 +433,7 @@ If the number of possible completions is greater than this value,
 Readline will ask the user whether or not he wishes to view
 them; otherwise, they are simply listed.
 This variable must be set to an integer value greater than or equal to 0.
+A negative value means Readline should never ask.
 The default limit is @code{100}.
 
 @item convert-meta
@@ -456,10 +467,11 @@ arrow keys.  The default is @samp{off}.
 If set to @samp{on}, tilde expansion is performed when Readline
 attempts word completion.  The default is @samp{off}.
 
+@item history-preserve-point
 @vindex history-preserve-point
 If set to @samp{on}, the history code attempts to place point at the
 same location on each history line retrieved with @code{previous-history}
-or @code{next-history}.
+or @code{next-history}.  The default is @samp{off}.
 
 @item horizontal-scroll-mode
 @vindex horizontal-scroll-mode
@@ -1012,6 +1024,8 @@ 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.
+Once the argument @var{n} is computed, the argument is extracted
+as if the @samp{!@var{n}} history expansion had been specified.
 
 @item yank-last-arg (M-. or M-_)
 Insert last argument to the previous command (the last word of the
@@ -1019,6 +1033,8 @@ previous history entry).  With an
 argument, behave exactly like @code{yank-nth-arg}.
 Successive calls to @code{yank-last-arg} move back through the history
 list, inserting the last argument of each line in turn.
+The history expansion facilities are used to extract the last argument,
+as if the @samp{!$} history expansion had been specified.
 
 @end ftable
 
@@ -1530,7 +1546,7 @@ special variable as delimiters.
 Shell quoting is honored.
 Each word is then expanded using
 brace expansion, tilde expansion, parameter and variable expansion,
-command substitution, arithmetic expansion, and pathname expansion,
+command substitution, and arithmetic expansion,
 as described above (@pxref{Shell Expansions}).
 The results are split using the rules described above
 (@pxref{Word Splitting}).
@@ -1693,6 +1709,12 @@ shell functions specified with @option{-F}.
 @item nospace
 Tell Readline not to append a space (the default) to words completed at
 the end of the line.
+
+@item plusdirs
+After any matches defined by the compspec are generated, 
+directory name completion is attempted and any
+matches are added to the results of the other actions.
+
 @end table
 
 @item -A @var{action}
diff --git a/contrib/libreadline/doc/rluserman.texi b/contrib/libreadline/doc/rluserman.texi
index 8681a86c48fc..db80b312611c 100644
--- a/contrib/libreadline/doc/rluserman.texi
+++ b/contrib/libreadline/doc/rluserman.texi
@@ -14,7 +14,7 @@ This manual describes the end user interface of the GNU Readline Library
 consistency of user interface across discrete programs which provide
 a command line interface.
 
-Copyright @copyright{} 1988-2004 Free Software Foundation, Inc.
+Copyright @copyright{} 1988-2005 Free Software Foundation, Inc.
 
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
diff --git a/contrib/libreadline/doc/version.texi b/contrib/libreadline/doc/version.texi
index 0beb27609f5f..99816bf6807e 100644
--- a/contrib/libreadline/doc/version.texi
+++ b/contrib/libreadline/doc/version.texi
@@ -1,10 +1,10 @@
 @ignore
-Copyright (C) 1988-2004 Free Software Foundation, Inc. 
+Copyright (C) 1988-2005 Free Software Foundation, Inc. 
 @end ignore
 
-@set EDITION 5.0
-@set VERSION 5.0
-@set UPDATED 28 January 2004
-@set UPDATED-MONTH January 2004
+@set EDITION 5.1-beta1
+@set VERSION 5.1-beta1
+@set UPDATED 11 November 2005
+@set UPDATED-MONTH November 2005
 
-@set LASTCHANGE Wed Jan 28 15:46:54 EST 2004
+@set LASTCHANGE Fri Nov 11 19:50:51 EST 2005