Debian Codegraph @

upstream/debian-trixie/man5/systemd.unit.5

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