"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
- This file is part of elogind.
+ SPDX-License-Identifier: LGPL-2.1+
Copyright 2010 Lennart Poettering
-
- elogind is free software; you can redistribute it and/or modify it
- under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation; either version 2.1 of the License, or
- (at your option) any later version.
-
- elogind is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with elogind; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="elogind"
<refsynopsisdiv>
<!-- 0 /// elogind has a different synopsis of course...
<cmdsynopsis>
- <command>systemd</command>
+ <command>/usr/lib/systemd/systemd</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
<cmdsynopsis>
<variablelist>
<!-- 0 /// This list is much shorter with elogind of course.
<varlistentry>
- <term><option>--test</option></term>
+ <term><option>--test</option></term>
<listitem><para>Determine startup sequence, dump it and exit.
This is an option useful for debugging only.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--dump-configuration-items</option></term>
+ <term><option>--dump-configuration-items</option></term>
<listitem><para>Dump understood unit configuration items. This
outputs a terse but complete list of configuration items
understood in unit definition files.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--unit=</option></term>
+ <term><option>--dump-bus-properties</option></term>
+
+ <listitem><para>Dump exposed bus properties. This outputs
+ a terse but complete list of properties exposed to dbus.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--unit=</option></term>
<listitem><para>Set default unit to activate on startup. If
not specified, defaults to
<filename>default.target</filename>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--system</option></term>
- <term><option>--user</option></term>
+ <term><option>--system</option></term>
+ <term><option>--user</option></term>
- <listitem><para>For <option>--system</option>, tell systemd to
+ <listitem><para>For <option>--system</option>, tell systemd to
run a system instance, even if the process ID is not 1, i.e.
- systemd is not run as init process. <option>--user</option>
+ systemd is not run as init process. <option>--user</option>
does the opposite, running a user instance even if the process
ID is 1. Normally, it should not be necessary to pass these
options, as systemd automatically detects the mode it is
started in. These options are hence of little use except for
debugging. Note that it is not supported booting and
maintaining a full system with systemd running in
- <option>--system</option> mode, but PID not 1. In practice,
- passing <option>--system</option> explicitly is only useful in
- conjunction with <option>--test</option>.</para></listitem>
+ <option>--system</option> mode, but PID not 1. In practice,
+ passing <option>--system</option> explicitly is only useful in
+ conjunction with <option>--test</option>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--dump-core</option></term>
+ <term><option>--dump-core</option></term>
<listitem><para>Enable core dumping on crash. This switch has
no effect when running as user instance. This setting may also
</varlistentry>
<varlistentry>
- <term><option>--crash-vt=</option><replaceable>VT</replaceable></term>
+ <term><option>--crash-vt=</option><replaceable>VT</replaceable></term>
<listitem><para>Switch to a specific virtual console (VT) on
crash. Takes a positive integer in the range 1–63, or a
</varlistentry>
<varlistentry>
- <term><option>--crash-shell</option></term>
+ <term><option>--crash-shell</option></term>
<listitem><para>Run a shell on crash. This switch has no
effect when running as user instance. This setting may also be
</varlistentry>
<varlistentry>
- <term><option>--crash-reboot</option></term>
+ <term><option>--crash-reboot</option></term>
<listitem><para>Automatically reboot the system on crash. This
switch has no effect when running as user instance. This
</varlistentry>
<varlistentry>
- <term><option>--confirm-spawn</option></term>
+ <term><option>--confirm-spawn</option></term>
<listitem><para>Ask for confirmation when spawning processes.
This switch has no effect when run as user
instance.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--show-status=</option></term>
+ <term><option>--show-status=</option></term>
<listitem><para>Takes a boolean argument or the special value <constant>auto</constant>. If on, terse unit
status information is shown on the console during boot-up and shutdown. If off, no such status information is
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--log-target=</option></term>
+ <term><option>--log-target=</option></term>
<listitem><para>Set log target. Argument must be one of
<option>console</option>,
<option>null</option>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--log-level=</option></term>
+ <term><option>--log-level=</option></term>
<listitem><para>Set log level. As
argument this accepts a numerical log
<option>debug</option>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--log-color=</option></term>
+ <term><option>--log-color=</option></term>
<listitem><para>Highlight important log messages. Argument is
a boolean value. If the argument is omitted, it defaults to
<option>true</option>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--log-location=</option></term>
+ <term><option>--log-location=</option></term>
<listitem><para>Include code location in log messages. This is
mostly relevant for debugging purposes. Argument is a boolean
<option>true</option>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--default-standard-output=</option></term>
- <term><option>--default-standard-error=</option></term>
+ <term><option>--default-standard-output=</option></term>
+ <term><option>--default-standard-error=</option></term>
<listitem><para>Sets the default output or error output for
all services and sockets, respectively. That is, controls the
<option>kmsg</option>,
<option>kmsg+console</option>. If the
argument is omitted
- <option>--default-standard-output=</option> defaults to
+ <option>--default-standard-output=</option> defaults to
<option>journal</option> and
- <option>--default-standard-error=</option> to
+ <option>--default-standard-error=</option> to
<option>inherit</option>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--machine-id=</option></term>
+ <term><option>--machine-id=</option></term>
<listitem><para>Override the machine-id set on the hard drive,
useful for network booting or for containers. May not be set
to all zeros.</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--service-watchdogs=</option></term>
+
+ <listitem><para>Globally enable/disable all service watchdog timeouts and emergency
+ actions. This setting may also be specified during boot, on the kernel
+ command line via the <varname>systemd.service_watchdogs=</varname>
+ option, see below. Defaults to enabled.</para></listitem>
+ </varlistentry>
+
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
else -->
states are called "activating", "deactivating"). A special
"failed" state is available as well, which is very similar to
"inactive" and is entered when the service failed in some way
- (process returned error code on exit, or crashed, or an operation
- timed out). If this state is entered, the cause will be logged,
- for later reference. Note that the various unit types may have a
- number of additional substates, which are mapped to the five
- generalized unit states described here.</para>
+ (process returned error code on exit, or crashed, an operation
+ timed out, or after too many restarts). If this state is entered,
+ the cause will be logged, for later reference. Note that the
+ various unit types may have a number of additional substates,
+ which are mapped to the five generalized unit states described
+ here.</para>
<para>The following unit types are available:</para>
<para>Processes systemd spawns are placed in individual Linux
control groups named after the unit which they belong to in the
private systemd hierarchy. (see <ulink
- url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>
+ url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>
for more information about control groups, or short "cgroups").
systemd uses this to effectively keep track of processes. Control
group information is maintained in the kernel, and is accessible
verify that it makes sense, fixing it if possible, and only
failing if it really cannot work.</para>
- <para>Systemd contains native implementations of various tasks
+ <para>systemd contains native implementations of various tasks
that need to be executed as part of the boot process. For example,
it sets the hostname or configures the loopback network device. It
also sets up and mounts various API file systems, such as
configuration from various directories. Packages that want to
install unit files shall place them in the directory returned
by <command>pkg-config systemd
- --variable=systemdsystemunitdir</command>. Other directories
+ --variable=systemdsystemunitdir</command>. Other directories
checked are <filename>/usr/local/lib/systemd/system</filename>
and <filename>/usr/lib/systemd/system</filename>. User
configuration always takes precedence. <command>pkg-config
- systemd --variable=systemdsystemconfdir</command> returns the
+ systemd --variable=systemdsystemconfdir</command> returns the
path of the system configuration directory. Packages should
alter the content of these directories only with the
<command>enable</command> and <command>disable</command>
Base Directory specification</ulink> is followed to find
units. Applications should place their unit files in the
directory returned by <command>pkg-config systemd
- --variable=systemduserunitdir</command>. Global configuration
+ --variable=systemduserunitdir</command>. Global configuration
is done in the directory reported by <command>pkg-config
- systemd --variable=systemduserconfdir</command>. The
+ systemd --variable=systemduserconfdir</command>. The
<command>enable</command> and <command>disable</command>
commands of the
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<para>systemd user managers will start the
<filename>exit.target</filename> unit when this signal is
received. This is mostly equivalent to <command>systemctl
- --user start exit.target
- --job-mode=replace-irreversible</command>.</para></listitem>
+ --user start exit.target
+ --job-mode=replace-irreversible</command>.</para></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Upon receiving this signal the systemd system
manager will start the
<filename>ctrl-alt-del.target</filename> unit. This is mostly
- equivalent to <command>systemctl start ctl-alt-del.target
- --job-mode=replace-irreversible</command>. If this signal is
+ equivalent to <command>systemctl start ctrl-alt-del.target
+ --job-mode=replace-irreversible</command>. If this signal is
received more than 7 times per 2s, an immediate reboot is
triggered. Note that pressing Ctrl-Alt-Del on the console
will trigger this signal. Hence, if a reboot is hanging,
<listitem><para>Halts the machine, starts the
<filename>halt.target</filename> unit. This is mostly
equivalent to <command>systemctl start halt.target
- --job-mode=replace-irreversible</command>.</para>
+ --job-mode=replace-irreversible</command>.</para>
</listitem>
</varlistentry>
<listitem><para>Powers off the machine, starts the
<filename>poweroff.target</filename> unit. This is mostly
equivalent to <command>systemctl start poweroff.target
- --job-mode=replace-irreversible</command>.</para>
+ --job-mode=replace-irreversible</command>.</para>
</listitem>
</varlistentry>
<listitem><para>Reboots the machine, starts the
<filename>reboot.target</filename> unit. This is mostly
equivalent to <command>systemctl start reboot.target
- --job-mode=replace-irreversible</command>.</para>
+ --job-mode=replace-irreversible</command>.</para>
</listitem>
</varlistentry>
<listitem><para>Reboots the machine via kexec, starts the
<filename>kexec.target</filename> unit. This is mostly
equivalent to <command>systemctl start kexec.target
- --job-mode=replace-irreversible</command>.</para>
+ --job-mode=replace-irreversible</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>SIGRTMIN+22</constant></term>
+
+ <listitem><para>Sets the service manager's log level to <literal>debug</literal>, in a fashion equivalent to
+ <varname>systemd.log_level=debug</varname> on the kernel command line.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><constant>SIGRTMIN+23</constant></term>
- <listitem><para>Sets the log level to <literal>debug</literal>
- (or <literal>info</literal> on
- <constant>SIGRTMIN+23</constant>), as controlled via
- <varname>systemd.log_level=debug</varname> (or
- <varname>systemd.log_level=info</varname> on
- <constant>SIGRTMIN+23</constant>) on the kernel command
- line.</para></listitem>
+ <listitem><para>Restores the log level to its configured value. The configured value is derived from – in order
+ of priority – the value specified with <varname>systemd.log-level=</varname> on the kernel command line, or the
+ value specified with <option>LogLevel=</option> in the configuration file, or the built-in default of
+ <literal>info</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>SIGRTMIN+24</constant></term>
<listitem><para>Immediately exits the manager (only available
- for --user instances).</para></listitem>
+ for --user instances).</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>SIGRTMIN+26</constant></term>
+
+ <listitem><para>Restores the log target to its configured value. The configured value is derived from – in
+ order of priority – the value specified with <varname>systemd.log-target=</varname> on the kernel command line,
+ or the value specified with <option>LogTarget=</option> in the configuration file, or the built-in
+ default.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><constant>SIGRTMIN+27</constant></term>
<term><constant>SIGRTMIN+28</constant></term>
- <listitem><para>Sets the log target to
- <literal>journal-or-kmsg</literal> (or
- <literal>console</literal> on
- <constant>SIGRTMIN+27</constant>, <literal>kmsg</literal> on
- <constant>SIGRTMIN+28</constant>), as controlled via
- <varname>systemd.log_target=journal-or-kmsg</varname> (or
- <varname>systemd.log_target=console</varname> on
- <constant>SIGRTMIN+27</constant> or
- <varname>systemd.log_target=kmsg</varname> on
- <constant>SIGRTMIN+28</constant>) on the kernel command
- line.</para></listitem>
+ <listitem><para>Sets the log target to <literal>console</literal> on <constant>SIGRTMIN+27</constant> (or
+ <literal>kmsg</literal> on <constant>SIGRTMIN+28</constant>), in a fashion equivalent to
+ <varname>systemd.log_target=console</varname> (or <varname>systemd.log_target=kmsg</varname> on
+ <constant>SIGRTMIN+28</constant>) on the kernel command line.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<term><varname>$SYSTEMD_LOG_LEVEL</varname></term>
<listitem><para>systemd reads the log level from this
environment variable. This can be overridden with
- <option>--log-level=</option>.</para></listitem>
+ <option>--log-level=</option>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>$SYSTEMD_LOG_TARGET</varname></term>
<listitem><para>systemd reads the log target from this
environment variable. This can be overridden with
- <option>--log-target=</option>.</para></listitem>
+ <option>--log-target=</option>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>$SYSTEMD_LOG_COLOR</varname></term>
<listitem><para>Controls whether systemd highlights important
log messages. This can be overridden with
- <option>--log-color=</option>.</para></listitem>
+ <option>--log-color=</option>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>$SYSTEMD_LOG_LOCATION</varname></term>
<listitem><para>Controls whether systemd prints the code
location along with log messages. This can be overridden with
- <option>--log-location=</option>.</para></listitem>
+ <option>--log-location=</option>.</para></listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>$SYSTEMD_URLIFY</varname></term>
+
+ <listitem><para>The value must be a boolean. Controls whether clickable links should be generated in the output
+ for terminal emulators supporting this. This can be specified to override the decision that
+ <command>systemd</command> makes based on <varname>$TERM</varname> and other conditions.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>$LISTEN_PID</varname></term>
<term><varname>$LISTEN_FDS</varname></term>
</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>systemd.service_watchdogs=</varname></term>
+
+ <listitem><para>Takes a boolean argument. If disabled, all service runtime
+ watchdogs (<option>WatchdogSec=</option>) and emergency actions (e.g.
+ <option>OnFailure=</option> or <option>StartLimitAction=</option>) are
+ ignored by the system manager (PID 1); see
+ <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ Defaults to enabled, i.e. watchdogs and failure actions are processed
+ normally. The hardware watchdog is not affected by this
+ option.</para></listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>systemd.show_status</varname></term>
it defaults to <constant>auto</constant>. If specified overrides the system
manager configuration file option <option>ShowStatus=</option>, see
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
- However, the process command line option <option>--show-status=</option>
+ However, the process command line option <option>--show-status=</option>
takes precedence over both this kernel command line option and the
configuration file option.</para></listitem>
</varlistentry>
<term><varname>systemd.default_standard_error=</varname></term>
<listitem><para>Controls default standard output and error
output for services, with the same effect as the
- <option>--default-standard-output=</option> and
- <option>--default-standard-error=</option> command line
+ <option>--default-standard-output=</option> and
+ <option>--default-standard-error=</option> command line
arguments described above, respectively.</para></listitem>
</varlistentry>
hybrid or full legacy cgroup hierarchy.</para>
<para>If this option is not specified, the default behaviour is determined
- during compilation (the <option>--with-default-hierarchy=</option>
+ during compilation (the <option>--with-default-hierarchy=</option>
option). If the kernel does not support unified cgroup hierarchy, the legacy
hierarchy will be used even if this option is specified.</para>
</listitem>
the use of "hybrid" hierarchy.</para>
<para>If this option is not specified, the default behaviour is determined
- during compilation (the <option>--with-default-hierarchy=</option>
+ during compilation (the <option>--with-default-hierarchy=</option>
option). If the kernel does not support unified cgroup hierarchy, the legacy
hierarchy will be used even if this option is specified.</para>
</listitem>
~ianmdlvl / elogind.git / blobdiff