summaryrefslogtreecommitdiff
path: root/lispref/commands.texi
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2006-07-18 01:35:03 +0000
committerChong Yidong <cyd@stupidchicken.com>2006-07-18 01:35:03 +0000
commite18423327e15d044674a9b949a3cb138f6009dbd (patch)
treeefba1f9a1d6023f44c858da03ef34eadb6c4aca8 /lispref/commands.texi
parentc1fdbde6c8c1e007d5abe6fba012fb1a2c09c448 (diff)
downloademacs-e18423327e15d044674a9b949a3cb138f6009dbd.tar.gz
* commands.texi (Waiting): Document batch-mode sit-for behavior.
Diffstat (limited to 'lispref/commands.texi')
-rw-r--r--lispref/commands.texi12
1 files changed, 7 insertions, 5 deletions
diff --git a/lispref/commands.texi b/lispref/commands.texi
index df8eeae9c90..e1c37efa812 100644
--- a/lispref/commands.texi
+++ b/lispref/commands.texi
@@ -2534,9 +2534,10 @@ screen.
@defun sit-for seconds &optional nodisp
This function performs redisplay (provided there is no pending input
from the user), then waits @var{seconds} seconds, or until input is
-available. The value is @code{t} if @code{sit-for} waited the full
-time with no input arriving (see @code{input-pending-p} in @ref{Event
-Input Misc}). Otherwise, the value is @code{nil}.
+available. The usual purpose of @code{sit-for} is to give the user
+time to read text that you display. The value is @code{t} if
+@code{sit-for} waited the full time with no input arriving
+(@pxref{Event Input Misc}). Otherwise, the value is @code{nil}.
The argument @var{seconds} need not be an integer. If it is a floating
point number, @code{sit-for} waits for a fractional number of seconds.
@@ -2551,8 +2552,9 @@ If @var{nodisp} is non-@code{nil}, then @code{sit-for} does not
redisplay, but it still returns as soon as input is available (or when
the timeout elapses).
-The usual purpose of @code{sit-for} is to give the user time to read
-text that you display.
+In batch mode (@pxref{Batch Mode}), @code{sit-for} cannot be
+interrupted, even by input from the standard input descriptor. It is
+thus equivalent to @code{sleep-for}, which is described below.
It is also possible to call @code{sit-for} with three arguments,
as @code{(sit-for @var{seconds} @var{millisec} @var{nodisp})},