logind: move logind into its own subdirectory

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

diff --git a/man/systemd.special.xml.in b/man/systemd.special.xml.in
index daa93583f573bd5fd1669fed11a8ea7ec61e5c8b..116a43ccfb30798e6570fdeb43df6ac2963c962c 100644 (file)
--- a/man/systemd.special.xml.in
+++ b/man/systemd.special.xml.in
@@ -50,37 +50,42 @@
         <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>dbus.service</filename>,

                 <filename>default.target</filename>,
                 <filename>default.target</filename>,

-                <filename>emergency.service</filename>,
+                <filename>display-manager.service</filename>,
+                <filename>emergency.target</filename>,
+                <filename>exit.service</filename>,

                 <filename>graphical.target</filename>,
                 <filename>halt.target</filename>,
                 <filename>kbrequest.target</filename>,
                 <filename>local-fs.target</filename>,
                 <filename>graphical.target</filename>,
                 <filename>halt.target</filename>,
                 <filename>kbrequest.target</filename>,
                 <filename>local-fs.target</filename>,

+                <filename>local-fs-pre.target</filename>,
+                <filename>mail-transfer-agent.target</filename>,

                 <filename>multi-user.target</filename>,
                 <filename>network.target</filename>,
                 <filename>nss-lookup.target</filename>,
                 <filename>poweroff.target</filename>,
                 <filename>reboot.target</filename>,
                 <filename>remote-fs.target</filename>,
                 <filename>multi-user.target</filename>,
                 <filename>network.target</filename>,
                 <filename>nss-lookup.target</filename>,
                 <filename>poweroff.target</filename>,
                 <filename>reboot.target</filename>,
                 <filename>remote-fs.target</filename>,

+                <filename>remote-fs-pre.target</filename>,

                 <filename>rescue.target</filename>,
                 <filename>rpcbind.target</filename>,
                 <filename>rescue.target</filename>,
                 <filename>rpcbind.target</filename>,

-                <filename>rtc-set.target</filename>,
-                <filename>runlevel0.target</filename>,
-                <filename>runlevel1.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>systemd-initctl.service</filename>,
                 <filename>systemd-initctl.socket</filename>,
                 <filename>syslog.target</filename>,
                 <filename>systemd-initctl.service</filename>,
                 <filename>systemd-initctl.socket</filename>,

-                <filename>systemd-logger.service</filename>,
-                <filename>systemd-logger.socket</filename></para>
+                <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>
 
         <refsect1>
         </refsynopsisdiv>
 
         <refsect1>


@@ -106,16 +111,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>


@@ -130,6 +134,17 @@
                                         <filename>reboot.target</filename>.</para>
                                 </listitem>
                         </varlistentry>
                                         <filename>reboot.target</filename>.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>dbus.service</filename></term>
+                                <listitem>
+                                        <para>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.</para>
+                                </listitem>
+                        </varlistentry>

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


@@ -142,21 +157,41 @@
                                         <filename>graphical.target</filename>.</para>
                                         <para>The default unit systemd
                                         starts at bootup can be
                                         <filename>graphical.target</filename>.</para>
                                         <para>The default unit systemd
                                         starts at bootup can be

-                                        overriden with the
-                                        <varname>systemd.default=</varname>
+                                        overridden with the
+                                        <varname>systemd.unit=</varname>

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

-                                <term><filename>emergency.service</filename></term>
+                                <term><filename>display-manager.service</filename></term>

                                 <listitem>
                                 <listitem>

-                                        <para>A special service unit
+                                        <para>The display manager
+                                        service. Usually this should
+                                        be aliased (symlinked) to
+                                        <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
+                                        units with a LSB header
+                                        referring to the
+                                        <literal>$x-display-manager</literal>
+                                        facility, for compatibility
+                                        with Debian.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><filename>emergency.target</filename></term>
+                                <listitem>
+                                        <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>


@@ -213,8 +248,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


@@ -227,6 +262,41 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
                                         facility.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>local-fs-pre.target</filename></term>
+                                <listitem>
+                                        <para>This target unit is
+                                        automatically ordered before
+                                        all local mount points marked
+                                        with <option>auto</option>
+                                        (see above). It can be used to
+                                        execute certain units before
+                                        all local mounts.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><filename>mail-transfer-agent.target</filename></term>
+                                <listitem>
+                                        <para>The mail transfer agent
+                                        (MTA) service. Usually this
+                                        should pull-in all units
+                                        necessary for
+                                        sending/receiving mails on the
+                                        local host.</para>
+
+                                        <para>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
+                                        <literal>$mail-transfer-agent</literal>
+                                        or
+                                        <literal>$mail-transport-agent</literal>
+                                        facilities, for compatibility
+                                        with Debian.</para>
+                                </listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><filename>multi-user.target</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>multi-user.target</filename></term>
                                 <listitem>


@@ -317,6 +387,18 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
                                         facility.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>remote-fs-pre.target</filename></term>
+                                <listitem>
+                                        <para>This target unit is
+                                        automatically ordered before
+                                        all remote mount points marked
+                                        with <option>auto</option>
+                                        (see above). It can be used to
+                                        execute certain units before
+                                        all remote mounts.</para>
+                                </listitem>
+                        </varlistentry>

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


@@ -342,50 +424,11 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
                                         facility.</para>
                                 </listitem>
                         </varlistentry>

-                        <varlistentry>
-                                <term><filename>rtc-set.target</filename></term>
-                                <listitem>
-                                        <para>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
-                                        <literal>$time</literal>
-                                        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>
                                         <para>This is a target that is
                         <varlistentry>
                                 <term><filename>runlevel2.target</filename></term>
                                 <listitem>
                                         <para>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
                                         compatibility code asks for
                                         runlevel 2. It is a good idea
                                         to make this an alias for


@@ -397,7 +440,7 @@
                                 <term><filename>runlevel3.target</filename></term>
                                 <listitem>
                                         <para>This is a target that is
                                 <term><filename>runlevel3.target</filename></term>
                                 <listitem>
                                         <para>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
                                         compatibility code asks for
                                         runlevel 3. It is a good idea
                                         to make this an alias for


@@ -411,7 +454,7 @@
                                 <term><filename>runlevel4.target</filename></term>
                                 <listitem>
                                         <para>This is a target that is
                                 <term><filename>runlevel4.target</filename></term>
                                 <listitem>
                                         <para>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
                                         compatibility code asks for
                                         runlevel 4. It is a good idea
                                         to make this an alias for


@@ -425,7 +468,7 @@
                                 <term><filename>runlevel5.target</filename></term>
                                 <listitem>
                                         <para>This is a target that is
                                 <term><filename>runlevel5.target</filename></term>
                                 <listitem>
                                         <para>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
                                         compatibility code asks for
                                         runlevel 5. It is a good idea
                                         to make this an alias for


@@ -435,19 +478,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>


@@ -459,8 +489,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


@@ -505,6 +537,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>


@@ -516,15 +565,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>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>


@@ -549,7 +589,7 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>

-                                <term><filename>systemd-logger.service</filename></term>
+                                <term><filename>systemd-stdout-syslog-bridge.service</filename></term>

                                 <listitem>
                                         <para>This is internally used
                                         by systemd to provide syslog
                                 <listitem>
                                         <para>This is internally used
                                         by systemd to provide syslog


@@ -557,15 +597,15 @@
                                         maintains.</para>
                                         <para>This is a
                                         socket-activated service, see
                                         maintains.</para>
                                         <para>This is a
                                         socket-activated service, see

-                                        <filename>system-logger.socket</filename>.</para>
+                                        <filename>system-stdout-syslog-bridge.socket</filename>.</para>

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

-                                <term><filename>systemd-logger.socket</filename></term>
+                                <term><filename>systemd-stdout-syslog-bridge.socket</filename></term>

                                 <listitem>
                                         <para>Socket activation unit
                                         for
                                 <listitem>
                                         <para>Socket activation unit
                                         for

-                                        <filename>system-logger.service</filename>. systemd
+                                        <filename>system-stdout-syslog-bridge.service</filename>. systemd

                                         will automatically add
                                         dependencies of types Requires
                                         and After to all units that
                                         will automatically add
                                         dependencies of types Requires
                                         and After to all units that


@@ -575,13 +615,64 @@
                                         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>time-sync.target</filename></term>
+                                <listitem>
+                                        <para>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
+                                        <literal>$time</literal>
+                                        facility.</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>,


@@ -590,14 +681,43 @@
                 <filename>shutdown.target</filename>,
                 <filename>sockets.target</filename>,
                 <filename>swap.target</filename>.</para>
                 <filename>shutdown.target</filename>,
                 <filename>sockets.target</filename>,
                 <filename>swap.target</filename>.</para>

+
+                <para>In addition the following special unit is
+                understood only when systemd runs as service instance:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><filename>exit.service</filename></term>
+                                <listitem>
+                                        <para>A special service unit
+                                        for shutting down the
+                                        user service manager.</para>
+
+                                        <para>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.</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
+                                        user service manager exit.</para>
+                                </listitem>
+                        </varlistentry>
+                </variablelist>

         </refsect1>
 
         <refsect1>
                   <title>See Also</title>
                   <para>
         </refsect1>
 
         <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>