X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.service.xml;h=e4fa6bcc7c6fc14177c774754c74854352c0082a;hp=8005a51a472150f8a9fce31f50c21ad7148237f2;hb=b24a167b6f0f9a44686736734e6d0cec07e1efa3;hpb=65232ea79d8f6b1288c33852f89b575a9200162d
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 8005a51a4..e4fa6bcc7 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -64,24 +64,52 @@
systemd.unit5
for the common options of all unit configuration
files. The common configuration items are configured
- in the generic [Unit] and [Install] sections. The
- service specific configuration options are configured
- in the [Service] section.
-
- Additional options are listed in systemd.exec5.
+ in the generic [Unit] and
+ [Install] sections. The service
+ specific configuration options are configured in the
+ [Service] section.
+
+ Additional options are listed in
+ systemd.exec5,
+ which define the execution environment the commands
+ are executed in.
+
+ Unless DefaultDependencies=
+ is set to , service units will
+ implicitly have dependencies of type
+ Requires= and
+ After= on
+ basic.target as well as
+ dependencies of type Conflicts= and
+ Before= on
+ shutdown.target. These ensure
+ that normal service units pull in basic system
+ initialization, and are terminated cleanly prior to
+ system shutdown. Only services involved with early
+ boot or late system shutdown should disable this
+ option.
+
+ If a service is requested under a certain name
+ but no unit configuration file is found, systemd looks
+ for a SysV init script by the same name (with the
+ .service suffix removed) and
+ dynamically creates a service unit from that
+ script. This is useful for compatibility with
+ SysV.Options
- Service files must include a [Service] section,
- which carries information about the service and the
- process it supervises. A number of options that may be
- used in this section are shared with other unit
- types. These options are documented in
+ Service files must include a
+ [Service] section, which carries
+ information about the service and the process it
+ supervises. A number of options that may be used in
+ this section are shared with other unit types. These
+ options are documented in
systemd.exec5. The
- options specific to the [Service] section of service
- units are the following:
+ options specific to the [Service]
+ section of service units are the following:
@@ -91,7 +119,7 @@
start-up type for this service
unit. One of ,
,
- ,
+ ,
,
.
@@ -101,25 +129,27 @@
configured with
ExecStart= is the
main process of the service. In this
- mode, communication channels must be
- installed before the daemon is started
- up (e.g. sockets set up by systemd,
- via socket activation), as systemd
- will immediately proceed starting
- follow-up units.
+ mode, if the process offers
+ functionality to other processes on
+ 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
+ systemd will immediately proceed
+ starting follow-up units.
If set to
it is
expected that the process configured
with ExecStart=
- will start up and call
- fork(). The
- parent process is expected to finish
- when start-up is complete and all
- communication channels set up. The
- child continues to run as the main
- daemon process. This is the behaviour
- of traditional UNIX daemons. If this
+ 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
+ to run as the main daemon
+ process. This is the behaviour of
+ traditional UNIX daemons. If this
setting is used, it is recommended to
also use the
PIDFile= option, so
@@ -130,24 +160,28 @@
exits.Behaviour of
- is similar
+ is similar
to , however
it is expected that the process has to
exit before systemd starts follow-up
- units. ValidNoProcess=
+ units. RemainAfterExit=
is particularly useful for this type
of service.Behaviour of
is similar to
- , however it
- is expected that the daemon acquires a
+ , however it is
+ expected that the daemon acquires a
name on the D-Bus bus, as configured
by
BusName=. systemd
will proceed starting follow-up units
after the D-Bus bus name has been
- acquired.
+ acquired. Service units with this
+ option configured implicitly gain
+ dependencies on the
+ dbus.target
+ unit.
Behaviour of
is similar to
@@ -160,15 +194,18 @@
starting follow-up units after this
notification message has been sent. If
this option is used
- (see
- below) must be set to open access to
+ NotifyAccess= (see
+ below) should be set to open access to
the notification socket provided by
- systemd.
+ systemd. If
+ NotifyAccess= is not
+ set, it will implicitly be set to
+ .
- ValidNoProcess=
+ RemainAfterExit=Takes a boolean value
that specifies whether the service
@@ -215,17 +252,51 @@
arguments for the process. It is
mandatory to set this option for all
services. This option may not be
- specified more than once. Optionally,
- if the absolute file name is prefixed
- with @, the second token will be
- passed as argv[0] to the executed
- process, followed by the further
- arguments specified. Unless
- is set,
- the process started via this command
- line will be considered the main
- process of the
- daemon.
+ specified more than once, except when
+ Type=oneshot is
+ used in which case more than one
+ ExecStart= line is
+ accepted which are then invoked one by
+ one, sequentially in the order they
+ appear in the unit file.
+
+ Optionally, if the absolute file
+ name is prefixed with
+ @, the second token
+ will be passed as
+ argv[0] to the
+ executed process, followed by the
+ further arguments specified. If the
+ first token 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 for the
+ same command the former must precede
+ the latter. Unless
+ Type=forking is
+ set, the process started via this
+ command line will be considered the
+ main process of the daemon. The
+ command line accepts % specifiers as
+ described in
+ systemd.unit5. On
+ top of that basic environment variable
+ substitution is supported, where
+ ${FOO} is replaced
+ by the string value of the environment
+ variable of the same name. Also
+ $FOO may appear as
+ separate word on the command line in
+ which case the variable is replaced by
+ its value split at whitespaces. Note
+ that the first argument (i.e. the
+ binary to execute) may not be a
+ variable, and must be a literal and
+ absolute path name.
@@ -234,31 +305,58 @@
Additional commands
that are executed before (resp. after)
the command in
- ExecStart=. If
- specified more than once, all commands
- are executed one after the other,
- serially. Use of these settings is
- optional.
+ ExecStart=. Multiple
+ command lines may be concatenated in a
+ single directive, by separating them
+ by semicolons (these semicolons must
+ be passed as separate words). In that
+ case, the commands are executed one
+ after the other,
+ serially. Alternatively, these
+ directives may be specified more than
+ once with the same effect. However,
+ the latter syntax is not recommended
+ for compatibility with parsers
+ suitable for XDG
+ .desktop files.
+ Use of these settings is
+ optional. Specifier and environment
+ variable substitution is
+ supported.
ExecReload=Commands to execute to
trigger a configuration reload in the
- service. If used more than once, all
- commands are executed one after the
- other, serially. Use of this setting is optional.
-
+ service. This argument takes multiple
+ command lines, following the same
+ scheme as pointed out for
+ ExecStartPre=
+ above. Use of this setting is
+ optional. Specifier and environment
+ variable substitution is supported
+ here following the same scheme as for
+ ExecStart=. One
+ special environment variable 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.
ExecStop=Commands to execute to
stop the service started via
- ExecStart=. If used
- more than once, all commands are
- executed one after the other,
- serially. Use of this setting is
+ ExecStart=. This
+ argument takes multiple command lines,
+ following the same scheme as pointed
+ out for
+ ExecStartPre=
+ above. Use of this setting is
optional. All processes remaining for
a service after the commands
configured in this option are run are
@@ -267,7 +365,11 @@
(see below). If this option is not
specified the process is terminated
right-away when service stop is
- requested.
+ requested. Specifier and environment
+ variable substitution is supported
+ (including
+ $MAINPID, see
+ above).
@@ -276,11 +378,15 @@
that are executed after the service
was stopped using the commands
configured in
- ExecStop=. If
- specified more than once, all commands
- are executed one after the other,
- serially. Use of these settings is
- optional.
+ ExecStop=. This
+ argument takes multiple command lines,
+ following the same scheme as pointed
+ out for
+ ExecStartPre. Use
+ of these settings is
+ optional. Specifier and environment
+ variable substitution is
+ supported.
@@ -309,7 +415,7 @@
forcibly via SIGTERM, and after
another delay of this time with
SIGKILL. (See
-
+ KillMode=
below.) Takes a unit-less value in seconds, or a
time span value such as "5min
20s". Pass 0 to disable the timeout
@@ -320,19 +426,28 @@
Restart=Configures whether the
- main service process shall be restarted when
- it exists. Takes one of
- ,
- 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
- the
+ main service process shall be
+ restarted when it exits. Takes one of
+ ,
+ ,
+ ,
+ 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 equalling 0, or when
+ terminated by a signal. If set to
+ it will be
+ restarted only if it exits due to
+ reception of an uncaught signal. If
+ set to the
service will be restarted regardless
whether it exited cleanly or not, or
got terminated abnormally by a
@@ -442,12 +557,12 @@
group and the control group continues
to exist after stop unless it is
empty. Defaults to
- .
+ .
Processes will first be
terminated via SIGTERM. If then after
a delay (configured via the
- option)
+ TimeoutSec= option)
processes still remain, the
termination request is repeated with
the SIGKILL signal. See
@@ -482,7 +597,7 @@
or
. If
no daemon status
- updates are accepted by the service
+ updates are accepted from the service
processes, all status update messages
are ignored. If
only service updates sent from the
@@ -496,13 +611,67 @@
Type=notify (see above).
+
+ Sockets=
+ Specifies the name of
+ the socket units this service shall
+ inherit the sockets from when the
+ service (ignoring the different suffix
+ of course) is started. Normally it
+ should not be necessary to use this
+ setting as all sockets whose unit
+ shares the same name as the service
+ are passed to the spawned
+ process.
+
+ Note that the same socket may be
+ passed to multiple processes at the
+ same time. Also note that a different
+ service may be activated on incoming
+ traffic than inherits the sockets. Or
+ in other words: The
+ Service= setting of
+ .socket units
+ doesn't have to match the inverse of the
+ Sockets= setting of
+ the .service it
+ refers to.
+
+
+
+ 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.
+
+
See Also
- systemd8,
+ systemd1,
systemctl8,
systemd.unit5,
systemd.exec5