]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.service.xml
man: Add xinclude namespace
[thirdparty/systemd.git] / man / systemd.service.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6 <refentry id="systemd.service" xmlns:xi="http://www.w3.org/2001/XInclude">
7 <refentryinfo>
8 <title>systemd.service</title>
9 <productname>systemd</productname>
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
30 <literal>.service</literal> encodes information about a process
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 [Unit] and [Install]
39 sections. The service specific configuration options are
40 configured in the [Service] 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
53 <para>If SysV init compat is enabled, systemd automatically creates service units that wrap SysV init
54 scripts (the service name is the same as the name of the script, with a <literal>.service</literal>
55 suffix added); see
56 <citerefentry><refentrytitle>systemd-sysv-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
57 </para>
58
59 <para>The <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
60 command allows creating <filename>.service</filename> and <filename>.scope</filename> units dynamically
61 and transiently from the command line.</para>
62 </refsect1>
63
64 <refsect1>
65 <title>Service Templates</title>
66
67 <para>It is possible for <command>systemd</command> services to take a single argument via the
68 <literal><replaceable>service</replaceable>@<replaceable>argument</replaceable>.service</literal>
69 syntax. Such services are called "instantiated" services, while the unit definition without the
70 <replaceable>argument</replaceable> parameter is called a "template". An example could be a
71 <filename>dhcpcd@.service</filename> service template which takes a network interface as a
72 parameter to form an instantiated service. Within the service file, this parameter or "instance
73 name" can be accessed with %-specifiers. See
74 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
75 for details.</para>
76 </refsect1>
77
78 <refsect1>
79 <title>Automatic Dependencies</title>
80
81 <refsect2>
82 <title>Implicit Dependencies</title>
83
84 <para>The following dependencies are implicitly added:</para>
85
86 <itemizedlist>
87 <listitem><para>Services with <varname>Type=dbus</varname> set automatically
88 acquire dependencies of type <varname>Requires=</varname> and
89 <varname>After=</varname> on
90 <filename>dbus.socket</filename>.</para></listitem>
91
92 <listitem><para>Socket activated services are automatically ordered after
93 their activating <filename>.socket</filename> units via an
94 automatic <varname>After=</varname> dependency.
95 Services also pull in all <filename>.socket</filename> units
96 listed in <varname>Sockets=</varname> via automatic
97 <varname>Wants=</varname> and <varname>After=</varname> dependencies.</para></listitem>
98 </itemizedlist>
99
100 <para>Additional implicit dependencies may be added as result of
101 execution and resource control parameters as documented in
102 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
103 and
104 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
105 </refsect2>
106
107 <refsect2>
108 <title>Default Dependencies</title>
109
110 <para>The following dependencies are added unless <varname>DefaultDependencies=no</varname> is set:</para>
111
112 <itemizedlist>
113 <listitem><para>Service units will have dependencies of type <varname>Requires=</varname> and
114 <varname>After=</varname> on <filename>sysinit.target</filename>, a dependency of type <varname>After=</varname> on
115 <filename>basic.target</filename> as well as dependencies of type <varname>Conflicts=</varname> and
116 <varname>Before=</varname> on <filename>shutdown.target</filename>. These ensure that normal service units pull in
117 basic system initialization, and are terminated cleanly prior to system shutdown. Only services involved with early
118 boot or late system shutdown should disable this option.</para></listitem>
119
120 <listitem><para>Instanced service units (i.e. service units with an <literal>@</literal> in their name) are assigned by
121 default a per-template slice unit (see
122 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>), named after the
123 template unit, containing all instances of the specific template. This slice is normally stopped at shutdown,
124 together with all template instances. If that is not desired, set <varname>DefaultDependencies=no</varname> in the
125 template unit, and either define your own per-template slice unit file that also sets
126 <varname>DefaultDependencies=no</varname>, or set <varname>Slice=system.slice</varname> (or another suitable slice)
127 in the template unit. Also see
128 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
129 </para></listitem>
130 </itemizedlist>
131 </refsect2>
132 </refsect1>
133
134 <refsect1>
135 <title>Options</title>
136
137 <para>Service unit files may include [Unit] and [Install] sections, which are described in
138 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
139 </para>
140
141 <para>Service unit files must include a [Service]
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
146 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
147 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
148 and
149 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
150 The options specific to the [Service] section
151 of service units are the following:</para>
152
153 <variablelist class='unit-directives'>
154 <varlistentry>
155 <term><varname>Type=</varname></term>
156
157 <listitem>
158 <para>Configures the mechanism via which the service notifies the manager that the service start-up
159 has finished. One of <option>simple</option>, <option>exec</option>, <option>forking</option>,
160 <option>oneshot</option>, <option>dbus</option>, <option>notify</option>,
161 <option>notify-reload</option>, or <option>idle</option>:</para>
162
163 <itemizedlist>
164 <listitem><para>If set to <option>simple</option> (the default if <varname>ExecStart=</varname>
165 is specified but neither <varname>Type=</varname> nor <varname>BusName=</varname> are), the
166 service manager will consider the unit started immediately after the main service process has
167 been forked off (i.e. immediately after <function>fork()</function>, and before various process
168 attributes have been configured and in particular before the new process has called
169 <function>execve()</function> to invoke the actual service binary). Typically,
170 <varname>Type=</varname><option>exec</option> (see below) is the better choice, see below.</para>
171
172 <para>It is expected that the process configured with <varname>ExecStart=</varname> is the main
173 process of the service. In this mode, if the process offers functionality to other processes on
174 the system, its communication channels should be installed before the service is started up
175 (e.g. sockets set up by systemd, via socket activation), as the service manager will immediately
176 proceed starting follow-up units, right after creating the main service process, and before
177 executing the service's binary. Note that this means <command>systemctl start</command> command
178 lines for <option>simple</option> services will report success even if the service's binary
179 cannot be invoked successfully (for example because the selected <varname>User=</varname> doesn't
180 exist, or the service binary is missing).</para></listitem>
181
182 <listitem><para>The <option>exec</option> type is similar to <option>simple</option>, but the
183 service manager will consider the unit started immediately after the main service binary has been
184 executed. The service manager will delay starting of follow-up units until that point. (Or in
185 other words: <option>simple</option> proceeds with further jobs right after
186 <function>fork()</function> returns, while <option>exec</option> will not proceed before both
187 <function>fork()</function> and <function>execve()</function> in the service process succeeded.)
188 Note that this means <command>systemctl start</command> command lines for <option>exec</option>
189 services will report failure when the service's binary cannot be invoked successfully (for
190 example because the selected <varname>User=</varname> doesn't exist, or the service binary is
191 missing).</para></listitem>
192
193 <listitem><para>If set to <option>forking</option>, the manager will consider the unit started
194 immediately after the binary that forked off by the manager exits. <emphasis>The use of this type
195 is discouraged, use <option>notify</option>, <option>notify-reload</option>, or
196 <option>dbus</option> instead.</emphasis></para>
197
198 <para>It is expected that the process configured with <varname>ExecStart=</varname> will call
199 <function>fork()</function> as part of its start-up. The parent process is expected to exit when
200 start-up is complete and all communication channels are set up. The child continues to run as the
201 main service process, and the service manager will consider the unit started when the parent
202 process exits. This is the behavior of traditional UNIX services. If this setting is used, it is
203 recommended to also use the <varname>PIDFile=</varname> option, so that systemd can reliably
204 identify the main process of the service. The manager will proceed with starting follow-up units
205 after the parent process exits.</para></listitem>
206
207 <listitem><para>Behavior of <option>oneshot</option> is similar to <option>simple</option>;
208 however, the service manager will consider the unit up after the main process exits. It will then
209 start follow-up units. <varname>RemainAfterExit=</varname> is particularly useful for this type
210 of service. <varname>Type=</varname><option>oneshot</option> is the implied default if neither
211 <varname>Type=</varname> nor <varname>ExecStart=</varname> are specified. Note that if this
212 option is used without <varname>RemainAfterExit=</varname> the service will never enter
213 <literal>active</literal> unit state, but will directly transition from
214 <literal>activating</literal> to <literal>deactivating</literal> or <literal>dead</literal>,
215 since no process is configured that shall run continuously. In particular this means that after a
216 service of this type ran (and which has <varname>RemainAfterExit=</varname> not set) it will not
217 show up as started afterwards, but as dead.</para></listitem>
218
219 <listitem><para>Behavior of <option>dbus</option> is similar to <option>simple</option>; however,
220 units of this type must have the <varname>BusName=</varname> specified and the service manager
221 will consider the unit up when the specified bus name has been acquired. This type is the default
222 if <varname>BusName=</varname> is specified.</para>
223
224 <para>Service units with this option configured implicitly gain dependencies on the
225 <filename>dbus.socket</filename> unit. A service unit of this type is considered to be in the
226 activating state until the specified bus name is acquired. It is considered activated while the
227 bus name is taken. Once the bus name is released the service is considered being no longer
228 functional which has the effect that the service manager attempts to terminate any remaining
229 processes belonging to the service. Services that drop their bus name as part of their shutdown
230 logic thus should be prepared to receive a <constant>SIGTERM</constant> (or whichever signal is
231 configured in <varname>KillSignal=</varname>) as result.</para></listitem>
232
233 <listitem><para>Behavior of <option>notify</option> is similar to <option>exec</option>; however,
234 it is expected that the service sends a <literal>READY=1</literal> notification message via
235 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> or
236 an equivalent call when it has finished starting up. systemd will proceed with starting follow-up
237 units after this notification message has been sent. If this option is used,
238 <varname>NotifyAccess=</varname> (see below) should be set to open access to the notification
239 socket provided by systemd. If <varname>NotifyAccess=</varname> is missing or set to
240 <option>none</option>, it will be forcibly set to <option>main</option>.</para>
241
242 <para>If the service supports reloading, and uses the a signal to start the reload, using
243 <option>notify-reload</option> instead is recommended.</para></listitem>
244
245 <listitem><para>Behavior of <option>notify-reload</option> is similar to <option>notify</option>,
246 with one difference: the <constant>SIGHUP</constant> UNIX process signal is sent to the service's
247 main process when the service is asked to reload and the manager will wait for a notification
248 about the reload being finished.</para>
249
250 <para>When initiating the reload process the service is expected to reply with a notification
251 message via
252 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
253 that contains the <literal>RELOADING=1</literal> field in combination with
254 <literal>MONOTONIC_USEC=</literal> set to the current monotonic time
255 (i.e. <constant>CLOCK_MONOTONIC</constant> in
256 <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>)
257 in μs, formatted as decimal string. Once reloading is complete another notification message must
258 be sent, containing <literal>READY=1</literal>. Using this service type and implementing this
259 reload protocol is an efficient alternative to providing an <varname>ExecReload=</varname>
260 command for reloading of the service's configuration.</para>
261
262 <para>The signal to send can be tweaked via <varname>ReloadSignal=</varname>, see below.</para>
263 </listitem>
264
265 <listitem><para>Behavior of <option>idle</option> is very similar to <option>simple</option>; however,
266 actual execution of the service program is delayed until all active jobs are dispatched. This may be used
267 to avoid interleaving of output of shell services with the status output on the console. Note that this
268 type is useful only to improve console output, it is not useful as a general unit ordering tool, and the
269 effect of this service type is subject to a 5s timeout, after which the service program is invoked
270 anyway.</para></listitem>
271 </itemizedlist>
272
273 <para>It is recommended to use <varname>Type=</varname><option>exec</option> for long-running
274 services, as it ensures that process setup errors (e.g. errors such as a missing service
275 executable, or missing user) are properly tracked. However, as this service type won't propagate
276 the failures in the service's own startup code (as opposed to failures in the preparatory steps the
277 service manager executes before <function>execve()</function>) and doesn't allow ordering of other
278 units against completion of initialization of the service code itself (which for example is useful
279 if clients need to connect to the service through some form of IPC, and the IPC channel is only
280 established by the service itself — in contrast to doing this ahead of time through socket or bus
281 activation or similar), it might not be sufficient for many cases. If so, <option>notify</option>,
282 <option>notify-reload</option>, or <option>dbus</option> (the latter only in case the service
283 provides a D-Bus interface) are the preferred options as they allow service program code to
284 precisely schedule when to consider the service started up successfully and when to proceed with
285 follow-up units. The <option>notify</option>/<option>notify-reload</option> service types require
286 explicit support in the service codebase (as <function>sd_notify()</function> or an equivalent API
287 needs to be invoked by the service at the appropriate time) — if it's not supported, then
288 <option>forking</option> is an alternative: it supports the traditional heavy-weight UNIX service
289 start-up protocol. Note that using any type other than <option>simple</option> possibly delays the
290 boot process, as the service manager needs to wait for at least some service initialization to
291 complete. (Also note it is generally not recommended to use <option>idle</option> or
292 <option>oneshot</option> for long-running services.)</para>
293
294 <para>Note that various service settings (e.g. <varname>User=</varname>, <varname>Group=</varname>
295 through libc NSS) might result in "hidden" blocking IPC calls to other services when
296 used. Sometimes it might be advisable to use the <option>simple</option> service type to ensure
297 that the service manager's transaction logic is not affected by such potentially slow operations
298 and hidden dependencies, as this is the only service type where the service manager will not wait
299 for such service execution setup operations to complete before proceeding.</para></listitem>
300 </varlistentry>
301
302 <varlistentry>
303 <term><varname>ExitType=</varname></term>
304
305 <listitem>
306 <para>Specifies when the manager should consider the service to be finished. One of <option>main</option> or
307 <option>cgroup</option>:</para>
308
309 <itemizedlist>
310 <listitem><para>If set to <option>main</option> (the default), the service manager
311 will consider the unit stopped when the main process, which is determined according to the
312 <varname>Type=</varname>, exits. Consequently, it cannot be used with
313 <varname>Type=</varname><option>oneshot</option>.</para></listitem>
314
315 <listitem><para>If set to <option>cgroup</option>, the service will be considered running as long as at
316 least one process in the cgroup has not exited.</para></listitem>
317 </itemizedlist>
318
319 <para>It is generally recommended to use <varname>ExitType=</varname><option>main</option> when a service has
320 a known forking model and a main process can reliably be determined. <varname>ExitType=</varname>
321 <option>cgroup</option> is meant for applications whose forking model is not known ahead of time and which
322 might not have a specific main process. It is well suited for transient or automatically generated services,
323 such as graphical applications inside of a desktop environment.</para>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry>
328 <term><varname>RemainAfterExit=</varname></term>
329
330 <listitem><para>Takes a boolean value that specifies whether
331 the service shall be considered active even when all its
332 processes exited. Defaults to <option>no</option>.</para>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry>
337 <term><varname>GuessMainPID=</varname></term>
338
339 <listitem><para>Takes a boolean value that specifies whether
340 systemd should try to guess the main PID of a service if it
341 cannot be determined reliably. This option is ignored unless
342 <option>Type=forking</option> is set and
343 <option>PIDFile=</option> is unset because for the other types
344 or with an explicitly configured PID file, the main PID is
345 always known. The guessing algorithm might come to incorrect
346 conclusions if a daemon consists of more than one process. If
347 the main PID cannot be determined, failure detection and
348 automatic restarting of a service will not work reliably.
349 Defaults to <option>yes</option>.</para>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry>
354 <term><varname>PIDFile=</varname></term>
355
356 <listitem><para>Takes a path referring to the PID file of the service. Usage of this option is recommended for
357 services where <varname>Type=</varname> is set to <option>forking</option>. The path specified typically points
358 to a file below <filename>/run/</filename>. If a relative path is specified it is hence prefixed with
359 <filename>/run/</filename>. The service manager will read the PID of the main process of the service from this
360 file after start-up of the service. The service manager will not write to the file configured here, although it
361 will remove the file after the service has shut down if it still exists. The PID file does not need to be owned
362 by a privileged user, but if it is owned by an unprivileged user additional safety restrictions are enforced:
363 the file may not be a symlink to a file owned by a different user (neither directly nor indirectly), and the
364 PID file must refer to a process already belonging to the service.</para>
365
366 <para>Note that PID files should be avoided in modern projects. Use <option>Type=notify</option>,
367 <option>Type=notify-reload</option> or <option>Type=simple</option> where possible, which does not
368 require use of PID files to determine the main process of a service and avoids needless
369 forking.</para></listitem>
370 </varlistentry>
371
372 <varlistentry>
373 <term><varname>BusName=</varname></term>
374
375 <listitem><para>Takes a D-Bus destination name that this service shall use. This option is mandatory
376 for services where <varname>Type=</varname> is set to <option>dbus</option>. It is recommended to
377 always set this property if known to make it easy to map the service name to the D-Bus destination.
378 In particular, <command>systemctl service-log-level/service-log-target</command> verbs make use of
379 this.</para>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry>
384 <term><varname>ExecStart=</varname></term>
385 <listitem><para>Commands that are executed when this service is started. The value is split into zero
386 or more command lines according to the rules described in the section "Command Lines" below.</para>
387
388 <para>Unless <varname>Type=</varname> is <option>oneshot</option>, exactly one command must be given. When
389 <varname>Type=oneshot</varname> is used, zero or more commands may be specified. Commands may be specified by
390 providing multiple command lines in the same directive, or alternatively, this directive may be specified more
391 than once with the same effect. If the empty string is assigned to this option, the list of commands to start
392 is reset, prior assignments of this option will have no effect. If no <varname>ExecStart=</varname> is
393 specified, then the service must have <varname>RemainAfterExit=yes</varname> and at least one
394 <varname>ExecStop=</varname> line set. (Services lacking both <varname>ExecStart=</varname> and
395 <varname>ExecStop=</varname> are not valid.)</para>
396
397 <para>If more than one command is specified, the commands are
398 invoked sequentially in the order they appear in the unit
399 file. If one of the commands fails (and is not prefixed with
400 <literal>-</literal>), other lines are not executed, and the
401 unit is considered failed.</para>
402
403 <para>Unless <varname>Type=forking</varname> is set, the
404 process started via this command line will be considered the
405 main process of the daemon.</para>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry>
410 <term><varname>ExecStartPre=</varname></term>
411 <term><varname>ExecStartPost=</varname></term>
412 <listitem><para>Additional commands that are executed before
413 or after the command in <varname>ExecStart=</varname>,
414 respectively. Syntax is the same as for
415 <varname>ExecStart=</varname>, except that multiple command
416 lines are allowed and the commands are executed one after the
417 other, serially.</para>
418
419 <para>If any of those commands (not prefixed with
420 <literal>-</literal>) fail, the rest are not executed and the
421 unit is considered failed.</para>
422
423 <para><varname>ExecStart=</varname> commands are only run after
424 all <varname>ExecStartPre=</varname> commands that were not prefixed
425 with a <literal>-</literal> exit successfully.</para>
426
427 <para><varname>ExecStartPost=</varname> commands are only run after the commands specified in
428 <varname>ExecStart=</varname> have been invoked successfully, as determined by
429 <varname>Type=</varname> (i.e. the process has been started for <varname>Type=simple</varname> or
430 <varname>Type=idle</varname>, the last <varname>ExecStart=</varname> process exited successfully for
431 <varname>Type=oneshot</varname>, the initial process exited successfully for
432 <varname>Type=forking</varname>, <literal>READY=1</literal> is sent for
433 <varname>Type=notify</varname>/<varname>Type=notify-reload</varname>, or the
434 <varname>BusName=</varname> has been taken for <varname>Type=dbus</varname>).</para>
435
436 <para>Note that <varname>ExecStartPre=</varname> may not be
437 used to start long-running processes. All processes forked
438 off by processes invoked via <varname>ExecStartPre=</varname> will
439 be killed before the next service process is run.</para>
440
441 <para>Note that if any of the commands specified in <varname>ExecStartPre=</varname>,
442 <varname>ExecStart=</varname>, or <varname>ExecStartPost=</varname> fail (and are not prefixed with
443 <literal>-</literal>, see above) or time out before the service is fully up, execution continues with commands
444 specified in <varname>ExecStopPost=</varname>, the commands in <varname>ExecStop=</varname> are skipped.</para>
445
446 <para>Note that the execution of <varname>ExecStartPost=</varname> is taken into account for the purpose of
447 <varname>Before=</varname>/<varname>After=</varname> ordering constraints.</para>
448 </listitem>
449 </varlistentry>
450
451 <varlistentry>
452 <term><varname>ExecCondition=</varname></term>
453 <listitem><para>Optional commands that are executed before the commands in <varname>ExecStartPre=</varname>.
454 Syntax is the same as for <varname>ExecStart=</varname>, except that multiple command lines are allowed and the
455 commands are executed one after the other, serially.</para>
456
457 <para>The behavior is like an <varname>ExecStartPre=</varname> and condition check hybrid: when an
458 <varname>ExecCondition=</varname> command exits with exit code 1 through 254 (inclusive), the remaining
459 commands are skipped and the unit is <emphasis>not</emphasis> marked as failed. However, if an
460 <varname>ExecCondition=</varname> command exits with 255 or abnormally (e.g. timeout, killed by a
461 signal, etc.), the unit will be considered failed (and remaining commands will be skipped). Exit code of 0 or
462 those matching <varname>SuccessExitStatus=</varname> will continue execution to the next commands.</para>
463
464 <para>The same recommendations about not running long-running processes in <varname>ExecStartPre=</varname>
465 also applies to <varname>ExecCondition=</varname>. <varname>ExecCondition=</varname> will also run the commands
466 in <varname>ExecStopPost=</varname>, as part of stopping the service, in the case of any non-zero or abnormal
467 exits, like the ones described above.</para>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry>
472 <term><varname>ExecReload=</varname></term>
473
474 <listitem><para>Commands to execute to trigger a configuration reload in the service. This argument
475 takes multiple command lines, following the same scheme as described for
476 <varname>ExecStart=</varname> above. Use of this setting is optional. Specifier and environment
477 variable substitution is supported here following the same scheme as for
478 <varname>ExecStart=</varname>.</para>
479
480 <para>One additional, special environment variable is set: if known, <varname>$MAINPID</varname> is
481 set to the main process of the daemon, and may be used for command lines like the following:</para>
482
483 <programlisting>ExecReload=kill -HUP $MAINPID</programlisting>
484
485 <para>Note however that reloading a daemon by enqueuing a signal (as with the example line above) is
486 usually not a good choice, because this is an asynchronous operation and hence not suitable when
487 ordering reloads of multiple services against each other. It is thus strongly recommended to either
488 use <varname>Type=</varname><option>notify-reload</option> in place of
489 <varname>ExecReload=</varname>, or to set <varname>ExecReload=</varname> to a command that not only
490 triggers a configuration reload of the daemon, but also synchronously waits for it to complete. For
491 example, <citerefentry
492 project='mankier'><refentrytitle>dbus-broker</refentrytitle><manvolnum>1</manvolnum></citerefentry>
493 uses the following:</para>
494
495 <programlisting>ExecReload=busctl call org.freedesktop.DBus \
496 /org/freedesktop/DBus org.freedesktop.DBus \
497 ReloadConfig
498 </programlisting>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry>
503 <term><varname>ExecStop=</varname></term>
504 <listitem><para>Commands to execute to stop the service started via
505 <varname>ExecStart=</varname>. This argument takes multiple command lines, following the same scheme
506 as described for <varname>ExecStart=</varname> above. Use of this setting is optional. After the
507 commands configured in this option are run, it is implied that the service is stopped, and any
508 processes remaining for it are terminated according to the <varname>KillMode=</varname> setting (see
509 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
510 If this option is not specified, the process is terminated by sending the signal specified in
511 <varname>KillSignal=</varname> or <varname>RestartKillSignal=</varname> when service stop is
512 requested. Specifier and environment variable substitution is supported (including
513 <varname>$MAINPID</varname>, see above).</para>
514
515 <para>Note that it is usually not sufficient to specify a command for this setting that only asks the
516 service to terminate (for example, by sending some form of termination signal to it), but does not
517 wait for it to do so. Since the remaining processes of the services are killed according to
518 <varname>KillMode=</varname> and <varname>KillSignal=</varname> or
519 <varname>RestartKillSignal=</varname> as described above immediately after the command exited, this
520 may not result in a clean stop. The specified command should hence be a synchronous operation, not an
521 asynchronous one.</para>
522
523 <para>Note that the commands specified in <varname>ExecStop=</varname> are only executed when the service
524 started successfully first. They are not invoked if the service was never started at all, or in case its
525 start-up failed, for example because any of the commands specified in <varname>ExecStart=</varname>,
526 <varname>ExecStartPre=</varname> or <varname>ExecStartPost=</varname> failed (and weren't prefixed with
527 <literal>-</literal>, see above) or timed out. Use <varname>ExecStopPost=</varname> to invoke commands when a
528 service failed to start up correctly and is shut down again. Also note that the stop operation is always
529 performed if the service started successfully, even if the processes in the service terminated on their
530 own or were killed. The stop commands must be prepared to deal with that case. <varname>$MAINPID</varname>
531 will be unset if systemd knows that the main process exited by the time the stop commands are called.</para>
532
533 <para>Service restart requests are implemented as stop operations followed by start operations. This
534 means that <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> are executed during a
535 service restart operation.</para>
536
537 <para>It is recommended to use this setting for commands that communicate with the service requesting
538 clean termination. For post-mortem clean-up steps use <varname>ExecStopPost=</varname> instead.
539 </para></listitem>
540 </varlistentry>
541
542 <varlistentry>
543 <term><varname>ExecStopPost=</varname></term>
544 <listitem><para>Additional commands that are executed after the service is stopped. This includes cases where
545 the commands configured in <varname>ExecStop=</varname> were used, where the service does not have any
546 <varname>ExecStop=</varname> defined, or where the service exited unexpectedly. This argument takes multiple
547 command lines, following the same scheme as described for <varname>ExecStart=</varname>. Use of these settings
548 is optional. Specifier and environment variable substitution is supported. Note that – unlike
549 <varname>ExecStop=</varname> – commands specified with this setting are invoked when a service failed to start
550 up correctly and is shut down again.</para>
551
552 <para>It is recommended to use this setting for clean-up operations that shall be executed even when the
553 service failed to start up correctly. Commands configured with this setting need to be able to operate even if
554 the service failed starting up half-way and left incompletely initialized data around. As the service's
555 processes have been terminated already when the commands specified with this setting are executed they should
556 not attempt to communicate with them.</para>
557
558 <para>Note that all commands that are configured with this setting are invoked with the result code of the
559 service, as well as the main process' exit code and status, set in the <varname>$SERVICE_RESULT</varname>,
560 <varname>$EXIT_CODE</varname> and <varname>$EXIT_STATUS</varname> environment variables, see
561 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
562 details.</para>
563
564 <para>Note that the execution of <varname>ExecStopPost=</varname> is taken into account for the purpose of
565 <varname>Before=</varname>/<varname>After=</varname> ordering constraints.</para></listitem>
566 </varlistentry>
567
568 <varlistentry>
569 <term><varname>RestartSec=</varname></term>
570 <listitem><para>Configures the time to sleep before restarting
571 a service (as configured with <varname>Restart=</varname>).
572 Takes a unit-less value in seconds, or a time span value such
573 as "5min 20s". Defaults to 100ms.</para></listitem>
574 </varlistentry>
575
576 <varlistentry>
577 <term><varname>RestartSteps=</varname></term>
578 <listitem><para>Configures the number of steps to take to increase the interval
579 of auto-restarts from <varname>RestartSec=</varname> to <varname>RestartMaxDelaySec=</varname>.
580 Takes a positive integer or 0 to disable it. Defaults to 0.</para>
581
582 <para>This setting is effective only if <varname>RestartMaxDelaySec=</varname> is also set.</para></listitem>
583 </varlistentry>
584
585 <varlistentry>
586 <term><varname>RestartMaxDelaySec=</varname></term>
587 <listitem><para>Configures the longest time to sleep before restarting a service
588 as the interval goes up with <varname>RestartSteps=</varname>. Takes a value
589 in the same format as <varname>RestartSec=</varname>, or <literal>infinity</literal>
590 to disable the setting. Defaults to <literal>infinity</literal>.</para>
591
592 <para>This setting is effective only if <varname>RestartSteps=</varname> is also set.</para></listitem>
593 </varlistentry>
594
595 <varlistentry>
596 <term><varname>TimeoutStartSec=</varname></term>
597 <listitem><para>Configures the time to wait for start-up. If a daemon service does not signal
598 start-up completion within the configured time, the service will be considered failed and will be
599 shut down again. The precise action depends on the <varname>TimeoutStartFailureMode=</varname>
600 option. Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass
601 <literal>infinity</literal> to disable the timeout logic. Defaults to
602 <varname>DefaultTimeoutStartSec=</varname> set in the manager, except when
603 <varname>Type=oneshot</varname> is used, in which case the timeout is disabled by default (see
604 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
605 </para>
606
607 <para>If a service of <varname>Type=notify</varname>/<varname>Type=notify-reload</varname> sends
608 <literal>EXTEND_TIMEOUT_USEC=…</literal>, this may cause the start time to be extended beyond
609 <varname>TimeoutStartSec=</varname>. The first receipt of this message must occur before
610 <varname>TimeoutStartSec=</varname> is exceeded, and once the start time has extended beyond
611 <varname>TimeoutStartSec=</varname>, the service manager will allow the service to continue to start,
612 provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified
613 until the service startup status is finished by <literal>READY=1</literal>. (see
614 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
615 </para></listitem>
616 </varlistentry>
617
618 <varlistentry>
619 <term><varname>TimeoutStopSec=</varname></term>
620 <listitem><para>This option serves two purposes. First, it configures the time to wait for each
621 <varname>ExecStop=</varname> command. If any of them times out, subsequent <varname>ExecStop=</varname> commands
622 are skipped and the service will be terminated by <constant>SIGTERM</constant>. If no <varname>ExecStop=</varname>
623 commands are specified, the service gets the <constant>SIGTERM</constant> immediately. This default behavior
624 can be changed by the <varname>TimeoutStopFailureMode=</varname> option. Second, it configures the time
625 to wait for the service itself to stop. If it doesn't terminate in the specified time, it will be forcibly terminated
626 by <constant>SIGKILL</constant> (see <varname>KillMode=</varname> in
627 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
628 Takes a unit-less value in seconds, or a time span value such
629 as "5min 20s". Pass <literal>infinity</literal> to disable the
630 timeout logic. Defaults to
631 <varname>DefaultTimeoutStopSec=</varname> from the manager
632 configuration file (see
633 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
634 </para>
635
636 <para>If a service of <varname>Type=notify</varname>/<varname>Type=notify-reload</varname> sends
637 <literal>EXTEND_TIMEOUT_USEC=…</literal>, this may cause the stop time to be extended beyond
638 <varname>TimeoutStopSec=</varname>. The first receipt of this message must occur before
639 <varname>TimeoutStopSec=</varname> is exceeded, and once the stop time has extended beyond
640 <varname>TimeoutStopSec=</varname>, the service manager will allow the service to continue to stop,
641 provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified,
642 or terminates itself (see
643 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
644 </para></listitem>
645 </varlistentry>
646
647 <varlistentry>
648 <term><varname>TimeoutAbortSec=</varname></term>
649 <listitem><para>This option configures the time to wait for the service to terminate when it was aborted due to a
650 watchdog timeout (see <varname>WatchdogSec=</varname>). If the service has a short <varname>TimeoutStopSec=</varname>
651 this option can be used to give the system more time to write a core dump of the service. Upon expiration the service
652 will be forcibly terminated by <constant>SIGKILL</constant> (see <varname>KillMode=</varname> in
653 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). The core file will
654 be truncated in this case. Use <varname>TimeoutAbortSec=</varname> to set a sensible timeout for the core dumping per
655 service that is large enough to write all expected data while also being short enough to handle the service failure
656 in due time.
657 </para>
658
659 <para>Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass an empty value to skip
660 the dedicated watchdog abort timeout handling and fall back <varname>TimeoutStopSec=</varname>. Pass
661 <literal>infinity</literal> to disable the timeout logic. Defaults to <varname>DefaultTimeoutAbortSec=</varname> from
662 the manager configuration file (see
663 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
664 </para>
665
666 <para>If a service of <varname>Type=notify</varname>/<varname>Type=notify-reload</varname> handles
667 <constant>SIGABRT</constant> itself (instead of relying on the kernel to write a core dump) it can
668 send <literal>EXTEND_TIMEOUT_USEC=…</literal> to extended the abort time beyond
669 <varname>TimeoutAbortSec=</varname>. The first receipt of this message must occur before
670 <varname>TimeoutAbortSec=</varname> is exceeded, and once the abort time has extended beyond
671 <varname>TimeoutAbortSec=</varname>, the service manager will allow the service to continue to abort,
672 provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified,
673 or terminates itself (see
674 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
675 </para></listitem>
676 </varlistentry>
677
678 <varlistentry>
679 <term><varname>TimeoutSec=</varname></term>
680 <listitem><para>A shorthand for configuring both
681 <varname>TimeoutStartSec=</varname> and
682 <varname>TimeoutStopSec=</varname> to the specified value.
683 </para></listitem>
684 </varlistentry>
685
686 <varlistentry>
687 <term><varname>TimeoutStartFailureMode=</varname></term>
688 <term><varname>TimeoutStopFailureMode=</varname></term>
689
690 <listitem><para>These options configure the action that is taken in case a daemon service does not signal
691 start-up within its configured <varname>TimeoutStartSec=</varname>, respectively if it does not stop within
692 <varname>TimeoutStopSec=</varname>. Takes one of <option>terminate</option>, <option>abort</option> and
693 <option>kill</option>. Both options default to <option>terminate</option>.</para>
694
695 <para>If <option>terminate</option> is set the service will be gracefully terminated by sending the signal
696 specified in <varname>KillSignal=</varname> (defaults to <constant>SIGTERM</constant>, see
697 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). If the
698 service does not terminate the <varname>FinalKillSignal=</varname> is sent after
699 <varname>TimeoutStopSec=</varname>. If <option>abort</option> is set, <varname>WatchdogSignal=</varname> is sent
700 instead and <varname>TimeoutAbortSec=</varname> applies before sending <varname>FinalKillSignal=</varname>.
701 This setting may be used to analyze services that fail to start-up or shut-down intermittently.
702 By using <option>kill</option> the service is immediately terminated by sending
703 <varname>FinalKillSignal=</varname> without any further timeout. This setting can be used to expedite the
704 shutdown of failing services.
705 </para></listitem>
706 </varlistentry>
707
708 <varlistentry>
709 <term><varname>RuntimeMaxSec=</varname></term>
710
711 <listitem><para>Configures a maximum time for the service to run. If this is used and the service has been
712 active for longer than the specified time it is terminated and put into a failure state. Note that this setting
713 does not have any effect on <varname>Type=oneshot</varname> services, as they terminate immediately after
714 activation completed. Pass <literal>infinity</literal> (the default) to configure no runtime
715 limit.</para>
716
717 <para>If a service of <varname>Type=notify</varname>/<varname>Type=notify-reload</varname> sends
718 <literal>EXTEND_TIMEOUT_USEC=…</literal>, this may cause the runtime to be extended beyond
719 <varname>RuntimeMaxSec=</varname>. The first receipt of this message must occur before
720 <varname>RuntimeMaxSec=</varname> is exceeded, and once the runtime has extended beyond
721 <varname>RuntimeMaxSec=</varname>, the service manager will allow the service to continue to run,
722 provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified
723 until the service shutdown is achieved by <literal>STOPPING=1</literal> (or termination). (see
724 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
725 </para></listitem>
726 </varlistentry>
727
728 <varlistentry>
729 <term><varname>RuntimeRandomizedExtraSec=</varname></term>
730
731 <listitem><para>This option modifies <varname>RuntimeMaxSec=</varname> by increasing the maximum runtime by an
732 evenly distributed duration between 0 and the specified value (in seconds). If <varname>RuntimeMaxSec=</varname> is
733 unspecified, then this feature will be disabled.
734 </para></listitem>
735 </varlistentry>
736
737 <varlistentry>
738 <term><varname>WatchdogSec=</varname></term>
739 <listitem><para>Configures the watchdog timeout for a service.
740 The watchdog is activated when the start-up is completed. The
741 service must call
742 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
743 regularly with <literal>WATCHDOG=1</literal> (i.e. the
744 "keep-alive ping"). If the time between two such calls is
745 larger than the configured time, then the service is placed in
746 a failed state and it will be terminated with
747 <constant>SIGABRT</constant> (or the signal specified by
748 <varname>WatchdogSignal=</varname>). By setting
749 <varname>Restart=</varname> to <option>on-failure</option>,
750 <option>on-watchdog</option>, <option>on-abnormal</option> or
751 <option>always</option>, the service will be automatically
752 restarted. The time configured here will be passed to the
753 executed service process in the
754 <varname>WATCHDOG_USEC=</varname> environment variable. This
755 allows daemons to automatically enable the keep-alive pinging
756 logic if watchdog support is enabled for the service. If this
757 option is used, <varname>NotifyAccess=</varname> (see below)
758 should be set to open access to the notification socket
759 provided by systemd. If <varname>NotifyAccess=</varname> is
760 not set, it will be implicitly set to <option>main</option>.
761 Defaults to 0, which disables this feature. The service can
762 check whether the service manager expects watchdog keep-alive
763 notifications. See
764 <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>
765 for details.
766 <citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
767 may be used to enable automatic watchdog notification support.
768 </para></listitem>
769 </varlistentry>
770
771 <varlistentry>
772 <term><varname>Restart=</varname></term>
773 <listitem><para>Configures whether the service shall be
774 restarted when the service process exits, is killed, or a
775 timeout is reached. The service process may be the main
776 service process, but it may also be one of the processes
777 specified with <varname>ExecStartPre=</varname>,
778 <varname>ExecStartPost=</varname>,
779 <varname>ExecStop=</varname>,
780 <varname>ExecStopPost=</varname>, or
781 <varname>ExecReload=</varname>. When the death of the process
782 is a result of systemd operation (e.g. service stop or
783 restart), the service will not be restarted. Timeouts include
784 missing the watchdog "keep-alive ping" deadline and a service
785 start, reload, and stop operation timeouts.</para>
786
787 <para>Takes one of
788 <option>no</option>,
789 <option>on-success</option>,
790 <option>on-failure</option>,
791 <option>on-abnormal</option>,
792 <option>on-watchdog</option>,
793 <option>on-abort</option>, or
794 <option>always</option>.
795 If set to <option>no</option> (the default), the service will
796 not be restarted. If set to <option>on-success</option>, it
797 will be restarted only when the service process exits cleanly.
798 In this context, a clean exit means any of the following:
799 <itemizedlist>
800 <listitem><simpara>exit code of 0;</simpara></listitem>
801 <listitem><simpara>for types other than
802 <varname>Type=oneshot</varname>, one of the signals
803 <constant>SIGHUP</constant>,
804 <constant>SIGINT</constant>,
805 <constant>SIGTERM</constant>, or
806 <constant>SIGPIPE</constant>;</simpara></listitem>
807 <listitem><simpara>exit statuses and signals specified in
808 <varname>SuccessExitStatus=</varname>.</simpara></listitem>
809 </itemizedlist>
810 If set to
811 <option>on-failure</option>, the service will be restarted
812 when the process exits with a non-zero exit code, is
813 terminated by a signal (including on core dump, but excluding
814 the aforementioned four signals), when an operation (such as
815 service reload) times out, and when the configured watchdog
816 timeout is triggered. If set to <option>on-abnormal</option>,
817 the service will be restarted when the process is terminated
818 by a signal (including on core dump, excluding the
819 aforementioned four signals), when an operation times out, or
820 when the watchdog timeout is triggered. If set to
821 <option>on-abort</option>, the service will be restarted only
822 if the service process exits due to an uncaught signal not
823 specified as a clean exit status. If set to
824 <option>on-watchdog</option>, the service will be restarted
825 only if the watchdog timeout for the service expires. If set
826 to <option>always</option>, the service will be restarted
827 regardless of whether it exited cleanly or not, got terminated
828 abnormally by a signal, or hit a timeout.</para>
829
830 <table>
831 <title>Exit causes and the effect of the <varname>Restart=</varname> settings</title>
832
833 <tgroup cols='2'>
834 <colspec colname='path' />
835 <colspec colname='expl' />
836 <thead>
837 <row>
838 <entry>Restart settings/Exit causes</entry>
839 <entry><option>no</option></entry>
840 <entry><option>always</option></entry>
841 <entry><option>on-success</option></entry>
842 <entry><option>on-failure</option></entry>
843 <entry><option>on-abnormal</option></entry>
844 <entry><option>on-abort</option></entry>
845 <entry><option>on-watchdog</option></entry>
846 </row>
847 </thead>
848 <tbody>
849 <row>
850 <entry>Clean exit code or signal</entry>
851 <entry/>
852 <entry>X</entry>
853 <entry>X</entry>
854 <entry/>
855 <entry/>
856 <entry/>
857 <entry/>
858 </row>
859 <row>
860 <entry>Unclean exit code</entry>
861 <entry/>
862 <entry>X</entry>
863 <entry/>
864 <entry>X</entry>
865 <entry/>
866 <entry/>
867 <entry/>
868 </row>
869 <row>
870 <entry>Unclean signal</entry>
871 <entry/>
872 <entry>X</entry>
873 <entry/>
874 <entry>X</entry>
875 <entry>X</entry>
876 <entry>X</entry>
877 <entry/>
878 </row>
879 <row>
880 <entry>Timeout</entry>
881 <entry/>
882 <entry>X</entry>
883 <entry/>
884 <entry>X</entry>
885 <entry>X</entry>
886 <entry/>
887 <entry/>
888 </row>
889 <row>
890 <entry>Watchdog</entry>
891 <entry/>
892 <entry>X</entry>
893 <entry/>
894 <entry>X</entry>
895 <entry>X</entry>
896 <entry/>
897 <entry>X</entry>
898 </row>
899 </tbody>
900 </tgroup>
901 </table>
902
903 <para>As exceptions to the setting above, the service will not
904 be restarted if the exit code or signal is specified in
905 <varname>RestartPreventExitStatus=</varname> (see below) or
906 the service is stopped with <command>systemctl stop</command>
907 or an equivalent operation. Also, the services will always be
908 restarted if the exit code or signal is specified in
909 <varname>RestartForceExitStatus=</varname> (see below).</para>
910
911 <para>Note that service restart is subject to unit start rate
912 limiting configured with <varname>StartLimitIntervalSec=</varname>
913 and <varname>StartLimitBurst=</varname>, see
914 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
915 for details.</para>
916
917 <para>Setting this to <option>on-failure</option> is the
918 recommended choice for long-running services, in order to
919 increase reliability by attempting automatic recovery from
920 errors. For services that shall be able to terminate on their
921 own choice (and avoid immediate restarting),
922 <option>on-abnormal</option> is an alternative choice.</para>
923 </listitem>
924 </varlistentry>
925
926 <varlistentry>
927 <term><varname>RestartMode=</varname></term>
928
929 <listitem>
930 <para>Takes a string value that specifies how a service should restart:
931 <itemizedlist>
932 <listitem><para>If set to <option>normal</option> (the default), the service restarts by
933 going through a failed/inactive state.</para></listitem>
934
935 <listitem><para>If set to <option>direct</option>, the service transitions to the activating
936 state directly during auto-restart, skipping failed/inactive state.
937 <varname>ExecStopPost=</varname> is invoked.
938 <varname>OnSuccess=</varname> and <varname>OnFailure=</varname> are skipped.</para></listitem>
939 </itemizedlist>
940 </para>
941
942 <para>This option is useful in cases where a dependency can fail temporarily
943 but we don't want these temporary failures to make the dependent units fail.
944 When this option is set to <option>direct</option>, dependent units are not notified of these temporary failures.</para>
945 </listitem>
946 </varlistentry>
947
948 <varlistentry>
949 <term><varname>SuccessExitStatus=</varname></term>
950
951 <listitem><para>Takes a list of exit status definitions that, when returned by the main service
952 process, will be considered successful termination, in addition to the normal successful exit status
953 0 and, except for <varname>Type=oneshot</varname>, the signals <constant>SIGHUP</constant>, <constant>SIGINT</constant>,
954 <constant>SIGTERM</constant>, and <constant>SIGPIPE</constant>. Exit status definitions can be
955 numeric termination statuses, termination status names, or termination signal names, separated by
956 spaces. See the Process Exit Codes section in
957 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
958 a list of termination status names (for this setting only the part without the
959 <literal>EXIT_</literal> or <literal>EX_</literal> prefix should be used). See <citerefentry
960 project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
961 a list of signal names.</para>
962
963 <para>Note that this setting does not change the mapping between numeric exit statuses and their
964 names, i.e. regardless how this setting is used 0 will still be mapped to <literal>SUCCESS</literal>
965 (and thus typically shown as <literal>0/SUCCESS</literal> in tool outputs) and 1 to
966 <literal>FAILURE</literal> (and thus typically shown as <literal>1/FAILURE</literal>), and so on. It
967 only controls what happens as effect of these exit statuses, and how it propagates to the state of
968 the service as a whole.</para>
969
970 <para>This option may appear more than once, in which case the list of successful exit statuses is
971 merged. If the empty string is assigned to this option, the list is reset, all prior assignments of
972 this option will have no effect.</para>
973
974 <example>
975 <title>A service with the <varname>SuccessExitStatus=</varname> setting</title>
976
977 <programlisting>SuccessExitStatus=TEMPFAIL 250 SIGKILL</programlisting>
978
979 <para>Exit status 75 (<constant>TEMPFAIL</constant>), 250, and the termination signal
980 <constant>SIGKILL</constant> are considered clean service terminations.</para>
981 </example>
982
983 <para>Note: <command>systemd-analyze exit-status</command> may be used to list exit statuses and
984 translate between numerical status values and names.</para></listitem>
985 </varlistentry>
986
987 <varlistentry>
988 <term><varname>RestartPreventExitStatus=</varname></term>
989
990 <listitem><para>Takes a list of exit status definitions that, when returned by the main service
991 process, will prevent automatic service restarts, regardless of the restart setting configured with
992 <varname>Restart=</varname>. Exit status definitions can either be numeric exit codes or termination
993 signal names, and are separated by spaces. Defaults to the empty list, so that, by default, no exit
994 status is excluded from the configured restart logic. For example:
995
996 <programlisting>RestartPreventExitStatus=1 6 SIGABRT</programlisting>
997
998 ensures that exit codes 1 and 6 and the termination signal <constant>SIGABRT</constant> will not
999 result in automatic service restarting. This option may appear more than once, in which case the list
1000 of restart-preventing statuses is merged. If the empty string is assigned to this option, the list is
1001 reset and all prior assignments of this option will have no effect.</para>
1002
1003 <para>Note that this setting has no effect on processes configured via
1004 <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecStop=</varname>,
1005 <varname>ExecStopPost=</varname> or <varname>ExecReload=</varname>, but only on the main service
1006 process, i.e. either the one invoked by <varname>ExecStart=</varname> or (depending on
1007 <varname>Type=</varname>, <varname>PIDFile=</varname>, …) the otherwise configured main
1008 process.</para></listitem>
1009 </varlistentry>
1010
1011 <varlistentry>
1012 <term><varname>RestartForceExitStatus=</varname></term>
1013 <listitem><para>Takes a list of exit status definitions that,
1014 when returned by the main service process, will force automatic
1015 service restarts, regardless of the restart setting configured
1016 with <varname>Restart=</varname>. The argument format is
1017 similar to
1018 <varname>RestartPreventExitStatus=</varname>.</para></listitem>
1019 </varlistentry>
1020
1021 <varlistentry>
1022 <term><varname>RootDirectoryStartOnly=</varname></term>
1023 <listitem><para>Takes a boolean argument. If true, the root
1024 directory, as configured with the
1025 <varname>RootDirectory=</varname> option (see
1026 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1027 for more information), is only applied to the process started
1028 with <varname>ExecStart=</varname>, and not to the various
1029 other <varname>ExecStartPre=</varname>,
1030 <varname>ExecStartPost=</varname>,
1031 <varname>ExecReload=</varname>, <varname>ExecStop=</varname>,
1032 and <varname>ExecStopPost=</varname> commands. If false, the
1033 setting is applied to all configured commands the same way.
1034 Defaults to false.</para></listitem>
1035 </varlistentry>
1036
1037 <varlistentry>
1038 <term><varname>NonBlocking=</varname></term>
1039 <listitem><para>Set the <constant>O_NONBLOCK</constant> flag for all file descriptors passed via socket-based
1040 activation. If true, all file descriptors >= 3 (i.e. all except stdin, stdout, stderr), excluding those passed
1041 in via the file descriptor storage logic (see <varname>FileDescriptorStoreMax=</varname> for details), will
1042 have the <constant>O_NONBLOCK</constant> flag set and hence are in non-blocking mode. This option is only
1043 useful in conjunction with a socket unit, as described in
1044 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> and has no
1045 effect on file descriptors which were previously saved in the file-descriptor store for example. Defaults to
1046 false.</para></listitem>
1047 </varlistentry>
1048
1049 <varlistentry>
1050 <term><varname>NotifyAccess=</varname></term>
1051 <listitem><para>Controls access to the service status notification socket, as accessible via the
1052 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1053 call. Takes one of <option>none</option> (the default), <option>main</option>, <option>exec</option>
1054 or <option>all</option>. If <option>none</option>, no daemon status updates are accepted from the
1055 service processes, all status update messages are ignored. If <option>main</option>, only service
1056 updates sent from the main process of the service are accepted. If <option>exec</option>, only
1057 service updates sent from any of the main or control processes originating from one of the
1058 <varname>Exec*=</varname> commands are accepted. If <option>all</option>, all services updates from
1059 all members of the service's control group are accepted. This option should be set to open access to
1060 the notification socket when using
1061 <varname>Type=notify</varname>/<varname>Type=notify-reload</varname> or
1062 <varname>WatchdogSec=</varname> (see above). If those options are used but
1063 <varname>NotifyAccess=</varname> is not configured, it will be implicitly set to
1064 <option>main</option>.</para>
1065
1066 <para>Note that <function>sd_notify()</function> notifications may be attributed to units correctly only if
1067 either the sending process is still around at the time PID 1 processes the message, or if the sending process
1068 is explicitly runtime-tracked by the service manager. The latter is the case if the service manager originally
1069 forked off the process, i.e. on all processes that match <option>main</option> or
1070 <option>exec</option>. Conversely, if an auxiliary process of the unit sends an
1071 <function>sd_notify()</function> message and immediately exits, the service manager might not be able to
1072 properly attribute the message to the unit, and thus will ignore it, even if
1073 <varname>NotifyAccess=</varname><option>all</option> is set for it.</para>
1074
1075 <para>Hence, to eliminate all race conditions involving lookup of the client's unit and attribution of notifications
1076 to units correctly, <function>sd_notify_barrier()</function> may be used. This call acts as a synchronization point
1077 and ensures all notifications sent before this call have been picked up by the service manager when it returns
1078 successfully. Use of <function>sd_notify_barrier()</function> is needed for clients which are not invoked by the
1079 service manager, otherwise this synchronization mechanism is unnecessary for attribution of notifications to the
1080 unit.</para></listitem>
1081 </varlistentry>
1082
1083 <varlistentry>
1084 <term><varname>Sockets=</varname></term>
1085 <listitem><para>Specifies the name of the socket units this
1086 service shall inherit socket file descriptors from when the
1087 service is started. Normally, it should not be necessary to use
1088 this setting, as all socket file descriptors whose unit shares
1089 the same name as the service (subject to the different unit
1090 name suffix of course) are passed to the spawned
1091 process.</para>
1092
1093 <para>Note that the same socket file descriptors may be passed
1094 to multiple processes simultaneously. Also note that a
1095 different service may be activated on incoming socket traffic
1096 than the one which is ultimately configured to inherit the
1097 socket file descriptors. Or, in other words: the
1098 <varname>Service=</varname> setting of
1099 <filename>.socket</filename> units does not have to match the
1100 inverse of the <varname>Sockets=</varname> setting of the
1101 <filename>.service</filename> it refers to.</para>
1102
1103 <para>This option may appear more than once, in which case the list of socket units is merged. Note
1104 that once set, clearing the list of sockets again (for example, by assigning the empty string to this
1105 option) is not supported.</para></listitem>
1106 </varlistentry>
1107
1108 <varlistentry>
1109 <term><varname>FileDescriptorStoreMax=</varname></term>
1110 <listitem><para>Configure how many file descriptors may be stored in the service manager for the
1111 service using
1112 <citerefentry><refentrytitle>sd_pid_notify_with_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>'s
1113 <literal>FDSTORE=1</literal> messages. This is useful for implementing services that can restart
1114 after an explicit request or a crash without losing state. Any open sockets and other file
1115 descriptors which should not be closed during the restart may be stored this way. Application state
1116 can either be serialized to a file in <varname>RuntimeDirectory=</varname>, or stored in a
1117 <citerefentry><refentrytitle>memfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1118 memory file descriptor. Defaults to 0, i.e. no file descriptors may be stored in the service
1119 manager. All file descriptors passed to the service manager from a specific service are passed back
1120 to the service's main process on the next service restart (see
1121 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
1122 details about the precise protocol used and the order in which the file descriptors are passed). Any
1123 file descriptors passed to the service manager are automatically closed when
1124 <constant>POLLHUP</constant> or <constant>POLLERR</constant> is seen on them, or when the service is
1125 fully stopped and no job is queued or being executed for it (the latter can be tweaked with
1126 <varname>FileDescriptorStorePreserve=</varname>, see below). If this option is used,
1127 <varname>NotifyAccess=</varname> (see above) should be set to open access to the notification socket
1128 provided by systemd. If <varname>NotifyAccess=</varname> is not set, it will be implicitly set to
1129 <option>main</option>.</para>
1130
1131 <para>The <command>fdstore</command> command of
1132 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1133 may be used to list the current contents of a service's file descriptor store.</para>
1134
1135 <para>Note that the service manager will only pass file descriptors contained in the file descriptor
1136 store to the service's own processes, never to other clients via IPC or similar. However, it does
1137 allow unprivileged clients to query the list of currently open file descriptors of a
1138 service. Sensitive data may hence be safely placed inside the referenced files, but should not be
1139 attached to the metadata (e.g. included in filenames) of the stored file
1140 descriptors.</para>
1141
1142 <para>If this option is set to a non-zero value the <varname>$FDSTORE</varname> environment variable
1143 will be set for processes invoked for this service. See
1144 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1145 details.</para></listitem>
1146 </varlistentry>
1147
1148 <varlistentry>
1149 <term><varname>FileDescriptorStorePreserve=</varname></term>
1150 <listitem><para>Takes one of <constant>no</constant>, <constant>yes</constant>,
1151 <constant>restart</constant> and controls when to release the service's file descriptor store
1152 (i.e. when to close the contained file descriptors, if any). If set to <constant>no</constant> the
1153 file descriptor store is automatically released when the service is stopped; if
1154 <constant>restart</constant> (the default) it is kept around as long as the unit is neither inactive
1155 nor failed, or a job is queued for the service, or the service is expected to be restarted. If
1156 <constant>yes</constant> the file descriptor store is kept around until the unit is removed from
1157 memory (i.e. is not referenced anymore and inactive). The latter is useful to keep entries in the
1158 file descriptor store pinned until the service manager exits.</para>
1159
1160 <para>Use <command>systemctl clean --what=fdstore …</command> to release the file descriptor store
1161 explicitly.</para></listitem>
1162 </varlistentry>
1163
1164 <varlistentry>
1165 <term><varname>USBFunctionDescriptors=</varname></term>
1166 <listitem><para>Configure the location of a file containing
1167 <ulink
1168 url="https://docs.kernel.org/usb/functionfs.html">USB
1169 FunctionFS</ulink> descriptors, for implementation of USB
1170 gadget functions. This is used only in conjunction with a
1171 socket unit with <varname>ListenUSBFunction=</varname>
1172 configured. The contents of this file are written to the
1173 <filename>ep0</filename> file after it is
1174 opened.</para></listitem>
1175 </varlistentry>
1176
1177 <varlistentry>
1178 <term><varname>USBFunctionStrings=</varname></term>
1179 <listitem><para>Configure the location of a file containing
1180 USB FunctionFS strings. Behavior is similar to
1181 <varname>USBFunctionDescriptors=</varname>
1182 above.</para></listitem>
1183 </varlistentry>
1184
1185 <varlistentry id='oom-policy'>
1186 <term><varname>OOMPolicy=</varname></term>
1187
1188 <listitem><para>Configure the out-of-memory (OOM) killing policy for the kernel and the userspace OOM
1189 killer
1190 <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
1191 On Linux, when memory becomes scarce to the point that the kernel has trouble allocating memory for
1192 itself, it might decide to kill a running process in order to free up memory and reduce memory
1193 pressure. Note that <filename>systemd-oomd.service</filename> is a more flexible solution that aims
1194 to prevent out-of-memory situations for the userspace too, not just the kernel, by attempting to
1195 terminate services earlier, before the kernel would have to act.</para>
1196
1197 <para>This setting takes one of <constant>continue</constant>, <constant>stop</constant> or
1198 <constant>kill</constant>. If set to <constant>continue</constant> and a process in the unit is
1199 killed by the OOM killer, this is logged but the unit continues running. If set to
1200 <constant>stop</constant> the event is logged but the unit is terminated cleanly by the service
1201 manager. If set to <constant>kill</constant> and one of the unit's processes is killed by the OOM
1202 killer the kernel is instructed to kill all remaining processes of the unit too, by setting the
1203 <filename>memory.oom.group</filename> attribute to <constant>1</constant>; also see <ulink
1204 url="https://docs.kernel.org/admin-guide/cgroup-v2.html">kernel documentation</ulink>.</para>
1205
1206 <para>Defaults to the setting <varname>DefaultOOMPolicy=</varname> in
1207 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1208 is set to, except for units where <varname>Delegate=</varname> is turned on, where it defaults to
1209 <constant>continue</constant>.</para>
1210
1211 <para>Use the <varname>OOMScoreAdjust=</varname> setting to configure whether processes of the unit
1212 shall be considered preferred or less preferred candidates for process termination by the Linux OOM
1213 killer logic. See
1214 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1215 details.</para>
1216
1217 <para>This setting also applies to
1218 <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
1219 Similarly to the kernel OOM kills performed by the kernel, this setting determines the state of the
1220 unit after <command>systemd-oomd</command> kills a cgroup associated with it.</para></listitem>
1221 </varlistentry>
1222
1223 <varlistentry>
1224 <term><varname>OpenFile=</varname></term>
1225 <listitem><para>Takes an argument of the form <literal>path<optional><replaceable>:fd-name:options</replaceable></optional></literal>,
1226 where:
1227 <itemizedlist>
1228 <listitem><simpara><literal>path</literal> is a path to a file or an <constant>AF_UNIX</constant> socket in the file system;</simpara></listitem>
1229 <listitem><simpara><literal>fd-name</literal> is a name that will be associated with the file descriptor;
1230 the name may contain any ASCII character, but must exclude control characters and ":", and must be at most 255 characters in length;
1231 it is optional and, if not provided, defaults to the file name;</simpara></listitem>
1232 <listitem><simpara><literal>options</literal> is a comma-separated list of access options;
1233 possible values are
1234 <literal>read-only</literal>,
1235 <literal>append</literal>,
1236 <literal>truncate</literal>,
1237 <literal>graceful</literal>;
1238 if not specified, files will be opened in <constant>rw</constant> mode;
1239 if <literal>graceful</literal> is specified, errors during file/socket opening are ignored.
1240 Specifying the same option several times is treated as an error.</simpara></listitem>
1241 </itemizedlist>
1242 The file or socket is opened by the service manager and the file descriptor is passed to the service.
1243 If the path is a socket, we call <function>connect()</function> on it.
1244 See <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1245 for more details on how to retrieve these file descriptors.</para>
1246
1247 <para>This setting is useful to allow services to access files/sockets that they can't access themselves
1248 (due to running in a separate mount namespace, not having privileges, ...).</para>
1249
1250 <para>This setting can be specified multiple times, in which case all the specified paths are opened and the file descriptors passed to the service.
1251 If the empty string is assigned, the entire list of open files defined prior to this is reset.</para></listitem>
1252 </varlistentry>
1253
1254 <varlistentry>
1255 <term><varname>ReloadSignal=</varname></term>
1256 <listitem><para>Configures the UNIX process signal to send to the service's main process when asked
1257 to reload the service's configuration. Defaults to <constant>SIGHUP</constant>. This option has no
1258 effect unless <varname>Type=</varname><option>notify-reload</option> is used, see
1259 above.</para></listitem>
1260 </varlistentry>
1261
1262 </variablelist>
1263
1264 <para id='shared-unit-options'>Check
1265 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1266 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and
1267 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
1268 settings.</para>
1269 </refsect1>
1270
1271 <refsect1>
1272 <title>Command lines</title>
1273
1274 <para>This section describes command line parsing and
1275 variable and specifier substitutions for
1276 <varname>ExecStart=</varname>,
1277 <varname>ExecStartPre=</varname>,
1278 <varname>ExecStartPost=</varname>,
1279 <varname>ExecReload=</varname>,
1280 <varname>ExecStop=</varname>, and
1281 <varname>ExecStopPost=</varname> options.</para>
1282
1283 <para>Multiple command lines may be concatenated in a single directive by separating them with semicolons
1284 (these semicolons must be passed as separate words). Lone semicolons may be escaped as
1285 <literal>\;</literal>.</para>
1286
1287 <para>Each command line is unquoted using the rules described in "Quoting" section in
1288 <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
1289 first item becomes the command to execute, and the subsequent items the arguments.</para>
1290
1291 <para>This syntax is inspired by shell syntax, but only the meta-characters and expansions
1292 described in the following paragraphs are understood, and the expansion of variables is
1293 different. Specifically, redirection using
1294 <literal>&lt;</literal>,
1295 <literal>&lt;&lt;</literal>,
1296 <literal>&gt;</literal>, and
1297 <literal>&gt;&gt;</literal>, pipes using
1298 <literal>|</literal>, running programs in the background using
1299 <literal>&amp;</literal>, and <emphasis>other elements of shell
1300 syntax are not supported</emphasis>.</para>
1301
1302 <para>The command to execute may contain spaces, but control characters are not allowed.</para>
1303
1304 <para>Each command may be prefixed with a number of special characters:</para>
1305
1306 <table>
1307 <title>Special executable prefixes</title>
1308
1309 <tgroup cols='2'>
1310 <colspec colname='prefix'/>
1311 <colspec colname='meaning'/>
1312
1313 <thead>
1314 <row>
1315 <entry>Prefix</entry>
1316 <entry>Effect</entry>
1317 </row>
1318 </thead>
1319 <tbody>
1320 <row>
1321 <entry><literal>@</literal></entry>
1322 <entry>If the executable path is prefixed with <literal>@</literal>, the second specified token will be passed as <constant>argv[0]</constant> to the executed process (instead of the actual filename), followed by the further arguments specified.</entry>
1323 </row>
1324
1325 <row>
1326 <entry><literal>-</literal></entry>
1327 <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>
1328 </row>
1329
1330 <row>
1331 <entry><literal>:</literal></entry>
1332 <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>
1333 </row>
1334
1335 <row>
1336 <entry><literal>+</literal></entry>
1337 <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). However, note that this will not bypass options that apply to the whole control group, such as <varname>DevicePolicy=</varname>, see <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the full list.</entry>
1338 </row>
1339
1340 <row>
1341 <entry><literal>!</literal></entry>
1342
1343 <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>
1344 </row>
1345
1346 <row>
1347 <entry><literal>!!</literal></entry>
1348
1349 <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>
1350 </row>
1351 </tbody>
1352 </tgroup>
1353 </table>
1354
1355 <para><literal>@</literal>, <literal>-</literal>, <literal>:</literal>, and one of
1356 <literal>+</literal>/<literal>!</literal>/<literal>!!</literal> may be used together and they can appear in any
1357 order. However, only one of <literal>+</literal>, <literal>!</literal>, <literal>!!</literal> may be used at a
1358 time.</para>
1359
1360 <para>For each command, the first argument must be either an absolute path to an executable or a simple
1361 file name without any slashes. If the command is not a full (absolute) path, it will be resolved to a
1362 full path using a fixed search path determined at compilation time. Searched directories include
1363 <filename>/usr/local/bin/</filename>, <filename>/usr/bin/</filename>, <filename>/bin/</filename> on
1364 systems using split <filename>/usr/bin/</filename> and <filename>/bin/</filename> directories, and their
1365 <filename>sbin/</filename> counterparts on systems using split <filename>bin/</filename> and
1366 <filename>sbin/</filename>. It is thus safe to use just the executable name in case of executables
1367 located in any of the "standard" directories, and an absolute path must be used in other cases. Using an
1368 absolute path is recommended to avoid ambiguity. Hint: this search path may be queried using
1369 <command>systemd-path search-binaries-default</command>.</para>
1370
1371 <para>The command line accepts <literal>%</literal> specifiers as described in
1372 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1373
1374 <para>Basic environment variable substitution is supported. Use
1375 <literal>${FOO}</literal> as part of a word, or as a word of its
1376 own, on the command line, in which case it will be erased and replaced
1377 by the exact value of the environment variable (if any) including all
1378 whitespace it contains, always resulting in exactly a single argument.
1379 Use <literal>$FOO</literal> as a separate word on the command line, in
1380 which case it will be replaced by the value of the environment
1381 variable split at whitespace, resulting in zero or more arguments.
1382 For this type of expansion, quotes are respected when splitting
1383 into words, and afterwards removed.</para>
1384
1385 <para>Example:</para>
1386
1387 <programlisting>Environment="ONE=one" 'TWO=two two'
1388 ExecStart=echo $ONE $TWO ${TWO}</programlisting>
1389
1390 <para>This will execute <command>/bin/echo</command> with four
1391 arguments: <literal>one</literal>, <literal>two</literal>,
1392 <literal>two</literal>, and <literal>two two</literal>.</para>
1393
1394 <para>Example:</para>
1395 <programlisting>Environment=ONE='one' "TWO='two two' too" THREE=
1396 ExecStart=/bin/echo ${ONE} ${TWO} ${THREE}
1397 ExecStart=/bin/echo $ONE $TWO $THREE</programlisting>
1398 <para>This results in <filename>/bin/echo</filename> being
1399 called twice, the first time with arguments
1400 <literal>'one'</literal>,
1401 <literal>'two two' too</literal>, <literal></literal>,
1402 and the second time with arguments
1403 <literal>one</literal>, <literal>two two</literal>,
1404 <literal>too</literal>.
1405 </para>
1406
1407 <para>To pass a literal dollar sign, use <literal>$$</literal>.
1408 Variables whose value is not known at expansion time are treated
1409 as empty strings. Note that the first argument (i.e. the program
1410 to execute) may not be a variable.</para>
1411
1412 <para>Variables to be used in this fashion may be defined through
1413 <varname>Environment=</varname> and
1414 <varname>EnvironmentFile=</varname>. In addition, variables listed
1415 in the section "Environment variables in spawned processes" in
1416 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1417 which are considered "static configuration", may be used (this
1418 includes e.g. <varname>$USER</varname>, but not
1419 <varname>$TERM</varname>).</para>
1420
1421 <para>Note that shell command lines are not directly supported. If
1422 shell command lines are to be used, they need to be passed
1423 explicitly to a shell implementation of some kind. Example:</para>
1424 <programlisting>ExecStart=sh -c 'dmesg | tac'</programlisting>
1425
1426 <para>Example:</para>
1427
1428 <programlisting>ExecStart=echo one ; echo "two two"</programlisting>
1429
1430 <para>This will execute <command>echo</command> two times,
1431 each time with one argument: <literal>one</literal> and
1432 <literal>two two</literal>, respectively. Because two commands are
1433 specified, <varname>Type=oneshot</varname> must be used.</para>
1434
1435 <para>Example:</para>
1436
1437 <programlisting>Type=oneshot
1438 ExecStart=:echo $USER ; -false ; +:@true $TEST</programlisting>
1439
1440 <para>This will execute <command>/usr/bin/echo</command> with the literal argument
1441 <literal>$USER</literal> (<literal>:</literal> suppresses variable expansion), and then
1442 <command>/usr/bin/false</command> (the return value will be ignored because <literal>-</literal>
1443 suppresses checking of the return value), and <command>/usr/bin/true</command> (with elevated privileges,
1444 with <literal>$TEST</literal> as <constant>argv[0]</constant>).</para>
1445
1446 <para>Example:</para>
1447
1448 <programlisting>ExecStart=echo / &gt;/dev/null &amp; \; \
1449 ls</programlisting>
1450
1451 <para>This will execute <command>echo</command>
1452 with five arguments: <literal>/</literal>,
1453 <literal>&gt;/dev/null</literal>,
1454 <literal>&amp;</literal>, <literal>;</literal>, and
1455 <literal>ls</literal>.</para>
1456 </refsect1>
1457
1458 <refsect1>
1459 <title>Examples</title>
1460
1461 <example>
1462 <title>Simple service</title>
1463
1464 <para>The following unit file creates a service that will
1465 execute <filename index="false">/usr/sbin/foo-daemon</filename>. Since no
1466 <varname>Type=</varname> is specified, the default
1467 <varname>Type=</varname><option>simple</option> will be assumed.
1468 systemd will assume the unit to be started immediately after the
1469 program has begun executing.</para>
1470
1471 <programlisting>[Unit]
1472 Description=Foo
1473
1474 [Service]
1475 ExecStart=/usr/sbin/foo-daemon
1476
1477 [Install]
1478 WantedBy=multi-user.target</programlisting>
1479
1480 <para>Note that systemd assumes here that the process started by
1481 systemd will continue running until the service terminates. If
1482 the program daemonizes itself (i.e. forks), please use
1483 <varname>Type=</varname><option>forking</option> instead.</para>
1484
1485 <para>Since no <varname>ExecStop=</varname> was specified,
1486 systemd will send SIGTERM to all processes started from this
1487 service, and after a timeout also SIGKILL. This behavior can be
1488 modified, see
1489 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1490 for details.</para>
1491
1492 <para>Note that this unit type does not include any type of notification when a service has completed
1493 initialization. For this, you should use other unit types, such as
1494 <varname>Type=</varname><option>notify</option>/<varname>Type=</varname><option>notify-reload</option>
1495 if the service understands systemd's notification protocol,
1496 <varname>Type=</varname><option>forking</option> if the service can background itself or
1497 <varname>Type=</varname><option>dbus</option> if the unit acquires a DBus name once initialization is
1498 complete. See below.</para>
1499 </example>
1500
1501 <example>
1502 <title>Oneshot service</title>
1503
1504 <para>Sometimes, units should just execute an action without
1505 keeping active processes, such as a filesystem check or a
1506 cleanup action on boot. For this,
1507 <varname>Type=</varname><option>oneshot</option> exists. Units
1508 of this type will wait until the process specified terminates
1509 and then fall back to being inactive. The following unit will
1510 perform a cleanup action:</para>
1511
1512 <programlisting>[Unit]
1513 Description=Cleanup old Foo data
1514
1515 [Service]
1516 Type=oneshot
1517 ExecStart=/usr/sbin/foo-cleanup
1518
1519 [Install]
1520 WantedBy=multi-user.target</programlisting>
1521
1522 <para>Note that systemd will consider the unit to be in the
1523 state "starting" until the program has terminated, so ordered
1524 dependencies will wait for the program to finish before starting
1525 themselves. The unit will revert to the "inactive" state after
1526 the execution is done, never reaching the "active" state. That
1527 means another request to start the unit will perform the action
1528 again.</para>
1529
1530 <para><varname>Type=</varname><option>oneshot</option> are the
1531 only service units that may have more than one
1532 <varname>ExecStart=</varname> specified. For units with multiple
1533 commands (<varname index="false">Type=oneshot</varname>), all commands will be run again.</para>
1534 <para> For <varname index="false">Type=oneshot</varname>, <varname>Restart=</varname><option>always</option>
1535 and <varname>Restart=</varname><option>on-success</option> are <emphasis>not</emphasis> allowed.</para>
1536 </example>
1537
1538 <example>
1539 <title>Stoppable oneshot service</title>
1540
1541 <para>Similarly to the oneshot services, there are sometimes
1542 units that need to execute a program to set up something and
1543 then execute another to shut it down, but no process remains
1544 active while they are considered "started". Network
1545 configuration can sometimes fall into this category. Another use
1546 case is if a oneshot service shall not be executed each time
1547 when they are pulled in as a dependency, but only the first
1548 time.</para>
1549
1550 <para>For this, systemd knows the setting
1551 <varname>RemainAfterExit=</varname><option>yes</option>, which
1552 causes systemd to consider the unit to be active if the start
1553 action exited successfully. This directive can be used with all
1554 types, but is most useful with
1555 <varname>Type=</varname><option>oneshot</option> and
1556 <varname>Type=</varname><option>simple</option>. With
1557 <varname>Type=</varname><option>oneshot</option>, systemd waits
1558 until the start action has completed before it considers the
1559 unit to be active, so dependencies start only after the start
1560 action has succeeded. With
1561 <varname>Type=</varname><option>simple</option>, dependencies
1562 will start immediately after the start action has been
1563 dispatched. The following unit provides an example for a simple
1564 static firewall.</para>
1565
1566 <programlisting>[Unit]
1567 Description=Simple firewall
1568
1569 [Service]
1570 Type=oneshot
1571 RemainAfterExit=yes
1572 ExecStart=/usr/local/sbin/simple-firewall-start
1573 ExecStop=/usr/local/sbin/simple-firewall-stop
1574
1575 [Install]
1576 WantedBy=multi-user.target</programlisting>
1577
1578 <para>Since the unit is considered to be running after the start
1579 action has exited, invoking <command>systemctl start</command>
1580 on that unit again will cause no action to be taken.</para>
1581 </example>
1582
1583 <example>
1584 <title>Traditional forking services</title>
1585
1586 <para>Many traditional daemons/services background (i.e. fork,
1587 daemonize) themselves when starting. Set
1588 <varname>Type=</varname><option>forking</option> in the
1589 service's unit file to support this mode of operation. systemd
1590 will consider the service to be in the process of initialization
1591 while the original program is still running. Once it exits
1592 successfully and at least a process remains (and
1593 <varname>RemainAfterExit=</varname><option>no</option>), the
1594 service is considered started.</para>
1595
1596 <para>Often, a traditional daemon only consists of one process.
1597 Therefore, if only one process is left after the original
1598 process terminates, systemd will consider that process the main
1599 process of the service. In that case, the
1600 <varname>$MAINPID</varname> variable will be available in
1601 <varname>ExecReload=</varname>, <varname>ExecStop=</varname>,
1602 etc.</para>
1603
1604 <para>In case more than one process remains, systemd will be
1605 unable to determine the main process, so it will not assume
1606 there is one. In that case, <varname>$MAINPID</varname> will not
1607 expand to anything. However, if the process decides to write a
1608 traditional PID file, systemd will be able to read the main PID
1609 from there. Please set <varname>PIDFile=</varname> accordingly.
1610 Note that the daemon should write that file before finishing
1611 with its initialization. Otherwise, systemd might try to read the
1612 file before it exists.</para>
1613
1614 <para>The following example shows a simple daemon that forks and
1615 just starts one process in the background:</para>
1616
1617 <programlisting>[Unit]
1618 Description=Some simple daemon
1619
1620 [Service]
1621 Type=forking
1622 ExecStart=/usr/sbin/my-simple-daemon -d
1623
1624 [Install]
1625 WantedBy=multi-user.target</programlisting>
1626
1627 <para>Please see
1628 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1629 for details on how you can influence the way systemd terminates
1630 the service.</para>
1631 </example>
1632
1633 <example>
1634 <title>DBus services</title>
1635
1636 <para>For services that acquire a name on the DBus system bus,
1637 use <varname>Type=</varname><option>dbus</option> and set
1638 <varname>BusName=</varname> accordingly. The service should not
1639 fork (daemonize). systemd will consider the service to be
1640 initialized once the name has been acquired on the system bus.
1641 The following example shows a typical DBus service:</para>
1642
1643 <programlisting>[Unit]
1644 Description=Simple DBus service
1645
1646 [Service]
1647 Type=dbus
1648 BusName=org.example.simple-dbus-service
1649 ExecStart=/usr/sbin/simple-dbus-service
1650
1651 [Install]
1652 WantedBy=multi-user.target</programlisting>
1653
1654 <para>For <emphasis>bus-activatable</emphasis> services, do not
1655 include a [Install] section in the systemd
1656 service file, but use the <varname>SystemdService=</varname>
1657 option in the corresponding DBus service file, for example
1658 (<filename>/usr/share/dbus-1/system-services/org.example.simple-dbus-service.service</filename>):</para>
1659
1660 <programlisting>[D-BUS Service]
1661 Name=org.example.simple-dbus-service
1662 Exec=/usr/sbin/simple-dbus-service
1663 User=root
1664 SystemdService=simple-dbus-service.service</programlisting>
1665
1666 <para>Please see
1667 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1668 for details on how you can influence the way systemd terminates
1669 the service.</para>
1670 </example>
1671
1672 <example>
1673 <title>Services that notify systemd about their initialization</title>
1674
1675 <para><varname>Type=</varname><option>simple</option> services are really easy to write, but have the
1676 major disadvantage of systemd not being able to tell when initialization of the given service is
1677 complete. For this reason, systemd supports a simple notification protocol that allows daemons to make
1678 systemd aware that they are done initializing. Use <varname>Type=</varname><option>notify</option> or
1679 <varname>Type=</varname><option>notify-reload</option> for this. A typical service file for such a
1680 daemon would look like this:</para>
1681
1682 <programlisting>[Unit]
1683 Description=Simple notifying service
1684
1685 [Service]
1686 Type=notify
1687 ExecStart=/usr/sbin/simple-notifying-service
1688
1689 [Install]
1690 WantedBy=multi-user.target</programlisting>
1691
1692 <para>Note that the daemon has to support systemd's notification
1693 protocol, else systemd will think the service has not started yet
1694 and kill it after a timeout. For an example of how to update
1695 daemons to support this protocol transparently, take a look at
1696 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1697 systemd will consider the unit to be in the 'starting' state
1698 until a readiness notification has arrived.</para>
1699
1700 <para>Please see
1701 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1702 for details on how you can influence the way systemd terminates
1703 the service.</para>
1704 </example>
1705 </refsect1>
1706
1707 <refsect1>
1708 <title>See Also</title>
1709 <para>
1710 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1711 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1712 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1713 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1714 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1715 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1716 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1717 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1718 <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1719 </para>
1720 </refsect1>
1721
1722 </refentry>