X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=897f99f24cd64fe434ee8481907208a2a2005f4a;hp=dd32e5505cb67493e0b271d236d8b5d84a4ddf26;hb=8ab49c12dcab02d9d83e63a93676d4fc8f709516;hpb=0aef434548f43ce2635620e7f97073aa3e23cf96
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index dd32e5505..897f99f24 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -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 appropiate 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
@@ -485,8 +542,8 @@
argument. If
this unit will not be included in
snapshots. Defaults to
- for device and
- snapshot units,
+ for device and
+ snapshot units,
for the others.
@@ -607,11 +664,16 @@
ConditionPathExists=
+ ConditionPathExistsGlob=ConditionPathIsDirectory=
+ ConditionPathIsSymbolicLink=
+ ConditionPathIsMountPoint=ConditionDirectoryNotEmpty=
+ ConditionFileIsExecutable=ConditionKernelCommandLine=ConditionVirtualization=ConditionSecurity=
+ ConditionCapability=ConditionNull=Before starting a unit
@@ -621,7 +683,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
@@ -631,12 +693,34 @@
ConditionPathExists=
is prefixed with an exclamation mark
(!), the test is negated, and the unit
- only started if the path does not
- exist. ConditionPathIsDirectory=
+ 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. 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. ConditionFileIsExecutable=
is similar to
ConditionPathExists=
but verifies whether a certain path
- exists and is a directory.
+ exists, is a regular file and marked
+ executable.
ConditionDirectoryNotEmpty=
is similar to
ConditionPathExists=
@@ -664,25 +748,47 @@
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
- test may be negated by prepending an
- exclamation mark.
+ bochs,
+ chroot,
+ openvz,
+ lxc,
+ systemd-nspawn,
+ pidns 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=
- 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,
+ 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. 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
@@ -704,7 +810,10 @@
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.
@@ -836,7 +945,8 @@
systemd.target5,
systemd.path5,
systemd.timer5,
- systemd.snapshot5
+ systemd.snapshot5,
+ capabilities7