X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=a06eed58618011b1225d589185af682bb4dc32c2;hb=b4f10a5e8956d26f0bc6b9aef12846b57caee08b;hp=99bd8b3906f06a9c7256b8636b8b59706ed8a034;hpb=11e299550e832659095d7bf833e4e8fc1971ef1e;p=elogind.git
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 99bd8b390..a06eed586 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -56,7 +56,8 @@
systemd.swap,
systemd.target,
systemd.path,
- systemd.timer
+ systemd.timer,
+ systemd.snapshot
@@ -70,7 +71,7 @@
systemd1. The
syntax is inspired by XDG
- Desktop Entry Specificiation.desktop files, which are in turn
+ Desktop Entry Specification .desktop files, which are in turn
inspired by Microsoft Windows
.ini files.
@@ -94,7 +95,7 @@
additional information in the unit files.
Boolean arguments used in unit files can be
- written in various forms. For positive settings the
+ written in various formats. For positive settings the
strings , ,
and are
equivalent. For negative settings the strings
@@ -102,8 +103,21 @@
and are
equivalent.
+ Time span values encoded in unit files can be
+ written in various formats. A stand-alone number
+ specifies a time in seconds. If suffixed with a time
+ unit, the unit is honored. A concatenation of
+ multiple value with units is supported, in which case
+ the values are added up. Example: "50" refers to 50
+ seconds; "2min 200ms" refers to 2 minutes plus 200
+ milliseconds, i.e. 120200ms. The following time units
+ are understood: s, min, h, d, w, ms, us.
+
Empty lines and lines starting with # or ; are
- ignored. This may be used for commenting.
+ ignored. This may be used for commenting. Lines ending
+ in a backslash are concatenated with the following
+ line while reading and the backslash is replaced by a
+ space character. This may be used to wrap long lines.
If a line starts with
followed by a file name the specified file will be
@@ -134,6 +148,47 @@
activation which makes dependencies implicit, which
both results in a simpler and more flexible
system.
+
+ Some unit names reflect paths existing in the
+ file system name space. 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 it is
+ usable as part of a file name. Basically, given a
+ path, "/" is replaced by "-", and all unprintable
+ characters and the "-" are replaced by C-style "\x20"
+ escapes. The root directory "/" is encoded as single
+ dash, while otherwise the initial and ending "/" is
+ removed from all paths during transformation. This
+ escaping is reversible.
+
+ Optionally, units may be instantiated from a
+ template file at runtime. This allows creation of
+ multiple units from a single configuration file. If
+ 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
+ unit template that shares the same name but with the
+ 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
+ for getty@.service and
+ instantiate a service from that configuration file if
+ 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 and
+ %I, for the full unit name, the
+ unescaped unit name, the prefix name, the unescaped
+ prefix name and the unescaped instance name,
+ respectively. The prefix name here refers to the
+ string before the @, i.e. "getty" in the example
+ above, where "tty3" is the instance name.
@@ -163,10 +218,10 @@
Description=A free-form string
- describing the unit. This is intended for use
- in UIs wanting to show
- descriptive information along with the
- unit name.
+ describing the unit. This is intended
+ for use in UIs to show descriptive
+ information along with the unit
+ name.
@@ -227,7 +282,7 @@
must be fulfilled and otherwise the
transaction fails. Hence, this option
may be used to configure dependencies
- that are normally honoured unless the
+ that are normally honored unless the
user explicitly starts up the unit, in
which case whether they failed or not
is irrelevant.
@@ -393,12 +448,40 @@
dependency of another unit start-up
will succeed. This is mostly a safety
feature to ensure that the user does
- not accidently activate units that are
+ not accidentally activate units that are
not intended to be activated
explicitly. This option defaults to
.
+
+ DefaultDependencies=
+
+ Takes a boolean
+ argument. If
+ (the default), a few default
+ dependencies will implicitly be
+ created for the unit. The actual
+ dependencies created depend on the
+ unit type. For example, for service
+ units, these dependencies ensure that
+ the service is started only after
+ basic system initialization is
+ complete and is properly terminated on
+ system shutdown. See the respective
+ man pages for details. Generally, only
+ services involved with early boot or
+ late shutdown should set this option
+ to . It is
+ highly recommended to leave this
+ option enabled for the majority of
+ common units. If set to
+ this option
+ does not disable all implicit
+ dependencies, just non-essential
+ ones.
+
+
Unit file may include a [Install] section, which
@@ -420,7 +503,7 @@
name. This option may be specified
more than once, in which case all
listed names are used. At installation
- time
+ time,
systemd-install
will create symlinks from these names
to the unit file name. Note that this
@@ -458,7 +541,7 @@
effect that when the listed unit name
is activated the unit listing it is
activated
- to. WantedBy=foo.service
+ too. WantedBy=foo.service
in a service
bar.service is
mostly equivalent to
@@ -498,7 +581,8 @@
systemd.swap5,
systemd.target5,
systemd.path5,
- systemd.timer5
+ systemd.timer5,
+ systemd.snapshot5