]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.xml
Merge pull request #11827 from keszybz/pkgconfig-variables
[thirdparty/systemd.git] / man / systemd.xml
CommitLineData
514094f9 1<?xml version='1.0'?>
9e632bf7 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
9e632bf7
LP
4
5<!--
572eb058 6 SPDX-License-Identifier: LGPL-2.1+
9e632bf7
LP
7-->
8
dfdebb1b 9<refentry id="systemd"
798d3a52
ZJS
10 xmlns:xi="http://www.w3.org/2001/XInclude">
11
12 <refentryinfo>
13 <title>systemd</title>
14 <productname>systemd</productname>
798d3a52
ZJS
15 </refentryinfo>
16
17 <refmeta>
18 <refentrytitle>systemd</refentrytitle>
19 <manvolnum>1</manvolnum>
20 </refmeta>
21
22 <refnamediv>
23 <refname>systemd</refname>
24 <refname>init</refname>
25 <refpurpose>systemd system and service manager</refpurpose>
26 </refnamediv>
27
28 <refsynopsisdiv>
29 <cmdsynopsis>
b57b372a 30 <command>/usr/lib/systemd/systemd</command>
770c4777 31 <arg choice="opt" rep="repeat">OPTIONS</arg>
798d3a52
ZJS
32 </cmdsynopsis>
33 <cmdsynopsis>
770c4777
ZJS
34 <command>init</command>
35 <arg choice="opt" rep="repeat">OPTIONS</arg>
36 <arg choice="req">COMMAND</arg>
798d3a52
ZJS
37 </cmdsynopsis>
38 </refsynopsisdiv>
39
40 <refsect1>
41 <title>Description</title>
42
43 <para>systemd is a system and service manager for Linux operating
44 systems. When run as first process on boot (as PID 1), it acts as
45 init system that brings up and maintains userspace
46 services.</para>
47
48 <para>For compatibility with SysV, if systemd is called as
49 <command>init</command> and a PID that is not 1, it will execute
50 <command>telinit</command> and pass all command line arguments
51 unmodified. That means <command>init</command> and
52 <command>telinit</command> are mostly equivalent when invoked from
53 normal login sessions. See
54 <citerefentry><refentrytitle>telinit</refentrytitle><manvolnum>8</manvolnum></citerefentry>
55 for more information.</para>
56
57 <para>When run as a system instance, systemd interprets the
58 configuration file <filename>system.conf</filename> and the files
59 in <filename>system.conf.d</filename> directories; when run as a
60 user instance, systemd interprets the configuration file
61 <filename>user.conf</filename> and the files in
62 <filename>user.conf.d</filename> directories. See
63 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
64 for more information.</para>
65 </refsect1>
66
67 <refsect1>
68 <title>Options</title>
69
70 <para>The following options are understood:</para>
71
72 <variablelist>
73 <varlistentry>
74 <term><option>--test</option></term>
75
76 <listitem><para>Determine startup sequence, dump it and exit.
77 This is an option useful for debugging only.</para></listitem>
78 </varlistentry>
79 <varlistentry>
80 <term><option>--dump-configuration-items</option></term>
81
82 <listitem><para>Dump understood unit configuration items. This
83 outputs a terse but complete list of configuration items
84 understood in unit definition files.</para></listitem>
85 </varlistentry>
bbc1acab
YW
86 <varlistentry>
87 <term><option>--dump-bus-properties</option></term>
88
89 <listitem><para>Dump exposed bus properties. This outputs
90 a terse but complete list of properties exposed to dbus.
91 </para></listitem>
92 </varlistentry>
798d3a52
ZJS
93 <varlistentry>
94 <term><option>--unit=</option></term>
95
96 <listitem><para>Set default unit to activate on startup. If
97 not specified, defaults to
98 <filename>default.target</filename>.</para></listitem>
99 </varlistentry>
100 <varlistentry>
101 <term><option>--system</option></term>
102 <term><option>--user</option></term>
103
104 <listitem><para>For <option>--system</option>, tell systemd to
105 run a system instance, even if the process ID is not 1, i.e.
106 systemd is not run as init process. <option>--user</option>
107 does the opposite, running a user instance even if the process
b938cb90 108 ID is 1. Normally, it should not be necessary to pass these
798d3a52
ZJS
109 options, as systemd automatically detects the mode it is
110 started in. These options are hence of little use except for
111 debugging. Note that it is not supported booting and
112 maintaining a full system with systemd running in
113 <option>--system</option> mode, but PID not 1. In practice,
114 passing <option>--system</option> explicitly is only useful in
115 conjunction with <option>--test</option>.</para></listitem>
116 </varlistentry>
117 <varlistentry>
118 <term><option>--dump-core</option></term>
119
b9e74c39
LP
120 <listitem><para>Enable core dumping on crash. This switch has
121 no effect when running as user instance. This setting may also
122 be enabled during boot on the kernel command line via the
123 <varname>systemd.dump_core=</varname> option, see
124 below.</para></listitem>
798d3a52 125 </varlistentry>
b9e74c39
LP
126
127 <varlistentry>
128 <term><option>--crash-vt=</option><replaceable>VT</replaceable></term>
129
130 <listitem><para>Switch to a specific virtual console (VT) on
b938cb90 131 crash. Takes a positive integer in the range 1–63, or a
b9e74c39
LP
132 boolean argument. If an integer is passed, selects which VT to
133 switch to. If <constant>yes</constant>, the VT kernel messages
134 are written to is selected. If <constant>no</constant>, no VT
135 switch is attempted. This switch has no effect when running as
136 user instance. This setting may also be enabled during boot,
137 on the kernel command line via the
138 <varname>systemd.crash_vt=</varname> option, see
770c4777 139 <!-- FIXME: there is no crash_vt command line option? -->
b9e74c39
LP
140 below.</para></listitem>
141 </varlistentry>
142
798d3a52
ZJS
143 <varlistentry>
144 <term><option>--crash-shell</option></term>
145
b9e74c39
LP
146 <listitem><para>Run a shell on crash. This switch has no
147 effect when running as user instance. This setting may also be
148 enabled during boot, on the kernel command line via the
149 <varname>systemd.crash_shell=</varname> option, see
150 below.</para></listitem>
798d3a52 151 </varlistentry>
b9e74c39
LP
152
153 <varlistentry>
154 <term><option>--crash-reboot</option></term>
155
156 <listitem><para>Automatically reboot the system on crash. This
157 switch has no effect when running as user instance. This
158 setting may also be enabled during boot, on the kernel command
159 line via the <varname>systemd.crash_reboot=</varname> option,
160 see below.</para></listitem>
161 </varlistentry>
162
798d3a52
ZJS
163 <varlistentry>
164 <term><option>--confirm-spawn</option></term>
165
166 <listitem><para>Ask for confirmation when spawning processes.
167 This switch has no effect when run as user
168 instance.</para></listitem>
169 </varlistentry>
170 <varlistentry>
171 <term><option>--show-status=</option></term>
172
33fc1800
LP
173 <listitem><para>Takes a boolean argument or the special value <constant>auto</constant>. If on, terse unit
174 status information is shown on the console during boot-up and shutdown. If off, no such status information is
175 shown. If set to <constant>auto</constant> behavior is similar to off, except that it is automatically switched
176 to on, as soon as the first unit failure or significant boot delay is encountered. This switch has no effect
177 when invoked as user instance. If specified, overrides both the kernel command line setting
178 <varname>systemd.show_status=</varname> (see below) and the configuration file option
179 <option>ShowStatus=</option>, see
180 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
798d3a52
ZJS
181 </varlistentry>
182 <varlistentry>
183 <term><option>--log-target=</option></term>
184
185 <listitem><para>Set log target. Argument must be one of
186 <option>console</option>,
187 <option>journal</option>,
188 <option>kmsg</option>,
189 <option>journal-or-kmsg</option>,
190 <option>null</option>.</para></listitem>
191 </varlistentry>
192 <varlistentry>
193 <term><option>--log-level=</option></term>
194
195 <listitem><para>Set log level. As
196 argument this accepts a numerical log
197 level or the well-known <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
198 symbolic names (lowercase):
199 <option>emerg</option>,
200 <option>alert</option>,
201 <option>crit</option>,
202 <option>err</option>,
203 <option>warning</option>,
204 <option>notice</option>,
205 <option>info</option>,
206 <option>debug</option>.</para></listitem>
207 </varlistentry>
208 <varlistentry>
209 <term><option>--log-color=</option></term>
210
211 <listitem><para>Highlight important log messages. Argument is
212 a boolean value. If the argument is omitted, it defaults to
213 <option>true</option>.</para></listitem>
214 </varlistentry>
215 <varlistentry>
216 <term><option>--log-location=</option></term>
217
218 <listitem><para>Include code location in log messages. This is
219 mostly relevant for debugging purposes. Argument is a boolean
220 value. If the argument is omitted it defaults to
221 <option>true</option>.</para></listitem>
222 </varlistentry>
223 <varlistentry>
224 <term><option>--default-standard-output=</option></term>
225 <term><option>--default-standard-error=</option></term>
226
227 <listitem><para>Sets the default output or error output for
228 all services and sockets, respectively. That is, controls the
229 default for <option>StandardOutput=</option> and
230 <option>StandardError=</option> (see
231 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
232 for details). Takes one of
233 <option>inherit</option>,
234 <option>null</option>,
235 <option>tty</option>,
236 <option>journal</option>,
237 <option>journal+console</option>,
238 <option>syslog</option>,
239 <option>syslog+console</option>,
240 <option>kmsg</option>,
241 <option>kmsg+console</option>. If the
242 argument is omitted
243 <option>--default-standard-output=</option> defaults to
244 <option>journal</option> and
245 <option>--default-standard-error=</option> to
246 <option>inherit</option>.</para></listitem>
247 </varlistentry>
248
ee48dbd5
NC
249 <varlistentry>
250 <term><option>--machine-id=</option></term>
251
252 <listitem><para>Override the machine-id set on the hard drive,
b8e1d4d1 253 useful for network booting or for containers. May not be set
ee48dbd5
NC
254 to all zeros.</para></listitem>
255 </varlistentry>
256
2a12e32e
JK
257 <varlistentry>
258 <term><option>--service-watchdogs=</option></term>
259
260 <listitem><para>Globally enable/disable all service watchdog timeouts and emergency
261 actions. This setting may also be specified during boot, on the kernel
262 command line via the <varname>systemd.service_watchdogs=</varname>
263 option, see below. Defaults to enabled.</para></listitem>
264 </varlistentry>
265
798d3a52
ZJS
266 <xi:include href="standard-options.xml" xpointer="help" />
267 <xi:include href="standard-options.xml" xpointer="version" />
268 </variablelist>
269 </refsect1>
270
271 <refsect1>
272 <title>Concepts</title>
273
274 <para>systemd provides a dependency system between various
19f0cf65 275 entities called "units" of 11 different types. Units encapsulate
798d3a52
ZJS
276 various objects that are relevant for system boot-up and
277 maintenance. The majority of units are configured in unit
278 configuration files, whose syntax and basic set of options is
279 described in
280 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
281 however some are created automatically from other configuration,
282 dynamically from system state or programmatically at runtime.
1eecafb8 283 Units may be "active" (meaning started, bound, plugged in, …,
798d3a52 284 depending on the unit type, see below), or "inactive" (meaning
1eecafb8 285 stopped, unbound, unplugged, …), as well as in the process of
798d3a52
ZJS
286 being activated or deactivated, i.e. between the two states (these
287 states are called "activating", "deactivating"). A special
288 "failed" state is available as well, which is very similar to
289 "inactive" and is entered when the service failed in some way
bd2538b5
KBM
290 (process returned error code on exit, or crashed, an operation
291 timed out, or after too many restarts). If this state is entered,
292 the cause will be logged, for later reference. Note that the
293 various unit types may have a number of additional substates,
294 which are mapped to the five generalized unit states described
295 here.</para>
798d3a52
ZJS
296
297 <para>The following unit types are available:</para>
298
299 <orderedlist>
300 <listitem><para>Service units, which start and control daemons
b938cb90 301 and the processes they consist of. For details, see
798d3a52
ZJS
302 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
303
304 <listitem><para>Socket units, which encapsulate local IPC or
305 network sockets in the system, useful for socket-based
b938cb90 306 activation. For details about socket units, see
798d3a52
ZJS
307 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
308 for details on socket-based activation and other forms of
309 activation, see
310 <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem>
311
312 <listitem><para>Target units are useful to group units, or
313 provide well-known synchronization points during boot-up, see
314 <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
315
316 <listitem><para>Device units expose kernel devices in systemd
317 and may be used to implement device-based activation. For
b938cb90 318 details, see
798d3a52
ZJS
319 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
320
321 <listitem><para>Mount units control mount points in the file
322 system, for details see
323 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
324
325 <listitem><para>Automount units provide automount capabilities,
326 for on-demand mounting of file systems as well as parallelized
327 boot-up. See
328 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
798d3a52
ZJS
329
330 <listitem><para>Timer units are useful for triggering activation
331 of other units based on timers. You may find details in
332 <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
333
334 <listitem><para>Swap units are very similar to mount units and
335 encapsulate memory swap partitions or files of the operating
336 system. They are described in
337 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
338
339 <listitem><para>Path units may be used to activate other
340 services when file system objects change or are modified. See
341 <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
342
343 <listitem><para>Slice units may be used to group units which
344 manage system processes (such as service and scope units) in a
345 hierarchical tree for resource management purposes. See
346 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
347
348 <listitem><para>Scope units are similar to service units, but
349 manage foreign processes instead of starting them as well. See
350 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
351
352 </orderedlist>
353
354 <para>Units are named as their configuration files. Some units
355 have special semantics. A detailed list is available in
356 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
357
358 <para>systemd knows various kinds of dependencies, including
359 positive and negative requirement dependencies (i.e.
360 <varname>Requires=</varname> and <varname>Conflicts=</varname>) as
361 well as ordering dependencies (<varname>After=</varname> and
362 <varname>Before=</varname>). NB: ordering and requirement
363 dependencies are orthogonal. If only a requirement dependency
364 exists between two units (e.g. <filename>foo.service</filename>
365 requires <filename>bar.service</filename>), but no ordering
366 dependency (e.g. <filename>foo.service</filename> after
367 <filename>bar.service</filename>) and both are requested to start,
368 they will be started in parallel. It is a common pattern that both
369 requirement and ordering dependencies are placed between two
370 units. Also note that the majority of dependencies are implicitly
371 created and maintained by systemd. In most cases, it should be
372 unnecessary to declare additional dependencies manually, however
373 it is possible to do this.</para>
374
375 <para>Application programs and units (via dependencies) may
376 request state changes of units. In systemd, these requests are
377 encapsulated as 'jobs' and maintained in a job queue. Jobs may
378 succeed or can fail, their execution is ordered based on the
379 ordering dependencies of the units they have been scheduled
380 for.</para>
381
382 <para>On boot systemd activates the target unit
383 <filename>default.target</filename> whose job is to activate
384 on-boot services and other on-boot units by pulling them in via
b938cb90 385 dependencies. Usually, the unit name is just an alias (symlink) for
798d3a52
ZJS
386 either <filename>graphical.target</filename> (for fully-featured
387 boots into the UI) or <filename>multi-user.target</filename> (for
388 limited console-only boots for use in embedded or server
389 environments, or similar; a subset of graphical.target). However,
390 it is at the discretion of the administrator to configure it as an
391 alias to any other target unit. See
392 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
393 for details about these target units.</para>
394
e5b62c9b
LP
395 <para>systemd only keeps a minimal set of units loaded into memory. Specifically, the only units that are kept
396 loaded into memory are those for which at least one of the following conditions is true:</para>
397
398 <orderedlist>
05d4db20 399 <listitem><para>It is in an active, activating, deactivating or failed state (i.e. in any unit state except for <literal>inactive</literal>)</para></listitem>
e5b62c9b
LP
400 <listitem><para>It has a job queued for it</para></listitem>
401 <listitem><para>It is a dependency of some sort of at least one other unit that is loaded into memory</para></listitem>
402 <listitem><para>It has some form of resource still allocated (e.g. a service unit that is inactive but for which
403 a process is still lingering that ignored the request to be terminated)</para></listitem>
404 <listitem><para>It has been pinned into memory programmatically by a D-Bus call</para></listitem>
405 </orderedlist>
406
407 <para>systemd will automatically and implicitly load units from disk — if they are not loaded yet — as soon as
408 operations are requested for them. Thus, in many respects, the fact whether a unit is loaded or not is invisible to
409 clients. Use <command>systemctl list-units --all</command> to comprehensively list all units currently loaded. Any
410 unit for which none of the conditions above applies is promptly unloaded. Note that when a unit is unloaded from
411 memory its accounting data is flushed out too. However, this data is generally not lost, as a journal log record
412 is generated declaring the consumed resources whenever a unit shuts down.</para>
413
798d3a52
ZJS
414 <para>Processes systemd spawns are placed in individual Linux
415 control groups named after the unit which they belong to in the
416 private systemd hierarchy. (see <ulink
3c887f97 417 url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>
798d3a52
ZJS
418 for more information about control groups, or short "cgroups").
419 systemd uses this to effectively keep track of processes. Control
420 group information is maintained in the kernel, and is accessible
421 via the file system hierarchy (beneath
422 <filename>/sys/fs/cgroup/systemd/</filename>), or in tools such as
f4b8163b
EV
423 <citerefentry project='man-pages'><refentrytitle>systemd-cgls</refentrytitle><manvolnum>1</manvolnum></citerefentry>
424 or
798d3a52
ZJS
425 <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
426 (<command>ps xawf -eo pid,user,cgroup,args</command> is
427 particularly useful to list all processes and the systemd units
428 they belong to.).</para>
429
430 <para>systemd is compatible with the SysV init system to a large
431 degree: SysV init scripts are supported and simply read as an
432 alternative (though limited) configuration file format. The SysV
433 <filename>/dev/initctl</filename> interface is provided, and
434 compatibility implementations of the various SysV client tools are
435 available. In addition to that, various established Unix
436 functionality such as <filename>/etc/fstab</filename> or the
437 <filename>utmp</filename> database are supported.</para>
438
439 <para>systemd has a minimal transaction system: if a unit is
440 requested to start up or shut down it will add it and all its
441 dependencies to a temporary transaction. Then, it will verify if
442 the transaction is consistent (i.e. whether the ordering of all
443 units is cycle-free). If it is not, systemd will try to fix it up,
444 and removes non-essential jobs from the transaction that might
445 remove the loop. Also, systemd tries to suppress non-essential
446 jobs in the transaction that would stop a running service. Finally
447 it is checked whether the jobs of the transaction contradict jobs
448 that have already been queued, and optionally the transaction is
449 aborted then. If all worked out and the transaction is consistent
450 and minimized in its impact it is merged with all already
451 outstanding jobs and added to the run queue. Effectively this
452 means that before executing a requested operation, systemd will
453 verify that it makes sense, fixing it if possible, and only
454 failing if it really cannot work.</para>
92e29d82 455
05d4db20
JK
456 <para>Note that transactions are generated independently of a unit's
457 state at runtime, hence, for example, if a start job is requested on an
458 already started unit, it will still generate a transaction and wake up any
459 inactive dependencies (and cause propagation of other jobs as per the
460 defined relationships). This is because the enqueued job is at the time of
461 execution compared to the target unit's state and is marked successful and
462 complete when both satisfy. However, this job also pulls in other
463 dependencies due to the defined relationships and thus leads to, in our
464 our example, start jobs for any of those inactive units getting queued as
465 well.</para>
798d3a52 466
f95b0be7 467 <para>systemd contains native implementations of various tasks
798d3a52
ZJS
468 that need to be executed as part of the boot process. For example,
469 it sets the hostname or configures the loopback network device. It
470 also sets up and mounts various API file systems, such as
471 <filename>/sys</filename> or <filename>/proc</filename>.</para>
472
473 <para>For more information about the concepts and
474 ideas behind systemd, please refer to the
475 <ulink url="http://0pointer.de/blog/projects/systemd.html">Original Design Document</ulink>.</para>
476
477 <para>Note that some but not all interfaces provided
478 by systemd are covered by the
28a0ad81 479 <ulink url="https://www.freedesktop.org/wiki/Software/systemd/InterfaceStabilityPromise">Interface
798d3a52
ZJS
480 Stability Promise</ulink>.</para>
481
482 <para>Units may be generated dynamically at boot and system
483 manager reload time, for example based on other configuration
b938cb90 484 files or parameters passed on the kernel command line. For details, see
b1c1a519 485 <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
798d3a52
ZJS
486
487 <para>Systems which invoke systemd in a container or initrd
488 environment should implement the
28a0ad81
DR
489 <ulink url="https://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container Interface</ulink> or
490 <ulink url="https://www.freedesktop.org/wiki/Software/systemd/InitrdInterface">initrd Interface</ulink>
798d3a52
ZJS
491 specifications, respectively.</para>
492 </refsect1>
493
494 <refsect1>
495 <title>Directories</title>
496
497 <variablelist>
498 <varlistentry>
499 <term>System unit directories</term>
500
501 <listitem><para>The systemd system manager reads unit
502 configuration from various directories. Packages that want to
503 install unit files shall place them in the directory returned
504 by <command>pkg-config systemd
505 --variable=systemdsystemunitdir</command>. Other directories
506 checked are <filename>/usr/local/lib/systemd/system</filename>
12b42c76 507 and <filename>/usr/lib/systemd/system</filename>. User
798d3a52
ZJS
508 configuration always takes precedence. <command>pkg-config
509 systemd --variable=systemdsystemconfdir</command> returns the
510 path of the system configuration directory. Packages should
511 alter the content of these directories only with the
512 <command>enable</command> and <command>disable</command>
513 commands of the
514 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
515 tool. Full list of directories is provided in
516 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
517 </para></listitem>
518 </varlistentry>
519 </variablelist>
520
521 <variablelist>
522 <varlistentry>
523 <term>User unit directories</term>
524
525 <listitem><para>Similar rules apply for the user unit
526 directories. However, here the
527 <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
528 Base Directory specification</ulink> is followed to find
529 units. Applications should place their unit files in the
530 directory returned by <command>pkg-config systemd
531 --variable=systemduserunitdir</command>. Global configuration
532 is done in the directory reported by <command>pkg-config
533 systemd --variable=systemduserconfdir</command>. The
534 <command>enable</command> and <command>disable</command>
535 commands of the
536 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
537 tool can handle both global (i.e. for all users) and private
538 (for one user) enabling/disabling of units. Full list of
539 directories is provided in
540 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
541 </para></listitem>
542 </varlistentry>
543 </variablelist>
544
545 <variablelist>
546 <varlistentry>
547 <term>SysV init scripts directory</term>
548
549 <listitem><para>The location of the SysV init script directory
550 varies between distributions. If systemd cannot find a native
551 unit file for a requested service, it will look for a SysV
552 init script of the same name (with the
553 <filename>.service</filename> suffix
554 removed).</para></listitem>
555 </varlistentry>
556 </variablelist>
557
558 <variablelist>
559 <varlistentry>
560 <term>SysV runlevel link farm directory</term>
561
562 <listitem><para>The location of the SysV runlevel link farm
563 directory varies between distributions. systemd will take the
564 link farm into account when figuring out whether a service
565 shall be enabled. Note that a service unit with a native unit
566 configuration file cannot be started by activating it in the
567 SysV runlevel link farm.</para></listitem>
568 </varlistentry>
569 </variablelist>
570 </refsect1>
571
572 <refsect1>
573 <title>Signals</title>
574
575 <variablelist>
576 <varlistentry>
577 <term><constant>SIGTERM</constant></term>
578
579 <listitem><para>Upon receiving this signal the systemd system
580 manager serializes its state, reexecutes itself and
581 deserializes the saved state again. This is mostly equivalent
582 to <command>systemctl daemon-reexec</command>.</para>
583
584 <para>systemd user managers will start the
585 <filename>exit.target</filename> unit when this signal is
586 received. This is mostly equivalent to <command>systemctl
d60cb656
AJ
587 --user start exit.target
588 --job-mode=replace-irreversible</command>.</para></listitem>
798d3a52
ZJS
589 </varlistentry>
590
591 <varlistentry>
592 <term><constant>SIGINT</constant></term>
593
84afbbcf
ZJS
594 <listitem><para>Upon receiving this signal the systemd system manager will start the
595 <filename>ctrl-alt-del.target</filename> unit. This is mostly equivalent to
596 <command>systemctl start ctrl-alt-del.target --job-mode=replace-irreversible</command>. If
597 this signal is received more than 7 times per 2s, an immediate reboot is triggered. Note
598 that pressing
599 <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Del</keycap></keycombo> on the
600 console will trigger this signal. Hence, if a reboot is hanging, pressing
601 <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Del</keycap></keycombo> more than
602 7 times in 2 seconds is a relatively safe way to trigger an immediate reboot.</para>
798d3a52
ZJS
603
604 <para>systemd user managers treat this signal the same way as
605 <constant>SIGTERM</constant>.</para></listitem>
606 </varlistentry>
607
608 <varlistentry>
609 <term><constant>SIGWINCH</constant></term>
610
611 <listitem><para>When this signal is received the systemd
612 system manager will start the
613 <filename>kbrequest.target</filename> unit. This is mostly
614 equivalent to <command>systemctl start
615 kbrequest.target</command>.</para>
616
617 <para>This signal is ignored by systemd user
618 managers.</para></listitem>
619 </varlistentry>
620
621 <varlistentry>
622 <term><constant>SIGPWR</constant></term>
623
624 <listitem><para>When this signal is received the systemd
625 manager will start the <filename>sigpwr.target</filename>
626 unit. This is mostly equivalent to <command>systemctl start
627 sigpwr.target</command>.</para></listitem>
628 </varlistentry>
629
630 <varlistentry>
631 <term><constant>SIGUSR1</constant></term>
632
633 <listitem><para>When this signal is received the systemd
634 manager will try to reconnect to the D-Bus
635 bus.</para></listitem>
636 </varlistentry>
637
638 <varlistentry>
639 <term><constant>SIGUSR2</constant></term>
640
641 <listitem><para>When this signal is received the systemd
b938cb90 642 manager will log its complete state in human-readable form.
798d3a52
ZJS
643 The data logged is the same as printed by
644 <command>systemd-analyze dump</command>.</para></listitem>
645 </varlistentry>
646
647 <varlistentry>
648 <term><constant>SIGHUP</constant></term>
649
650 <listitem><para>Reloads the complete daemon configuration.
651 This is mostly equivalent to <command>systemctl
652 daemon-reload</command>.</para></listitem>
653 </varlistentry>
654
655 <varlistentry>
656 <term><constant>SIGRTMIN+0</constant></term>
657
658 <listitem><para>Enters default mode, starts the
659 <filename>default.target</filename> unit. This is mostly
d60cb656 660 equivalent to <command>systemctl isolate
798d3a52
ZJS
661 default.target</command>.</para></listitem>
662 </varlistentry>
663
664 <varlistentry>
665 <term><constant>SIGRTMIN+1</constant></term>
666
667 <listitem><para>Enters rescue mode, starts the
668 <filename>rescue.target</filename> unit. This is mostly
669 equivalent to <command>systemctl isolate
670 rescue.target</command>.</para></listitem>
671 </varlistentry>
672
673 <varlistentry>
674 <term><constant>SIGRTMIN+2</constant></term>
675
676 <listitem><para>Enters emergency mode, starts the
677 <filename>emergency.service</filename> unit. This is mostly
678 equivalent to <command>systemctl isolate
679 emergency.service</command>.</para></listitem>
680 </varlistentry>
681
682 <varlistentry>
683 <term><constant>SIGRTMIN+3</constant></term>
684
685 <listitem><para>Halts the machine, starts the
686 <filename>halt.target</filename> unit. This is mostly
d60cb656
AJ
687 equivalent to <command>systemctl start halt.target
688 --job-mode=replace-irreversible</command>.</para>
689 </listitem>
798d3a52
ZJS
690 </varlistentry>
691
692 <varlistentry>
693 <term><constant>SIGRTMIN+4</constant></term>
694
695 <listitem><para>Powers off the machine, starts the
696 <filename>poweroff.target</filename> unit. This is mostly
d60cb656
AJ
697 equivalent to <command>systemctl start poweroff.target
698 --job-mode=replace-irreversible</command>.</para>
699 </listitem>
798d3a52
ZJS
700 </varlistentry>
701
702 <varlistentry>
703 <term><constant>SIGRTMIN+5</constant></term>
704
705 <listitem><para>Reboots the machine, starts the
706 <filename>reboot.target</filename> unit. This is mostly
d60cb656
AJ
707 equivalent to <command>systemctl start reboot.target
708 --job-mode=replace-irreversible</command>.</para>
709 </listitem>
798d3a52
ZJS
710 </varlistentry>
711
712 <varlistentry>
713 <term><constant>SIGRTMIN+6</constant></term>
714
715 <listitem><para>Reboots the machine via kexec, starts the
716 <filename>kexec.target</filename> unit. This is mostly
d60cb656
AJ
717 equivalent to <command>systemctl start kexec.target
718 --job-mode=replace-irreversible</command>.</para>
719 </listitem>
798d3a52
ZJS
720 </varlistentry>
721
722 <varlistentry>
723 <term><constant>SIGRTMIN+13</constant></term>
724
725 <listitem><para>Immediately halts the machine.</para></listitem>
726 </varlistentry>
727
728 <varlistentry>
729 <term><constant>SIGRTMIN+14</constant></term>
730
731 <listitem><para>Immediately powers off the machine.</para></listitem>
732 </varlistentry>
733
734 <varlistentry>
735 <term><constant>SIGRTMIN+15</constant></term>
736
737 <listitem><para>Immediately reboots the machine.</para></listitem>
738 </varlistentry>
739
740 <varlistentry>
741 <term><constant>SIGRTMIN+16</constant></term>
742
743 <listitem><para>Immediately reboots the machine with kexec.</para></listitem>
744 </varlistentry>
745
746 <varlistentry>
747 <term><constant>SIGRTMIN+20</constant></term>
748
749 <listitem><para>Enables display of status messages on the
750 console, as controlled via
751 <varname>systemd.show_status=1</varname> on the kernel command
752 line.</para></listitem>
753 </varlistentry>
754
755 <varlistentry>
756 <term><constant>SIGRTMIN+21</constant></term>
757
758 <listitem><para>Disables display of
759 status messages on the console, as
760 controlled via
761 <varname>systemd.show_status=0</varname>
762 on the kernel command
763 line.</para></listitem>
764 </varlistentry>
765
766 <varlistentry>
767 <term><constant>SIGRTMIN+22</constant></term>
a6ecbf83
FB
768
769 <listitem><para>Sets the service manager's log level to <literal>debug</literal>, in a fashion equivalent to
770 <varname>systemd.log_level=debug</varname> on the kernel command line.</para></listitem>
771 </varlistentry>
772
773 <varlistentry>
798d3a52
ZJS
774 <term><constant>SIGRTMIN+23</constant></term>
775
a6ecbf83
FB
776 <listitem><para>Restores the log level to its configured value. The configured value is derived from – in order
777 of priority – the value specified with <varname>systemd.log-level=</varname> on the kernel command line, or the
778 value specified with <option>LogLevel=</option> in the configuration file, or the built-in default of
779 <literal>info</literal>.</para></listitem>
798d3a52
ZJS
780 </varlistentry>
781
782 <varlistentry>
783 <term><constant>SIGRTMIN+24</constant></term>
784
785 <listitem><para>Immediately exits the manager (only available
786 for --user instances).</para></listitem>
787 </varlistentry>
788
789 <varlistentry>
790 <term><constant>SIGRTMIN+26</constant></term>
bda7d78b
FB
791
792 <listitem><para>Restores the log target to its configured value. The configured value is derived from – in
793 order of priority – the value specified with <varname>systemd.log-target=</varname> on the kernel command line,
794 or the value specified with <option>LogTarget=</option> in the configuration file, or the built-in
795 default.</para></listitem>
796 </varlistentry>
797
798 <varlistentry>
798d3a52
ZJS
799 <term><constant>SIGRTMIN+27</constant></term>
800 <term><constant>SIGRTMIN+28</constant></term>
801
bda7d78b
FB
802 <listitem><para>Sets the log target to <literal>console</literal> on <constant>SIGRTMIN+27</constant> (or
803 <literal>kmsg</literal> on <constant>SIGRTMIN+28</constant>), in a fashion equivalent to
804 <varname>systemd.log_target=console</varname> (or <varname>systemd.log_target=kmsg</varname> on
805 <constant>SIGRTMIN+28</constant>) on the kernel command line.</para></listitem>
798d3a52
ZJS
806 </varlistentry>
807 </variablelist>
808 </refsect1>
809
810 <refsect1>
811 <title>Environment</title>
812
813 <variablelist class='environment-variables'>
814 <varlistentry>
815 <term><varname>$SYSTEMD_LOG_LEVEL</varname></term>
816 <listitem><para>systemd reads the log level from this
817 environment variable. This can be overridden with
818 <option>--log-level=</option>.</para></listitem>
819 </varlistentry>
820
821 <varlistentry>
822 <term><varname>$SYSTEMD_LOG_TARGET</varname></term>
823 <listitem><para>systemd reads the log target from this
824 environment variable. This can be overridden with
825 <option>--log-target=</option>.</para></listitem>
826 </varlistentry>
827
828 <varlistentry>
829 <term><varname>$SYSTEMD_LOG_COLOR</varname></term>
830 <listitem><para>Controls whether systemd highlights important
831 log messages. This can be overridden with
832 <option>--log-color=</option>.</para></listitem>
833 </varlistentry>
834
835 <varlistentry>
836 <term><varname>$SYSTEMD_LOG_LOCATION</varname></term>
837 <listitem><para>Controls whether systemd prints the code
838 location along with log messages. This can be overridden with
839 <option>--log-location=</option>.</para></listitem>
840 </varlistentry>
841
842 <varlistentry>
843 <term><varname>$XDG_CONFIG_HOME</varname></term>
844 <term><varname>$XDG_CONFIG_DIRS</varname></term>
845 <term><varname>$XDG_DATA_HOME</varname></term>
846 <term><varname>$XDG_DATA_DIRS</varname></term>
847
848 <listitem><para>The systemd user manager uses these variables
849 in accordance to the <ulink
850 url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
851 Base Directory specification</ulink> to find its
852 configuration.</para></listitem>
853 </varlistentry>
854
855 <varlistentry>
856 <term><varname>$SYSTEMD_UNIT_PATH</varname></term>
857
858 <listitem><para>Controls where systemd looks for unit
859 files.</para></listitem>
860 </varlistentry>
861
862 <varlistentry>
863 <term><varname>$SYSTEMD_SYSVINIT_PATH</varname></term>
864
865 <listitem><para>Controls where systemd looks for SysV init
866 scripts.</para></listitem>
867 </varlistentry>
868
869 <varlistentry>
870 <term><varname>$SYSTEMD_SYSVRCND_PATH</varname></term>
871
872 <listitem><para>Controls where systemd looks for SysV init
873 script runlevel link farms.</para></listitem>
874 </varlistentry>
875
40c9fe4c
JS
876 <varlistentry>
877 <term><varname>$SYSTEMD_COLORS</varname></term>
878
acf553b0
ZJS
879 <listitem><para>The value must be a boolean. Controls whether colorized output should be
880 generated. This can be specified to override the decision that <command>systemd</command>
881 makes based on <varname>$TERM</varname> and what the console is connected to.</para>
882 </listitem>
40c9fe4c
JS
883 </varlistentry>
884
23b27b39
LP
885 <varlistentry>
886 <term><varname>$SYSTEMD_URLIFY</varname></term>
887
888 <listitem><para>The value must be a boolean. Controls whether clickable links should be generated in the output
889 for terminal emulators supporting this. This can be specified to override the decision that
890 <command>systemd</command> makes based on <varname>$TERM</varname> and other conditions.</para>
891 </listitem>
892 </varlistentry>
893
798d3a52
ZJS
894 <varlistentry>
895 <term><varname>$LISTEN_PID</varname></term>
896 <term><varname>$LISTEN_FDS</varname></term>
8dd4c05b 897 <term><varname>$LISTEN_FDNAMES</varname></term>
798d3a52
ZJS
898
899 <listitem><para>Set by systemd for supervised processes during
900 socket-based activation. See
901 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>
acf553b0 902 for more information.</para></listitem>
798d3a52
ZJS
903 </varlistentry>
904
905 <varlistentry>
906 <term><varname>$NOTIFY_SOCKET</varname></term>
907
908 <listitem><para>Set by systemd for supervised processes for
909 status and start-up completion notification. See
910 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
acf553b0 911 for more information.</para></listitem>
798d3a52
ZJS
912 </varlistentry>
913 </variablelist>
8ce202fa
LP
914
915 <para>For further environment variables understood by systemd and its various components, see <ulink
916 url="https://systemd.io/ENVIRONMENT">Known Environment Variables</ulink>.</para>
798d3a52
ZJS
917 </refsect1>
918
919 <refsect1>
920 <title>Kernel Command Line</title>
921
922 <para>When run as system instance systemd parses a number of
923 kernel command line arguments<footnote><para>If run inside a Linux
924 container these arguments may be passed as command line arguments
925 to systemd itself, next to any of the command line options listed
926 in the Options section above. If run outside of Linux containers,
927 these arguments are parsed from <filename>/proc/cmdline</filename>
928 instead.</para></footnote>:</para>
929
930 <variablelist class='kernel-commandline-options'>
931 <varlistentry>
932 <term><varname>systemd.unit=</varname></term>
933 <term><varname>rd.systemd.unit=</varname></term>
934
935 <listitem><para>Overrides the unit to activate on boot.
936 Defaults to <filename>default.target</filename>. This may be
937 used to temporarily boot into a different boot unit, for
938 example <filename>rescue.target</filename> or
939 <filename>emergency.service</filename>. See
940 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
941 for details about these units. The option prefixed with
942 <literal>rd.</literal> is honored only in the initial RAM disk
943 (initrd), while the one that is not prefixed only in the main
944 system.</para></listitem>
945 </varlistentry>
946
947 <varlistentry>
770c4777 948 <term><varname>systemd.dump_core</varname></term>
798d3a52 949
770c4777
ZJS
950 <listitem><para>Takes a boolean argument or enables the option if specified
951 without an argument. If enabled, the systemd manager (PID 1) dumps core when
952 it crashes. Otherwise, no core dump is created. Defaults to enabled.</para>
953 </listitem>
b9e74c39
LP
954 </varlistentry>
955
956 <varlistentry>
770c4777 957 <term><varname>systemd.crash_chvt</varname></term>
b9e74c39 958
770c4777
ZJS
959 <listitem><para>Takes a positive integer, or a boolean argument. Can be also
960 specified without an argument, with the same effect as a positive boolean. If
961 a positive integer (in the range 1–63) is specified, the system manager (PID
962 1) will activate the specified virtual terminal (VT) when it
963 crashes. Defaults to disabled, meaning that no such switch is attempted. If
964 set to enabled, the VT the kernel messages are written to is selected.
965 </para></listitem>
798d3a52
ZJS
966 </varlistentry>
967
968 <varlistentry>
770c4777 969 <term><varname>systemd.crash_shell</varname></term>
798d3a52 970
770c4777
ZJS
971 <listitem><para>Takes a boolean argument or enables the option if specified
972 without an argument. If enabled, the system manager (PID 1) spawns a shell
973 when it crashes, after a 10s delay. Otherwise, no shell is spawned. Defaults
974 to disabled, for security reasons, as the shell is not protected by password
798d3a52
ZJS
975 authentication.</para></listitem>
976 </varlistentry>
977
978 <varlistentry>
770c4777 979 <term><varname>systemd.crash_reboot</varname></term>
798d3a52 980
770c4777
ZJS
981 <listitem><para>Takes a boolean argument or enables the option if specified
982 without an argument. If enabled, the system manager (PID 1) will reboot the
983 machine automatically when it crashes, after a 10s delay. Otherwise, the
984 system will hang indefinitely. Defaults to disabled, in order to avoid a
985 reboot loop. If combined with <varname>systemd.crash_shell</varname>, the
4cf0b03b 986 system is rebooted after the shell exits.</para></listitem>
798d3a52
ZJS
987 </varlistentry>
988
989 <varlistentry>
770c4777 990 <term><varname>systemd.confirm_spawn</varname></term>
798d3a52 991
770c4777
ZJS
992 <listitem><para>Takes a boolean argument or a path to the virtual console
993 where the confirmation messages should be emitted. Can be also specified
994 without an argument, with the same effect as a positive boolean. If enabled,
995 the system manager (PID 1) asks for confirmation when spawning processes
996 using <option>/dev/console</option>. If a path or a console name (such as
997 <literal>ttyS0</literal>) is provided, the virtual console pointed to by this
998 path or described by the give name will be used instead. Defaults to disabled.
999 </para></listitem>
798d3a52
ZJS
1000 </varlistentry>
1001
2a12e32e
JK
1002 <varlistentry>
1003 <term><varname>systemd.service_watchdogs=</varname></term>
1004
1005 <listitem><para>Takes a boolean argument. If disabled, all service runtime
1006 watchdogs (<option>WatchdogSec=</option>) and emergency actions (e.g.
1007 <option>OnFailure=</option> or <option>StartLimitAction=</option>) are
1008 ignored by the system manager (PID 1); see
1009 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1010 Defaults to enabled, i.e. watchdogs and failure actions are processed
1011 normally. The hardware watchdog is not affected by this
1012 option.</para></listitem>
1013 </varlistentry>
1014
798d3a52 1015 <varlistentry>
770c4777 1016 <term><varname>systemd.show_status</varname></term>
798d3a52 1017
770c4777
ZJS
1018 <listitem><para>Takes a boolean argument or the constant
1019 <constant>auto</constant>. Can be also specified without an argument, with
1020 the same effect as a positive boolean. If enabled, the systemd manager (PID
1021 1) shows terse service status updates on the console during bootup.
1022 <constant>auto</constant> behaves like <option>false</option> until a unit
1023 fails or there is a significant delay in boot. Defaults to enabled, unless
1024 <option>quiet</option> is passed as kernel command line option, in which case
1025 it defaults to <constant>auto</constant>. If specified overrides the system
1026 manager configuration file option <option>ShowStatus=</option>, see
1027 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1028 However, the process command line option <option>--show-status=</option>
1029 takes precedence over both this kernel command line option and the
1030 configuration file option.</para></listitem>
798d3a52
ZJS
1031 </varlistentry>
1032
1033 <varlistentry>
1034 <term><varname>systemd.log_target=</varname></term>
1035 <term><varname>systemd.log_level=</varname></term>
798d3a52 1036 <term><varname>systemd.log_location=</varname></term>
770c4777 1037 <term><varname>systemd.log_color</varname></term>
798d3a52 1038
770c4777
ZJS
1039 <listitem><para>Controls log output, with the same effect as the
1040 <varname>$SYSTEMD_LOG_TARGET</varname>,
798d3a52 1041 <varname>$SYSTEMD_LOG_LEVEL</varname>,
770c4777
ZJS
1042 <varname>$SYSTEMD_LOG_LOCATION</varname>,
1043 <varname>$SYSTEMD_LOG_COLOR</varname> environment variables described above.
1044 <varname>systemd.log_color</varname> can be specified without an argument,
1045 with the same effect as a positive boolean.</para></listitem>
798d3a52
ZJS
1046 </varlistentry>
1047
1048 <varlistentry>
1049 <term><varname>systemd.default_standard_output=</varname></term>
1050 <term><varname>systemd.default_standard_error=</varname></term>
1051 <listitem><para>Controls default standard output and error
1052 output for services, with the same effect as the
1053 <option>--default-standard-output=</option> and
1054 <option>--default-standard-error=</option> command line
1055 arguments described above, respectively.</para></listitem>
1056 </varlistentry>
1057
1058 <varlistentry>
1059 <term><varname>systemd.setenv=</varname></term>
1060
1061 <listitem><para>Takes a string argument in the form
1062 VARIABLE=VALUE. May be used to set default environment
1063 variables to add to forked child processes. May be used more
1064 than once to set multiple variables.</para></listitem>
1065 </varlistentry>
1066
ee48dbd5
NC
1067 <varlistentry>
1068 <term><varname>systemd.machine_id=</varname></term>
1069
1070 <listitem><para>Takes a 32 character hex value to be
1071 used for setting the machine-id. Intended mostly for
1072 network booting where the same machine-id is desired
1073 for every boot.</para></listitem>
1074 </varlistentry>
1075
ee075513
ZJS
1076 <varlistentry>
1077 <term><varname>systemd.unified_cgroup_hierarchy</varname></term>
1078
1079 <listitem><para>When specified without an argument or with a true argument,
1080 enables the usage of
1081 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">unified cgroup hierarchy</ulink>
1082 (a.k.a. cgroups-v2). When specified with a false argument, fall back to
1083 hybrid or full legacy cgroup hierarchy.</para>
1084
1085 <para>If this option is not specified, the default behaviour is determined
0fad72fa 1086 during compilation (the <option>-Ddefault-hierarchy=</option> meson
ee075513
ZJS
1087 option). If the kernel does not support unified cgroup hierarchy, the legacy
1088 hierarchy will be used even if this option is specified.</para>
1089 </listitem>
1090 </varlistentry>
1091
1092 <varlistentry>
1093 <term><varname>systemd.legacy_systemd_cgroup_controller</varname></term>
1094
1095 <listitem><para>Takes effect if the full unified cgroup hierarchy is not used
1096 (see previous option). When specified without an argument or with a true
1097 argument, disables the use of "hybrid" cgroup hierarchy (i.e. a cgroups-v2
1098 tree used for systemd, and
1099 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/">legacy
1100 cgroup hierarchy</ulink>, a.k.a. cgroups-v1, for other controllers), and
1101 forces a full "legacy" mode. When specified with a false argument, enables
1102 the use of "hybrid" hierarchy.</para>
1103
1104 <para>If this option is not specified, the default behaviour is determined
0fad72fa 1105 during compilation (the <option>-Ddefault-hierarchy=</option> meson
ee075513
ZJS
1106 option). If the kernel does not support unified cgroup hierarchy, the legacy
1107 hierarchy will be used even if this option is specified.</para>
1108 </listitem>
1109 </varlistentry>
1110
798d3a52
ZJS
1111 <varlistentry>
1112 <term><varname>quiet</varname></term>
1113
1114 <listitem><para>Turn off status output at boot, much like
964c4eda 1115 <varname>systemd.show_status=no</varname> would. Note that
798d3a52
ZJS
1116 this option is also read by the kernel itself and disables
1117 kernel log output. Passing this option hence turns off the
1118 usual output from both the system manager and the kernel.
1119 </para></listitem>
1120 </varlistentry>
1121
1122 <varlistentry>
1123 <term><varname>debug</varname></term>
1124
1125 <listitem><para>Turn on debugging output. This is equivalent
1126 to <varname>systemd.log_level=debug</varname>. Note that this
1127 option is also read by the kernel itself and enables kernel
1128 debug output. Passing this option hence turns on the debug
1129 output from both the system manager and the
1130 kernel.</para></listitem>
1131 </varlistentry>
1132
1133 <varlistentry>
1134 <term><varname>emergency</varname></term>
dcd61450 1135 <term><varname>rd.emergency</varname></term>
798d3a52
ZJS
1136 <term><varname>-b</varname></term>
1137
1138 <listitem><para>Boot into emergency mode. This is equivalent
dcd61450
IS
1139 to <varname>systemd.unit=emergency.target</varname> or
1140 <varname>rd.systemd.unit=emergency.target</varname>, respectively, and
1141 provided for compatibility reasons and to be easier to type.</para></listitem>
798d3a52
ZJS
1142 </varlistentry>
1143
1144 <varlistentry>
1145 <term><varname>rescue</varname></term>
dcd61450 1146 <term><varname>rd.rescue</varname></term>
798d3a52
ZJS
1147 <term><varname>single</varname></term>
1148 <term><varname>s</varname></term>
1149 <term><varname>S</varname></term>
1150 <term><varname>1</varname></term>
1151
1152 <listitem><para>Boot into rescue mode. This is equivalent to
dcd61450
IS
1153 <varname>systemd.unit=rescue.target</varname> or
1154 <varname>rd.systemd.unit=rescue.target</varname>, respectively, and
1155 provided for compatibility reasons and to be easier to type.</para></listitem>
798d3a52
ZJS
1156 </varlistentry>
1157
1158 <varlistentry>
1159 <term><varname>2</varname></term>
1160 <term><varname>3</varname></term>
1161 <term><varname>4</varname></term>
1162 <term><varname>5</varname></term>
1163
1164 <listitem><para>Boot into the specified legacy SysV runlevel.
1165 These are equivalent to
1166 <varname>systemd.unit=runlevel2.target</varname>,
1167 <varname>systemd.unit=runlevel3.target</varname>,
1168 <varname>systemd.unit=runlevel4.target</varname>, and
1169 <varname>systemd.unit=runlevel5.target</varname>,
1170 respectively, and provided for compatibility reasons and to be
1171 easier to type.</para></listitem>
1172 </varlistentry>
1173
1174 <varlistentry>
1175 <term><varname>locale.LANG=</varname></term>
1176 <term><varname>locale.LANGUAGE=</varname></term>
1177 <term><varname>locale.LC_CTYPE=</varname></term>
1178 <term><varname>locale.LC_NUMERIC=</varname></term>
1179 <term><varname>locale.LC_TIME=</varname></term>
1180 <term><varname>locale.LC_COLLATE=</varname></term>
1181 <term><varname>locale.LC_MONETARY=</varname></term>
1182 <term><varname>locale.LC_MESSAGES=</varname></term>
1183 <term><varname>locale.LC_PAPER=</varname></term>
1184 <term><varname>locale.LC_NAME=</varname></term>
1185 <term><varname>locale.LC_ADDRESS=</varname></term>
1186 <term><varname>locale.LC_TELEPHONE=</varname></term>
1187 <term><varname>locale.LC_MEASUREMENT=</varname></term>
1188 <term><varname>locale.LC_IDENTIFICATION=</varname></term>
1189
1190 <listitem><para>Set the system locale to use. This overrides
1191 the settings in <filename>/etc/locale.conf</filename>. For
b938cb90 1192 more information, see
3ba3a79d 1193 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
798d3a52 1194 and
3ba3a79d 1195 <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
798d3a52
ZJS
1196 </para></listitem>
1197 </varlistentry>
1198 </variablelist>
1199
1200 <para>For other kernel command line parameters understood by
1201 components of the core OS, please refer to
1202 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
1203 </refsect1>
1204
1205 <refsect1>
1206 <title>Sockets and FIFOs</title>
1207
1208 <variablelist>
1209 <varlistentry>
1210 <term><filename>/run/systemd/notify</filename></term>
1211
1212 <listitem><para>Daemon status notification socket. This is an
1213 <constant>AF_UNIX</constant> datagram socket and is used to
1214 implement the daemon notification logic as implemented by
1215 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
1216
1217 </varlistentry>
1218
798d3a52
ZJS
1219 <varlistentry>
1220 <term><filename>/run/systemd/private</filename></term>
1221
1222 <listitem><para>Used internally as communication channel
1223 between
1224 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1225 and the systemd process. This is an
1226 <constant>AF_UNIX</constant> stream socket. This interface is
1227 private to systemd and should not be used in external
1228 projects.</para></listitem>
1229 </varlistentry>
1230
1231 <varlistentry>
1232 <term><filename>/dev/initctl</filename></term>
1233
1234 <listitem><para>Limited compatibility support for the SysV
1235 client interface, as implemented by the
1236 <filename>systemd-initctl.service</filename> unit. This is a
1237 named pipe in the file system. This interface is obsolete and
1238 should not be used in new applications.</para></listitem>
1239 </varlistentry>
1240 </variablelist>
1241 </refsect1>
1242
1243 <refsect1>
1244 <title>See Also</title>
1245 <para>
28a0ad81 1246 The <ulink url="https://www.freedesktop.org/wiki/Software/systemd/">systemd Homepage</ulink>,
798d3a52 1247 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3ba3a79d 1248 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
798d3a52
ZJS
1249 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1250 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1251 <citerefentry><refentrytitle>systemd-notify</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1252 <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1253 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1254 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1255 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1256 <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1257 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1258 <citerefentry project='man-pages'><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1259 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1260 </para>
1261 </refsect1>
9e632bf7
LP
1262
1263</refentry>