diff options
| author | Chet Ramey <chet.ramey@case.edu> | 2022-01-31 09:53:03 -0500 |
|---|---|---|
| committer | Chet Ramey <chet.ramey@case.edu> | 2022-01-31 09:53:03 -0500 |
| commit | b325b0e96bd05c76bbfc4d60d0707fc93d58f03f (patch) | |
| tree | 9b15fcef840f54cdd5ead129441509b594b883cc /lib/readline/doc/rltech.texi | |
| parent | 6e1ab9a367ff927d1815922a24ced22e73ad965e (diff) | |
| download | bash-b325b0e96bd05c76bbfc4d60d0707fc93d58f03f.tar.gz | |
more changes for here-docs and $'...'; command optimization updates
Diffstat (limited to 'lib/readline/doc/rltech.texi')
| -rw-r--r-- | lib/readline/doc/rltech.texi | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/lib/readline/doc/rltech.texi b/lib/readline/doc/rltech.texi index 8c4814ec..a1eac5eb 100644 --- a/lib/readline/doc/rltech.texi +++ b/lib/readline/doc/rltech.texi @@ -1184,10 +1184,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 |