units: rename rtc-set.target to time-sync.target and pull it in by hwclock-load.service

[elogind.git] / man / systemd.special.xml.in

diff --git a/man/systemd.special.xml.in b/man/systemd.special.xml.in
index 1d9c1326b4f2e5d43634f2eee69d54c2407c06a8..efc4c32bed588c58835364e98201c06d19e0ff05 100644 (file)
--- a/man/systemd.special.xml.in
+++ b/man/systemd.special.xml.in
@@ -50,10 +50,10 @@
         <refsynopsisdiv>
                 <para><filename>basic.target</filename>,
                 <filename>ctrl-alt-del.target</filename>,
         <refsynopsisdiv>
                 <para><filename>basic.target</filename>,
                 <filename>ctrl-alt-del.target</filename>,

-                <filename>@SPECIAL_DBUS_SERVICE@</filename>,
+                <filename>dbus.service</filename>,

                 <filename>default.target</filename>,
                 <filename>display-manager.service</filename>,
                 <filename>default.target</filename>,
                 <filename>display-manager.service</filename>,

-                <filename>emergency.service</filename>,
+                <filename>emergency.target</filename>,

                 <filename>exit.service</filename>,
                 <filename>graphical.target</filename>,
                 <filename>halt.target</filename>,
                 <filename>exit.service</filename>,
                 <filename>graphical.target</filename>,
                 <filename>halt.target</filename>,


@@ -68,24 +68,22 @@
                 <filename>remote-fs.target</filename>,
                 <filename>rescue.target</filename>,
                 <filename>rpcbind.target</filename>,
                 <filename>remote-fs.target</filename>,
                 <filename>rescue.target</filename>,
                 <filename>rpcbind.target</filename>,

-                <filename>rtc-set.target</filename>,
-                <filename>runlevel0.target</filename>,
-                <filename>runlevel1.target</filename>,
+                <filename>time-sync.target</filename>,

                 <filename>runlevel2.target</filename>,
                 <filename>runlevel3.target</filename>,
                 <filename>runlevel4.target</filename>,
                 <filename>runlevel5.target</filename>,
                 <filename>runlevel2.target</filename>,
                 <filename>runlevel3.target</filename>,
                 <filename>runlevel4.target</filename>,
                 <filename>runlevel5.target</filename>,

-                <filename>runlevel6.target</filename>

                 <filename>shutdown.target</filename>,
                 <filename>sigpwr.target</filename>,
                 <filename>sockets.target</filename>,
                 <filename>swap.target</filename>,
                 <filename>shutdown.target</filename>,
                 <filename>sigpwr.target</filename>,
                 <filename>sockets.target</filename>,
                 <filename>swap.target</filename>,

+                <filename>sysinit.target</filename>,

                 <filename>syslog.target</filename>,
                 <filename>syslog.target</filename>,

-                <filename>@SPECIAL_SYSLOG_SERVICE@</filename>,

                 <filename>systemd-initctl.service</filename>,
                 <filename>systemd-initctl.socket</filename>,
                 <filename>systemd-logger.service</filename>,
                 <filename>systemd-initctl.service</filename>,
                 <filename>systemd-initctl.socket</filename>,
                 <filename>systemd-logger.service</filename>,

-                <filename>systemd-logger.socket</filename></para>
+                <filename>systemd-logger.socket</filename>,
+                <filename>umount.target</filename></para>

         </refsynopsisdiv>
 
         <refsect1>
         </refsynopsisdiv>
 
         <refsect1>


@@ -111,16 +109,15 @@
                                         target unit to all SysV
                                         service units configured for
                                         runlevel 1 to 5.</para>
                                         target unit to all SysV
                                         service units configured for
                                         runlevel 1 to 5.</para>

-                                        <para>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.</para>
+                                        <para>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.</para>

                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>


@@ -136,7 +133,7 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>

-                                <term><filename>@SPECIAL_DBUS_SERVICE@</filename></term>
+                                <term><filename>dbus.service</filename></term>

                                 <listitem>
                                         <para>A special unit for the
                                         D-Bus system bus. As soon as
                                 <listitem>
                                         <para>A special unit for the
                                         D-Bus system bus. As soon as


@@ -159,7 +156,7 @@
                                         <para>The default unit systemd
                                         starts at bootup can be
                                         overriden with the
                                         <para>The default unit systemd
                                         starts at bootup can be
                                         overriden with the

-                                        <varname>systemd.default=</varname>
+                                        <varname>systemd.unit=</varname>

                                         kernel command line option.</para>
                                 </listitem>
                         </varlistentry>
                                         kernel command line option.</para>
                                 </listitem>
                         </varlistentry>


@@ -169,14 +166,14 @@
                                         <para>The display manager
                                         service. Usually this should
                                         be aliased (symlinked) to
                                         <para>The display manager
                                         service. Usually this should
                                         be aliased (symlinked) to

-                                        <filename>gdm.service</filename>
+                                        <filename>xdm.service</filename>

                                         or a similar display manager
                                         service.</para>
                                         <para>systemd automatically
                                         adds dependencies of type
                                         After for this target unit to
                                         all SysV init script service
                                         or a similar display manager
                                         service.</para>
                                         <para>systemd automatically
                                         adds dependencies of type
                                         After for this target unit to
                                         all SysV init script service

-                                        units with an LSB header
+                                        units with a LSB header

                                         referring to the
                                         <literal>$x-display-manager</literal>
                                         facility, for compatibility
                                         referring to the
                                         <literal>$x-display-manager</literal>
                                         facility, for compatibility


@@ -184,15 +181,15 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>

-                                <term><filename>emergency.service</filename></term>
+                                <term><filename>emergency.target</filename></term>

                                 <listitem>
                                 <listitem>

-                                        <para>A special service unit
+                                        <para>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
                                         that starts an emergency
                                         shell on the main
                                         console. This unit is supposed
                                         to be used with the kernel
                                         command line option

-                                        <varname>systemd.default=</varname>
+                                        <varname>systemd.unit=</varname>

                                         and has otherwise little use.
                                         </para>
                                 </listitem>
                                         and has otherwise little use.
                                         </para>
                                 </listitem>


@@ -249,8 +246,8 @@
                                         mounts listed in
                                         <filename>/etc/fstab</filename>
                                         that have the
                                         mounts listed in
                                         <filename>/etc/fstab</filename>
                                         that have the

-                                        <literal>auto</literal> and
-                                        <literal>comment=systemd.mount</literal>
+                                        <option>auto</option> and
+                                        <option>comment=systemd.mount</option>

                                         mount options set.</para>
 
                                         <para>systemd automatically
                                         mount options set.</para>
 
                                         <para>systemd automatically


@@ -268,7 +265,7 @@
                                 <listitem>
                                         <para>The mail transfer agent
                                         (MTA) service. Usually this
                                 <listitem>
                                         <para>The mail transfer agent
                                         (MTA) service. Usually this

-                                        should pull in all units
+                                        should pull-in all units

                                         necessary for
                                         sending/receiving mails on the
                                         local host.</para>
                                         necessary for
                                         sending/receiving mails on the
                                         local host.</para>


@@ -402,7 +399,7 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>

-                                <term><filename>rtc-set.target</filename></term>
+                                <term><filename>time-sync.target</filename></term>

                                 <listitem>
                                         <para>systemd automatically
                                         adds dependencies of type
                                 <listitem>
                                         <para>systemd automatically
                                         adds dependencies of type


@@ -414,32 +411,6 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
                                         facility.</para>
                                 </listitem>
                         </varlistentry>

-                        <varlistentry>
-                                <term><filename>runlevel0.target</filename></term>
-                                <listitem>
-                                        <para>This is a target that is
-                                        called whever the SysV
-                                        compatibility code asks for
-                                        runlevel 0. This is an alias
-                                        for
-                                        <filename>poweroff.target</filename>,
-                                        for compatibility with
-                                        SysV.</para>
-                                </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><filename>runlevel1.target</filename></term>
-                                <listitem>
-                                        <para>This is a target that is
-                                        called whever the SysV
-                                        compatibility code asks for
-                                        runlevel 1. This is an alias
-                                        for
-                                        <filename>rescue.target</filename>,
-                                        for compatibility with
-                                        SysV.</para>
-                                </listitem>
-                        </varlistentry>

                         <varlistentry>
                                 <term><filename>runlevel2.target</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>runlevel2.target</filename></term>
                                 <listitem>


@@ -494,19 +465,6 @@
                                         <filename>graphical.target</filename>.</para>
                                 </listitem>
                         </varlistentry>
                                         <filename>graphical.target</filename>.</para>
                                 </listitem>
                         </varlistentry>

-                        <varlistentry>
-                                <term><filename>runlevel6.target</filename></term>
-                                <listitem>
-                                        <para>This is a target that is
-                                        called whever the SysV
-                                        compatibility code asks for
-                                        runlevel 6. This is an alias
-                                        for
-                                        <filename>reboot.target</filename>,
-                                        for compatibility with
-                                        SysV.</para>
-                                </listitem>
-                        </varlistentry>

                         <varlistentry>
                                 <term><filename>shutdown.target</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>shutdown.target</filename></term>
                                 <listitem>


@@ -518,8 +476,10 @@
                                         terminated on system shutdown
                                         shall add Conflicts
                                         dependencies to this unit for
                                         terminated on system shutdown
                                         shall add Conflicts
                                         dependencies to this unit for

-                                        their service unit during
-                                        installation.</para>
+                                        their service unit, which is
+                                        implicitly done when
+                                        <varname>DefaultDependencies=yes</varname>
+                                        is set (the default).</para>

 
                                         <para>systemd automatically
                                         adds dependencies of type
 
                                         <para>systemd automatically
                                         adds dependencies of type


@@ -564,6 +524,23 @@
                                         files.</para>
                                 </listitem>
                         </varlistentry>
                                         files.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>sysinit.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        covering early boot-up scripts.</para>
+                                        <para>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.</para>
+                                </listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><filename>syslog.target</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>syslog.target</filename></term>
                                 <listitem>


@@ -575,32 +552,6 @@
                                         referring to the
                                         <literal>$syslog</literal>
                                         facility.</para>
                                         referring to the
                                         <literal>$syslog</literal>
                                         facility.</para>

-
-                                        <para>Administrators should
-                                        ensure that this target pulls
-                                        in a service unit with the
-                                        name or alias of
-                                        <filename>@SPECIAL_SYSLOG_SERVICE@</filename>
-                                        (or a socket unit that
-                                        activates this
-                                        service).</para>
-                                </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><filename>@SPECIAL_SYSLOG_SERVICE@</filename></term>
-                                <listitem>
-                                        <para>A special unit for the
-                                        syslog daemon. As soon as
-                                        this service is fully started
-                                        up systemd will connect to it
-                                        and use it for logging if it
-                                        has been configured for
-                                        that.</para>
-                                        <para>Applications should
-                                        generally not depend on this
-                                        service, and depend on
-                                        <filename>syslog.target</filename>
-                                        instead.</para>

                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>


@@ -651,13 +602,51 @@
                                         kernel log buffer.</para>
                                 </listitem>
                         </varlistentry>
                                         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>umount.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        that umounts all mount and
+                                        automount points on system
+                                        shutdown.</para>
+
+                                        <para>Mounts that shall be
+                                        unmounted on system shutdown
+                                        shall add Conflicts
+                                        dependencies to this unit for
+                                        their mount unit, which is
+                                        implicitly done when
+                                        <varname>DefaultDependencies=yes</varname>
+                                        is set (the default).</para>
+                                </listitem>
+                        </varlistentry>

                 </variablelist>
         </refsect1>
 
         <refsect1>
                 </variablelist>
         </refsect1>
 
         <refsect1>

-                <title>Special Session Units</title>
+                <title>Special User Units</title>

 
 

-                <para>When systemd runs as a service instance, the
+                <para>When systemd runs as a user instance, the

                 following special units are available, which have
                 similar definitions as their system counterparts:
                 <filename>default.target</filename>,
                 following special units are available, which have
                 similar definitions as their system counterparts:
                 <filename>default.target</filename>,


@@ -676,22 +665,22 @@
                                 <listitem>
                                         <para>A special service unit
                                         for shutting down the
                                 <listitem>
                                         <para>A special service unit
                                         for shutting down the

-                                        session.</para>
+                                        user service manager.</para>

 
                                         <para>Applications wanting to
 
                                         <para>Applications wanting to

-                                        terminate the session should
-                                        start this unit. If systemd
-                                        receives SIGTERM or SIGINT
-                                        when running as session daemon
-                                        it will start this
-                                        unit.</para>
+                                        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.</para>

 
                                         <para>Normally, this pulls in
                                         <filename>shutdown.target</filename>
                                         which in turn should be
                                         conflicted by all units that
                                         want to be shut down on
 
                                         <para>Normally, this pulls in
                                         <filename>shutdown.target</filename>
                                         which in turn should be
                                         conflicted by all units that
                                         want to be shut down on

-                                        session exit.</para>
+                                        user service manager exit.</para>

                                 </listitem>
                         </varlistentry>
                 </variablelist>
                                 </listitem>
                         </varlistentry>
                 </variablelist>


@@ -700,9 +689,9 @@
         <refsect1>
                   <title>See Also</title>
                   <para>
         <refsect1>
                   <title>See Also</title>
                   <para>

-                          <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>
+                          <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>,

                           <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>
         </refsect1>
                           <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>
         </refsect1>