logind: support for hybrid sleep (i.e. suspend+hibernate at the same time)

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

diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 39c3802210b7f970c93a46f964e9e9c4c26bfc09..6b8e0ec7f0b8fe7cedc9a95ada2622a690dc0940 100644 (file)
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -49,16 +49,21 @@
 
         <refsynopsisdiv>
                 <para><filename>basic.target</filename>,
 
         <refsynopsisdiv>
                 <para><filename>basic.target</filename>,

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

                 <filename>ctrl-alt-del.target</filename>,
                 <filename>ctrl-alt-del.target</filename>,

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

                 <filename>dbus.service</filename>,
                 <filename>dbus.socket</filename>,
                 <filename>default.target</filename>,
                 <filename>display-manager.service</filename>,
                 <filename>emergency.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>exit.target</filename>,
+                <filename>final.target</filename>,
+                <filename>getty.target</filename>,

                 <filename>graphical.target</filename>,
                 <filename>graphical.target</filename>,

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

                 <filename>http-daemon.target</filename>,
                 <filename>http-daemon.target</filename>,

+                <filename>hybrid-sleep.target</filename>,

                 <filename>halt.target</filename>,
                 <filename>kbrequest.target</filename>,
                 <filename>kexec.target</filename>,
                 <filename>halt.target</filename>,
                 <filename>kbrequest.target</filename>,
                 <filename>kexec.target</filename>,


@@ -68,7 +73,9 @@
                 <filename>multi-user.target</filename>,
                 <filename>network.target</filename>,
                 <filename>nss-lookup.target</filename>,
                 <filename>multi-user.target</filename>,
                 <filename>network.target</filename>,
                 <filename>nss-lookup.target</filename>,

+                <filename>nss-user-lookup.target</filename>,

                 <filename>poweroff.target</filename>,
                 <filename>poweroff.target</filename>,

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

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


@@ -80,12 +87,16 @@
                 <filename>runlevel5.target</filename>,
                 <filename>shutdown.target</filename>,
                 <filename>sigpwr.target</filename>,
                 <filename>runlevel5.target</filename>,
                 <filename>shutdown.target</filename>,
                 <filename>sigpwr.target</filename>,

+                <filename>sleep.target</filename>,
+                <filename>smartcard.target</filename>,

                 <filename>sockets.target</filename>,
                 <filename>sockets.target</filename>,

+                <filename>sound.target</filename>,
+                <filename>suspend.target</filename>,

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

-                <filename>syslog.service</filename>,

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

+                <filename>system-update.target</filename>,

                 <filename>time-sync.target</filename>,
                 <filename>umount.target</filename></para>
         </refsynopsisdiv>
                 <filename>time-sync.target</filename>,
                 <filename>umount.target</filename></para>
         </refsynopsisdiv>


@@ -124,6 +135,16 @@
                                         this unit.</para>
                                 </listitem>
                         </varlistentry>
                                         this unit.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>bluetooth.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        bluetooth controller is
+                                        plugged in or becomes
+                                        available at boot.</para>
+                                </listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><filename>ctrl-alt-del.target</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>ctrl-alt-del.target</filename></term>
                                 <listitem>


@@ -136,6 +157,15 @@
                                         <filename>reboot.target</filename>.</para>
                                 </listitem>
                         </varlistentry>
                                         <filename>reboot.target</filename>.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>cryptsetup.target</filename></term>
+                                <listitem>
+                                        <para>A target that pulls in
+                                        setup services for all
+                                        encrypted block
+                                        devices.</para>
+                                </listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><filename>dbus.service</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>dbus.service</filename></term>
                                 <listitem>


@@ -223,6 +253,15 @@
                                         </para>
                                 </listitem>
                         </varlistentry>
                                         </para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>getty.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        that pulls in all local TTY
+                                        <filename>getty</filename> instances.
+                                        </para>
+                                </listitem>
+                        </varlistentry>

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


@@ -239,6 +278,15 @@
                                         during installation.</para>
                                 </listitem>
                         </varlistentry>
                                         during installation.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>hibernate.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        for hibernating the
+                                        system. This pulls in
+                                        <filename>sleep.target</filename>.</para>
+                                </listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><filename>http-daemon.target</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>http-daemon.target</filename></term>
                                 <listitem>


@@ -255,6 +303,15 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
                                         facility.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>hybrid-sleep.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        for hibernating and suspending the
+                                        system at the same time. This pulls in
+                                        <filename>sleep.target</filename>.</para>
+                                </listitem>
+                        </varlistentry>

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


@@ -430,6 +487,16 @@
                                         unit, for compatibility with SysV.</para>
                                 </listitem>
                         </varlistentry>
                                         unit, for compatibility with SysV.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>printer.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        printer is plugged in or
+                                        becomes available at
+                                        boot.</para>
+                                </listitem>
+                        </varlistentry>

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


@@ -496,7 +563,7 @@
                                         all SysV init script service
                                         units with an LSB header
                                         referring to the
                                         all SysV init script service
                                         units with an LSB header
                                         referring to the

-                                        <literal>$rpcbind</literal>
+                                        <literal>$portmap</literal>

                                         facility.</para>
                                 </listitem>
                         </varlistentry>
                                         facility.</para>
                                 </listitem>
                         </varlistentry>


@@ -590,6 +657,28 @@
                                         power fails.</para>
                                 </listitem>
                         </varlistentry>
                                         power fails.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>sleep.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        that is pulled in by
+                                        <filename>suspend.target</filename>,
+                                        <filename>hibernate.target</filename> and <filename>hybrid-sleep.target</filename>
+                                        and may be used to hook units
+                                        into the sleep state
+                                        logic.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><filename>smartcard.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        smartcard controller is
+                                        plugged in or becomes
+                                        available at boot.</para>
+                                </listitem>
+                        </varlistentry>

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


@@ -604,6 +693,25 @@
                                         during installation.</para>
                                 </listitem>
                         </varlistentry>
                                         during installation.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>sound.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        sound card is plugged in or
+                                        becomes available at
+                                        boot.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><filename>suspend.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        for suspending the
+                                        system. This pulls in
+                                        <filename>sleep.target</filename>.</para>
+                                </listitem>
+                        </varlistentry>

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


@@ -630,17 +738,6 @@
                                         or b.</para>
                                 </listitem>
                         </varlistentry>
                                         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>
                         <varlistentry>
                                 <term><filename>syslog.socket</filename></term>
                                 <listitem>


@@ -648,8 +745,13 @@
                                         syslog implementations should
                                         listen on. All userspace log
                                         messages will be made
                                         syslog implementations should
                                         listen on. All userspace log
                                         messages will be made

-                                        available on this
-                                        socket.</para>
+                                        available on this socket. For
+                                        more information about syslog
+                                        integration, please consult
+                                        the <ulink
+                                        url="http://www.freedesktop.org/wiki/Software/systemd/syslog">Syslog
+                                        Interface</ulink>
+                                        document.</para>

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


@@ -665,6 +767,23 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
                                         facility.</para>
                                 </listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><filename>system-update.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        that is used for off-line
+                                        system updates.
+                                        <citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                        will redirect the boot process
+                                        to this target if
+                                        <filename>/system-update</filename>
+                                        exists. For more information
+                                        see the <ulink
+                                        url="http://freedesktop.org/wiki/Software/systemd/SystemUpdates">System
+                                        Updates
+                                        Specification</ulink>.</para>
+                                </listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><filename>time-sync.target</filename></term>
                                 <listitem>
                         <varlistentry>
                                 <term><filename>time-sync.target</filename></term>
                                 <listitem>


@@ -696,6 +815,7 @@
                                         is set (the default).</para>
                                 </listitem>
                         </varlistentry>
                                         is set (the default).</para>
                                 </listitem>
                         </varlistentry>

+

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


@@ -714,7 +834,7 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>

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

                                 <listitem>
                                         <para>A special service unit
                                         for shutting down the
                                 <listitem>
                                         <para>A special service unit
                                         for shutting down the


@@ -746,7 +866,8 @@
                           <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>
+                          <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>

                   </para>
         </refsect1>
 
                   </para>
         </refsect1>