From: Richard M. Stallman <rms@gnu.org>
Date: Wed, 24 Oct 2007 08:18:34 +0000 (+0000)
Subject: (Idle Timers): current-idle-time returns nil if not idle.
X-Git-Tag: emacs-pretest-22.1.90~523
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=17bec671b52712738c33805b5e1c2cb9f95da7d8;p=emacs.git

(Idle Timers): current-idle-time returns nil if not idle.
---

diff --git a/lispref/os.texi b/lispref/os.texi
index 498cc857eab..06ae49e5236 100644
--- a/lispref/os.texi
+++ b/lispref/os.texi
@@ -1556,10 +1556,10 @@ set up to repeat will subsequently run another time, one by one.
 
 @c Emacs 19 feature
 @defun current-idle-time
-This function returns the length of time Emacs has been idle, as a
-list of three integers: @code{(@var{high} @var{low} @var{microsec})}.
-The integers @var{high} and @var{low} combine to give the number of
-seconds of idleness, which is
+If Emacs is idle, this function returns the length of time Emacs has
+been idle, as a list of three integers: @code{(@var{high} @var{low}
+@var{microsec})}.  The integers @var{high} and @var{low} combine to
+give the number of seconds of idleness, which is
 @ifnottex
 @var{high} * 2**16 + @var{low}.
 @end ifnottex
@@ -1571,6 +1571,9 @@ The third element, @var{microsec}, gives the microseconds since the
 start of the current second (or 0 for systems that return time with
 the resolution of only one second).
 
+When Emacs is not idle, @code{current-idle-time} returns @code{nil}.
+This is a convenient way to test whether Emacs is idle.
+
 The main use of this function is when an idle timer function wants to
 ``take a break'' for a while.  It can set up another idle timer to
 call the same function again, after a few seconds more idleness.