]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.unit.xml
man/systemd.mount: tmpfs automatically gains After=swap.target dep
[thirdparty/systemd.git] / man / systemd.unit.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
5 %entities;
6 ]>
7 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
8
9 <refentry id="systemd.unit"
10 xmlns:xi="http://www.w3.org/2001/XInclude">
11
12 <refentryinfo>
13 <title>systemd.unit</title>
14 <productname>systemd</productname>
15 </refentryinfo>
16
17 <refmeta>
18 <refentrytitle>systemd.unit</refentrytitle>
19 <manvolnum>5</manvolnum>
20 </refmeta>
21
22 <refnamediv>
23 <refname>systemd.unit</refname>
24 <refpurpose>Unit configuration</refpurpose>
25 </refnamediv>
26
27 <refsynopsisdiv>
28 <para><filename><replaceable>service</replaceable>.service</filename>,
29 <filename><replaceable>socket</replaceable>.socket</filename>,
30 <filename><replaceable>device</replaceable>.device</filename>,
31 <filename><replaceable>mount</replaceable>.mount</filename>,
32 <filename><replaceable>automount</replaceable>.automount</filename>,
33 <filename><replaceable>swap</replaceable>.swap</filename>,
34 <filename><replaceable>target</replaceable>.target</filename>,
35 <filename><replaceable>path</replaceable>.path</filename>,
36 <filename><replaceable>timer</replaceable>.timer</filename>,
37 <filename><replaceable>slice</replaceable>.slice</filename>,
38 <filename><replaceable>scope</replaceable>.scope</filename></para>
39
40 <refsect2>
41 <title>System Unit Search Path</title>
42
43 <para><literallayout><filename>/etc/systemd/system.control/*</filename>
44 <filename>/run/systemd/system.control/*</filename>
45 <filename>/run/systemd/transient/*</filename>
46 <filename>/run/systemd/generator.early/*</filename>
47 <filename>/etc/systemd/system/*</filename>
48 <filename>/etc/systemd/system.attached/*</filename>
49 <filename>/run/systemd/system/*</filename>
50 <filename>/run/systemd/system.attached/*</filename>
51 <filename>/run/systemd/generator/*</filename>
52 <filename index='false'></filename>
53 <filename>/usr/lib/systemd/system/*</filename>
54 <filename>/run/systemd/generator.late/*</filename></literallayout></para>
55 </refsect2>
56
57 <refsect2>
58 <title>User Unit Search Path</title>
59 <para><literallayout><filename>~/.config/systemd/user.control/*</filename>
60 <filename>$XDG_RUNTIME_DIR/systemd/user.control/*</filename>
61 <filename>$XDG_RUNTIME_DIR/systemd/transient/*</filename>
62 <filename>$XDG_RUNTIME_DIR/systemd/generator.early/*</filename>
63 <filename>~/.config/systemd/user/*</filename>
64 <filename>$XDG_CONFIG_DIRS/systemd/user/*</filename>
65 <filename>/etc/systemd/user/*</filename>
66 <filename>$XDG_RUNTIME_DIR/systemd/user/*</filename>
67 <filename>/run/systemd/user/*</filename>
68 <filename>$XDG_RUNTIME_DIR/systemd/generator/*</filename>
69 <filename>$XDG_DATA_HOME/systemd/user/*</filename>
70 <filename>$XDG_DATA_DIRS/systemd/user/*</filename>
71 <filename index='false'></filename>
72 <filename>/usr/lib/systemd/user/*</filename>
73 <filename>$XDG_RUNTIME_DIR/systemd/generator.late/*</filename></literallayout></para>
74 </refsect2>
75
76 </refsynopsisdiv>
77
78 <refsect1>
79 <title>Description</title>
80
81 <para>A unit file is a plain text ini-style file that encodes information about a service, a
82 socket, a device, a mount point, an automount point, a swap file or partition, a start-up
83 target, a watched file system path, a timer controlled and supervised by
84 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, a
85 resource management slice or a group of externally created processes. See
86 <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
87 for a general description of the syntax.</para>
88
89 <para>This man page lists the common configuration options of all
90 the unit types. These options need to be configured in the [Unit]
91 or [Install] sections of the unit files.</para>
92
93 <para>In addition to the generic [Unit] and [Install] sections
94 described here, each unit may have a type-specific section, e.g.
95 [Service] for a service unit. See the respective man pages for
96 more information:
97 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
98 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
99 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
100 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
101 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
102 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
103 <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
104 <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
105 <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
106 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
107 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
108 </para>
109
110 <para>Unit files are loaded from a set of paths determined during compilation, described in the next
111 section.</para>
112
113 <para>Valid unit names consist of a "unit name prefix", and a suffix specifying the unit type which
114 begins with a dot. The "unit name prefix" must consist of one or more valid characters (ASCII letters,
115 digits, <literal>:</literal>, <literal>-</literal>, <literal>_</literal>, <literal>.</literal>, and
116 <literal>\</literal>). The total length of the unit name including the suffix must not exceed 255
117 characters. The unit type suffix must be one of <literal>.service</literal>, <literal>.socket</literal>,
118 <literal>.device</literal>, <literal>.mount</literal>, <literal>.automount</literal>,
119 <literal>.swap</literal>, <literal>.target</literal>, <literal>.path</literal>,
120 <literal>.timer</literal>, <literal>.slice</literal>, or <literal>.scope</literal>.</para>
121
122 <para>Unit names can be parameterized by a single argument called the "instance name". The unit is then
123 constructed based on a "template file" which serves as the definition of multiple services or other
124 units. A template unit must have a single <literal>@</literal> at the end of the unit name prefix (right
125 before the type suffix). The name of the full unit is formed by inserting the instance name between
126 <literal>@</literal> and the unit type suffix. In the unit file itself, the instance parameter may be
127 referred to using <literal>%i</literal> and other specifiers, see below.</para>
128
129 <para>Unit files may contain additional options on top of those listed here. If systemd encounters an
130 unknown option, it will write a warning log message but continue loading the unit. If an option or
131 section name is prefixed with <option>X-</option>, it is ignored completely by systemd. Options within an
132 ignored section do not need the prefix. Applications may use this to include additional information in
133 the unit files. To access those options, applications need to parse the unit files on their own.</para>
134
135 <para>Units can be aliased (have an alternative name), by creating a symlink from the new name to the
136 existing name in one of the unit search paths. For example, <filename>systemd-networkd.service</filename>
137 has the alias <filename>dbus-org.freedesktop.network1.service</filename>, created during installation as
138 a symlink, so when <command>systemd</command> is asked through D-Bus to load
139 <filename>dbus-org.freedesktop.network1.service</filename>, it'll load
140 <filename>systemd-networkd.service</filename>. As another example, <filename>default.target</filename>
141 the default system target started at boot — is commonly aliased to either
142 <filename>multi-user.target</filename> or <filename>graphical.target</filename> to select what is started
143 by default. Alias names may be used in commands like <command>disable</command>,
144 <command>start</command>, <command>stop</command>, <command>status</command>, and similar, and in all
145 unit dependency directives, including <varname>Wants=</varname>, <varname>Requires=</varname>,
146 <varname>Before=</varname>, <varname>After=</varname>. Aliases cannot be used with the
147 <command>preset</command> command.</para>
148
149 <para>Aliases obey the following restrictions: a unit of a certain type (<literal>.service</literal>,
150 <literal>.socket</literal>, …) can only be aliased by a name with the same type suffix. A plain unit (not
151 a template or an instance), may only be aliased by a plain name. A template instance may only be aliased
152 by another template instance, and the instance part must be identical. A template may be aliased by
153 another template (in which case the alias applies to all instances of the template). As a special case, a
154 template instance (e.g. <literal>alias@inst.service</literal>) may be a symlink to different template
155 (e.g. <literal>template@inst.service</literal>). In that case, just this specific instance is aliased,
156 while other instances of the template (e.g. <literal>alias@foo.service</literal>,
157 <literal>alias@bar.service</literal>) are not aliased. Those rules preserve the requirement that the
158 instance (if any) is always uniquely defined for a given unit and all its aliases. The target of alias
159 symlink must point to a valid unit file location, i.e. the symlink target name must match the symlink
160 source name as described, and the destination path must be in one of the unit search paths, see UNIT FILE
161 LOAD PATH section below for more details. Note that the target file may not exist, i.e. the symlink may
162 be dangling.</para>
163
164 <para>Unit files may specify aliases through the <varname>Alias=</varname> directive in the [Install]
165 section. When the unit is enabled, symlinks will be created for those names, and removed when the unit is
166 disabled. For example, <filename>reboot.target</filename> specifies
167 <varname>Alias=ctrl-alt-del.target</varname>, so when enabled, the symlink
168 <filename>/etc/systemd/system/ctrl-alt-del.service</filename> pointing to the
169 <filename>reboot.target</filename> file will be created, and when
170 <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Del</keycap></keycombo> is invoked,
171 <command>systemd</command> will look for the <filename>ctrl-alt-del.service</filename> and execute
172 <filename>reboot.service</filename>. <command>systemd</command> does not look at the [Install] section at
173 all during normal operation, so any directives in that section only have an effect through the symlinks
174 created during enablement.</para>
175
176 <para>Along with a unit file <filename>foo.service</filename>, the directory
177 <filename>foo.service.wants/</filename> may exist. All unit files symlinked from such a directory are
178 implicitly added as dependencies of type <varname>Wants=</varname> to the unit. Similar functionality
179 exists for <varname>Requires=</varname> type dependencies as well, the directory suffix is
180 <filename>.requires/</filename> in this case. This functionality is useful to hook units into the
181 start-up of other units, without having to modify their unit files. For details about the semantics of
182 <varname>Wants=</varname> and <varname>Requires=</varname>, see below. The preferred way to create
183 symlinks in the <filename>.wants/</filename> or <filename>.requires/</filename> directories is by
184 specifying the dependency in [Install] section of the target unit, and creating the symlink in the file
185 system with the <command>enable</command> or <command>preset</command> commands of
186 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The
187 target can be a normal unit (either plain or a specific instance of a template unit). In case when the
188 source unit is a template, the target can also be a template, in which case the instance will be
189 "propagated" to the target unit to form a valid unit instance. The target of symlinks in
190 <filename>.wants/</filename> or <filename>.requires/</filename> must thus point to a valid unit file
191 location, i.e. the symlink target name must satisfy the described requirements, and the destination path
192 must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details. Note
193 that the target file may not exist, i.e. the symlink may be dangling.</para>
194
195 <para>Along with a unit file <filename>foo.service</filename>, a "drop-in" directory
196 <filename>foo.service.d/</filename> may exist. All files with the suffix
197 <literal>.conf</literal> from this directory will be merged in the alphanumeric order and parsed
198 after the main unit file itself has been parsed. This is useful to alter or add configuration
199 settings for a unit, without having to modify unit files. Each drop-in file must contain appropriate
200 section headers. For instantiated units, this logic will first look for the instance
201 <literal>.d/</literal> subdirectory (e.g. <literal>foo@bar.service.d/</literal>) and read its
202 <literal>.conf</literal> files, followed by the template <literal>.d/</literal> subdirectory (e.g.
203 <literal>foo@.service.d/</literal>) and the <literal>.conf</literal> files there. Moreover for unit
204 names containing dashes (<literal>-</literal>), the set of directories generated by repeatedly
205 truncating the unit name after all dashes is searched too. Specifically, for a unit name
206 <filename>foo-bar-baz.service</filename> not only the regular drop-in directory
207 <filename>foo-bar-baz.service.d/</filename> is searched but also both <filename>foo-bar-.service.d/</filename> and
208 <filename>foo-.service.d/</filename>. This is useful for defining common drop-ins for a set of related units, whose
209 names begin with a common prefix. This scheme is particularly useful for mount, automount and slice units, whose
210 systematic naming structure is built around dashes as component separators. Note that equally named drop-in files
211 further down the prefix hierarchy override those further up,
212 i.e. <filename>foo-bar-.service.d/10-override.conf</filename> overrides
213 <filename>foo-.service.d/10-override.conf</filename>.</para>
214
215 <para>In cases of unit aliases (described above), dropins for the aliased name and all aliases are
216 loaded. In the example of <filename>default.target</filename> aliasing
217 <filename>graphical.target</filename>, <filename>default.target.d/</filename>,
218 <filename>default.target.wants/</filename>, <filename>default.target.requires/</filename>,
219 <filename>graphical.target.d/</filename>, <filename>graphical.target.wants/</filename>,
220 <filename>graphical.target.requires/</filename> would all be read. For templates, dropins for the
221 template, any template aliases, the template instance, and all alias instances are read. When just a
222 specific template instance is aliased, then the dropins for the target template, the target template
223 instance, and the alias template instance are read.</para>
224
225 <para>In addition to <filename>/etc/systemd/system</filename>, the drop-in <literal>.d/</literal>
226 directories for system services can be placed in <filename>/usr/lib/systemd/system</filename> or
227 <filename>/run/systemd/system</filename> directories. Drop-in files in <filename>/etc/</filename>
228 take precedence over those in <filename>/run/</filename> which in turn take precedence over those
229 in <filename>/usr/lib/</filename>. Drop-in files under any of these directories take precedence
230 over unit files wherever located. Multiple drop-in files with different names are applied in
231 lexicographic order, regardless of which of the directories they reside in.</para>
232
233 <para>Units also support a top-level drop-in with <filename><replaceable>type</replaceable>.d/</filename>,
234 where <replaceable>type</replaceable> may be e.g. <literal>service</literal> or <literal>socket</literal>,
235 that allows altering or adding to the settings of all corresponding unit files on the system.
236 The formatting and precedence of applying drop-in configurations follow what is defined above.
237 Files in <filename><replaceable>type</replaceable>.d/</filename> have lower precedence compared
238 to files in name-specific override directories. The usual rules apply: multiple drop-in files
239 with different names are applied in lexicographic order, regardless of which of the directories
240 they reside in, so a file in <filename><replaceable>type</replaceable>.d/</filename> applies
241 to a unit only if there are no drop-ins or masks with that name in directories with higher
242 precedence. See Examples.</para>
243
244 <para>Note that while systemd offers a flexible dependency system
245 between units it is recommended to use this functionality only
246 sparingly and instead rely on techniques such as bus-based or
247 socket-based activation which make dependencies implicit,
248 resulting in a both simpler and more flexible system.</para>
249
250 <para>As mentioned above, a unit may be instantiated from a template file. This allows creation
251 of multiple units from a single configuration file. If systemd looks for a unit configuration
252 file, it will first search for the literal unit name in the file system. If that yields no
253 success and the unit name contains an <literal>@</literal> character, systemd will look for a
254 unit template that shares the same name but with the instance string (i.e. the part between the
255 <literal>@</literal> character and the suffix) removed. Example: if a service
256 <filename>getty@tty3.service</filename> is requested and no file by that name is found, systemd
257 will look for <filename>getty@.service</filename> and instantiate a service from that
258 configuration file if it is found.</para>
259
260 <para>To refer to the instance string from within the
261 configuration file you may use the special <literal>%i</literal>
262 specifier in many of the configuration options. See below for
263 details.</para>
264
265 <para>If a unit file is empty (i.e. has the file size 0) or is
266 symlinked to <filename>/dev/null</filename>, its configuration
267 will not be loaded and it appears with a load state of
268 <literal>masked</literal>, and cannot be activated. Use this as an
269 effective way to fully disable a unit, making it impossible to
270 start it even manually.</para>
271
272 <para>The unit file format is covered by the
273 <ulink url="https://systemd.io/PORTABILITY_AND_STABILITY/">Interface
274 Portability and Stability Promise</ulink>.</para>
275
276 </refsect1>
277
278 <refsect1>
279 <title>String Escaping for Inclusion in Unit Names</title>
280
281 <para>Sometimes it is useful to convert arbitrary strings into unit names. To facilitate this, a method of string
282 escaping is used, in order to map strings containing arbitrary byte values (except <constant>NUL</constant>) into
283 valid unit names and their restricted character set. A common special case are unit names that reflect paths to
284 objects in the file system hierarchy. Example: a device unit <filename>dev-sda.device</filename> refers to a device
285 with the device node <filename index="false">/dev/sda</filename> in the file system.</para>
286
287 <para>The escaping algorithm operates as follows: given a string, any <literal>/</literal> character is
288 replaced by <literal>-</literal>, and all other characters which are not ASCII alphanumerics,
289 <literal>:</literal>, <literal>_</literal> or <literal>.</literal> are replaced by C-style
290 <literal>\x2d</literal> escapes. In addition, <literal>.</literal> is replaced with such a C-style escape
291 when it would appear as the first character in the escaped string.</para>
292
293 <para>When the input qualifies as absolute file system path, this algorithm is extended slightly: the path to the
294 root directory <literal>/</literal> is encoded as single dash <literal>-</literal>. In addition, any leading,
295 trailing or duplicate <literal>/</literal> characters are removed from the string before transformation. Example:
296 <filename index="false">/foo//bar/baz/</filename> becomes <literal>foo-bar-baz</literal>.</para>
297
298 <para>This escaping is fully reversible, as long as it is known whether the escaped string was a path (the
299 unescaping results are different for paths and non-path strings). The
300 <citerefentry><refentrytitle>systemd-escape</refentrytitle><manvolnum>1</manvolnum></citerefentry> command may be
301 used to apply and reverse escaping on arbitrary strings. Use <command>systemd-escape --path</command> to escape
302 path strings, and <command>systemd-escape</command> without <option>--path</option> otherwise.</para>
303 </refsect1>
304
305 <refsect1>
306 <title>Automatic dependencies</title>
307
308 <refsect2>
309 <title>Implicit Dependencies</title>
310
311 <para>A number of unit dependencies are implicitly established, depending on unit type and
312 unit configuration. These implicit dependencies can make unit configuration file cleaner. For
313 the implicit dependencies in each unit type, please refer to section "Implicit Dependencies"
314 in respective man pages.</para>
315
316 <para>For example, service units with <varname>Type=dbus</varname> automatically acquire
317 dependencies of type <varname>Requires=</varname> and <varname>After=</varname> on
318 <filename>dbus.socket</filename>. See
319 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
320 for details.</para>
321 </refsect2>
322
323 <refsect2>
324 <title>Default Dependencies</title>
325
326 <para>Default dependencies are similar to implicit dependencies, but can be turned on and off
327 by setting <varname>DefaultDependencies=</varname> to <varname>yes</varname> (the default) and
328 <varname>no</varname>, while implicit dependencies are always in effect. See section "Default
329 Dependencies" in respective man pages for the effect of enabling
330 <varname>DefaultDependencies=</varname> in each unit types.</para>
331
332 <para>For example, target units will complement all configured dependencies of type
333 <varname>Wants=</varname> or <varname>Requires=</varname> with dependencies of type
334 <varname>After=</varname>. See
335 <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>
336 for details. Note that this behavior can be opted out by setting
337 <varname>DefaultDependencies=no</varname> in the specified units, or it can be selectively
338 overridden via an explicit <varname>Before=</varname> dependency.</para>
339 </refsect2>
340 </refsect1>
341
342 <refsect1>
343 <title>Unit File Load Path</title>
344
345 <para>Unit files are loaded from a set of paths determined during
346 compilation, described in the two tables below. Unit files found
347 in directories listed earlier override files with the same name in
348 directories lower in the list.</para>
349
350 <para>When the variable <varname>$SYSTEMD_UNIT_PATH</varname> is set,
351 the contents of this variable overrides the unit load path. If
352 <varname>$SYSTEMD_UNIT_PATH</varname> ends with an empty component
353 (<literal>:</literal>), the usual unit load path will be appended
354 to the contents of the variable.</para>
355
356 <table>
357 <title>
358 Load path when running in system mode (<option>--system</option>).
359 </title>
360
361 <tgroup cols='2'>
362 <colspec colname='path' />
363 <colspec colname='expl' />
364 <thead>
365 <row>
366 <entry>Path</entry>
367 <entry>Description</entry>
368 </row>
369 </thead>
370 <tbody>
371 <row>
372 <entry><filename>/etc/systemd/system.control</filename></entry>
373 <entry morerows="1">Persistent and transient configuration created using the dbus API</entry>
374 </row>
375 <row>
376 <entry><filename>/run/systemd/system.control</filename></entry>
377 </row>
378 <row>
379 <entry><filename>/run/systemd/transient</filename></entry>
380 <entry>Dynamic configuration for transient units</entry>
381 </row>
382 <row>
383 <entry><filename>/run/systemd/generator.early</filename></entry>
384 <entry>Generated units with high priority (see <replaceable>early-dir</replaceable> in <citerefentry
385 ><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
386 </row>
387 <row>
388 <entry><filename>/etc/systemd/system</filename></entry>
389 <entry>System units created by the administrator</entry>
390 </row>
391 <row>
392 <entry><filename>/run/systemd/system</filename></entry>
393 <entry>Runtime units</entry>
394 </row>
395 <row>
396 <entry><filename>/run/systemd/generator</filename></entry>
397 <entry>Generated units with medium priority (see <replaceable>normal-dir</replaceable> in <citerefentry
398 ><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
399 </row>
400 <row>
401 <entry><filename>/usr/local/lib/systemd/system</filename></entry>
402 <entry>System units installed by the administrator </entry>
403 </row>
404 <row>
405 <entry><filename>/usr/lib/systemd/system</filename></entry>
406 <entry>System units installed by the distribution package manager</entry>
407 </row>
408 <row>
409 <entry><filename>/run/systemd/generator.late</filename></entry>
410 <entry>Generated units with low priority (see <replaceable>late-dir</replaceable> in <citerefentry
411 ><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
412 </row>
413 </tbody>
414 </tgroup>
415 </table>
416
417 <table>
418 <title>
419 Load path when running in user mode (<option>--user</option>).
420 </title>
421
422 <tgroup cols='2'>
423 <colspec colname='path' />
424 <colspec colname='expl' />
425 <thead>
426 <row>
427 <entry>Path</entry>
428 <entry>Description</entry>
429 </row>
430 </thead>
431 <tbody>
432 <row>
433 <entry><filename>$XDG_CONFIG_HOME/systemd/user.control</filename> or <filename
434 >~/.config/systemd/user.control</filename></entry>
435 <entry morerows="1">Persistent and transient configuration created using the dbus API (<varname>$XDG_CONFIG_HOME</varname> is used if set, <filename>~/.config</filename> otherwise)</entry>
436 </row>
437 <row>
438 <entry><filename>$XDG_RUNTIME_DIR/systemd/user.control</filename></entry>
439 </row>
440 <row>
441 <entry><filename>$XDG_RUNTIME_DIR/systemd/transient</filename></entry>
442 <entry>Dynamic configuration for transient units</entry>
443 </row>
444 <row>
445 <entry><filename>$XDG_RUNTIME_DIR/systemd/generator.early</filename></entry>
446 <entry>Generated units with high priority (see <replaceable>early-dir</replaceable> in <citerefentry
447 ><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
448 </row>
449 <row>
450 <entry><filename>$XDG_CONFIG_HOME/systemd/user</filename> or <filename>$HOME/.config/systemd/user</filename></entry>
451 <entry>User configuration (<varname>$XDG_CONFIG_HOME</varname> is used if set, <filename>~/.config</filename> otherwise)</entry>
452 </row>
453 <row>
454 <entry><filename>$XDG_CONFIG_DIRS/systemd/user</filename> or <filename>/etc/xdg/systemd/user</filename></entry>
455 <entry>Additional configuration directories as specified by the XDG base directory specification (<varname>$XDG_CONFIG_DIRS</varname> is used if set, <filename>/etc/xdg</filename> otherwise)</entry>
456 </row>
457 <row>
458 <entry><filename>/etc/systemd/user</filename></entry>
459 <entry>User units created by the administrator</entry>
460 </row>
461 <row>
462 <entry><filename>$XDG_RUNTIME_DIR/systemd/user</filename></entry>
463 <entry>Runtime units (only used when $XDG_RUNTIME_DIR is set)</entry>
464 </row>
465 <row>
466 <entry><filename>/run/systemd/user</filename></entry>
467 <entry>Runtime units</entry>
468 </row>
469 <row>
470 <entry><filename>$XDG_RUNTIME_DIR/systemd/generator</filename></entry>
471 <entry>Generated units with medium priority (see <replaceable>normal-dir</replaceable> in <citerefentry
472 ><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
473 </row>
474 <row>
475 <entry><filename>$XDG_DATA_HOME/systemd/user</filename> or <filename>$HOME/.local/share/systemd/user</filename></entry>
476 <entry>Units of packages that have been installed in the home directory (<varname>$XDG_DATA_HOME</varname> is used if set, <filename>~/.local/share</filename> otherwise)</entry>
477 </row>
478 <row>
479 <entry><filename>$XDG_DATA_DIRS/systemd/user</filename> or <filename>/usr/local/share/systemd/user</filename> and <filename>/usr/share/systemd/user</filename></entry>
480 <entry>Additional data directories as specified by the XDG base directory specification (<varname>$XDG_DATA_DIRS</varname> is used if set, <filename>/usr/local/share</filename> and <filename>/usr/share</filename> otherwise)</entry>
481 </row>
482 <row>
483 <entry><filename>$dir/systemd/user</filename> for each <varname index="false">$dir</varname> in <varname>$XDG_DATA_DIRS</varname></entry>
484 <entry>Additional locations for installed user units, one for each entry in <varname>$XDG_DATA_DIRS</varname></entry>
485 </row>
486 <row>
487 <entry><filename>/usr/local/lib/systemd/user</filename></entry>
488 <entry>User units installed by the administrator</entry>
489 </row>
490 <row>
491 <entry><filename>/usr/lib/systemd/user</filename></entry>
492 <entry>User units installed by the distribution package manager</entry>
493 </row>
494 <row>
495 <entry><filename>$XDG_RUNTIME_DIR/systemd/generator.late</filename></entry>
496 <entry>Generated units with low priority (see <replaceable>late-dir</replaceable> in <citerefentry
497 ><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
498 </row>
499 </tbody>
500 </tgroup>
501 </table>
502
503 <para>The set of load paths for the user manager instance may be augmented or
504 changed using various environment variables. And environment variables may in
505 turn be set using environment generators, see
506 <citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
507 In particular, <varname>$XDG_DATA_HOME</varname> and
508 <varname>$XDG_DATA_DIRS</varname> may be easily set using
509 <citerefentry><refentrytitle>systemd-environment-d-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
510 Thus, directories listed here are just the defaults. To see the actual list that
511 would be used based on compilation options and current environment use
512 <programlisting>systemd-analyze --user unit-paths</programlisting>
513 </para>
514
515 <para>Moreover, additional units might be loaded into systemd from directories not on the unit load path
516 by creating a symlink pointing to a unit file in the directories. You can use <command>systemctl
517 link</command> for this; see
518 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The file
519 system where the linked unit files are located must be accessible when systemd is started (e.g. anything
520 underneath <filename>/home/</filename> or <filename>/var/</filename> is not allowed, unless those
521 directories are located on the root file system).</para>
522
523 <para>It is important to distinguish "linked unit files" from "unit file aliases": any symlink where the
524 symlink <emphasis>target</emphasis> is within the unit load path becomes an alias: the source name and
525 the target file name must satisfy specific constraints listed above in the discussion of aliases, but the
526 symlink target doesn't have to exist, and in fact the symlink target path is not used, except to check
527 whether the target is within the unit load path. In contrast, a symlink which goes outside of the unit
528 load path signifies a linked unit file. The symlink is followed when loading the file, but the
529 destination name is otherwise unused (and may even not be a valid unit file name). For example, symlinks
530 <filename index='false'>/etc/systemd/system/alias1.service</filename><filename index='false'>service1.service</filename>,
531 <filename index='false'>/etc/systemd/system/alias2.service</filename><filename index='false'>/usr/lib/systemd/service1.service</filename>,
532 <filename index='false'>/etc/systemd/system/alias3.service</filename><filename index='false'>/etc/systemd/system/service1.service</filename>
533 are all valid aliases and <filename index='false'>service1.service</filename> will have
534 four names, even if the unit file is located at
535 <filename index='false'>/run/systemd/system/service1.service</filename>. In contrast,
536 a symlink <filename index='false'>/etc/systemd/system/link1.service</filename><filename index='false'>../link1_service_file</filename>
537 means that <filename index='false'>link1.service</filename> is a "linked unit" and the contents of
538 <filename index='false'>/etc/systemd/link1_service_file</filename> provide its configuration.</para>
539 </refsect1>
540
541 <refsect1>
542 <title>Unit Garbage Collection</title>
543
544 <para>The system and service manager loads a unit's configuration automatically when a unit is referenced for the
545 first time. It will automatically unload the unit configuration and state again when the unit is not needed anymore
546 ("garbage collection"). A unit may be referenced through a number of different mechanisms:</para>
547
548 <orderedlist>
549 <listitem><para>Another loaded unit references it with a dependency such as <varname>After=</varname>,
550 <varname>Wants=</varname>, …</para></listitem>
551
552 <listitem><para>The unit is currently starting, running, reloading or stopping.</para></listitem>
553
554 <listitem><para>The unit is currently in the <constant>failed</constant> state. (But see below.)</para></listitem>
555
556 <listitem><para>A job for the unit is pending.</para></listitem>
557
558 <listitem><para>The unit is pinned by an active IPC client program.</para></listitem>
559
560 <listitem><para>The unit is a special "perpetual" unit that is always active and loaded. Examples for perpetual
561 units are the root mount unit <filename>-.mount</filename> or the scope unit <filename>init.scope</filename> that
562 the service manager itself lives in.</para></listitem>
563
564 <listitem><para>The unit has running processes associated with it.</para></listitem>
565 </orderedlist>
566
567 <para>The garbage collection logic may be altered with the <varname>CollectMode=</varname> option, which allows
568 configuration whether automatic unloading of units that are in <constant>failed</constant> state is permissible,
569 see below.</para>
570
571 <para>Note that when a unit's configuration and state is unloaded, all execution results, such as exit codes, exit
572 signals, resource consumption and other statistics are lost, except for what is stored in the log subsystem.</para>
573
574 <para>Use <command>systemctl daemon-reload</command> or an equivalent command to reload unit configuration while
575 the unit is already loaded. In this case all configuration settings are flushed out and replaced with the new
576 configuration (which however might not be in effect immediately), however all runtime state is
577 saved/restored.</para>
578 </refsect1>
579
580 <refsect1>
581 <title>[Unit] Section Options</title>
582
583 <para>The unit file may include a [Unit] section, which carries
584 generic information about the unit that is not dependent on the
585 type of unit:</para>
586
587 <variablelist class='unit-directives'>
588 <varlistentry>
589 <term><varname>Description=</varname></term>
590 <listitem><para>A short human readable title of the unit. This may be used by
591 <command>systemd</command> (and other UIs) as a user-visible label for the unit, so this string
592 should identify the unit rather than describe it, despite the name. This string also shouldn't just
593 repeat the unit name. <literal>Apache2 Web Server</literal> is a good example. Bad examples are
594 <literal>high-performance light-weight HTTP server</literal> (too generic) or
595 <literal>Apache2</literal> (meaningless for people who do not know Apache, duplicates the unit
596 name). <command>systemd</command> may use this string as a noun in status messages (<literal>Starting
597 <replaceable>description</replaceable>...</literal>, <literal>Started
598 <replaceable>description</replaceable>.</literal>, <literal>Reached target
599 <replaceable>description</replaceable>.</literal>, <literal>Failed to start
600 <replaceable>description</replaceable>.</literal>), so it should be capitalized, and should not be a
601 full sentence, or a phrase with a continuous verb. Bad examples include <literal>exiting the
602 container</literal> or <literal>updating the database once per day.</literal>.</para>
603
604 <xi:include href="version-info.xml" xpointer="v201"/>
605 </listitem>
606 </varlistentry>
607
608 <varlistentry>
609 <term><varname>Documentation=</varname></term>
610 <listitem><para>A space-separated list of URIs referencing
611 documentation for this unit or its configuration. Accepted are
612 only URIs of the types <literal>http://</literal>,
613 <literal>https://</literal>, <literal>file:</literal>,
614 <literal>info:</literal>, <literal>man:</literal>. For more
615 information about the syntax of these URIs, see <citerefentry
616 project='man-pages'><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
617 The URIs should be listed in order of relevance, starting with
618 the most relevant. It is a good idea to first reference
619 documentation that explains what the unit's purpose is,
620 followed by how it is configured, followed by any other
621 related documentation. This option may be specified more than
622 once, in which case the specified list of URIs is merged. If
623 the empty string is assigned to this option, the list is reset
624 and all prior assignments will have no
625 effect.</para>
626
627 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
628 </varlistentry>
629
630 <varlistentry>
631 <term><varname>Wants=</varname></term>
632
633 <listitem><para>Configures (weak) requirement dependencies on other units. This option may be
634 specified more than once or multiple space-separated units may be specified in one option in which
635 case dependencies for all listed names will be created. Dependencies of this type may also be
636 configured outside of the unit configuration file by adding a symlink to a
637 <filename>.wants/</filename> directory accompanying the unit file. For details, see above.</para>
638
639 <para>Units listed in this option will be started if the configuring unit is. However, if the listed
640 units fail to start or cannot be added to the transaction, this has no impact on the validity of the
641 transaction as a whole, and this unit will still be started. This is the recommended way to hook
642 the start-up of one unit to the start-up of another unit.</para>
643
644 <para>Note that requirement dependencies do not influence the order in which services are started or
645 stopped. This has to be configured independently with the <varname>After=</varname> or
646 <varname>Before=</varname> options. If unit <filename>foo.service</filename> pulls in unit
647 <filename>bar.service</filename> as configured with <varname>Wants=</varname> and no ordering is
648 configured with <varname>After=</varname> or <varname>Before=</varname>, then both units will be
649 started simultaneously and without any delay between them if <filename>foo.service</filename> is
650 activated.</para>
651
652 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
653 </varlistentry>
654
655 <varlistentry>
656 <term><varname>Requires=</varname></term>
657
658 <listitem><para>Similar to <varname>Wants=</varname>, but declares a stronger requirement
659 dependency. Dependencies of this type may also be configured by adding a symlink to a
660 <filename>.requires/</filename> directory accompanying the unit file.</para>
661
662 <para>If this unit gets activated, the units listed will be activated as well. If one of
663 the other units fails to activate, and an ordering dependency <varname>After=</varname> on the
664 failing unit is set, this unit will not be started. Besides, with or without specifying
665 <varname>After=</varname>, this unit will be stopped (or restarted) if one of the other units is
666 explicitly stopped (or restarted).</para>
667
668 <para>Often, it is a better choice to use <varname>Wants=</varname> instead of
669 <varname>Requires=</varname> in order to achieve a system that is more robust when dealing with
670 failing services.</para>
671
672 <para>Note that this dependency type does not imply that the other unit always has to be in active state when
673 this unit is running. Specifically: failing condition checks (such as <varname>ConditionPathExists=</varname>,
674 <varname>ConditionPathIsSymbolicLink=</varname>, … — see below) do not cause the start job of a unit with a
675 <varname>Requires=</varname> dependency on it to fail. Also, some unit types may deactivate on their own (for
676 example, a service process may decide to exit cleanly, or a device may be unplugged by the user), which is not
677 propagated to units having a <varname>Requires=</varname> dependency. Use the <varname>BindsTo=</varname>
678 dependency type together with <varname>After=</varname> to ensure that a unit may never be in active state
679 without a specific other unit also in active state (see below).</para>
680
681 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
682 </varlistentry>
683
684 <varlistentry>
685 <term><varname>Requisite=</varname></term>
686
687 <listitem><para>Similar to <varname>Requires=</varname>. However, if the units listed here
688 are not started already, they will not be started and the starting of this unit will fail
689 immediately. <varname>Requisite=</varname> does not imply an ordering dependency, even if
690 both units are started in the same transaction. Hence this setting should usually be
691 combined with <varname>After=</varname>, to ensure this unit is not started before the other
692 unit.</para>
693
694 <para>When <varname>Requisite=b.service</varname> is used on
695 <filename>a.service</filename>, this dependency will show as
696 <varname>RequisiteOf=a.service</varname> in property listing of
697 <filename>b.service</filename>. <varname>RequisiteOf=</varname>
698 dependency cannot be specified directly.</para>
699
700 <xi:include href="version-info.xml" xpointer="v201"/>
701 </listitem>
702 </varlistentry>
703
704 <varlistentry>
705 <term><varname>BindsTo=</varname></term>
706
707 <listitem><para>Configures requirement dependencies, very similar in style to
708 <varname>Requires=</varname>. However, this dependency type is stronger: in addition to the effect of
709 <varname>Requires=</varname> it declares that if the unit bound to is stopped, this unit will be stopped
710 too. This means a unit bound to another unit that suddenly enters inactive state will be stopped too.
711 Units can suddenly, unexpectedly enter inactive state for different reasons: the main process of a service unit
712 might terminate on its own choice, the backing device of a device unit might be unplugged or the mount point of
713 a mount unit might be unmounted without involvement of the system and service manager.</para>
714
715 <para>When used in conjunction with <varname>After=</varname> on the same unit the behaviour of
716 <varname>BindsTo=</varname> is even stronger. In this case, the unit bound to strictly has to be in active
717 state for this unit to also be in active state. This not only means a unit bound to another unit that suddenly
718 enters inactive state, but also one that is bound to another unit that gets skipped due to an unmet condition
719 check (such as <varname>ConditionPathExists=</varname>, <varname>ConditionPathIsSymbolicLink=</varname>, … —
720 see below) will be stopped, should it be running. Hence, in many cases it is best to combine
721 <varname>BindsTo=</varname> with <varname>After=</varname>.</para>
722
723 <para>When <varname>BindsTo=b.service</varname> is used on
724 <filename>a.service</filename>, this dependency will show as
725 <varname>BoundBy=a.service</varname> in property listing of
726 <filename>b.service</filename>. <varname>BoundBy=</varname>
727 dependency cannot be specified directly.</para>
728
729 <xi:include href="version-info.xml" xpointer="v201"/>
730 </listitem>
731 </varlistentry>
732
733 <varlistentry>
734 <term><varname>PartOf=</varname></term>
735
736 <listitem><para>Configures dependencies similar to
737 <varname>Requires=</varname>, but limited to stopping and
738 restarting of units. When systemd stops or restarts the units
739 listed here, the action is propagated to this unit. Note that
740 this is a one-way dependency — changes to this unit do not
741 affect the listed units.</para>
742
743 <para>When <varname>PartOf=b.service</varname> is used on
744 <filename>a.service</filename>, this dependency will show as
745 <varname>ConsistsOf=a.service</varname> in property listing of
746 <filename>b.service</filename>. <varname>ConsistsOf=</varname>
747 dependency cannot be specified directly.</para>
748
749 <xi:include href="version-info.xml" xpointer="v201"/>
750 </listitem>
751 </varlistentry>
752
753 <varlistentry>
754 <term><varname>Upholds=</varname></term>
755
756 <listitem><para>Configures dependencies similar to <varname>Wants=</varname>, but as long as this unit
757 is up, all units listed in <varname>Upholds=</varname> are started whenever found to be inactive or
758 failed, and no job is queued for them. While a <varname>Wants=</varname> dependency on another unit
759 has a one-time effect when this units started, a <varname>Upholds=</varname> dependency on it has a
760 continuous effect, constantly restarting the unit if necessary. This is an alternative to the
761 <varname>Restart=</varname> setting of service units, to ensure they are kept running whatever
762 happens. The restart happens without delay, and usual per-unit rate-limit applies.</para>
763
764 <para>When <varname>Upholds=b.service</varname> is used on <filename>a.service</filename>, this
765 dependency will show as <varname>UpheldBy=a.service</varname> in the property listing of
766 <filename>b.service</filename>.</para>
767
768 <xi:include href="version-info.xml" xpointer="v249"/>
769 </listitem>
770 </varlistentry>
771
772 <varlistentry>
773 <term><varname>Conflicts=</varname></term>
774
775 <listitem><para>A space-separated list of unit names. Configures negative requirement
776 dependencies. If a unit has a <varname>Conflicts=</varname> setting on another unit, starting the
777 former will stop the latter and vice versa.</para>
778
779 <para>Note that this setting does not imply an ordering dependency, similarly to the
780 <varname>Wants=</varname> and <varname>Requires=</varname> dependencies described above. This means
781 that to ensure that the conflicting unit is stopped before the other unit is started, an
782 <varname>After=</varname> or <varname>Before=</varname> dependency must be declared. It doesn't
783 matter which of the two ordering dependencies is used, because stop jobs are always ordered before
784 start jobs, see the discussion in <varname>Before=</varname>/<varname>After=</varname> below.</para>
785
786 <para>If unit A that conflicts with unit B is scheduled to
787 be started at the same time as B, the transaction will either
788 fail (in case both are required parts of the transaction) or be
789 modified to be fixed (in case one or both jobs are not a
790 required part of the transaction). In the latter case, the job
791 that is not required will be removed, or in case both are
792 not required, the unit that conflicts will be started and the
793 unit that is conflicted is stopped.</para>
794
795 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
796 </varlistentry>
797
798 <varlistentry>
799 <term><varname>Before=</varname></term>
800 <term><varname>After=</varname></term>
801
802 <listitem><para>These two settings expect a space-separated list of unit names. They may be specified
803 more than once, in which case dependencies for all listed names are created.</para>
804
805 <para>Those two settings configure ordering dependencies between units. If unit
806 <filename>foo.service</filename> contains the setting <option>Before=bar.service</option> and both
807 units are being started, <filename>bar.service</filename>'s start-up is delayed until
808 <filename>foo.service</filename> has finished starting up. <varname>After=</varname> is the inverse
809 of <varname>Before=</varname>, i.e. while <varname>Before=</varname> ensures that the configured unit
810 is started before the listed unit begins starting up, <varname>After=</varname> ensures the opposite,
811 that the listed unit is fully started up before the configured unit is started.</para>
812
813 <para>When two units with an ordering dependency between them are shut down, the inverse of the
814 start-up order is applied. I.e. if a unit is configured with <varname>After=</varname> on another
815 unit, the former is stopped before the latter if both are shut down. Given two units with any
816 ordering dependency between them, if one unit is shut down and the other is started up, the shutdown
817 is ordered before the start-up. It doesn't matter if the ordering dependency is
818 <varname>After=</varname> or <varname>Before=</varname>, in this case. It also doesn't matter which
819 of the two is shut down, as long as one is shut down and the other is started up; the shutdown is
820 ordered before the start-up in all cases. If two units have no ordering dependencies between them,
821 they are shut down or started up simultaneously, and no ordering takes place. It depends on the unit
822 type when precisely a unit has finished starting up. Most importantly, for service units start-up is
823 considered completed for the purpose of <varname>Before=</varname>/<varname>After=</varname> when all
824 its configured start-up commands have been invoked and they either failed or reported start-up
825 success. Note that this does includes <varname>ExecStartPost=</varname> (or
826 <varname>ExecStopPost=</varname> for the shutdown case).</para>
827
828 <para>Note that those settings are independent of and orthogonal to the requirement dependencies as
829 configured by <varname>Requires=</varname>, <varname>Wants=</varname>, <varname>Requisite=</varname>,
830 or <varname>BindsTo=</varname>. It is a common pattern to include a unit name in both the
831 <varname>After=</varname> and <varname>Wants=</varname> options, in which case the unit listed will
832 be started before the unit that is configured with these options.</para>
833
834 <para>Note that <varname>Before=</varname> dependencies on device units have no effect and are not
835 supported. Devices generally become available as a result of an external hotplug event, and systemd
836 creates the corresponding device unit without delay.</para>
837
838 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
839 </varlistentry>
840
841 <varlistentry>
842 <term><varname>OnFailure=</varname></term>
843
844 <listitem><para>A space-separated list of one or more units that are activated when this unit enters
845 the <literal>failed</literal> state.</para>
846
847 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
848 </varlistentry>
849
850 <varlistentry>
851 <term><varname>OnSuccess=</varname></term>
852
853 <listitem><para>A space-separated list of one or more units that are activated when this unit enters
854 the <literal>inactive</literal> state.</para>
855
856 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
857 </varlistentry>
858
859 <varlistentry>
860 <term><varname>PropagatesReloadTo=</varname></term>
861 <term><varname>ReloadPropagatedFrom=</varname></term>
862
863 <listitem><para>A space-separated list of one or more units to which reload requests from this unit
864 shall be propagated to, or units from which reload requests shall be propagated to this unit,
865 respectively. Issuing a reload request on a unit will automatically also enqueue reload requests on
866 all units that are linked to it using these two settings.</para>
867
868 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
869 </varlistentry>
870
871 <varlistentry>
872 <term><varname>PropagatesStopTo=</varname></term>
873 <term><varname>StopPropagatedFrom=</varname></term>
874
875 <listitem><para>A space-separated list of one or more units to which stop requests from this unit
876 shall be propagated to, or units from which stop requests shall be propagated to this unit,
877 respectively. Issuing a stop request on a unit will automatically also enqueue stop requests on all
878 units that are linked to it using these two settings.</para>
879
880 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
881 </varlistentry>
882
883 <varlistentry>
884 <term><varname>JoinsNamespaceOf=</varname></term>
885
886 <listitem><para>For units that start processes (such as service units), lists one or more other units
887 whose network and/or temporary file namespace to join. If this is specified on a unit (say,
888 <filename>a.service</filename> has <varname>JoinsNamespaceOf=b.service</varname>), then the inverse
889 dependency (<varname>JoinsNamespaceOf=a.service</varname> for b.service) is implied. This only
890 applies to unit types which support the <varname>PrivateNetwork=</varname>,
891 <varname>NetworkNamespacePath=</varname>, <varname>PrivateIPC=</varname>,
892 <varname>IPCNamespacePath=</varname>, and <varname>PrivateTmp=</varname> directives (see
893 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
894 details). If a unit that has this setting set is started, its processes will see the same
895 <filename>/tmp/</filename>, <filename>/var/tmp/</filename>, IPC namespace and network namespace as
896 one listed unit that is started. If multiple listed units are already started and these do not share
897 their namespace, then it is not defined which namespace is joined. Note that this setting only has an
898 effect if <varname>PrivateNetwork=</varname>/<varname>NetworkNamespacePath=</varname>,
899 <varname>PrivateIPC=</varname>/<varname>IPCNamespacePath=</varname> and/or
900 <varname>PrivateTmp=</varname> is enabled for both the unit that joins the namespace and the unit
901 whose namespace is joined.</para>
902
903 <xi:include href="version-info.xml" xpointer="v209"/></listitem>
904 </varlistentry>
905
906 <varlistentry>
907 <term><varname>RequiresMountsFor=</varname></term>
908
909 <listitem><para>Takes a space-separated list of absolute
910 paths. Automatically adds dependencies of type
911 <varname>Requires=</varname> and <varname>After=</varname> for
912 all mount units required to access the specified path.</para>
913
914 <para>Mount points marked with <option>noauto</option> are not
915 mounted automatically through <filename>local-fs.target</filename>,
916 but are still honored for the purposes of this option, i.e. they
917 will be pulled in by this unit.</para>
918
919 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
920 </varlistentry>
921
922 <varlistentry>
923 <term><varname>WantsMountsFor=</varname></term>
924
925 <listitem><para>Same as <varname>RequiresMountsFor=</varname>,
926 but adds dependencies of type <varname>Wants=</varname> instead
927 of <varname>Requires=</varname>.</para>
928
929 <xi:include href="version-info.xml" xpointer="v256"/></listitem>
930 </varlistentry>
931
932 <varlistentry>
933 <term><varname>OnSuccessJobMode=</varname></term>
934 <term><varname>OnFailureJobMode=</varname></term>
935
936 <listitem><para>Takes a value of
937 <literal>fail</literal>,
938 <literal>replace</literal>,
939 <literal>replace-irreversibly</literal>,
940 <literal>isolate</literal>,
941 <literal>flush</literal>,
942 <literal>ignore-dependencies</literal> or
943 <literal>ignore-requirements</literal>. Defaults to
944 <literal>replace</literal>. Specifies how the units listed in
945 <varname>OnSuccess=</varname>/<varname>OnFailure=</varname> will be enqueued. See
946 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
947 <option>--job-mode=</option> option for details on the
948 possible values. If this is set to <literal>isolate</literal>,
949 only a single unit may be listed in
950 <varname>OnSuccess=</varname>/<varname>OnFailure=</varname>.</para>
951
952 <xi:include href="version-info.xml" xpointer="v209"/></listitem>
953 </varlistentry>
954
955 <varlistentry>
956 <term><varname>IgnoreOnIsolate=</varname></term>
957
958 <listitem><para>Takes a boolean argument. If <option>true</option>, this unit will not be stopped
959 when isolating another unit. Defaults to <option>false</option> for service, target, socket, timer,
960 and path units, and <option>true</option> for slice, scope, device, swap, mount, and automount
961 units.</para>
962
963 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
964 </varlistentry>
965
966 <varlistentry>
967 <term><varname>StopWhenUnneeded=</varname></term>
968
969 <listitem><para>Takes a boolean argument. If
970 <option>true</option>, this unit will be stopped when it is no
971 longer used. Note that, in order to minimize the work to be
972 executed, systemd will not stop units by default unless they
973 are conflicting with other units, or the user explicitly
974 requested their shut down. If this option is set, a unit will
975 be automatically cleaned up if no other active unit requires
976 it. Defaults to <option>false</option>.</para>
977
978 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
979 </varlistentry>
980
981 <varlistentry>
982 <term><varname>RefuseManualStart=</varname></term>
983 <term><varname>RefuseManualStop=</varname></term>
984
985 <listitem><para>Takes a boolean argument. If
986 <option>true</option>, this unit can only be activated or
987 deactivated indirectly. In this case, explicit start-up or
988 termination requested by the user is denied, however if it is
989 started or stopped as a dependency of another unit, start-up
990 or termination will succeed. This is mostly a safety feature
991 to ensure that the user does not accidentally activate units
992 that are not intended to be activated explicitly, and not
993 accidentally deactivate units that are not intended to be
994 deactivated. These options default to
995 <option>false</option>.</para>
996
997 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
998 </varlistentry>
999
1000 <varlistentry>
1001 <term><varname>AllowIsolate=</varname></term>
1002
1003 <listitem><para>Takes a boolean argument. If
1004 <option>true</option>, this unit may be used with the
1005 <command>systemctl isolate</command> command. Otherwise, this
1006 will be refused. It probably is a good idea to leave this
1007 disabled except for target units that shall be used similar to
1008 runlevels in SysV init systems, just as a precaution to avoid
1009 unusable system states. This option defaults to
1010 <option>false</option>.</para>
1011
1012 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
1013 </varlistentry>
1014
1015 <varlistentry>
1016 <term><varname>DefaultDependencies=</varname></term>
1017
1018 <listitem><para>Takes a boolean argument. If
1019 <option>yes</option>, (the default), a few default
1020 dependencies will implicitly be created for the unit. The
1021 actual dependencies created depend on the unit type. For
1022 example, for service units, these dependencies ensure that the
1023 service is started only after basic system initialization is
1024 completed and is properly terminated on system shutdown. See
1025 the respective man pages for details. Generally, only services
1026 involved with early boot or late shutdown should set this
1027 option to <option>no</option>. It is highly recommended to
1028 leave this option enabled for the majority of common units. If
1029 set to <option>no</option>, this option does not disable
1030 all implicit dependencies, just non-essential
1031 ones.</para>
1032
1033 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
1034 </varlistentry>
1035
1036 <varlistentry>
1037 <term><varname>SurviveFinalKillSignal=</varname></term>
1038
1039 <listitem><para>Takes a boolean argument. Defaults to <option>no</option>. If <option>yes</option>,
1040 processes belonging to this unit will not be sent the final <literal>SIGTERM</literal> and
1041 <literal>SIGKILL</literal> signals during the final phase of the system shutdown process.
1042 This functionality replaces the older mechanism that allowed a program to set
1043 <literal>argv[0][0] = '@'</literal> as described at
1044 <ulink url="https://systemd.io/ROOT_STORAGE_DAEMONS">systemd and Storage Daemons for the Root File
1045 System</ulink>, which however continues to be supported.</para>
1046
1047 <xi:include href="version-info.xml" xpointer="v255"/></listitem>
1048 </varlistentry>
1049
1050 <varlistentry>
1051 <term><varname>CollectMode=</varname></term>
1052
1053 <listitem><para>Tweaks the "garbage collection" algorithm for this unit. Takes one of <option>inactive</option>
1054 or <option>inactive-or-failed</option>. If set to <option>inactive</option> the unit will be unloaded if it is
1055 in the <constant>inactive</constant> state and is not referenced by clients, jobs or other units — however it
1056 is not unloaded if it is in the <constant>failed</constant> state. In <option>failed</option> mode, failed
1057 units are not unloaded until the user invoked <command>systemctl reset-failed</command> on them to reset the
1058 <constant>failed</constant> state, or an equivalent command. This behaviour is altered if this option is set to
1059 <option>inactive-or-failed</option>: in this case the unit is unloaded even if the unit is in a
1060 <constant>failed</constant> state, and thus an explicitly resetting of the <constant>failed</constant> state is
1061 not necessary. Note that if this mode is used unit results (such as exit codes, exit signals, consumed
1062 resources, …) are flushed out immediately after the unit completed, except for what is stored in the logging
1063 subsystem. Defaults to <option>inactive</option>.</para>
1064
1065 <xi:include href="version-info.xml" xpointer="v236"/>
1066 </listitem>
1067 </varlistentry>
1068
1069 <varlistentry>
1070 <term><varname>FailureAction=</varname></term>
1071 <term><varname>SuccessAction=</varname></term>
1072
1073 <listitem><para>Configure the action to take when the unit stops and enters a failed state or
1074 inactive state. Takes one of <option>none</option>, <option>reboot</option>,
1075 <option>reboot-force</option>, <option>reboot-immediate</option>, <option>poweroff</option>,
1076 <option>poweroff-force</option>, <option>poweroff-immediate</option>, <option>exit</option>,
1077 <option>exit-force</option>, <option>soft-reboot</option>, <option>soft-reboot-force</option>,
1078 <option>kexec</option>, <option>kexec-force</option>, <option>halt</option>,
1079 <option>halt-force</option> and <option>halt-immediate</option>. In system mode, all options are
1080 allowed. In user mode, only <option>none</option>, <option>exit</option>,
1081 <option>exit-force</option>, <option>soft-reboot</option> and <option>soft-reboot-force</option> are
1082 allowed. Both options default to <option>none</option>.</para>
1083
1084 <para>If <option>none</option> is set, no action will be triggered. <option>reboot</option> causes a
1085 reboot following the normal shutdown procedure (i.e. equivalent to <command>systemctl
1086 reboot</command>). <option>reboot-force</option> causes a forced reboot which will terminate all
1087 processes forcibly but should cause no dirty file systems on reboot (i.e. equivalent to
1088 <command>systemctl reboot -f</command>) and <option>reboot-immediate</option> causes immediate
1089 execution of the
1090 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
1091 call, which might result in data loss (i.e. equivalent to <command>systemctl reboot -ff</command>).
1092 Similarly, <option>poweroff</option>, <option>poweroff-force</option>,
1093 <option>poweroff-immediate</option>, <option>kexec</option>, <option>kexec-force</option>,
1094 <option>halt</option>, <option>halt-force</option> and <option>halt-immediate</option> have the
1095 effect of powering down the system, executing kexec, and halting the system respectively with similar
1096 semantics. <option>exit</option> causes the manager to exit following the normal shutdown procedure,
1097 and <option>exit-force</option> causes it terminate without shutting down services. When
1098 <option>exit</option> or <option>exit-force</option> is used by default the exit status of the main
1099 process of the unit (if this applies) is returned from the service manager. However, this may be
1100 overridden with
1101 <varname>FailureActionExitStatus=</varname>/<varname>SuccessActionExitStatus=</varname>, see below.
1102 <option>soft-reboot</option> will trigger a userspace reboot operation.
1103 <option>soft-reboot-force</option> does that too, but does not go through the shutdown transaction
1104 beforehand.</para>
1105
1106 <xi:include href="version-info.xml" xpointer="v236"/></listitem>
1107 </varlistentry>
1108
1109 <varlistentry>
1110 <term><varname>FailureActionExitStatus=</varname></term>
1111 <term><varname>SuccessActionExitStatus=</varname></term>
1112
1113 <listitem><para>Controls the exit status to propagate back to an invoking container manager (in case of a
1114 system service) or service manager (in case of a user manager) when the
1115 <varname>FailureAction=</varname>/<varname>SuccessAction=</varname> are set to <option>exit</option> or
1116 <option>exit-force</option> and the action is triggered. By default the exit status of the main process of the
1117 triggering unit (if this applies) is propagated. Takes a value in the range 0255 or the empty string to
1118 request default behaviour.</para>
1119
1120 <xi:include href="version-info.xml" xpointer="v240"/></listitem>
1121 </varlistentry>
1122
1123 <varlistentry>
1124 <term><varname>JobTimeoutSec=</varname></term>
1125 <term><varname>JobRunningTimeoutSec=</varname></term>
1126
1127 <listitem><para><varname>JobTimeoutSec=</varname> specifies a timeout for the whole job that starts
1128 running when the job is queued. <varname>JobRunningTimeoutSec=</varname> specifies a timeout that
1129 starts running when the queued job is actually started. If either limit is reached, the job will be
1130 cancelled, the unit however will not change state or even enter the <literal>failed</literal> mode.
1131 </para>
1132
1133 <para>Both settings take a time span with the default unit of seconds, but other units may be
1134 specified, see
1135 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1136 The default is <literal>infinity</literal> (job timeouts disabled), except for device units where
1137 <varname>JobRunningTimeoutSec=</varname> defaults to <varname>DefaultDeviceTimeoutSec=</varname>.
1138 </para>
1139
1140 <para>Note: these timeouts are independent from any unit-specific timeouts (for example, the timeout
1141 set with <varname>TimeoutStartSec=</varname> in service units). The job timeout has no effect on the
1142 unit itself. Or in other words: unit-specific timeouts are useful to abort unit state changes, and
1143 revert them. The job timeout set with this option however is useful to abort only the job waiting for
1144 the unit state to change.</para>
1145
1146 <xi:include href="version-info.xml" xpointer="v201"/>
1147 </listitem>
1148 </varlistentry>
1149
1150 <varlistentry>
1151 <term><varname>JobTimeoutAction=</varname></term>
1152 <term><varname>JobTimeoutRebootArgument=</varname></term>
1153
1154 <listitem><para><varname>JobTimeoutAction=</varname> optionally configures an additional action to
1155 take when the timeout is hit, see description of <varname>JobTimeoutSec=</varname> and
1156 <varname>JobRunningTimeoutSec=</varname> above. It takes the same values as
1157 <varname>StartLimitAction=</varname>. Defaults to <option>none</option>.</para>
1158
1159 <para><varname>JobTimeoutRebootArgument=</varname> configures an optional reboot string to pass to
1160 the <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
1161 call.</para>
1162
1163 <xi:include href="version-info.xml" xpointer="v240"/></listitem>
1164 </varlistentry>
1165
1166 <varlistentry>
1167 <term><varname>StartLimitIntervalSec=<replaceable>interval</replaceable></varname></term>
1168 <term><varname>StartLimitBurst=<replaceable>burst</replaceable></varname></term>
1169
1170 <listitem><para>Configure unit start rate limiting. Units which are started more than
1171 <replaceable>burst</replaceable> times within an <replaceable>interval</replaceable> time span are
1172 not permitted to start any more. Use <varname>StartLimitIntervalSec=</varname> to configure the
1173 checking interval and <varname>StartLimitBurst=</varname> to configure how many starts per interval
1174 are allowed.</para>
1175
1176 <para><replaceable>interval</replaceable> is a time span with the default unit of seconds, but other
1177 units may be specified, see
1178 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1179 The special value <literal>infinity</literal> can be used to limit the total number of start
1180 attempts, even if they happen at large time intervals.
1181 Defaults to <varname>DefaultStartLimitIntervalSec=</varname> in manager configuration file, and may
1182 be set to 0 to disable any kind of rate limiting. <replaceable>burst</replaceable> is a number and
1183 defaults to <varname>DefaultStartLimitBurst=</varname> in manager configuration file.</para>
1184
1185 <para>These configuration options are particularly useful in conjunction with the service setting
1186 <varname>Restart=</varname> (see
1187 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>);
1188 however, they apply to all kinds of starts (including manual), not just those triggered by the
1189 <varname>Restart=</varname> logic.</para>
1190
1191 <para>Note that units which are configured for <varname>Restart=</varname>, and which reach the start
1192 limit are not attempted to be restarted anymore; however, they may still be restarted manually or
1193 from a timer or socket at a later point, after the <replaceable>interval</replaceable> has passed.
1194 From that point on, the restart logic is activated again. <command>systemctl reset-failed</command>
1195 will cause the restart rate counter for a service to be flushed, which is useful if the administrator
1196 wants to manually start a unit and the start limit interferes with that. Rate-limiting is enforced
1197 after any unit condition checks are executed, and hence unit activations with failing conditions do
1198 not count towards the rate limit.</para>
1199
1200 <para>When a unit is unloaded due to the garbage collection logic (see above) its rate limit counters
1201 are flushed out too. This means that configuring start rate limiting for a unit that is not
1202 referenced continuously has no effect.</para>
1203
1204 <para>This setting does not apply to slice, target, device, and scope units, since they are unit
1205 types whose activation may either never fail, or may succeed only a single time.</para>
1206
1207 <xi:include href="version-info.xml" xpointer="v229"/></listitem>
1208 </varlistentry>
1209
1210 <varlistentry>
1211 <term><varname>StartLimitAction=</varname></term>
1212
1213 <listitem><para>Configure an additional action to take if the rate limit configured with
1214 <varname>StartLimitIntervalSec=</varname> and <varname>StartLimitBurst=</varname> is hit. Takes the same
1215 values as the <varname>FailureAction=</varname>/<varname>SuccessAction=</varname> settings. If
1216 <option>none</option> is set, hitting the rate limit will trigger no action except that
1217 the start will not be permitted. Defaults to <option>none</option>.</para>
1218
1219 <xi:include href="version-info.xml" xpointer="v229"/></listitem>
1220 </varlistentry>
1221
1222 <varlistentry>
1223 <term><varname>RebootArgument=</varname></term>
1224 <listitem><para>Configure the optional argument for the
1225 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call if
1226 <varname>StartLimitAction=</varname> or <varname>FailureAction=</varname> is a reboot action. This
1227 works just like the optional argument to <command>systemctl reboot</command> command.</para>
1228
1229 <xi:include href="version-info.xml" xpointer="v229"/></listitem>
1230 </varlistentry>
1231
1232 <varlistentry>
1233 <term><varname>SourcePath=</varname></term>
1234 <listitem><para>A path to a configuration file this unit has
1235 been generated from. This is primarily useful for
1236 implementation of generator tools that convert configuration
1237 from an external configuration file format into native unit
1238 files. This functionality should not be used in normal
1239 units.</para>
1240
1241 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
1242 </varlistentry>
1243 </variablelist>
1244
1245 <refsect2>
1246 <title>Conditions and Asserts</title>
1247
1248 <para>Unit files may also include a number of <varname index="false">Condition…=</varname> and <varname
1249 index="false">Assert…=</varname> settings. Before the unit is started, systemd will verify that the
1250 specified conditions and asserts are true. If not, the starting of the unit will be (mostly silently)
1251 skipped (in case of conditions), or aborted with an error message (in case of asserts). Failing
1252 conditions or asserts will not result in the unit being moved into the <literal>failed</literal>
1253 state. The conditions and asserts are checked at the time the queued start job is to be executed. The
1254 ordering dependencies are still respected, so other units are still pulled in and ordered as if this
1255 unit was successfully activated, and the conditions and asserts are executed the precise moment the
1256 unit would normally start and thus can validate system state after the units ordered before completed
1257 initialization. Use condition expressions for skipping units that do not apply to the local system, for
1258 example because the kernel or runtime environment doesn't require their functionality.
1259 </para>
1260
1261 <para>If multiple conditions are specified, the unit will be executed if all of them apply (i.e. a
1262 logical AND is applied). Condition checks can use a pipe symbol (<literal>|</literal>) after the equals
1263 sign (<literal>Condition…=|…</literal>), which causes the condition to become a
1264 <emphasis>triggering</emphasis> condition. If at least one triggering condition is defined for a unit,
1265 then the unit will be started if at least one of the triggering conditions of the unit applies and all
1266 of the regular (i.e. non-triggering) conditions apply. If you prefix an argument with the pipe symbol
1267 and an exclamation mark, the pipe symbol must be passed first, the exclamation second. If any of these
1268 options is assigned the empty string, the list of conditions is reset completely, all previous
1269 condition settings (of any kind) will have no effect.</para>
1270
1271 <para>The <varname>AssertArchitecture=</varname>, <varname>AssertVirtualization=</varname>, … options
1272 are similar to conditions but cause the start job to fail (instead of being skipped). The failed check
1273 is logged. Units with unmet conditions are considered to be in a clean state and will be garbage
1274 collected if they are not referenced. This means that when queried, the condition failure may or may
1275 not show up in the state of the unit.</para>
1276
1277 <para>Note that neither assertion nor condition expressions result in unit state changes. Also note
1278 that both are checked at the time the job is to be executed, i.e. long after depending jobs and it
1279 itself were queued. Thus, neither condition nor assertion expressions are suitable for conditionalizing
1280 unit dependencies.</para>
1281
1282 <para>The <command>condition</command> verb of
1283 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry> can
1284 be used to test condition and assert expressions.</para>
1285
1286 <para>Except for <varname>ConditionPathIsSymbolicLink=</varname>, all path checks follow symlinks.</para>
1287
1288 <variablelist class='unit-directives'>
1289 <varlistentry>
1290 <term><varname>ConditionArchitecture=</varname></term>
1291
1292 <listitem><para>Check whether the system is running on a specific architecture. Takes one of
1293 <literal>x86</literal>,
1294 <literal>x86-64</literal>,
1295 <literal>ppc</literal>,
1296 <literal>ppc-le</literal>,
1297 <literal>ppc64</literal>,
1298 <literal>ppc64-le</literal>,
1299 <literal>ia64</literal>,
1300 <literal>parisc</literal>,
1301 <literal>parisc64</literal>,
1302 <literal>s390</literal>,
1303 <literal>s390x</literal>,
1304 <literal>sparc</literal>,
1305 <literal>sparc64</literal>,
1306 <literal>mips</literal>,
1307 <literal>mips-le</literal>,
1308 <literal>mips64</literal>,
1309 <literal>mips64-le</literal>,
1310 <literal>alpha</literal>,
1311 <literal>arm</literal>,
1312 <literal>arm-be</literal>,
1313 <literal>arm64</literal>,
1314 <literal>arm64-be</literal>,
1315 <literal>sh</literal>,
1316 <literal>sh64</literal>,
1317 <literal>m68k</literal>,
1318 <literal>tilegx</literal>,
1319 <literal>cris</literal>,
1320 <literal>arc</literal>,
1321 <literal>arc-be</literal>, or
1322 <literal>native</literal>.</para>
1323
1324 <para>Use
1325 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1326 for the complete list of known architectures.</para>
1327
1328 <para>The architecture is determined from the information returned by
1329 <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1330 and is thus subject to
1331 <citerefentry><refentrytitle>personality</refentrytitle><manvolnum>2</manvolnum></citerefentry>.
1332 Note that a <varname>Personality=</varname> setting in the same unit file has no effect on this
1333 condition. A special architecture name <literal>native</literal> is mapped to the architecture the
1334 system manager itself is compiled for. The test may be negated by prepending an exclamation
1335 mark.</para>
1336
1337 <xi:include href="version-info.xml" xpointer="v201"/>
1338 </listitem>
1339 </varlistentry>
1340
1341 <varlistentry>
1342 <term><varname>ConditionFirmware=</varname></term>
1343
1344 <listitem><para>Check whether the system's firmware is of a certain type. The following values are
1345 possible:</para>
1346
1347 <itemizedlist>
1348 <listitem><para><literal>uefi</literal> matches systems with EFI.</para></listitem>
1349
1350 <listitem><para><literal>device-tree</literal> matches systems with a device tree.
1351 </para></listitem>
1352
1353 <listitem><para><literal>device-tree-compatible(<replaceable>value</replaceable>)</literal>
1354 matches systems with a device tree that are compatible with <literal>value</literal>.
1355 </para></listitem>
1356
1357 <listitem><para><literal>smbios-field(<replaceable>field</replaceable>
1358 <replaceable>operator</replaceable> <replaceable>value</replaceable>)</literal> matches systems
1359 with a SMBIOS field containing a certain value. <replaceable>field</replaceable> is the name of
1360 the SMBIOS field exposed as <literal>sysfs</literal> attribute file below
1361 <filename>/sys/class/dmi/id/</filename>. <replaceable>operator</replaceable> is one of
1362 <literal>&lt;</literal>, <literal>&lt;=</literal>, <literal>&gt;=</literal>,
1363 <literal>&gt;</literal>, <literal>==</literal>, <literal>&lt;&gt;</literal> for version
1364 comparisons, <literal>=</literal> and <literal>!=</literal> for literal string comparisons, or
1365 <literal>$=</literal>, <literal>!$=</literal> for shell-style glob comparisons.
1366 <replaceable>value</replaceable> is the expected value of the SMBIOS field value (possibly
1367 containing shell style globs in case <literal>$=</literal>/<literal>!$=</literal> is used).
1368 </para></listitem>
1369 </itemizedlist>
1370
1371 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
1372 </varlistentry>
1373
1374 <varlistentry>
1375 <term><varname>ConditionVirtualization=</varname></term>
1376
1377 <listitem><para>Check whether the system is executed in a virtualized environment and optionally
1378 test whether it is a specific implementation. Takes either boolean value to check if being executed
1379 in any virtualized environment, or one of
1380 <literal>vm</literal> and
1381 <literal>container</literal> to test against a generic type of virtualization solution, or one of
1382 <literal>qemu</literal>,
1383 <literal>kvm</literal>,
1384 <literal>amazon</literal>,
1385 <literal>zvm</literal>,
1386 <literal>vmware</literal>,
1387 <literal>microsoft</literal>,
1388 <literal>oracle</literal>,
1389 <literal>powervm</literal>,
1390 <literal>xen</literal>,
1391 <literal>bochs</literal>,
1392 <literal>uml</literal>,
1393 <literal>bhyve</literal>,
1394 <literal>qnx</literal>,
1395 <literal>apple</literal>,
1396 <literal>sre</literal>,
1397 <literal>openvz</literal>,
1398 <literal>lxc</literal>,
1399 <literal>lxc-libvirt</literal>,
1400 <literal>systemd-nspawn</literal>,
1401 <literal>docker</literal>,
1402 <literal>podman</literal>,
1403 <literal>rkt</literal>,
1404 <literal>wsl</literal>,
1405 <literal>proot</literal>,
1406 <literal>pouch</literal>,
1407 <literal>acrn</literal> to test
1408 against a specific implementation, or
1409 <literal>private-users</literal> to check whether we are running in a user namespace. See
1410 <citerefentry><refentrytitle>systemd-detect-virt</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1411 for a full list of known virtualization technologies and their identifiers. If multiple
1412 virtualization technologies are nested, only the innermost is considered. The test may be negated
1413 by prepending an exclamation mark.</para>
1414
1415 <xi:include href="version-info.xml" xpointer="v244"/>
1416 </listitem>
1417 </varlistentry>
1418
1419 <varlistentry>
1420 <term><varname>ConditionHost=</varname></term>
1421
1422 <listitem><para><varname>ConditionHost=</varname> may be used to match against the hostname or
1423 machine ID of the host. This either takes a hostname string (optionally with shell style globs)
1424 which is tested against the locally set hostname as returned by
1425 <citerefentry><refentrytitle>gethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>, or
1426 a machine ID formatted as string (see
1427 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
1428 The test may be negated by prepending an exclamation mark.</para>
1429
1430 <xi:include href="version-info.xml" xpointer="v244"/>
1431 </listitem>
1432 </varlistentry>
1433
1434 <varlistentry>
1435 <term><varname>ConditionKernelCommandLine=</varname></term>
1436
1437 <listitem><para><varname>ConditionKernelCommandLine=</varname> may be used to check whether a
1438 specific kernel command line option is set (or if prefixed with the exclamation mark — unset). The
1439 argument must either be a single word, or an assignment (i.e. two words, separated by
1440 <literal>=</literal>). In the former case the kernel command line is searched for the word
1441 appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is
1442 looked for with right and left hand side matching. This operates on the kernel command line
1443 communicated to userspace via <filename>/proc/cmdline</filename>, except when the service manager
1444 is invoked as payload of a container manager, in which case the command line of <filename>PID
1445 1</filename> is used instead (i.e. <filename>/proc/1/cmdline</filename>).</para>
1446
1447 <xi:include href="version-info.xml" xpointer="v244"/>
1448 </listitem>
1449 </varlistentry>
1450
1451 <varlistentry>
1452 <term><varname>ConditionKernelVersion=</varname></term>
1453
1454 <listitem><para><varname>ConditionKernelVersion=</varname> may be used to check whether the kernel
1455 version (as reported by <command>uname -r</command>) matches a certain expression, or if prefixed
1456 with the exclamation mark, does not match. The argument must be a list of (potentially quoted)
1457 expressions. Each expression starts with one of <literal>=</literal> or <literal>!=</literal> for
1458 string comparisons, <literal>&lt;</literal>, <literal>&lt;=</literal>, <literal>==</literal>,
1459 <literal>&lt;&gt;</literal>, <literal>&gt;=</literal>, <literal>&gt;</literal> for version
1460 comparisons, or <literal>$=</literal>, <literal>!$=</literal> for a shell-style glob match. If no
1461 operator is specified, <literal>$=</literal> is implied.</para>
1462
1463 <para>Note that using the kernel version string is an unreliable way to determine which features
1464 are supported by a kernel, because of the widespread practice of backporting drivers, features, and
1465 fixes from newer upstream kernels into older versions provided by distributions. Hence, this check
1466 is inherently unportable and should not be used for units which may be used on different
1467 distributions.</para>
1468
1469 <xi:include href="version-info.xml" xpointer="v244"/>
1470 </listitem>
1471 </varlistentry>
1472
1473 <varlistentry>
1474 <term><varname>ConditionCredential=</varname></term>
1475
1476 <listitem><para><varname>ConditionCredential=</varname> may be used to check whether a credential
1477 by the specified name was passed into the service manager. See <ulink
1478 url="https://systemd.io/CREDENTIALS">System and Service Credentials</ulink> for details about
1479 credentials. If used in services for the system service manager this may be used to conditionalize
1480 services based on system credentials passed in. If used in services for the per-user service
1481 manager this may be used to conditionalize services based on credentials passed into the
1482 <filename>unit@.service</filename> service instance belonging to the user. The argument must be a
1483 valid credential name.</para>
1484
1485 <xi:include href="version-info.xml" xpointer="v252"/></listitem>
1486 </varlistentry>
1487
1488 <varlistentry>
1489 <term><varname>ConditionEnvironment=</varname></term>
1490
1491 <listitem><para><varname>ConditionEnvironment=</varname> may be used to check whether a specific
1492 environment variable is set (or if prefixed with the exclamation mark — unset) in the service
1493 manager's environment block.
1494
1495 The argument may be a single word, to check if the variable with this name is defined in the
1496 environment block, or an assignment
1497 (<literal><replaceable>name</replaceable>=<replaceable>value</replaceable></literal>), to check if
1498 the variable with this exact value is defined. Note that the environment block of the service
1499 manager itself is checked, i.e. not any variables defined with <varname>Environment=</varname> or
1500 <varname>EnvironmentFile=</varname>, as described above. This is particularly useful when the
1501 service manager runs inside a containerized environment or as per-user service manager, in order to
1502 check for variables passed in by the enclosing container manager or PAM.</para>
1503
1504 <xi:include href="version-info.xml" xpointer="v246"/>
1505 </listitem>
1506 </varlistentry>
1507
1508 <varlistentry>
1509 <term><varname>ConditionSecurity=</varname></term>
1510
1511 <listitem><para><varname>ConditionSecurity=</varname> may be used to check whether the given
1512 security technology is enabled on the system. Currently, the following values are recognized:</para>
1513
1514 <table>
1515 <title>Recognized security technologies</title>
1516
1517 <tgroup cols='2'>
1518 <colspec colname='value'/>
1519 <colspec colname='description'/>
1520
1521 <thead>
1522 <row>
1523 <entry>Value</entry>
1524 <entry>Description</entry>
1525 </row>
1526 </thead>
1527 <tbody>
1528 <row>
1529 <entry>selinux</entry>
1530 <entry>SELinux MAC</entry>
1531 </row>
1532 <row>
1533 <entry>apparmor</entry>
1534 <entry>AppArmor MAC</entry>
1535 </row>
1536 <row>
1537 <entry>tomoyo</entry>
1538 <entry>Tomoyo MAC</entry>
1539 </row>
1540 <row>
1541 <entry>smack</entry>
1542 <entry>SMACK MAC</entry>
1543 </row>
1544 <row>
1545 <entry>ima</entry>
1546 <entry>Integrity Measurement Architecture (IMA)</entry>
1547 </row>
1548 <row>
1549 <entry>audit</entry>
1550 <entry>Linux Audit Framework</entry>
1551 </row>
1552 <row>
1553 <entry>uefi-secureboot</entry>
1554 <entry>UEFI SecureBoot</entry>
1555 </row>
1556 <row>
1557 <entry>tpm2</entry>
1558 <entry>Trusted Platform Module 2.0 (TPM2)</entry>
1559 </row>
1560 <row>
1561 <entry>cvm</entry>
1562 <entry>Confidential virtual machine (SEV/TDX)</entry>
1563 </row>
1564 <row>
1565 <entry>measured-uki</entry>
1566 <entry>Unified Kernel Image with PCR 11 Measurements, as per <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>. <xi:include href="version-info.xml" xpointer="v255"/></entry>
1567 </row>
1568 </tbody>
1569 </tgroup>
1570 </table>
1571
1572 <para>The test may be negated by prepending an exclamation mark.</para>
1573
1574 <xi:include href="version-info.xml" xpointer="v244"/>
1575 </listitem>
1576 </varlistentry>
1577
1578 <varlistentry>
1579 <term><varname>ConditionCapability=</varname></term>
1580
1581 <listitem><para>Check whether the given capability exists in the capability bounding set of the
1582 service manager (i.e. this does not check whether capability is actually available in the permitted
1583 or effective sets, see
1584 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1585 for details). Pass a capability name such as <literal>CAP_MKNOD</literal>, possibly prefixed with
1586 an exclamation mark to negate the check.</para>
1587
1588 <xi:include href="version-info.xml" xpointer="v244"/>
1589 </listitem>
1590 </varlistentry>
1591
1592 <varlistentry>
1593 <term><varname>ConditionACPower=</varname></term>
1594
1595 <listitem><para>Check whether the system has AC power, or is exclusively battery powered at the
1596 time of activation of the unit. This takes a boolean argument. If set to <literal>true</literal>,
1597 the condition will hold only if at least one AC connector of the system is connected to a power
1598 source, or if no AC connectors are known. Conversely, if set to <literal>false</literal>, the
1599 condition will hold only if there is at least one AC connector known and all AC connectors are
1600 disconnected from a power source.</para>
1601
1602 <xi:include href="version-info.xml" xpointer="v244"/>
1603 </listitem>
1604 </varlistentry>
1605
1606 <varlistentry>
1607 <term><varname>ConditionNeedsUpdate=</varname></term>
1608
1609 <listitem><para>Takes one of <filename>/var/</filename> or <filename>/etc/</filename> as argument,
1610 possibly prefixed with a <literal>!</literal> (to invert the condition). This condition may be
1611 used to conditionalize units on whether the specified directory requires an update because
1612 <filename>/usr/</filename>'s modification time is newer than the stamp file
1613 <filename>.updated</filename> in the specified directory. This is useful to implement offline
1614 updates of the vendor operating system resources in <filename>/usr/</filename> that require updating
1615 of <filename>/etc/</filename> or <filename>/var/</filename> on the next following boot. Units making
1616 use of this condition should order themselves before
1617 <citerefentry><refentrytitle>systemd-update-done.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1618 to make sure they run before the stamp file's modification time gets reset indicating a completed
1619 update.</para>
1620
1621 <para>If the <varname>systemd.condition-needs-update=</varname> option is specified on the kernel
1622 command line (taking a boolean), it will override the result of this condition check, taking
1623 precedence over any file modification time checks. If the kernel command line option is used,
1624 <filename>systemd-update-done.service</filename> will not have immediate effect on any following
1625 <varname>ConditionNeedsUpdate=</varname> checks, until the system is rebooted where the kernel
1626 command line option is not specified anymore.</para>
1627
1628 <para>Note that to make this scheme effective, the timestamp of <filename>/usr/</filename> should
1629 be explicitly updated after its contents are modified. The kernel will automatically update
1630 modification timestamp on a directory only when immediate children of a directory are modified; an
1631 modification of nested files will not automatically result in mtime of <filename>/usr/</filename>
1632 being updated.</para>
1633
1634 <para>Also note that if the update method includes a call to execute appropriate post-update steps
1635 itself, it should not touch the timestamp of <filename>/usr/</filename>. In a typical distribution
1636 packaging scheme, packages will do any required update steps as part of the installation or
1637 upgrade, to make package contents immediately usable. <varname>ConditionNeedsUpdate=</varname>
1638 should be used with other update mechanisms where such an immediate update does not
1639 happen.</para>
1640
1641 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
1642 </varlistentry>
1643
1644 <varlistentry>
1645 <term><varname>ConditionFirstBoot=</varname></term>
1646
1647 <listitem><para>Takes a boolean argument. This condition may be used to conditionalize units on
1648 whether the system is booting up for the first time. This roughly means that <filename>/etc/</filename>
1649 was unpopulated when the system started booting (for details, see "First Boot Semantics" in
1650 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
1651 First boot is considered finished (this condition will evaluate as false) after the manager
1652 has finished the startup phase.</para>
1653
1654 <para>This condition may be used to populate <filename>/etc/</filename> on the first boot after
1655 factory reset, or when a new system instance boots up for the first time.</para>
1656
1657 <para>For robustness, units with <varname>ConditionFirstBoot=yes</varname> should order themselves
1658 before <filename>first-boot-complete.target</filename> and pull in this passive target with
1659 <varname>Wants=</varname>. This ensures that in a case of an aborted first boot, these units will
1660 be re-run during the next system startup.</para>
1661
1662 <para>If the <varname>systemd.condition-first-boot=</varname> option is specified on the kernel
1663 command line (taking a boolean), it will override the result of this condition check, taking
1664 precedence over <filename>/etc/machine-id</filename> existence checks.</para>
1665
1666 <xi:include href="version-info.xml" xpointer="v244"/>
1667 </listitem>
1668 </varlistentry>
1669
1670 <varlistentry>
1671 <term><varname>ConditionPathExists=</varname></term>
1672
1673 <listitem><para>Check for the existence of a file. If the specified absolute path name does not exist,
1674 the condition will fail. If the absolute path name passed to
1675 <varname>ConditionPathExists=</varname> is prefixed with an exclamation mark
1676 (<literal>!</literal>), the test is negated, and the unit is only started if the path does not
1677 exist.</para>
1678
1679 <xi:include href="version-info.xml" xpointer="v244"/>
1680 </listitem>
1681 </varlistentry>
1682
1683 <varlistentry>
1684 <term><varname>ConditionPathExistsGlob=</varname></term>
1685
1686 <listitem><para><varname>ConditionPathExistsGlob=</varname> is similar to
1687 <varname>ConditionPathExists=</varname>, but checks for the existence of at least one file or
1688 directory matching the specified globbing pattern.</para>
1689
1690 <xi:include href="version-info.xml" xpointer="v244"/>
1691 </listitem>
1692 </varlistentry>
1693
1694 <varlistentry>
1695 <term><varname>ConditionPathIsDirectory=</varname></term>
1696
1697 <listitem><para><varname>ConditionPathIsDirectory=</varname> is similar to
1698 <varname>ConditionPathExists=</varname> but verifies that a certain path exists and is a
1699 directory.</para>
1700
1701 <xi:include href="version-info.xml" xpointer="v244"/>
1702 </listitem>
1703 </varlistentry>
1704
1705 <varlistentry>
1706 <term><varname>ConditionPathIsSymbolicLink=</varname></term>
1707
1708 <listitem><para><varname>ConditionPathIsSymbolicLink=</varname> is similar to
1709 <varname>ConditionPathExists=</varname> but verifies that a certain path exists and is a symbolic
1710 link.</para>
1711
1712 <xi:include href="version-info.xml" xpointer="v244"/>
1713 </listitem>
1714 </varlistentry>
1715
1716 <varlistentry>
1717 <term><varname>ConditionPathIsMountPoint=</varname></term>
1718
1719 <listitem><para><varname>ConditionPathIsMountPoint=</varname> is similar to
1720 <varname>ConditionPathExists=</varname> but verifies that a certain path exists and is a mount
1721 point.</para>
1722
1723 <xi:include href="version-info.xml" xpointer="v244"/>
1724 </listitem>
1725 </varlistentry>
1726
1727 <varlistentry>
1728 <term><varname>ConditionPathIsReadWrite=</varname></term>
1729
1730 <listitem><para><varname>ConditionPathIsReadWrite=</varname> is similar to
1731 <varname>ConditionPathExists=</varname> but verifies that the underlying file system is readable
1732 and writable (i.e. not mounted read-only).</para>
1733
1734 <xi:include href="version-info.xml" xpointer="v244"/>
1735 </listitem>
1736 </varlistentry>
1737
1738 <varlistentry>
1739 <term><varname>ConditionPathIsEncrypted=</varname></term>
1740
1741 <listitem><para><varname>ConditionPathIsEncrypted=</varname> is similar to
1742 <varname>ConditionPathExists=</varname> but verifies that the underlying file system's backing
1743 block device is encrypted using dm-crypt/LUKS. Note that this check does not cover ext4
1744 per-directory encryption, and only detects block level encryption. Moreover, if the specified path
1745 resides on a file system on top of a loopback block device, only encryption above the loopback device is
1746 detected. It is not detected whether the file system backing the loopback block device is encrypted.</para>
1747
1748 <xi:include href="version-info.xml" xpointer="v246"/>
1749 </listitem>
1750 </varlistentry>
1751
1752 <varlistentry>
1753 <term><varname>ConditionDirectoryNotEmpty=</varname></term>
1754
1755 <listitem><para><varname>ConditionDirectoryNotEmpty=</varname> is similar to
1756 <varname>ConditionPathExists=</varname> but verifies that a certain path exists and is a non-empty
1757 directory.</para>
1758
1759 <xi:include href="version-info.xml" xpointer="v244"/>
1760 </listitem>
1761 </varlistentry>
1762
1763 <varlistentry>
1764 <term><varname>ConditionFileNotEmpty=</varname></term>
1765
1766 <listitem><para><varname>ConditionFileNotEmpty=</varname> is similar to
1767 <varname>ConditionPathExists=</varname> but verifies that a certain path exists and refers to a
1768 regular file with a non-zero size.</para>
1769
1770 <xi:include href="version-info.xml" xpointer="v244"/>
1771 </listitem>
1772 </varlistentry>
1773
1774 <varlistentry>
1775 <term><varname>ConditionFileIsExecutable=</varname></term>
1776
1777 <listitem><para><varname>ConditionFileIsExecutable=</varname> is similar to
1778 <varname>ConditionPathExists=</varname> but verifies that a certain path exists, is a regular file,
1779 and marked executable.</para>
1780
1781 <xi:include href="version-info.xml" xpointer="v244"/>
1782 </listitem>
1783 </varlistentry>
1784
1785 <varlistentry>
1786 <term><varname>ConditionUser=</varname></term>
1787
1788 <listitem><para><varname>ConditionUser=</varname> takes a numeric <literal>UID</literal>, a UNIX
1789 user name, or the special value <literal>@system</literal>. This condition may be used to check
1790 whether the service manager is running as the given user. The special value
1791 <literal>@system</literal> can be used to check if the user id is within the system user
1792 range. This option is not useful for system services, as the system manager exclusively runs as the
1793 root user, and thus the test result is constant.</para>
1794
1795 <xi:include href="version-info.xml" xpointer="v244"/>
1796 </listitem>
1797 </varlistentry>
1798
1799 <varlistentry>
1800 <term><varname>ConditionGroup=</varname></term>
1801
1802 <listitem><para><varname>ConditionGroup=</varname> is similar to <varname>ConditionUser=</varname>
1803 but verifies that the service manager's real or effective group, or any of its auxiliary groups,
1804 match the specified group or GID. This setting does not support the special value
1805 <literal>@system</literal>.</para>
1806
1807 <xi:include href="version-info.xml" xpointer="v244"/>
1808 </listitem>
1809 </varlistentry>
1810
1811 <varlistentry>
1812 <term><varname>ConditionControlGroupController=</varname></term>
1813
1814 <listitem><para>Check whether given cgroup controllers (e.g. <literal>cpu</literal>) are available
1815 for use on the system or whether the legacy v1 cgroup or the modern v2 cgroup hierarchy is used.
1816 </para>
1817
1818 <para>Multiple controllers may be passed with a space separating them; in this case the condition
1819 will only pass if all listed controllers are available for use. Controllers unknown to systemd are
1820 ignored. Valid controllers are <literal>cpu</literal>, <literal>io</literal>,
1821 <literal>memory</literal>, and <literal>pids</literal>. Even if available in the kernel, a
1822 particular controller may not be available if it was disabled on the kernel command line with
1823 <varname>cgroup_disable=controller</varname>.</para>
1824
1825 <para>Alternatively, two special strings <literal>v1</literal> and <literal>v2</literal> may be
1826 specified (without any controller names). <literal>v2</literal> will pass if the unified v2 cgroup
1827 hierarchy is used, and <literal>v1</literal> will pass if the legacy v1 hierarchy or the hybrid
1828 hierarchy are used. Note that legacy or hybrid hierarchies have been deprecated. See
1829 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
1830 more information.</para>
1831
1832 <xi:include href="version-info.xml" xpointer="v244"/>
1833 </listitem>
1834 </varlistentry>
1835
1836 <varlistentry>
1837 <term><varname>ConditionMemory=</varname></term>
1838
1839 <listitem><para>Verify that the specified amount of system memory is available to the current
1840 system. Takes a memory size in bytes as argument, optionally prefixed with a comparison operator
1841 <literal>&lt;</literal>, <literal>&lt;=</literal>, <literal>=</literal> (or <literal>==</literal>),
1842 <literal>!=</literal> (or <literal>&lt;&gt;</literal>), <literal>&gt;=</literal>,
1843 <literal>&gt;</literal>. On bare-metal systems compares the amount of physical memory in the system
1844 with the specified size, adhering to the specified comparison operator. In containers compares the
1845 amount of memory assigned to the container instead.</para>
1846
1847 <xi:include href="version-info.xml" xpointer="v244"/>
1848 </listitem>
1849 </varlistentry>
1850
1851 <varlistentry>
1852 <term><varname>ConditionCPUs=</varname></term>
1853
1854 <listitem><para>Verify that the specified number of CPUs is available to the current system. Takes
1855 a number of CPUs as argument, optionally prefixed with a comparison operator
1856 <literal>&lt;</literal>, <literal>&lt;=</literal>, <literal>=</literal> (or <literal>==</literal>),
1857 <literal>!=</literal> (or <literal>&lt;&gt;</literal>), <literal>&gt;=</literal>,
1858 <literal>&gt;</literal>. Compares the number of CPUs in the CPU affinity mask configured of the
1859 service manager itself with the specified number, adhering to the specified comparison operator. On
1860 physical systems the number of CPUs in the affinity mask of the service manager usually matches the
1861 number of physical CPUs, but in special and virtual environments might differ. In particular, in
1862 containers the affinity mask usually matches the number of CPUs assigned to the container and not
1863 the physically available ones.</para>
1864
1865 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
1866 </varlistentry>
1867
1868 <varlistentry>
1869 <term><varname>ConditionCPUFeature=</varname></term>
1870
1871 <listitem><para>Verify that a given CPU feature is available via the <literal>CPUID</literal>
1872 instruction. This condition only does something on i386 and x86-64 processors. On other
1873 processors it is assumed that the CPU does not support the given feature. It checks the leaves
1874 <literal>1</literal>, <literal>7</literal>, <literal>0x80000001</literal>, and
1875 <literal>0x80000007</literal>. Valid values are:
1876 <literal>fpu</literal>,
1877 <literal>vme</literal>,
1878 <literal>de</literal>,
1879 <literal>pse</literal>,
1880 <literal>tsc</literal>,
1881 <literal>msr</literal>,
1882 <literal>pae</literal>,
1883 <literal>mce</literal>,
1884 <literal>cx8</literal>,
1885 <literal>apic</literal>,
1886 <literal>sep</literal>,
1887 <literal>mtrr</literal>,
1888 <literal>pge</literal>,
1889 <literal>mca</literal>,
1890 <literal>cmov</literal>,
1891 <literal>pat</literal>,
1892 <literal>pse36</literal>,
1893 <literal>clflush</literal>,
1894 <literal>mmx</literal>,
1895 <literal>fxsr</literal>,
1896 <literal>sse</literal>,
1897 <literal>sse2</literal>,
1898 <literal>ht</literal>,
1899 <literal>pni</literal>,
1900 <literal>pclmul</literal>,
1901 <literal>monitor</literal>,
1902 <literal>ssse3</literal>,
1903 <literal>fma3</literal>,
1904 <literal>cx16</literal>,
1905 <literal>sse4_1</literal>,
1906 <literal>sse4_2</literal>,
1907 <literal>movbe</literal>,
1908 <literal>popcnt</literal>,
1909 <literal>aes</literal>,
1910 <literal>xsave</literal>,
1911 <literal>osxsave</literal>,
1912 <literal>avx</literal>,
1913 <literal>f16c</literal>,
1914 <literal>rdrand</literal>,
1915 <literal>bmi1</literal>,
1916 <literal>avx2</literal>,
1917 <literal>bmi2</literal>,
1918 <literal>rdseed</literal>,
1919 <literal>adx</literal>,
1920 <literal>sha_ni</literal>,
1921 <literal>syscall</literal>,
1922 <literal>rdtscp</literal>,
1923 <literal>lm</literal>,
1924 <literal>lahf_lm</literal>,
1925 <literal>abm</literal>,
1926 <literal>constant_tsc</literal>.</para>
1927
1928 <xi:include href="version-info.xml" xpointer="v248"/>
1929 </listitem>
1930 </varlistentry>
1931
1932 <varlistentry>
1933 <term><varname>ConditionOSRelease=</varname></term>
1934
1935 <listitem><para>Verify that a specific <literal>key=value</literal> pair is set in the host's
1936 <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1937
1938 <para>Other than exact string matching (with <literal>=</literal> and <literal>!=</literal>),
1939 relative comparisons are supported for versioned parameters (e.g. <literal>VERSION_ID</literal>;
1940 with <literal>&lt;</literal>, <literal>&lt;=</literal>, <literal>==</literal>,
1941 <literal>&lt;&gt;</literal>, <literal>&gt;=</literal>, <literal>&gt;</literal>), and shell-style
1942 wildcard comparisons (<literal>*</literal>, <literal>?</literal>, <literal>[]</literal>) are
1943 supported with the <literal>$=</literal> (match) and <literal>!$=</literal> (non-match).</para>
1944
1945 <xi:include href="version-info.xml" xpointer="v249"/>
1946 </listitem>
1947 </varlistentry>
1948
1949 <varlistentry>
1950 <term><varname>ConditionMemoryPressure=</varname></term>
1951 <term><varname>ConditionCPUPressure=</varname></term>
1952 <term><varname>ConditionIOPressure=</varname></term>
1953
1954 <listitem><para>Verify that the overall system (memory, CPU or IO) pressure is below or equal to a threshold.
1955 This setting takes a threshold value as argument. It can be specified as a simple percentage value,
1956 suffixed with <literal>%</literal>, in which case the pressure will be measured as an average over the last
1957 five minutes before the attempt to start the unit is performed.
1958 Alternatively, the average timespan can also be specified using <literal>/</literal> as a separator, for
1959 example: <literal>10%/1min</literal>. The supported timespans match what the kernel provides, and are
1960 limited to <literal>10sec</literal>, <literal>1min</literal> and <literal>5min</literal>. The
1961 <literal>full</literal> PSI will be checked first, and if not found <literal>some</literal> will be
1962 checked. For more details, see the documentation on <ulink
1963 url="https://docs.kernel.org/accounting/psi.html">PSI (Pressure Stall Information)
1964 </ulink>.</para>
1965
1966 <para>Optionally, the threshold value can be prefixed with the slice unit under which the pressure will be checked,
1967 followed by a <literal>:</literal>. If the slice unit is not specified, the overall system pressure will be measured,
1968 instead of a particular cgroup's.</para>
1969
1970 <xi:include href="version-info.xml" xpointer="v250"/>
1971 </listitem>
1972 </varlistentry>
1973
1974 <varlistentry>
1975 <term><varname>AssertArchitecture=</varname></term>
1976 <term><varname>AssertVirtualization=</varname></term>
1977 <term><varname>AssertHost=</varname></term>
1978 <term><varname>AssertKernelCommandLine=</varname></term>
1979 <term><varname>AssertKernelVersion=</varname></term>
1980 <term><varname>AssertCredential=</varname></term>
1981 <term><varname>AssertEnvironment=</varname></term>
1982 <term><varname>AssertSecurity=</varname></term>
1983 <term><varname>AssertCapability=</varname></term>
1984 <term><varname>AssertACPower=</varname></term>
1985 <term><varname>AssertNeedsUpdate=</varname></term>
1986 <term><varname>AssertFirstBoot=</varname></term>
1987 <term><varname>AssertPathExists=</varname></term>
1988 <term><varname>AssertPathExistsGlob=</varname></term>
1989 <term><varname>AssertPathIsDirectory=</varname></term>
1990 <term><varname>AssertPathIsSymbolicLink=</varname></term>
1991 <term><varname>AssertPathIsMountPoint=</varname></term>
1992 <term><varname>AssertPathIsReadWrite=</varname></term>
1993 <term><varname>AssertPathIsEncrypted=</varname></term>
1994 <term><varname>AssertDirectoryNotEmpty=</varname></term>
1995 <term><varname>AssertFileNotEmpty=</varname></term>
1996 <term><varname>AssertFileIsExecutable=</varname></term>
1997 <term><varname>AssertUser=</varname></term>
1998 <term><varname>AssertGroup=</varname></term>
1999 <term><varname>AssertControlGroupController=</varname></term>
2000 <term><varname>AssertMemory=</varname></term>
2001 <term><varname>AssertCPUs=</varname></term>
2002 <term><varname>AssertCPUFeature=</varname></term>
2003 <term><varname>AssertOSRelease=</varname></term>
2004 <term><varname>AssertMemoryPressure=</varname></term>
2005 <term><varname>AssertCPUPressure=</varname></term>
2006 <term><varname>AssertIOPressure=</varname></term>
2007
2008 <listitem><para>Similar to the <varname>ConditionArchitecture=</varname>,
2009 <varname>ConditionVirtualization=</varname>, …, condition settings described above, these settings
2010 add assertion checks to the start-up of the unit. However, unlike the conditions settings, any
2011 assertion setting that is not met results in failure of the start job (which means this is logged
2012 loudly). Note that hitting a configured assertion does not cause the unit to enter the
2013 <literal>failed</literal> state (or in fact result in any state change of the unit), it affects
2014 only the job queued for it. Use assertion expressions for units that cannot operate when specific
2015 requirements are not met, and when this is something the administrator or user should look
2016 into.</para>
2017
2018 <xi:include href="version-info.xml" xpointer="v218"/>
2019 </listitem>
2020 </varlistentry>
2021 </variablelist>
2022 </refsect2>
2023 </refsect1>
2024
2025 <refsect1>
2026 <title>Mapping of unit properties to their inverses</title>
2027
2028 <para>Unit settings that create a relationship with a second unit usually show up
2029 in properties of both units, for example in <command>systemctl show</command>
2030 output. In some cases the name of the property is the same as the name of the
2031 configuration setting, but not always. This table lists the properties
2032 that are shown on two units which are connected through some dependency, and shows
2033 which property on "source" unit corresponds to which property on the "target" unit.
2034 </para>
2035
2036 <table>
2037 <title>
2038 "Forward" and "reverse" unit properties
2039 </title>
2040
2041 <tgroup cols='4'>
2042 <colspec colname='forward' />
2043 <colspec colname='reverse' />
2044 <colspec colname='fuse' />
2045 <colspec colname='ruse' />
2046 <thead>
2047 <row>
2048 <entry>"Forward" property</entry>
2049 <entry>"Reverse" property</entry>
2050 <entry namest='fuse' nameend='ruse' valign='middle'>Where used</entry>
2051 </row>
2052 </thead>
2053 <tbody>
2054 <row>
2055 <entry><varname>Before=</varname></entry>
2056 <entry><varname>After=</varname></entry>
2057 <entry morerows='1' namest='fuse' nameend='ruse' valign='middle'>[Unit] section</entry>
2058 </row>
2059 <row>
2060 <entry><varname>After=</varname></entry>
2061 <entry><varname>Before=</varname></entry>
2062 </row>
2063 <row>
2064 <entry><varname>Requires=</varname></entry>
2065 <entry><varname>RequiredBy=</varname></entry>
2066 <entry>[Unit] section</entry>
2067 <entry>[Install] section</entry>
2068 </row>
2069 <row>
2070 <entry><varname>Wants=</varname></entry>
2071 <entry><varname>WantedBy=</varname></entry>
2072 <entry>[Unit] section</entry>
2073 <entry>[Install] section</entry>
2074 </row>
2075 <row>
2076 <entry><varname>Upholds=</varname></entry>
2077 <entry><varname>UpheldBy=</varname></entry>
2078 <entry>[Unit] section</entry>
2079 <entry>[Install] section</entry>
2080 </row>
2081 <row>
2082 <entry><varname>PartOf=</varname></entry>
2083 <entry><varname>ConsistsOf=</varname></entry>
2084 <entry>[Unit] section</entry>
2085 <entry>an automatic property</entry>
2086 </row>
2087 <row>
2088 <entry><varname>BindsTo=</varname></entry>
2089 <entry><varname>BoundBy=</varname></entry>
2090 <entry>[Unit] section</entry>
2091 <entry>an automatic property</entry>
2092 </row>
2093 <row>
2094 <entry><varname>Requisite=</varname></entry>
2095 <entry><varname>RequisiteOf=</varname></entry>
2096 <entry>[Unit] section</entry>
2097 <entry>an automatic property</entry>
2098 </row>
2099 <row>
2100 <entry><varname>Conflicts=</varname></entry>
2101 <entry><varname>ConflictedBy=</varname></entry>
2102 <entry>[Unit] section</entry>
2103 <entry>an automatic property</entry>
2104 </row>
2105 <row>
2106 <entry><varname>Triggers=</varname></entry>
2107 <entry><varname>TriggeredBy=</varname></entry>
2108 <entry namest='fuse' nameend='ruse' valign='middle'>Automatic properties, see notes below</entry>
2109 </row>
2110 <row>
2111 <entry><varname>PropagatesReloadTo=</varname></entry>
2112 <entry><varname>ReloadPropagatedFrom=</varname></entry>
2113 <entry morerows='1' namest='fuse' nameend='ruse' valign='middle'>[Unit] section</entry>
2114 </row>
2115 <row>
2116 <entry><varname>ReloadPropagatedFrom=</varname></entry>
2117 <entry><varname>PropagatesReloadTo=</varname></entry>
2118 </row>
2119 <row>
2120 <entry><varname>PropagatesStopTo=</varname></entry>
2121 <entry><varname>StopPropagatedFrom=</varname></entry>
2122 <entry morerows='1' namest='fuse' nameend='ruse' valign='middle'>[Unit] section</entry>
2123 </row>
2124 <row>
2125 <entry><varname>StopPropagatedFrom=</varname></entry>
2126 <entry><varname>PropagatesStopTo=</varname></entry>
2127 </row>
2128 <row>
2129 <entry><varname>Following=</varname></entry>
2130 <entry>n/a</entry>
2131 <entry>An automatic property</entry>
2132 </row>
2133 </tbody>
2134 </tgroup>
2135 </table>
2136
2137 <para>Note: <varname>WantedBy=</varname>, <varname>RequiredBy=</varname>, and <varname>UpheldBy=</varname>
2138 are used in the [Install] section to create symlinks in <filename>.wants/</filename>,
2139 <filename>.requires/</filename>, and <filename>.upholds/</filename> directories. They cannot be used
2140 directly as a unit configuration setting.</para>
2141
2142 <para>Note: <varname>ConsistsOf=</varname>, <varname>BoundBy=</varname>,
2143 <varname>RequisiteOf=</varname>, <varname>ConflictedBy=</varname> are created
2144 implicitly along with their reverses and cannot be specified directly.</para>
2145
2146 <para>Note: <varname>Triggers=</varname> is created implicitly between a socket,
2147 path unit, or an automount unit, and the unit they activate. By default a unit
2148 with the same name is triggered, but this can be overridden using
2149 <varname>Sockets=</varname>, <varname>Service=</varname>, and <varname>Unit=</varname>
2150 settings. See
2151 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2152 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2153 <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2154 and
2155 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2156 for details. <varname>TriggeredBy=</varname> is created implicitly on the
2157 triggered unit.</para>
2158
2159 <para>Note: <varname>Following=</varname> is used to group device aliases and points to the
2160 "primary" device unit that systemd is using to track device state, usually corresponding to a
2161 sysfs path. It does not show up in the "target" unit.</para>
2162 </refsect1>
2163
2164 <refsect1>
2165 <title>[Install] Section Options</title>
2166
2167 <para>Unit files may include an [Install] section, which carries installation information for
2168 the unit. This section is not interpreted by
2169 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> during runtime; it is
2170 used by the <command>enable</command> and <command>disable</command> commands of the
2171 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool during
2172 installation of a unit.</para>
2173
2174 <variablelist class='unit-directives'>
2175 <varlistentry>
2176 <term><varname>Alias=</varname></term>
2177
2178 <listitem><para>A space-separated list of additional names this unit shall be installed under. The names listed
2179 here must have the same suffix (i.e. type) as the unit filename. This option may be specified more than once,
2180 in which case all listed names are used. At installation time, <command>systemctl enable</command> will create
2181 symlinks from these names to the unit filename. Note that not all unit types support such alias names, and this
2182 setting is not supported for them. Specifically, mount, slice, swap, and automount units do not support
2183 aliasing.</para>
2184
2185 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
2186 </varlistentry>
2187
2188 <varlistentry>
2189 <term><varname>WantedBy=</varname></term>
2190 <term><varname>RequiredBy=</varname></term>
2191 <term><varname>UpheldBy=</varname></term>
2192
2193 <listitem><para>This option may be used more than once, or a space-separated list of unit names may
2194 be given. A symbolic link is created in the <filename>.wants/</filename>, <filename>.requires/</filename>,
2195 or <filename>.upholds/</filename> directory of each of the listed units when this unit is installed
2196 by <command>systemctl enable</command>. This has the effect of a dependency of type
2197 <varname>Wants=</varname>, <varname>Requires=</varname>, or <varname>Upholds=</varname> being added
2198 from the listed unit to the current unit. See the description of the mentioned dependency types
2199 in the [Unit] section for details.</para>
2200
2201 <para>In case of template units listing non template units, the listing unit must have
2202 <varname>DefaultInstance=</varname> set, or <command>systemctl enable</command> must be called with
2203 an instance name. The instance (default or specified) will be added to the
2204 <filename>.wants/</filename>, <filename>.requires/</filename>, or <filename>.upholds/</filename>
2205 list of the listed unit. For example, <command>WantedBy=getty.target</command> in a service
2206 <filename>getty@.service</filename> will result in <command>systemctl enable getty@tty2.service</command>
2207 creating a <filename>getty.target.wants/getty@tty2.service</filename> link to
2208 <filename>getty@.service</filename>. This also applies to listing specific instances of templated
2209 units: this specific instance will gain the dependency. A template unit may also list a template
2210 unit, in which case a generic dependency will be added where each instance of the listing unit will
2211 have a dependency on an instance of the listed template with the same instance value. For example,
2212 <command>WantedBy=container@.target</command> in a service <filename>monitor@.service</filename> will
2213 result in <command>systemctl enable monitor@.service</command> creating a
2214 <filename>container@.target.wants/monitor@.service</filename> link to
2215 <filename>monitor@.service</filename>, which applies to all instances of
2216 <filename>container@.target</filename>.</para>
2217
2218 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
2219 </varlistentry>
2220
2221 <varlistentry>
2222 <term><varname>Also=</varname></term>
2223
2224 <listitem><para>Additional units to install/deinstall when
2225 this unit is installed/deinstalled. If the user requests
2226 installation/deinstallation of a unit with this option
2227 configured, <command>systemctl enable</command> and
2228 <command>systemctl disable</command> will automatically
2229 install/uninstall units listed in this option as well.</para>
2230
2231 <para>This option may be used more than once, or a
2232 space-separated list of unit names may be
2233 given.</para>
2234
2235 <xi:include href="version-info.xml" xpointer="v201"/></listitem>
2236 </varlistentry>
2237
2238 <varlistentry>
2239 <term><varname>DefaultInstance=</varname></term>
2240
2241 <listitem><para>In template unit files, this specifies for
2242 which instance the unit shall be enabled if the template is
2243 enabled without any explicitly set instance. This option has
2244 no effect in non-template unit files. The specified string
2245 must be usable as instance identifier.</para>
2246
2247 <xi:include href="version-info.xml" xpointer="v215"/></listitem>
2248 </varlistentry>
2249 </variablelist>
2250
2251 <para>The following specifiers are interpreted in the Install section:
2252 %a, %b, %B, %g, %G, %H, %i, %j, %l, %m, %n, %N, %o, %p, %u, %U, %v, %w, %W, %%.
2253 For their meaning see the next section.</para>
2254 </refsect1>
2255
2256 <refsect1>
2257 <title>Specifiers</title>
2258
2259 <para>Many settings resolve specifiers which may be used to write
2260 generic unit files referring to runtime or unit parameters that
2261 are replaced when the unit files are loaded. Specifiers must be known
2262 and resolvable for the setting to be valid. The following
2263 specifiers are understood:</para>
2264
2265 <table class='specifiers'>
2266 <title>Specifiers available in unit files</title>
2267 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
2268 <colspec colname="spec" />
2269 <colspec colname="mean" />
2270 <colspec colname="detail" />
2271 <thead>
2272 <row>
2273 <entry>Specifier</entry>
2274 <entry>Meaning</entry>
2275 <entry>Details</entry>
2276 </row>
2277 </thead>
2278 <tbody>
2279 <row>
2280 <!-- We do not use the common definition from standard-specifiers.xml here since it includes a
2281 reference onto our own man page, which would make the rendered version self-referential. -->
2282 <entry><literal>%a</literal></entry>
2283 <entry>Architecture</entry>
2284 <entry>A short string identifying the architecture of the local system. A string such as <constant>x86</constant>, <constant>x86-64</constant> or <constant>arm64</constant>. See the architectures defined for <varname>ConditionArchitecture=</varname> above for a full list.</entry>
2285 </row>
2286 <xi:include href="standard-specifiers.xml" xpointer="A"/>
2287 <xi:include href="standard-specifiers.xml" xpointer="b"/>
2288 <xi:include href="standard-specifiers.xml" xpointer="B"/>
2289 <row>
2290 <entry><literal>%C</literal></entry>
2291 <entry>Cache directory root</entry>
2292 <entry>This is either <filename>/var/cache</filename> (for the system manager) or the path <literal>$XDG_CACHE_HOME</literal> resolves to (for user managers).</entry>
2293 </row>
2294 <row>
2295 <entry><literal>%d</literal></entry>
2296 <entry>Credentials directory</entry>
2297 <entry>This is the value of the <literal>$CREDENTIALS_DIRECTORY</literal> environment variable if available. See section "Credentials" in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry>
2298 </row>
2299 <row>
2300 <entry><literal>%E</literal></entry>
2301 <entry>Configuration directory root</entry>
2302 <entry>This is either <filename>/etc/</filename> (for the system manager) or the path <literal>$XDG_CONFIG_HOME</literal> resolves to (for user managers).</entry>
2303 </row>
2304 <row>
2305 <entry><literal>%f</literal></entry>
2306 <entry>Unescaped filename</entry>
2307 <entry>This is either the unescaped instance name (if applicable) with <filename>/</filename> prepended (if applicable), or the unescaped prefix name prepended with <filename>/</filename>. This implements unescaping according to the rules for escaping absolute file system paths discussed above.</entry>
2308 </row>
2309 <row>
2310 <entry><literal>%g</literal></entry>
2311 <entry>User group</entry>
2312 <entry>This is the name of the group running the service manager instance. In case of the system manager this resolves to <literal>root</literal>.</entry>
2313 </row>
2314 <row>
2315 <entry><literal>%G</literal></entry>
2316 <entry>User GID</entry>
2317 <entry>This is the numeric GID of the user running the service manager instance. In case of the system manager this resolves to <literal>0</literal>.</entry>
2318 </row>
2319 <row>
2320 <entry><literal>%h</literal></entry>
2321 <entry>User home directory</entry>
2322 <entry>This is the home directory of the <emphasis>user running the service manager instance</emphasis>. In case of the system manager this resolves to <literal>/root</literal>.
2323
2324 Note that this setting is <emphasis>not</emphasis> influenced by the <varname>User=</varname> setting configurable in the [Service] section of the service unit.</entry>
2325 </row>
2326 <row>
2327 <!-- We do not use the common definition from standard-specifiers.xml here since we want a
2328 slightly more verbose explanation here, referring to the reload cycle. -->
2329 <entry><literal>%H</literal></entry>
2330 <entry>Host name</entry>
2331 <entry>The hostname of the running system at the point in time the unit configuration is loaded.</entry>
2332 </row>
2333 <row>
2334 <entry><literal>%i</literal></entry>
2335 <entry>Instance name</entry>
2336 <entry>For instantiated units this is the string between the first <literal>@</literal> character and the type suffix. Empty for non-instantiated units.</entry>
2337 </row>
2338 <row>
2339 <entry><literal>%I</literal></entry>
2340 <entry>Unescaped instance name</entry>
2341 <entry>Same as <literal>%i</literal>, but with escaping undone.</entry>
2342 </row>
2343 <row>
2344 <entry><literal>%j</literal></entry>
2345 <entry>Final component of the prefix</entry>
2346 <entry>This is the string between the last <literal>-</literal> and the end of the prefix name. If there is no <literal>-</literal>, this is the same as <literal>%p</literal>.</entry>
2347 </row>
2348 <row>
2349 <entry><literal>%J</literal></entry>
2350 <entry>Unescaped final component of the prefix</entry>
2351 <entry>Same as <literal>%j</literal>, but with escaping undone.</entry>
2352 </row>
2353 <row>
2354 <entry><literal>%l</literal></entry>
2355 <!-- We do not use the common definition from standard-specifiers.xml here since we want a
2356 slightly more verbose explanation here, referring to the reload cycle. -->
2357 <entry>Short host name</entry>
2358 <entry>The hostname of the running system at the point in time the unit configuration is loaded, truncated at the first dot to remove any domain component.</entry>
2359 </row>
2360 <row>
2361 <entry><literal>%L</literal></entry>
2362 <entry>Log directory root</entry>
2363 <entry>This is either <filename>/var/log</filename> (for the system manager) or the path <varname>$XDG_STATE_HOME</varname> resolves to with <filename index="false">/log</filename> appended (for user managers).</entry>
2364 </row>
2365 <xi:include href="standard-specifiers.xml" xpointer="m"/>
2366 <xi:include href="standard-specifiers.xml" xpointer="M"/>
2367 <row>
2368 <entry><literal>%n</literal></entry>
2369 <entry>Full unit name</entry>
2370 <entry></entry>
2371 </row>
2372 <row>
2373 <entry><literal>%N</literal></entry>
2374 <entry>Full unit name</entry>
2375 <entry>Same as <literal>%n</literal>, but with the type suffix removed.</entry>
2376 </row>
2377 <xi:include href="standard-specifiers.xml" xpointer="o"/>
2378 <row>
2379 <entry><literal>%p</literal></entry>
2380 <entry>Prefix name</entry>
2381 <entry>For instantiated units, this refers to the string before the first <literal>@</literal> character of the unit name. For non-instantiated units, same as <literal>%N</literal>.</entry>
2382 </row>
2383 <row>
2384 <entry><literal>%P</literal></entry>
2385 <entry>Unescaped prefix name</entry>
2386 <entry>Same as <literal>%p</literal>, but with escaping undone.</entry>
2387 </row>
2388 <row>
2389 <!-- We do not use the common definition from standard-specifiers.xml here since we want a
2390 slightly more verbose explanation here, referring to the reload cycle. -->
2391 <entry><literal>%q</literal></entry>
2392 <entry>Pretty host name</entry>
2393 <entry>The pretty hostname of the running system at the point in time the unit configuration is loaded, as read from the <varname>PRETTY_HOSTNAME=</varname> field of <filename>/etc/machine-info</filename>. If not set, resolves to the short hostname. See <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry>
2394 </row>
2395 <row>
2396 <entry><literal>%s</literal></entry>
2397 <entry>User shell</entry>
2398 <entry>This is the shell of the user running the service manager instance.</entry>
2399 </row>
2400 <row>
2401 <entry><literal>%S</literal></entry>
2402 <entry>State directory root</entry>
2403 <entry>This is either <filename>/var/lib</filename> (for the system manager) or the path <varname>$XDG_STATE_HOME</varname> resolves to (for user managers).</entry>
2404 </row>
2405 <row>
2406 <entry><literal>%t</literal></entry>
2407 <entry>Runtime directory root</entry>
2408 <entry>This is either <filename>/run/</filename> (for the system manager) or the path <literal>$XDG_RUNTIME_DIR</literal> resolves to (for user managers).</entry>
2409 </row>
2410 <xi:include href="standard-specifiers.xml" xpointer="T"/>
2411 <row>
2412 <entry><literal>%u</literal></entry>
2413 <entry>User name</entry>
2414 <entry>This is the name of the <emphasis>user running the service manager instance</emphasis>. In case of the system manager this resolves to <literal>root</literal>.
2415
2416 Note that this setting is <emphasis>not</emphasis> influenced by the <varname>User=</varname> setting configurable in the [Service] section of the service unit.</entry>
2417 </row>
2418 <row>
2419 <entry><literal>%U</literal></entry>
2420 <entry>User UID</entry>
2421 <entry>This is the numeric UID of the <emphasis>user running the service manager instance</emphasis>. In case of the system manager this resolves to <literal>0</literal>.
2422
2423 Note that this setting is <emphasis>not</emphasis> influenced by the <varname>User=</varname> setting configurable in the [Service] section of the service unit.</entry>
2424 </row>
2425 <xi:include href="standard-specifiers.xml" xpointer="v"/>
2426 <xi:include href="standard-specifiers.xml" xpointer="V"/>
2427 <xi:include href="standard-specifiers.xml" xpointer="w"/>
2428 <xi:include href="standard-specifiers.xml" xpointer="W"/>
2429 <row>
2430 <entry><literal>%y</literal></entry>
2431 <entry>The path to the fragment</entry>
2432 <entry>This is the path where the main part of the unit file is located. For linked unit files, the real path outside of the unit search directories is used. For units that don't have a fragment file, this specifier will raise an error.</entry>
2433 </row>
2434 <row>
2435 <entry><literal>%Y</literal></entry>
2436 <entry>The directory of the fragment</entry>
2437 <entry>This is the directory part of <literal>%y</literal>.</entry>
2438 </row>
2439 <xi:include href="standard-specifiers.xml" xpointer="percent"/>
2440 </tbody>
2441 </tgroup>
2442 </table>
2443 </refsect1>
2444
2445 <refsect1>
2446 <title>Examples</title>
2447
2448 <example>
2449 <title>Allowing units to be enabled</title>
2450
2451 <para>The following snippet (highlighted) allows a unit (e.g.
2452 <filename>foo.service</filename>) to be enabled via
2453 <command>systemctl enable</command>:</para>
2454
2455 <programlisting>[Unit]
2456 Description=Foo
2457
2458 [Service]
2459 ExecStart=/usr/sbin/foo-daemon
2460
2461 <emphasis>[Install]</emphasis>
2462 <emphasis>WantedBy=multi-user.target</emphasis></programlisting>
2463
2464 <para>After running <command>systemctl enable</command>, a
2465 symlink
2466 <filename index="false">/etc/systemd/system/multi-user.target.wants/foo.service</filename>
2467 linking to the actual unit will be created. It tells systemd to
2468 pull in the unit when starting
2469 <filename>multi-user.target</filename>. The inverse
2470 <command>systemctl disable</command> will remove that symlink
2471 again.</para>
2472 </example>
2473
2474 <example>
2475 <title>Overriding vendor settings</title>
2476
2477 <para>There are two methods of overriding vendor settings in
2478 unit files: copying the unit file from
2479 <filename>/usr/lib/systemd/system</filename> to
2480 <filename>/etc/systemd/system</filename> and modifying the
2481 chosen settings. Alternatively, one can create a directory named
2482 <filename><replaceable>unit</replaceable>.d/</filename> within
2483 <filename>/etc/systemd/system</filename> and place a drop-in
2484 file <filename><replaceable>name</replaceable>.conf</filename>
2485 there that only changes the specific settings one is interested
2486 in. Note that multiple such drop-in files are read if
2487 present, processed in lexicographic order of their filename.</para>
2488
2489 <para>The advantage of the first method is that one easily
2490 overrides the complete unit, the vendor unit is not parsed at
2491 all anymore. It has the disadvantage that improvements to the
2492 unit file by the vendor are not automatically incorporated on
2493 updates.</para>
2494
2495 <para>The advantage of the second method is that one only
2496 overrides the settings one specifically wants, where updates to
2497 the unit by the vendor automatically apply. This has the
2498 disadvantage that some future updates by the vendor might be
2499 incompatible with the local changes.</para>
2500
2501 <para>This also applies for user instances of systemd, but with
2502 different locations for the unit files. See the section on unit
2503 load paths for further details.</para>
2504
2505 <para>Suppose there is a vendor-supplied unit
2506 <filename>/usr/lib/systemd/system/httpd.service</filename> with
2507 the following contents:</para>
2508
2509 <programlisting>[Unit]
2510 Description=Some HTTP server
2511 After=remote-fs.target sqldb.service
2512 Requires=sqldb.service
2513 AssertPathExists=/srv/webserver
2514
2515 [Service]
2516 Type=notify
2517 ExecStart=/usr/sbin/some-fancy-httpd-server
2518 Nice=5
2519
2520 [Install]
2521 WantedBy=multi-user.target</programlisting>
2522
2523 <para>Now one wants to change some settings as an administrator:
2524 firstly, in the local setup, <filename>/srv/webserver</filename>
2525 might not exist, because the HTTP server is configured to use
2526 <filename>/srv/www</filename> instead. Secondly, the local
2527 configuration makes the HTTP server also depend on a memory
2528 cache service, <filename>memcached.service</filename>, that
2529 should be pulled in (<varname>Requires=</varname>) and also be
2530 ordered appropriately (<varname>After=</varname>). Thirdly, in
2531 order to harden the service a bit more, the administrator would
2532 like to set the <varname>PrivateTmp=</varname> setting (see
2533 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2534 for details). And lastly, the administrator would like to reset
2535 the niceness of the service to its default value of 0.</para>
2536
2537 <para>The first possibility is to copy the unit file to
2538 <filename>/etc/systemd/system/httpd.service</filename> and
2539 change the chosen settings:</para>
2540
2541 <programlisting>[Unit]
2542 Description=Some HTTP server
2543 After=remote-fs.target sqldb.service <emphasis>memcached.service</emphasis>
2544 Requires=sqldb.service <emphasis>memcached.service</emphasis>
2545 AssertPathExists=<emphasis>/srv/www</emphasis>
2546
2547 [Service]
2548 Type=notify
2549 ExecStart=/usr/sbin/some-fancy-httpd-server
2550 <emphasis>Nice=0</emphasis>
2551 <emphasis>PrivateTmp=yes</emphasis>
2552
2553 [Install]
2554 WantedBy=multi-user.target</programlisting>
2555
2556 <para>Alternatively, the administrator could create a drop-in
2557 file
2558 <filename>/etc/systemd/system/httpd.service.d/local.conf</filename>
2559 with the following contents:</para>
2560
2561 <programlisting>[Unit]
2562 After=memcached.service
2563 Requires=memcached.service
2564 # Reset all assertions and then re-add the condition we want
2565 AssertPathExists=
2566 AssertPathExists=/srv/www
2567
2568 [Service]
2569 Nice=0
2570 PrivateTmp=yes</programlisting>
2571
2572 <para>Note that for drop-in files, if one wants to remove
2573 entries from a setting that is parsed as a list (and is not a
2574 dependency), such as <varname>AssertPathExists=</varname> (or
2575 e.g. <varname>ExecStart=</varname> in service units), one needs
2576 to first clear the list before re-adding all entries except the
2577 one that is to be removed. Dependencies (<varname>After=</varname>, etc.)
2578 cannot be reset to an empty list, so dependencies can only be
2579 added in drop-ins. If you want to remove dependencies, you have
2580 to override the entire unit.</para>
2581
2582 </example>
2583
2584 <example>
2585 <title>Top level drop-ins with template units</title>
2586
2587 <para>Top level per-type drop-ins can be used to change some aspect of
2588 all units of a particular type. For example, by creating the
2589 <filename index='false'>/etc/systemd/system/service.d/</filename>
2590 directory with a drop-in file, the contents of the drop-in file can be
2591 applied to all service units. We can take this further by having the
2592 top-level drop-in instantiate a secondary helper unit. Consider for
2593 example the following set of units and drop-in files where we install
2594 an <varname>OnFailure=</varname> dependency for all service units.</para>
2595
2596 <para>
2597 <filename index='false'>/etc/systemd/system/failure-handler@.service</filename>:</para>
2598
2599 <programlisting>[Unit]
2600 Description=My failure handler for %i
2601
2602 [Service]
2603 Type=oneshot
2604 # Perform some special action for when %i exits unexpectedly.
2605 ExecStart=/usr/sbin/myfailurehandler %i
2606 </programlisting>
2607
2608 <para>We can then add an instance of
2609 <filename index='false'>failure-handler@.service</filename> as an
2610 <varname>OnFailure=</varname> dependency for all service units.</para>
2611
2612 <para>
2613 <filename index='false'>/etc/systemd/system/service.d/10-all.conf</filename>:</para>
2614
2615 <programlisting>[Unit]
2616 OnFailure=failure-handler@%N.service
2617 </programlisting>
2618
2619 <para>Now, after running <command>systemctl daemon-reload</command> all
2620 services will have acquired an <varname>OnFailure=</varname> dependency on
2621 <filename index='false'>failure-handler@%N.service</filename>. The
2622 template instance units will also have gained the dependency which results
2623 in the creation of a recursive dependency chain. systemd will try to detect
2624 these recursive dependency chains where a template unit directly and
2625 recursively depends on itself and will remove such dependencies
2626 automatically if it finds them. If systemd doesn't detect the recursive
2627 dependency chain, we can break the chain ourselves by disabling the drop-in
2628 for the template instance units via a symlink to
2629 <filename index='false'>/dev/null</filename>:</para>
2630
2631 <programlisting>
2632 <command>mkdir /etc/systemd/system/failure-handler@.service.d/</command>
2633 <command>ln -s /dev/null /etc/systemd/system/failure-handler@.service.d/10-all.conf</command>
2634 <command>systemctl daemon-reload</command>
2635 </programlisting>
2636
2637 <para>This ensures that if a <filename index='false'>failure-handler@.service</filename> instance fails it will not trigger an instance named
2638 <filename index='false'>failure-handler@failure-handler.service</filename>.</para>
2639
2640 </example>
2641
2642 </refsect1>
2643
2644 <refsect1>
2645 <title>See Also</title>
2646 <para>
2647 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2648 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2649 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2650 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2651 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2652 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2653 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2654 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2655 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2656 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2657 <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2658 <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2659 <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2660 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2661 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2662 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2663 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2664 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2665 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2666 <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>1</manvolnum></citerefentry>
2667 </para>
2668 </refsect1>
2669
2670 </refentry>