From: Lennart Poettering Date: Fri, 2 Jul 2010 00:14:13 +0000 (+0200) Subject: man: document timer units X-Git-Tag: v1~72 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=11fcc3ab1b07c730fac6c8100e2e9d1585223be4 man: document timer units --- diff --git a/Makefile.am b/Makefile.am index cdf85f977..2e001a64b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -321,6 +321,7 @@ MANPAGES = \ man/systemd.mount.5 \ man/systemd.automount.5 \ man/systemd.swap.5 \ + man/systemd.timer.5 \ man/daemon.7 \ man/sd-daemon.7 \ man/runlevel.8 \ diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml new file mode 100644 index 000000000..b61cabc3e --- /dev/null +++ b/man/systemd.timer.xml @@ -0,0 +1,181 @@ + + + + + + + + + systemd.timer + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.timer + 5 + + + + systemd.timer + systemd timer configuration files + + + + systemd.timer + + + + Description + + A unit configuration file whose name ends in + .timer encodes information about + a timer controlled and supervised by systemd, for + timer-based activation. + + This man page lists the configuration options + specific to this unit type. See + systemd.unit5 + for the common options of all unit configuration + files. The common configuration items are configured + in the generic [Unit] and [Install] sections. The + timer specific configuration options are configured in + the [Timer] section. + + 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 + 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). + + + + Options + + Timer files must include a [Timer] section, + which carries information about the timer it + defines. The options specific to the [Timer] section + of timer units are the following: + + + + OnActive= + OnBootup= + OnStartup= + OnUnitActive= + OnUnitInactive= + + Defines timers + relative to different starting points: + OnActive= defines a + timer relative to the moment the timer + itself is + activated. OnBootup= + defines a timer relative to when the + machine was booted + up. OnStartup= + defines a timer relative to when + systemd was + started. OnUnitActive= + defines a timer relative to when the + unit the timer is activating was last + activated. OnUnitInactive= + 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 + types. For example, by combining + OnBoot= and + OnUnitActive= it is + possible to define a timer that + elapses in regular intervals and + activates a specific service each + time. + + The arguments to the directives + are time spans configured in + seconds. Example: "OnBoot=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 + systemd.unit5. + + If a timer configured with + OnBootup= or + OnStartup= 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. + + These are monotonic timers, + independant of wall-clock time and timezones. If the + computer is temporarily suspended, the + monotonic clock stops too. + + + + Unit= + + The unit to activate + when this timer elapses. Argument is a + unit name, whose suffix is not + .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 + suffix. + + + + + + See Also + + systemd8, + systemctl8, + systemd.unit5, + systemd.service5 + + + +