diff --git a/man/systemctl.xml b/man/systemctl.xml index 5ebe1832bc..b2e3cbcb21 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -506,6 +506,21 @@ + + + + + Select what type of per-unit resources to remove when the clean command is + invoked, see below. Takes one of configuration, state, + cache, logs, runtime to select the + type of resource. This option may be specified more than once, in which case all specified resource + types are removed. Also accepts the special value all as a shortcut for + specifiying all five resource types. If this option is not specified defaults to the combination of + cache and runtime, i.e. the two kinds of resources that + are generally considered to be redundant and can be reconstructed on next invocation. + + + @@ -904,6 +919,24 @@ Sun 2017-02-26 20:57:49 EST 2h 3min left Sun 2017-02-26 11:56:36 EST 6h ago the signal to send. + + clean PATTERN… + + + Remove the configuration, state, cache, logs or runtime data of the specified units. Use + to select which kind of resource to remove. For service units this may + be used to remove the directories configured with ConfigurationDirectory=, + StateDirectory=, CacheDirectory=, + LogsDirectory= and RuntimeDirectory=, see + systemd.exec5 + for details. For timer units this may be used to clear out the persistent timestamp data if + Persistent= is used and is selected, see + systemd.timer5. This + command only applies to units that use either of these settings. If is + not specified, both the cache and runtime data are removed (as these two types of data are + generally redundant and reproducible on the next invocation of the unit). + + is-active PATTERN… diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 56a029a82e..48dd42ca3c 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -981,6 +981,11 @@ CapabilityBoundingSet=~CAP_B CAP_C the directories is tied directly to the lifetime of the unit, and it is not necessary to ensure that the tmpfiles.d configuration is executed before the unit is started. + To remove any of the directories created by these settings, use the systemctl clean + … command on the relevant units, see + systemctl1 for + details. + Example: if a system service unit has the following, RuntimeDirectory=foo/bar baz the service manager creates /run/foo (if it does not exist), diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 22329f6c2f..145f97206c 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -610,6 +610,16 @@ + + TimeoutCleanSec= + Configures a timeout on the clean-up operation requested through systemctl + clean …, see + systemctl1 for + details. Takes the usual time values and defaults to infinity, i.e. by default + no time-out is applied. If a time-out is configured the clean operation will be aborted forcibly when + the time-out is reached, potentially leaving resources on disk. + + RuntimeMaxSec= diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 340286d912..0f6518dbc2 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -286,16 +286,18 @@ Persistent= - 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 OnCalendar=. Defaults - to false. - + 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 system was powered down. Note that this setting + only has an effect on timers configured with OnCalendar=. Defaults to + false. + + Use systemctl clean --what=state … on the timer unit to remove the timestamp + file maintained by this option from disk. In particular, use this command before uninstalling a timer + unit. See + systemctl1 for + details.