chiark / gitweb /
00a6398a1e1ac2adff0dddc36d2e433df5aad60d
[elogind.git] / man / systemd.service.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <!--
7   This file is part of systemd.
8
9   Copyright 2010 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU Lesser General Public License as published by
13   the Free Software Foundation; either version 2.1 of the License, or
14   (at your option) any later version.
15
16   systemd is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   Lesser General Public License for more details.
20
21   You should have received a copy of the GNU Lesser General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 -->
24
25 <refentry id="systemd.service">
26         <refentryinfo>
27                 <title>systemd.service</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>systemd.service</refentrytitle>
42                 <manvolnum>5</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>systemd.service</refname>
47                 <refpurpose>Service unit configuration</refpurpose>
48         </refnamediv>
49
50         <refsynopsisdiv>
51                 <para><filename>systemd.service</filename></para>
52         </refsynopsisdiv>
53
54         <refsect1>
55                 <title>Description</title>
56
57                 <para>A unit configuration file whose name ends in
58                 <filename>.service</filename> encodes information
59                 about a process controlled and supervised by
60                 systemd.</para>
61
62                 <para>This man page lists the configuration options
63                 specific to this unit type. See
64                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
65                 for the common options of all unit configuration
66                 files. The common configuration items are configured
67                 in the generic <literal>[Unit]</literal> and
68                 <literal>[Install]</literal> sections. The service
69                 specific configuration options are configured in the
70                 <literal>[Service]</literal> section.</para>
71
72                 <para>Additional options are listed in
73                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
74                 which define the execution environment the commands
75                 are executed in, and in
76                 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
77                 which define the way the processes of the service are
78                 terminated.</para>
79
80                 <para>Unless <varname>DefaultDependencies=</varname>
81                 is set to <option>false</option>, service units will
82                 implicitly have dependencies of type
83                 <varname>Requires=</varname> and
84                 <varname>After=</varname> on
85                 <filename>basic.target</filename> as well as
86                 dependencies of type <varname>Conflicts=</varname> and
87                 <varname>Before=</varname> on
88                 <filename>shutdown.target</filename>. These ensure
89                 that normal service units pull in basic system
90                 initialization, and are terminated cleanly prior to
91                 system shutdown. Only services involved with early
92                 boot or late system shutdown should disable this
93                 option.</para>
94
95                 <para>If a service is requested under a certain name
96                 but no unit configuration file is found, systemd looks
97                 for a SysV init script by the same name (with the
98                 <filename>.service</filename> suffix removed) and
99                 dynamically creates a service unit from that
100                 script. This is useful for compatibility with
101                 SysV. Note that this compatibility is quite
102                 comprehensive but not 100%. For details about the
103                 incompatibilities see the <ulink
104                 url="http://www.freedesktop.org/wiki/Software/systemd/Incompatibilities">Incompatibilities
105                 with SysV</ulink> document.
106                 </para>
107         </refsect1>
108
109         <refsect1>
110                 <title>Options</title>
111
112                 <para>Service files must include a
113                 <literal>[Service]</literal> section, which carries
114                 information about the service and the process it
115                 supervises. A number of options that may be used in
116                 this section are shared with other unit types. These
117                 options are documented in
118                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
119                 and
120                 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
121                 options specific to the <literal>[Service]</literal>
122                 section of service units are the following:</para>
123
124                 <variablelist>
125                         <varlistentry>
126                                 <term><varname>Type=</varname></term>
127
128                                 <listitem><para>Configures the process
129                                 start-up type for this service
130                                 unit. One of <option>simple</option>,
131                                 <option>forking</option>,
132                                 <option>oneshot</option>,
133                                 <option>dbus</option>,
134                                 <option>notify</option> or
135                                 <option>idle</option>.</para>
136
137                                 <para>If set to
138                                 <option>simple</option> (the default
139                                 value if <varname>BusName=</varname>
140                                 is not specified) it is expected that
141                                 the process configured with
142                                 <varname>ExecStart=</varname> is the
143                                 main process of the service. In this
144                                 mode, if the process offers
145                                 functionality to other processes on
146                                 the system its communication channels
147                                 should be installed before the daemon
148                                 is started up (e.g. sockets set up by
149                                 systemd, via socket activation), as
150                                 systemd will immediately proceed
151                                 starting follow-up units.</para>
152
153                                 <para>If set to
154                                 <option>forking</option> it is
155                                 expected that the process configured
156                                 with <varname>ExecStart=</varname>
157                                 will call <function>fork()</function>
158                                 as part of its start-up. The parent process is
159                                 expected to exit when start-up is
160                                 complete and all communication
161                                 channels set up. The child continues
162                                 to run as the main daemon
163                                 process. This is the behavior of
164                                 traditional UNIX daemons. If this
165                                 setting is used, it is recommended to
166                                 also use the
167                                 <varname>PIDFile=</varname> option, so
168                                 that systemd can identify the main
169                                 process of the daemon. systemd will
170                                 proceed starting follow-up units as
171                                 soon as the parent process
172                                 exits.</para>
173
174                                 <para>Behavior of
175                                 <option>oneshot</option> is similar
176                                 to <option>simple</option>, however
177                                 it is expected that the process has to
178                                 exit before systemd starts follow-up
179                                 units. <varname>RemainAfterExit=</varname>
180                                 is particularly useful for this type
181                                 of service.</para>
182
183                                 <para>Behavior of
184                                 <option>dbus</option> is similar to
185                                 <option>simple</option>, however it is
186                                 expected that the daemon acquires a
187                                 name on the D-Bus bus, as configured
188                                 by
189                                 <varname>BusName=</varname>. systemd
190                                 will proceed starting follow-up units
191                                 after the D-Bus bus name has been
192                                 acquired. Service units with this
193                                 option configured implicitly gain
194                                 dependencies on the
195                                 <filename>dbus.socket</filename>
196                                 unit. This type is the default if
197                                 <varname>BusName=</varname> is
198                                 specified.</para>
199
200                                 <para>Behavior of
201                                 <option>notify</option> is similar to
202                                 <option>simple</option>, however it is
203                                 expected that the daemon sends a
204                                 notification message via
205                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
206                                 or an equivalent call when it finished
207                                 starting up. systemd will proceed
208                                 starting follow-up units after this
209                                 notification message has been sent. If
210                                 this option is used
211                                 <varname>NotifyAccess=</varname> (see
212                                 below) should be set to open access to
213                                 the notification socket provided by
214                                 systemd. If
215                                 <varname>NotifyAccess=</varname> is
216                                 not set, it will be implicitly set to
217                                 <option>main</option>.</para>
218
219                                 <para>Behavior of
220                                 <option>idle</option> is very similar
221                                 to <option>simple</option>, however
222                                 actual execution of the service
223                                 binary is delayed until all jobs are
224                                 dispatched. This may be used to avoid
225                                 interleaving of output of shell
226                                 services with the status output on the
227                                 console.</para>
228                                 </listitem>
229                         </varlistentry>
230
231                         <varlistentry>
232                                 <term><varname>RemainAfterExit=</varname></term>
233
234                                 <listitem><para>Takes a boolean value
235                                 that specifies whether the service
236                                 shall be considered active even when
237                                 all its processes exited. Defaults to
238                                 <option>no</option>.</para>
239                                 </listitem>
240                         </varlistentry>
241
242                         <varlistentry>
243                                 <term><varname>GuessMainPID=</varname></term>
244
245                                 <listitem><para>Takes a boolean value
246                                 that specifies whether systemd should
247                                 try to guess the main PID of a service
248                                 if it cannot be determined
249                                 reliably. This option is ignored
250                                 unless <option>Type=forking</option>
251                                 is set and <option>PIDFile=</option>
252                                 is unset because for the other types
253                                 or with an explicitly configured PID
254                                 file the main PID is always known. The
255                                 guessing algorithm might come to
256                                 incorrect conclusions if a daemon
257                                 consists of more than one process. If
258                                 the main PID cannot be determined
259                                 failure detection and automatic
260                                 restarting of a service will not work
261                                 reliably. Defaults to
262                                 <option>yes</option>.</para>
263                                 </listitem>
264                         </varlistentry>
265
266                         <varlistentry>
267                                 <term><varname>PIDFile=</varname></term>
268
269                                 <listitem><para>Takes an absolute file
270                                 name pointing to the PID file of this
271                                 daemon. Use of this option is
272                                 recommended for services where
273                                 <varname>Type=</varname> is set to
274                                 <option>forking</option>. systemd will
275                                 read the PID of the main process of
276                                 the daemon after start-up of the
277                                 service. systemd will not write to the
278                                 file configured here.</para>
279                                 </listitem>
280                         </varlistentry>
281
282                         <varlistentry>
283                                 <term><varname>BusName=</varname></term>
284
285                                 <listitem><para>Takes a D-Bus bus
286                                 name, that this service is reachable
287                                 as. This option is mandatory for
288                                 services where
289                                 <varname>Type=</varname> is set to
290                                 <option>dbus</option>, but its use
291                                 is otherwise recommended as well if
292                                 the process takes a name on the D-Bus
293                                 bus.</para>
294                                 </listitem>
295                         </varlistentry>
296
297                         <varlistentry>
298                                 <term><varname>ExecStart=</varname></term>
299                                 <listitem><para>Takes a command line
300                                 that is executed when this service
301                                 shall be started up. The first token
302                                 of the command line must be an
303                                 absolute file name, then followed by
304                                 arguments for the process. It is
305                                 mandatory to set this option for all
306                                 services. This option may not be
307                                 specified more than once, except when
308                                 <varname>Type=oneshot</varname> is
309                                 used in which case more than one
310                                 <varname>ExecStart=</varname> line is
311                                 accepted which are then invoked one by
312                                 one, sequentially in the order they
313                                 appear in the unit file.</para>
314
315                                 <para>Optionally, if the absolute file
316                                 name is prefixed with
317                                 <literal>@</literal>, the second token
318                                 will be passed as
319                                 <literal>argv[0]</literal> to the
320                                 executed process, followed by the
321                                 further arguments specified. If the
322                                 first token is prefixed with
323                                 <literal>-</literal> an exit code of
324                                 the command normally considered a
325                                 failure (i.e. non-zero exit status or
326                                 abnormal exit due to signal) is ignored
327                                 and considered success. If both
328                                 <literal>-</literal> and
329                                 <literal>@</literal> are used for the
330                                 same command the former must precede
331                                 the latter. Unless
332                                 <varname>Type=forking</varname> is
333                                 set, the process started via this
334                                 command line will be considered the
335                                 main process of the daemon. The
336                                 command line accepts % specifiers as
337                                 described in
338                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
339
340                                 <para>On top of that basic environment
341                                 variable substitution is
342                                 supported. Use
343                                 <literal>${FOO}</literal> as part of a
344                                 word, or as a word of its own on the
345                                 command line, in which case it will be
346                                 replaced by the value of the
347                                 environment variable including all
348                                 whitespace it contains, resulting in a
349                                 single argument.  Use
350                                 <literal>$FOO</literal> as a separate
351                                 word on the command line, in which
352                                 case it will be replaced by the value
353                                 of the environment variable split up
354                                 at whitespace, resulting in no or more
355                                 arguments. Note that the first
356                                 argument (i.e. the program to execute)
357                                 may not be a variable, and must be a
358                                 literal and absolute path
359                                 name.</para>
360
361                                 <para>Note that this setting does not
362                                 directly support shell command
363                                 lines. If shell command lines are to
364                                 be used they need to be passed
365                                 explicitly to a shell implementation
366                                 of some kind. Example:
367                                 <literal>ExecStart=/bin/sh -c 'dmesg | tac'</literal></para>
368
369                                 <para>For services run by a user
370                                 instance of systemd the special
371                                 environment variable
372                                 <literal>MANAGERPID</literal> is set
373                                 to the PID of the systemd
374                                 instance.</para>
375                                 </listitem>
376                         </varlistentry>
377
378                         <varlistentry>
379                                 <term><varname>ExecStartPre=</varname></term>
380                                 <term><varname>ExecStartPost=</varname></term>
381                                 <listitem><para>Additional commands
382                                 that are executed before or after
383                                 the command in
384                                 <varname>ExecStart=</varname>, respectively. Multiple
385                                 command lines may be concatenated in a
386                                 single directive, by separating them
387                                 by semicolons (these semicolons must
388                                 be passed as separate words). In that
389                                 case, the commands are executed one
390                                 after the other,
391                                 serially. Alternatively, these
392                                 directives may be specified more than
393                                 once with the same effect. However,
394                                 the latter syntax is not recommended
395                                 for compatibility with parsers
396                                 suitable for XDG
397                                 <filename>.desktop</filename> files.
398                                 Use of these settings is
399                                 optional. Specifier and environment
400                                 variable substitution is
401                                 supported.</para></listitem>
402                         </varlistentry>
403
404                         <varlistentry>
405                                 <term><varname>ExecReload=</varname></term>
406                                 <listitem><para>Commands to execute to
407                                 trigger a configuration reload in the
408                                 service. This argument takes multiple
409                                 command lines, following the same
410                                 scheme as pointed out for
411                                 <varname>ExecStartPre=</varname>
412                                 above. Use of this setting is
413                                 optional. Specifier and environment
414                                 variable substitution is supported
415                                 here following the same scheme as for
416                                 <varname>ExecStart=</varname>. One
417                                 additional special environment
418                                 variables is set: if known
419                                 <literal>$MAINPID</literal> is set to
420                                 the main process of the daemon, and
421                                 may be used for command lines like the
422                                 following: <command>/bin/kill -HUP
423                                 $MAINPID</command>.</para></listitem>
424                         </varlistentry>
425
426                         <varlistentry>
427                                 <term><varname>ExecStop=</varname></term>
428                                 <listitem><para>Commands to execute to
429                                 stop the service started via
430                                 <varname>ExecStart=</varname>. This
431                                 argument takes multiple command lines,
432                                 following the same scheme as pointed
433                                 out for
434                                 <varname>ExecStartPre=</varname>
435                                 above. Use of this setting is
436                                 optional. All processes remaining for
437                                 a service after the commands
438                                 configured in this option are run are
439                                 terminated according to the
440                                 <varname>KillMode=</varname> setting
441                                 (see
442                                 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). If
443                                 this option is not specified the
444                                 process is terminated right-away when
445                                 service stop is requested. Specifier
446                                 and environment variable substitution
447                                 is supported (including
448                                 <literal>$MAINPID</literal>, see
449                                 above).</para></listitem>
450                         </varlistentry>
451
452                         <varlistentry>
453                                 <term><varname>ExecStopPost=</varname></term>
454                                 <listitem><para>Additional commands
455                                 that are executed after the service
456                                 was stopped using the commands
457                                 configured in
458                                 <varname>ExecStop=</varname>. This
459                                 argument takes multiple command lines,
460                                 following the same scheme as pointed
461                                 out for
462                                 <varname>ExecStartPre</varname>. Use
463                                 of these settings is
464                                 optional. Specifier and environment
465                                 variable substitution is
466                                 supported.</para></listitem>
467                         </varlistentry>
468
469                         <varlistentry>
470                                 <term><varname>RestartSec=</varname></term>
471                                 <listitem><para>Configures the time to
472                                 sleep before restarting a service (as
473                                 configured with
474                                 <varname>Restart=</varname>). Takes a
475                                 unit-less value in seconds, or a time
476                                 span value such as "5min
477                                 20s". Defaults to
478                                 100ms.</para></listitem>
479                         </varlistentry>
480
481                         <varlistentry>
482                                 <term><varname>TimeoutStartSec=</varname></term>
483                                 <listitem><para>Configures the time to
484                                 wait for start-up. If a
485                                 daemon service does not signal
486                                 start-up completion within the
487                                 configured time, the service will be
488                                 considered failed and be shut down
489                                 again.
490                                 Takes a unit-less value in seconds, or a
491                                 time span value such as "5min
492                                 20s". Pass 0 to disable the timeout
493                                 logic. Defaults to 90s, except when
494                                 <varname>Type=oneshot</varname> is
495                                 used in which case the timeout
496                                 is disabled by default.
497                                 </para></listitem>
498                         </varlistentry>
499
500                         <varlistentry>
501                                 <term><varname>TimeoutStopSec=</varname></term>
502                                 <listitem><para>Configures the time to
503                                 wait for stop. If a service is asked
504                                 to stop but does not terminate in the
505                                 specified time, it will be terminated
506                                 forcibly via SIGTERM, and after
507                                 another delay of this time with
508                                 SIGKILL (See
509                                 <varname>KillMode=</varname>
510                                 in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
511                                 Takes a unit-less value in seconds, or a
512                                 time span value such as "5min
513                                 20s". Pass 0 to disable the timeout
514                                 logic. Defaults to 90s.
515                                 </para></listitem>
516                         </varlistentry>
517
518                         <varlistentry>
519                                 <term><varname>TimeoutSec=</varname></term>
520                                 <listitem><para>A shorthand for configuring
521                                 both <varname>TimeoutStartSec=</varname>
522                                 and <varname>TimeoutStopSec=</varname>
523                                 to the specified value.
524                                 </para></listitem>
525                         </varlistentry>
526
527                         <varlistentry>
528                                 <term><varname>WatchdogSec=</varname></term>
529                                 <listitem><para>Configures the
530                                 watchdog timeout for a service. This
531                                 is activated when the start-up is
532                                 completed. The service must call
533                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
534                                 regularly with "WATCHDOG=1" (i.e. the
535                                 "keep-alive ping"). If the time
536                                 between two such calls is larger than
537                                 the configured time then the service
538                                 is placed in a failure state. By
539                                 setting <varname>Restart=</varname> to
540                                 <option>on-failure</option> or
541                                 <option>always</option> the service
542                                 will be automatically restarted. The
543                                 time configured here will be passed to
544                                 the executed service process in the
545                                 <varname>WATCHDOG_USEC=</varname>
546                                 environment variable. This allows
547                                 daemons to automatically enable the
548                                 keep-alive pinging logic if watchdog
549                                 support is enabled for the service. If
550                                 this option is used
551                                 <varname>NotifyAccess=</varname> (see
552                                 below) should be set to open access to
553                                 the notification socket provided by
554                                 systemd. If
555                                 <varname>NotifyAccess=</varname> is
556                                 not set, it will be implicitly set to
557                                 <option>main</option>. Defaults to 0,
558                                 which disables this
559                                 feature.</para></listitem>
560                         </varlistentry>
561
562                         <varlistentry>
563                                 <term><varname>Restart=</varname></term>
564                                 <listitem><para>Configures whether the
565                                 main service process shall be
566                                 restarted when it exits. Takes one of
567                                 <option>no</option>,
568                                 <option>on-success</option>,
569                                 <option>on-failure</option>,
570                                 <option>on-abort</option> or
571                                 <option>always</option>. If set to
572                                 <option>no</option> (the default) the
573                                 service will not be restarted when it
574                                 exits. If set to
575                                 <option>on-success</option> it will be
576                                 restarted only when it exited cleanly,
577                                 i.e. terminated with an exit code of
578                                 0. If set to
579                                 <option>on-failure</option> it will be
580                                 restarted only when it exited with an
581                                 exit code not equaling 0, when
582                                 terminated by a signal (including on
583                                 core dump), when an operation (such as
584                                 service reload) times out or when the
585                                 configured watchdog timeout is
586                                 triggered. If set to
587                                 <option>on-abort</option> it will be
588                                 restarted only if it exits due to
589                                 reception of an uncaught signal
590                                 (including on core dump). If set to
591                                 <option>always</option> the service
592                                 will be restarted regardless whether
593                                 it exited cleanly or not, got
594                                 terminated abnormally by a signal or
595                                 hit a timeout.</para></listitem>
596                         </varlistentry>
597
598                         <varlistentry>
599                                 <term><varname>SuccessExitStatus=</varname></term>
600                                 <listitem><para>Takes a list of exit
601                                 status definitions that when returned
602                                 by the main service process will be
603                                 considered successful termination, in
604                                 addition to the normal successful exit
605                                 code 0 and the signals SIGHUP, SIGINT,
606                                 SIGTERM and SIGPIPE. Exit status
607                                 definitions can either be numeric exit
608                                 codes or termination signal names, and
609                                 are separated by spaces. Example:
610                                 "<literal>SuccessExitStatus=1 2 8
611                                 SIGKILL</literal>", ensures that exit
612                                 codes 1, 2, 8 and the termination
613                                 signal SIGKILL are considered clean
614                                 service
615                                 terminations.</para></listitem>
616                         </varlistentry>
617
618                         <varlistentry>
619                                 <term><varname>RestartPreventExitStatus=</varname></term>
620                                 <listitem><para>Takes a list of exit
621                                 status definitions that when returned
622                                 by the main service process will
623                                 prevent automatic service restarts
624                                 regardless of the restart setting
625                                 configured with
626                                 <varname>Restart=</varname>. Exit
627                                 status definitions can either be
628                                 numeric exit codes or termination
629                                 signal names, and are separated by
630                                 spaces. Defaults to the empty list, so
631                                 that by default no exit status is
632                                 excluded from the configured restart
633                                 logic. Example:
634                                 "<literal>RestartPreventExitStatus=1 6
635                                 SIGABRT</literal>", ensures that exit
636                                 codes 1 and 6 and the termination signal
637                                 SIGABRT will not result in automatic
638                                 service restarting.</para></listitem>
639                         </varlistentry>
640
641                         <varlistentry>
642                                 <term><varname>PermissionsStartOnly=</varname></term>
643                                 <listitem><para>Takes a boolean
644                                 argument. If true, the permission
645                                 related execution options as
646                                 configured with
647                                 <varname>User=</varname> and similar
648                                 options (see
649                                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
650                                 for more information) are only applied
651                                 to the process started with
652                                 <varname>ExecStart=</varname>, and not
653                                 to the various other
654                                 <varname>ExecStartPre=</varname>,
655                                 <varname>ExecStartPost=</varname>,
656                                 <varname>ExecReload=</varname>,
657                                 <varname>ExecStop=</varname>,
658                                 <varname>ExecStopPost=</varname>
659                                 commands. If false, the setting is
660                                 applied to all configured commands the
661                                 same way. Defaults to
662                                 false.</para></listitem>
663                         </varlistentry>
664
665                         <varlistentry>
666                                 <term><varname>RootDirectoryStartOnly=</varname></term>
667                                 <listitem><para>Takes a boolean
668                                 argument. If true, the root directory
669                                 as configured with the
670                                 <varname>RootDirectory=</varname>
671                                 option (see
672                                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
673                                 for more information) is only applied
674                                 to the process started with
675                                 <varname>ExecStart=</varname>, and not
676                                 to the various other
677                                 <varname>ExecStartPre=</varname>,
678                                 <varname>ExecStartPost=</varname>,
679                                 <varname>ExecReload=</varname>,
680                                 <varname>ExecStop=</varname>,
681                                 <varname>ExecStopPost=</varname>
682                                 commands. If false, the setting is
683                                 applied to all configured commands the
684                                 same way. Defaults to
685                                 false.</para></listitem>
686                         </varlistentry>
687
688                         <varlistentry>
689                                 <term><varname>NonBlocking=</varname></term>
690                                 <listitem><para>Set O_NONBLOCK flag
691                                 for all file descriptors passed via
692                                 socket-based activation. If true, all
693                                 file descriptors >= 3 (i.e. all except
694                                 STDIN/STDOUT/STDERR) will have
695                                 the O_NONBLOCK flag set and hence are in
696                                 non-blocking mode. This option is only
697                                 useful in conjunction with a socket
698                                 unit, as described in
699                                 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Defaults
700                                 to false.</para></listitem>
701                         </varlistentry>
702
703                         <varlistentry>
704                                 <term><varname>NotifyAccess=</varname></term>
705                                 <listitem><para>Controls access to the
706                                 service status notification socket, as
707                                 accessible via the
708                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
709                                 call. Takes one of
710                                 <option>none</option> (the default),
711                                 <option>main</option> or
712                                 <option>all</option>. If
713                                 <option>none</option> no daemon status
714                                 updates are accepted from the service
715                                 processes, all status update messages
716                                 are ignored. If <option>main</option>
717                                 only service updates sent from the
718                                 main process of the service are
719                                 accepted. If <option>all</option> all
720                                 services updates from all members of
721                                 the service's control group are
722                                 accepted. This option should be set to
723                                 open access to the notification socket
724                                 when using
725                                 <varname>Type=notify</varname> or
726                                 <varname>WatchdogUsec=</varname> (see
727                                 above). If those options are used but
728                                 <varname>NotifyAccess=</varname> not
729                                 configured it will be implicitly set
730                                 to
731                                 <option>main</option>.</para></listitem>
732                         </varlistentry>
733
734                         <varlistentry>
735                                 <term><varname>Sockets=</varname></term>
736                                 <listitem><para>Specifies the name of
737                                 the socket units this service shall
738                                 inherit the sockets from when the
739                                 service is started. Normally it
740                                 should not be necessary to use this
741                                 setting as all sockets whose unit
742                                 shares the same name as the service
743                                 (ignoring the different suffix of course)
744                                 are passed to the spawned
745                                 process.</para>
746
747                                 <para>Note that the same socket may be
748                                 passed to multiple processes at the
749                                 same time. Also note that a different
750                                 service may be activated on incoming
751                                 traffic than inherits the sockets. Or
752                                 in other words: The
753                                 <varname>Service=</varname> setting of
754                                 <filename>.socket</filename> units
755                                 doesn't have to match the inverse of the
756                                 <varname>Sockets=</varname> setting of
757                                 the <filename>.service</filename> it
758                                 refers to.</para></listitem>
759                         </varlistentry>
760
761                         <varlistentry>
762                                 <term><varname>StartLimitInterval=</varname></term>
763                                 <term><varname>StartLimitBurst=</varname></term>
764
765                                 <listitem><para>Configure service
766                                 start rate limiting. By default
767                                 services which are started more often
768                                 than 5 times within 10s are not
769                                 permitted to start any more times
770                                 until the 10s interval ends. With
771                                 these two options this rate limiting
772                                 may be modified. Use
773                                 <varname>StartLimitInterval=</varname>
774                                 to configure the checking interval
775                                 (defaults to 10s, set to 0 to disable
776                                 any kind of rate limiting). Use
777                                 <varname>StartLimitBurst=</varname> to
778                                 configure how many starts per interval
779                                 are allowed (defaults to 5). These
780                                 configuration options are particularly
781                                 useful in conjunction with
782                                 <varname>Restart=</varname>, however
783                                 apply to all kinds of starts
784                                 (including manual), not just those
785                                 triggered by the
786                                 <varname>Restart=</varname> logic.
787                                 Note that units which are configured
788                                 for <varname>Restart=</varname> and
789                                 which reach the start limit are not
790                                 attempted to be restarted anymore,
791                                 however they may still be restarted
792                                 manually at a later point from which
793                                 point on the restart logic is again
794                                 activated. Note that
795                                 <command>systemctl
796                                 reset-failed</command> will cause the
797                                 restart rate counter for a service to
798                                 be flushed, which is useful if the
799                                 administrator wants to manually start
800                                 a service and the start limit
801                                 interferes with
802                                 that.</para></listitem>
803                         </varlistentry>
804
805                         <varlistentry>
806                                 <term><varname>StartLimitAction=</varname></term>
807
808                                 <listitem><para>Configure the action
809                                 to take if the rate limit configured
810                                 with
811                                 <varname>StartLimitInterval=</varname>
812                                 and
813                                 <varname>StartLimitBurst=</varname> is
814                                 hit. Takes one of
815                                 <option>none</option>,
816                                 <option>reboot</option>,
817                                 <option>reboot-force</option> or
818                                 <option>reboot-immediate</option>. If
819                                 <option>none</option> is set,
820                                 hitting the rate limit will trigger no
821                                 action besides that the start will not
822                                 be
823                                 permitted. <option>reboot</option>
824                                 causes a reboot following the normal
825                                 shutdown procedure (i.e. equivalent to
826                                 <command>systemctl reboot</command>),
827                                 <option>reboot-force</option> causes
828                                 an forced reboot which will terminate
829                                 all processes forcibly but should
830                                 cause no dirty file systems on reboot
831                                 (i.e. equivalent to <command>systemctl
832                                 reboot -f</command>) and
833                                 <option>reboot-immediate</option>
834                                 causes immediate execution of the
835                                 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
836                                 system call, which might result in
837                                 data loss.  Defaults to
838                                 <option>none</option>.</para></listitem>
839                         </varlistentry>
840
841                 </variablelist>
842
843                 <para>Check
844                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
845                 and
846                 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
847                 for more settings.</para>
848
849         </refsect1>
850
851         <refsect1>
852                 <title>Compatibility Options</title>
853
854                 <para>The following options are also available in the
855                 <literal>[Service]</literal> section, but exist purely
856                 for compatibility reasons and should not be used in
857                 newly written service files.</para>
858
859                 <variablelist>
860                         <varlistentry>
861                                 <term><varname>SysVStartPriority=</varname></term>
862                                 <listitem><para>Set the SysV start
863                                 priority to use to order this service
864                                 in relation to SysV services lacking
865                                 LSB headers. This option is only
866                                 necessary to fix ordering in relation
867                                 to legacy SysV services, that have no
868                                 ordering information encoded in the
869                                 script headers. As such it should only
870                                 be used as temporary compatibility
871                                 option, and not be used in new unit
872                                 files. Almost always it is a better
873                                 choice to add explicit ordering
874                                 directives via
875                                 <varname>After=</varname> or
876                                 <varname>Before=</varname>,
877                                 instead. For more details see
878                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If
879                                 used, pass an integer value in the
880                                 range 0-99.</para></listitem>
881                         </varlistentry>
882
883                         <varlistentry>
884                                 <term><varname>FsckPassNo=</varname></term>
885                                 <listitem><para>Set the fsck passno
886                                 priority to use to order this service
887                                 in relation to other file system
888                                 checking services. This option is only
889                                 necessary to fix ordering in relation
890                                 to fsck jobs automatically created for
891                                 all <filename>/etc/fstab</filename>
892                                 entries with a value in the fs_passno
893                                 column > 0. As such it should only be
894                                 used as option for fsck
895                                 services. Almost always it is a better
896                                 choice to add explicit ordering
897                                 directives via
898                                 <varname>After=</varname> or
899                                 <varname>Before=</varname>,
900                                 instead. For more details see
901                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If
902                                 used, pass an integer value in the
903                                 same range as
904                                 <filename>/etc/fstab</filename>'s
905                                 fs_passno column. See
906                                 <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
907                                 for details.</para></listitem>
908                         </varlistentry>
909
910                 </variablelist>
911         </refsect1>
912
913         <refsect1>
914                   <title>See Also</title>
915                   <para>
916                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
917                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
918                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
919                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
920                           <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
921                   </para>
922         </refsect1>
923
924 </refentry>