]>
Commit | Line | Data |
---|---|---|
d1ab0ca0 LP |
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 General Public License as published by | |
13 | the Free Software Foundation; either version 2 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 | General Public License for more details. | |
20 | ||
21 | You should have received a copy of the GNU 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>systemd service configuration files</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <para><filename>systemd.service</filename></para> | |
52 | </refsynopsisdiv> | |
53 | ||
54 | <refsect1> | |
55 | <title>Description</title> | |
56 | ||
1f812fea | 57 | <para>A unit configuration file whose name ends in |
65232ea7 LP |
58 | <filename>.service</filename> encodes information |
59 | about a process controlled and supervised by | |
60 | systemd.</para> | |
d1ab0ca0 LP |
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 | |
0d624a78 | 66 | files. The common configuration items are configured |
62adf224 LP |
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> | |
0d624a78 | 71 | |
ba60f905 LP |
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.</para> | |
62adf224 LP |
76 | |
77 | <para>Unless <varname>DefaultDependencies=</varname> | |
78 | is set to <option>false</option>, service units will | |
79 | implicitly have dependencies of type | |
80 | <varname>Requires=</varname> and | |
81 | <varname>After=</varname> on | |
82 | <filename>basic.target</filename> as well as | |
83 | dependencies of type <varname>Conflicts=</varname> and | |
84 | <varname>Before=</varname> on | |
85 | <filename>shutdown.target</filename>. These ensure | |
86 | that normal service units pull in basic system | |
87 | initialization, and are terminated cleanly prior to | |
88 | system shutdown. Only services involved with early | |
89 | boot or late system shutdown should disable this | |
90 | option.</para> | |
59a3e1bc LP |
91 | |
92 | <para>If a service is requested under a certain name | |
93 | but no unit configuration file is found, systemd looks | |
94 | for a SysV init script by the same name (with the | |
95 | <filename>.service</filename> suffix removed) and | |
96 | dynamically creates a service unit from that | |
97 | script. This is useful for compatibility with | |
98 | SysV.</para> | |
d1ab0ca0 LP |
99 | </refsect1> |
100 | ||
101 | <refsect1> | |
102 | <title>Options</title> | |
103 | ||
62adf224 LP |
104 | <para>Service files must include a |
105 | <literal>[Service]</literal> section, which carries | |
106 | information about the service and the process it | |
107 | supervises. A number of options that may be used in | |
108 | this section are shared with other unit types. These | |
109 | options are documented in | |
0d624a78 | 110 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The |
62adf224 LP |
111 | options specific to the <literal>[Service]</literal> |
112 | section of service units are the following:</para> | |
0d624a78 | 113 | |
d1ab0ca0 LP |
114 | <variablelist> |
115 | <varlistentry> | |
116 | <term><varname>Type=</varname></term> | |
0d624a78 LP |
117 | |
118 | <listitem><para>Configures the process | |
119 | start-up type for this service | |
120 | unit. One of <option>simple</option>, | |
121 | <option>forking</option>, | |
34e9ba66 | 122 | <option>oneshot</option>, |
0d624a78 LP |
123 | <option>dbus</option>, |
124 | <option>notify</option>.</para> | |
125 | ||
126 | <para>If set to | |
127 | <option>simple</option> (the default | |
128 | value) it is expected that the process | |
129 | configured with | |
130 | <varname>ExecStart=</varname> is the | |
131 | main process of the service. In this | |
b1690fe7 LP |
132 | mode, if the process offers |
133 | functionality to other processes on | |
134 | the system its communication channels | |
135 | should be installed before the daemon | |
136 | is started up (e.g. sockets set up by | |
137 | systemd, via socket activation), as | |
138 | systemd will immediately proceed | |
139 | starting follow-up units.</para> | |
0d624a78 LP |
140 | |
141 | <para>If set to | |
142 | <option>forking</option> it is | |
143 | expected that the process configured | |
144 | with <varname>ExecStart=</varname> | |
b1690fe7 LP |
145 | will call <function>fork()</function> |
146 | as part of its start-up. The parent process is | |
147 | expected to exit when start-up is | |
148 | complete and all communication | |
149 | channels set up. The child continues | |
150 | to run as the main daemon | |
151 | process. This is the behaviour of | |
152 | traditional UNIX daemons. If this | |
0d624a78 LP |
153 | setting is used, it is recommended to |
154 | also use the | |
155 | <varname>PIDFile=</varname> option, so | |
156 | that systemd can identify the main | |
157 | process of the daemon. systemd will | |
158 | proceed starting follow-up units as | |
159 | soon as the parent process | |
160 | exits.</para> | |
161 | ||
162 | <para>Behaviour of | |
34e9ba66 | 163 | <option>oneshot</option> is similar |
0d624a78 LP |
164 | to <option>simple</option>, however |
165 | it is expected that the process has to | |
166 | exit before systemd starts follow-up | |
02ee865a | 167 | units. <varname>RemainAfterExit=</varname> |
0d624a78 LP |
168 | is particularly useful for this type |
169 | of service.</para> | |
170 | ||
171 | <para>Behaviour of | |
172 | <option>dbus</option> is similar to | |
62adf224 LP |
173 | <option>simple</option>, however it is |
174 | expected that the daemon acquires a | |
0d624a78 LP |
175 | name on the D-Bus bus, as configured |
176 | by | |
177 | <varname>BusName=</varname>. systemd | |
178 | will proceed starting follow-up units | |
179 | after the D-Bus bus name has been | |
62adf224 | 180 | acquired. Service units with this |
b1690fe7 | 181 | option configured implicitly gain |
62adf224 LP |
182 | dependencies on the |
183 | <filename>dbus.target</filename> | |
184 | unit.</para> | |
0d624a78 LP |
185 | |
186 | <para>Behaviour of | |
187 | <option>notify</option> is similar to | |
188 | <option>simple</option>, however it is | |
189 | expected that the daemon sends a | |
190 | notification message via | |
191 | <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
192 | or an equivalent call when it finished | |
193 | starting up. systemd will proceed | |
194 | starting follow-up units after this | |
195 | notification message has been sent. If | |
196 | this option is used | |
62adf224 | 197 | <varname>NotifyAccess=</varname> (see |
b1690fe7 | 198 | below) should be set to open access to |
0d624a78 | 199 | the notification socket provided by |
62adf224 LP |
200 | systemd. If |
201 | <varname>NotifyAccess=</varname> is not | |
b1690fe7 | 202 | set, it will implicitly be set to |
62adf224 | 203 | <option>main</option>.</para> |
d1ab0ca0 LP |
204 | </listitem> |
205 | </varlistentry> | |
0d624a78 | 206 | |
d1ab0ca0 | 207 | <varlistentry> |
02ee865a | 208 | <term><varname>RemainAfterExit=</varname></term> |
0d624a78 LP |
209 | |
210 | <listitem><para>Takes a boolean value | |
211 | that specifies whether the service | |
212 | shall be considered active even when | |
213 | all its processes exited. Defaults to | |
214 | <option>no</option>.</para> | |
d1ab0ca0 LP |
215 | </listitem> |
216 | </varlistentry> | |
217 | ||
218 | <varlistentry> | |
219 | <term><varname>PIDFile=</varname></term> | |
0d624a78 LP |
220 | |
221 | <listitem><para>Takes an absolute file | |
222 | name pointing to the PID file of this | |
223 | daemon. Use of this option is | |
224 | recommended for services where | |
225 | <varname>Type=</varname> is set to | |
226 | <option>forking</option>.</para> | |
d1ab0ca0 LP |
227 | </listitem> |
228 | </varlistentry> | |
229 | ||
230 | <varlistentry> | |
231 | <term><varname>BusName=</varname></term> | |
0d624a78 LP |
232 | |
233 | <listitem><para>Takes a D-Bus bus | |
234 | name, where this service is reachable | |
235 | as. This option is mandatory for | |
236 | services where | |
237 | <varname>Type=</varname> is set to | |
238 | <option>dbus</option>, but its use | |
239 | is otherwise recommended as well if | |
240 | the process takes a name on the D-Bus | |
241 | bus.</para> | |
d1ab0ca0 LP |
242 | </listitem> |
243 | </varlistentry> | |
244 | ||
245 | <varlistentry> | |
246 | <term><varname>ExecStart=</varname></term> | |
0d624a78 LP |
247 | <listitem><para>Takes a command line |
248 | that is executed when this service | |
249 | shall be started up. The first token | |
250 | of the command line must be an | |
251 | absolute file name, then followed by | |
252 | arguments for the process. It is | |
253 | mandatory to set this option for all | |
254 | services. This option may not be | |
b1690fe7 LP |
255 | specified more than once, except when |
256 | <varname>Type=oneshot</varname> is | |
257 | used in which case more than one | |
258 | <varname>ExecStart=</varname> line is | |
259 | accepted which are then invoked one by | |
260 | one, sequentially in the order they | |
261 | appear in the unit file.</para> | |
262 | ||
263 | <para>Optionally, if the absolute file | |
264 | name is prefixed with | |
265 | <literal>@</literal>, the second token | |
266 | will be passed as | |
62adf224 LP |
267 | <literal>argv[0]</literal> to the |
268 | executed process, followed by the | |
b708e7ce LP |
269 | further arguments specified. If the |
270 | first token is prefixed with | |
b1690fe7 | 271 | <literal>-</literal> an exit code of |
b708e7ce | 272 | the command normally considered a |
b1690fe7 | 273 | failure (i.e. non-zero exit status or |
5471472d | 274 | abnormal exit due to signal) is ignored |
b1690fe7 LP |
275 | and considered success. If both |
276 | <literal>-</literal> and | |
277 | <literal>@</literal> are used for the | |
5471472d | 278 | same command the former must precede |
b1690fe7 | 279 | the latter. Unless |
420a0166 LP |
280 | <varname>Type=forking</varname> is |
281 | set, the process started via this | |
282 | command line will be considered the | |
283 | main process of the daemon. The | |
284 | command line accepts % specifiers as | |
285 | described in | |
286 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. On | |
287 | top of that basic environment variable | |
288 | substitution is supported, where | |
c24eb49e LP |
289 | <literal>${FOO}</literal> is replaced |
290 | by the string value of the environment | |
291 | variable of the same name. Also | |
292 | <literal>$FOO</literal> may appear as | |
96d4ce01 | 293 | separate word on the command line in |
c24eb49e | 294 | which case the variable is replaced by |
d2f31634 LP |
295 | its value split at whitespaces. Note |
296 | that the first argument (i.e. the | |
297 | binary to execute) may not be a | |
298 | variable, and must be a literal and | |
299 | absolute path name.</para></listitem> | |
0d624a78 LP |
300 | </varlistentry> |
301 | ||
302 | <varlistentry> | |
303 | <term><varname>ExecStartPre=</varname></term> | |
304 | <term><varname>ExecStartPost=</varname></term> | |
305 | <listitem><para>Additional commands | |
306 | that are executed before (resp. after) | |
307 | the command in | |
b3eaa628 LP |
308 | <varname>ExecStart=</varname>. Multiple |
309 | command lines may be concatenated in a | |
c899f8c6 | 310 | single directive, by separating them |
b3eaa628 | 311 | by semicolons (these semicolons must |
96d4ce01 | 312 | be passed as separate words). In that |
b3eaa628 LP |
313 | case, the commands are executed one |
314 | after the other, | |
315 | serially. Alternatively, these | |
316 | directives may be specified more than | |
5471472d | 317 | once with the same effect. However, |
b3eaa628 LP |
318 | the latter syntax is not recommended |
319 | for compatibility with parsers | |
320 | suitable for XDG | |
321 | <filename>.desktop</filename> files. | |
322 | Use of these settings is | |
420a0166 LP |
323 | optional. Specifier and environment |
324 | variable substitution is | |
325 | supported.</para></listitem> | |
0d624a78 LP |
326 | </varlistentry> |
327 | ||
328 | <varlistentry> | |
329 | <term><varname>ExecReload=</varname></term> | |
330 | <listitem><para>Commands to execute to | |
331 | trigger a configuration reload in the | |
b3eaa628 LP |
332 | service. This argument takes multiple |
333 | command lines, following the same | |
334 | scheme as pointed out for | |
335 | <varname>ExecStartPre=</varname> | |
336 | above. Use of this setting is | |
420a0166 LP |
337 | optional. Specifier and environment |
338 | variable substitution is supported | |
339 | here following the same scheme as for | |
340 | <varname>ExecStart=</varname>. One | |
341 | special environment variable is set: | |
342 | if known <literal>$MAINPID</literal> is | |
343 | set to the main process of the | |
344 | daemon, and may be used for command | |
345 | lines like the following: | |
346 | <command>/bin/kill -HUP | |
075b1e86 | 347 | $MAINPID</command>.</para></listitem> |
0d624a78 LP |
348 | </varlistentry> |
349 | ||
350 | <varlistentry> | |
351 | <term><varname>ExecStop=</varname></term> | |
352 | <listitem><para>Commands to execute to | |
353 | stop the service started via | |
b3eaa628 LP |
354 | <varname>ExecStart=</varname>. This |
355 | argument takes multiple command lines, | |
356 | following the same scheme as pointed | |
357 | out for | |
358 | <varname>ExecStartPre=</varname> | |
359 | above. Use of this setting is | |
0d624a78 LP |
360 | optional. All processes remaining for |
361 | a service after the commands | |
362 | configured in this option are run are | |
363 | terminated according to the | |
364 | <varname>KillMode=</varname> setting | |
365 | (see below). If this option is not | |
366 | specified the process is terminated | |
367 | right-away when service stop is | |
420a0166 LP |
368 | requested. Specifier and environment |
369 | variable substitution is supported | |
370 | (including | |
075b1e86 | 371 | <literal>$MAINPID</literal>, see |
420a0166 | 372 | above).</para></listitem> |
0d624a78 LP |
373 | </varlistentry> |
374 | ||
375 | <varlistentry> | |
376 | <term><varname>ExecStopPost=</varname></term> | |
377 | <listitem><para>Additional commands | |
378 | that are executed after the service | |
379 | was stopped using the commands | |
380 | configured in | |
b3eaa628 LP |
381 | <varname>ExecStop=</varname>. This |
382 | argument takes multiple command lines, | |
383 | following the same scheme as pointed | |
384 | out for | |
385 | <varname>ExecStartPre</varname>. Use | |
386 | of these settings is | |
420a0166 LP |
387 | optional. Specifier and environment |
388 | variable substitution is | |
389 | supported.</para></listitem> | |
0d624a78 LP |
390 | </varlistentry> |
391 | ||
392 | <varlistentry> | |
393 | <term><varname>RestartSec=</varname></term> | |
394 | <listitem><para>Configures the time to | |
395 | sleep before restarting a service (as | |
396 | configured with | |
397 | <varname>Restart=</varname>). Takes a | |
398 | unit-less value in seconds, or a time | |
399 | span value such as "5min | |
400 | 20s". Defaults to | |
401 | 100ms.</para></listitem> | |
402 | </varlistentry> | |
403 | ||
404 | <varlistentry> | |
405 | <term><varname>TimeoutSec=</varname></term> | |
406 | <listitem><para>Configures the time to | |
407 | wait for start-up and stop. If a | |
408 | daemon service does not signal | |
409 | start-up completion within the | |
410 | configured time the service will be | |
411 | considered failed and be shut down | |
412 | again. If a service is asked to stop | |
413 | but does not terminate in the | |
414 | specified time it will be terminated | |
415 | forcibly via SIGTERM, and after | |
416 | another delay of this time with | |
417 | SIGKILL. (See | |
62adf224 | 418 | <varname>KillMode=</varname> |
0d624a78 LP |
419 | below.) Takes a unit-less value in seconds, or a |
420 | time span value such as "5min | |
421 | 20s". Pass 0 to disable the timeout | |
422 | logic. Defaults to | |
423 | 60s.</para></listitem> | |
424 | </varlistentry> | |
425 | ||
426 | <varlistentry> | |
427 | <term><varname>Restart=</varname></term> | |
428 | <listitem><para>Configures whether the | |
50caaedb | 429 | main service process shall be |
f8553ccb | 430 | restarted when it exits. Takes one of |
525ee6f4 | 431 | <option>no</option>, |
50caaedb LP |
432 | <option>on-success</option>, |
433 | <option>on-failure</option>, | |
434 | <option>on-abort</option> or | |
435 | <option>always</option>. If set to | |
436 | <option>no</option> (the default) the | |
437 | service will not be restarted when it | |
438 | exits. If set to | |
439 | <option>on-success</option> it will be | |
440 | restarted only when it exited cleanly, | |
441 | i.e. terminated with an exit code of | |
442 | 0. If set to | |
443 | <option>on-failure</option> it will be | |
5471472d | 444 | restarted only when it exited with an |
50caaedb LP |
445 | exit code not equalling 0, or when |
446 | terminated by a signal. If set to | |
447 | <option>on-abort</option> it will be | |
448 | restarted only if it exits due to | |
449 | reception of an uncaught signal. If | |
450 | set to <option>always</option> the | |
0d624a78 LP |
451 | service will be restarted regardless |
452 | whether it exited cleanly or not, or | |
453 | got terminated abnormally by a | |
454 | signal.</para></listitem> | |
455 | </varlistentry> | |
456 | ||
457 | <varlistentry> | |
458 | <term><varname>PermissionsStartOnly=</varname></term> | |
459 | <listitem><para>Takes a boolean | |
460 | argument. If true, the permission | |
461 | related execution options as | |
462 | configured with | |
463 | <varname>User=</varname> and similar | |
464 | options (see | |
465 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
466 | for more information) are only applied | |
467 | to the process started with | |
468 | <varname>ExecStart=</varname>, and not | |
469 | to the various other | |
470 | <varname>ExecStartPre=</varname>, | |
471 | <varname>ExecStartPost=</varname>, | |
472 | <varname>ExecReload=</varname>, | |
473 | <varname>ExecStop=</varname>, | |
474 | <varname>ExecStopPost=</varname> | |
475 | commands. If false, the setting is | |
476 | applied to all configured commands the | |
477 | same way. Defaults to | |
478 | false.</para></listitem> | |
479 | </varlistentry> | |
480 | ||
481 | <varlistentry> | |
482 | <term><varname>RootDirectoryStartOnly=</varname></term> | |
483 | <listitem><para>Takes a boolean | |
484 | argument. If true, the root directory | |
485 | as configured with the | |
486 | <varname>RootDirectory=</varname> | |
487 | option (see | |
488 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
489 | for more information) is only applied | |
490 | to the process started with | |
491 | <varname>ExecStart=</varname>, and not | |
492 | to the various other | |
493 | <varname>ExecStartPre=</varname>, | |
494 | <varname>ExecStartPost=</varname>, | |
495 | <varname>ExecReload=</varname>, | |
496 | <varname>ExecStop=</varname>, | |
497 | <varname>ExecStopPost=</varname> | |
498 | commands. If false, the setting is | |
499 | applied to all configured commands the | |
500 | same way. Defaults to | |
501 | false.</para></listitem> | |
502 | </varlistentry> | |
503 | ||
504 | <varlistentry> | |
505 | <term><varname>SysVStartPriority=</varname></term> | |
506 | <listitem><para>Set the SysV start | |
507 | priority to use to order this service | |
508 | in relation to SysV services lacking | |
509 | LSB headers. This option is only | |
510 | necessary to fix ordering in relation | |
511 | to legacy SysV services, that have no | |
512 | ordering information encoded in the | |
513 | script headers. As such it should only | |
514 | be used as temporary compatibility | |
515 | option, and not be used in new unit | |
516 | files. Almost always it is a better | |
517 | choice to add explicit ordering | |
518 | directives via | |
519 | <varname>After=</varname> or | |
520 | <varname>Before=</varname>, | |
521 | instead. For more details see | |
522 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If | |
523 | used, pass an integer value in the | |
524 | range 0-99.</para></listitem> | |
525 | </varlistentry> | |
526 | ||
527 | <varlistentry> | |
528 | <term><varname>KillMode=</varname></term> | |
529 | <listitem><para>Specifies how | |
530 | processes of this service shall be | |
531 | killed. One of | |
532 | <option>control-group</option>, | |
533 | <option>process-group</option>, | |
534 | <option>process</option>, | |
535 | <option>none</option>.</para> | |
536 | ||
537 | <para>If set to | |
538 | <option>control-group</option> all | |
539 | remaining processes in the control | |
540 | group of this service will be | |
541 | terminated on service stop, after the | |
542 | stop command (as configured with | |
543 | <varname>ExecStop=</varname>) is | |
544 | executed. If set to | |
545 | <option>process-group</option> only | |
546 | the members of the process group of | |
547 | the main service process are | |
548 | killed. If set to | |
549 | <option>process</option> only the main | |
550 | process itself is killed. If set to | |
551 | <option>none</option> no process is | |
552 | killed. In this case only the stop | |
553 | command will be executed on service | |
554 | stop, but no process be killed | |
555 | otherwise. Processes remaining alive | |
556 | after stop are left in their control | |
557 | group and the control group continues | |
558 | to exist after stop unless it is | |
559 | empty. Defaults to | |
f8553ccb | 560 | <option>control-group</option>.</para> |
0d624a78 LP |
561 | |
562 | <para>Processes will first be | |
ba035df2 LP |
563 | terminated via SIGTERM (unless the |
564 | signal to send is changed via | |
2292707d LP |
565 | <varname>KillSignal=</varname>). If |
566 | then after a delay (configured via the | |
62adf224 | 567 | <varname>TimeoutSec=</varname> option) |
0d624a78 LP |
568 | processes still remain, the |
569 | termination request is repeated with | |
ba035df2 LP |
570 | the SIGKILL signal (unless this is |
571 | disabled via the | |
572 | <varname>SendSIGKILL=</varname> | |
573 | option). See | |
0d624a78 LP |
574 | <citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry> |
575 | for more | |
576 | information.</para></listitem> | |
577 | </varlistentry> | |
578 | ||
2292707d LP |
579 | <varlistentry> |
580 | <term><varname>KillSignal=</varname></term> | |
581 | <listitem><para>Specifies which signal | |
582 | to use when killing a | |
583 | service. Defaults to SIGTERM. | |
584 | </para></listitem> | |
585 | </varlistentry> | |
586 | ||
ba035df2 LP |
587 | <varlistentry> |
588 | <term><varname>SendSIGKILL=</varname></term> | |
589 | <listitem><para>Specifies whether to | |
590 | send SIGKILL to remaining processes | |
591 | after a timeout, if the normal | |
592 | shutdown procedure left processes of | |
593 | the service around. Takes a boolean | |
594 | value. Defaults to "yes". | |
595 | </para></listitem> | |
596 | </varlistentry> | |
597 | ||
0d624a78 LP |
598 | <varlistentry> |
599 | <term><varname>NonBlocking=</varname></term> | |
600 | <listitem><para>Set O_NONBLOCK flag | |
601 | for all file descriptors passed via | |
602 | socket-based activation. If true, all | |
603 | file descriptors >= 3 (i.e. all except | |
604 | STDIN/STDOUT/STDERR) will have | |
605 | the O_NONBLOCK flag set and hence are in | |
606 | non-blocking mode. This option is only | |
607 | useful in conjunction with a socket | |
608 | unit, as described in | |
609 | <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Defaults | |
610 | to false.</para></listitem> | |
611 | </varlistentry> | |
612 | ||
613 | <varlistentry> | |
614 | <term><varname>NotifyAccess=</varname></term> | |
615 | <listitem><para>Controls access to the | |
616 | service status notification socket, as | |
617 | accessible via the | |
618 | <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
619 | call. Takes one of | |
620 | <option>none</option> (the default), | |
621 | <option>main</option> or | |
622 | <option>all</option>. If | |
623 | <option>none</option> no daemon status | |
f8553ccb | 624 | updates are accepted from the service |
0d624a78 LP |
625 | processes, all status update messages |
626 | are ignored. If <option>main</option> | |
627 | only service updates sent from the | |
628 | main process of the service are | |
629 | accepted. If <option>all</option> all | |
630 | services updates from all members of | |
631 | the service's control group are | |
632 | accepted. This option must be set to | |
633 | open access to the notification socket | |
634 | when using | |
635 | <varname>Type=notify</varname> (see above).</para></listitem> | |
d1ab0ca0 LP |
636 | </varlistentry> |
637 | ||
f72192c0 LP |
638 | <varlistentry> |
639 | <term><varname>Sockets=</varname></term> | |
640 | <listitem><para>Specifies the name of | |
641 | the socket units this service shall | |
642 | inherit the sockets from when the | |
643 | service (ignoring the different suffix | |
644 | of course) is started. Normally it | |
645 | should not be necessary to use this | |
646 | setting as all sockets whose unit | |
647 | shares the same name as the service | |
648 | are passed to the spawned | |
649 | process.</para> | |
650 | ||
651 | <para>Note that the same socket may be | |
652 | passed to multiple processes at the | |
653 | same time. Also note that a different | |
654 | service may be activated on incoming | |
655 | traffic than inherits the sockets. Or | |
656 | in other words: The | |
657 | <varname>Service=</varname> setting of | |
658 | <filename>.socket</filename> units | |
659 | doesn't have to match the inverse of the | |
a1102c1f | 660 | <varname>Sockets=</varname> setting of |
f72192c0 LP |
661 | the <filename>.service</filename> it |
662 | refers to.</para></listitem> | |
663 | </varlistentry> | |
664 | ||
2ba545f1 LP |
665 | <varlistentry> |
666 | <term><varname>FsckPassNo=</varname></term> | |
667 | <listitem><para>Set the fsck passno | |
668 | priority to use to order this service | |
669 | in relation to other file system | |
670 | checking services. This option is only | |
671 | necessary to fix ordering in relation | |
672 | to fsck jobs automatically created for | |
673 | all <filename>/etc/fstab</filename> | |
674 | entries with a value in the fs_passno | |
675 | column > 0. As such it should only be | |
676 | used as option for fsck | |
677 | services. Almost always it is a better | |
678 | choice to add explicit ordering | |
679 | directives via | |
680 | <varname>After=</varname> or | |
681 | <varname>Before=</varname>, | |
682 | instead. For more details see | |
683 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If | |
684 | used, pass an integer value in the | |
685 | same range as | |
686 | <filename>/etc/fstab</filename>'s | |
687 | fs_passno column. See | |
688 | <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
689 | for details.</para></listitem> | |
690 | </varlistentry> | |
691 | ||
d1ab0ca0 LP |
692 | </variablelist> |
693 | </refsect1> | |
694 | ||
695 | <refsect1> | |
696 | <title>See Also</title> | |
697 | <para> | |
f3e219a2 | 698 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
0d624a78 LP |
699 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
700 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
701 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
d1ab0ca0 LP |
702 | </para> |
703 | </refsect1> | |
704 | ||
705 | </refentry> |