From 624dd009732dd18ca5e0d43a064958930366512f Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Tue, 19 Dec 2017 00:07:11 +0900 Subject: [PATCH] man: add explanation about transient path or socket units in systemd-run --- man/systemd-run.xml | 61 +++++++++++++++++++++++++++++++++++------------------ 1 file changed, 40 insertions(+), 21 deletions(-) diff --git a/man/systemd-run.xml b/man/systemd-run.xml index 7bcea9b..4f47ef8 100644 --- a/man/systemd-run.xml +++ b/man/systemd-run.xml @@ -47,7 +47,7 @@ systemd-run - Run programs in transient scope units, service units, or timer-scheduled service units + Run programs in transient scope units, service units, or path-, socket-, or timer-triggered service units @@ -61,6 +61,20 @@ systemd-run OPTIONS + PATH OPTIONS + COMMAND + ARGS + + + systemd-run + OPTIONS + SOCKET OPTIONS + COMMAND + ARGS + + + systemd-run + OPTIONS TIMER OPTIONS COMMAND ARGS @@ -72,8 +86,8 @@ systemd-run may be used to create and start a transient .service or .scope unit and run the specified COMMAND in it. It may also be - used to create and start a transient .timer unit, that activates a - .service unit when elapsing. + used to create and start a transient .path, .socket, or + .timer unit, that activates a .service unit when elapsing. If a command is run as transient service unit, it will be started and managed by the service manager like any other service, and thus shows up in the output of systemctl list-units like any other unit. It @@ -88,12 +102,13 @@ list-units. Execution in this case is synchronous, and will return only when the command finishes. This mode is enabled via the switch (see below). - If a command is run with timer options such as (see below), a transient timer - unit is created alongside the service unit for the specified command. Only the transient timer unit is started - immediately, the transient service unit will be started when the timer elapses. If the - option is specified, the COMMAND may be omitted. In this case, - systemd-run creates only a .timer unit that invokes the specified unit when - elapsing. + If a command is run with path, socket, or timer options such as (see below), + a transient path, socket, or timer unit is created alongside the service unit for the specified command. Only the + transient path, socket, or timer unit is started immediately, the transient service unit will be triggered by the + path, socket, or timer unit. If the option is specified, the + COMMAND may be omitted. In this case, systemd-run creates only a + .path, .socket, or .timer unit that triggers the + specified unit. @@ -140,8 +155,8 @@ - Provide a description for the service, scope or timer unit. If not specified, the command - itself will be used as a description. See Description= in + Provide a description for the service, scope, path, socket, or timer unit. If not specified, + the command itself will be used as a description. See Description= in systemd.unit5. @@ -278,7 +293,8 @@ command. See OnActiveSec=, OnBootSec=, OnStartupSec=, OnUnitActiveSec= and OnUnitInactiveSec= in systemd.timer5 for - details. These options may not be combined with or . + details. These options are shortcuts for --timer-property= with the relevant properties. + These options may not be combined with or . @@ -287,20 +303,23 @@ Defines a calendar timer for starting the specified command. See OnCalendar= in systemd.timer5. This - option may not be combined with or . + option is a shortcut for --timer-property=OnCalendar=. This option may not be combined with + or . + + - Sets a property on the timer unit that is created. This option is similar to - but applies to the transient timer unit rather than the transient service unit - created. This option only has an effect in conjunction with , - , , , - or . This option takes an assignment in the - same format as systemctl1's - set-property command. + Sets a property on the path, socket, or timer unit that is created. This option is similar to + but applies to the transient path, socket, or timer unit rather than the + transient service unit created. This option takes an assignment in the same format as + systemctl1's + set-property command. These options may not be combined with + or . + @@ -323,7 +342,7 @@ completed). On exit, terse information about the unit's runtime is shown, including total runtime (as well as CPU usage, if was set) and the exit code and status of the main process. This output may be suppressed with . This option may not be combined with - , or the various timer options. + , or the various path, socket, or timer options. -- 2.7.4