diff options
Diffstat (limited to 'doc/rltech.texi')
| -rw-r--r-- | doc/rltech.texi | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/doc/rltech.texi b/doc/rltech.texi index 8c4814e..6f7ffb9 100644 --- a/doc/rltech.texi +++ b/doc/rltech.texi @@ -7,7 +7,7 @@ This document describes the GNU Readline Library, a utility for aiding in the consistency of user interface across discrete programs that need to provide a command line interface. -Copyright (C) 1988--2020 Free Software Foundation, Inc. +Copyright (C) 1988--2022 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -323,6 +323,14 @@ and point define a @emph{region}. @deftypevar int rl_done Setting this to a non-zero value causes Readline to return the current line immediately. +Readline will set this variable when it has read a key sequence bound +to @code{accept-line} and is about to return the line to the caller. +@end deftypevar + +@deftypevar int rl_eof_found +Readline will set this variable when it has read an EOF character (e.g., the +stty @samp{EOF} character) on an empty line or encountered a read error and +is about to return a NULL line to the caller. @end deftypevar @deftypevar int rl_num_chars_to_read @@ -597,6 +605,9 @@ and is about to return the line to the caller. Readline has timed out (it did not receive a line or specified number of characters before the timeout duration specified by @code{rl_set_timeout} elapsed) and is returning that status to the caller. +@item RL_STATE_EOF +Readline has read an EOF character (e.g., the stty @samp{EOF} character) +or encountered a read error and is about to return a NULL line to the caller. @end table @end deftypevar @@ -1184,10 +1195,13 @@ Returns 0 if the timeout is set successfully. @deftypefun int rl_timeout_remaining (unsigned int *secs, unsigned int *usecs) Return the number of seconds and microseconds remaining in the current -timeout duration in @code{*secs} and @code{*usecs}, respectively. -Returns -1 on error or when there is no timeout set, 0 when the timeout has -expired (leaving @code{*secs} and @code{*usecs} unchanged), and 1 if the -timeout has not expired. If @code{secs} and @code{usecs} are @code{NULL}, +timeout duration in @var{*secs} and @var{*usecs}, respectively. +Both @var{*secs} and @var{*usecs} must be non-NULL to return any values. +The return value is -1 on error or when there is no timeout set, +0 when the timeout has expired (leaving @var{*secs} and @var{*usecs} +unchanged), +and 1 if the timeout has not expired. +If either of @var{secs} and @var{usecs} is @code{NULL}, the return value indicates whether the timeout has expired. @end deftypefun |