man: document that RemainAfterElapse=no means that also the triggered unit needs to deactivate

Fixes: #16378
This commit is contained in:
Lennart Poettering 2020-09-10 19:08:45 +02:00 committed by Zbigniew Jędrzejewski-Szmek
parent 4b6bc95c01
commit 415f8a5bfe
1 changed files with 8 additions and 12 deletions

View File

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