X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=a14e452fa36f5f869680ab40a91ab77a156df51b;hb=3eb1395706ca0a00ac15d59098a0250b0377e6b5;hp=49103dad56d8610e1d3f20feb0f50a51c9d14a9c;hpb=a7be37a5014f5d7f8aa372915943611fe1112834;p=elogind.git
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 49103dad5..a14e452fa 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -173,7 +173,7 @@
Along with a unit file
foo.service a directory
foo.service.d/ may exist. All
- files with the suffix .conf from
+ files with the suffix .conf from
this directory will be parsed after the file itself is
parsed. This is useful to alter or add configuration
settings to a unit, without having to modify their
@@ -182,7 +182,7 @@
directive.If a line starts with
- followed by a file name, the specified file will be
+ followed by a filename, the specified file will be
parsed at this point. Make sure that the file that is
included has the appropriate section headers before
any directives.
@@ -195,12 +195,12 @@
in a both simpler and more flexible system.
Some unit names reflect paths existing in the
- file system name space. Example: a device unit
+ file system namespace. Example: a device unit
dev-sda.device refers to a device
with the device node /dev/sda in
the file system namespace. If this applies a special
way to escape the path name is used, so that the
- result is usable as part of a file name. Basically,
+ result is usable as part of a filename. Basically,
given a path, "/" is replaced by "-", and all
unprintable characters and the "-" are replaced by
C-style "\x20" escapes. The root directory "/" is
@@ -214,9 +214,9 @@
systemd looks for a unit configuration file it will
first search for the literal unit name in the
filesystem. If that yields no success and the unit
- name contains an @ character, systemd will look for a
+ name contains an @ character, systemd will look for a
unit template that shares the same name but with the
- instance string (i.e. the part between the @ character
+ instance string (i.e. the part between the @ character
and the suffix) removed. Example: if a service
getty@tty3.service is requested
and no file by that name is found, systemd will look
@@ -382,7 +382,7 @@
Documentation=
- A space separated list
+ A space-separated list
of URIs referencing documentation for
this unit or its
configuration. Accepted are only URIs
@@ -393,7 +393,7 @@
info:,
man:. For more
information about the syntax of these
- URIs see
+ URIs, see
uri7. The
URIs should be listed in order of
relevance, starting with the most
@@ -405,7 +405,7 @@
option may be specified more than once
in which case the specified list of
URIs is merged. If the empty string is
- assigned to this option the list is
+ assigned to this option, the list is
reset and all prior assignments will
have no effect.
@@ -646,7 +646,7 @@
Lists one or more
units that are activated when this
unit enters the
- 'failed'
+ failed
state.
@@ -669,8 +669,8 @@
RequiresMountsFor=
- Takes a space
- separated list of absolute paths. Automatically
+ Takes a space-separated
+ list of absolute paths. Automatically
adds dependencies of type
Requires= and
After= for all
@@ -797,7 +797,7 @@
highly recommended to leave this
option enabled for the majority of
common units. If set to
- this option
+ , this option
does not disable all implicit
dependencies, just non-essential
ones.
@@ -812,7 +812,7 @@
time. If this time limit is reached
the job will be cancelled, the unit
however will not change state or even
- enter the 'failed'
+ enter the failed
mode. This value defaults to 0 (job
timeouts disabled), except for device
units. NB: this timeout is independent
@@ -871,7 +871,7 @@
to
ConditionPathExists=
is prefixed with an exclamation mark
- ('!'), the test is negated, and the unit
+ (!), the test is negated, and the unit
is only started if the path does not
exist.
@@ -940,7 +940,7 @@
exclamation mark unset). The argument
must either be a single word, or an
assignment (i.e. two words, separated
- '='). In the former
+ =). In the former
case the kernel command line is
searched for the word appearing as is,
or as left hand side of an
@@ -983,9 +983,11 @@
ConditionSecurity=
may be used to check whether the given
security module is enabled on the
- system. Currently the only recognized
- values are selinux
- and apparmor.
+ system. Currently the recognized values
+ values are selinux,
+ apparmor,
+ ima and
+ smack.
The test may be negated by prepending
an exclamation
mark.
@@ -1005,11 +1007,11 @@
ConditionHost=
may be used to match against the
- host name or machine ID of the
- host. This either takes a host name
+ hostname or machine ID of the
+ host. This either takes a hostname
string (optionally with shell style
globs) which is tested against the
- locally set host name as returned by
+ locally set hostname as returned by
gethostname2,
or a machine ID formatted as string
(see
@@ -1106,26 +1108,53 @@
time,
systemctl enable
will create symlinks from these names
- to the unit file name.
+ to the unit filename.WantedBy=RequiredBy=
- Installs a symlink in
- the .wants/
- or .requires/
- subdirectory for a unit, respectively. This has the
- effect that when the listed unit name
- is activated the unit listing it is
- activated
- too. WantedBy=foo.service
+ A symbolic link is
+ created in the
+ .wants/ or
+ .requires/ folder
+ of the listed unit when this unit is
+ activated by systemctl
+ enable. This has the effect
+ that a dependency of type
+ Wants= or
+ Requires= is added
+ from the listed unit to the current
+ unit. The primary result is that the
+ current unit will be started when the
+ listed unit is started. See the
+ description of
+ Wants= and
+ Requires= in the
+ [Unit] section for details.
+
+ WantedBy=foo.service
in a service
bar.service is
mostly equivalent to
Alias=foo.service.wants/bar.service
- in the same file.
+ in the same file. In case of template
+ units, systemctl enable
+ must be called with an instance name, and
+ this instance will be added to the
+ .wants/ or
+ .requires/ list
+ of the listed unit.
+ E.g. WantedBy=getty.target
+ in a service
+ getty@.service
+ will result in systemctl
+ enable getty@tty2.service
+ creating a
+ getty.target.wants/getty@tty2.service
+ link to getty@.service.
+
@@ -1196,7 +1225,7 @@
%iInstance name
- For instantiated units: this is the string between the @ character and the suffix.
+ For instantiated units: this is the string between the @ character and the suffix.%I
@@ -1205,7 +1234,7 @@
%f
- Unescaped file name
+ Unescaped filenameThis is either the unescaped instance name (if applicable) with / prepended (if applicable), or the prefix name similarly prepended with /.
@@ -1261,7 +1290,7 @@
%HHost name
- The host name of the running system.
+ The hostname of the running system.%%