summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2016-09-23 11:43:25 +0300
committerEli Zaretskii <eliz@gnu.org>2016-09-23 11:43:25 +0300
commit0ae9a816b9f68bd3f50fc287a342237c8b4fe78d (patch)
tree6ba51f5f6c94220c1ab8f1656e332919d88655f5
parent2c72c46af18b586137c3cebde56f451c1b0b7a9b (diff)
downloademacs-0ae9a816b9f68bd3f50fc287a342237c8b4fe78d.tar.gz
Document 'timerp'
* doc/lispref/os.texi (Timers): Document 'timerp'. (Bug#24511) Improve indexing.
-rw-r--r--doc/lispref/os.texi11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index ec14b014e52..0d999ae9b99 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -1727,10 +1727,17 @@ This function returns @code{t} if @var{year} is a leap year.
@node Timers
@section Timers for Delayed Execution
-@cindex timer
+@cindex timers
You can set up a @dfn{timer} to call a function at a specified
-future time or after a certain length of idleness.
+future time or after a certain length of idleness. A timer is a
+special object that stores the information about the next invocation
+times and the function to invoke.
+
+@defun timerp object
+This predicate function returns non-@code{nil} of @code{object} is a
+timer.
+@end defun
Emacs cannot run timers at any arbitrary point in a Lisp program; it
can run them only when Emacs could accept output from a subprocess: