]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: document that RemainAfterElapse=no means that also the triggered unit needs...
authorLennart Poettering <lennart@poettering.net>
Thu, 10 Sep 2020 17:08:45 +0000 (19:08 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 14 Sep 2020 08:17:41 +0000 (10:17 +0200)
Fixes: #16378
man/systemd.timer.xml

index 32ddb1c6e4753977e87e92623658a2814ccad4b3..32f7814f8e54cf435e42a60f818cb3e404b0eeba 100644 (file)
       <varlistentry>
         <term><varname>RemainAfterElapse=</varname></term>
 
-        <listitem><para>Takes a boolean argument. If true, an elapsed
-        timer will stay loaded, and its state remains queryable. If
-        false, an elapsed timer unit that cannot elapse anymore is
-        unloaded. Turning this off is particularly useful for
-        transient timer units that shall disappear after they first
-        elapse. Note that this setting has an effect on repeatedly
-        starting a timer unit that only elapses once: if
-        <varname>RemainAfterElapse=</varname> is on, it will not be
-        started again, and is guaranteed to elapse only once. However,
-        if <varname>RemainAfterElapse=</varname> is off, it might be
-        started again if it is already elapsed, and thus be triggered
-        multiple times. Defaults to
+        <listitem><para>Takes a boolean argument. If true, a timer will stay loaded, and its state remains
+        queryable even after it elapsed and the associated unit (as configured with <varname>Unit=</varname>,
+        see above) deactivated again. If false, an elapsed timer unit that cannot elapse anymore is unloaded
+        once its associated unit deactivated again. Turning this off is particularly useful for transient
+        timer units. Note that this setting has an effect when repeatedly starting a timer unit: if
+        <varname>RemainAfterElapse=</varname> is on, starting the timer a second time has no effect. However,
+        if <varname>RemainAfterElapse=</varname> is off and the timer unit was already unloaded, it can be
+        started again, and thus the service can be triggered multiple times. Defaults to
         <varname>yes</varname>.</para></listitem>
       </varlistentry>
     </variablelist>