summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2006-08-25 07:51:46 +0000
committerRichard M. Stallman <rms@gnu.org>2006-08-25 07:51:46 +0000
commit73c24ae8e82a9144264b768a18e76765263c10df (patch)
tree7e71758db0d52a3201dfc10fc451ee46f79ae593
parent11f56bbcfee486e60d33c9d18d0ca9a01ebbaa6d (diff)
downloademacs-73c24ae8e82a9144264b768a18e76765263c10df.tar.gz
(Idle Timers): run-with-idle-timer allows Lisp time value. Add xref.
-rw-r--r--lispref/os.texi5
1 files changed, 3 insertions, 2 deletions
diff --git a/lispref/os.texi b/lispref/os.texi
index b5522dc2a98..f6682548e5b 100644
--- a/lispref/os.texi
+++ b/lispref/os.texi
@@ -1500,7 +1500,8 @@ work just like ordinary timers.
@deffn Command run-with-idle-timer secs repeat function &rest args
Set up a timer which runs when Emacs has been idle for @var{secs}
seconds. The value of @var{secs} may be an integer or a floating point
-number.
+number; a value of the type returned by @code{current-idle-time}
+is also allowed.
If @var{repeat} is @code{nil}, the timer runs just once, the first time
Emacs remains idle for a long enough time. More often @var{repeat} is
@@ -1508,7 +1509,7 @@ non-@code{nil}, which means to run the timer @emph{each time} Emacs
remains idle for @var{secs} seconds.
The function @code{run-with-idle-timer} returns a timer value which you
-can use in calling @code{cancel-timer} (see below).
+can use in calling @code{cancel-timer} (@pxref{Timers}).
@end deffn
@cindex idleness