4cad4c
From b8af9fd65b697e9bb77a32d1a6a70367814aaed5 Mon Sep 17 00:00:00 2001
4cad4c
From: Lennart Poettering <lennart@poettering.net>
4cad4c
Date: Mon, 1 Apr 2019 17:30:45 +0200
4cad4c
Subject: [PATCH] man: be clearer that .timer time expressions need to be reset
4cad4c
 to override them
4cad4c
4cad4c
let's be clearer about the overriding concept for OnCalendar= settings.
4cad4c
4cad4c
Prompted by this thread:
4cad4c
4cad4c
https://lists.freedesktop.org/archives/systemd-devel/2019-March/042351.html
4cad4c
(cherry picked from commit 58031d99c6320855b86f4890baa9165597e3d841)
4cad4c
4cad4c
Resolves: #1816908
4cad4c
---
4cad4c
 man/systemd.timer.xml | 31 ++++++++++++++++++-------------
4cad4c
 1 file changed, 18 insertions(+), 13 deletions(-)
4cad4c
4cad4c
diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
4cad4c
index 44b257c745..ebc1df89f1 100644
4cad4c
--- a/man/systemd.timer.xml
4cad4c
+++ b/man/systemd.timer.xml
4cad4c
@@ -125,12 +125,12 @@
4cad4c
         to when the unit the timer is activating was last
4cad4c
         deactivated.</para>
4cad4c
 
4cad4c
-        <para>Multiple directives may be combined of the same and of
4cad4c
-        different types. For example, by combining
4cad4c
-        <varname>OnBootSec=</varname> and
4cad4c
-        <varname>OnUnitActiveSec=</varname>, it is possible to define
4cad4c
-        a timer that elapses in regular intervals and activates a
4cad4c
-        specific service each time.</para>
4cad4c
+        <para>Multiple directives may be combined of the same and of different types, in which case the timer
4cad4c
+        unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
4cad4c
+        <varname>OnBootSec=</varname> and <varname>OnUnitActiveSec=</varname>, it is possible to define a
4cad4c
+        timer that elapses in regular intervals and activates a specific service each time. Moreover, both
4cad4c
+        monotonic time expressions and <varname>OnCalendar=</varname> calendar expressions may be combined in
4cad4c
+        the same timer unit.</para>
4cad4c
 
4cad4c
         <para>The arguments to the directives are time spans
4cad4c
         configured in seconds. Example: "OnBootSec=50" means 50s after
4cad4c
@@ -145,13 +145,12 @@
4cad4c
         and the configured unit is started. This is not the case for
4cad4c
         timers defined in the other directives.</para>
4cad4c
 
4cad4c
-        <para>These are monotonic timers, independent of wall-clock
4cad4c
-        time and timezones. If the computer is temporarily suspended,
4cad4c
-        the monotonic clock stops too.</para>
4cad4c
+        <para>These are monotonic timers, independent of wall-clock time and timezones. If the computer is
4cad4c
+        temporarily suspended, the monotonic clock pauses, too.</para>
4cad4c
 
4cad4c
-        <para>If the empty string is assigned to any of these options,
4cad4c
-        the list of timers is reset, and all prior assignments will
4cad4c
-        have no effect.</para>
4cad4c
+        <para>If the empty string is assigned to any of these options, the list of timers is reset (both
4cad4c
+        monotonic timers and <varname>OnCalendar=</varname> timers, see below), and all prior assignments
4cad4c
+        will have no effect.</para>
4cad4c
 
4cad4c
         <para>Note that timers do not necessarily expire at the
4cad4c
         precise time configured with these settings, as they are
4cad4c
@@ -175,7 +174,13 @@
4cad4c
         the <varname>AccuracySec=</varname> setting
4cad4c
         below.</para>
4cad4c
 
4cad4c
-       <para>May be specified more than once.</para></listitem>
4cad4c
+        <para>May be specified more than once, in which case the timer unit will trigger whenever any of the
4cad4c
+        specified expressions elapse. Moreover calendar timers and monotonic timers (see above) may be
4cad4c
+        combined within the same timer unit.</para>
4cad4c
+
4cad4c
+        <para>If the empty string is assigned to any of these options, the list of timers is reset (both
4cad4c
+        <varname>OnCalendar=</varname> timers and monotonic timers, see above), and all prior assignments
4cad4c
+        will have no effect.</para></listitem>
4cad4c
       </varlistentry>
4cad4c
 
4cad4c
       <varlistentry>