AboutSummaryRefsLogTreeCommitDiffStats
path: root/doc/mcron.texi
diff options
context:
space:
mode:
authorMathieu Lirzin <mthl@gnu.org>2017-10-19 23:22:14 +0200
committerMathieu Lirzin <mthl@gnu.org>2018-03-16 21:41:14 +0100
commit5f83aef90f0b5a3bef3baee48bc6f6cdf452155d (patch)
tree463d736d525a8237089a700cf375fb755fc0b5a6 /doc/mcron.texi
parentb80020ef782921df147b957c4041f4b61d61c673 (diff)
downloadmcron-5f83aef90f0b5a3bef3baee48bc6f6cdf452155d.tar.gz
mcron-5f83aef90f0b5a3bef3baee48bc6f6cdf452155d.tar.bz2
mcron-5f83aef90f0b5a3bef3baee48bc6f6cdf452155d.zip
base: Add 'display-schedule' procedure
This procedure is a more generic and less coupled version of 'get-schedule' which has been kept for backward compatibility and deprecated. * src/mcron/base.scm (display-schedule): New procedure. (get-schedule): Move to ... * src/mcron/core.scm: ... here. * src/mcron/scripts/cron.scm (main): Use 'display-schedule'. * src/mcron/scripts/mcron.scm (main): Likewise. * doc/mcron.texi (The base module): Document it.
Diffstat (limited to 'doc/mcron.texi')
-rw-r--r--doc/mcron.texi7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/mcron.texi b/doc/mcron.texi
index 70e9d98..04f92bd 100644
--- a/doc/mcron.texi
+++ b/doc/mcron.texi
@@ -1233,9 +1233,12 @@ entry. All jobs on the current job list that are scheduled to be run
under this personality are removed from the job list.
@end deffn
-@deffn{Scheme procedure} get-schedule count
+@deffn{Scheme procedure} display-schedule @var{count} [@var{port}]
@cindex schedule of jobs
-The argument @var{count} should be an integer value giving the number
+This procedure is used to display a textual list of the next COUNT jobs
+to run.
+
+The argument @var{count} must be an integer value giving the number
of time-points in the future to report that jobs will run as. Note
that this procedure is disruptive; if @code{run-job-loop} is called
after this procedure, the first job to run will be the one after the