X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.special.xml;h=0d1df8475a353212be31493dbd12c64cbedfa58c;hp=3f9286d4b4e4a13434007ec7d0af0b889959e873;hb=4f19b1df41b9a1971989ffd858d0a2f6977b01c8;hpb=9f23530860942a8f94b7c535ead80c38f02424b1
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 3f9286d4b..0d1df8475 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,26 +44,58 @@
systemd.special
- special systemd units
+ Special systemd units
- emergency.service
- local-fs.target
- network.target
- nss-lookup.target
- remote-fs.target
- rpcbind.target
- rtc-set.target
- shutdown.target
- sigpwr.target
- sockets.target
- swap.target
- syslog.target
- systemd-initctl.service
- systemd-initctl.socket
- systemd-logger.service
- systemd-logger.socket
+ basic.target,
+ bluetooth.target,
+ ctrl-alt-del.target,
+ cryptsetup.target,
+ dbus.service,
+ dbus.socket,
+ default.target,
+ display-manager.service,
+ emergency.target,
+ exit.target,
+ final.target,
+ getty.target,
+ graphical.target,
+ halt.target,
+ hibernate.target,
+ hybrid-sleep.target,
+ kbrequest.target,
+ kexec.target,
+ local-fs.target,
+ local-fs-pre.target,
+ multi-user.target,
+ network.target,
+ nss-lookup.target,
+ nss-user-lookup.target,
+ poweroff.target,
+ printer.target,
+ reboot.target,
+ remote-fs.target,
+ remote-fs-pre.target,
+ rescue.target,
+ rpcbind.target,
+ runlevel2.target,
+ runlevel3.target,
+ runlevel4.target,
+ runlevel5.target,
+ shutdown.target,
+ sigpwr.target,
+ sleep.target,
+ smartcard.target,
+ sockets.target,
+ sound.target,
+ suspend.target,
+ swap.target,
+ sysinit.target,
+ syslog.socket,
+ system-update.target,
+ time-sync.target,
+ umount.target
@@ -79,43 +111,257 @@
- emergency.service
+ basic.target
- A special service unit
+ A special target unit
+ covering early 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
+ 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.
+
+
+
+ ctrl-alt-del.target
+
+ systemd starts this
+ target whenever
+ Control+Alt+Del is pressed on
+ the console. Usually this
+ should be aliased (symlinked)
+ to
+ reboot.target.
+
+
+
+ cryptsetup.target
+
+ A target that pulls in
+ setup services for all
+ encrypted block
+ devices.
+
+
+
+ dbus.service
+
+ A special unit for the
+ D-Bus system bus. 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
+
+ The default unit systemd
+ starts at bootup. Usually this
+ should be aliased (symlinked)
+ to
+ multi-user.target
+ or
+ graphical.target.
+ The default unit systemd
+ starts at bootup can be
+ overridden with the
+ systemd.unit=
+ kernel command line option.
+
+
+
+ display-manager.service
+
+ The display manager
+ service. Usually this should
+ be aliased (symlinked) to
+ gdm.service
+ or a similar display manager
+ service.
+
+
+
+ emergency.target
+
+ A special target unit
that starts an emergency
shell on the main
console. This unit is supposed
to be used with the kernel
command line option
- systemd.default=
+ systemd.unit=
and has otherwise little use.
+
+ 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 all local TTY
+ getty instances.
+
+
+
+
+ graphical.target
+
+ A special target unit
+ for setting up a graphical
+ login screen. This pulls in
+ multi-user.target.
+
+ Units that are needed
+ for graphical login shall add
+ Wants dependencies for their
+ unit to this unit (or
+ multi-user.target)
+ during installation.
+
+
+
+ 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.target
+
+ A special target unit
+ for shutting down and halting the system.
+
+ Applications wanting to
+ halt the system should start
+ this unit.
+
+
+
+ kbrequest.target
+
+ systemd starts this
+ target whenever Alt+ArrowUp is
+ pressed on the console. This
+ is a good candidate to be
+ aliased (symlinked) to
+ 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.targetsystemd automatically
adds dependencies of type
After to all mount units that
- refer to local mount
- points. In addition, systemd
- adds dependencies of type
- Wants to those mounts listed
- in
+ refer to local mount points
+ for this target unit. In
+ addition, systemd adds
+ dependencies of type Wants to
+ this target unit for those
+ mounts listed in
/etc/fstab
that have the
- auto and
- comment=systemd.mount
+ and
+
mount options set.
+
+
+
+ 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.
+
+
+
+ multi-user.target
+
+ A special target unit
+ for setting up a multi-user
+ system (non-graphical). This
+ is pulled in by
+ graphical.target.
- systemd automatically
- adds dependencies of type
- After to this target unit for
- all SysV init scripts with an
- LSB header referring to the
- $local_fs
- facility.
+ Units that are needed
+ for a multi-user system shall
+ add Wants dependencies to
+ this unit for their unit during
+ installation.
@@ -123,60 +369,171 @@
systemd automatically
adds dependencies of type
- After to this target unit for
- all SysV init scripts 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 to this target unit for
- all SysV init scripts 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.
+
+
+
+ poweroff.target
+
+ A special target unit
+ for shutting down and powering off the system.
+
+ Applications wanting to
+ power off the system should start
+ this unit.
+
+ runlevel0.target
+ is an alias for this target
+ 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
+
+ A special target unit
+ for shutting down and rebooting the system.
+
+ Applications wanting to
+ reboot the system should start
+ this unit.
+
+ runlevel6.target
+ is an alias for this target
+ unit, for compatibility with SysV.
+
+ remote-fs.target
- Similar to local-fs.target, but for remote mount points.
+ Similar to
+ local-fs.target,
+ but for remote mount
+ points.
+
systemd automatically
adds dependencies of type
- After to this target unit for
- all SysV init scripts with an
- LSB header referring to the
- $remote-fs
+ 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
+
+ This 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.
+
+
+
+ rescue.target
+
+ A special target unit
+ for setting up the base system
+ and a rescue shell.
+
+ runlevel1.target
+ is an alias for this target
+ unit, for compatibility with SysV.
+
+ rpcbind.targetsystemd automatically
adds dependencies of type
- After to this target unit for
- all SysV init scripts 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.
- rtc-set.target
+ runlevel2.target
+ runlevel3.target
+ runlevel4.target
+ runlevel5.target
- systemd automatically
- adds dependencies of type
- After to this target unit for
- all SysV init scripts with an
- LSB header referring to the
- $time
- facility.
+ These are targets that
+ are called whenever the SysV
+ compatibility code asks 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
+ (for runlevel 2) or
+ graphical.target
+ (the others).
@@ -188,17 +545,20 @@
Services that shall be
terminated on system shutdown
- shall add Wants dependencies
- from this unit to their
- service unit during
- installation.
+ 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 scripts that
- shall be terminated in SysV
- runlevels 0 or 6.
+ for all SysV init script
+ service units that shall be
+ terminated in SysV runlevels 0
+ or 6.
@@ -208,10 +568,32 @@
started when systemd receives
the SIGPWR process signal,
which is normally sent by the
- kernel or UPS daemons when the
+ kernel or UPS daemons when
power fails.
+
+ sleep.target
+
+ A special target unit
+ 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.
+
+
+
+ smartcard.target
+
+ This target is started
+ automatically as soon as a
+ smartcard controller is
+ plugged in or becomes
+ available at boot.
+
+ sockets.target
@@ -221,11 +603,30 @@
Services that can be
socket-activated shall add
- Wants dependencies from this
- unit to their socket unit
+ 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.
+
+
+
+ suspend.target
+
+ A special target unit
+ for suspending the
+ system. This pulls in
+ sleep.target.
+
+ swap.target
@@ -236,89 +637,129 @@
- syslog.target
+ sysinit.target
- systemd automatically
- adds dependencies of type
- After to this target unit for
- all SysV init scripts with an
- LSB header referring to the
- $syslog
- facility.
-
- Administrators should
- ensure that this target pulls
- in a service unit with the
- name or alias of
- @SPECIAL_SYSLOG_NAME@ (or a
- socket unit that activates
- this service).
+ A special target unit
+ covering early boot-up scripts.
- systemd-initctl.service
+ syslog.socket
- 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.
+ 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-initctl.socket
+ system-update.target
- Socket activation unit
- for
- system-initctl.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.
- systemd-logger.service
+ time-sync.target
- This is used internally
- by systemd to provide syslog
- logging to started
- processes.
- This is a
- socket-activated service, see
- system-logger.socket.
+ 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.
- systemd-logger.socket
+ umount.target
- Socket activation unit
- for
- system-logger.service.
+ A special target unit
+ that umounts all mount and
+ automount points on system
+ shutdown.
+
+ Mounts that shall be
+ unmounted on system shutdown
+ shall add Conflicts
+ dependencies to this unit for
+ their mount unit, which is
+ implicitly done when
+ DefaultDependencies=yes
+ is set (the default).
+
- Special Session Units
+ Special User Units
- When systemd runs as a service instance, the
+ When systemd runs as a user instance, the
following special units are available, which have
similar definitions as their system counterparts:
- local-fs.target,
- remote-fs.target,
+ default.target,
shutdown.target,
- sockets.target,
- swap.target.
+ sockets.target
+
+ In addition the following special unit is
+ understood only when systemd runs as service instance:
+
+
+
+ exit.target
+
+ A special service unit
+ for shutting down the
+ user service manager.
+
+ Applications wanting to
+ terminate the user service
+ manager should start this
+ unit. If systemd receives
+ SIGTERM or SIGINT when running
+ as user service daemon it will
+ start this unit.
+
+ Normally, this pulls in
+ shutdown.target
+ which in turn should be
+ conflicted by all units that
+ want to be shut down on
+ user service manager exit.
+
+
+ See Also
- systemd.unit5
- systemd.service5
- systemd.socket5
- systemd.target5
+ systemd1,
+ systemd.unit5,
+ systemd.service5,
+ systemd.socket5,
+ systemd.target5,
+ bootup7