summaryrefslogtreecommitdiff
path: root/man/systemd.timer.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2015-11-18 12:18:27 +0100
committerLennart Poettering <lennart@poettering.net>2015-11-18 17:04:04 +0100
commit70b4f8197008e04f7b4f12cead3f616db5cbba3c (patch)
tree39815c177547935edbf1ba22b9fde59bc1946db3 /man/systemd.timer.xml
parentddb4b0d3eb57292c38a76f9b977f73cea15448fb (diff)
downloadsystemd-70b4f8197008e04f7b4f12cead3f616db5cbba3c.tar.gz
man: improve and fix documentation for RemainAfterElapse=
Diffstat (limited to 'man/systemd.timer.xml')
-rw-r--r--man/systemd.timer.xml15
1 files changed, 12 insertions, 3 deletions
diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
index 3841588820..5826773a99 100644
--- a/man/systemd.timer.xml
+++ b/man/systemd.timer.xml
@@ -245,11 +245,20 @@
</varlistentry>
<varlistentry>
- <term><varname>RemainAfterExit=</varname></term>
+ <term><varname>RemainAfterElapse=</varname></term>
<listitem><para>Takes a boolean argument. If true, an elapsed
- timer will stay loaded, and its state remains
- queriable. Defaults to
+ timer will stay loaded, and its state remains queriable. 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 the 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>RemainAfterLeapse=</varname> is off, it might be
+ started again if it is already elapsed, and thus be triggered
+ multiple times. Defaults to
<varname>yes</varname>.</para></listitem>
</varlistentry>
</variablelist>