X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.timer.xml;h=98d4f7b7b9cef66dd82060295fea66f214905f8a;hp=5845383e8bb7b44d6f5b96df9495baf3ba36bf96;hb=deb480d1a7c3f3178c44f0aa73765181c0e2317f;hpb=b36b082c8a24d2575909c3e0b4b8aeec49ec17bb diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 5845383e8..98d4f7b7b 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -9,16 +9,16 @@ Copyright 2010 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. systemd is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> @@ -44,18 +44,18 @@ systemd.timer - systemd timer configuration files + Timer unit configuration - systemd.timer + timer.timer Description A unit configuration file whose name ends in - .timer encodes information about + .timer encodes information about a timer controlled and supervised by systemd, for timer-based activation. @@ -68,14 +68,25 @@ timer specific configuration options are configured in the [Timer] section. - For each timer file a matching unit file must + For each timer file, a matching unit file must exist, describing the unit to activate when the timer - elapses. By default a service by the same name as the + elapses. By default, a service by the same name as the timer (except for the suffix) is activated. Example: a timer file foo.timer activates a matching service foo.service. The unit to activate may be controlled by Unit= (see below). + + Unless DefaultDependencies= + is set to , timer units will + implicitly have dependencies of type + Conflicts= and + Before= on + shutdown.target. These ensure + that timer units are stopped cleanly prior to system + shutdown. Only timer units involved with early boot or + late system shutdown should disable this + option. @@ -86,38 +97,38 @@ defines. The options specific to the [Timer] section of timer units are the following: - + - OnActive= - OnBootup= - OnStartup= - OnUnitActive= - OnUnitInactive= + OnActiveSec= + OnBootSec= + OnStartupSec= + OnUnitActiveSec= + OnUnitInactiveSec= - Defines timers + Defines monotonic timers relative to different starting points: - OnActive= defines a + OnActiveSec= defines a timer relative to the moment the timer itself is - activated. OnBootup= + activated. OnBootSec= defines a timer relative to when the machine was booted - up. OnStartup= + up. OnStartupSec= defines a timer relative to when - systemd was - started. OnUnitActive= + systemd was first + started. OnUnitActiveSec= defines a timer relative to when the unit the timer is activating was last - activated. OnUnitInactive= + activated. OnUnitInactiveSec= defines a timer relative to when the unit the timer is activating was last deactivated. Multiple directives may be - combined, of the same and of different + combined of the same and of different types. For example, by combining - OnBoot= and - OnUnitActive= it is + OnBootSec= and + OnUnitActiveSec=, it is possible to define a timer that elapses in regular intervals and activates a specific service each @@ -125,29 +136,102 @@ The arguments to the directives are time spans configured in - seconds. Example: "OnBoot=50" means + seconds. Example: "OnBootSec=50" means 50s after boot-up. The argument may also include time units. Example: - "OnBoot=5h 30min" means 5 hours and 30 - minutes after boot-up. For details - about the syntax of time spans see + "OnBootSec=5h 30min" means 5 hours and + 30 minutes after boot-up. For details + about the syntax of time spans, see systemd.unit5. If a timer configured with - OnBootup= or - OnStartup= is + OnBootSec= or + OnStartupSec= is already in the past when the timer unit is activated, it will immediately elapse and the configured unit is started. This is not the case for timers defined in the other - directives. + directives. These are monotonic timers, - independant of wall-clock time and timezones. If the + independent of wall-clock time and timezones. If the computer is temporarily suspended, the monotonic clock stops too. + If the empty string is assigned + to any of these options, the list of + timers is reset, and all prior + assignments will have no + effect. + + Note that timers do not + necessarily expire at the precise + time configured with these settings, + as they are subject to the + AccuracySec= + setting below. + + + + + OnCalendar= + + Defines realtime + (i.e. wallclock) timers with calendar + event expressions. See + systemd.time7 + for more information on the syntax of + calendar event expressions. Otherwise, + the semantics are similar to + OnActiveSec= and + related settings. + + Note that timers do not + necessarily expire at the precise + time configured with this setting, + as it is subject to the + AccuracySec= + setting below. + + + + AccuracySec= + + Specify the accuracy + the timer shall elapse with. Defaults + to 1min. The timer is scheduled to + elapse within a time window starting + with the time specified in + OnCalendar=, + OnActiveSec=, + OnBootSec=, + OnStartupSec=, + OnUnitActiveSec= or + OnUnitInactiveSec= + and ending the time configured with + AccuracySec= + later. Within this time window, the + expiry time will be placed at a + host-specific, randomized but stable + 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 + 1us. Note that the timer is still + subject to the timer slack configured + via + systemd-system.conf5's + TimerSlackNSec= + setting. See + prctl2 + for details. To optimize power + consumption, make sure to set this + value as high as possible and as low + as necessary. Unit= @@ -155,14 +239,14 @@ The unit to activate when this timer elapses. The argument is a unit name, whose suffix is not - .timer. If not - specified this value defaults to a + .timer. If not + specified, this value defaults to a service that has the same name as the timer unit, except for the suffix. (See above.) It is recommended that the unit name that is activated and the unit name of the timer unit - is chosen identical except for the + are named identically, except for the suffix. @@ -171,10 +255,14 @@ See Also - systemd8, + systemd1, systemctl8, systemd.unit5, - systemd.service5 + systemd.service5, + systemd.time7, + systemd.directives7, + systemd-system.conf5, + prctl2