System D Manual
System D Manual
--test
Determine startup sequence, dump it and exit. This is an option
useful for debugging only.
--dump-configuration-items
Dump understood unit configuration items. This outputs a terse
but complete list of configuration items understood in unit
definition files.
--unit=
Set default unit to activate on startup. If not specified,
defaults to default.target.
--system, --user
For --system, tell systemd to run a system instance, even if the
process ID is not 1, i.e. systemd is not run as init process.
--user 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 --system mode, but PID not
1. In practice, passing --system explicitly is only useful in
conjunction with --test.
--dump-core
Enable core dumping on crash. This switch has no effect when
running as user instance. This setting may also be enabled during
boot on the kernel command line via the systemd.dump_core=
option, see below.
--crash-vt=VT
Switch to a specific virtual console (VT) on crash. Takes a
positive integer in the range 1�63, or a boolean argument. If an
integer is passed, selects which VT to switch to. If yes, the VT
kernel messages are written to is selected. If no, no VT switch
is attempted. This switch has no effect when running as user
instance. This setting may also be enabled during boot, on the
kernel command line via the systemd.crash_vt= option, see below.
--crash-shell
Run a shell on crash. This switch has no effect when running as
user instance. This setting may also be enabled during boot, on
the kernel command line via the systemd.crash_shell= option, see
below.
--crash-reboot
Automatically reboot the system on crash. This switch has no
effect when running as user instance. This setting may also be
enabled during boot, on the kernel command line via the
systemd.crash_reboot= option, see below.
--confirm-spawn
Ask for confirmation when spawning processes. This switch has no
effect when run as user instance.
--show-status=
Takes a boolean argument or the special value auto. If on, terse
unit status information is shown on the console during boot-up
and shutdown. If off, no such status information is shown. If set
to auto behavior is similar to off, except that it is
automatically switched to on, as soon as the first unit failure
or significant boot delay is encountered. This switch has no
effect when invoked as user instance. If specified, overrides
both the kernel command line setting systemd.show_status= (see
below) and the configuration file option ShowStatus=, see
systemd-system.conf(5).
--log-target=
Set log target. Argument must be one of console, journal, kmsg,
journal-or-kmsg, null.
--log-level=
Set log level. As argument this accepts a numerical log level or
the well-known syslog(3) symbolic names (lowercase): emerg,
alert, crit, err, warning, notice, info, debug.
--log-color=
Highlight important log messages. Argument is a boolean value. If
the argument is omitted, it defaults to true.
--log-location=
Include code location in log messages. This is mostly relevant
for debugging purposes. Argument is a boolean value. If the
argument is omitted it defaults to true.
--default-standard-output=, --default-standard-error=
Sets the default output or error output for all services and
sockets, respectively. That is, controls the default for
StandardOutput= and StandardError= (see systemd.exec(5) for
details). Takes one of inherit, null, tty, journal,
journal+console, syslog, syslog+console, kmsg, kmsg+console. If
the argument is omitted --default-standard-output= defaults to
journal and --default-standard-error= to inherit.
--machine-id=
Override the machine-id set on the hard drive, useful for network
booting or for containers. May not be set to all zeros.
-h, --help
Print a short help text and exit.
--version
Print a short version string and exit.
CONCEPTS top
systemd provides a dependency system between various entities called
"units" of 11 different types. Units encapsulate various objects that
are relevant for system boot-up and maintenance. The majority of
units are configured in unit configuration files, whose syntax and
basic set of options is described in systemd.unit(5), however some
are created automatically from other configuration, dynamically from
system state or programmatically at runtime. Units may be "active"
(meaning started, bound, plugged in, ..., depending on the unit type,
see below), or "inactive" (meaning stopped, unbound, unplugged, ...),
as well as in the process of being activated or deactivated, i.e.
between the two states (these 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.
1. Service units, which start and control daemons and the processes
they consist of. For details, see systemd.service(5).
5. Mount units control mount points in the file system, for details
see systemd.mount(5).
8. Swap units are very similar to mount units and encapsulate memory
swap partitions or files of the operating system. They are
described in systemd.swap(5).
10. Slice units may be used to group units which manage system
processes (such as service and scope units) in a hierarchical
tree for resource management purposes. See systemd.slice(5).
11. Scope units are similar to service units, but manage foreign
processes instead of starting them as well. See systemd.scope(5).
Units are named as their configuration files. Some units have special
semantics. A detailed list is available in systemd.special(7).
For more information about the concepts and ideas behind systemd,
please refer to the Original Design Document[2].
Note that some but not all interfaces provided by systemd are covered
by the Interface Stability Promise[3].
systemd user managers will start the exit.target unit when this
signal is received. This is mostly equivalent to systemctl --user
start exit.target.
SIGINT
Upon receiving this signal the systemd system manager will start
the ctrl-alt-del.target unit. This is mostly equivalent to
systemctl start ctl-alt-del.target. 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, pressing Ctrl-Alt-Del more
than 7 times in 2s is a relatively safe way to trigger an
immediate reboot.
systemd user managers treat this signal the same way as SIGTERM.
SIGWINCH
When this signal is received the systemd system manager will
start the kbrequest.target unit. This is mostly equivalent to
systemctl start kbrequest.target.
SIGPWR
When this signal is received the systemd manager will start the
sigpwr.target unit. This is mostly equivalent to systemctl start
sigpwr.target.
SIGUSR1
When this signal is received the systemd manager will try to
reconnect to the D-Bus bus.
SIGUSR2
When this signal is received the systemd manager will log its
complete state in human-readable form. The data logged is the
same as printed by systemd-analyze dump.
SIGHUP
Reloads the complete daemon configuration. This is mostly
equivalent to systemctl daemon-reload.
SIGRTMIN+0
Enters default mode, starts the default.target unit. This is
mostly equivalent to systemctl start default.target.
SIGRTMIN+1
Enters rescue mode, starts the rescue.target unit. This is mostly
equivalent to systemctl isolate rescue.target.
SIGRTMIN+2
Enters emergency mode, starts the emergency.service unit. This is
mostly equivalent to systemctl isolate emergency.service.
SIGRTMIN+3
Halts the machine, starts the halt.target unit. This is mostly
equivalent to systemctl start halt.target.
SIGRTMIN+4
Powers off the machine, starts the poweroff.target unit. This is
mostly equivalent to systemctl start poweroff.target.
SIGRTMIN+5
Reboots the machine, starts the reboot.target unit. This is
mostly equivalent to systemctl start reboot.target.
SIGRTMIN+6
Reboots the machine via kexec, starts the kexec.target unit. This
is mostly equivalent to systemctl start kexec.target.
SIGRTMIN+13
Immediately halts the machine.
SIGRTMIN+14
Immediately powers off the machine.
SIGRTMIN+15
Immediately reboots the machine.
SIGRTMIN+16
Immediately reboots the machine with kexec.
SIGRTMIN+20
Enables display of status messages on the console, as controlled
via systemd.show_status=1 on the kernel command line.
SIGRTMIN+21
Disables display of status messages on the console, as controlled
via systemd.show_status=0 on the kernel command line.
SIGRTMIN+22, SIGRTMIN+23
Sets the log level to "debug" (or "info" on SIGRTMIN+23), as
controlled via systemd.log_level=debug (or systemd.log_level=info
on SIGRTMIN+23) on the kernel command line.
SIGRTMIN+24
Immediately exits the manager (only available for --user
instances).
$SYSTEMD_LOG_TARGET
systemd reads the log target from this environment variable. This
can be overridden with --log-target=.
$SYSTEMD_LOG_COLOR
Controls whether systemd highlights important log messages. This
can be overridden with --log-color=.
$SYSTEMD_LOG_LOCATION
Controls whether systemd prints the code location along with log
messages. This can be overridden with --log-location=.
$SYSTEMD_UNIT_PATH
Controls where systemd looks for unit files.
$SYSTEMD_SYSVINIT_PATH
Controls where systemd looks for SysV init scripts.
$SYSTEMD_SYSVRCND_PATH
Controls where systemd looks for SysV init script runlevel link
farms.
$SYSTEMD_COLORS
The value must be a boolean. Controls whether colorized output
should be generated. This can be specified to override the
decision that systemd makes based on $TERM and what the console
is connected to.
$NOTIFY_SOCKET
Set by systemd for supervised processes for status and start-up
completion notification. See sd_notify(3) for more information.
KERNEL COMMAND LINE top
When run as system instance systemd parses a number of kernel command
line arguments[7]:
systemd.unit=, rd.systemd.unit=
Overrides the unit to activate on boot. Defaults to
default.target. This may be used to temporarily boot into a
different boot unit, for example rescue.target or
emergency.service. See systemd.special(7) for details about these
units. The option prefixed with "rd." is honored only in the
initial RAM disk (initrd), while the one that is not prefixed
only in the main system.
systemd.dump_core
Takes a boolean argument or enables the option if specified
without an argument. If enabled, the systemd manager (PID 1)
dumps core when it crashes. Otherwise, no core dump is created.
Defaults to enabled.
systemd.crash_chvt
Takes a positive integer, or a boolean argument. Can be also
specified without an argument, with the same effect as a positive
boolean. If a positive integer (in the range 1�63) is specified,
the system manager (PID 1) will activate the specified virtual
terminal (VT) when it crashes. Defaults to disabled, meaning that
no such switch is attempted. If set to enabled, the VT the kernel
messages are written to is selected.
systemd.crash_shell
Takes a boolean argument or enables the option if specified
without an argument. If enabled, the system manager (PID 1)
spawns a shell when it crashes, after a 10s delay. Otherwise, no
shell is spawned. Defaults to disabled, for security reasons, as
the shell is not protected by password authentication.
systemd.crash_reboot
Takes a boolean argument or enables the option if specified
without an argument. If enabled, the system manager (PID 1) will
reboot the machine automatically when it crashes, after a 10s
delay. Otherwise, the system will hang indefinitely. Defaults to
disabled, in order to avoid a reboot loop. If combined with
systemd.crash_shell, the system is rebooted after the shell
exits.
systemd.confirm_spawn
Takes a boolean argument or a path to the virtual console where
the confirmation messages should be emitted. Can be also
specified without an argument, with the same effect as a positive
boolean. If enabled, the system manager (PID 1) asks for
confirmation when spawning processes using /dev/console. If a
path or a console name (such as "ttyS0") is provided, the virtual
console pointed to by this path or described by the give name
will be used instead. Defaults to disabled.
systemd.show_status
Takes a boolean argument or the constant auto. Can be also
specified without an argument, with the same effect as a positive
boolean. If enabled, the systemd manager (PID 1) shows terse
service status updates on the console during bootup. auto
behaves like false until a unit fails or there is a significant
delay in boot. Defaults to enabled, unless quiet is passed as
kernel command line option, in which case it defaults to auto. If
specified overrides the system manager configuration file option
ShowStatus=, see systemd-system.conf(5). However, the process
command line option --show-status= takes precedence over both
this kernel command line option and the configuration file
option.
systemd.default_standard_output=, systemd.default_standard_error=
Controls default standard output and error output for services,
with the same effect as the --default-standard-output= and
--default-standard-error= command line arguments described above,
respectively.
systemd.setenv=
Takes a string argument in the form VARIABLE=VALUE. May be used
to set default environment variables to add to forked child
processes. May be used more than once to set multiple variables.
systemd.machine_id=
Takes a 32 character hex value to be used for setting the
machine-id. Intended mostly for network booting where the same
machine-id is desired for every boot.
systemd.unified_cgroup_hierarchy
When specified without an argument or with a true argument,
enables the usage of unified cgroup hierarchy[8]
(a.k.a. cgroups-v2). When specified with a false argument, fall
back to hybrid or full legacy cgroup hierarchy.
systemd.legacy_systemd_cgroup_controller
Takes effect if the full unified cgroup hierarchy is not used
(see previous option). When specified without an argument or with
a true argument, disables the use of "hybrid" cgroup hierarchy
(i.e. a cgroups-v2 tree used for systemd, and legacy cgroup
hierarchy[9], a.k.a. cgroups-v1, for other controllers), and
forces a full "legacy" mode. When specified with a false
argument, enables the use of "hybrid" hierarchy.
quiet
Turn off status output at boot, much like
systemd.show_status=false would. Note that this option is also
read by the kernel itself and disables kernel log output. Passing
this option hence turns off the usual output from both the system
manager and the kernel.
debug
Turn on debugging output. This is equivalent to
systemd.log_level=debug. Note that this option is also read by
the kernel itself and enables kernel debug output. Passing this
option hence turns on the debug output from both the system
manager and the kernel.
emergency, rd.emergency, -b
Boot into emergency mode. This is equivalent to
systemd.unit=emergency.target or
rd.systemd.unit=emergency.target, respectively, and provided for
compatibility reasons and to be easier to type.
2, 3, 4, 5
Boot into the specified legacy SysV runlevel. These are
equivalent to systemd.unit=runlevel2.target,
systemd.unit=runlevel3.target, systemd.unit=runlevel4.target, and
systemd.unit=runlevel5.target, respectively, and provided for
compatibility reasons and to be easier to type.
/run/systemd/private
Used internally as communication channel between systemctl(1) and
the systemd process. This is an AF_UNIX stream socket. This
interface is private to systemd and should not be used in
external projects.
/dev/initctl
Limited compatibility support for the SysV client interface, as
implemented by the systemd-initctl.service unit. This is a named
pipe in the file system. This interface is obsolete and should
not be used in new applications.