HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/systemd.special.xml
Git blob: eafea18529a77343401004cfbfb6050ec395b22b
Lines 1–1000 of 1,623
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd.special" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd.special</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd.special</refentrytitle>
<manvolnum>7</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd.special</refname>
<refpurpose>Special systemd units</refpurpose>
</refnamediv>
<refsynopsisdiv><para>
<!-- sort alphabetically, targets first --><filename>basic.target</filename>,
<filename>bluetooth.target</filename>,
<filename>cryptsetup-pre.target</filename>,
<filename>cryptsetup.target</filename>,
<filename>veritysetup-pre.target</filename>,
<filename>veritysetup.target</filename>,
<filename>ctrl-alt-del.target</filename>,
<filename>blockdev@.target</filename>,
<filename>boot-complete.target</filename>,
<filename>default.target</filename>,
<filename>emergency.target</filename>,
<filename>exit.target</filename>,
<filename>factory-reset.target</filename>,
<filename>factory-reset-now.target</filename>,
<filename>final.target</filename>,
<filename>first-boot-complete.target</filename>,
<filename>getty.target</filename>,
<filename>getty-pre.target</filename>,
<filename>graphical.target</filename>,
<filename>halt.target</filename>,
<filename>hibernate.target</filename>,
<filename>hybrid-sleep.target</filename>,
<filename>suspend-then-hibernate.target</filename>,
<filename>initrd.target</filename>,
<filename>initrd-fs.target</filename>,
<filename>initrd-root-device.target</filename>,
<filename>initrd-root-fs.target</filename>,
<filename>initrd-usr-fs.target</filename>,
<filename>integritysetup-pre.target</filename>,
<filename>integritysetup.target</filename>,
<filename>kbrequest.target</filename>,
<filename>kexec.target</filename>,
<filename>local-fs-pre.target</filename>,
<filename>local-fs.target</filename>,
<filename>machines.target</filename>,
<filename>multi-user.target</filename>,
<filename>network-online.target</filename>,
<filename>network-pre.target</filename>,
<filename>network.target</filename>,
<filename>nss-lookup.target</filename>,
<filename>nss-user-lookup.target</filename>,
<filename>paths.target</filename>,
<filename>poweroff.target</filename>,
<filename>printer.target</filename>,
<filename>reboot.target</filename>,
<filename>remote-cryptsetup.target</filename>,
<filename>remote-integritysetup.target</filename>,
<filename>remote-veritysetup.target</filename>,
<filename>remote-fs-pre.target</filename>,
<filename>remote-fs.target</filename>,
<filename>rescue.target</filename>,
<filename>rpcbind.target</filename>,
<filename>shutdown.target</filename>,
<filename>sigpwr.target</filename>,
<filename>sleep.target</filename>,
<filename>slices.target</filename>,
<filename>smartcard.target</filename>,
<filename>sockets.target</filename>,
<filename>soft-reboot.target</filename>,
<filename>sound.target</filename>,
<filename>ssh-access.target</filename>,
<filename>storage-target-mode.target</filename>,
<filename>suspend.target</filename>,
<filename>swap.target</filename>,
<filename>sysinit.target</filename>,
<filename>system-update.target</filename>,
<filename>system-update-pre.target</filename>,
<filename>time-set.target</filename>,
<filename>time-sync.target</filename>,
<filename>timers.target</filename>,
<filename>tpm2.target</filename>,
<filename>umount.target</filename>,
<filename>usb-gadget.target</filename>,
<!-- slices --><filename>-.slice</filename>,
<filename>capsule.slice</filename>,
<filename>machine.slice</filename>,
<filename>system.slice</filename>,
<filename>user.slice</filename>,
<!-- the rest --><filename>-.mount</filename>,
<filename>dbus.service</filename>,
<filename>dbus.socket</filename>,
<filename>display-manager.service</filename>,
<filename>init.scope</filename>,
<filename>syslog.socket</filename>,
<filename>system-update-cleanup.service</filename>
</para></refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>A few units are treated specially by systemd. Many of them have
special internal semantics and cannot be renamed, while others simply
have a standard meaning and should be present on all systems.</para>
</refsect1>
<refsect1>
<title>Units managed by the system service manager</title>
<refsect2>
<title>Special System Units</title>
<variablelist>
<varlistentry>
<term><filename>-.mount</filename></term>
<listitem>
<para>The root mount point, i.e. the mount unit for the <filename>/</filename>
path. This unit is unconditionally active, during the entire time the system is up, as
this mount point is where the basic userspace is running from.</para>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>basic.target</filename></term>
<listitem>
<para>A special target unit covering basic boot-up.</para>
<para>systemd automatically adds dependency of the type
<varname>After=</varname> for this target unit to all
services (except for those with
<varname>DefaultDependencies=no</varname>).</para>
<para>Usually, this should pull-in all local mount points plus
<filename>/var/</filename>, <filename>/tmp/</filename> and
<filename>/var/tmp/</filename>, swap devices, sockets, timers,
path units and other basic initialization necessary for general
purpose daemons. The mentioned mount points are special cased
to allow them to be remote.
</para>
<para>This target usually does not pull in any non-target units
directly, but rather does so indirectly via other early boot targets.
It is instead meant as a synchronization point for late boot
services. Refer to
<citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details on the targets involved.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>boot-complete.target</filename></term>
<listitem>
<para>This target is intended as generic synchronization point for services that shall determine or act on
whether the boot process completed successfully. Order units that are required to succeed for a boot process
to be considered successful before this unit, and add a <varname>Requires=</varname> dependency from the
target unit to them. Order units that shall only run when the boot process is considered successful after the
target unit and pull in the target from it, also with <varname>Requires=</varname>. Note that by default this
target unit is not part of the initial boot transaction, but is supposed to be pulled in only if required by
units that want to run only on successful boots.</para>
<para>See
<citerefentry><refentrytitle>systemd-boot-check-no-failures.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for a service that implements a generic system health check and orders itself before
<filename>boot-complete.target</filename>.</para>
<para>See
<citerefentry><refentrytitle>systemd-bless-boot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for a service that propagates boot success information to the boot loader, and orders itself after
<filename>boot-complete.target</filename>.</para>
<xi:include href="version-info.xml" xpointer="v240"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>ctrl-alt-del.target</filename></term>
<listitem>
<para>systemd starts this target whenever Control+Alt+Del is
pressed on the console. Usually, this should be aliased
(symlinked) to <filename>reboot.target</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>cryptsetup.target</filename></term>
<listitem>
<para>A target that pulls in setup services for all
encrypted block devices.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>veritysetup.target</filename></term>
<listitem>
<para>A target that pulls in setup services for all
verity integrity protected block devices.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>dbus.service</filename></term>
<listitem>
<para>A special unit for the D-Bus bus daemon. As soon as
this service is fully started up systemd will connect to it
and register its service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>dbus.socket</filename></term>
<listitem>
<para>A special unit for the D-Bus system bus socket. All
units with <varname>Type=dbus</varname> automatically gain a
dependency on this unit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>default.target</filename></term>
<listitem>
<para>The default unit systemd starts at bootup. Usually, this should be aliased (symlinked) to
<filename>multi-user.target</filename> or <filename>graphical.target</filename>. See
<citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
more discussion.</para>
<para>The default unit systemd starts at bootup can be overridden with the
<varname>systemd.unit=</varname> kernel command line option, or more conveniently, with the short
names like <varname>single</varname>, <varname>rescue</varname>, <varname>1</varname>,
<varname>3</varname>, <varname>5</varname>, …; see
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
<para>If <filename>default.target</filename> is not present on disk and no unit was requested on
the kernel command line, the default set at compile time will be used
(<filename>&FALLBACK_DEFAULT_TARGET;</filename>).</para>
<para>If the default unit or one of the fallbacks cannot be started, systemd starts
<filename>rescue.target</filename>.</para>
<para>For typical unit files please set <literal>WantedBy=</literal> to a regular target (like
<filename>multi-user.target</filename> or <filename>graphical.target</filename>),
instead of <filename>default.target</filename>, since such a service will also be run on special
boots like on system update, emergency boot…</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>display-manager.service</filename></term>
<listitem>
<para>The display manager service. Usually, this should be
aliased (symlinked) to <filename>gdm.service</filename> or a
similar display manager service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>emergency.target</filename></term>
<listitem>
<para>A special target unit that starts an emergency shell on the main console. This
target does not pull in other services or mounts. It is the most minimal version of
starting the system in order to acquire an interactive shell; the only processes running
are usually just the system manager (PID 1) and the shell process. This unit may be used
by specifying <varname>emergency</varname> on the kernel command line; it is
also used when a file system check on a required file system fails and boot-up cannot
continue. Compare with <filename>rescue.target</filename>, which serves a similar
purpose, but also starts the most basic services and mounts all file systems.</para>
<para>In many ways booting into <filename>emergency.target</filename> is similar to the
effect of booting with <literal>init=/bin/sh</literal> on the kernel command line,
except that emergency mode provides you with the full system and service manager, and
allows starting individual units in order to continue the boot process in steps.</para>
<para>Note that depending on how <filename>emergency.target</filename> is reached, the root file
system might be mounted read-only or read-write (no remounting is done specially for this
target). For example, the system may boot with root mounted read-only when <varname>ro</varname>
is used on the kernel command line and remain this way for <filename>emergency.target</filename>,
or the system may transition to <filename>emergency.target</filename> after the system has been
partially booted and disks have already been remounted read-write.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>exit.target</filename></term>
<listitem>
<para>A special service unit for shutting down the system or
user service manager. It is equivalent to
<filename>poweroff.target</filename> on non-container
systems, and also works in containers.</para>
<para>systemd will start this unit when it receives the
<constant>SIGTERM</constant> or <constant>SIGINT</constant>
signal when running as user service daemon.</para>
<para>Normally, this (indirectly) pulls in
<filename>shutdown.target</filename>, which in turn should be
conflicted by all units that want to be scheduled for
shutdown when the service manager starts to exit.</para>
<xi:include href="version-info.xml" xpointer="v186"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>factory-reset.target</filename></term>
<listitem>
<para>A special target to request a factory reset operation. This will typically persistently
store a request flag for the next boot and then reboot in order to reset the system to factory
state.</para>
<para>See <ulink url="https://systemd.io/FACTORY_RESET">Factory Reset</ulink> for more
information.</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>factory-reset-now.target</filename></term>
<listitem>
<para>A special target that is started on boots that shall execute a factory reset. It may be
used to pull in additional services that shall be invoked during a factory reset operation. It
also acts as ordering barrier: once the target is reached the factory reset state is marked as
"completed".</para>
<para>See <ulink url="https://systemd.io/FACTORY_RESET">Factory Reset</ulink> for more
information.</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>final.target</filename></term>
<listitem>
<para>A special target unit that is used during the shutdown
logic and may be used to pull in late services after all
normal services are already terminated and all mounts
unmounted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>getty.target</filename></term>
<listitem>
<para>A special target unit that pulls in statically
configured local TTY <filename>getty</filename> instances.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>graphical.target</filename></term>
<listitem>
<para>A special target unit for setting up a graphical login
screen. This pulls in
<filename>multi-user.target</filename>.</para>
<para>Units that are needed for graphical logins shall add
<varname>Wants=</varname> dependencies for their unit to
this unit (or <filename>multi-user.target</filename>) during
installation. This is best configured via
<varname>WantedBy=graphical.target</varname> in the unit's
[Install] section.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>hibernate.target</filename></term>
<listitem>
<para>A special target unit for hibernating the system. This
pulls in <filename>sleep.target</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>hybrid-sleep.target</filename></term>
<listitem>
<para>A special target unit for hibernating and suspending
the system at the same time. This pulls in
<filename>sleep.target</filename>.</para>
<xi:include href="version-info.xml" xpointer="v196"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>suspend-then-hibernate.target</filename></term>
<listitem>
<para>A special target unit for suspending the system for a period
of time, waking it and putting it into hibernate. This pulls in
<filename>sleep.target</filename>.</para>
<xi:include href="version-info.xml" xpointer="v239"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>halt.target</filename></term>
<listitem>
<para>A special target unit for shutting down and halting
the system. Note that this target is distinct from
<filename>poweroff.target</filename> in that it generally
really just halts the system rather than powering it
down.</para>
<para>Applications wanting to halt the system should not start this unit
directly, but should instead execute <command>systemctl halt</command>
(possibly with the <option>--no-block</option> option) or call
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>org.freedesktop.systemd1.Manager.Halt</command> D-Bus method
directly.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>imports.target</filename></term>
<listitem>
<para>A target unit that pulls in all disk image download jobs to execute on system boot. This is
used by
<citerefentry><refentrytitle>systemd-import-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>init.scope</filename></term>
<listitem>
<para>This scope unit is where the system and service manager (PID 1) itself resides. It
is active as long as the system is running.</para>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd.target</filename></term>
<listitem>
<para>This is the default target in the initrd, similar to <filename>default.target</filename> in
the main system. It is used to mount the real root and transition to it. See
<citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
more discussion.</para>
<xi:include href="version-info.xml" xpointer="v245"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-fs.target</filename></term>
<listitem>
<para><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
automatically adds dependencies of type <varname>Before=</varname> to
<filename>sysroot-usr.mount</filename> and all mount points found in
<filename>/etc/fstab</filename> that have the <option>x-initrd.mount</option> mount option set
and do not have the <option>noauto</option> mount option set. It is also indirectly ordered after
<filename>sysroot.mount</filename>. Thus, once this target is reached the
<filename>/sysroot/</filename> hierarchy is fully set up, in preparation for the transition to
the host OS.</para>
<xi:include href="version-info.xml" xpointer="v199"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-root-device.target</filename></term>
<listitem>
<para>A special initrd target unit that is reached when the root filesystem device is available, but before
it has been mounted.
<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
automatically set up the appropriate dependencies to make this happen.
</para>
<xi:include href="version-info.xml" xpointer="v230"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-root-fs.target</filename></term>
<listitem>
<para><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
automatically adds dependencies of type <varname>Before=</varname> to the
<filename>sysroot.mount</filename> unit, which is generated from the kernel command line's
<varname>root=</varname> setting (or equivalent).</para>
<xi:include href="version-info.xml" xpointer="v199"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-usr-fs.target</filename></term>
<listitem>
<para><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
automatically adds dependencies of type <varname>Before=</varname> to the
<filename>sysusr-usr.mount</filename> unit, which is generated from the kernel command line's
<varname>usr=</varname> switch. Services may order themselves after this target unit in order to
run once the <filename>/sysusr/</filename> hierarchy becomes available, on systems that come up
initially without a root file system, but with an initialized <filename>/usr/</filename> and need
to access that before setting up the root file system to ultimately switch to. On systems where
<varname>usr=</varname> is not used this target is ordered after
<filename>sysroot.mount</filename> and thus mostly equivalent to
<filename>initrd-root-fs.target</filename>. In effect on any system once this target is reached
the file system backing <filename>/usr/</filename> is mounted, though possibly at two different
locations, either below the <filename>/sysusr/</filename> or the <filename>/sysroot/</filename>
hierarchies.</para>
<xi:include href="version-info.xml" xpointer="v249"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>kbrequest.target</filename></term>
<listitem>
<para>systemd starts this target whenever Alt+ArrowUp is
pressed on the console. Note that any user with physical access
to the machine will be able to do this, without authentication,
so this should be used carefully.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>kexec.target</filename></term>
<listitem>
<para>A special target unit for shutting down and rebooting the system via kexec.</para>
<para>Applications wanting to reboot the system should not start this unit directly, but should
instead execute <command>systemctl kexec</command> (possibly with the
<option>--no-block</option> option) or call
<citerefentry><refentrytitle>systemd-logind</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s
<function>org.freedesktop.login1.Manager.RebootWithFlags()</function> D-Bus method
directly.</para>
<para>See
<citerefentry><refentrytitle>systemd-kexec.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for further details of the operation this target pulls in.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>local-fs.target</filename></term>
<listitem>
<para><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
automatically adds dependencies of type
<varname>Before=</varname> to all mount units that refer to
local mount points for this target unit. In addition, it
adds dependencies of type <varname>Wants=</varname> to this
target unit for those mounts listed in
<filename>/etc/fstab</filename> that have the
<option>auto</option> mount option set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>machines.target</filename></term>
<listitem>
<para>A standard target unit for starting all the containers
and other virtual machines. See <filename>systemd-nspawn@.service</filename>
for an example.</para>
<xi:include href="version-info.xml" xpointer="v233"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>multi-user.target</filename></term>
<listitem>
<para>A special target unit for setting up a multi-user
system (non-graphical). This is pulled in by
<filename>graphical.target</filename>.</para>
<para>Units that are needed for a multi-user system shall
add <varname>Wants=</varname> dependencies for their unit to
this unit during installation. This is best configured via
<varname>WantedBy=multi-user.target</varname> in the unit's
[Install] section.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>network-online.target</filename></term>
<listitem>
<para>Units that strictly require a configured network
connection should pull in
<filename>network-online.target</filename> (via a
<varname>Wants=</varname> type dependency) and order
themselves after it. This target unit is intended to pull in
a service that delays further execution until the network is
sufficiently set up. What precisely this requires is left to
the implementation of the network managing service.</para>
<para>Note the distinction between this unit and <filename>network.target</filename>. This unit
is an active unit (i.e. pulled in by the consumer rather than the provider of this functionality)
and pulls in a service which possibly adds substantial delays to further execution. In contrast,
<filename>network.target</filename> is a passive unit (i.e. pulled in by the provider of the
functionality, rather than the consumer) that usually does not delay execution much. Usually,
<filename>network.target</filename> is part of the boot of most systems, while
<filename>network-online.target</filename> is not, except when at least one unit requires
it. Also see <ulink url="https://systemd.io/NETWORK_ONLINE">Running Services After the Network Is
Up</ulink> for more information.</para>
<para>All mount units for remote network file systems automatically pull in this unit, and order
themselves after it. Note that networking daemons that simply <emphasis>provide</emphasis>
functionality to other hosts (as opposed to <emphasis>consume</emphasis> functionality of other
hosts) generally do not need to pull this in.</para>
<para>Note that this unit is only useful during the original system start-up
logic. After the system has completed booting up, it will not track the online state of
the system anymore. Due to this it cannot be used as a network connection monitor
concept, it is purely a one-time system start-up concept.</para>
<xi:include href="version-info.xml" xpointer="v200"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>paths.target</filename></term>
<listitem>
<para>A special target unit that sets up all path units (see
<citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details) that shall be active after boot.</para>
<para>It is recommended that path units installed by
applications get pulled in via <varname>Wants=</varname>
dependencies from this unit. This is best configured via a
<varname>WantedBy=paths.target</varname> in the path unit's
[Install] section.</para>
<xi:include href="version-info.xml" xpointer="v199"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>poweroff.target</filename></term>
<listitem>
<para>A special target unit for shutting down and powering
off the system.</para>
<para>Applications wanting to power off the system should not start this unit
directly, but should instead execute <command>systemctl poweroff</command>
(possibly with the <option>--no-block</option> option) or call
<citerefentry><refentrytitle>systemd-logind</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s
<command>org.freedesktop.login1.Manager.PowerOff</command> D-Bus method
directly.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>reboot.target</filename></term>
<listitem>
<para>A special target unit for shutting down and rebooting the system.</para>
<para>Applications wanting to reboot the system should not start this unit directly, but should
instead execute <command>systemctl reboot</command> (possibly with the
<option>--no-block</option> option) or call
<citerefentry><refentrytitle>systemd-logind</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s
<function>org.freedesktop.login1.Manager.Reboot()</function> D-Bus method directly.</para>
<para>See
<citerefentry><refentrytitle>systemd-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for further details of the operation this target pulls in.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>remote-cryptsetup.target</filename></term>
<listitem>
<para>Similar to <filename>cryptsetup.target</filename>, but for encrypted
devices which are accessed over the network. It is used for
<citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
entries marked with <option>_netdev</option>.</para>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>remote-integritysetup.target</filename></term>
<listitem>
<para>Similar to <filename>integritysetup.target</filename>, but for integrity protected devices
which are accessed over the network. It is used for
<citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
entries marked with <option>_netdev</option>.</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>remote-veritysetup.target</filename></term>
<listitem>
<para>Similar to <filename>veritysetup.target</filename>, but for verity
protected devices which are accessed over the network. It is used for
<citerefentry><refentrytitle>veritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
entries marked with <option>_netdev</option>.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>remote-fs.target</filename></term>
<listitem>
<para>Similar to <filename>local-fs.target</filename>, but
for remote mount points.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>rescue.target</filename></term>
<listitem>
<para>A special target unit that pulls in the base system (including system mounts) and
spawns a rescue shell. Isolate to this target in order to administer the system in
single-user mode with all file systems mounted but with no services running, except for
the most basic. Compare with <filename>emergency.target</filename>, which is much more
reduced and does not provide the file systems or most basic services. Compare with
<filename>multi-user.target</filename>, this target could be seen as
<filename>single-user.target</filename>.</para>
<para>Use the <literal>systemd.unit=rescue.target</literal> kernel command line option
to boot into this mode. A short alias for this kernel command line option is
<literal>1</literal>, for compatibility with SysV.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>shutdown.target</filename></term>
<listitem>
<para>A special target unit that terminates the services on
system shutdown.</para>
<para>Services that shall be terminated on system shutdown
shall add <varname>Conflicts=</varname> and
<varname>Before=</varname> dependencies to this unit for
their service unit, which is implicitly done when
<varname>DefaultDependencies=yes</varname> is set (the
default).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>sigpwr.target</filename></term>
<listitem>
<para>A special target that is started when systemd receives
the SIGPWR process signal, which is normally sent by the
kernel or UPS daemons when power fails.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>sleep.target</filename></term>
<listitem>
<para>A special target unit that is pulled in by <filename>suspend.target</filename>,
<filename>hibernate.target</filename>, <filename>suspend-then-hibernate.target</filename>, and
<filename>hybrid-sleep.target</filename> and may be used to hook units into the sleep state
logic.</para>
<para>In order to hook external programs <emphasis>before</emphasis> the actual system sleep
operation, place their command line in a service unit file's <varname>ExecStart=</varname> line
(use <varname>Type=oneshot</varname>), and ensure the unit is pulled in by
<filename>sleep.target</filename> and ordered before it. In order to hook program code
<emphasis>after</emphasis> the actual system sleep operation (i.e. to be run after the system
woke up again), place the command in <varname>ExecStop=</varname> instead, and make sure to
enable <varname>StopWhenUnneeded=</varname> and <varname>RemainAfterExit=</varname>. Both
approaches can be combined into one unit file in order to run programs both before and after the
sleep operation.</para>
<example>
<title>Combined Example</title>
<programlisting>[Unit]
DefaultDependencies=no
StopWhenUnneeded=yes
Before=sleep.target
[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=/usr/bin/some-before-command
ExecStop=/usr/bin/some-after-command
[Install]
WantedBy=sleep.target</programlisting>
</example>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>slices.target</filename></term>
<listitem>
<para>A special target unit that sets up all slice units (see
<citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details) that shall always be active after boot. By default, the generic
<filename>system.slice</filename> slice unit as well as the root slice unit
<filename>-.slice</filename> are pulled in and ordered before this unit (see
below).</para>
<para>Adding slice units to <filename>slices.target</filename> is generally not
necessary. Instead, when some unit that uses <varname>Slice=</varname> is started, the
specified slice will be started automatically. Adding
<varname>WantedBy=slices.target</varname> lines to the [Install]
section should only be done for units that need to be always active. In that case care
needs to be taken to avoid creating a loop through the automatic dependencies on
"parent" slices.</para>
<xi:include href="version-info.xml" xpointer="v229"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>sockets.target</filename></term>
<listitem>
<para>A special target unit that sets up all socket
units (see
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details) that shall be active after boot.</para>
<para>Services that can be socket-activated shall add
<varname>Wants=</varname> dependencies to this unit for
their socket unit during installation. This is best
configured via a <varname>WantedBy=sockets.target</varname>
in the socket unit's [Install]
section.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>soft-reboot.target</filename></term>
<listitem>
<para>A special target unit for shutting down and rebooting the userspace of the system (leaving
the kernel running).</para>
<para>Applications wanting to reboot the system should not start this unit directly, but should
instead execute <command>systemctl soft-reboot</command> (possibly with the
<option>--no-block</option> option) or call
<citerefentry><refentrytitle>systemd-logind</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s
<function>org.freedesktop.login1.Manager.RebootWithFlags()</function> D-Bus method
directly.</para>
<para>See
<citerefentry><refentrytitle>systemd-soft-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for further details of the operation this target pulls in.</para>
<xi:include href="version-info.xml" xpointer="v254"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>storage-target-mode.target</filename></term>
<listitem>
<para>A special target unit that can be booted into that selects the "Storage Target Mode" for
the OS. In this mode all local storage disks are exposed to external systems as block
devices. This invokes
<citerefentry><refentrytitle>systemd-storagetm.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
which exposes all local disks as NVMe-TCP devices for access over the network. It might as well
invoke other services too that make local disks available via other mechanisms.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>suspend.target</filename></term>
<listitem>
<para>A special target unit for suspending the system. This
pulls in <filename>sleep.target</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>swap.target</filename></term>
<listitem>
<para>Similar to <filename>local-fs.target</filename>, but
for swap partitions and swap files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>sysinit.target</filename></term>
<listitem>
<para>systemd automatically adds dependencies of the types
<varname>Requires=</varname> and <varname>After=</varname>
for this target unit to all services (except for those with
<varname>DefaultDependencies=no</varname>).</para>
<para>This target pulls in the services required for system
initialization. System services pulled in by this target should
declare <varname>DefaultDependencies=no</varname> and specify
all their dependencies manually, including access to anything
more than a read only root filesystem. For details on the
dependencies of this target, refer to
<citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>syslog.socket</filename></term>
<listitem>
<para>The socket unit syslog implementations should listen
on. All userspace log messages will be made available on
this socket. For more information about syslog integration,
please consult the <ulink
url="https://systemd.io/SYSLOG">Syslog
Interface</ulink> document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>system-update.target</filename></term>
<term><filename>system-update-pre.target</filename></term>
<term><filename>system-update-cleanup.service</filename></term>
<listitem>
<para>A special target unit that is used for offline system updates.
<citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
will redirect the boot process to this target if <filename>/system-update</filename> or
<filename>/etc/system-update</filename> exists. For more information see
<citerefentry><refentrytitle>systemd.offline-updates</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
</para>
<para>Updates should happen before the <filename>system-update.target</filename> is
reached, and the services which implement them should cause the machine to reboot. The
main units executing the update should order themselves after
<filename>system-update-pre.target</filename> but not pull it in. Services which want to
run during system updates only, but before the actual system update is executed should
order themselves before this unit and pull it in. As a safety measure, if this does not
happen, and <filename>/system-update</filename> or
<filename>/etc/system-update</filename> still exists after
<filename>system-update.target</filename> is reached,
<filename>system-update-cleanup.service</filename> will remove the symlinks and reboot
the machine.</para>
<xi:include href="version-info.xml" xpointer="v186"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>timers.target</filename></term>
<listitem>
<para>A special target unit that sets up all timer units
(see
<citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details) that shall be active after boot.</para>
<para>It is recommended that timer units installed by
applications get pulled in via <varname>Wants=</varname>
dependencies from this unit. This is best configured via
<varname>WantedBy=timers.target</varname> in the timer
unit's [Install] section.</para>
<xi:include href="version-info.xml" xpointer="v199"/>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>umount.target</filename></term>
<listitem>
<para>A special target unit that unmounts all mount and
automount points on system shutdown.</para>
<para>Mounts that shall be unmounted on system shutdown
shall add Conflicts dependencies to this unit for their
mount unit, which is implicitly done when
<varname>DefaultDependencies=yes</varname> is set (the
default).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Special System Units for Devices</title>
<para>Some target units are automatically pulled in as devices of
certain kinds show up in the system. These may be used to
automatically activate various services based on the specific type
of the available hardware.</para>
<variablelist>
<varlistentry>
<term><filename>bluetooth.target</filename></term>
<listitem>
<para>This target is started automatically as soon as a
Bluetooth controller is plugged in or becomes available at
boot.</para>
<para>This may be used to pull in Bluetooth management
daemons dynamically when Bluetooth hardware is found.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>printer.target</filename></term>
<listitem>
<para>This target is started automatically as soon as a
printer is plugged in or becomes available at boot.</para>
<para>This may be used to pull in printer management daemons
dynamically when printer hardware is found.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>smartcard.target</filename></term>
<listitem>
<para>This target is started automatically as soon as a
smartcard controller is plugged in or becomes available at
boot.</para>
<para>This may be used to pull in smartcard management
daemons dynamically when smartcard hardware is found.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>sound.target</filename></term>
<listitem>
<para>This target is started automatically as soon as a
sound card is plugged in or becomes available at
boot.</para>
<para>This may be used to pull in audio management daemons
dynamically when audio hardware is found.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>usb-gadget.target</filename></term>
<listitem>
<para>This target is started automatically as soon as a
USB Device Controller becomes available at boot.</para>
<para>This may be used to pull in usb gadget
dynamically when UDC hardware is found.</para>
<xi:include href="version-info.xml" xpointer="v242"/>
</listitem>