improve timer documentation

This commit is contained in:
2022-11-21 11:51:12 +01:00
parent 100e3c2fa3
commit 3eeb15d540
2 changed files with 6 additions and 1 deletions
@@ -20,6 +20,7 @@ Parameters
description String
command String
on_calendar String
persistent Boolean false
=============================== ======== ================================================
@@ -38,3 +39,7 @@ and a check is performed against this.
~~~~~~~~~~~~~~~
The definition of the timer execution time. See `OnCalendar` on systemd.timer(5).
``persistent``
~~~~~~~~~~~~~
If set will run the timer immediately at bootup if the device was switched off at the time
of the last scheduled run.
+1 -1
View File
@@ -137,7 +137,7 @@ For each time following keys are mandatory
- `description` for a short explaination what it is about
- `command` for the command to run
- `on_calendar`defining when it should run using the [`systemd` calendar event format](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events)
- `on_calendar` defining when it should run using the [`systemd` calendar event format](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events), (alternatively see also chapter "CALENDAR EVENTS" `man systemd.date`)
Optional is
- `persistence` which signals if the timer should run immediately after boot when the node was switched of on the last suggested run time (default is `false`)