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