systemd.unit.xml 72.2 KB
Newer Older
1
2
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3
4
5
6
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
7
8
9
10
11
12
13

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
14
15
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
16
17
18
19
20
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21
  Lesser General Public License for more details.
22

23
  You should have received a copy of the GNU Lesser General Public License
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd.unit">

        <refentryinfo>
                <title>systemd.unit</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd.unit</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd.unit</refname>
50
                <refpurpose>Unit configuration</refpurpose>
51
52
53
        </refnamediv>

        <refsynopsisdiv>
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
                <para><filename><replaceable>service</replaceable>.service</filename>,
                <filename><replaceable>socket</replaceable>.socket</filename>,
                <filename><replaceable>device</replaceable>.device</filename>,
                <filename><replaceable>mount</replaceable>.mount</filename>,
                <filename><replaceable>automount</replaceable>.automount</filename>,
                <filename><replaceable>swap</replaceable>.swap</filename>,
                <filename><replaceable>target</replaceable>.target</filename>,
                <filename><replaceable>path</replaceable>.path</filename>,
                <filename><replaceable>timer</replaceable>.timer</filename>,
                <filename><replaceable>snapshot</replaceable>.snapshot</filename></para>

                <para><literallayout><filename>/etc/systemd/system/*</filename>
<filename>/run/systemd/system/*</filename>
<filename>/usr/lib/systemd/system/*</filename>
<filename>...</filename>
                </literallayout></para>

                <para><literallayout><filename>/etc/systemd/user/*</filename>
<filename>/run/systemd/user/*</filename>
<filename>/usr/lib/systemd/user/*</filename>
<filename>...</filename>
                </literallayout></para>
76
77
78
79
80
81
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>A unit configuration file encodes information
82
                about a service, a socket, a device, a mount point, an
Kay Sievers's avatar
Kay Sievers committed
83
                automount point, a swap file or partition, a start-up
84
                target, a file system path, or a timer controlled and
85
86
87
88
                supervised by
                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The
                syntax is inspired by <ulink
                url="http://standards.freedesktop.org/desktop-entry-spec/latest/">XDG
Kay Sievers's avatar
Kay Sievers committed
89
                Desktop Entry Specification</ulink> <filename>.desktop</filename> files, which are in turn
90
91
                inspired by Microsoft Windows
                <filename>.ini</filename> files.</para>
92

93
                <para>This man page lists the common configuration
94
                options of all the unit types. These options need to
95
96
                be configured in the [Unit] or [Install]
                sections of the unit files.</para>
97
98

                <para>In addition to the generic [Unit] and [Install]
99
                sections described here, each unit may have a
100
101
                type-specific section, e.g. [Service] for a service
                unit. See the respective man pages for more
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
                information:
                <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>systemd.snapshot</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
                </para>

                <para>Unit files are loaded from a set of paths
                determined during compilation, described in the next section.
                </para>
118
119
120
121
122
123
124
125
126
127

                <para>Unit files may contain additional options on top
                of those listed here. If systemd encounters an unknown
                option it will write a warning log message but
                continue loading the unit. If an option is prefixed
                with <option>X-</option> it is ignored completely by
                systemd. Applications may use this to include
                additional information in the unit files.</para>

                <para>Boolean arguments used in unit files can be
Lennart Poettering's avatar
Lennart Poettering committed
128
                written in various formats. For positive settings the
129
130
131
132
133
134
135
                strings <option>1</option>, <option>yes</option>,
                <option>true</option> and <option>on</option> are
                equivalent. For negative settings the strings
                <option>0</option>, <option>no</option>,
                <option>false</option> and <option>off</option> are
                equivalent.</para>

136
137
138
                <para>Time span values encoded in unit files can be
                written in various formats. A stand-alone number
                specifies a time in seconds. If suffixed with a time
139
140
141
                unit, the unit is honored. A concatenation of multiple
                values with units is supported, in which case the
                values are added up. Example: "50" refers to 50
142
143
                seconds; "2min 200ms" refers to 2 minutes plus 200
                milliseconds, i.e. 120200ms. The following time units
144
145
146
                are understood: s, min, h, d, w, ms, us. For details
                see
                <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
147

148
                <para>Empty lines and lines starting with # or ; are
149
150
151
152
                ignored. This may be used for commenting. Lines ending
                in a backslash are concatenated with the following
                line while reading and the backslash is replaced by a
                space character. This may be used to wrap long lines.</para>
153
154

                <para>Along with a unit file
155
                <filename>foo.service</filename> the directory
156
                <filename>foo.service.wants/</filename> may exist. All
157
158
                unit files symlinked from such a directory are
                implicitly added as dependencies of type
159
160
                <varname>Wanted=</varname> to the unit. This is useful
                to hook units into the start-up of other units,
161
162
163
164
165
                without having to modify their unit files. For details
                about the semantics of <varname>Wanted=</varname> see
                below. The preferred way to create symlinks in the
                <filename>.wants/</filename> directory of a unit file
                is with the <command>enable</command> command of the
166
                <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
167
                tool which reads information from the [Install]
168
                section of unit files (see below). A similar
169
170
171
                functionality exists for <varname>Requires=</varname>
                type dependencies as well, the directory suffix is
                <filename>.requires/</filename> in this case.</para>
172

173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
                <para>Along with a unit file
                <filename>foo.service</filename> a directory
                <filename>foo.service.d/</filename> may exist. All
                files with the suffix <filename>.conf</filename> from
                this directory will be parsed after the file itself is
                parsed. This is useful to alter or add configuration
                settings to a unit, without having to modify their
                unit files. Make sure that the file that is included
                has the appropriate section headers before any
                directive.</para>

                <para>If a line starts with <option>.include</option>
                followed by a file name, the specified file will be
                parsed at this point. Make sure that the file that is
                included has the appropriate section headers before
                any directives.</para>

190
191
                <para>Note that while systemd offers a flexible
                dependency system between units it is recommended to
192
                use this functionality only sparingly and instead rely
193
                on techniques such as bus-based or socket-based
194
195
                activation which make dependencies implicit, resulting
                in a both simpler and more flexible system.</para>
196
197
198
199

                <para>Some unit names reflect paths existing in the
                file system name space. Example: a device unit
                <filename>dev-sda.device</filename> refers to a device
200
                with the device node <filename noindex='true'>/dev/sda</filename> in
201
                the file system namespace. If this applies a special
Lennart Poettering's avatar
Lennart Poettering committed
202
203
204
205
206
207
208
209
                way to escape the path name is used, so that the
                result is usable as part of a file name. Basically,
                given a path, "/" is replaced by "-", and all
                unprintable characters and the "-" are replaced by
                C-style "\x20" escapes. The root directory "/" is
                encoded as single dash, while otherwise the initial
                and ending "/" is removed from all paths during
                transformation. This escaping is reversible.</para>
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

                <para>Optionally, units may be instantiated from a
                template file at runtime. This allows creation of
                multiple units from a single configuration file. If
                systemd looks for a unit configuration file it will
                first search for the literal unit name in the
                filesystem. If that yields no success and the unit
                name contains an @ character, systemd will look for a
                unit template that shares the same name but with the
                instance string (i.e. the part between the @ character
                and the suffix) removed. Example: if a service
                <filename>getty@tty3.service</filename> is requested
                and no file by that name is found, systemd will look
                for <filename>getty@.service</filename> and
                instantiate a service from that configuration file if
225
226
227
                it is found.</para>

                <para>To refer to the instance string from
228
229
                within the configuration file you may use the special
                <literal>%i</literal> specifier in many of the
230
                configuration options. See below for details.</para>
231

232
233
234
235
236
237
238
239
                <para>If a unit file is empty (i.e. has the file size
                0) or is symlinked to <filename>/dev/null</filename>
                its configuration will not be loaded and it appears
                with a load state of <literal>masked</literal>, and
                cannot be activated. Use this as an effective way to
                fully disable a unit, making it impossible to start it
                even manually.</para>

240
241
242
243
                <para>The unit file format is covered by the
                <ulink
                url="http://www.freedesktop.org/wiki/Software/systemd/InterfaceStabilityPromise">Interface
                Stability Promise</ulink>.</para>
244

245
246
        </refsect1>

247
        <refsect1>
248
                <title>Unit Load Path</title>
249
250
251
252
253
254
255
256

                <para>Unit files are loaded from a set of paths
                determined during compilation, described in the two
                tables below. Unit files found in directories higher
                in the hierarchy override files with the same name
                lower in the hierarchy, thus allowing overrides.
                </para>

257
                <para>When systemd is running in user mode
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
                (<option>--user</option>) and the variable
                <varname>$SYSTEMD_UNIT_PATH</varname> is set, this
                contents of this variable overrides the unit load
                path.
                </para>

                <table>
                  <title>
                    Load path when running in system mode (<option>--system</option>).
                  </title>

                  <tgroup cols='2'>
                    <colspec colname='path' />
                    <colspec colname='expl' />
                    <thead>
                      <row>
                        <entry>Path</entry>
                        <entry>Description</entry>
                      </row>
                    </thead>
                    <tbody>
                      <row>
                        <entry><filename>/run/systemd/generator.early</filename></entry>
281
                        <entry>Generated units (early)</entry>
282
283
284
                      </row>
                      <row>
                        <entry><filename>/etc/systemd/system</filename></entry>
285
                        <entry>Local configuration</entry>
286
287
288
289
290
291
292
                      </row>
                      <row>
                        <entry><filename>/run/systemd/systemd</filename></entry>
                        <entry>Volatile units</entry>
                      </row>
                      <row>
                        <entry><filename>/run/systemd/generator</filename></entry>
293
                        <entry>Generated units (middle)</entry>
294
295
296
297
298
299
300
                      </row>
                      <row>
                        <entry><filename>/usr/local/lib/systemd/system</filename></entry>
                        <entry>Units for local packages</entry>
                      </row>
                      <row>
                        <entry><filename>/usr/lib/systemd/system</filename></entry>
301
                        <entry>Units for installed packages</entry>
302
303
304
                      </row>
                      <row>
                        <entry><filename>/run/systemd/generator.late</filename></entry>
305
                        <entry>Generated units (late)</entry>
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
                      </row>
                    </tbody>
                  </tgroup>
                </table>

                <table>
                  <title>
                    Load path when running in session mode (<option>--user</option>).
                  </title>

                  <tgroup cols='2'>
                    <colspec colname='path' />
                    <colspec colname='expl' />
                    <thead>
                      <row>
                        <entry>Path</entry>
                        <entry>Description</entry>
                      </row>
                    </thead>
                    <tbody>
                      <row>
                        <entry><filename>/tmp/systemd-generator.early.<replaceable>XXXXXX</replaceable></filename></entry>
328
                        <entry>Generated units (early)</entry>
329
330
331
                      </row>
                      <row>
                        <entry><filename>/etc/systemd/user</filename></entry>
332
                        <entry>Local configuration</entry>
333
334
335
336
337
338
339
                      </row>
                      <row>
                        <entry><filename>/run/systemd/user</filename></entry>
                        <entry>Volatile units</entry>
                      </row>
                      <row>
                        <entry><filename>/tmp/systemd-generator.<replaceable>XXXXXX</replaceable></filename></entry>
340
                        <entry>Generated units (middle)</entry>
341
342
343
                      </row>
                      <row>
                        <entry><filename>/usr/local/lib/systemd/user</filename></entry>
344
                        <entry>Units for local packages</entry>
345
346
347
                      </row>
                      <row>
                        <entry><filename>/usr/lib/systemd/user</filename></entry>
348
                        <entry>Units for installed packages</entry>
349
350
351
                      </row>
                      <row>
                        <entry><filename>/tmp/systemd-generator.late.<replaceable>XXXXXX</replaceable></filename></entry>
352
                        <entry>Generated units (late)</entry>
353
354
355
356
357
358
359
360
361
362
363
364
                      </row>
                    </tbody>
                  </tgroup>
                </table>

                <para>Additional units might be loaded into systemd
                ("linked") from directories not on the unit load
                path. See the <command>link</command> command for
                <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
                </para>
        </refsect1>

365
366
367
        <refsect1>
                <title>Options</title>

368
369
370
371
                <para>Unit file may include a [Unit] section, which
                carries generic information about the unit that is not
                dependent on the type of unit:</para>

372
                <variablelist class='unit-directives'>
373
374
375
376

                        <varlistentry>
                                <term><varname>Description=</varname></term>
                                <listitem><para>A free-form string
377
378
379
380
                                describing the unit. This is intended
                                for use in UIs to show descriptive
                                information along with the unit
                                name.</para></listitem>
381
382
                        </varlistentry>

383
384
385
386
387
388
389
390
391
392
393
394
395
396
                        <varlistentry>
                                <term><varname>Documentation=</varname></term>
                                <listitem><para>A space separated list
                                of URIs referencing documentation for
                                this unit or its
                                configuration. Accepted are only URIs
                                of the types
                                <literal>http://</literal>,
                                <literal>https://</literal>,
                                <literal>file:</literal>,
                                <literal>info:</literal>,
                                <literal>man:</literal>. For more
                                information about the syntax of these
                                URIs see
397
398
399
400
401
402
403
                                <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
                                URIs should be listed in order of
                                relevance, starting with the most
                                relevant. It is a good idea to first
                                reference documentation that explains
                                what the unit's purpose is, followed
                                by how it is configured, followed by
404
405
406
407
408
409
410
                                any other related documentation. This
                                option may be specified more than once
                                in which case the specified list of
                                URIs is merged. If the empty string is
                                assigned to this option the list is
                                reset and all prior assignments will
                                have no effect.</para></listitem>
411
412
                        </varlistentry>

413
                        <varlistentry>
414
                                <term><varname>Requires=</varname></term>
415

416
                                <listitem><para>Configures requirement
417
                                dependencies on other units. If this
418
                                unit gets activated, the units listed
419
420
421
422
423
424
                                here will be activated as well. If one
                                of the other units gets deactivated or
                                its activation fails, this unit will
                                be deactivated. This option may be
                                specified more than once, in which
                                case requirement dependencies for all
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
                                listed names are created. Note that
                                requirement dependencies do not
                                influence the order in which services
                                are started or stopped. This has to be
                                configured independently with the
                                <varname>After=</varname> or
                                <varname>Before=</varname> options. If
                                a unit
                                <filename>foo.service</filename>
                                requires a unit
                                <filename>bar.service</filename> as
                                configured with
                                <varname>Requires=</varname> and no
                                ordering is configured with
                                <varname>After=</varname> or
                                <varname>Before=</varname>, then both
                                units will be started simultaneously
                                and without any delay between them if
                                <filename>foo.service</filename> is
                                activated. Often it is a better choice
                                to use <varname>Wants=</varname>
                                instead of
                                <varname>Requires=</varname> in order
                                to achieve a system that is more
                                robust when dealing with failing
450
451
452
453
454
455
456
457
458
                                services.</para>

                                <para>Note that dependencies of this
                                type may also be configured outside of
                                the unit configuration file by
                                adding a symlink to a
                                <filename>.requires/</filename> directory
                                accompanying the unit file. For
                                details see above.</para></listitem>
459
                        </varlistentry>
460
461
462
463
464
465
466
467
468

                        <varlistentry>
                                <term><varname>RequiresOverridable=</varname></term>

                                <listitem><para>Similar to
                                <varname>Requires=</varname>.
                                Dependencies listed in
                                <varname>RequiresOverridable=</varname>
                                which cannot be fulfilled or fail to
469
                                start are ignored if the startup was
470
471
472
473
474
475
476
477
                                explicitly requested by the user. If
                                the start-up was pulled in indirectly
                                by some dependency or automatic
                                start-up of units that is not
                                requested by the user this dependency
                                must be fulfilled and otherwise the
                                transaction fails. Hence, this option
                                may be used to configure dependencies
Kay Sievers's avatar
Kay Sievers committed
478
                                that are normally honored unless the
479
480
481
482
483
484
485
486
487
488
489
                                user explicitly starts up the unit, in
                                which case whether they failed or not
                                is irrelevant.</para></listitem>

                        </varlistentry>
                        <varlistentry>
                                <term><varname>Requisite=</varname></term>
                                <term><varname>RequisiteOverridable=</varname></term>

                                <listitem><para>Similar to
                                <varname>Requires=</varname>
490
                                and <varname>RequiresOverridable=</varname>, respectively. However,
491
492
493
494
495
496
497
498
499
500
501
502
503
                                if a unit listed here is not started
                                already it will not be started and the
                                transaction fails
                                immediately.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Wants=</varname></term>

                                <listitem><para>A weaker version of
                                <varname>Requires=</varname>. A unit
                                listed in this option will be started
                                if the configuring unit is. However,
504
                                if the listed unit fails to start up
505
506
507
508
509
                                or cannot be added to the transaction
                                this has no impact on the validity of
                                the transaction as a whole. This is
                                the recommended way to hook start-up
                                of one unit to the start-up of another
510
511
512
                                unit.</para>

                                <para>Note that dependencies of this
513
514
515
516
517
518
519
520
                                type may also be configured outside of
                                the unit configuration file by
                                adding a symlink to a
                                <filename>.wants/</filename> directory
                                accompanying the unit file. For
                                details see above.</para></listitem>
                        </varlistentry>

521
                        <varlistentry>
522
                                <term><varname>BindsTo=</varname></term>
523
524
525
526

                                <listitem><para>Configures requirement
                                dependencies, very similar in style to
                                <varname>Requires=</varname>, however
527
                                in addition to this behavior it also
528
529
530
531
532
533
                                declares that this unit is stopped
                                when any of the units listed suddenly
                                disappears. Units can suddenly,
                                unexpectedly disappear if a service
                                terminates on its own choice, a device
                                is unplugged or a mount point
534
                                unmounted without involvement of
535
536
537
                                systemd.</para></listitem>
                        </varlistentry>

538
539
540
                        <varlistentry>
                                <term><varname>PartOf=</varname></term>

541
542
543
544
545
546
547
548
549
550
                                <listitem><para>Configures dependencies
                                similar to <varname>Requires=</varname>,
                                but limited to stopping and restarting
                                of units. When systemd stops or restarts
                                the units listed here, the action is
                                propagated to this unit.
                                Note that this is a one way dependency -
                                changes to this unit do not affect the
                                listed units.
                                </para></listitem>
551
552
                        </varlistentry>

553
554
555
556
557
                        <varlistentry>
                                <term><varname>Conflicts=</varname></term>

                                <listitem><para>Configures negative
                                requirement dependencies. If a unit
558
                                has a
559
                                <varname>Conflicts=</varname> setting
560
                                on another unit, starting the former
561
562
563
564
565
                                will stop the latter and vice
                                versa. Note that this setting is
                                independent of and orthogonal to the
                                <varname>After=</varname> and
                                <varname>Before=</varname> ordering
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
                                dependencies.</para>

                                <para>If a unit A that conflicts with
                                a unit B is scheduled to be started at
                                the same time as B, the transaction
                                will either fail (in case both are
                                required part of the transaction) or
                                be modified to be fixed (in case one
                                or both jobs are not a required part
                                of the transaction). In the latter
                                case the job that is not the required
                                will be removed, or in case both are
                                not required the unit that conflicts
                                will be started and the unit that is
                                conflicted is
                                stopped.</para></listitem>
582
583
584
585
586
587
588
589
590
591
592
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Before=</varname></term>
                                <term><varname>After=</varname></term>

                                <listitem><para>Configures ordering
                                dependencies between units. If a unit
                                <filename>foo.service</filename>
                                contains a setting
                                <option>Before=bar.service</option>
593
                                and both units are being started,
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
                                <filename>bar.service</filename>'s
                                start-up is delayed until
                                <filename>foo.service</filename> is
                                started up. Note that this setting is
                                independent of and orthogonal to the
                                requirement dependencies as configured
                                by <varname>Requires=</varname>. It is
                                a common pattern to include a unit
                                name in both the
                                <varname>After=</varname> and
                                <varname>Requires=</varname> option in
                                which case the unit listed will be
                                started before the unit that is
                                configured with these options. This
                                option may be specified more than
                                once, in which case ordering
                                dependencies for all listed names are
                                created. <varname>After=</varname> is
                                the inverse of
                                <varname>Before=</varname>, i.e. while
                                <varname>After=</varname> ensures that
                                the configured unit is started after
                                the listed unit finished starting up,
                                <varname>Before=</varname> ensures the
                                opposite, i.e.  that the configured
                                unit is fully started up before the
                                listed unit is started. Note that when
                                two units with an ordering dependency
                                between them are shut down, the
623
                                inverse of the start-up order is
624
625
626
627
628
629
630
631
632
633
634
635
636
637
                                applied. i.e. if a unit is configured
                                with <varname>After=</varname> on
                                another unit, the former is stopped
                                before the latter if both are shut
                                down. If one unit with an ordering
                                dependency on another unit is shut
                                down while the latter is started up,
                                the shut down is ordered before the
                                start-up regardless whether the
                                ordering dependency is actually of
                                type <varname>After=</varname> or
                                <varname>Before=</varname>. If two
                                units have no ordering dependencies
                                between them they are shut down
638
                                or started up simultaneously, and
639
640
641
642
                                no ordering takes
                                place. </para></listitem>
                        </varlistentry>

643
644
645
646
647
                        <varlistentry>
                                <term><varname>OnFailure=</varname></term>

                                <listitem><para>Lists one or more
                                units that are activated when this
648
649
650
                                unit enters the
                                '<literal>failed</literal>'
                                state.</para></listitem>
651
652
                        </varlistentry>

653
                        <varlistentry>
654
655
                                <term><varname>PropagatesReloadTo=</varname></term>
                                <term><varname>ReloadPropagatedFrom=</varname></term>
656
657
658
659
660
661
662
663
664
665
666
667
668

                                <listitem><para>Lists one or more
                                units where reload requests on the
                                unit will be propagated to/on the
                                other unit will be propagated
                                from. Issuing a reload request on a
                                unit will automatically also enqueue a
                                reload request on all units that the
                                reload request shall be propagated to
                                via these two
                                settings.</para></listitem>
                        </varlistentry>

669
670
671
672
                        <varlistentry>
                                <term><varname>RequiresMountsFor=</varname></term>

                                <listitem><para>Takes a space
673
                                separated list of absolute paths. Automatically
674
675
676
677
678
679
680
                                adds dependencies of type
                                <varname>Requires=</varname> and
                                <varname>After=</varname> for all
                                mount units required to access the
                                specified path.</para></listitem>
                        </varlistentry>

681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
                        <varlistentry>
                                <term><varname>OnFailureIsolate=</varname></term>

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option> the
                                unit listed in
                                <varname>OnFailure=</varname> will be
                                enqueued in isolation mode, i.e. all
                                units that are not its dependency will
                                be stopped. If this is set only a
                                single unit may be listed in
                                <varname>OnFailure=</varname>. Defaults
                                to
                                <option>false</option>.</para></listitem>
                        </varlistentry>

697
698
699
700
701
702
703
704
705
706
                        <varlistentry>
                                <term><varname>IgnoreOnIsolate=</varname></term>

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option>
                                this unit will not be stopped when
                                isolating another unit. Defaults to
                                <option>false</option>.</para></listitem>
                        </varlistentry>

707
708
709
710
711
712
713
                        <varlistentry>
                                <term><varname>IgnoreOnSnapshot=</varname></term>

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option>
                                this unit will not be included in
                                snapshots. Defaults to
714
715
                                <option>true</option> for device and
                                snapshot units, <option>false</option>
716
717
718
                                for the others.</para></listitem>
                        </varlistentry>

719
720
721
722
723
724
725
                        <varlistentry>
                                <term><varname>StopWhenUnneeded=</varname></term>

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option>
                                this unit will be stopped when it is
                                no longer used. Note that in order to
726
727
                                minimize the work to be executed,
                                systemd will not stop units by default
728
729
730
                                unless they are conflicting with other
                                units, or the user explicitly
                                requested their shut down. If this
731
                                option is set, a unit will be
732
733
734
735
736
737
                                automatically cleaned up if no other
                                active unit requires it. Defaults to
                                <option>false</option>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
738
739
                                <term><varname>RefuseManualStart=</varname></term>
                                <term><varname>RefuseManualStop=</varname></term>
740
741
742

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option>
743
                                this unit can only be activated
744
                                or deactivated indirectly. In
745
                                this case explicit start-up
746
                                or termination requested by the
747
                                user is denied, however if it is
748
                                started or stopped as a
749
                                dependency of another unit, start-up
750
                                or termination will succeed. This
751
752
753
754
755
756
757
                                is mostly a safety feature to ensure
                                that the user does not accidentally
                                activate units that are not intended
                                to be activated explicitly, and not
                                accidentally deactivate units that are
                                not intended to be deactivated.
                                These options default to
758
759
760
                                <option>false</option>.</para></listitem>
                        </varlistentry>

761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
                        <varlistentry>
                                <term><varname>AllowIsolate=</varname></term>

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option>
                                this unit may be used with the
                                <command>systemctl isolate</command>
                                command. Otherwise this will be
                                refused. It probably is a good idea to
                                leave this disabled except for target
                                units that shall be used similar to
                                runlevels in SysV init systems, just
                                as a precaution to avoid unusable
                                system states. This option defaults to
                                <option>false</option>.</para></listitem>
                        </varlistentry>

778
779
780
781
782
783
784
785
786
787
788
789
790
                        <varlistentry>
                                <term><varname>DefaultDependencies=</varname></term>

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option>
                                (the default), a few default
                                dependencies will implicitly be
                                created for the unit. The actual
                                dependencies created depend on the
                                unit type. For example, for service
                                units, these dependencies ensure that
                                the service is started only after
                                basic system initialization is
791
                                completed and is properly terminated on
792
793
794
795
796
797
798
799
800
801
802
803
804
805
                                system shutdown. See the respective
                                man pages for details. Generally, only
                                services involved with early boot or
                                late shutdown should set this option
                                to <option>false</option>. It is
                                highly recommended to leave this
                                option enabled for the majority of
                                common units. If set to
                                <option>false</option> this option
                                does not disable all implicit
                                dependencies, just non-essential
                                ones.</para></listitem>
                        </varlistentry>

806
807
808
809
810
811
812
813
814
                        <varlistentry>
                                <term><varname>JobTimeoutSec=</varname></term>

                                <listitem><para>When clients are
                                waiting for a job of this unit to
                                complete, time out after the specified
                                time. If this time limit is reached
                                the job will be cancelled, the unit
                                however will not change state or even
815
816
817
818
819
820
                                enter the '<literal>failed</literal>'
                                mode. This value defaults to 0 (job
                                timeouts disabled), except for device
                                units. NB: this timeout is independent
                                from any unit-specific timeout (for
                                example, the timeout set with
821
                                <varname>Timeout=</varname> in service
822
823
824
825
                                units) as the job timeout has no
                                effect on the unit itself, only on the
                                job that might be pending for it. Or
                                in other words: unit-specific timeouts
826
827
828
                                are useful to abort unit state
                                changes, and revert them. The job
                                timeout set with this option however
829
830
831
                                is useful to abort only the job
                                waiting for the unit state to
                                change.</para></listitem>
832
833
                        </varlistentry>

834
835
                        <varlistentry>
                                <term><varname>ConditionPathExists=</varname></term>
836
                                <term><varname>ConditionPathExistsGlob=</varname></term>
837
                                <term><varname>ConditionPathIsDirectory=</varname></term>
838
                                <term><varname>ConditionPathIsSymbolicLink=</varname></term>
839
                                <term><varname>ConditionPathIsMountPoint=</varname></term>
840
                                <term><varname>ConditionPathIsReadWrite=</varname></term>
841
                                <term><varname>ConditionDirectoryNotEmpty=</varname></term>
842
                                <term><varname>ConditionFileNotEmpty=</varname></term>
843
                                <term><varname>ConditionFileIsExecutable=</varname></term>
844
                                <term><varname>ConditionKernelCommandLine=</varname></term>
845
                                <term><varname>ConditionVirtualization=</varname></term>
846
                                <term><varname>ConditionSecurity=</varname></term>
847
                                <term><varname>ConditionCapability=</varname></term>
848
                                <term><varname>ConditionHost=</varname></term>
849
                                <term><varname>ConditionACPower=</varname></term>
850
                                <term><varname>ConditionNull=</varname></term>
851
852
853

                                <listitem><para>Before starting a unit
                                verify that the specified condition is
854
855
856
857
858
859
860
861
862
863
864
                                true. If it is not true the starting
                                of the unit will be skipped, however
                                all ordering dependencies of it are
                                still respected. A failing condition
                                will not result in the unit being
                                moved into a failure state. The
                                condition is checked at the time the
                                queued start job is to be
                                executed.</para>

                                <para>With
865
                                <varname>ConditionPathExists=</varname>
866
                                a file existence condition is
867
868
                                checked before a unit is started. If
                                the specified absolute path name does
869
870
871
                                not exist the condition will
                                fail. If the absolute path name passed
                                to
872
873
                                <varname>ConditionPathExists=</varname>
                                is prefixed with an exclamation mark
874
                                ('!'), the test is negated, and the unit
875
                                is only started if the path does not
876
877
878
879
880
881
882
883
884
885
                                exist.</para>

                                <para><varname>ConditionPathExistsGlob=</varname>
                                is similar to
                                <varname>ConditionPathExists=</varname>,
                                but checks for the existence of at
                                least one file or directory matching
                                the specified globbing pattern.</para>

                                <para><varname>ConditionPathIsDirectory=</varname>
886
887
888
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
889
                                exists and is a
890
891
892
                                directory.</para>

                                <para><varname>ConditionPathIsSymbolicLink=</varname>
893
894
895
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
896
                                exists and is a symbolic
897
898
899
                                link.</para>

                                <para><varname>ConditionPathIsMountPoint=</varname>
900
901
902
903
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
                                exists and is a mount
904
905
906
                                point.</para>

                                <para><varname>ConditionPathIsReadWrite=</varname>
907
908
909
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether the underlying
910
                                file system is readable and writable
911
                                (i.e. not mounted
912
913
                                read-only).</para>

914
                                <para><varname>ConditionDirectoryNotEmpty=</varname>
915
916
917
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
918
919
                                exists and is a non-empty
                                directory.</para>
920

921
                                <para><varname>ConditionFileNotEmpty=</varname>
922
923
924
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
925
926
927
928
929
930
931
932
933
                                exists and refers to a regular file
                                with a non-zero size.</para>

                                <para><varname>ConditionFileIsExecutable=</varname>
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
                                exists, is a regular file and marked
                                executable.</para>
934

935
                                <para>Similar,
936
937
938
939
940
941
                                <varname>ConditionKernelCommandLine=</varname>
                                may be used to check whether a
                                specific kernel command line option is
                                set (or if prefixed with the
                                exclamation mark unset). The argument
                                must either be a single word, or an
Miklos Vajna's avatar
Miklos Vajna committed
942
                                assignment (i.e. two words, separated
943
                                '='). In the former
944
945
946
947
948
949
                                case the kernel command line is
                                searched for the word appearing as is,
                                or as left hand side of an
                                assignment. In the latter case the
                                exact assignment is looked for with
                                right and left hand side
950
951
952
                                matching.</para>

                                <para><varname>ConditionVirtualization=</varname>
953
954
955
956
957
                                may be used to check whether the
                                system is executed in a virtualized
                                environment and optionally test
                                whether it is a specific
                                implementation. Takes either boolean
958
                                value to check if being executed in
959
960
                                any virtualized environment, or one of
                                <varname>vm</varname> and
961
                                <varname>container</varname> to test
962
                                against a generic type of
963
                                virtualization solution, or one of
964
965
966
967
968
969
                                <varname>qemu</varname>,
                                <varname>kvm</varname>,
                                <varname>vmware</varname>,
                                <varname>microsoft</varname>,
                                <varname>oracle</varname>,
                                <varname>xen</varname>,
970
971
                                <varname>bochs</varname>,
                                <varname>chroot</varname>,
972
973
                                <varname>openvz</varname>,
                                <varname>lxc</varname>,
974
                                <varname>lxc-libvirt</varname>,
975
976
977
978
979
980
                                <varname>systemd-nspawn</varname> to
                                test against a specific
                                implementation. If multiple
                                virtualization technologies are nested
                                only the innermost is considered. The
                                test may be negated by prepending an
981
982
983
                                exclamation mark.</para>

                                <para><varname>ConditionSecurity=</varname>
984
985
986
987
988
                                may be used to check whether the given
                                security module is enabled on the
                                system.  Currently the only recognized
                                value is <varname>selinux</varname>.
                                The test may be negated by prepending
989
                                an exclamation
990
991
992
                                mark.</para>

                                <para><varname>ConditionCapability=</varname>
993
994
995
996
997
998
999
1000
1001
1002
                                may be used to check whether the given
                                capability exists in the capability
                                bounding set of the service manager
                                (i.e. this does not check whether
                                capability is actually available in
                                the permitted or effective sets, see
                                <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                                for details). Pass a capability name
                                such as <literal>CAP_MKNOD</literal>,
                                possibly prefixed with an exclamation
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
                                mark to negate the check.</para>

                                <para><varname>ConditionHost=</varname>
                                may be used to match against the
                                host name or machine ID of the
                                host. This either takes a host name
                                string (optionally with shell style
                                globs) which is tested against the
                                locally set host name as returned by
                                <citerefentry><refentrytitle>gethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
                                or a machine ID formatted as string
                                (see
                                <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
                                The test may be negated by prepending
                                an exclamation mark.</para>

1019
                                <para><varname>ConditionACPower=</varname>
1020
1021
                                may be used to check whether the
                                system has AC power, or is exclusively
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
                                battery powered at the time of
                                activation of the unit. This takes a
                                boolean argument. If set to
                                <varname>true</varname> the condition
                                will hold only if at least one AC
                                connector of the system is connected
                                to a power source, or if no AC
                                connectors are known. Conversely, if
                                set to <varname>false</varname> the
                                condition will hold only if there is
                                at least one AC connector known and
                                all AC connectors are disconnected
                                from a power source.</para>

1036
                                <para>Finally,
1037
1038
1039
1040
1041
1042
                                <varname>ConditionNull=</varname> may
                                be used to add a constant condition
                                check value to the unit. It takes a
                                boolean argument. If set to
                                <varname>false</varname> the condition
                                will always fail, otherwise
1043
1044
1045
                                succeed.</para>

                                <para>If multiple conditions are
1046
                                specified the unit will be executed if
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
                                all of them apply (i.e. a logical AND
                                is applied). Condition checks can be
                                prefixed with a pipe symbol (|) in
                                which case a condition becomes a
                                triggering condition. If at least one
                                triggering condition is defined for a
                                unit then the unit will be executed if
                                at least one of the triggering
                                conditions apply and all of the
                                non-triggering conditions. If you
                                prefix an argument with the pipe
                                symbol and an exclamation mark the
                                pipe symbol must be passed first, the
1060
1061
                                exclamation second. Except for
                                <varname>ConditionPathIsSymbolicLink=</varname>,
1062
1063
1064
1065
1066
1067
                                all path checks follow symlinks. If
                                any of these options is assigned the
                                empty string the list of conditions is
                                reset completely, all previous
                                condition settings (of any kind) will
                                have no effect.</para></listitem>
1068
                        </varlistentry>
1069

1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
                        <varlistentry>
                                <term><varname>SourcePath=</varname></term>
                                <listitem><para>A path to a
                                configuration file this unit has been
                                generated from. This is primarily
                                useful for implementation of generator
                                tools that convert configuration from
                                an external configuration file format
                                into native unit files. Thus
                                functionality should not be used in
                                normal units.</para></listitem>
                        </varlistentry>
1082
                </variablelist>
1083
1084
1085
1086
1087
1088

                <para>Unit file may include a [Install] section, which
                carries installation information for the unit. This
                section is not interpreted by
                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                during runtime. It is used exclusively by the
1089
1090
1091
                <command>enable</command> and
                <command>disable</command> commands of the
                <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1092
                tool during installation of a unit:</para>
1093

1094
                <variablelist class='unit-directives'>
1095
1096
1097
                        <varlistentry>
                                <term><varname>Alias=</varname></term>

Lennart Poettering's avatar
Lennart Poettering committed
1098
                                <listitem><para>Additional names this
1099
1100
1101
1102
1103
1104
                                unit shall be installed under. The
                                names listed here must have the same
                                suffix (i.e. type) as the unit file
                                name. This option may be specified
                                more than once, in which case all
                                listed names are used. At installation
Kay Sievers's avatar
Kay Sievers committed
1105
                                time,
1106
                                <command>systemctl enable</command>
1107
                                will create symlinks from these names
1108
                                to the unit file name.</para></listitem>
1109
1110
1111
1112
                        </varlistentry>

                        <varlistentry>
                                <term><varname>WantedBy=</varname></term>
1113
                                <term><varname>RequiredBy=</varname></term>
1114
1115
1116

                                <listitem><para>Installs a symlink in
                                the <filename>.wants/</filename>
1117
1118
                                or <filename>.requires/</filename>
                                subdirectory for a unit, respectively. This has the
1119
1120
1121
                                effect that when the listed unit name
                                is activated the unit listing it is
                                activated
Lennart Poettering's avatar
Lennart Poettering committed
1122
                                too. <command>WantedBy=foo.service</command>
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
                                in a service
                                <filename>bar.service</filename> is
                                mostly equivalent to
                                <command>Alias=foo.service.wants/bar.service</command>
                                in the same file.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Also=</varname></term>

                                <listitem><para>Additional units to
                                install when this unit is
                                installed. If the user requests
                                installation of a unit with this
1137
                                option configured,
1138
                                <command>systemctl enable</command>
1139
1140
1141
                                will automatically install units
                                listed in this option as
                                well.</para></listitem>
1142
1143
1144
                        </varlistentry>
                </variablelist>

1145
1146
1147
1148
                <para>The following specifiers are interpreted in the
                Install section: %n, %N, %p, %i, %U, %u, %m, %H, %b.
                For their meaning see the next section.
                </para>
1149
1150
        </refsect1>

1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
        <refsect1>
                <title>Specifiers</title>

                <para>Many settings resolve specifiers which may be
                used to write generic unit files referring to runtime
                or unit parameters that are replaced when the unit
                files are loaded. The following specifiers are
                understood:</para>

                <table>
                  <title>Specifiers available in unit files</title>
                  <tgroup cols='3' align='left' colsep='1' rowsep='1'>
                    <colspec colname="spec" />
                    <colspec colname="mean" />
                    <colspec colname="detail" />
                    <thead>
                      <row>
                        <entry>Specifier</entry>
                        <entry>Meaning</entry>
                        <entry>Details</entry>
                      </row>
                    </thead>
                    <tbody>
                      <row>
                        <entry><literal>%n</literal></entry>
                        <entry>Full unit name</entry>
                        <entry></entry>
                      </row>
                      <row>
                        <entry><literal>%N</literal></entry>
                        <entry>Unescaped full unit name</entry>
                        <entry></entry>
                      </row>
                      <row>
                        <entry><literal>%p</literal></entry>
                        <entry>Prefix name</entry>
                        <entry>For instantiated units this refers to the string before the @. For non-instantiated units this refers to to the name of the unit with the type suffix removed.</entry>
                      </row>
                      <row>
                        <entry><literal>%P</literal></entry>
                        <entry>Unescaped prefix name</entry>
                        <entry></entry>
                      </row>
                      <row>
                        <entry><literal>%i</literal></entry>
                        <entry>Instance name</entry>
                        <entry>For instantiated units: this is the string between the @ character and the suffix.</entry>
                      </row>
                      <row>
                        <entry><literal>%I</literal></entry>
                        <entry>Unescaped instance name</entry>
                        <entry></entry>
                      </row>
                      <row>
                        <entry><literal>%f</literal></entry>
                        <entry>Unescaped file name</entry>
1207
                        <entry>This is either the unescaped instance name (if applicable) with <filename>/</filename> prepended (if applicable), or the prefix name similarly prepended with <filename>/</filename>.</entry>
1208
1209
1210
1211
1212
1213
1214
1215
                      </row>
                      <row>
                        <entry><literal>%c</literal></entry>
                        <entry>Control group path of the unit</entry>
                        <entry></entry>
                      </row>
                      <row>
                        <entry><literal>%r</literal></entry>
1216
1217
                        <entry>Root control group path where units are placed.</entry>
                        <entry>For system instances this usually resolves to <filename>/system</filename>, except in containers, where the path might be prefixed with the container's root control group.</entry>
1218
1219
1220
                      </row>
                      <row>
                        <entry><literal>%R</literal></entry>
1221
1222
                        <entry>Parent directory of the control group path where units are placed.</entry>
                        <entry>For system instances this usually resolves to <filename>/</filename>, except in containers, where this resolves to the container's root directory. This specifier is particularly useful in the <varname>ControlGroup=</varname> setting (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</entry>
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
                      </row>
                      <row>
                        <entry><literal>%t</literal></entry>
                        <entry>Runtime socket dir</entry>
                        <entry>This is either <filename>/run</filename> (for the system manager) or <literal>$XDG_RUNTIME_DIR</literal> (for user managers).</entry>
                      </row>
                      <row>
                        <entry><literal>%u</literal></entry>
                        <entry>User name</entry>
                        <entry>This is the name of the configured user of the unit, or (if none is set) the user running the systemd instance.</entry>
                      </row>
                      <row>
                        <entry><literal>%U</literal></entry>
                        <entry>User UID</entry>
                        <entry>This is the UID of the configured user of the unit, or (if none is set) the user running the systemd instance.</entry>
                      </row>
                      <row>
                        <entry><literal>%h</literal></entry>
                        <entry>User home directory</entry>
                        <entry>This is the home directory of the configured user of the unit, or (if none is set) the user running the systemd instance.</entry>
                      </row>
                      <row>
                        <entry><literal>%s</literal></entry>
                        <entry>User shell</entry>
1247
                        <entry>This is the shell of the configured user of the unit, or (if none is set) the user running the systemd instance.  If the user is <literal>root</literal> (UID equal to 0), the shell configured in account database is ignored and <filename>/bin/sh</filename> is always used.</entry>
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
                      </row>
                      <row>
                        <entry><literal>%m</literal></entry>
                        <entry>Machine ID</entry>
                        <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry>
                      </row>
                      <row>
                        <entry><literal>%b</literal></entry>
                        <entry>Boot ID</entry>
                        <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry>
                      </row>
                      <row>
                        <entry><literal>%H</literal></entry>
                        <entry>Host name</entry>
                        <entry>The host name of the running system.</entry>
                      </row>
1264
1265
1266
1267
1268
                      <row>
                        <entry><literal>%%</literal></entry>
                        <entry>Escaped %</entry>
                        <entry>Single percent sign.</entry>
                      </row>
1269
1270
1271
1272
1273
                    </tbody>
                  </tgroup>
                </table>
        </refsect1>

1274
        <refsect1>
Lennart Poettering's avatar
Lennart Poettering committed
1275
1276
1277
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1288
                        <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1289
                        <citerefentry><refentrytitle>systemd.snapshot</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1290
                        <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1291
1292
                        <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
Lennart Poettering's avatar
Lennart Poettering committed
1293
                </para>
1294
1295
1296
        </refsect1>

</refentry>