X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.special.xml;h=172836ee20e6ffc6be8216a3e476208afcccc15f;hp=9ea288e337a0525728298ed40819d98c9fc4d3f2;hb=1183f9b2252d0ee45ec7ad32ba34be746ceaaf6e;hpb=f848f8d87e3aafa514e8134e3ecf2317d89420e0
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 9ea288e33..172836ee2 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -64,21 +64,24 @@
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,
+ remote-fs-setup.target,
rescue.target,
+ initrd-root-fs.target,
rpcbind.target,
runlevel2.target,
runlevel3.target,
@@ -94,9 +97,9 @@
swap.target,
sysinit.target,
syslog.socket,
- syslog.target,
system-update.target,
time-sync.target,
+ timers.target,
umount.target
@@ -116,32 +119,23 @@
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.
-
-
-
- bluetooth.target
-
- This target is started
- automatically as soon as a
- bluetooth controller is
- plugged in or becomes
- available at boot.
+ general purpose
+ daemons.
@@ -169,7 +163,7 @@
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
@@ -182,7 +176,7 @@
A special unit for the
D-Bus system bus socket. All
units with
- Type=dbus
+ Type=dbus
automatically gain a
dependency on this
unit.
@@ -198,6 +192,7 @@
multi-user.target
or
graphical.target.
+
The default unit systemd
starts at bootup can be
overridden with the
@@ -214,14 +209,6 @@
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.
@@ -255,8 +242,10 @@
getty.targetA special target unit
- that pulls in all local TTY
- getty instances.
+ that pulls in statically
+ configured local TTY
+ getty
+ instances.
@@ -269,11 +258,17 @@
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.
@@ -298,13 +293,36 @@
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
@@ -330,60 +348,21 @@
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.
-
-
-
- local-fs-pre.target
-
- This target unit is
- automatically ordered before
- all local mount points marked
- with
- (see above). It can be used to
- execute certain units before
- 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.
+ mount
+ option set.
@@ -397,57 +376,38 @@
Units that are needed
for a multi-user system shall
- add Wants dependencies to
- this unit for their unit during
- installation.
-
-
-
- network.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
- $network
- facility.
+ 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.
- nss-lookup.target
+ paths.target
- 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.
+ 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.
@@ -465,16 +425,6 @@
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.
-
- reboot.target
@@ -500,24 +450,35 @@
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.
- remote-fs-pre.target
+ remote-fs-setup.targetThis target unit is
- automatically ordered before
- all remote mount points marked
- with
- (see above). It can be used to
- execute certain units before
- all remote mounts.
+ automatically pulled in (by a
+ Wants= type
+ dependency) by all remote
+ mount points. It can be used
+ to run certain units when at
+ least one remote file system
+ is to be mounted. Note that
+ this target is not ordered
+ against the remote mounts, use
+ remote-fs-pre.target
+ for that (see below).
+
+ Again, this target unit
+ is not
+ suitable for ordering, it is
+ only useful for pulling in
+ other units.
@@ -533,16 +494,17 @@
- rpcbind.target
+ initrd-root-fs.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
- $portmap
- facility.
+ systemd-fstab-generator3
+ automatically adds
+ dependencies of type
+ Before= to
+ the
+ sysroot.mount
+ unit, which is generated from
+ the kernel command line.
+
@@ -573,20 +535,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.
@@ -606,44 +560,35 @@
A special target unit
that is pulled in by
suspend.target,
- hibernate.target and hybrid-sleep.target
+ hibernate.target
+ and
+ hybrid-sleep.target
and may be used to hook units
into the sleep state
logic.
-
- smartcard.target
-
- This target is started
- automatically as soon as a
- smartcard controller is
- plugged in or becomes
- available at boot.
-
- sockets.targetA special target unit
- that sets up all service
- sockets.
+ 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.
-
-
-
- sound.target
-
- This target is started
- automatically as soon as a
- sound card is plugged in or
- becomes available at
- boot.
+ 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.
@@ -669,16 +614,6 @@
A 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.
@@ -697,19 +632,6 @@
document.
-
- syslog.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.
-
- system-update.target
@@ -728,16 +650,26 @@
- time-sync.target
+ timers.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
- $time
- facility.
+ 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.
@@ -762,6 +694,239 @@
+
+ Special System Units for Devices
+
+ 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.
+
+
+
+ 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.
+
+
+
+ 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.
+
+
+
+ smartcard.target
+
+ 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.
+
+
+
+ sound.target
+
+ 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.
+
+
+
+
+
+
+ Special Passive System Units
+
+ A number of special system targets are defined
+ that can be used to properly order boot-up of optional
+ services. These targets are generally not part of the
+ initial boot transaction, unless they are explicitly
+ pulled in by one of the implementing services. Note
+ specifically, that these passive
+ target units are generally not pulled in by the
+ consumer of a service, but by the provider of the
+ service. This means: a consuming service should order
+ itself after these targets (as appropriate), but not
+ pull it in. A providing service should order itself
+ before these targets (as appropriate) and pull it in
+ (via a Wants= type
+ dependency).
+
+ Note that these passive units cannot be started
+ manually, i.e. systemctl start
+ time-sync.target will fail with an
+ error. They can only be pulled in by dependency. This
+ is enforced since they exist for ordering purposes
+ only and thus are not useful as only unit within a
+ transaction.
+
+
+
+ local-fs-pre.target
+
+ This target unit is
+ automatically ordered before
+ all local mount points marked
+ with
+ (see above). It can be used to
+ execute certain units before
+ all local mounts.
+
+
+
+ network.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
+ $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
+
+ 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.
+
+
+
+ remote-fs-pre.target
+
+ This target unit is
+ automatically ordered before
+ all remote mount point units
+ (see above). It can be used to
+ run certain units before the
+ remote mounts are
+ established. Note that this
+ unit is generally not part of
+ the initial transaction,
+ unless the unit that wants to
+ be ordered before all remote
+ mounts pulls it in via a
+ Wants= type
+ dependency. If the unit wants
+ to be pulled in by the first
+ remote mount showing up it
+ should use
+ remote-fs-setup.target
+ (see above).
+
+ Again, this target unit
+ is not
+ suitable for pulling in other
+ units, it is only useful for
+ ordering.
+
+
+
+ rpcbind.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
+ $portmap
+ facility.
+
+
+
+ time-sync.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
+ $time
+ facility.
+
+
+
+
+
Special User Units
@@ -770,7 +935,13 @@
similar definitions as their system counterparts:
default.target,
shutdown.target,
- sockets.target
+ sockets.target,
+ timers.target,
+ paths.target,
+ bluetooth.target,
+ printer.target,
+ smartcard.target,
+ sound.target.
In addition the following special unit is
understood only when systemd runs as service instance:
@@ -810,7 +981,8 @@
systemd.service5,
systemd.socket5,
systemd.target5,
- bootup7
+ bootup7,
+ systemd-fstab-generator8