]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.service.xml
shared/bus-util: fix dbus serialization of {RestartPrevent,RestartForce,Success}ExitS...
[thirdparty/systemd.git] / man / systemd.service.xml
CommitLineData
514094f9 1<?xml version='1.0'?>
3a54a157 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
0307f791 4<!-- SPDX-License-Identifier: LGPL-2.1+ -->
d1ab0ca0
LP
5
6<refentry id="systemd.service">
798d3a52
ZJS
7 <refentryinfo>
8 <title>systemd.service</title>
9 <productname>systemd</productname>
798d3a52
ZJS
10 </refentryinfo>
11
12 <refmeta>
13 <refentrytitle>systemd.service</refentrytitle>
14 <manvolnum>5</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>systemd.service</refname>
19 <refpurpose>Service unit configuration</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <para><filename><replaceable>service</replaceable>.service</filename></para>
24 </refsynopsisdiv>
25
26 <refsect1>
27 <title>Description</title>
28
29 <para>A unit configuration file whose name ends in
ed10715a 30 <literal>.service</literal> encodes information about a process
798d3a52
ZJS
31 controlled and supervised by systemd.</para>
32
33 <para>This man page lists the configuration options specific to
34 this unit type. See
35 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
36 for the common options of all unit configuration files. The common
37 configuration items are configured in the generic
38 <literal>[Unit]</literal> and <literal>[Install]</literal>
39 sections. The service specific configuration options are
40 configured in the <literal>[Service]</literal> section.</para>
41
42 <para>Additional options are listed in
43 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
44 which define the execution environment the commands are executed
45 in, and in
46 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
47 which define the way the processes of the service are terminated,
48 and in
49 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
50 which configure resource control settings for the processes of the
51 service.</para>
52
798d3a52
ZJS
53 <para>If a service is requested under a certain name but no unit
54 configuration file is found, systemd looks for a SysV init script
55 by the same name (with the <filename>.service</filename> suffix
56 removed) and dynamically creates a service unit from that script.
57 This is useful for compatibility with SysV. Note that this
58 compatibility is quite comprehensive but not 100%. For details
59 about the incompatibilities, see the <ulink
28a0ad81 60 url="https://www.freedesktop.org/wiki/Software/systemd/Incompatibilities">Incompatibilities
c129bd5d 61 with SysV</ulink> document.</para>
438e6a48
LP
62
63 <para>The <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
64 command allows creating <filename>.service</filename> and <filename>.scope</filename> units dynamically
65 and transiently from the command line.</para>
c129bd5d
LP
66 </refsect1>
67
68 <refsect1>
75695fb7
ZJS
69 <title>Service Templates</title>
70
71 <para>It is possible for <command>systemd</command> services to take a single argument via the
72 <literal><replaceable>service</replaceable>@<replaceable>argument</replaceable>.service</literal>
73 syntax. Such services are called "instantiated" services, while the unit definition without the
74 <replaceable>argument</replaceable> parameter is called a "template". An example could be a
75 <filename>dhcpcd@.service</filename> service template which takes a network interface as a
76 parameter to form an instantiated service. Within the service file, this parameter or "instance
77 name" can be accessed with %-specifiers. See
78 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
79 for details.</para>
798d3a52
ZJS
80 </refsect1>
81
45f09f93 82 <refsect1>
aed5cb03
ZJS
83 <title>Automatic Dependencies</title>
84
85 <refsect2>
86 <title>Implicit Dependencies</title>
87
88 <para>The following dependencies are implicitly added:</para>
89
90 <itemizedlist>
91 <listitem><para>Services with <varname>Type=dbus</varname> set automatically
92 acquire dependencies of type <varname>Requires=</varname> and
93 <varname>After=</varname> on
94 <filename>dbus.socket</filename>.</para></listitem>
95
96 <listitem><para>Socket activated services are automatically ordered after
97 their activating <filename>.socket</filename> units via an
98 automatic <varname>After=</varname> dependency.
99 Services also pull in all <filename>.socket</filename> units
100 listed in <varname>Sockets=</varname> via automatic
101 <varname>Wants=</varname> and <varname>After=</varname> dependencies.</para></listitem>
102 </itemizedlist>
103
104 <para>Additional implicit dependencies may be added as result of
105 execution and resource control parameters as documented in
106 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
107 and
108 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
109 </refsect2>
110
111 <refsect2>
112 <title>Default Dependencies</title>
113
114 <para>The following dependencies are added unless <varname>DefaultDependencies=no</varname> is set:</para>
115
116 <itemizedlist>
117 <listitem><para>Service units will have dependencies of type <varname>Requires=</varname> and
118 <varname>After=</varname> on <filename>sysinit.target</filename>, a dependency of type <varname>After=</varname> on
119 <filename>basic.target</filename> as well as dependencies of type <varname>Conflicts=</varname> and
120 <varname>Before=</varname> on <filename>shutdown.target</filename>. These ensure that normal service units pull in
121 basic system initialization, and are terminated cleanly prior to system shutdown. Only services involved with early
122 boot or late system shutdown should disable this option.</para></listitem>
123
124 <listitem><para>Instanced service units (i.e. service units with an <literal>@</literal> in their name) are assigned by
125 default a per-template slice unit (see
126 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>), named after the
127 template unit, containing all instances of the specific template. This slice is normally stopped at shutdown,
128 together with all template instances. If that is not desired, set <varname>DefaultDependencies=no</varname> in the
129 template unit, and either define your own per-template slice unit file that also sets
130 <varname>DefaultDependencies=no</varname>, or set <varname>Slice=system.slice</varname> (or another suitable slice)
131 in the template unit. Also see
132 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
133 </para></listitem>
134 </itemizedlist>
135 </refsect2>
45f09f93
JL
136 </refsect1>
137
798d3a52
ZJS
138 <refsect1>
139 <title>Options</title>
140
141 <para>Service files must include a <literal>[Service]</literal>
142 section, which carries information about the service and the
143 process it supervises. A number of options that may be used in
144 this section are shared with other unit types. These options are
145 documented in
aa9f9e58
LW
146 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
147 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
798d3a52 148 and
aa9f9e58 149 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
798d3a52
ZJS
150 The options specific to the <literal>[Service]</literal> section
151 of service units are the following:</para>
152
153 <variablelist class='unit-directives'>
154 <varlistentry>
155 <term><varname>Type=</varname></term>
156
79905a24
LP
157 <listitem>
158 <para>Configures the process start-up type for this service unit. One of <option>simple</option>,
159 <option>exec</option>, <option>forking</option>, <option>oneshot</option>, <option>dbus</option>,
160 <option>notify</option> or <option>idle</option>:</para>
161
162 <itemizedlist>
163 <listitem><para>If set to <option>simple</option> (the default if <varname>ExecStart=</varname> is
164 specified but neither <varname>Type=</varname> nor <varname>BusName=</varname> are), the service manager
165 will consider the unit started immediately after the main service process has been forked off. It is
166 expected that the process configured with <varname>ExecStart=</varname> is the main process of the
167 service. In this mode, if the process offers functionality to other processes on the system, its
168 communication channels should be installed before the service is started up (e.g. sockets set up by
169 systemd, via socket activation), as the service manager will immediately proceed starting follow-up units,
170 right after creating the main service process, and before executing the service's binary. Note that this
171 means <command>systemctl start</command> command lines for <option>simple</option> services will report
172 success even if the service's binary cannot be invoked successfully (for example because the selected
173 <varname>User=</varname> doesn't exist, or the service binary is missing).</para></listitem>
174
175 <listitem><para>The <option>exec</option> type is similar to <option>simple</option>, but the service
176 manager will consider the unit started immediately after the main service binary has been executed. The service
177 manager will delay starting of follow-up units until that point. (Or in other words:
178 <option>simple</option> proceeds with further jobs right after <function>fork()</function> returns, while
179 <option>exec</option> will not proceed before both <function>fork()</function> and
180 <function>execve()</function> in the service process succeeded.) Note that this means <command>systemctl
181 start</command> command lines for <option>exec</option> services will report failure when the service's
182 binary cannot be invoked successfully (for example because the selected <varname>User=</varname> doesn't
183 exist, or the service binary is missing).</para></listitem>
184
185 <listitem><para>If set to <option>forking</option>, it is expected that the process configured with
186 <varname>ExecStart=</varname> will call <function>fork()</function> as part of its start-up. The parent
187 process is expected to exit when start-up is complete and all communication channels are set up. The child
188 continues to run as the main service process, and the service manager will consider the unit started when
189 the parent process exits. This is the behavior of traditional UNIX services. If this setting is used, it is
190 recommended to also use the <varname>PIDFile=</varname> option, so that systemd can reliably identify the
191 main process of the service. systemd will proceed with starting follow-up units as soon as the parent
192 process exits.</para></listitem>
193
bfcb9d3a
LP
194 <listitem><para>Behavior of <option>oneshot</option> is similar to <option>simple</option>;
195 however, the service manager will consider the unit up after the main process exits. It will then
196 start follow-up units. <varname>RemainAfterExit=</varname> is particularly useful for this type
197 of service. <varname>Type=</varname><option>oneshot</option> is the implied default if neither
198 <varname>Type=</varname> nor <varname>ExecStart=</varname> are specified. Note that if this
199 option is used without <varname>RemainAfterExit=</varname> the service will never enter
200 <literal>active</literal> unit state, but directly transition from <literal>activating</literal>
201 to <literal>deactivating</literal> or <literal>dead</literal> since no process is configured that
202 shall run continously. In particular this means that after a service of this type ran (and which
203 has <varname>RemainAfterExit=</varname> not set) it will not show up as started afterwards, but
204 as dead.</para></listitem>
79905a24
LP
205
206 <listitem><para>Behavior of <option>dbus</option> is similar to <option>simple</option>; however, it is
207 expected that the service acquires a name on the D-Bus bus, as configured by
208 <varname>BusName=</varname>. systemd will proceed with starting follow-up units after the D-Bus bus name
209 has been acquired. Service units with this option configured implicitly gain dependencies on the
210 <filename>dbus.socket</filename> unit. This type is the default if <varname>BusName=</varname> is
211 specified.</para></listitem>
212
213 <listitem><para>Behavior of <option>notify</option> is similar to <option>exec</option>; however, it is
214 expected that the service sends a notification message via
215 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> or an
216 equivalent call when it has finished starting up. systemd will proceed with starting follow-up units after
217 this notification message has been sent. If this option is used, <varname>NotifyAccess=</varname> (see
218 below) should be set to open access to the notification socket provided by systemd. If
219 <varname>NotifyAccess=</varname> is missing or set to <option>none</option>, it will be forcibly set to
220 <option>main</option>. Note that currently <varname>Type=</varname><option>notify</option> will not work if
221 used in combination with <varname>PrivateNetwork=</varname><option>yes</option>.</para></listitem>
222
223 <listitem><para>Behavior of <option>idle</option> is very similar to <option>simple</option>; however,
224 actual execution of the service program is delayed until all active jobs are dispatched. This may be used
225 to avoid interleaving of output of shell services with the status output on the console. Note that this
226 type is useful only to improve console output, it is not useful as a general unit ordering tool, and the
3f9a0a52 227 effect of this service type is subject to a 5s timeout, after which the service program is invoked
79905a24
LP
228 anyway.</para></listitem>
229 </itemizedlist>
230
231 <para>It is generally recommended to use <varname>Type=</varname><option>simple</option> for long-running
232 services whenever possible, as it is the simplest and fastest option. However, as this service type won't
233 propagate service start-up failures and doesn't allow ordering of other units against completion of
234 initialization of the service (which for example is useful if clients need to connect to the service through
235 some form of IPC, and the IPC channel is only established by the service itself — in contrast to doing this
236 ahead of time through socket or bus activation or similar), it might not be sufficient for many cases. If so,
237 <option>notify</option> or <option>dbus</option> (the latter only in case the service provides a D-Bus
238 interface) are the preferred options as they allow service program code to precisely schedule when to
239 consider the service started up successfully and when to proceed with follow-up units. The
240 <option>notify</option> service type requires explicit support in the service codebase (as
241 <function>sd_notify()</function> or an equivalent API needs to be invoked by the service at the appropriate
242 time) — if it's not supported, then <option>forking</option> is an alternative: it supports the traditional
243 UNIX service start-up protocol. Finally, <option>exec</option> might be an option for cases where it is
244 enough to ensure the service binary is invoked, and where the service binary itself executes no or little
245 initialization on its own (and its initialization is unlikely to fail). Note that using any type other than
246 <option>simple</option> possibly delays the boot process, as the service manager needs to wait for service
247 initialization to complete. It is hence recommended not to needlessly use any types other than
248 <option>simple</option>. (Also note it is generally not recommended to use <option>idle</option> or
249 <option>oneshot</option> for long-running services.)</para>
798d3a52
ZJS
250 </listitem>
251 </varlistentry>
252
253 <varlistentry>
254 <term><varname>RemainAfterExit=</varname></term>
255
256 <listitem><para>Takes a boolean value that specifies whether
257 the service shall be considered active even when all its
258 processes exited. Defaults to <option>no</option>.</para>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry>
263 <term><varname>GuessMainPID=</varname></term>
264
265 <listitem><para>Takes a boolean value that specifies whether
266 systemd should try to guess the main PID of a service if it
267 cannot be determined reliably. This option is ignored unless
268 <option>Type=forking</option> is set and
269 <option>PIDFile=</option> is unset because for the other types
270 or with an explicitly configured PID file, the main PID is
271 always known. The guessing algorithm might come to incorrect
272 conclusions if a daemon consists of more than one process. If
273 the main PID cannot be determined, failure detection and
274 automatic restarting of a service will not work reliably.
275 Defaults to <option>yes</option>.</para>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry>
280 <term><varname>PIDFile=</varname></term>
281
a9353a5c
LP
282 <listitem><para>Takes a path referring to the PID file of the service. Usage of this option is recommended for
283 services where <varname>Type=</varname> is set to <option>forking</option>. The path specified typically points
284 to a file below <filename>/run/</filename>. If a relative path is specified it is hence prefixed with
285 <filename>/run/</filename>. The service manager will read the PID of the main process of the service from this
286 file after start-up of the service. The service manager will not write to the file configured here, although it
287 will remove the file after the service has shut down if it still exists. The PID file does not need to be owned
288 by a privileged user, but if it is owned by an unprivileged user additional safety restrictions are enforced:
289 the file may not be a symlink to a file owned by a different user (neither directly nor indirectly), and the
290 PID file must refer to a process already belonging to the service.</para></listitem>
798d3a52
ZJS
291 </varlistentry>
292
293 <varlistentry>
294 <term><varname>BusName=</varname></term>
295
296 <listitem><para>Takes a D-Bus bus name that this service is
297 reachable as. This option is mandatory for services where
298 <varname>Type=</varname> is set to
299 <option>dbus</option>.</para>
300 </listitem>
301 </varlistentry>
302
798d3a52
ZJS
303 <varlistentry>
304 <term><varname>ExecStart=</varname></term>
305 <listitem><para>Commands with their arguments that are
306 executed when this service is started. The value is split into
a8eaaee7 307 zero or more command lines according to the rules described
798d3a52
ZJS
308 below (see section "Command Lines" below).
309 </para>
310
29df65f9
ZJS
311 <para>Unless <varname>Type=</varname> is <option>oneshot</option>, exactly one command must be given. When
312 <varname>Type=oneshot</varname> is used, zero or more commands may be specified. Commands may be specified by
313 providing multiple command lines in the same directive, or alternatively, this directive may be specified more
314 than once with the same effect. If the empty string is assigned to this option, the list of commands to start
315 is reset, prior assignments of this option will have no effect. If no <varname>ExecStart=</varname> is
e4b45b32
LP
316 specified, then the service must have <varname>RemainAfterExit=yes</varname> and at least one
317 <varname>ExecStop=</varname> line set. (Services lacking both <varname>ExecStart=</varname> and
318 <varname>ExecStop=</varname> are not valid.)</para>
798d3a52 319
5008da1e
ZJS
320 <para>For each of the specified commands, the first argument must be either an absolute path to an executable
321 or a simple file name without any slashes. Optionally, this filename may be prefixed with a number of special
322 characters:</para>
165a31c0
LP
323
324 <table>
325 <title>Special executable prefixes</title>
326
327 <tgroup cols='2'>
328 <colspec colname='prefix'/>
329 <colspec colname='meaning'/>
330
331 <thead>
332 <row>
333 <entry>Prefix</entry>
334 <entry>Effect</entry>
335 </row>
336 </thead>
337 <tbody>
338 <row>
339 <entry><literal>@</literal></entry>
340 <entry>If the executable path is prefixed with <literal>@</literal>, the second specified token will be passed as <literal>argv[0]</literal> to the executed process (instead of the actual filename), followed by the further arguments specified.</entry>
341 </row>
342
343 <row>
344 <entry><literal>-</literal></entry>
6e021090 345 <entry>If the executable path is prefixed with <literal>-</literal>, an exit code of the command normally considered a failure (i.e. non-zero exit status or abnormal exit due to signal) is recorded, but has no further effect and is considered equivalent to success.</entry>
165a31c0
LP
346 </row>
347
7ca69792
AZ
348 <row>
349 <entry><literal>:</literal></entry>
350 <entry>If the executable path is prefixed with <literal>:</literal>, environment variable substitution (as described by the "Command Lines" section below) is not applied.</entry>
351 </row>
352
165a31c0
LP
353 <row>
354 <entry><literal>+</literal></entry>
355 <entry>If the executable path is prefixed with <literal>+</literal> then the process is executed with full privileges. In this mode privilege restrictions configured with <varname>User=</varname>, <varname>Group=</varname>, <varname>CapabilityBoundingSet=</varname> or the various file system namespacing options (such as <varname>PrivateDevices=</varname>, <varname>PrivateTmp=</varname>) are not applied to the invoked command line (but still affect any other <varname>ExecStart=</varname>, <varname>ExecStop=</varname>, … lines).</entry>
356 </row>
357
358 <row>
359 <entry><literal>!</literal></entry>
360
7fc97da0 361 <entry>Similar to the <literal>+</literal> character discussed above this permits invoking command lines with elevated privileges. However, unlike <literal>+</literal> the <literal>!</literal> character exclusively alters the effect of <varname>User=</varname>, <varname>Group=</varname> and <varname>SupplementaryGroups=</varname>, i.e. only the stanzas that affect user and group credentials. Note that this setting may be combined with <varname>DynamicUser=</varname>, in which case a dynamic user/group pair is allocated before the command is invoked, but credential changing is left to the executed process itself.</entry>
165a31c0
LP
362 </row>
363
364 <row>
365 <entry><literal>!!</literal></entry>
366
132523e7 367 <entry>This prefix is very similar to <literal>!</literal>, however it only has an effect on systems lacking support for ambient process capabilities, i.e. without support for <varname>AmbientCapabilities=</varname>. It's intended to be used for unit files that take benefit of ambient capabilities to run processes with minimal privileges wherever possible while remaining compatible with systems that lack ambient capabilities support. Note that when <literal>!!</literal> is used, and a system lacking ambient capability support is detected any configured <varname>SystemCallFilter=</varname> and <varname>CapabilityBoundingSet=</varname> stanzas are implicitly modified, in order to permit spawned processes to drop credentials and capabilities themselves, even if this is configured to not be allowed. Moreover, if this prefix is used and a system lacking ambient capability support is detected <varname>AmbientCapabilities=</varname> will be skipped and not be applied. On systems supporting ambient capabilities, <literal>!!</literal> has no effect and is redundant.</entry>
165a31c0
LP
368 </row>
369 </tbody>
370 </tgroup>
371 </table>
372
7ca69792 373 <para><literal>@</literal>, <literal>-</literal>, <literal>:</literal>, and one of
165a31c0 374 <literal>+</literal>/<literal>!</literal>/<literal>!!</literal> may be used together and they can appear in any
ee905de0 375 order. However, only one of <literal>+</literal>, <literal>!</literal>, <literal>!!</literal> may be used at a
165a31c0 376 time. Note that these prefixes are also supported for the other command line settings,
78a263f4 377 i.e. <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecReload=</varname>,
165a31c0 378 <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname>.</para>
798d3a52
ZJS
379
380 <para>If more than one command is specified, the commands are
381 invoked sequentially in the order they appear in the unit
382 file. If one of the commands fails (and is not prefixed with
383 <literal>-</literal>), other lines are not executed, and the
384 unit is considered failed.</para>
385
386 <para>Unless <varname>Type=forking</varname> is set, the
387 process started via this command line will be considered the
388 main process of the daemon.</para>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry>
393 <term><varname>ExecStartPre=</varname></term>
394 <term><varname>ExecStartPost=</varname></term>
395 <listitem><para>Additional commands that are executed before
396 or after the command in <varname>ExecStart=</varname>,
397 respectively. Syntax is the same as for
398 <varname>ExecStart=</varname>, except that multiple command
399 lines are allowed and the commands are executed one after the
400 other, serially.</para>
401
402 <para>If any of those commands (not prefixed with
403 <literal>-</literal>) fail, the rest are not executed and the
404 unit is considered failed.</para>
b481de3b 405
12e2683d
RM
406 <para><varname>ExecStart=</varname> commands are only run after
407 all <varname>ExecStartPre=</varname> commands that were not prefixed
408 with a <literal>-</literal> exit successfully.</para>
409
80af263b
LP
410 <para><varname>ExecStartPost=</varname> commands are only run after the commands specified in
411 <varname>ExecStart=</varname> have been invoked successfully, as determined by <varname>Type=</varname>
412 (i.e. the process has been started for <varname>Type=simple</varname> or <varname>Type=idle</varname>, the last
413 <varname>ExecStart=</varname> process exited successfully for <varname>Type=oneshot</varname>, the initial
414 process exited successfully for <varname>Type=forking</varname>, <literal>READY=1</literal> is sent for
415 <varname>Type=notify</varname>, or the <varname>BusName=</varname> has been taken for
416 <varname>Type=dbus</varname>).</para>
12e2683d 417
b481de3b
LP
418 <para>Note that <varname>ExecStartPre=</varname> may not be
419 used to start long-running processes. All processes forked
420 off by processes invoked via <varname>ExecStartPre=</varname> will
421 be killed before the next service process is run.</para>
ce359e98
LP
422
423 <para>Note that if any of the commands specified in <varname>ExecStartPre=</varname>,
424 <varname>ExecStart=</varname>, or <varname>ExecStartPost=</varname> fail (and are not prefixed with
425 <literal>-</literal>, see above) or time out before the service is fully up, execution continues with commands
426 specified in <varname>ExecStopPost=</varname>, the commands in <varname>ExecStop=</varname> are skipped.</para>
798d3a52
ZJS
427 </listitem>
428 </varlistentry>
429
31cd5f63
AZ
430 <varlistentry>
431 <term><varname>ExecCondition=</varname></term>
432 <listitem><para>Optional commands that are executed before the command(s) in <varname>ExecStartPre=</varname>.
433 Syntax is the same as for <varname>ExecStart=</varname>, except that multiple command lines are allowed and the
434 commands are executed one after the other, serially.</para>
435
436 <para>The behavior is like an <varname>ExecStartPre=</varname> and condition check hybrid: when an
437 <varname>ExecCondition=</varname> command exits with exit code 1 through 254 (inclusive), the remaining
438 commands are skipped and the unit is <emphasis>not</emphasis> marked as failed. However, if an
439 <varname>ExecCondition=</varname> command exits with 255 or abnormally (e.g. timeout, killed by a
440 signal, etc.), the unit will be considered failed (and remaining commands will be skipped). Exit code of 0 or
441 those matching <varname>SuccessExitStatus=</varname> will continue execution to the next command(s).</para>
442
443 <para>The same recommendations about not running long-running processes in <varname>ExecStartPre=</varname>
444 also applies to <varname>ExecCondition=</varname>. <varname>ExecCondition=</varname> will also run the commands
445 in <varname>ExecStopPost=</varname>, as part of stopping the service, in the case of any non-zero or abnormal
446 exits, like the ones described above.</para>
447 </listitem>
448 </varlistentry>
449
798d3a52
ZJS
450 <varlistentry>
451 <term><varname>ExecReload=</varname></term>
452 <listitem><para>Commands to execute to trigger a configuration
453 reload in the service. This argument takes multiple command
454 lines, following the same scheme as described for
455 <varname>ExecStart=</varname> above. Use of this setting is
456 optional. Specifier and environment variable substitution is
457 supported here following the same scheme as for
458 <varname>ExecStart=</varname>.</para>
459
460 <para>One additional, special environment variable is set: if
461 known, <varname>$MAINPID</varname> is set to the main process
462 of the daemon, and may be used for command lines like the
463 following:</para>
464
465 <programlisting>/bin/kill -HUP $MAINPID</programlisting>
466
467 <para>Note however that reloading a daemon by sending a signal
468 (as with the example line above) is usually not a good choice,
469 because this is an asynchronous operation and hence not
470 suitable to order reloads of multiple services against each
471 other. It is strongly recommended to set
472 <varname>ExecReload=</varname> to a command that not only
473 triggers a configuration reload of the daemon, but also
474 synchronously waits for it to complete.</para>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry>
479 <term><varname>ExecStop=</varname></term>
480 <listitem><para>Commands to execute to stop the service
481 started via <varname>ExecStart=</varname>. This argument takes
482 multiple command lines, following the same scheme as described
483 for <varname>ExecStart=</varname> above. Use of this setting
484 is optional. After the commands configured in this option are
23656d2b
AY
485 run, it is implied that the service is stopped, and any processes
486 remaining for it are terminated
798d3a52
ZJS
487 according to the <varname>KillMode=</varname> setting (see
488 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
cceb20c7
LP
489 If this option is not specified, the process is terminated by
490 sending the signal specified in <varname>KillSignal=</varname>
491 when service stop is requested. Specifier and environment
492 variable substitution is supported (including
493 <varname>$MAINPID</varname>, see above).</para>
494
99479986
FS
495 <para>Note that it is usually not sufficient to specify a command for this setting that only asks the service
496 to terminate (for example, by queuing some form of termination signal for it), but does not wait for it to do
497 so. Since the remaining processes of the services are killed according to <varname>KillMode=</varname> and
498 <varname>KillSignal=</varname> as described above immediately after the command exited, this may not result in
499 a clean stop. The specified command should hence be a synchronous operation, not an asynchronous one.</para>
ce359e98
LP
500
501 <para>Note that the commands specified in <varname>ExecStop=</varname> are only executed when the service
07ff561c 502 started successfully first. They are not invoked if the service was never started at all, or in case its
ce359e98
LP
503 start-up failed, for example because any of the commands specified in <varname>ExecStart=</varname>,
504 <varname>ExecStartPre=</varname> or <varname>ExecStartPost=</varname> failed (and weren't prefixed with
505 <literal>-</literal>, see above) or timed out. Use <varname>ExecStopPost=</varname> to invoke commands when a
3aaae27a
ZJS
506 service failed to start up correctly and is shut down again. Also note that the stop operation is always
507 performed if the service started successfully, even if the processes in the service terminated on their
508 own or were killed. The stop commands must be prepared to deal with that case. <varname>$MAINPID</varname>
509 will be unset if systemd knows that the main process exited by the time the stop commands are called.</para>
510
511 <para>Service restart requests are implemented as stop operations followed by start operations. This
512 means that <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> are executed during a
513 service restart operation.</para>
514
515 <para>It is recommended to use this setting for commands that communicate with the service requesting
516 clean termination. For post-mortem clean-up steps use <varname>ExecStopPost=</varname> instead.
517 </para></listitem>
798d3a52
ZJS
518 </varlistentry>
519
520 <varlistentry>
521 <term><varname>ExecStopPost=</varname></term>
ce359e98
LP
522 <listitem><para>Additional commands that are executed after the service is stopped. This includes cases where
523 the commands configured in <varname>ExecStop=</varname> were used, where the service does not have any
524 <varname>ExecStop=</varname> defined, or where the service exited unexpectedly. This argument takes multiple
525 command lines, following the same scheme as described for <varname>ExecStart=</varname>. Use of these settings
526 is optional. Specifier and environment variable substitution is supported. Note that – unlike
527 <varname>ExecStop=</varname> – commands specified with this setting are invoked when a service failed to start
528 up correctly and is shut down again.</para>
529
530 <para>It is recommended to use this setting for clean-up operations that shall be executed even when the
531 service failed to start up correctly. Commands configured with this setting need to be able to operate even if
532 the service failed starting up half-way and left incompletely initialized data around. As the service's
533 processes have been terminated already when the commands specified with this setting are executed they should
136dc4c4
LP
534 not attempt to communicate with them.</para>
535
536 <para>Note that all commands that are configured with this setting are invoked with the result code of the
537 service, as well as the main process' exit code and status, set in the <varname>$SERVICE_RESULT</varname>,
538 <varname>$EXIT_CODE</varname> and <varname>$EXIT_STATUS</varname> environment variables, see
539 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
540 details.</para></listitem>
798d3a52
ZJS
541 </varlistentry>
542
543 <varlistentry>
544 <term><varname>RestartSec=</varname></term>
545 <listitem><para>Configures the time to sleep before restarting
546 a service (as configured with <varname>Restart=</varname>).
547 Takes a unit-less value in seconds, or a time span value such
548 as "5min 20s". Defaults to 100ms.</para></listitem>
549 </varlistentry>
550
551 <varlistentry>
552 <term><varname>TimeoutStartSec=</varname></term>
553 <listitem><para>Configures the time to wait for start-up. If a
554 daemon service does not signal start-up completion within the
555 configured time, the service will be considered failed and
556 will be shut down again. Takes a unit-less value in seconds,
557 or a time span value such as "5min 20s". Pass
2c29d332 558 <literal>infinity</literal> to disable the timeout logic. Defaults to
798d3a52
ZJS
559 <varname>DefaultTimeoutStartSec=</varname> from the manager
560 configuration file, except when
561 <varname>Type=oneshot</varname> is used, in which case the
562 timeout is disabled by default (see
563 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
a327431b
DB
564 </para>
565
566 <para>If a service of <varname>Type=notify</varname> sends <literal>EXTEND_TIMEOUT_USEC=…</literal>, this may cause
567 the start time to be extended beyond <varname>TimeoutStartSec=</varname>. The first receipt of this message
568 must occur before <varname>TimeoutStartSec=</varname> is exceeded, and once the start time has exended beyond
569 <varname>TimeoutStartSec=</varname>, the service manager will allow the service to continue to start, provided
570 the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified until the service
571 startup status is finished by <literal>READY=1</literal>. (see
572 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
798d3a52
ZJS
573 </para></listitem>
574 </varlistentry>
575
576 <varlistentry>
577 <term><varname>TimeoutStopSec=</varname></term>
9a6da355
JS
578 <listitem><para>This option serves two purposes. First, it configures the time to wait for each
579 <constant>ExecStop=</constant> command. If any of them times out, subsequent <constant>ExecStop=</constant> commands
580 are skipped and the service will be terminated by <constant>SIGTERM</constant>. If no <constant>ExecStop=</constant>
581 commands are specified, the service gets the <constant>SIGTERM</constant> immediately. Second, it configures the time
582 to wait for the service itself to stop. If it doesn't terminate in the specified time, it will be forcibly terminated
583 by <constant>SIGKILL</constant> (see <varname>KillMode=</varname> in
798d3a52
ZJS
584 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
585 Takes a unit-less value in seconds, or a time span value such
2c29d332 586 as "5min 20s". Pass <literal>infinity</literal> to disable the
798d3a52
ZJS
587 timeout logic. Defaults to
588 <varname>DefaultTimeoutStopSec=</varname> from the manager
589 configuration file (see
590 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
a327431b
DB
591 </para>
592
593 <para>If a service of <varname>Type=notify</varname> sends <literal>EXTEND_TIMEOUT_USEC=…</literal>, this may cause
594 the stop time to be extended beyond <varname>TimeoutStopSec=</varname>. The first receipt of this message
595 must occur before <varname>TimeoutStopSec=</varname> is exceeded, and once the stop time has exended beyond
596 <varname>TimeoutStopSec=</varname>, the service manager will allow the service to continue to stop, provided
597 the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified, or terminates itself
598 (see <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
798d3a52
ZJS
599 </para></listitem>
600 </varlistentry>
601
dc653bf4
JK
602 <varlistentry>
603 <term><varname>TimeoutAbortSec=</varname></term>
604 <listitem><para>This option configures the time to wait for the service to terminate when it was aborted due to a
605 watchdog timeout (see <varname>WatchdogSec=</varname>). If the service has a short <varname>TimeoutStopSec=</varname>
606 this option can be used to give the system more time to write a core dump of the service. Upon expiration the service
607 will be forcibly terminated by <constant>SIGKILL</constant> (see <varname>KillMode=</varname> in
608 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). The core file will
609 be truncated in this case. Use <varname>TimeoutAbortSec=</varname> to set a sensible timeout for the core dumping per
610 service that is large enough to write all expected data while also being short enough to handle the service failure
611 in due time.
612 </para>
613
614 <para>Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass an empty value to skip
615 the dedicated watchdog abort timeout handling and fall back <varname>TimeoutStopSec=</varname>. Pass
616 <literal>infinity</literal> to disable the timeout logic. Defaults to <varname>DefaultTimeoutAbortSec=</varname> from
617 the manager configuration file (see
618 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
619 </para>
620
621 <para>If a service of <varname>Type=notify</varname> handles <constant>SIGABRT</constant> itself (instead of relying
622 on the kernel to write a core dump) it can send <literal>EXTEND_TIMEOUT_USEC=…</literal> to
623 extended the abort time beyond <varname>TimeoutAbortSec=</varname>. The first receipt of this message
624 must occur before <varname>TimeoutAbortSec=</varname> is exceeded, and once the abort time has exended beyond
625 <varname>TimeoutAbortSec=</varname>, the service manager will allow the service to continue to abort, provided
626 the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified, or terminates itself
627 (see <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
628 </para></listitem>
629 </varlistentry>
630
798d3a52
ZJS
631 <varlistentry>
632 <term><varname>TimeoutSec=</varname></term>
633 <listitem><para>A shorthand for configuring both
634 <varname>TimeoutStartSec=</varname> and
635 <varname>TimeoutStopSec=</varname> to the specified value.
636 </para></listitem>
637 </varlistentry>
638
2c29d332 639 <varlistentry>
8c8208cb
LP
640 <term><varname>TimeoutCleanSec=</varname></term>
641 <listitem><para>Configures a timeout on the clean-up operation requested through <command>systemctl
642 clean …</command>, see
643 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
644 details. Takes the usual time values and defaults to <constant>infinity</constant>, i.e. by default
645 no time-out is applied. If a time-out is configured the clean operation will be aborted forcibly when
646 the time-out is reached, potentially leaving resources on disk.</para></listitem>
647 </varlistentry>
648
649 <varlistentry>
2c29d332
LP
650 <term><varname>RuntimeMaxSec=</varname></term>
651
652 <listitem><para>Configures a maximum time for the service to run. If this is used and the service has been
653 active for longer than the specified time it is terminated and put into a failure state. Note that this setting
654 does not have any effect on <varname>Type=oneshot</varname> services, as they terminate immediately after
655 activation completed. Pass <literal>infinity</literal> (the default) to configure no runtime
a327431b
DB
656 limit.</para>
657
658 <para>If a service of <varname>Type=notify</varname> sends <literal>EXTEND_TIMEOUT_USEC=…</literal>, this may cause
659 the runtime to be extended beyond <varname>RuntimeMaxSec=</varname>. The first receipt of this message
660 must occur before <varname>RuntimeMaxSec=</varname> is exceeded, and once the runtime has exended beyond
661 <varname>RuntimeMaxSec=</varname>, the service manager will allow the service to continue to run, provided
662 the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified until the service
90bc77af 663 shutdown is achieved by <literal>STOPPING=1</literal> (or termination). (see
a327431b
DB
664 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
665 </para></listitem>
2c29d332
LP
666 </varlistentry>
667
798d3a52
ZJS
668 <varlistentry>
669 <term><varname>WatchdogSec=</varname></term>
670 <listitem><para>Configures the watchdog timeout for a service.
671 The watchdog is activated when the start-up is completed. The
672 service must call
673 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
674 regularly with <literal>WATCHDOG=1</literal> (i.e. the
675 "keep-alive ping"). If the time between two such calls is
676 larger than the configured time, then the service is placed in
677 a failed state and it will be terminated with
c87700a1
AZ
678 <constant>SIGABRT</constant> (or the signal specified by
679 <varname>WatchdogSignal=</varname>). By setting
a0533c6d
EV
680 <varname>Restart=</varname> to <option>on-failure</option>,
681 <option>on-watchdog</option>, <option>on-abnormal</option> or
798d3a52
ZJS
682 <option>always</option>, the service will be automatically
683 restarted. The time configured here will be passed to the
684 executed service process in the
685 <varname>WATCHDOG_USEC=</varname> environment variable. This
686 allows daemons to automatically enable the keep-alive pinging
687 logic if watchdog support is enabled for the service. If this
688 option is used, <varname>NotifyAccess=</varname> (see below)
689 should be set to open access to the notification socket
690 provided by systemd. If <varname>NotifyAccess=</varname> is
691 not set, it will be implicitly set to <option>main</option>.
582f2fcb
EV
692 Defaults to 0, which disables this feature. The service can
693 check whether the service manager expects watchdog keep-alive
694 notifications. See
695 <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>
a0533c6d
EV
696 for details.
697 <citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
698 may be used to enable automatic watchdog notification support.
582f2fcb 699 </para></listitem>
798d3a52
ZJS
700 </varlistentry>
701
702 <varlistentry>
703 <term><varname>Restart=</varname></term>
704 <listitem><para>Configures whether the service shall be
705 restarted when the service process exits, is killed, or a
706 timeout is reached. The service process may be the main
707 service process, but it may also be one of the processes
708 specified with <varname>ExecStartPre=</varname>,
709 <varname>ExecStartPost=</varname>,
710 <varname>ExecStop=</varname>,
711 <varname>ExecStopPost=</varname>, or
712 <varname>ExecReload=</varname>. When the death of the process
713 is a result of systemd operation (e.g. service stop or
714 restart), the service will not be restarted. Timeouts include
715 missing the watchdog "keep-alive ping" deadline and a service
716 start, reload, and stop operation timeouts.</para>
717
718 <para>Takes one of
719 <option>no</option>,
720 <option>on-success</option>,
721 <option>on-failure</option>,
722 <option>on-abnormal</option>,
723 <option>on-watchdog</option>,
724 <option>on-abort</option>, or
725 <option>always</option>.
726 If set to <option>no</option> (the default), the service will
727 not be restarted. If set to <option>on-success</option>, it
728 will be restarted only when the service process exits cleanly.
729 In this context, a clean exit means an exit code of 0, or one
730 of the signals
731 <constant>SIGHUP</constant>,
732 <constant>SIGINT</constant>,
733 <constant>SIGTERM</constant> or
734 <constant>SIGPIPE</constant>, and
735 additionally, exit statuses and signals specified in
736 <varname>SuccessExitStatus=</varname>. If set to
737 <option>on-failure</option>, the service will be restarted
738 when the process exits with a non-zero exit code, is
739 terminated by a signal (including on core dump, but excluding
ff9b60f3 740 the aforementioned four signals), when an operation (such as
798d3a52
ZJS
741 service reload) times out, and when the configured watchdog
742 timeout is triggered. If set to <option>on-abnormal</option>,
743 the service will be restarted when the process is terminated
744 by a signal (including on core dump, excluding the
745 aforementioned four signals), when an operation times out, or
746 when the watchdog timeout is triggered. If set to
747 <option>on-abort</option>, the service will be restarted only
748 if the service process exits due to an uncaught signal not
749 specified as a clean exit status. If set to
750 <option>on-watchdog</option>, the service will be restarted
751 only if the watchdog timeout for the service expires. If set
752 to <option>always</option>, the service will be restarted
753 regardless of whether it exited cleanly or not, got terminated
754 abnormally by a signal, or hit a timeout.</para>
755
756 <table>
757 <title>Exit causes and the effect of the <varname>Restart=</varname> settings on them</title>
758
759 <tgroup cols='2'>
760 <colspec colname='path' />
761 <colspec colname='expl' />
762 <thead>
763 <row>
764 <entry>Restart settings/Exit causes</entry>
765 <entry><option>no</option></entry>
766 <entry><option>always</option></entry>
767 <entry><option>on-success</option></entry>
768 <entry><option>on-failure</option></entry>
769 <entry><option>on-abnormal</option></entry>
770 <entry><option>on-abort</option></entry>
771 <entry><option>on-watchdog</option></entry>
772 </row>
773 </thead>
774 <tbody>
775 <row>
776 <entry>Clean exit code or signal</entry>
777 <entry/>
778 <entry>X</entry>
779 <entry>X</entry>
780 <entry/>
781 <entry/>
782 <entry/>
783 <entry/>
784 </row>
785 <row>
786 <entry>Unclean exit code</entry>
787 <entry/>
788 <entry>X</entry>
789 <entry/>
790 <entry>X</entry>
791 <entry/>
792 <entry/>
793 <entry/>
794 </row>
795 <row>
796 <entry>Unclean signal</entry>
797 <entry/>
798 <entry>X</entry>
799 <entry/>
800 <entry>X</entry>
801 <entry>X</entry>
802 <entry>X</entry>
803 <entry/>
804 </row>
805 <row>
806 <entry>Timeout</entry>
807 <entry/>
808 <entry>X</entry>
809 <entry/>
810 <entry>X</entry>
811 <entry>X</entry>
812 <entry/>
813 <entry/>
814 </row>
815 <row>
816 <entry>Watchdog</entry>
817 <entry/>
818 <entry>X</entry>
819 <entry/>
820 <entry>X</entry>
821 <entry>X</entry>
822 <entry/>
823 <entry>X</entry>
824 </row>
825 </tbody>
826 </tgroup>
827 </table>
828
b938cb90 829 <para>As exceptions to the setting above, the service will not
798d3a52 830 be restarted if the exit code or signal is specified in
09b69d68
TW
831 <varname>RestartPreventExitStatus=</varname> (see below) or
832 the service is stopped with <command>systemctl stop</command>
833 or an equivalent operation. Also, the services will always be
834 restarted if the exit code or signal is specified in
798d3a52
ZJS
835 <varname>RestartForceExitStatus=</varname> (see below).</para>
836
6d249476
LW
837 <para>Note that service restart is subject to unit start rate
838 limiting configured with <varname>StartLimitIntervalSec=</varname>
839 and <varname>StartLimitBurst=</varname>, see
840 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
bd2538b5
KBM
841 for details. A restarted service enters the failed state only
842 after the start limits are reached.</para>
6d249476 843
798d3a52
ZJS
844 <para>Setting this to <option>on-failure</option> is the
845 recommended choice for long-running services, in order to
846 increase reliability by attempting automatic recovery from
847 errors. For services that shall be able to terminate on their
848 own choice (and avoid immediate restarting),
849 <option>on-abnormal</option> is an alternative choice.</para>
850 </listitem>
851 </varlistentry>
852
853 <varlistentry>
854 <term><varname>SuccessExitStatus=</varname></term>
b938cb90
JE
855 <listitem><para>Takes a list of exit status definitions that,
856 when returned by the main service process, will be considered
798d3a52
ZJS
857 successful termination, in addition to the normal successful
858 exit code 0 and the signals <constant>SIGHUP</constant>,
859 <constant>SIGINT</constant>, <constant>SIGTERM</constant>, and
860 <constant>SIGPIPE</constant>. Exit status definitions can
861 either be numeric exit codes or termination signal names,
862 separated by spaces. For example:
dc83f27a
LP
863
864 <programlisting>SuccessExitStatus=1 2 8 SIGKILL</programlisting>
865
866 ensures that exit codes 1, 2, 8 and
798d3a52
ZJS
867 the termination signal <constant>SIGKILL</constant> are
868 considered clean service terminations.
869 </para>
870
798d3a52
ZJS
871 <para>This option may appear more than once, in which case the
872 list of successful exit statuses is merged. If the empty
873 string is assigned to this option, the list is reset, all
874 prior assignments of this option will have no
875 effect.</para></listitem>
876 </varlistentry>
877
878 <varlistentry>
879 <term><varname>RestartPreventExitStatus=</varname></term>
57639710
LP
880
881 <listitem><para>Takes a list of exit status definitions that, when returned by the main service
882 process, will prevent automatic service restarts, regardless of the restart setting configured with
883 <varname>Restart=</varname>. Exit status definitions can either be numeric exit codes or termination
884 signal names, and are separated by spaces. Defaults to the empty list, so that, by default, no exit
885 status is excluded from the configured restart logic. For example:
dc83f27a
LP
886
887 <programlisting>RestartPreventExitStatus=1 6 SIGABRT</programlisting>
888
57639710
LP
889 ensures that exit codes 1 and 6 and the termination signal <constant>SIGABRT</constant> will not
890 result in automatic service restarting. This option may appear more than once, in which case the list
891 of restart-preventing statuses is merged. If the empty string is assigned to this option, the list is
892 reset and all prior assignments of this option will have no effect.</para>
893
894 <para>Note that this setting has no effect on processes configured via
895 <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecStop=</varname>,
896 <varname>ExecStopPost=</varname> or <varname>ExecReload=</varname>, but only on the main service
897 process, i.e. either the one invoked by <varname>ExecStart=</varname> or (depending on
898 <varname>Type=</varname>, <varname>PIDFile=</varname>, …) the otherwise configured main
899 process.</para></listitem>
798d3a52
ZJS
900 </varlistentry>
901
902 <varlistentry>
903 <term><varname>RestartForceExitStatus=</varname></term>
b938cb90
JE
904 <listitem><para>Takes a list of exit status definitions that,
905 when returned by the main service process, will force automatic
798d3a52
ZJS
906 service restarts, regardless of the restart setting configured
907 with <varname>Restart=</varname>. The argument format is
908 similar to
909 <varname>RestartPreventExitStatus=</varname>.</para></listitem>
910 </varlistentry>
911
798d3a52
ZJS
912 <varlistentry>
913 <term><varname>RootDirectoryStartOnly=</varname></term>
914 <listitem><para>Takes a boolean argument. If true, the root
915 directory, as configured with the
916 <varname>RootDirectory=</varname> option (see
917 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
918 for more information), is only applied to the process started
919 with <varname>ExecStart=</varname>, and not to the various
920 other <varname>ExecStartPre=</varname>,
921 <varname>ExecStartPost=</varname>,
922 <varname>ExecReload=</varname>, <varname>ExecStop=</varname>,
923 and <varname>ExecStopPost=</varname> commands. If false, the
924 setting is applied to all configured commands the same way.
925 Defaults to false.</para></listitem>
926 </varlistentry>
927
928 <varlistentry>
929 <term><varname>NonBlocking=</varname></term>
9b141911
FB
930 <listitem><para>Set the <constant>O_NONBLOCK</constant> flag for all file descriptors passed via socket-based
931 activation. If true, all file descriptors >= 3 (i.e. all except stdin, stdout, stderr), excluding those passed
932 in via the file descriptor storage logic (see <varname>FileDescriptorStoreMax=</varname> for details), will
933 have the <constant>O_NONBLOCK</constant> flag set and hence are in non-blocking mode. This option is only
934 useful in conjunction with a socket unit, as described in
935 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> and has no
936 effect on file descriptors which were previously saved in the file-descriptor store for example. Defaults to
937 false.</para></listitem>
798d3a52
ZJS
938 </varlistentry>
939
940 <varlistentry>
941 <term><varname>NotifyAccess=</varname></term>
b3bb6476
LP
942 <listitem><para>Controls access to the service status notification socket, as accessible via the
943 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> call. Takes one
944 of <option>none</option> (the default), <option>main</option>, <option>exec</option> or
945 <option>all</option>. If <option>none</option>, no daemon status updates are accepted from the service
946 processes, all status update messages are ignored. If <option>main</option>, only service updates sent from the
947 main process of the service are accepted. If <option>exec</option>, only service updates sent from any of the
948 main or control processes originating from one of the <varname>Exec*=</varname> commands are accepted. If
949 <option>all</option>, all services updates from all members of the service's control group are accepted. This
950 option should be set to open access to the notification socket when using <varname>Type=notify</varname> or
951 <varname>WatchdogSec=</varname> (see above). If those options are used but <varname>NotifyAccess=</varname> is
952 not configured, it will be implicitly set to <option>main</option>.</para>
953
954 <para>Note that <function>sd_notify()</function> notifications may be attributed to units correctly only if
955 either the sending process is still around at the time PID 1 processes the message, or if the sending process
956 is explicitly runtime-tracked by the service manager. The latter is the case if the service manager originally
957 forked off the process, i.e. on all processes that match <option>main</option> or
958 <option>exec</option>. Conversely, if an auxiliary process of the unit sends an
959 <function>sd_notify()</function> message and immediately exits, the service manager might not be able to
960 properly attribute the message to the unit, and thus will ignore it, even if
961 <varname>NotifyAccess=</varname><option>all</option> is set for it.</para></listitem>
798d3a52
ZJS
962 </varlistentry>
963
964 <varlistentry>
965 <term><varname>Sockets=</varname></term>
966 <listitem><para>Specifies the name of the socket units this
967 service shall inherit socket file descriptors from when the
b938cb90
JE
968 service is started. Normally, it should not be necessary to use
969 this setting, as all socket file descriptors whose unit shares
798d3a52
ZJS
970 the same name as the service (subject to the different unit
971 name suffix of course) are passed to the spawned
972 process.</para>
973
974 <para>Note that the same socket file descriptors may be passed
975 to multiple processes simultaneously. Also note that a
976 different service may be activated on incoming socket traffic
977 than the one which is ultimately configured to inherit the
b938cb90 978 socket file descriptors. Or, in other words: the
798d3a52
ZJS
979 <varname>Service=</varname> setting of
980 <filename>.socket</filename> units does not have to match the
981 inverse of the <varname>Sockets=</varname> setting of the
982 <filename>.service</filename> it refers to.</para>
983
b30772a4
LP
984 <para>This option may appear more than once, in which case the list of socket units is merged. Note
985 that once set, clearing the list of sockets again (for example, by assigning the empty string to this
986 option) is not supported.</para></listitem>
798d3a52
ZJS
987 </varlistentry>
988
798d3a52
ZJS
989 <varlistentry>
990 <term><varname>FileDescriptorStoreMax=</varname></term>
3ceb72e5 991 <listitem><para>Configure how many file descriptors may be stored in the service manager for the service using
798d3a52 992 <citerefentry><refentrytitle>sd_pid_notify_with_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>'s
3ceb72e5
LP
993 <literal>FDSTORE=1</literal> messages. This is useful for implementing services that can restart after an
994 explicit request or a crash without losing state. Any open sockets and other file descriptors which should not
995 be closed during the restart may be stored this way. Application state can either be serialized to a file in
996 <filename>/run</filename>, or better, stored in a
997 <citerefentry><refentrytitle>memfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry> memory file
998 descriptor. Defaults to 0, i.e. no file descriptors may be stored in the service manager. All file descriptors
999 passed to the service manager from a specific service are passed back to the service's main process on the next
1000 service restart. Any file descriptors passed to the service manager are automatically closed when
1001 <constant>POLLHUP</constant> or <constant>POLLERR</constant> is seen on them, or when the service is fully
4330dc03
AJ
1002 stopped and no job is queued or being executed for it. If this option is used, <varname>NotifyAccess=</varname>
1003 (see above) should be set to open access to the notification socket provided by systemd. If
1004 <varname>NotifyAccess=</varname> is not set, it will be implicitly set to
1005 <option>main</option>.</para></listitem>
798d3a52
ZJS
1006 </varlistentry>
1007
8c7c9839
PS
1008 <varlistentry>
1009 <term><varname>USBFunctionDescriptors=</varname></term>
3d314510
LP
1010 <listitem><para>Configure the location of a file containing
1011 <ulink
1012 url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB
1013 FunctionFS</ulink> descriptors, for implementation of USB
a8eaaee7 1014 gadget functions. This is used only in conjunction with a
3d314510 1015 socket unit with <varname>ListenUSBFunction=</varname>
a8eaaee7 1016 configured. The contents of this file are written to the
3d314510
LP
1017 <filename>ep0</filename> file after it is
1018 opened.</para></listitem>
8c7c9839
PS
1019 </varlistentry>
1020
1021 <varlistentry>
1022 <term><varname>USBFunctionStrings=</varname></term>
3d314510
LP
1023 <listitem><para>Configure the location of a file containing
1024 USB FunctionFS strings. Behavior is similar to
1025 <varname>USBFunctionDescriptors=</varname>
1026 above.</para></listitem>
8c7c9839
PS
1027 </varlistentry>
1028
8e74bf7f
LP
1029 <varlistentry>
1030 <term><varname>OOMPolicy=</varname></term>
1031
1032 <listitem><para>Configure the Out-Of-Memory (OOM) killer policy. On Linux, when memory becomes scarce
1033 the kernel might decide to kill a running process in order to free up memory and reduce memory
1034 pressure. This setting takes one of <constant>continue</constant>, <constant>stop</constant> or
1035 <constant>kill</constant>. If set to <constant>continue</constant> and a process of the service is
1036 killed by the kernel's OOM killer this is logged but the service continues running. If set to
1037 <constant>stop</constant> the event is logged but the service is terminated cleanly by the service
1038 manager. If set to <constant>kill</constant> and one of the service's processes is killed by the OOM
1039 killer the kernel is instructed to kill all remaining processes of the service, too. Defaults to the
1040 setting <varname>DefaultOOMPolicy=</varname> in
1041 <citerefentry><refentrytitle>system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> is
1042 set to, except for services where <varname>Delegate=</varname> is turned on, where it defaults to
1043 <constant>continue</constant>.</para>
1044
1045 <para>Use the <varname>OOMScoreAdjust=</varname> setting to configure whether processes of the unit
1046 shall be considered preferred or less preferred candidates for process termination by the Linux OOM
1047 killer logic. See
1048 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1049 details.</para></listitem>
1050 </varlistentry>
1051
798d3a52
ZJS
1052 </variablelist>
1053
1054 <para>Check
1055 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1056 and
1057 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1058 for more settings.</para>
1059
1060 </refsect1>
1061
1062 <refsect1>
1063 <title>Command lines</title>
1064
1065 <para>This section describes command line parsing and
ff9b60f3 1066 variable and specifier substitutions for
798d3a52
ZJS
1067 <varname>ExecStart=</varname>,
1068 <varname>ExecStartPre=</varname>,
1069 <varname>ExecStartPost=</varname>,
1070 <varname>ExecReload=</varname>,
1071 <varname>ExecStop=</varname>, and
1072 <varname>ExecStopPost=</varname> options.</para>
1073
1074 <para>Multiple command lines may be concatenated in a single
1075 directive by separating them with semicolons (these semicolons
1076 must be passed as separate words). Lone semicolons may be escaped
1077 as <literal>\;</literal>.</para>
1078
330785f5 1079 <para>Each command line is split on whitespace, with the first item being the command to
1eecafb8 1080 execute, and the subsequent items being the arguments. Double quotes ("…") and single quotes
fa0c9e63
ZJS
1081 ('…') may be used to wrap a whole item (the opening quote may appear only at the beginning or
1082 after whitespace that is not quoted, and the closing quote must be followed by whitespace or the
1083 end of line), in which case everything until the next matching quote becomes part of the same
1084 argument. Quotes themselves are removed. C-style escapes are also supported. The table below
1085 contains the list of known escape patterns. Only escape patterns which match the syntax in the
1086 table are allowed; other patterns may be added in the future and unknown patterns will result in
1087 a warning. In particular, any backslashes should be doubled. Finally, a trailing backslash
1088 (<literal>\</literal>) may be used to merge lines.</para>
798d3a52 1089
0e3f51cf
ZJS
1090 <para>This syntax is inspired by shell syntax, but only the meta-characters and expansions
1091 described in the following paragraphs are understood, and the expansion of variables is
1092 different. Specifically, redirection using
798d3a52
ZJS
1093 <literal>&lt;</literal>,
1094 <literal>&lt;&lt;</literal>,
1095 <literal>&gt;</literal>, and
1096 <literal>&gt;&gt;</literal>, pipes using
1097 <literal>|</literal>, running programs in the background using
1098 <literal>&amp;</literal>, and <emphasis>other elements of shell
1099 syntax are not supported</emphasis>.</para>
1100
5008da1e 1101 <para>The command to execute may contain spaces, but control characters are not allowed.</para>
798d3a52 1102
5008da1e 1103 <para>The command line accepts <literal>%</literal> specifiers as described in
2d06ddb7 1104 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1105
1106 <para>Basic environment variable substitution is supported. Use
1107 <literal>${FOO}</literal> as part of a word, or as a word of its
1108 own, on the command line, in which case it will be replaced by the
1109 value of the environment variable including all whitespace it
1110 contains, resulting in a single argument. Use
1111 <literal>$FOO</literal> as a separate word on the command line, in
1112 which case it will be replaced by the value of the environment
b938cb90 1113 variable split at whitespace, resulting in zero or more arguments.
3faf145d 1114 For this type of expansion, quotes are respected when splitting
798d3a52
ZJS
1115 into words, and afterwards removed.</para>
1116
5008da1e
ZJS
1117 <para>If the command is not a full (absolute) path, it will be resolved to a full path using a
1118 fixed search path determinted at compilation time. Searched directories include
1119 <filename>/usr/local/bin/</filename>, <filename>/usr/bin/</filename>, <filename>/bin/</filename>
1120 on systems using split <filename>/usr/bin/</filename> and <filename>/bin/</filename>
1121 directories, and their <filename>sbin/</filename> counterparts on systems using split
1122 <filename>bin/</filename> and <filename>sbin/</filename>. It is thus safe to use just the
1123 executable name in case of executables located in any of the "standard" directories, and an
1124 absolute path must be used in other cases. Using an absolute path is recommended to avoid
e12d446b
ZJS
1125 ambiguity. Hint: this search path may be queried using
1126 <command>systemd-path search-binaries-default</command>.</para>
5008da1e 1127
798d3a52
ZJS
1128 <para>Example:</para>
1129
1130 <programlisting>Environment="ONE=one" 'TWO=two two'
5008da1e 1131ExecStart=echo $ONE $TWO ${TWO}</programlisting>
5d9a2698 1132
798d3a52
ZJS
1133 <para>This will execute <command>/bin/echo</command> with four
1134 arguments: <literal>one</literal>, <literal>two</literal>,
1135 <literal>two</literal>, and <literal>two two</literal>.</para>
5d9a2698 1136
798d3a52
ZJS
1137 <para>Example:</para>
1138 <programlisting>Environment=ONE='one' "TWO='two two' too" THREE=
5d9a2698
ZJS
1139ExecStart=/bin/echo ${ONE} ${TWO} ${THREE}
1140ExecStart=/bin/echo $ONE $TWO $THREE</programlisting>
5008da1e 1141 <para>This results in <filename>/bin/echo</filename> being
798d3a52
ZJS
1142 called twice, the first time with arguments
1143 <literal>'one'</literal>,
1144 <literal>'two two' too</literal>, <literal></literal>,
1145 and the second time with arguments
1146 <literal>one</literal>, <literal>two two</literal>,
1147 <literal>too</literal>.
1148 </para>
1149
1150 <para>To pass a literal dollar sign, use <literal>$$</literal>.
1151 Variables whose value is not known at expansion time are treated
1152 as empty strings. Note that the first argument (i.e. the program
1153 to execute) may not be a variable.</para>
1154
1155 <para>Variables to be used in this fashion may be defined through
1156 <varname>Environment=</varname> and
1157 <varname>EnvironmentFile=</varname>. In addition, variables listed
1158 in the section "Environment variables in spawned processes" in
1159 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1160 which are considered "static configuration", may be used (this
1161 includes e.g. <varname>$USER</varname>, but not
1162 <varname>$TERM</varname>).</para>
1163
1164 <para>Note that shell command lines are not directly supported. If
1165 shell command lines are to be used, they need to be passed
1166 explicitly to a shell implementation of some kind. Example:</para>
5008da1e 1167 <programlisting>ExecStart=sh -c 'dmesg | tac'</programlisting>
798d3a52
ZJS
1168
1169 <para>Example:</para>
1170
5008da1e 1171 <programlisting>ExecStart=echo one ; echo "two two"</programlisting>
798d3a52 1172
5008da1e 1173 <para>This will execute <command>echo</command> two times,
798d3a52
ZJS
1174 each time with one argument: <literal>one</literal> and
1175 <literal>two two</literal>, respectively. Because two commands are
1176 specified, <varname>Type=oneshot</varname> must be used.</para>
1177
1178 <para>Example:</para>
1179
5008da1e
ZJS
1180 <programlisting>ExecStart=echo / &gt;/dev/null &amp; \; \
1181ls</programlisting>
30d88d54 1182
5008da1e 1183 <para>This will execute <command>echo</command>
798d3a52
ZJS
1184 with five arguments: <literal>/</literal>,
1185 <literal>&gt;/dev/null</literal>,
1186 <literal>&amp;</literal>, <literal>;</literal>, and
5008da1e 1187 <literal>ls</literal>.</para>
798d3a52
ZJS
1188
1189 <table>
1190 <title>C escapes supported in command lines and environment variables</title>
1191 <tgroup cols='2'>
1192 <colspec colname='escape' />
1193 <colspec colname='meaning' />
1194 <thead>
1195 <row>
1196 <entry>Literal</entry>
1197 <entry>Actual value</entry>
1198 </row>
1199 </thead>
1200 <tbody>
1201 <row>
1202 <entry><literal>\a</literal></entry>
1203 <entry>bell</entry>
1204 </row>
1205 <row>
1206 <entry><literal>\b</literal></entry>
1207 <entry>backspace</entry>
1208 </row>
1209 <row>
1210 <entry><literal>\f</literal></entry>
1211 <entry>form feed</entry>
1212 </row>
1213 <row>
1214 <entry><literal>\n</literal></entry>
1215 <entry>newline</entry>
1216 </row>
1217 <row>
1218 <entry><literal>\r</literal></entry>
1219 <entry>carriage return</entry>
1220 </row>
1221 <row>
1222 <entry><literal>\t</literal></entry>
1223 <entry>tab</entry>
1224 </row>
1225 <row>
1226 <entry><literal>\v</literal></entry>
1227 <entry>vertical tab</entry>
1228 </row>
1229 <row>
1230 <entry><literal>\\</literal></entry>
1231 <entry>backslash</entry>
1232 </row>
1233 <row>
1234 <entry><literal>\"</literal></entry>
1235 <entry>double quotation mark</entry>
1236 </row>
1237 <row>
1238 <entry><literal>\'</literal></entry>
1239 <entry>single quotation mark</entry>
1240 </row>
1241 <row>
1242 <entry><literal>\s</literal></entry>
1243 <entry>space</entry>
1244 </row>
1245 <row>
1246 <entry><literal>\x<replaceable>xx</replaceable></literal></entry>
1247 <entry>character number <replaceable>xx</replaceable> in hexadecimal encoding</entry>
1248 </row>
1249 <row>
1250 <entry><literal>\<replaceable>nnn</replaceable></literal></entry>
1251 <entry>character number <replaceable>nnn</replaceable> in octal encoding</entry>
1252 </row>
1253 </tbody>
1254 </tgroup>
1255 </table>
1256 </refsect1>
1257
1258 <refsect1>
1259 <title>Examples</title>
1260
1261 <example>
1262 <title>Simple service</title>
1263
1264 <para>The following unit file creates a service that will
1265 execute <filename>/usr/sbin/foo-daemon</filename>. Since no
1266 <varname>Type=</varname> is specified, the default
1267 <varname>Type=</varname><option>simple</option> will be assumed.
1268 systemd will assume the unit to be started immediately after the
1269 program has begun executing.</para>
1270
1271 <programlisting>[Unit]
d44efb62
CS
1272Description=Foo
1273
1274[Service]
1275ExecStart=/usr/sbin/foo-daemon
1276
1277[Install]
1278WantedBy=multi-user.target</programlisting>
1279
798d3a52
ZJS
1280 <para>Note that systemd assumes here that the process started by
1281 systemd will continue running until the service terminates. If
1282 the program daemonizes itself (i.e. forks), please use
1283 <varname>Type=</varname><option>forking</option> instead.</para>
1284
1285 <para>Since no <varname>ExecStop=</varname> was specified,
1286 systemd will send SIGTERM to all processes started from this
1287 service, and after a timeout also SIGKILL. This behavior can be
1288 modified, see
1289 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1290 for details.</para>
1291
1292 <para>Note that this unit type does not include any type of
1293 notification when a service has completed initialization. For
1294 this, you should use other unit types, such as
1295 <varname>Type=</varname><option>notify</option> if the service
1296 understands systemd's notification protocol,
1297 <varname>Type=</varname><option>forking</option> if the service
1298 can background itself or
1299 <varname>Type=</varname><option>dbus</option> if the unit
1300 acquires a DBus name once initialization is complete. See
1301 below.</para>
1302 </example>
1303
1304 <example>
1305 <title>Oneshot service</title>
1306
b938cb90 1307 <para>Sometimes, units should just execute an action without
798d3a52
ZJS
1308 keeping active processes, such as a filesystem check or a
1309 cleanup action on boot. For this,
1310 <varname>Type=</varname><option>oneshot</option> exists. Units
1311 of this type will wait until the process specified terminates
1312 and then fall back to being inactive. The following unit will
ff9b60f3 1313 perform a cleanup action:</para>
798d3a52
ZJS
1314
1315 <programlisting>[Unit]
d44efb62
CS
1316Description=Cleanup old Foo data
1317
1318[Service]
1319Type=oneshot
1320ExecStart=/usr/sbin/foo-cleanup
1321
1322[Install]
1323WantedBy=multi-user.target</programlisting>
1324
798d3a52 1325 <para>Note that systemd will consider the unit to be in the
b938cb90 1326 state "starting" until the program has terminated, so ordered
798d3a52 1327 dependencies will wait for the program to finish before starting
b938cb90
JE
1328 themselves. The unit will revert to the "inactive" state after
1329 the execution is done, never reaching the "active" state. That
798d3a52
ZJS
1330 means another request to start the unit will perform the action
1331 again.</para>
1332
1333 <para><varname>Type=</varname><option>oneshot</option> are the
1334 only service units that may have more than one
1335 <varname>ExecStart=</varname> specified. They will be executed
1336 in order until either they are all successful or one of them
1337 fails.</para>
1338 </example>
1339
1340 <example>
1341 <title>Stoppable oneshot service</title>
1342
1343 <para>Similarly to the oneshot services, there are sometimes
1344 units that need to execute a program to set up something and
1345 then execute another to shut it down, but no process remains
b938cb90 1346 active while they are considered "started". Network
798d3a52 1347 configuration can sometimes fall into this category. Another use
a8eaaee7 1348 case is if a oneshot service shall not be executed each time
798d3a52
ZJS
1349 when they are pulled in as a dependency, but only the first
1350 time.</para>
1351
1352 <para>For this, systemd knows the setting
1353 <varname>RemainAfterExit=</varname><option>yes</option>, which
1354 causes systemd to consider the unit to be active if the start
1355 action exited successfully. This directive can be used with all
1356 types, but is most useful with
1357 <varname>Type=</varname><option>oneshot</option> and
1358 <varname>Type=</varname><option>simple</option>. With
b938cb90 1359 <varname>Type=</varname><option>oneshot</option>, systemd waits
798d3a52
ZJS
1360 until the start action has completed before it considers the
1361 unit to be active, so dependencies start only after the start
1362 action has succeeded. With
b938cb90 1363 <varname>Type=</varname><option>simple</option>, dependencies
798d3a52
ZJS
1364 will start immediately after the start action has been
1365 dispatched. The following unit provides an example for a simple
1366 static firewall.</para>
1367
1368 <programlisting>[Unit]
d44efb62
CS
1369Description=Simple firewall
1370
1371[Service]
1372Type=oneshot
1373RemainAfterExit=yes
1374ExecStart=/usr/local/sbin/simple-firewall-start
1375ExecStop=/usr/local/sbin/simple-firewall-stop
1376
1377[Install]
1378WantedBy=multi-user.target</programlisting>
1379
798d3a52
ZJS
1380 <para>Since the unit is considered to be running after the start
1381 action has exited, invoking <command>systemctl start</command>
1382 on that unit again will cause no action to be taken.</para>
1383 </example>
1384
1385 <example>
1386 <title>Traditional forking services</title>
1387
1388 <para>Many traditional daemons/services background (i.e. fork,
1389 daemonize) themselves when starting. Set
1390 <varname>Type=</varname><option>forking</option> in the
1391 service's unit file to support this mode of operation. systemd
1392 will consider the service to be in the process of initialization
1393 while the original program is still running. Once it exits
1394 successfully and at least a process remains (and
1395 <varname>RemainAfterExit=</varname><option>no</option>), the
1396 service is considered started.</para>
1397
b938cb90 1398 <para>Often, a traditional daemon only consists of one process.
798d3a52
ZJS
1399 Therefore, if only one process is left after the original
1400 process terminates, systemd will consider that process the main
1401 process of the service. In that case, the
1402 <varname>$MAINPID</varname> variable will be available in
1403 <varname>ExecReload=</varname>, <varname>ExecStop=</varname>,
1404 etc.</para>
1405
1406 <para>In case more than one process remains, systemd will be
1407 unable to determine the main process, so it will not assume
1408 there is one. In that case, <varname>$MAINPID</varname> will not
1409 expand to anything. However, if the process decides to write a
1410 traditional PID file, systemd will be able to read the main PID
1411 from there. Please set <varname>PIDFile=</varname> accordingly.
1412 Note that the daemon should write that file before finishing
b938cb90 1413 with its initialization. Otherwise, systemd might try to read the
798d3a52
ZJS
1414 file before it exists.</para>
1415
1416 <para>The following example shows a simple daemon that forks and
1417 just starts one process in the background:</para>
1418
1419 <programlisting>[Unit]
d44efb62
CS
1420Description=Some simple daemon
1421
1422[Service]
1423Type=forking
1424ExecStart=/usr/sbin/my-simple-daemon -d
1425
1426[Install]
1427WantedBy=multi-user.target</programlisting>
1428
798d3a52
ZJS
1429 <para>Please see
1430 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1431 for details on how you can influence the way systemd terminates
1432 the service.</para>
1433 </example>
1434
1435 <example>
1436 <title>DBus services</title>
1437
1438 <para>For services that acquire a name on the DBus system bus,
1439 use <varname>Type=</varname><option>dbus</option> and set
1440 <varname>BusName=</varname> accordingly. The service should not
1441 fork (daemonize). systemd will consider the service to be
1442 initialized once the name has been acquired on the system bus.
1443 The following example shows a typical DBus service:</para>
1444
1445 <programlisting>[Unit]
d44efb62
CS
1446Description=Simple DBus service
1447
1448[Service]
1449Type=dbus
1450BusName=org.example.simple-dbus-service
1451ExecStart=/usr/sbin/simple-dbus-service
1452
1453[Install]
1454WantedBy=multi-user.target</programlisting>
1455
7ca41557 1456 <para>For <emphasis>bus-activatable</emphasis> services, do not
798d3a52
ZJS
1457 include a <literal>[Install]</literal> section in the systemd
1458 service file, but use the <varname>SystemdService=</varname>
1459 option in the corresponding DBus service file, for example
1460 (<filename>/usr/share/dbus-1/system-services/org.example.simple-dbus-service.service</filename>):</para>
d44efb62 1461
798d3a52 1462 <programlisting>[D-BUS Service]
d44efb62
CS
1463Name=org.example.simple-dbus-service
1464Exec=/usr/sbin/simple-dbus-service
1465User=root
1466SystemdService=simple-dbus-service.service</programlisting>
1467
798d3a52
ZJS
1468 <para>Please see
1469 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1470 for details on how you can influence the way systemd terminates
1471 the service.</para>
1472 </example>
1473
1474 <example>
1475 <title>Services that notify systemd about their initialization</title>
1476
1477 <para><varname>Type=</varname><option>simple</option> services
1478 are really easy to write, but have the major disadvantage of
1479 systemd not being able to tell when initialization of the given
1480 service is complete. For this reason, systemd supports a simple
1481 notification protocol that allows daemons to make systemd aware
1482 that they are done initializing. Use
1483 <varname>Type=</varname><option>notify</option> for this. A
1484 typical service file for such a daemon would look like
1485 this:</para>
1486
1487 <programlisting>[Unit]
d44efb62
CS
1488Description=Simple notifying service
1489
1490[Service]
1491Type=notify
1492ExecStart=/usr/sbin/simple-notifying-service
1493
1494[Install]
1495WantedBy=multi-user.target</programlisting>
1496
798d3a52 1497 <para>Note that the daemon has to support systemd's notification
7ca41557 1498 protocol, else systemd will think the service has not started yet
798d3a52
ZJS
1499 and kill it after a timeout. For an example of how to update
1500 daemons to support this protocol transparently, take a look at
1501 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1502 systemd will consider the unit to be in the 'starting' state
1503 until a readiness notification has arrived.</para>
1504
1505 <para>Please see
1506 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1507 for details on how you can influence the way systemd terminates
1508 the service.</para>
1509 </example>
1510 </refsect1>
1511
1512 <refsect1>
1513 <title>See Also</title>
1514 <para>
1515 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1516 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
d1698b82 1517 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
798d3a52
ZJS
1518 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1519 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1520 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1521 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
438e6a48
LP
1522 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1523 <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
798d3a52
ZJS
1524 </para>
1525 </refsect1>
d1ab0ca0
LP
1526
1527</refentry>