chiark / gitweb /
man: extend a bit what to expect from the various places apps can store data
[elogind.git] / man / systemd.timer.xml
index 484287ccf67fc3f770f6883e8f7df6039e8b4d3e..d82b9bdc973b09846231bbef88799a855ab8e557 100644 (file)
                                 also include time units. Example:
                                 "OnBootSec=5h 30min" means 5 hours and
                                 30 minutes after boot-up. For details
-                                about the syntax of time spans see
+                                about the syntax of time spans, see
                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 
                                 <para>If a timer configured with
                                 assignments will have no
                                 effect.</para>
 
-                                <para>Note that timers are not
-                                necessarily expired at the precise
+                                <para>Note that timers do not
+                                necessarily expire at the precise
                                 time configured with these settings,
                                 as they are subject to the
                                 <varname>AccuracySec=</varname>
                                 event expressions. See
                                 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                                 for more information on the syntax of
-                                calendar event expressions. Otherwise
+                                calendar event expressions. Otherwise,
                                 the semantics are similar to
                                 <varname>OnActiveSec=</varname> and
                                 related settings.</para>
 
-                                <para>Note that timers are not
-                                necessarily expired at the precise
+                                <para>Note that timers do not
+                                necessarily expire at the precise
                                 time configured with this setting,
                                 as it is subject to the
                                 <varname>AccuracySec=</varname>
                                 <listitem><para>Specify the accuracy
                                 the timer shall elapse with. Defaults
                                 to 1min. The timer is scheduled to
-                                expire within a time window starting
+                                elapse within a time window starting
                                 with the time specified in
                                 <varname>OnCalendar=</varname>,
                                 <varname>OnActiveSec=</varname>,
                                 <varname>OnUnitInactiveSec=</varname>
                                 and ending the time configured with
                                 <varname>AccuracySec=</varname>
-                                later. Within this time window the
+                                later. Within this time window, the
                                 expiry time will be placed at a
                                 host-specific, randomized but stable
-                                position, that is synchronized between
+                                position that is synchronized between
                                 all local timer units. This is done in
                                 order to distribute the wake-up time
                                 in networked installations, as well as
                                 optimizing power consumption to
                                 suppress unnecessary CPU wake-ups. To
-                                get best accuracy set this option to
+                                get best accuracy, set this option to
                                 1us. Note that the timer is still
                                 subject to the timer slack configured
                                 via
                                 setting. See
                                 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
                                 for details. To optimize power
-                                consumption make sure to set this
+                                consumption, make sure to set this
                                 value as high as possible and as low
                                 as necessary.</para></listitem>
                         </varlistentry>
                                 are named identically, except for the
                                 suffix.</para></listitem>
                         </varlistentry>
+
+
+                        <varlistentry>
+                                <term><varname>Persistent=</varname></term>
+
+                                <listitem><para>Takes a boolean
+                                argument. If true, the time when the
+                                service unit was last triggered is
+                                stored on disk. When the timer is
+                                activated, the service unit is
+                                triggered immediately if it would have
+                                been triggered at least once during
+                                the time when the timer was inactive.
+                                This is useful to catch up on missed
+                                runs of the service when the machine
+                                was off. Note that this setting only
+                                has an effect on timers configured
+                                with <varname>OnCalendar=</varname>.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>WakeSystem=</varname></term>
+
+                                <listitem><para>Takes a boolean
+                                argument. If true, an elapsing timer
+                                will cause the system to resume from
+                                suspend, should it be suspended and if
+                                the system supports this. Note that
+                                this option will only make sure the
+                                system resumes on the appropriate
+                                times, it will not take care of
+                                suspending it again after any work
+                                that is to be done is
+                                finished. Defaults to
+                                <varname>false</varname>.</para></listitem>
+                        </varlistentry>
                 </variablelist>
         </refsect1>