summaryrefslogtreecommitdiff
path: root/doc/readline.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/readline.html')
-rw-r--r--doc/readline.html13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/readline.html b/doc/readline.html
index f96335d..de0675a 100644
--- a/doc/readline.html
+++ b/doc/readline.html
@@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes the GNU Readline Library
-(version 8.2, 11 March 2022), a library which aids in the
+(version 8.2, 12 August 2022), a library which aids in the
consistency of user interface across discrete programs which provide
a command line interface.
@@ -682,9 +682,12 @@ The default limit is <code>100</code>.
<dd><p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline will convert characters with the
eighth bit set to an <small>ASCII</small> key sequence by stripping the eighth
bit and prefixing an <tt class="key">ESC</tt> character, converting them to a
-meta-prefixed key sequence. The default value is &lsquo;<samp>on</samp>&rsquo;, but
+meta-prefixed key sequence.
+The default value is &lsquo;<samp>on</samp>&rsquo;, but
will be set to &lsquo;<samp>off</samp>&rsquo; if the locale is one that contains
eight-bit characters.
+This variable is dependent on the <code>LC_CTYPE</code> locale category, and
+may change if the locale is changed.
</p>
</dd>
<dt id='index-disable_002dcompletion'><span><code>disable-completion</code><a href='#index-disable_002dcompletion' class='copiable-anchor'> &para;</a></span></dt>
@@ -796,6 +799,8 @@ regardless of what the terminal claims it can support. The
default value is &lsquo;<samp>off</samp>&rsquo;, but Readline will set it to &lsquo;<samp>on</samp>&rsquo; if the
locale contains eight-bit characters.
The name <code>meta-flag</code> is a synonym for this variable.
+This variable is dependent on the <code>LC_CTYPE</code> locale category, and
+may change if the locale is changed.
</p>
</dd>
<dt id='index-isearch_002dterminators'><span><code>isearch-terminators</code><a href='#index-isearch_002dterminators' class='copiable-anchor'> &para;</a></span></dt>
@@ -880,6 +885,8 @@ eighth bit set directly rather than as a meta-prefixed escape
sequence.
The default is &lsquo;<samp>off</samp>&rsquo;, but Readline will set it to &lsquo;<samp>on</samp>&rsquo; if the
locale contains eight-bit characters.
+This variable is dependent on the <code>LC_CTYPE</code> locale category, and
+may change if the locale is changed.
</p>
</dd>
<dt id='index-page_002dcompletions'><span><code>page-completions</code><a href='#index-page_002dcompletions' class='copiable-anchor'> &para;</a></span></dt>
@@ -3431,7 +3438,7 @@ Returns the old timeout value.
<dt id="index-rl_005fset_005ftimeout"><span class="category">Function: </span><span><em>int</em> <strong>rl_set_timeout</strong> <em>(unsigned int secs, unsigned int usecs)</em><a href='#index-rl_005fset_005ftimeout' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>Set a timeout for subsequent calls to <code>readline()</code>. If Readline does
not read a complete line, or the number of characters specified by
-<code>rl_num_chars_to_read</code>, before the duration specfied by <var>secs</var>
+<code>rl_num_chars_to_read</code>, before the duration specified by <var>secs</var>
(in seconds) and <var>usecs</var> (microseconds), it returns and sets
<code>RL_STATE_TIMEOUT</code> in <code>rl_readline_state</code>.
Passing 0 for <code>secs</code> and <code>usecs</code> cancels any previously set