X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=286862006a9ab503027085e679a97f9eed3f668a;hb=4819ff0358b6317c195fd4b1768e03d09c871070;hp=4e2590d00636c778350e964b887e98595ee54949;hpb=ab7f148f81723ef18402b78ea34fb5e1bbe85ff0;p=elogind.git
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 4e2590d00..286862006 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 .
-->
@@ -44,7 +44,7 @@
systemd.unit
- systemd unit configuration files
+ Unit configuration
@@ -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
@@ -257,6 +258,21 @@
Runtime socket dirThis is either /run (for the system manager) or $XDG_RUNTIME_DIR (for user managers).
+
+ %u
+ User name
+ This is the name of the configured user of the unit, or (if none is set) the user running the systemd instance.
+
+
+ %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.
+
+
+ %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.
+
@@ -293,6 +309,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=
@@ -392,7 +425,7 @@
- BindTo=
+ BindsTo=Configures requirement
dependencies, very similar in style to
@@ -508,6 +541,34 @@
state.
+
+ PropagatesReloadTo=
+ ReloadPropagatedFrom=
+
+ 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=
@@ -665,12 +726,15 @@
ConditionPathExists=ConditionPathExistsGlob=ConditionPathIsDirectory=
+ ConditionPathIsSymbolicLink=ConditionPathIsMountPoint=
+ ConditionPathIsReadWrite=ConditionDirectoryNotEmpty=ConditionFileIsExecutable=ConditionKernelCommandLine=ConditionVirtualization=ConditionSecurity=
+ ConditionCapability=ConditionNull=Before starting a unit
@@ -691,7 +755,7 @@
is prefixed with an exclamation mark
(!), the test is negated, and the unit
is only started if the path does not
- exist. The test follows symlinks.
+ exist.
ConditionPathExistsGlob=
works in a similar way, but checks for
the existence of at least one file or
@@ -701,19 +765,29 @@
is similar to
ConditionPathExists=
but verifies whether a certain path
- exists and is a directory. It does not
- follow
- symlinks. ConditionPathIsMountPoint=
+ 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=
+ 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. It follows symlinks.
+ executable.
ConditionDirectoryNotEmpty=
is similar to
ConditionPathExists=
@@ -741,16 +815,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=
@@ -759,7 +844,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
@@ -781,36 +878,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.
@@ -838,37 +922,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
@@ -913,7 +976,8 @@
systemd.target5,
systemd.path5,
systemd.timer5,
- systemd.snapshot5
+ systemd.snapshot5,
+ capabilities7