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