X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=d38a00136651b552ba94b4c513e643a5654f3a2f;hb=9e37286844f67ca7c59e923dd27ad193dfdda7eb;hp=14ec4561b2e925fc9ca74b758c16ef81b540d445;hpb=5471472d441d9ac48640f11a3b07e6a1fd6d1b63;p=elogind.git
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 14ec4561b..d38a00136 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
@@ -183,16 +186,24 @@
configuration options. Other specifiers that may be
used are %n, %N,
%p, %P,
- %I and %f, for
+ %I, %f,
+ %c, %r,
+ %R and %t for
the full unit name, the unescaped unit name, the
prefix name, the unescaped prefix name, the unescaped
- instance name and the unescaped filename,
+ instance name, the unescaped filename, the control
+ group path of the unit, the root control group path of
+ systemd, and the parent directory of the root control
+ cgroup path of systemd and the runtime socket dir,
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.
+ "tty3" is the instance name. The runtime socket
+ directory 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 +227,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 +452,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,15 +607,20 @@
ConditionPathExists=
+ ConditionPathExistsGlob=
+ ConditionPathIsDirectory=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
@@ -595,10 +634,26 @@
is prefixed with an exclamation mark
(!), the test is negated, and the unit
only started if the path does not
- exist. ConditionDirectoryNotEmpty=
+ exist. ConditionPathExistsGlob=
+ work in a similar way, but checks for
+ the existance of at least one file or
+ directory matching the specified
+ globbing
+ pattern. ConditionPathIsDirectory=
is similar to
ConditionPathExists=
- but verifies whether a certain path is
+ but verifies whether a certain path
+ exists and is a
+ directory. ConditionFileIsExecutable=
+ is similar to
+ ConditionPathExists=
+ 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=
@@ -615,7 +670,32 @@
assignment. In the latter case the
exact assignment is looked for with
right and left hand side
- matching. Finally,
+ matching. ConditionVirtualization=
+ may be used to check whether the
+ system is executed in a virtualized
+ 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
+ qemu,
+ kvm,
+ vmware,
+ microsoft,
+ oracle,
+ xen,
+ pidns,
+ openvz to test
+ against a specific implementation. The
+ test may be negated by prepending an
+ 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
@@ -623,10 +703,50 @@
false the condition
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).
+ specified the unit will be executed if
+ 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.
+
+
+
+ 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.
+