X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.service.xml;h=b1e3af2fefa485aead9214ad94c052c2fccc9b52;hb=202e6abb3d0959d8051d514ae48a140934a30f47;hp=2dd3b1977323dfc981bf656d3080bd70db2cea0a;hpb=df34f169b8961c6ef1429cdb940206b42c3f9041;p=elogind.git
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 2dd3b1977..b1e3af2fe 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -73,9 +73,12 @@
systemd.exec5,
which define the execution environment the commands
are executed in, and in
- systemd.kill5
+ systemd.kill5,
which define the way the processes of the service are
- terminated.
+ terminated, and in
+ systemd.resource-control5,
+ which configure resource control settings for the
+ processes of the service.
Unless DefaultDependencies=
is set to , service units will
@@ -137,13 +140,13 @@
If set to
(the default
value if BusName=
- is not specified) it is expected that
+ is not specified), it is expected that
the process configured with
ExecStart= is the
main process of the service. In this
mode, if the process offers
functionality to other processes on
- the system its communication channels
+ the system, its communication channels
should be installed before the daemon
is started up (e.g. sockets set up by
systemd, via socket activation), as
@@ -151,14 +154,14 @@
starting follow-up units.If set to
- it is
+ , it is
expected that the process configured
with ExecStart=
will call fork()
as part of its start-up. The parent process is
expected to exit when start-up is
complete and all communication
- channels set up. The child continues
+ channels are set up. The child continues
to run as the main daemon
process. This is the behavior of
traditional UNIX daemons. If this
@@ -207,14 +210,18 @@
starting up. systemd will proceed
starting follow-up units after this
notification message has been sent. If
- this option is used
+ this option is used,
NotifyAccess= (see
below) should be set to open access to
the notification socket provided by
systemd. If
NotifyAccess= is
not set, it will be implicitly set to
- .
+ . Note that
+ currently
+ Type=
+ will not work if used in combination with
+ PrivateNetwork=.Behavior of
is very similar
@@ -255,7 +262,7 @@
guessing algorithm might come to
incorrect conclusions if a daemon
consists of more than one process. If
- the main PID cannot be determined
+ the main PID cannot be determined,
failure detection and automatic
restarting of a service will not work
reliably. Defaults to
@@ -302,7 +309,9 @@
argument must be an absolute path
name.
- When
+ When Type is
+ not , only one
+ command may be given. When
Type=oneshot is
used, more than one command may be
specified. Multiple command lines may
@@ -316,19 +325,22 @@
for compatibility with parsers
suitable for XDG
.desktop files.
- The commands are invoked one by one
- sequentially in the order they appear
- in the unit file. When
- Type is not
- , only one
- command may be given. Lone semicolons
- may be escaped as
- '\;'. If the empty
- string is assigned to this option the
+ Lone semicolons may be escaped as
+ \;. If the empty
+ string is assigned to this option, the
list of commands to start is reset,
prior assignments of this option will
have no effect.
+ If more than one command is
+ specified, the commands are invoked
+ one by one sequentially in the order
+ they appear in the unit file. If one
+ of the commands fails (and is not
+ prefixed with -),
+ other lines are not executed and the
+ unit is considered failed.
+
Unless
Type=forking is
set, the process started via this
@@ -336,16 +348,15 @@
main process of the daemon.The command line accepts
- '%' specifiers as
+ % specifiers as
described in
systemd.unit5. Note
that the first argument of the command
line (i.e. the program to execute) may
not include specifiers.
- On top of that basic environment
- variable substitution is
- supported. Use
+ Basic environment variable
+ substitution is supported. Use
${FOO} as part of a
word, or as a word of its own on the
command line, in which case it will be
@@ -357,8 +368,9 @@
word on the command line, in which
case it will be replaced by the value
of the environment variable split up
- at whitespace, resulting in zero or more
- arguments. Note that the first
+ at whitespace, resulting in zero or
+ more arguments. To pass a literal dollar sign,
+ use $$. Note that the first
argument (i.e. the program to execute)
may not be a variable, since it must
be a literal and absolute path
@@ -366,33 +378,34 @@
Optionally, if the absolute file
name is prefixed with
- '@', the second token
+ @, the second token
will be passed as
argv[0] to the
executed process, followed by the
further arguments specified. If the
- absolute file name is prefixed with
- '-' an exit code of
+ absolute filename is prefixed with
+ -, an exit code of
the command normally considered a
failure (i.e. non-zero exit status or
abnormal exit due to signal) is ignored
and considered success. If both
- '-' and
- '@' are used they
+ - and
+ @ are used, they
can appear in either order.Note that this setting does not
directly support shell command
lines. If shell command lines are to
- be used they need to be passed
+ be used, they need to be passed
explicitly to a shell implementation
- of some kind. Example:
- ExecStart=/bin/sh -c 'dmesg | tac'
+ of some kind. Example:
+ ExecStart=/bin/sh -c 'dmesg | tac'
+ For services run by a user
instance of systemd the special
environment variable
- MANAGERPID is set
+ $MANAGERPID is set
to the PID of the systemd
instance.
@@ -410,6 +423,11 @@
that multiple command lines are allowed
and the commands are executed one
after the other, serially.
+
+ If any of those commands (not
+ prefixed with -)
+ fail, the rest are not executed and
+ the unit is considered failed.
@@ -425,14 +443,17 @@
optional. Specifier and environment
variable substitution is supported
here following the same scheme as for
- ExecStart=. One
- additional special environment
- variables is set: if known
- $MAINPID is set to
+ ExecStart=.
+
+ One additional special
+ environment variables is set: if known
+ $MAINPID is set to
the main process of the daemon, and
may be used for command lines like the
- following: /bin/kill -HUP
- $MAINPID.
+ following:
+
+ /bin/kill -HUP $MAINPID
+
@@ -451,12 +472,12 @@
KillMode= setting
(see
systemd.kill5). If
- this option is not specified the
+ this option is not specified, the
process is terminated right-away when
service stop is requested. Specifier
and environment variable substitution
is supported (including
- $MAINPID, see
+ $MAINPID, see
above).
@@ -467,7 +488,7 @@
was stopped. This includes cases where
the commands configured in
ExecStop= were used,
- where the service doesn't have any
+ where the service does not have any
ExecStop= defined, or
where the service exited unexpectedly. This
argument takes multiple command lines,
@@ -516,9 +537,9 @@
wait for stop. If a service is asked
to stop but does not terminate in the
specified time, it will be terminated
- forcibly via SIGTERM, and after
+ forcibly via SIGTERM, and after
another delay of this time with
- SIGKILL (See
+ SIGKILL (See
KillMode=
in systemd.kill5).
Takes a unit-less value in seconds, or a
@@ -540,18 +561,18 @@
WatchdogSec=Configures the
- watchdog timeout for a service. This
- is activated when the start-up is
+ watchdog timeout for a service. The
+ watchdog is activated when the start-up is
completed. The service must call
sd_notify3
regularly with "WATCHDOG=1" (i.e. the
"keep-alive ping"). If the time
between two such calls is larger than
- the configured time then the service
+ the configured time, then the service
is placed in a failure state. By
setting Restart= to
or
- the service
+ , the service
will be automatically restarted. The
time configured here will be passed to
the executed service process in the
@@ -560,7 +581,7 @@
daemons to automatically enable the
keep-alive pinging logic if watchdog
support is enabled for the service. If
- this option is used
+ this option is used,
NotifyAccess= (see
below) should be set to open access to
the notification socket provided by
@@ -575,37 +596,71 @@
Restart=Configures whether the
- main service process shall be
- restarted when it exits. Takes one of
+ service shall be restarted when the
+ service process exits, is killed,
+ or a timeout is reached. The service
+ process may be the main service
+ process, but also one of the processes
+ specified with
+ ExecStartPre=,
+ ExecStartPost=,
+ ExecStopPre=,
+ ExecStopPost=, or
+ ExecReload=.
+ When the death of the process is a
+ result of systemd operation (e.g. service
+ stop or restart), the service will not be
+ restarted. Timeouts include missing
+ the watchdog "keep-alive ping"
+ deadline and a service start, reload,
+ and stop operation timeouts.
+
+ Takes one of
,
,
,
- or
+ ,
+ , or
. If set to
- (the default) the
- service will not be restarted when it
- exits. If set to
- it will be
- restarted only when it exited cleanly,
- i.e. terminated with an exit code of
- 0. If set to
- it will be
- restarted only when it exited with an
- exit code not equaling 0, when
- terminated by a signal (including on
+ (the default), the
+ service will not be restarted. If set to
+ , it will be
+ restarted only when the service process
+ exits cleanly.
+ In this context, a clean exit means
+ an exit code of 0, or one of the signals
+ SIGHUP, SIGINT, SIGTERM, or SIGPIPE, and
+ additionally, exit statuses and signals
+ specified in SuccessExitStatus=.
+ If set to ,
+ the service will be restarted when the
+ process exits with an nonzero exit code,
+ is terminated by a signal (including on
core dump), when an operation (such as
- service reload) times out or when the
- configured watchdog timeout is
- triggered. If set to
- it will be
- restarted only if it exits due to
- reception of an uncaught signal
- (including on core dump). If set to
- the service
+ service reload) times out, and when the
+ configured watchdog timeout is triggered.
+ If set to
+ , the service
+ will be restarted only if the service
+ process exits due to an uncaught
+ signal not specified as a clean exit
+ status.
+ If set to
+ , the service
+ will be restarted only if the watchdog
+ timeout for the service expires.
+ If set to
+ , the service
will be restarted regardless whether
it exited cleanly or not, got
terminated abnormally by a signal or
- hit a timeout.
+ hit a timeout.
+
+ In addition to the above settings,
+ the service will not be restarted if the
+ exit code or signal is specified in
+ RestartPreventExitStatus=
+ (see below).
@@ -615,20 +670,20 @@
by the main service process will be
considered successful termination, in
addition to the normal successful exit
- code 0 and the signals SIGHUP, SIGINT,
- SIGTERM and SIGPIPE. Exit status
+ code 0 and the signals SIGHUP, SIGINT,
+ SIGTERM and SIGPIPE. Exit status
definitions can either be numeric exit
- codes or termination signal names, and
- are separated by spaces. Example:
- "SuccessExitStatus=1 2 8
- SIGKILL", ensures that exit
+ codes or termination signal names,
+ separated by spaces. Example:
+ SuccessExitStatus=1 2 8
+ SIGKILL, ensures that exit
codes 1, 2, 8 and the termination
- signal SIGKILL are considered clean
+ signal SIGKILL are considered clean
service terminations. This option may
appear more than once in which case
the list of successful exit statuses
is merged. If the empty string is
- assigned to this option the list is
+ assigned to this option, the list is
reset, all prior assignments of this
option will have no
effect.
@@ -650,15 +705,15 @@
that by default no exit status is
excluded from the configured restart
logic. Example:
- "RestartPreventExitStatus=1 6
- SIGABRT", ensures that exit
+ RestartPreventExitStatus=1 6
+ SIGABRT, ensures that exit
codes 1 and 6 and the termination
signal SIGABRT will not result in
automatic service restarting. This
option may appear more than once in
which case the list of restart preventing
statuses is merged. If the empty
- string is assigned to this option the
+ string is assigned to this option, the
list is reset, all prior assignments
of this option will have no
effect.
@@ -736,13 +791,13 @@
(the default),
or
. If
- no daemon status
+ , no daemon status
updates are accepted from the service
processes, all status update messages
- are ignored. If
+ are ignored. If ,
only service updates sent from the
main process of the service are
- accepted. If all
+ accepted. If , all
services updates from all members of
the service's control group are
accepted. This option should be set to
@@ -751,8 +806,8 @@
Type=notify or
WatchdogSec= (see
above). If those options are used but
- NotifyAccess= not
- configured it will be implicitly set
+ NotifyAccess= is not
+ configured, it will be implicitly set
to
.
@@ -778,7 +833,7 @@
in other words: the
Service= setting of
.socket units
- doesn't have to match the inverse of
+ does not have to match the inverse of
the Sockets=
setting of the
.service it
@@ -787,7 +842,7 @@
This option may appear more than
once, in which case the list of socket
units is merged. If the empty string
- is assigned to this option the list of
+ is assigned to this option, the list of
sockets is reset, all prior uses of
this setting will have no
effect.
@@ -798,12 +853,12 @@
StartLimitBurst=Configure service
- start rate limiting. By default
+ start rate limiting. By default,
services which are started more often
than 5 times within 10s are not
permitted to start any more times
until the 10s interval ends. With
- these two options this rate limiting
+ these two options, this rate limiting
may be modified. Use
StartLimitInterval=
to configure the checking interval
@@ -915,33 +970,6 @@
range 0-99.
-
- FsckPassNo=
- Set the fsck passno
- priority to use to order this service
- in relation to other file system
- checking services. This option is only
- necessary to fix ordering in relation
- to fsck jobs automatically created for
- all /etc/fstab
- entries with a value in the fs_passno
- column > 0. As such it should only be
- used as option for fsck
- services. Almost always it is a better
- choice to add explicit ordering
- directives via
- After= or
- Before=,
- instead. For more details see
- systemd.unit5. If
- used, pass an integer value in the
- same range as
- /etc/fstab's
- fs_passno column. See
- fstab5
- for details.
-
-
@@ -952,6 +980,7 @@
systemctl8,
systemd.unit5,
systemd.exec5,
+ systemd.resource-control5,
systemd.kill5,
systemd.directives7