systemd.unit.xml 64.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
11 12
  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
13 14 15 16 17
  (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
18
  Lesser General Public License for more details.
19

20
  You should have received a copy of the GNU Lesser General Public License
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
  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>
47
                <refpurpose>Unit configuration</refpurpose>
48 49 50
        </refnamediv>

        <refsynopsisdiv>
51 52 53 54 55 56 57 58
                <para><filename>systemd.service</filename>,
                <filename>systemd.socket</filename>,
                <filename>systemd.device</filename>,
                <filename>systemd.mount</filename>,
                <filename>systemd.automount</filename>,
                <filename>systemd.swap</filename>,
                <filename>systemd.target</filename>,
                <filename>systemd.path</filename>,
59 60
                <filename>systemd.timer</filename>,
                <filename>systemd.snapshot</filename></para>
61 62 63 64 65 66
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>A unit configuration file encodes information
67
                about a service, a socket, a device, a mount point, an
Kay Sievers's avatar
Kay Sievers committed
68
                automount point, a swap file or partition, a start-up
69
                target, a file system path or a timer controlled and
70 71 72 73
                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
74
                Desktop Entry Specification</ulink> <filename>.desktop</filename> files, which are in turn
75 76
                inspired by Microsoft Windows
                <filename>.ini</filename> files.</para>
77

78
                <para>This man page lists the common configuration
79
                options of all the unit types. These options need to
80 81
                be configured in the [Unit] or [Install]
                sections of the unit files.</para>
82 83

                <para>In addition to the generic [Unit] and [Install]
84
                sections described here, each unit may have a
85 86 87 88 89 90 91 92 93 94 95 96 97
                type-specific section, e.g. [Service] for a service
                unit. See the respective man pages for more
                information.</para>

                <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
98
                written in various formats. For positive settings the
99 100 101 102 103 104 105
                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>

106 107 108
                <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
109 110 111
                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
112 113
                seconds; "2min 200ms" refers to 2 minutes plus 200
                milliseconds, i.e. 120200ms. The following time units
114 115 116
                are understood: s, min, h, d, w, ms, us. For details
                see
                <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
117

118
                <para>Empty lines and lines starting with # or ; are
119 120 121 122
                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>
123 124

                <para>Along with a unit file
125
                <filename>foo.service</filename> the directory
126
                <filename>foo.service.wants/</filename> may exist. All
127 128
                unit files symlinked from such a directory are
                implicitly added as dependencies of type
129 130
                <varname>Wanted=</varname> to the unit. This is useful
                to hook units into the start-up of other units,
131 132 133 134 135
                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
136
                <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
137
                tool which reads information from the [Install]
138
                section of unit files (see below). A similar
139 140 141
                functionality exists for <varname>Requires=</varname>
                type dependencies as well, the directory suffix is
                <filename>.requires/</filename> in this case.</para>
142

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
                <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>

160 161
                <para>Note that while systemd offers a flexible
                dependency system between units it is recommended to
162
                use this functionality only sparingly and instead rely
163
                on techniques such as bus-based or socket-based
164 165
                activation which make dependencies implicit, resulting
                in a both simpler and more flexible system.</para>
166 167 168 169 170 171

                <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
                with the device node <filename>/dev/sda</filename> in
                the file system namespace. If this applies a special
Lennart Poettering's avatar
Lennart Poettering committed
172 173 174 175 176 177 178 179
                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>
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

                <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
195 196 197
                it is found.</para>

                <para>To refer to the instance string from
198 199
                within the configuration file you may use the special
                <literal>%i</literal> specifier in many of the
200
                configuration options. See below for details.</para>
201

202 203 204 205 206 207 208 209
                <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>

210 211 212 213
                <para>The unit file format is covered by the
                <ulink
                url="http://www.freedesktop.org/wiki/Software/systemd/InterfaceStabilityPromise">Interface
                Stability Promise</ulink>.</para>
214

215 216 217 218 219
        </refsect1>

        <refsect1>
                <title>Options</title>

220 221 222 223
                <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>

224
                <variablelist class='unit-directives'>
225 226 227 228

                        <varlistentry>
                                <term><varname>Description=</varname></term>
                                <listitem><para>A free-form string
229 230 231 232
                                describing the unit. This is intended
                                for use in UIs to show descriptive
                                information along with the unit
                                name.</para></listitem>
233 234
                        </varlistentry>

235 236 237 238 239 240 241 242 243 244 245 246 247 248
                        <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
249 250 251 252 253 254 255
                                <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
256 257 258 259 260 261 262
                                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>
263 264
                        </varlistentry>

265
                        <varlistentry>
266
                                <term><varname>Requires=</varname></term>
267

268
                                <listitem><para>Configures requirement
269
                                dependencies on other units. If this
270
                                unit gets activated, the units listed
271 272 273 274 275 276
                                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
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
                                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
302 303 304 305 306 307 308 309 310
                                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>
311
                        </varlistentry>
312 313 314 315 316 317 318 319 320

                        <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
321
                                start are ignored if the startup was
322 323 324 325 326 327 328 329
                                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
330
                                that are normally honored unless the
331 332 333 334 335 336 337 338 339 340 341
                                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>
342
                                and <varname>RequiresOverridable=</varname>, respectively. However,
343 344 345 346 347 348 349 350 351 352 353 354 355
                                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,
356
                                if the listed unit fails to start up
357 358 359 360 361
                                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
362 363 364
                                unit.</para>

                                <para>Note that dependencies of this
365 366 367 368 369 370 371 372
                                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>

373
                        <varlistentry>
374
                                <term><varname>BindsTo=</varname></term>
375 376 377 378

                                <listitem><para>Configures requirement
                                dependencies, very similar in style to
                                <varname>Requires=</varname>, however
379
                                in addition to this behavior it also
380 381 382 383 384 385
                                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
386
                                unmounted without involvement of
387 388 389
                                systemd.</para></listitem>
                        </varlistentry>

390 391 392
                        <varlistentry>
                                <term><varname>PartOf=</varname></term>

393 394 395 396 397 398 399 400 401 402
                                <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>
403 404
                        </varlistentry>

405 406 407 408 409
                        <varlistentry>
                                <term><varname>Conflicts=</varname></term>

                                <listitem><para>Configures negative
                                requirement dependencies. If a unit
410
                                has a
411
                                <varname>Conflicts=</varname> setting
412
                                on another unit, starting the former
413 414 415 416 417
                                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
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
                                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>
434 435 436 437 438 439 440 441 442 443 444
                        </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>
445
                                and both units are being started,
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
                                <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
475
                                inverse of the start-up order is
476 477 478 479 480 481 482 483 484 485 486 487 488 489
                                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
490
                                or started up simultaneously, and
491 492 493 494
                                no ordering takes
                                place. </para></listitem>
                        </varlistentry>

495 496 497 498 499
                        <varlistentry>
                                <term><varname>OnFailure=</varname></term>

                                <listitem><para>Lists one or more
                                units that are activated when this
500 501 502
                                unit enters the
                                '<literal>failed</literal>'
                                state.</para></listitem>
503 504
                        </varlistentry>

505
                        <varlistentry>
506 507
                                <term><varname>PropagatesReloadTo=</varname></term>
                                <term><varname>ReloadPropagatedFrom=</varname></term>
508 509 510 511 512 513 514 515 516 517 518 519 520

                                <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>

521 522 523 524
                        <varlistentry>
                                <term><varname>RequiresMountsFor=</varname></term>

                                <listitem><para>Takes a space
525
                                separated list of absolute paths. Automatically
526 527 528 529 530 531 532
                                adds dependencies of type
                                <varname>Requires=</varname> and
                                <varname>After=</varname> for all
                                mount units required to access the
                                specified path.</para></listitem>
                        </varlistentry>

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
                        <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>

549 550 551 552 553 554 555 556 557 558
                        <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>

559 560 561 562 563 564 565
                        <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
566 567
                                <option>true</option> for device and
                                snapshot units, <option>false</option>
568 569 570
                                for the others.</para></listitem>
                        </varlistentry>

571 572 573 574 575 576 577
                        <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
578 579
                                minimize the work to be executed,
                                systemd will not stop units by default
580 581 582
                                unless they are conflicting with other
                                units, or the user explicitly
                                requested their shut down. If this
583
                                option is set, a unit will be
584 585 586 587 588 589
                                automatically cleaned up if no other
                                active unit requires it. Defaults to
                                <option>false</option>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
590 591
                                <term><varname>RefuseManualStart=</varname></term>
                                <term><varname>RefuseManualStop=</varname></term>
592 593 594

                                <listitem><para>Takes a boolean
                                argument. If <option>true</option>
595
                                this unit can only be activated
596
                                or deactivated indirectly. In
597
                                this case explicit start-up
598
                                or termination requested by the
599
                                user is denied, however if it is
600
                                started or stopped as a
601
                                dependency of another unit, start-up
602
                                or termination will succeed. This
603 604 605 606 607 608 609
                                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
610 611 612
                                <option>false</option>.</para></listitem>
                        </varlistentry>

613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
                        <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>

630 631 632 633 634 635 636 637 638 639 640 641 642
                        <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
643
                                completed and is properly terminated on
644 645 646 647 648 649 650 651 652 653 654 655 656 657
                                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>

658 659 660 661 662 663 664 665 666
                        <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
667 668 669 670 671 672
                                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
673
                                <varname>Timeout=</varname> in service
674 675 676 677
                                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
678 679 680
                                are useful to abort unit state
                                changes, and revert them. The job
                                timeout set with this option however
681 682 683
                                is useful to abort only the job
                                waiting for the unit state to
                                change.</para></listitem>
684 685
                        </varlistentry>

686 687
                        <varlistentry>
                                <term><varname>ConditionPathExists=</varname></term>
688
                                <term><varname>ConditionPathExistsGlob=</varname></term>
689
                                <term><varname>ConditionPathIsDirectory=</varname></term>
690
                                <term><varname>ConditionPathIsSymbolicLink=</varname></term>
691
                                <term><varname>ConditionPathIsMountPoint=</varname></term>
692
                                <term><varname>ConditionPathIsReadWrite=</varname></term>
693
                                <term><varname>ConditionDirectoryNotEmpty=</varname></term>
694
                                <term><varname>ConditionFileNotEmpty=</varname></term>
695
                                <term><varname>ConditionFileIsExecutable=</varname></term>
696
                                <term><varname>ConditionKernelCommandLine=</varname></term>
697
                                <term><varname>ConditionVirtualization=</varname></term>
698
                                <term><varname>ConditionSecurity=</varname></term>
699
                                <term><varname>ConditionCapability=</varname></term>
700
                                <term><varname>ConditionHost=</varname></term>
701
                                <term><varname>ConditionACPower=</varname></term>
702
                                <term><varname>ConditionNull=</varname></term>
703 704 705

                                <listitem><para>Before starting a unit
                                verify that the specified condition is
706 707 708 709 710 711 712 713 714 715 716
                                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
717
                                <varname>ConditionPathExists=</varname>
718
                                a file existence condition is
719 720
                                checked before a unit is started. If
                                the specified absolute path name does
721 722 723
                                not exist the condition will
                                fail. If the absolute path name passed
                                to
724 725
                                <varname>ConditionPathExists=</varname>
                                is prefixed with an exclamation mark
726
                                ('!'), the test is negated, and the unit
727
                                is only started if the path does not
728 729 730 731 732 733 734 735 736 737
                                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>
738 739 740
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
741
                                exists and is a
742 743 744
                                directory.</para>

                                <para><varname>ConditionPathIsSymbolicLink=</varname>
745 746 747
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
748
                                exists and is a symbolic
749 750 751
                                link.</para>

                                <para><varname>ConditionPathIsMountPoint=</varname>
752 753 754 755
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
                                exists and is a mount
756 757 758
                                point.</para>

                                <para><varname>ConditionPathIsReadWrite=</varname>
759 760 761
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether the underlying
762
                                file system is readable and writable
763
                                (i.e. not mounted
764 765
                                read-only).</para>

766
                                <para><varname>ConditionDirectoryNotEmpty=</varname>
767 768 769
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
770 771
                                exists and is a non-empty
                                directory.</para>
772

773
                                <para><varname>ConditionFileNotEmpty=</varname>
774 775 776
                                is similar to
                                <varname>ConditionPathExists=</varname>
                                but verifies whether a certain path
777 778 779 780 781 782 783 784 785
                                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>
786

787
                                <para>Similar,
788 789 790 791 792 793
                                <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
794
                                assignment (i.e. two words, separated
795
                                '='). In the former
796 797 798 799 800 801
                                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
802 803 804
                                matching.</para>

                                <para><varname>ConditionVirtualization=</varname>
805 806 807 808 809
                                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
810
                                value to check if being executed in
811 812
                                any virtualized environment, or one of
                                <varname>vm</varname> and
813
                                <varname>container</varname> to test
814
                                against a generic type of
815
                                virtualization solution, or one of
816 817 818 819 820 821
                                <varname>qemu</varname>,
                                <varname>kvm</varname>,
                                <varname>vmware</varname>,
                                <varname>microsoft</varname>,
                                <varname>oracle</varname>,
                                <varname>xen</varname>,
822 823
                                <varname>bochs</varname>,
                                <varname>chroot</varname>,
824 825
                                <varname>openvz</varname>,
                                <varname>lxc</varname>,
826
                                <varname>lxc-libvirt</varname>,
827 828 829 830 831 832
                                <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
833 834 835
                                exclamation mark.</para>

                                <para><varname>ConditionSecurity=</varname>
836 837 838 839 840
                                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
841
                                an exclamation
842 843 844
                                mark.</para>

                                <para><varname>ConditionCapability=</varname>
845 846 847 848 849 850 851 852 853 854
                                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
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
                                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>

871
                                <para><varname>ConditionACPower=</varname>
872 873
                                may be used to check whether the
                                system has AC power, or is exclusively
874 875 876 877 878 879 880 881 882 883 884 885 886 887
                                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>

888
                                <para>Finally,
889 890 891 892 893 894
                                <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
895 896 897
                                succeed.</para>

                                <para>If multiple conditions are
898
                                specified the unit will be executed if
899 900 901 902 903 904 905 906 907 908 909 910 911
                                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
912 913
                                exclamation second. Except for
                                <varname>ConditionPathIsSymbolicLink=</varname>,
914 915 916 917 918 919
                                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>
920
                        </varlistentry>
921

922 923 924 925 926 927 928 929 930 931 932 933
                        <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>
934
                </variablelist>
935 936 937 938 939 940

                <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
941 942 943
                <command>enable</command> and
                <command>disable</command> commands of the
                <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
944
                tool during installation of a unit:</para>
945

946
                <variablelist class='unit-directives'>
947 948 949
                        <varlistentry>
                                <term><varname>Alias=</varname></term>

Lennart Poettering's avatar
Lennart Poettering committed
950
                                <listitem><para>Additional names this
951 952 953 954 955 956
                                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
957
                                time,
958
                                <command>systemctl enable</command>
959
                                will create symlinks from these names
960
                                to the unit file name.</para></listitem>
961 962 963 964
                        </varlistentry>

                        <varlistentry>
                                <term><varname>WantedBy=</varname></term>
965
                                <term><varname>RequiredBy=</varname></term>
966 967 968

                                <listitem><para>Installs a symlink in
                                the <filename>.wants/</filename>
969 970
                                or <filename>.requires/</filename>
                                subdirectory for a unit, respectively. This has the
971 972 973
                                effect that when the listed unit name
                                is activated the unit listing it is
                                activated
Lennart Poettering's avatar
Lennart Poettering committed
974
                                too. <command>WantedBy=foo.service</command>
975 976 977 978 979 980 981 982 983 984 985 986 987 988
                                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
989
                                option configured,
990
                                <command>systemctl enable</command>
991 992 993
                                will automatically install units
                                listed in this option as
                                well.</para></listitem>
994 995 996
                        </varlistentry>
                </variablelist>

997 998 999 1000
                <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>
1001 1002
        </refsect1>

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
        <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>
                        <entry>This is either the unescaped instance name (if applicable) with / prepended (if applicable), or the prefix name similarly prepended with /.</entry>
                      </row>
                      <row>
                        <entry><literal>%c</literal></entry>
                        <entry>Control group path of the unit</entry>
                        <entry></entry>
                      </row>
                      <row>
                        <entry><literal>%r</literal></entry>
                        <entry>Root control group path of systemd</entry>
                        <entry></entry>
                      </row>
                      <row>
                        <entry><literal>%R</literal></entry>
                        <entry>Parent directory of the root control group path of systemd</entry>
                        <entry></entry>
                      </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>
                        <entry>This is the shell of the configured user of the unit, or (if none is set) the user running the systemd instance.</entry>
                      </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>
                    </tbody>
                  </tgroup>
                </table>
        </refsect1>

1121
        <refsect1>
Lennart Poettering's avatar
Lennart Poettering committed
1122 1123 1124
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
                        <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>,
1135
                        <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1136
                        <citerefentry><refentrytitle>systemd.snapshot</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1137
                        <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1138 1139
                        <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
Lennart Poettering's avatar
Lennart Poettering committed
1140
                </para>
1141 1142 1143
        </refsect1>

</refentry>