X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=93fb37b72b3f674eab50da7a09eece7ec1cb977e;hb=94163dd54328780b4539e7296eb0ba75b7290367;hp=f4821821518bff3c2bb498bd29a60ef17466eebe;hpb=7e2bb92dcae6ee785ff7462aadc8c369fd93715b;p=elogind.git
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index f48218215..93fb37b72 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -8,16 +8,16 @@
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
@@ -121,8 +121,9 @@
If a line starts with
followed by a file name, the specified file will be
- read as if its contents were listed in place of the
- directive.
+ parsed at this point. Make sure that the file that is
+ included has the appropriate section headers before
+ any directives.
Along with a unit file
foo.service a directory
@@ -180,30 +181,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, %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, 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. The runtime socket
- directory is either /run (for the
- system manager) or $XDG_RUNTIME_DIR
- (for user managers).
+ 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
@@ -237,6 +294,23 @@
name.
+
+ Documentation=
+ A space separated list
+ of URIs referencing documentation for
+ this unit or its
+ configuration. Accepted are only URIs
+ of the types
+ http://,
+ https://,
+ file:,
+ info:,
+ man:. For more
+ information about the syntax of these
+ URIs see
+ uri7.
+
+
Requires=
@@ -452,6 +526,34 @@
state.
+
+ PropagateReloadTo=
+ PropagateReloadFrom=
+
+ 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.
+
+
+
+ RequiresMountsFor=
+
+ Takes a space
+ separated list of paths. Automatically
+ adds dependencies of type
+ Requires= and
+ After= for all
+ mount units required to access the
+ specified path.
+
+
OnFailureIsolate=
@@ -609,10 +711,15 @@
ConditionPathExists=ConditionPathExistsGlob=ConditionPathIsDirectory=
+ ConditionPathIsSymbolicLink=
+ ConditionPathIsMountPoint=
+ ConditionPathIsReadWrite=ConditionDirectoryNotEmpty=
+ ConditionFileIsExecutable=ConditionKernelCommandLine=ConditionVirtualization=ConditionSecurity=
+ ConditionCapability=ConditionNull=Before starting a unit
@@ -622,7 +729,7 @@
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
@@ -632,17 +739,40 @@
ConditionPathExists=
is prefixed with an exclamation mark
(!), the test is negated, and the unit
- only started if the path does not
- exist. ConditionPathExistsGlob=
- work in a similar way, but checks for
- the existance of at least one file or
+ 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.
+ exists and is a
+ directory. ConditionPathIsSymbolicLink=
+ is similar to
+ ConditionPathExists=
+ but verifies whether a certain path
+ exists and is a symbolic
+ link. ConditionPathIsMountPoint=
+ is similar to
+ ConditionPathExists=
+ but verifies whether a certain path
+ exists and is a mount
+ point. ConditionPathIsReadWrite=
+ is similar to
+ ConditionPathExists=
+ but verifies whether the underlying
+ file system is read and writable
+ (i.e. not mounted
+ read-only). ConditionFileIsExecutable=
+ is similar to
+ ConditionPathExists=
+ but verifies whether a certain path
+ exists, is a regular file and marked
+ executable.
ConditionDirectoryNotEmpty=
is similar to
ConditionPathExists=
@@ -670,16 +800,27 @@
whether it is a specific
implementation. Takes either boolean
value to check if being executed in
- any virtual environment or one of the
+ any virtualized environment, or one of
+ vm and
+ container to test
+ against a specific type of
+ virtualization solution, or one of
qemu,
kvm,
vmware,
microsoft,
oracle,
xen,
- pidns,
- openvz to test
- against a specific implementation. The
+ bochs,
+ chroot,
+ openvz,
+ lxc,
+ lxc-libvirt,
+ systemd-nspawn to
+ test against a specific
+ implementation. If multiple
+ virtualization technologies are nested
+ only the innermost is considered. The
test may be negated by prepending an
exclamation mark.
ConditionSecurity=
@@ -688,7 +829,19 @@
system. Currently the only recognized
value is selinux.
The test may be negated by prepending
- an exclamation mark. Finally,
+ an exclamation
+ mark. ConditionCapability=
+ may be used to check whether the given
+ capability exists in the capability
+ bounding set of the service manager
+ (i.e. this does not check whether
+ capability is actually available in
+ the permitted or effective sets, see
+ capabilities7
+ for details). Pass a capability name
+ such as CAP_MKNOD,
+ possibly prefixed with an exclamation
+ mark to negate the check. Finally,
ConditionNull= may
be used to add a constant condition
check value to the unit. It takes a
@@ -710,36 +863,23 @@
prefix an argument with the pipe
symbol and an exclamation mark the
pipe symbol must be passed first, the
- exclamation second.
+ exclamation second. Except for
+ ConditionPathIsSymbolicLink=,
+ 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.
-
+ SourcePath=
+ A path to a
+ configuration file this unit has been
+ generated from. This is primarily
+ useful for implementation of generator
+ tools that convert configuration from
+ an external configuration file format
+ into native unit files. Thus
+ functionality should not be used in
+ normal units.
@@ -767,37 +907,16 @@
time,
systemctl enable
will create symlinks from these names
- to the unit file name. Note that this
- is different from the
- Names= option from
- the [Unit] section mentioned above:
- The names from
- Names= apply
- unconditionally if the unit is
- loaded. The names from
- Alias= apply only
- if the unit has actually been
- installed with the
- systemctl enable
- command. Also, if systemd searches for a
- unit, it will discover symlinked alias
- names as configured with
- Alias=, but not
- names configured with
- Names= only. It is
- a common pattern to list a name in
- both options. In this case, a unit
- will be active under all names if
- installed, but also if not installed
- but requested explicitly under its
- main name.
+ to the unit file name.
WantedBy=
+ RequiredBy=Installs a symlink in
the .wants/
+ resp. .requires/
subdirectory for a unit. This has the
effect that when the listed unit name
is activated the unit listing it is
@@ -842,7 +961,8 @@
systemd.target5,
systemd.path5,
systemd.timer5,
- systemd.snapshot5
+ systemd.snapshot5,
+ capabilities7