X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=4437510df7c08fcba821aba97416df3e50ee5ff7;hp=fa8821afe5a7c94b19578666511841f88dd4ec45;hb=8571962ca31a468959eedce26fda278587327ba5;hpb=039655a40c77f88e4f9ccc00824f2f483f22f2c1
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index fa8821afe..4437510df 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -139,7 +139,10 @@
with the enable command of the
systemctl1
tool which reads information from the [Install]
- section of unit files. (See below.)
+ section of unit files. (See below.) A similar
+ functionality exists for Requires=
+ type dependencies as well, the directory suffix is
+ .requires/ in this case.
Note that while systemd offers a flexible
dependency system between units it is recommended to
@@ -177,22 +180,86 @@
and no file by that name is found, systemd will look
for getty@.service and
instantiate a service from that configuration file if
- it is found. To refer to the instance string from
+ it is found.
+
+ To refer to the instance string from
within the configuration file you may use the special
%i specifier in many of the
- configuration options. Other specifiers that may be
- used are %n, %N,
- %p, %P,
- %I and %f, for
- the full unit name, the unescaped unit name, the
- prefix name, the unescaped prefix name, the unescaped
- instance name and the unescaped filename,
- respectively. The unescaped filename is either the
- unescaped instance name (if set) with / prepended (if
- necessary), or the prefix name similarly prepended
- with /. The prefix name here refers to the string
- before the @, i.e. "getty" in the example above, where
- "tty3" is the instance name.
+ configuration options. Other specifiers exist, the
+ full list is:
+
+
+ Specifiers available in unit files
+
+
+
+
+
+
+ Specifier
+ Meaning
+ Details
+
+
+
+
+ %n
+ Full unit name
+
+
+
+ %N
+ Unescaped full unit name
+
+
+
+ %p
+ Prefix name
+ This refers to the string before the @, i.e. "getty" in the example above, where "tty3" is the instance name.
+
+
+ %P
+ Unescaped prefix name
+
+
+
+ %i
+ Instance name
+ This is the string between the @ character and the suffix.
+
+
+ %I
+ Unescaped instance name
+
+
+
+ %f
+ Unescaped file name
+ This is either the unescaped instance name (if set) with / prepended (if necessary), or the prefix name similarly prepended with /.
+
+
+ %c
+ Control group path of the unit
+
+
+
+ %r
+ Root control group path of systemd
+
+
+
+ %R
+ Parent directory of the root control group path of systemd
+
+
+
+ %t
+ Runtime socket dir
+ This is either /run (for the system manager) or $XDG_RUNTIME_DIR (for user managers).
+
+
+
+
If a unit file is empty (i.e. has the file size
0) or is symlinked to /dev/null
@@ -216,21 +283,6 @@
dependent on the type of unit:
-
- Names=
-
- Additional names for
- this unit. 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. Note
- that this option is different from the
- Alias= option from
- the [Install] section mentioned
- below. See below for details.
-
- Description=
@@ -456,6 +508,44 @@
state.
+
+ OnFailureIsolate=
+
+ Takes a boolean
+ argument. If the
+ unit listed in
+ OnFailure= will be
+ enqueued in isolation mode, i.e. all
+ units that are not its dependency will
+ be stopped. If this is set only a
+ single unit may be listed in
+ OnFailure=. Defaults
+ to
+ .
+
+
+
+ IgnoreOnIsolate=
+
+ Takes a boolean
+ argument. If
+ this unit will not be stopped when
+ isolating another unit. Defaults to
+ .
+
+
+
+ IgnoreOnSnapshot=
+
+ Takes a boolean
+ argument. If
+ this unit will not be included in
+ snapshots. Defaults to
+ for device and
+ snapshot units,
+ for the others.
+
+
StopWhenUnneeded=
@@ -573,19 +663,24 @@
ConditionPathExists=
+ ConditionPathExistsGlob=
+ ConditionPathIsDirectory=
+ ConditionPathIsMountPoint=ConditionDirectoryNotEmpty=
+ ConditionFileIsExecutable=ConditionKernelCommandLine=ConditionVirtualization=
+ ConditionSecurity=ConditionNull=Before starting a unit
verify that the specified condition is
true. With
ConditionPathExists=
- a file existance condition can be
+ a file existence condition can be
checked before a unit is started. If
the specified absolute path name does
- not exist startup of a unit will not
+ not exist, startup of a unit will not
actually happen, however the unit is
still useful for ordering purposes in
this case. The condition is checked at
@@ -595,11 +690,33 @@
ConditionPathExists=
is prefixed with an exclamation mark
(!), the test is negated, and the unit
- only started if the path does not
- exist. ConditionDirectoryNotEmpty=
+ is only started if the path does not
+ exist.
+ ConditionPathExistsGlob=
+ works in a similar way, but checks for
+ the existence of at least one file or
+ directory matching the specified
+ globbing
+ pattern. ConditionPathIsDirectory=
+ is similar to
+ ConditionPathExists=
+ but verifies whether a certain path
+ exists and is a
+ directory. ConditionPathIsMountPoint=
+ is similar to
+ ConditionPathExists=
+ but verifies whether a certain path
+ exists and is a mount
+ point. ConditionFileIsExecutable=
is similar to
ConditionPathExists=
- but verifies whether a certain path is
+ but verifies whether a certain path
+ exists, is a regular file and marked
+ executable.
+ ConditionDirectoryNotEmpty=
+ is similar to
+ ConditionPathExists=
+ but verifies whether a certain path
exists and is a non-empty
directory. Similarly
ConditionKernelCommandLine=
@@ -622,18 +739,26 @@
environment and optionally test
whether it is a specific
implementation. Takes either boolean
- value to check if being executed in any
- virtual environment or one of the
+ value to check if being executed in
+ any virtual environment or one of the
qemu,
kvm,
vmware,
microsoft,
oracle,
xen,
+ pidns,
openvz to test
against a specific implementation. The
test may be negated by prepending an
- exclamation mark. Finally,
+ exclamation mark.
+ ConditionSecurity=
+ may be used to check whether the given
+ security module is enabled on the
+ system. Currently the only recognized
+ value is selinux.
+ The test may be negated by prepending
+ an exclamation mark. Finally,
ConditionNull= may
be used to add a constant condition
check value to the unit. It takes a
@@ -642,9 +767,50 @@
will always fail, otherwise
succeed. If multiple conditions are
specified the unit will be executed if
- at least one of them applies (i.e. a
- logical OR is
- applied).
+ all of them apply (i.e. a logical AND
+ is applied). Condition checks can be
+ prefixed with a pipe symbol (|) in
+ which case a condition becomes a
+ triggering condition. If at least one
+ triggering condition is defined for a
+ unit then the unit will be executed if
+ at least one of the triggering
+ conditions apply and all of the
+ non-triggering conditions. If you
+ prefix an argument with the pipe
+ symbol and an exclamation mark the
+ pipe symbol must be passed first, the
+ exclamation second. All path checks
+ follow symlinks.
+
+
+
+ Names=
+
+ Additional names for
+ this unit. 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. Note
+ that this option is different from the
+ Alias= option from
+ the [Install] section mentioned
+ below. See below for details. Note
+ that in almost all cases this option
+ is not what you want. A symlink alias
+ in the file system is generally
+ preferable since it can be used as
+ lookup key. If a unit with a symlinked
+ alias name is not loaded and needs to
+ be it is easily found via the
+ symlink. However, if a unit with an
+ alias name configured with this
+ setting is not loaded it will not be
+ discovered. This settings' only use is
+ in conjunction with service
+ instances.
+