From feb88c9ff52b52a1fc0f075cba1215e4c2a82545 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 3 Apr 2012 22:32:05 +0200
Subject: man: update documentation of special units

---
 man/systemd.special.xml | 162 +++++++++++++++++++++++++-----------------------
 1 file changed, 84 insertions(+), 78 deletions(-)

(limited to 'man')

diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 116a43ccfb..fe85137ffe 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -44,20 +44,24 @@
 
         <refnamediv>
                 <refname>systemd.special</refname>
-                <refpurpose>special systemd units</refpurpose>
+                <refpurpose>Special systemd units</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
                 <para><filename>basic.target</filename>,
                 <filename>ctrl-alt-del.target</filename>,
                 <filename>dbus.service</filename>,
+                <filename>dbus.socket</filename>,
                 <filename>default.target</filename>,
                 <filename>display-manager.service</filename>,
                 <filename>emergency.target</filename>,
                 <filename>exit.service</filename>,
+                <filename>final.service</filename>,
                 <filename>graphical.target</filename>,
+                <filename>http-daemon.target</filename>,
                 <filename>halt.target</filename>,
                 <filename>kbrequest.target</filename>,
+                <filename>kexec.target</filename>,
                 <filename>local-fs.target</filename>,
                 <filename>local-fs-pre.target</filename>,
                 <filename>mail-transfer-agent.target</filename>,
@@ -79,11 +83,9 @@
                 <filename>sockets.target</filename>,
                 <filename>swap.target</filename>,
                 <filename>sysinit.target</filename>,
+                <filename>syslog.service</filename>,
+                <filename>syslog.socket</filename>,
                 <filename>syslog.target</filename>,
-                <filename>systemd-initctl.service</filename>,
-                <filename>systemd-initctl.socket</filename>,
-                <filename>systemd-stdout-syslog-bridge.service</filename>,
-                <filename>systemd-stdout-syslog-bridge.socket</filename>,
                 <filename>time-sync.target</filename>,
                 <filename>umount.target</filename></para>
         </refsynopsisdiv>
@@ -145,6 +147,18 @@
                                         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
+                                        <literal>Type=dbus</literal>
+                                        automatically gain a
+                                        dependency on this
+                                        unit.</para>
+                                </listitem>
+                        </varlistentry>
                         <varlistentry>
                                 <term><filename>default.target</filename></term>
                                 <listitem>
@@ -168,7 +182,7 @@
                                         <para>The display manager
                                         service. Usually this should
                                         be aliased (symlinked) to
-                                        <filename>xdm.service</filename>
+                                        <filename>gdm.service</filename>
                                         or a similar display manager
                                         service.</para>
                                         <para>systemd automatically
@@ -196,6 +210,19 @@
                                         </para>
                                 </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>graphical.target</filename></term>
                                 <listitem>
@@ -212,6 +239,22 @@
                                         during installation.</para>
                                 </listitem>
                         </varlistentry>
+                        <varlistentry>
+                                <term><filename>http-daemon.target</filename></term>
+                                <listitem>
+                                        <para>A target for pulling in
+                                        an HTTP server if there is
+                                        any.</para>
+                                        <para>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
+                                        <literal>$httpd</literal>
+                                        facility.</para>
+                                </listitem>
+                        </varlistentry>
                         <varlistentry>
                                 <term><filename>halt.target</filename></term>
                                 <listitem>
@@ -234,6 +277,17 @@
                                         <filename>rescue.target</filename>.</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 with kexec should start
+                                        this unit.</para>
+                                </listitem>
+                        </varlistentry>
                         <varlistentry>
                                 <term><filename>local-fs.target</filename></term>
                                 <listitem>
@@ -554,6 +608,28 @@
                                         or b.</para>
                                 </listitem>
                         </varlistentry>
+                        <varlistentry>
+                                <term><filename>syslog.service</filename></term>
+                                <listitem>
+                                        <para>The syslog service if
+                                        any. Implementations should
+                                        create a symlink from the
+                                        actual syslog implementation
+                                        to this generic name for
+                                        activating it.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><filename>syslog.socket</filename></term>
+                                <listitem>
+                                        <para>The socket unit where
+                                        syslog implementations should
+                                        listen on. All userspace log
+                                        messages will be made
+                                        available on this
+                                        socket.</para>
+                                </listitem>
+                        </varlistentry>
                         <varlistentry>
                                 <term><filename>syslog.target</filename></term>
                                 <listitem>
@@ -567,74 +643,6 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
-                        <varlistentry>
-                                <term><filename>systemd-initctl.service</filename></term>
-                                <listitem>
-                                        <para>This provides
-                                        compatibility with the SysV
-                                        /dev/initctl file system FIFO
-                                        for communication with the
-                                        init system.</para>
-                                        <para>This is a
-                                        socket-activated service, see
-                                        <filename>system-initctl.socket</filename>.</para>
-                                </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><filename>systemd-initctl.socket</filename></term>
-                                <listitem>
-                                        <para>Socket activation unit
-                                        for
-                                        <filename>system-initctl.service</filename>.</para>
-                                </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><filename>systemd-stdout-syslog-bridge.service</filename></term>
-                                <listitem>
-                                        <para>This is internally used
-                                        by systemd to provide syslog
-                                        logging to the processes it
-                                        maintains.</para>
-                                        <para>This is a
-                                        socket-activated service, see
-                                        <filename>system-stdout-syslog-bridge.socket</filename>.</para>
-                                </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><filename>systemd-stdout-syslog-bridge.socket</filename></term>
-                                <listitem>
-                                        <para>Socket activation unit
-                                        for
-                                        <filename>system-stdout-syslog-bridge.service</filename>. 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.</para>
-                                </listitem>
-                        </varlistentry>
-                         <varlistentry>
-                                <term><filename>systemd-shutdownd.service</filename></term>
-                                <listitem>
-                                        <para>This is internally used
-                                        by
-                                        <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-                                        to implement delayed shutdowns.</para>
-                                        <para>This is a
-                                        socket-activated service, see
-                                        <filename>system-shutdownd.socket</filename>.</para>
-                                </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><filename>systemd-shutdownd.socket</filename></term>
-                                <listitem>
-                                        <para>Socket activation unit
-                                        for
-                                        <filename>system-shutdownd.service</filename>.</para>
-                                </listitem>
-                        </varlistentry>
                         <varlistentry>
                                 <term><filename>time-sync.target</filename></term>
                                 <listitem>
@@ -676,11 +684,8 @@
                 following special units are available, which have
                 similar definitions as their system counterparts:
                 <filename>default.target</filename>,
-                <filename>local-fs.target</filename>,
-                <filename>remote-fs.target</filename>,
                 <filename>shutdown.target</filename>,
-                <filename>sockets.target</filename>,
-                <filename>swap.target</filename>.</para>
+                <filename>sockets.target</filename></para>
 
                 <para>In addition the following special unit is
                 understood only when systemd runs as service instance:</para>
@@ -715,6 +720,7 @@
         <refsect1>
                   <title>See Also</title>
                   <para>
+                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-- 
cgit v1.2.3-54-g00ecf