X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=d61426a8454be353561054d80b0d3c53f6b2963b;hp=c6325d373a506e4cc0ddd1751782b427325fb1eb;hb=1bee43de64aadb700dcb32958372714ec56c97b8;hpb=6f47d17c3c594bd6b0923ed1801f9ad706966d52;ds=sidebyside
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index c6325d373..d61426a84 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -126,9 +126,9 @@
Unit files may contain additional options on top
of those listed here. If systemd encounters an unknown
- option it will write a warning log message but
+ option, it will write a warning log message but
continue loading the unit. If an option is prefixed
- with it is ignored completely by
+ with , it is ignored completely by
systemd. Applications may use this to include
additional information in the unit files.
@@ -136,7 +136,7 @@
written in various formats. For positive settings the
strings , ,
and are
- equivalent. For negative settings the strings
+ equivalent. For negative settings, the strings
, ,
and are
equivalent.
@@ -160,14 +160,14 @@
space character. This may be used to wrap long lines.
Along with a unit file
- foo.service the directory
+ foo.service, the directory
foo.service.wants/ may exist. All
unit files symlinked from such a directory are
implicitly added as dependencies of type
Wanted= to the unit. This is useful
to hook units into the start-up of other units,
without having to modify their unit files. For details
- about the semantics of Wanted= see
+ about the semantics of Wanted=, see
below. The preferred way to create symlinks in the
.wants/ directory of a unit file
is with the enable command of the
@@ -179,7 +179,7 @@
.requires/ in this case.Along with a unit file
- foo.service a directory
+ foo.service, a directory
foo.service.d/ may exist. All
files with the suffix .conf from
this directory will be parsed after the file itself is
@@ -206,7 +206,7 @@
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
+ 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 filename. Basically,
given a path, "/" is replaced by "-", and all
@@ -219,7 +219,7 @@
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
+ 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
@@ -238,7 +238,7 @@
configuration options. See below for details.If a unit file is empty (i.e. has the file size
- 0) or is symlinked to /dev/null
+ 0) or is symlinked to /dev/null,
its configuration will not be loaded and it appears
with a load state of masked, and
cannot be activated. Use this as an effective way to
@@ -359,7 +359,15 @@
describing the unit. This is intended
for use in UIs to show descriptive
information along with the unit
- name.
+ name. The description should contain a name
+ that means something to the end user.
+ Apache2 Web Server is a good
+ example. Bad examples are
+ high-performance light-weight HTTP
+ server (too generic) or
+ Apache2 (too specific and
+ meaningless for people who do not know
+ Apache).
@@ -453,7 +461,7 @@
the start-up was pulled in indirectly
by some dependency or automatic
start-up of units that is not
- requested by the user this dependency
+ requested by the user, this dependency
must be fulfilled and otherwise the
transaction fails. Hence, this option
may be used to configure dependencies
@@ -616,7 +624,7 @@
type After= or
Before=. If two
units have no ordering dependencies
- between them they are shut down
+ between them, they are shut down
or started up simultaneously, and
no ordering takes
place.
@@ -664,12 +672,12 @@
OnFailureIsolate=Takes a boolean
- argument. If the
+ argument. If , the
unit listed in
OnFailure= will be
enqueued in isolation mode, i.e. all
units that are not its dependency will
- be stopped. If this is set only a
+ be stopped. If this is set, only a
single unit may be listed in
OnFailure=. Defaults
to
@@ -680,7 +688,7 @@
IgnoreOnIsolate=Takes a boolean
- argument. If
+ argument. If ,
this unit will not be stopped when
isolating another unit. Defaults to
.
@@ -690,7 +698,7 @@
IgnoreOnSnapshot=Takes a boolean
- argument. If
+ argument. If ,
this unit will not be included in
snapshots. Defaults to
for device and
@@ -702,7 +710,7 @@
StopWhenUnneeded=Takes a boolean
- argument. If
+ argument. If ,
this unit will be stopped when it is
no longer used. Note that in order to
minimize the work to be executed,
@@ -721,10 +729,10 @@
RefuseManualStop=Takes a boolean
- argument. If
+ argument. If ,
this unit can only be activated
or deactivated indirectly. In
- this case explicit start-up
+ this case, explicit start-up
or termination requested by the
user is denied, however if it is
started or stopped as a
@@ -744,10 +752,10 @@
AllowIsolate=Takes a boolean
- argument. If
+ argument. If ,
this unit may be used with the
systemctl isolate
- command. Otherwise this will be
+ command. Otherwise, this will be
refused. It probably is a good idea to
leave this disabled except for target
units that shall be used similar to
@@ -761,7 +769,7 @@
DefaultDependencies=Takes a boolean
- argument. If
+ argument. If ,
(the default), a few default
dependencies will implicitly be
created for the unit. The actual
@@ -791,7 +799,7 @@
When clients are
waiting for a job of this unit to
complete, time out after the specified
- time. If this time limit is reached
+ time. If this time limit is reached,
the job will be cancelled, the unit
however will not change state or even
enter the failed
@@ -833,7 +841,7 @@
Before starting a unit
verify that the specified condition is
- true. If it is not true the starting
+ true. If it is not true, the starting
of the unit will be skipped, however
all ordering dependencies of it are
still respected. A failing condition
@@ -848,7 +856,7 @@
a file existence condition is
checked before a unit is started. If
the specified absolute path name does
- not exist the condition will
+ not exist, the condition will
fail. If the absolute path name passed
to
ConditionPathExists=
@@ -958,7 +966,7 @@
systemd-nspawn to
test against a specific
implementation. If multiple
- virtualization technologies are nested
+ virtualization technologies are nested,
only the innermost is considered. The
test may be negated by prepending an
exclamation mark.
@@ -1008,12 +1016,12 @@
battery powered at the time of
activation of the unit. This takes a
boolean argument. If set to
- true the condition
+ true, the condition
will hold only if at least one AC
connector of the system is connected
to a power source, or if no AC
connectors are known. Conversely, if
- set to false the
+ set to false, the
condition will hold only if there is
at least one AC connector known and
all AC connectors are disconnected
@@ -1024,30 +1032,30 @@
be used to add a constant condition
check value to the unit. It takes a
boolean argument. If set to
- false the condition
+ false, the condition
will always fail, otherwise
succeed.If multiple conditions are
- specified the unit will be executed if
+ specified, the unit will be executed if
all of them apply (i.e. a logical AND
is applied). Condition checks can be
prefixed with a pipe symbol (|) in
which case a condition becomes a
triggering condition. If at least one
triggering condition is defined for a
- unit then the unit will be executed if
+ unit, then the unit will be executed if
at least one of the triggering
conditions apply and all of the
non-triggering conditions. If you
prefix an argument with the pipe
- symbol and an exclamation mark the
+ symbol and an exclamation mark, the
pipe symbol must be passed first, the
exclamation second. Except for
ConditionPathIsSymbolicLink=,
all path checks follow symlinks. If
any of these options is assigned the
- empty string the list of conditions is
+ empty string, the list of conditions is
reset completely, all previous
condition settings (of any kind) will
have no effect.