From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 18 Nov 2015 11:18:27 +0000 (+0100)
Subject: man: improve and fix documentation for RemainAfterElapse=
X-Git-Tag: v229~309^2~8
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=70b4f8197008e04f7b4f12cead3f616db5cbba3c;p=thirdparty%2Fsystemd.git

man: improve and fix documentation for RemainAfterElapse=
---

diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
index 38415888205..5826773a99a 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>