X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=2a965f5a1ca57520aeabcd20a4f2bc61d95839fc;hp=35dd4c78c4cc00de502100bbab1847c863855a66;hb=6fc73498945da749744041d4e10cf8dfac5c3bc6;hpb=6a44e50f4c0938b0ba355fff21add6c067cd9837 diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 35dd4c78c..2a965f5a1 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. @@ -221,7 +232,7 @@ multiple units from a single configuration file. If systemd looks for a unit configuration file, it will first search for the literal unit name in the - filesystem. If that yields no success and the unit + file system. If that yields no success and the unit name contains an @ character, systemd will look for a unit template that shares the same name but with the instance string (i.e. the part between the @ character @@ -392,7 +403,7 @@ what the unit's purpose is, followed by how it is configured, followed by any other related documentation. This - option may be specified more than once + option may be specified more than once, in which case the specified list of URIs is merged. If the empty string is assigned to this option, the list is @@ -481,7 +492,7 @@ Requires= and RequiresOverridable=, respectively. However, if the units - listed here are not started already + listed here are not started already, they will not be started and the transaction will fail immediately. @@ -495,7 +506,7 @@ listed in this option will be started if the configuring unit is. However, if the listed units fail to start - or cannot be added to the transaction + or cannot be added to the transaction, this has no impact on the validity of the transaction as a whole. This is the recommended way to hook start-up @@ -508,7 +519,7 @@ symlinks to a .wants/ directory accompanying the unit file. For - details see above. + details, see above. @@ -517,7 +528,7 @@ Configures requirement dependencies, very similar in style to Requires=, however - in addition to this behavior it also + in addition to this behavior, it also declares that this unit is stopped when any of the units listed suddenly disappears. Units can suddenly, @@ -537,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. @@ -566,9 +577,9 @@ be modified to be fixed (in case one or both jobs are not a required part of the transaction). In the latter - case the job that is not the required + case, the job that is not the required will be removed, or in case both are - not required the unit that conflicts + not required, the unit that conflicts will be started and the unit that is conflicted is stopped. @@ -595,7 +606,7 @@ a common pattern to include a unit name in both the After= and - Requires= option in + Requires= option, in which case the unit listed will be started before the unit that is configured with these options. This @@ -623,7 +634,7 @@ dependency on another unit is shut down while the latter is started up, the shut down is ordered before the - start-up regardless whether the + start-up regardless of whether the ordering dependency is actually of type After= or Before=. If two @@ -675,13 +686,13 @@ directives (see systemd.exec5 for details). If a unit that has this - setting set is started its processes + 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 + units are already started, it is not defined which namespace is joined. Note that this setting only has an effect if @@ -968,7 +979,7 @@ exists, is a regular file and marked executable. - Similar, + Similarly, ConditionKernelCommandLine= may be used to check whether a specific kernel command line option is @@ -1254,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 @@ -1312,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 @@ -1337,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.