X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=918bbc41198509cc9030ac8a83c5e8559dedf085;hp=b43fa1369ed80991979d60e8abe0e67d9d8254cb;hb=a53692f7b4fb0af771bd510436cc592ef2919f86;hpb=d420282b28f50720e233ccb1c02547c562195653 diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index b43fa1369..918bbc411 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -120,6 +120,17 @@ systemd.scope5. + Various settings are allowed to be specified + more than once, in which case the interpretation + depends on the setting. Often, multiple settings form + a list, and setting to an empty value "resets", which + means that previous assignments are ignored. When this + is allowed, it is mentioned in the description of the + setting. Note that using multiple assignments to the + same value makes the unit file incompatible with + parsers for the XDG .desktop file + format. + Unit files are loaded from a set of paths determined during compilation, described in the next section. @@ -410,10 +421,12 @@ of the other units gets deactivated or its activation fails, this unit will be deactivated. This option may be - specified more than once, in which - case requirement dependencies for all - listed names are created. Note that - requirement dependencies do not + specified more than once or multiple + space-separated units may be specified + in one option in which case + requirement dependencies for all + listed names will be created. Note + that requirement dependencies do not influence the order in which services are started or stopped. This has to be configured independently with the @@ -476,22 +489,23 @@ RequisiteOverridable= Similar to - Requires= - and RequiresOverridable=, respectively. However, - if a unit listed here is not started - already it will not be started and the - transaction fails - immediately. + Requires= and + RequiresOverridable=, + respectively. However, if the units + listed here are not started already + they will not be started and the + transaction will fail immediately. + Wants= A weaker version of - Requires=. A unit + Requires=. Units listed in this option will be started if the configuring unit is. However, - if the listed unit fails to start up + if the listed units fail to start or cannot be added to the transaction this has no impact on the validity of the transaction as a whole. This is @@ -501,8 +515,8 @@ Note that dependencies of this type may also be configured outside of - the unit configuration file by - adding a symlink to a + the unit configuration file by adding + symlinks to a .wants/ directory accompanying the unit file. For details see above. @@ -534,7 +548,7 @@ of units. When systemd stops or restarts the units listed here, the action is propagated to this unit. - Note that this is a one way dependency - + Note that this is a one way dependency — changes to this unit do not affect the listed units. @@ -543,12 +557,12 @@ Conflicts= - Configures negative + A space-separated list + of unit names. Configures negative requirement dependencies. If a unit - has a - Conflicts= setting - on another unit, starting the former - will stop the latter and vice + has a Conflicts= + setting on another unit, starting the + former will stop the latter and vice versa. Note that this setting is independent of and orthogonal to the After= and @@ -575,7 +589,8 @@ Before= After= - Configures ordering + A space-separated list + of unit names. Configures ordering dependencies between units. If a unit foo.service contains a setting @@ -624,18 +639,18 @@ type After= or Before=. If two units have no ordering dependencies - between them, they are shut down - or started up simultaneously, and - no ordering takes + between them, they are shut down or + started up simultaneously, and no + ordering takes place. OnFailure= - Lists one or more - units that are activated when this - unit enters the + A space-separated list + of one or more units that are + activated when this unit enters the failed state. @@ -644,16 +659,48 @@ PropagatesReloadTo= ReloadPropagatedFrom= - Lists one or more - units where reload requests on the - unit will be propagated to/on the - other unit will be propagated - from. Issuing a reload request on a - unit will automatically also enqueue a - reload request on all units that the - reload request shall be propagated to - via these two - settings. + A space-separated list + of one or more units where reload + requests on this unit will be + propagated to, or reload requests on + the other unit will be propagated to + this unit, respectively. Issuing a + reload request on a unit will + automatically also enqueue a reload + request on all units that the reload + request shall be propagated to via + these two settings. + + + + JoinsNamespaceOf= + + For units that start + processes (such as service units), + lists one or more other units whose + network and/or temporary file + namespace to join. This only applies + to unit types which support the + PrivateNetwork= and + PrivateTmp= + directives (see + systemd.exec5 + for details). If a unit that has this + setting set is started its processes + will see the same + /tmp, + /tmp/var and + network namespace as one listed unit + that is started. If multiple listed + units are already started it is not + defined which namespace is + joined. Note that this setting only + has an effect if + PrivateNetwork= + and/or PrivateTmp= + is enabled for both the unit that + joins the namespace and the unit whose + namespace is joined. @@ -674,28 +721,20 @@ Takes a value of fail, replace, - replace-irreversibly + replace-irreversibly, + isolate, + flush, + ignore-dependencies or - isolate. Defaults + ignore-requirements. Defaults to replace. Specifies how the units listed in OnFailure= will be - enqueued. If set to - fail and - contradicting jobs are already queued, - cause the activation to fail. If set - to replace and - contradicting jobs area already - queued, replace - those. replace-irreversibly - is similar to - replace, however, - creates jobs that cannot be reversed - unless they finished or are explicitly - canceled. isolate - may be used to terminate all other - units but the specified one. If + enqueued. See + systemctl1's + option + for details on the possible values. If this is set to isolate, only a single unit may be listed in @@ -1107,32 +1146,34 @@ Alias= - Additional names this - unit shall be installed under. The - names listed here must have the same - suffix (i.e. type) as the unit file - name. This option may be specified - more than once, in which case all - listed names are used. At installation - time, - systemctl enable - will create symlinks from these names - to the unit filename. + A space-seperated list + of additional names this unit shall be + installed under. The names listed here + must have the same suffix (i.e. type) + as the unit file name. This option may + be specified more than once, in which + case all listed names are used. At + installation time, systemctl + enable will create symlinks + from these names to the unit + filename. WantedBy= RequiredBy= - A symbolic link is - created in the - .wants/ or - .requires/ directory - of the listed unit when this unit is - activated by systemctl - enable. This has the effect - that a dependency of type - Wants= or + This option may be + used more than once, or a + space-separated list of unit names may + be given. A symbolic link is created + in the .wants/ or + .requires/ + directory of each of the listed units + when this unit is installed by + systemctl enable. + This has the effect that a dependency + of type Wants= or Requires= is added from the listed unit to the current unit. The primary result is that the @@ -1178,7 +1219,12 @@ and systemctl disable will automatically install/uninstall units listed in this option as - well. + well. + + This option may be used more + than once, or a space-separated list + of unit names may be + given. @@ -1219,55 +1265,52 @@ %N Unescaped full unit name - + Same as %n, but with escaping undone %p Prefix name - For instantiated units this refers to the string before the @. For non-instantiated units this refers to to the name of the unit with the type suffix removed. + For instantiated units this refers to the string before the @ character of the unit name. For non-instantiated units this refers to the name of the unit with the type suffix removed. %P Unescaped prefix name - + Same as %p, but with escaping undone %i Instance name - For instantiated units: this is the string between the @ character and the suffix. + For instantiated units: this is the string between the @ character and the suffix of the unit name. %I Unescaped instance name - + Same as %i, but with escaping undone %f Unescaped filename - This is either the unescaped instance name (if applicable) with / prepended (if applicable), or the prefix name similarly prepended with /. + This is either the unescaped instance name (if applicable) with / prepended (if applicable), or the prefix name prepended with /. %c Control group path of the unit - + This path does not include the /sys/fs/cgroup/systemd/ prefix. %r - Root control group path where units are placed. - For system instances, this usually resolves to /system, except in containers, where the path might be prefixed with the container's root control group. + Control group path of the slice the unit is placed in + This usually maps to the parent cgroup path of %c. %R - Parent directory of the control group path where units are placed. - For system instances, this usually - resolves to /, except in - containers, where this resolves to the - container's root directory. + Root control group path below which slices and units are placed + For system instances, this resolves to /, except in containers, where this maps to the container's root control group path. %t - Runtime socket dir - This is either /run (for the system manager) or $XDG_RUNTIME_DIR (for user managers). + Runtime directory + This is either /run (for the system manager) or the path $XDG_RUNTIME_DIR resolves to (for user managers). %u @@ -1277,17 +1320,17 @@ %U User UID - This is the UID of the configured user of the unit, or (if none is set) the user running the systemd instance. + This is the numeric UID of the configured user of the unit, or (if none is set) the user running the systemd user instance. Note that this specifier is not available for units run by the systemd system instance (as opposed to those run by a systemd user instance), unless the user has been configured as a numeric UID in the first place or the configured user is the root user. %h User home directory - This is the home directory of the configured user of the unit, or (if none is set) the user running the systemd instance. + This is the home directory of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to %U this specifier is not available for units run by the systemd system instance, unless the configured user is the root user. %s User shell - This is the shell of the configured user of the unit, or (if none is set) the user running the systemd instance. If the user is root (UID equal to 0), the shell configured in account database is ignored and /bin/sh is always used. + This is the shell of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to %U this specifier is not available for units run by the systemd system instance, unless the configured user is the root user. %m @@ -1302,17 +1345,17 @@ %H Host name - The hostname of the running system. + The hostname of the running system at the point in time the unit configuation is loaded. %v Kernel release - Identical to uname -r output. + Identical to uname -r output %% - Escaped % - Single percent sign. + Single percent sign + Use %% in place of % to specify a single percent sign.