X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.special.xml;h=8a7242662d7ac6c94958e2266803f05464849b18;hb=e3d84721dc9bcf9008f72dae03ff0f7842d0bb4b;hp=116a43ccfb30798e6570fdeb43df6ac2963c962c;hpb=19c5f19d69bb5f520fa7213239490c55de06d99d;p=elogind.git
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 116a43ccf..8a7242662 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -8,16 +8,16 @@
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ 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.
systemd 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
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
@@ -44,31 +44,43 @@
systemd.special
- special systemd units
+ Special systemd unitsbasic.target,
+ bluetooth.target,
ctrl-alt-del.target,
+ cryptsetup.target,
dbus.service,
+ dbus.socket,
default.target,
display-manager.service,
emergency.target,
- exit.service,
+ exit.target,
+ final.target,
+ getty.target,
graphical.target,
halt.target,
+ hibernate.target,
+ hybrid-sleep.target,
+ initrd-fs.target,
kbrequest.target,
+ kexec.target,
local-fs.target,
local-fs-pre.target,
- mail-transfer-agent.target,
multi-user.target,
network.target,
nss-lookup.target,
+ nss-user-lookup.target,
+ paths.target,
poweroff.target,
+ printer.target,
reboot.target,
remote-fs.target,
remote-fs-pre.target,
rescue.target,
+ initrd-root-fs.target,
rpcbind.target,
runlevel2.target,
runlevel3.target,
@@ -76,15 +88,17 @@
runlevel5.target,
shutdown.target,
sigpwr.target,
+ sleep.target,
+ smartcard.target,
sockets.target,
+ sound.target,
+ suspend.target,
swap.target,
sysinit.target,
- syslog.target,
- systemd-initctl.service,
- systemd-initctl.socket,
- systemd-stdout-syslog-bridge.service,
- systemd-stdout-syslog-bridge.socket,
+ syslog.socket,
+ system-update.target,
time-sync.target,
+ timers.target,
umount.target
@@ -104,22 +118,39 @@
basic.targetA special target unit
- covering early boot-up.
+ covering basic boot-up.
systemd automatically
adds dependencies of the types
- Requires and After for this
- target unit to all SysV
- service units configured for
- runlevel 1 to 5.
- Usually this should pull-in
- all sockets, mount points,
- swap devices and other basic
+ Requires=
+ and After=
+ for this target unit to all
+ services (except for those
+ with
+ DefaultDependencies=no).
+
+ Usually this should
+ pull-in all mount points, swap
+ devices, sockets, timers, and
+ path units and other basic
initialization necessary for
- the general purpose
- daemons. Most normal daemons
- should have dependencies of
- type After and Requires on
- this unit.
+ general purpose
+ daemons.
+
+
+
+ bluetooth.target
+
+ This target is started
+ automatically as soon as a
+ Bluetooth controller is
+ plugged in or becomes
+ available at boot.
+
+ This may be used to pull
+ in Bluetooth management
+ daemons dynamically when
+ Bluetooth hardware is
+ found.
@@ -134,17 +165,38 @@
reboot.target.
+
+ cryptsetup.target
+
+ A target that pulls in
+ setup services for all
+ encrypted block
+ devices.
+
+ dbus.serviceA special unit for the
- D-Bus system bus. As soon as
+ D-Bus bus daemon. As soon as
this service is fully started
up systemd will connect to it
and register its
service.
+
+ dbus.socket
+
+ A special unit for the
+ D-Bus system bus socket. All
+ units with
+ Type=dbus
+ automatically gain a
+ dependency on this
+ unit.
+
+ default.target
@@ -155,6 +207,7 @@
multi-user.target
or
graphical.target.
+
The default unit systemd
starts at bootup can be
overridden with the
@@ -168,18 +221,9 @@
The display manager
service. Usually this should
be aliased (symlinked) to
- xdm.service
+ gdm.service
or a similar display manager
service.
- systemd automatically
- adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with a LSB header
- referring to the
- $x-display-manager
- facility, for compatibility
- with Debian.
@@ -196,6 +240,30 @@
+
+ final.target
+
+ 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.
+
+
+
+
+ getty.target
+
+ A special target unit
+ that pulls in statically
+ configured local TTY
+ getty
+ instances.
+
+
+ graphical.target
@@ -205,24 +273,71 @@
multi-user.target.
Units that are needed
- for graphical login shall add
- Wants dependencies for their
- unit to this unit (or
+ for graphical logins shall add
+ Wants=
+ dependencies for their unit to
+ this unit (or
multi-user.target)
- during installation.
+ during installation. This is
+ best configured via
+ WantedBy=graphical.target
+ in the unit's
+ [Install]
+ section.
+
+
+
+ hibernate.target
+
+ A special target unit
+ for hibernating the
+ system. This pulls in
+ sleep.target.
+
+
+
+ hybrid-sleep.target
+
+ A special target unit
+ for hibernating and suspending the
+ system at the same time. This pulls in
+ sleep.target.halt.targetA special target unit
- for shutting down and halting the system.
+ for shutting down and halting
+ the system. Note that this
+ target is distinct from
+ poweroff.target
+ in that it generally really
+ just halts the system rather
+ than powering it down.
Applications wanting to
halt the system should start
this unit.
+
+ initrd-fs.target
+
+ systemd-fstab-generator3
+ automatically adds
+ dependencies of type
+ Before= to
+ sysroot-usr.mount
+ and all mount points fround in
+ /etc/fstab
+ that have the
+ and
+
+ mount options set.
+
+
+ kbrequest.target
@@ -234,32 +349,35 @@
rescue.target.
+
+ kexec.target
+
+ A special target unit
+ for shutting down and rebooting the system via kexec.
+
+ Applications wanting to
+ reboot the system with kexec should start
+ this unit.
+
+ local-fs.target
- systemd automatically
+ systemd-fstab-generator3
+ automatically adds
+ dependencies of type
+ Before= to
+ all mount units that refer to
+ local mount points for this
+ target unit. In addition, it
adds dependencies of type
- After to all mount units that
- refer to local mount points
- for this target unit. In
- addition, systemd adds
- dependencies of type Wants to
+ Wants= to
this target unit for those
mounts listed in
/etc/fstab
that have the
- and
-
- mount options set.
-
- systemd automatically
- adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
- $local_fs
- facility.
+ mount
+ option set.
@@ -274,29 +392,6 @@
all local mounts.
-
- mail-transfer-agent.target
-
- The mail transfer agent
- (MTA) service. Usually this
- should pull-in all units
- necessary for
- sending/receiving mails on the
- local host.
-
- systemd automatically
- adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
- $mail-transfer-agent
- or
- $mail-transport-agent
- facilities, for compatibility
- with Debian.
-
- multi-user.target
@@ -308,9 +403,15 @@
Units that are needed
for a multi-user system shall
- add Wants dependencies to
- this unit for their unit during
- installation.
+ add Wants=
+ dependencies for their unit to
+ this unit during
+ installation. This is best
+ configured via
+ WantedBy=multi-uer.target
+ in the unit's
+ [Install]
+ section.
@@ -318,27 +419,83 @@
systemd automatically
adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
+ After= for
+ this target unit to all SysV
+ init script service units with
+ an LSB header referring to the
$network
facility.
+
+ This unit is supposed to
+ indicate when the network is
+ "up", but it is only very
+ loosely defined what that is
+ supposed to mean. Also see Running
+ Services After the Network is
+ up for more
+ information.nss-lookup.target
- systemd automatically
- adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
+ A target that should be
+ used as synchronization point
+ for all host/network name
+ service lookups. Note that
+ this is independent of
+ user/group name lookups for
+ which
+ nss-user-lookup.target
+ should be used. systemd
+ automatically adds
+ dependencies of type
+ After= for
+ this target unit to all SysV
+ init script service units with
+ an LSB header referring to the
$named
facility.
+
+ nss-user-lookup.target
+
+ A target that should be
+ used as synchronization point
+ for all user/group name
+ service lookups. Note that
+ this is independent of
+ host/network name lookups for
+ which
+ nss-lookup.target
+ should be used.
+
+
+
+ paths.target
+
+ A special target unit
+ that sets up all path units
+ (see
+ systemd.path5
+ for details) that shall be
+ active after boot.
+
+ It is recommended that
+ path units installed by
+ applications get pulled in via
+ Wants=
+ dependencies from this
+ unit. This is best configured
+ via a
+ WantedBy=paths.target
+ in the path unit's
+ [Install]
+ section.
+
+ poweroff.target
@@ -354,6 +511,22 @@
unit, for compatibility with SysV.
+
+ printer.target
+
+ This target is started
+ automatically as soon as a
+ printer is plugged in or
+ becomes available at
+ boot.
+
+ This may be used to pull
+ in printer management
+ daemons dynamically when
+ printer hardware is
+ found.
+
+ reboot.target
@@ -379,10 +552,10 @@
systemd automatically
adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
+ After= for
+ this target unit to all SysV
+ init script service units with
+ an LSB header referring to the
$remote_fs
facility.
@@ -411,71 +584,50 @@
unit, for compatibility with SysV.
+
+ initrd-root-fs.target
+
+ systemd-fstab-generator3
+ automatically adds
+ dependencies of type
+ Before= to
+ the
+ sysroot.mount
+ unit, which is generated from
+ the kernel command line.
+
+
+ rpcbind.targetsystemd automatically
adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
- $rpcbind
+ After= for
+ this target unit to all SysV
+ init script service units with
+ an LSB header referring to the
+ $portmap
facility.runlevel2.target
-
- This is a target that is
- called whenever the SysV
- compatibility code asks for
- runlevel 2. It is a good idea
- to make this an alias for
- (i.e. symlink to)
- multi-user.target.
-
-
- runlevel3.target
-
- This is a target that is
- called whenever the SysV
- compatibility code asks for
- runlevel 3. It is a good idea
- to make this an alias for
- (i.e. symlink to)
- multi-user.target
- or
- graphical.target.
-
-
- runlevel4.target
-
- This is a target that is
- called whenever the SysV
- compatibility code asks for
- runlevel 4. It is a good idea
- to make this an alias for
- (i.e. symlink to)
- multi-user.target
- or
- graphical.target.
-
-
- runlevel5.target
- This is a target that is
- called whenever the SysV
+ These are targets that
+ are called whenever the SysV
compatibility code asks for
- runlevel 5. It is a good idea
- to make this an alias for
+ runlevel 2, 3, 4, 5,
+ respectively. It is a good
+ idea to make this an alias for
(i.e. symlink to)
multi-user.target
- or
- graphical.target.
+ (for runlevel 2) or
+ graphical.target
+ (the others).
@@ -487,20 +639,12 @@
Services that shall be
terminated on system shutdown
- shall add Conflicts
+ shall add Conflicts=
dependencies to this unit for
their service unit, which is
implicitly done when
DefaultDependencies=yes
is set (the default).
-
- systemd automatically
- adds dependencies of type
- Conflicts to this target unit
- for all SysV init script
- service units that shall be
- terminated in SysV runlevels 0
- or 6.
@@ -515,124 +659,129 @@
- sockets.target
+ sleep.targetA special target unit
- that sets up all service
- sockets.
-
- Services that can be
- socket-activated shall add
- Wants dependencies to this
- unit for their socket unit
- during installation.
+ that is pulled in by
+ suspend.target,
+ hibernate.target
+ and
+ hybrid-sleep.target
+ and may be used to hook units
+ into the sleep state
+ logic.
- swap.target
+ smartcard.target
- Similar to
- local-fs.target, but for swap
- partitions and swap
- files.
+ This target is started
+ automatically as soon as a
+ smartcard controller is
+ plugged in or becomes
+ available at boot.
+
+ This may be used to pull
+ in printer management
+ daemons dynamically when
+ smartcard hardware is
+ found.
- sysinit.target
+ sockets.targetA special target unit
- covering early boot-up scripts.
- systemd automatically
- adds dependencies of the types
- Wants and After for all
- SysV service units configured
- for runlevels that are not 0
- to 6 to this target unit.
- This covers the special
- boot-up runlevels some
- distributions have, such as S
- or b.
+ that sets up all socket
+ units.(see
+ systemd.socket5
+ for details) that shall be
+ active after boot.
+
+ Services that can be
+ socket-activated shall add
+ Wants=
+ dependencies to this unit for
+ their socket unit during
+ installation. This is best
+ configured via a
+ WantedBy=sockets.target
+ in the socket unit's
+ [Install]
+ section.
- syslog.target
+ sound.target
- systemd automatically
- adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
- $syslog
- facility.
+ This target is started
+ automatically as soon as a
+ sound card is plugged in or
+ becomes available at
+ boot.
+
+ This may be used to pull
+ in audio management daemons
+ dynamically when printer
+ hardware is found.
- systemd-initctl.service
+ suspend.target
- This provides
- compatibility with the SysV
- /dev/initctl file system FIFO
- for communication with the
- init system.
- This is a
- socket-activated service, see
- system-initctl.socket.
+ A special target unit
+ for suspending the
+ system. This pulls in
+ sleep.target.
- systemd-initctl.socket
+ swap.target
- Socket activation unit
- for
- system-initctl.service.
+ Similar to
+ local-fs.target, but for swap
+ partitions and swap
+ files.
- systemd-stdout-syslog-bridge.service
+ sysinit.target
- This is internally used
- by systemd to provide syslog
- logging to the processes it
- maintains.
- This is a
- socket-activated service, see
- system-stdout-syslog-bridge.socket.
+ A special target unit
+ covering early boot-up scripts.
- systemd-stdout-syslog-bridge.socket
-
- Socket activation unit
- for
- system-stdout-syslog-bridge.service. systemd
- will automatically add
- dependencies of types Requires
- and After to all units that
- have been configured for
- stdout or stderr to be
- connected to syslog or the
- kernel log buffer.
-
-
-
- systemd-shutdownd.service
+ syslog.socket
- This is internally used
- by
- shutdown8
- to implement delayed shutdowns.
- This is a
- socket-activated service, see
- system-shutdownd.socket.
+ 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 Syslog
+ Interface
+ document.
- systemd-shutdownd.socket
+ system-update.target
- Socket activation unit
- for
- system-shutdownd.service.
+ A special target unit
+ that is used for off-line
+ system updates.
+ systemd-system-update-generator8
+ will redirect the boot process
+ to this target if
+ /system-update
+ exists. For more information
+ see the System
+ Updates
+ Specification.
@@ -640,14 +789,37 @@
systemd automatically
adds dependencies of type
- After for this target unit to
- all SysV init script service
- units with an LSB header
- referring to the
+ After= for
+ this target unit to all SysV
+ init script service units with
+ an LSB header referring to the
$time
facility.
+
+ timers.target
+
+ A special target unit
+ that sets up all timer
+ units (see
+ systemd.timer5
+ for details) that shall be
+ active after boot.
+
+ It is recommended that
+ timer units installed by
+ applications get pulled in via
+ Wants=
+ dependencies from this
+ unit. This is best configured
+ via
+ WantedBy=timers.target
+ in the timer unit's
+ [Install]
+ section.
+
+ umount.target
@@ -666,6 +838,7 @@
is set (the default).
+
@@ -676,18 +849,15 @@
following special units are available, which have
similar definitions as their system counterparts:
default.target,
- local-fs.target,
- remote-fs.target,
shutdown.target,
- sockets.target,
- swap.target.
+ sockets.targetIn addition the following special unit is
understood only when systemd runs as service instance:
- exit.service
+ exit.targetA special service unit
for shutting down the
@@ -715,10 +885,13 @@
See Also
+ systemd1,
systemd.unit5,
systemd.service5,
systemd.socket5,
- systemd.target5
+ systemd.target5,
+ bootup7,
+ systemd-fstab-generator8