summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2020-09-10 19:08:45 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-09-20 12:00:25 +0200
commit366d38d8ed9e1f8ca06c765d1e569b06dfb4de70 (patch)
tree352284af2064b1ce614d33be0a9edd583608d611
parentd0f0f048ec86be122d9fa41ad50a15d97e629bbe (diff)
downloadsystemd-366d38d8ed9e1f8ca06c765d1e569b06dfb4de70.tar.gz
man: document that RemainAfterElapse=no means that also the triggered unit needs to deactivate
Fixes: #16378 (cherry picked from commit 415f8a5bfed4604e4a1bc275682d51af3ad3b611)
-rw-r--r--man/systemd.timer.xml20
1 files changed, 8 insertions, 12 deletions
diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
index 32ddb1c6e4..32f7814f8e 100644
--- a/man/systemd.timer.xml
+++ b/man/systemd.timer.xml
@@ -335,18 +335,14 @@
<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>