commit bash-20060209 snapshot

[thirdparty/bash.git] / lib / readline / doc / readline.html
diff --git a/lib/readline/doc/readline.html b/lib/readline/doc/readline.html

index fcd5f0a924285cc2ba7ea90560cf297a6dc4d42d..0221da96d01040a58ea48ced8acea3381864a0a8 100644 (file)
--- a/lib/readline/doc/readline.html
+++ b/lib/readline/doc/readline.html
@@ -1,6 +1,6 @@
  <HTML>
  <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!-- Created on November, 17  2005 by texi2html 1.64 -->
+<!-- Created on February, 9  2006 by texi2html 1.64 -->
  <!-- 
  Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
              Karl Berry  <karl@freefriends.org>
@@ -491,7 +491,9 @@ Any user can customize programs that use Readline by putting
  commands in an <EM>inputrc</EM> file, conventionally in his home directory.
  The name of this
  file is taken from the value of the environment variable <CODE>INPUTRC</CODE>.  If
-that variable is unset, the default is <TT>`~/.inputrc'</TT>.
+that variable is unset, the default is <TT>`~/.inputrc'</TT>.  If that
+file does not exist or cannot be read, the ultimate default is
+<TT>`/etc/inputrc'</TT>.
  </P><P>
  
  When a program which uses the Readline library starts up, the
@@ -3558,8 +3560,10 @@ pending input has not already been read with <CODE>rl_read_key()</CODE>.
  <DT><U>Function:</U> int <B>rl_set_keyboard_input_timeout</B> <I>(int u)</I>
  <DD>While waiting for keyboard input in <CODE>rl_read_key()</CODE>, Readline will
  wait for <VAR>u</VAR> microseconds for input before calling any function
-assigned to <CODE>rl_event_hook</CODE>.  The default waiting period is
-one-tenth of a second.  Returns the old timeout value.
+assigned to <CODE>rl_event_hook</CODE>.  <VAR>u</VAR> must be greater than or equal
+to zero (a zero-length timeout is equivalent to a poll).
+The default waiting period is one-tenth of a second.
+Returns the old timeout value.
  </DL>
  </P><P>
  
@@ -4529,6 +4533,9 @@ the directory portion of the pathname the user typed.
  It returns an integer that should be non-zero if the function modifies
  its directory argument.
  It could be used to expand symbolic links or shell variables in pathnames.
+At the least, even if no other expansion is performed, this function should
+remove any quote characters from the directory name, because its result will
+be passed directly to <CODE>opendir()</CODE>.
  </DL>
  </P><P>
  
@@ -6543,7 +6550,7 @@ to permit their use in free software.
  <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="readline.html#SEC_About"> ? </A>]</TD>
  </TR></TABLE>
  <H1>About this document</H1>
-This document was generated by <I>Chet Ramey</I> on <I>November, 17  2005</I>
+This document was generated by <I>Chet Ramey</I> on <I>February, 9  2006</I>
  using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
  "><I>texi2html</I></A>
  <P></P>  
@@ -6705,7 +6712,7 @@ the following structure:
  <BR>  
  <FONT SIZE="-1">
  This document was generated
-by <I>Chet Ramey</I> on <I>November, 17  2005</I>
+by <I>Chet Ramey</I> on <I>February, 9  2006</I>
  using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
  "><I>texi2html</I></A>