Mercurial > emacs
changeset 71962:649d10148b82
* commands.texi (Waiting): Document batch-mode sit-for behavior.
| author | Chong Yidong <cyd@stupidchicken.com> |
|---|---|
| date | Tue, 18 Jul 2006 01:35:03 +0000 |
| parents | f2a11961b9d8 |
| children | a6c0f6b0c790 |
| files | lispref/ChangeLog lispref/commands.texi |
| diffstat | 2 files changed, 11 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/ChangeLog Tue Jul 18 01:34:48 2006 +0000 +++ b/lispref/ChangeLog Tue Jul 18 01:35:03 2006 +0000 @@ -1,3 +1,7 @@ +2006-07-17 Chong Yidong <cyd@stupidchicken.com> + + * commands.texi (Waiting): Document batch-mode sit-for behavior. + 2006-07-17 Richard Stallman <rms@gnu.org> * eval.texi, elisp.texi, text.texi: Use real doublequote inside menus.
--- a/lispref/commands.texi Tue Jul 18 01:34:48 2006 +0000 +++ b/lispref/commands.texi Tue Jul 18 01:35:03 2006 +0000 @@ -2534,9 +2534,10 @@ @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 @@ 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})},