X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.special.xml;h=6b8e0ec7f0b8fe7cedc9a95ada2622a690dc0940;hp=e81e99e44efe07ce4572ae6c9c8d1abec34d3e37;hb=6524990fdc98370ecba5d9f73e67161e8798c010;hpb=bd3d19a4ea3b007bea4c94213cafd5dc37ce7a3d;ds=sidebyside diff --git a/man/systemd.special.xml b/man/systemd.special.xml index e81e99e44..6b8e0ec7f 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,42 +44,61 @@ systemd.special - special systemd units + Special systemd units - basic.target - ctrl-alt-del.target - default.target - emergency.service - graphical.target - halt.target - kbrequest.target - local-fs.target - multi-user.target - network.target - nss-lookup.target - poweroff.target - reboot.target - remote-fs.target - rescue.target - rpcbind.target - rtc-set.target - runlevel0.target, - runlevel0.target, - runlevel1.target, - runlevel2.target, - runlevel3.target, - runlevel4.target, - runlevel5.target, - runlevel6.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, + hibernate.target, + http-daemon.target, + hybrid-sleep.target, + halt.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, + 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, + syslog.target, + system-update.target, + time-sync.target, + umount.target @@ -105,16 +124,25 @@ target unit to all SysV service units configured for runlevel 1 to 5. - 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. + 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. @@ -129,6 +157,38 @@ 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 @@ -141,25 +201,67 @@ graphical.target. The default unit systemd starts at bootup can be - overriden with the - systemd.default= + overridden with the + systemd.unit= kernel command line option. - emergency.service + display-manager.service - A special service unit + The display manager + service. Usually this should + be aliased (symlinked) to + 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. + + + + 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 @@ -176,6 +278,40 @@ during installation. + + hibernate.target + + A special target unit + for hibernating the + system. This pulls in + sleep.target. + + + + http-daemon.target + + A target for pulling in + an HTTP server if there is + any. + 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 + $httpd + facility. + + + + hybrid-sleep.target + + A special target unit + for hibernating and suspending the + system at the same time. This pulls in + sleep.target. + + halt.target @@ -198,6 +334,17 @@ 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 @@ -212,8 +359,8 @@ mounts listed in /etc/fstab that have the - auto and - comment=systemd.mount + and + mount options set. systemd automatically @@ -226,6 +373,41 @@ 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 + or + $mail-transport-agent + facilities, for compatibility + with Debian. + + multi-user.target @@ -258,16 +440,38 @@ 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. + + poweroff.target @@ -283,6 +487,16 @@ 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 @@ -312,10 +526,22 @@ all SysV init script service units with an LSB header referring to the - $remote-fs + $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 @@ -337,54 +563,15 @@ all SysV init script service units with an LSB header referring to the - $rpcbind - facility. - - - - rtc-set.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 + $portmap facility. - - runlevel0.target - - This is a target that is - called whever the SysV - compatibility code asks for - runlevel 0. This is an alias - for - poweroff.target, - for compatibility with - SysV. - - - - runlevel1.target - - This is a target that is - called whever the SysV - compatibility code asks for - runlevel 1. This is an alias - for - rescue.target, - for compatibility with - SysV. - - runlevel2.target This is a target that is - called whever the SysV + called whenever the SysV compatibility code asks for runlevel 2. It is a good idea to make this an alias for @@ -396,7 +583,7 @@ runlevel3.target This is a target that is - called whever the SysV + called whenever the SysV compatibility code asks for runlevel 3. It is a good idea to make this an alias for @@ -410,7 +597,7 @@ runlevel4.target This is a target that is - called whever the SysV + called whenever the SysV compatibility code asks for runlevel 4. It is a good idea to make this an alias for @@ -424,7 +611,7 @@ runlevel5.target This is a target that is - called whever the SysV + called whenever the SysV compatibility code asks for runlevel 5. It is a good idea to make this an alias for @@ -434,19 +621,6 @@ graphical.target. - - runlevel6.target - - This is a target that is - called whever the SysV - compatibility code asks for - runlevel 6. This is an alias - for - reboot.target, - for compatibility with - SysV. - - shutdown.target @@ -458,8 +632,10 @@ terminated on system shutdown shall add Conflicts dependencies to this unit for - their service unit during - installation. + their service unit, which is + implicitly done when + DefaultDependencies=yes + is set (the default). systemd automatically adds dependencies of type @@ -481,6 +657,28 @@ 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 @@ -495,6 +693,25 @@ 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 @@ -504,6 +721,39 @@ files. + + sysinit.target + + 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. + + + + syslog.socket + + The socket unit where + 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. + + syslog.target @@ -515,89 +765,109 @@ referring to the $syslog facility. - - Administrators should - ensure that this target pulls - in a service unit with the - name or alias of - @SPECIAL_SYSLOG_SERVICE@ - (or a socket unit that - activates this - service). - systemd-initctl.service + system-update.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. - - - - systemd-initctl.socket - - 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 internally used - by systemd to provide syslog - logging to the processes it - maintains. - 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. 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. + 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: default.target, - local-fs.target, - remote-fs.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