X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-suspend.service.xml;h=9b8bad4791cb574507f77c674e35a41e4663eb00;hp=dea778fbec661afa5e074de6c157f11287e65bf8;hb=5a5c72ca6ed88b7068e08b0ebc191a5b21991b62;hpb=e2b696ee9bffad34daaafc99d3a5d8ee13504288

diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml
index dea778fbe..9b8bad479 100644
--- a/man/systemd-suspend.service.xml
+++ b/man/systemd-suspend.service.xml
@@ -45,13 +45,15 @@
         <refnamediv>
                 <refname>systemd-suspend.service</refname>
                 <refname>systemd-hibernate.service</refname>
+                <refname>systemd-hybrid-sleep.service</refname>
                 <refname>systemd-sleep</refname>
-                <refpurpose>systemd System Suspend/Hibernate Logic</refpurpose>
+                <refpurpose>System sleep state logic</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
                 <para><filename>systemd-suspend.service</filename></para>
                 <para><filename>systemd-hibernate.service</filename></para>
+                <para><filename>systemd-hybrid-sleep.service</filename></para>
                 <para><filename>/usr/lib/systemd/systemd-sleep</filename></para>
         </refsynopsisdiv>
 
@@ -64,38 +66,59 @@
                 for the actual system suspend. Similar,
                 <filename>systemd-hibernate.service</filename> is
                 pulled in by <filename>hibernate.target</filename> to
-                executed the actual hibernation.</para>
-
-                <para>Immediately before entering system suspend and
-                hibernation
-                <filename>systemd-suspend.service</filename> will run
-                all executables in
+                execute the actual hibernation. Finally,
+                <filename>systemd-hybrid-sleep.service</filename> is
+                pulled in by <filename>hybrid-sleep.target</filename>
+                to execute hybrid hibernation with system
+                suspend.</para>
+
+                <para>Immediately before entering system suspend
+                and/or hibernation
+                <filename>systemd-suspend.service</filename> (and the
+                other mentioned units, respectively) will run all
+                executables in
                 <filename>/usr/lib/systemd/system-sleep/</filename>
                 and pass two arguments to them. The first argument
                 will be "<literal>pre</literal>", the second either
-                "<literal>suspend</literal>" or
-                "<literal>hibernate</literal>", depending on the chosen
-                action. Immediately after leaving system suspend and
-                hibernation the same executables are run, but the
-                first argument is now "<literal>post</literal>". All
-                executables in this directory are executed in
-                parallel, and execution of the action is not continued
-                before all executables finished.</para>
+                "<literal>suspend</literal>",
+                "<literal>hibernate</literal>", or
+                "<literal>hybrid-sleep</literal>" depending on the
+                chosen action. Immediately after leaving system
+                suspend and/or hibernation the same executables are run,
+                but the first argument is now
+                "<literal>post</literal>". All executables in this
+                directory are executed in parallel, and execution of
+                the action is not continued before all executables
+                finished.</para>
 
                 <para>Note that scripts or binaries dropped in
                 <filename>/usr/lib/systemd/system-sleep/</filename>
                 are intended for local use only and should be
                 considered hacks. If applications want to be notified
-                of system suspend and resume there are much nicer
-                interfaces available.</para>
-
+                of system suspend/hibernation and resume there are
+                much nicer interfaces available.</para>
+
+                <para>Note that
+                <filename>systemd-suspend.service</filename>,
+                <filename>systemd-hibernate.service</filename> and
+                <filename>systemd-hybrid-sleep.service</filename>
+                should never be executed directly. Instead, trigger
+                system sleep states with a command such as
+                "<literal>systemctl suspend</literal>" or
+                similar.</para>
+
+                <para>Internally, this service will echo a string like
+                <literal>mem</literal> into
+                <filename>/sys/power/state</filename>, to trigger the
+                actual system suspend.</para>
         </refsect1>
 
         <refsect1>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-halt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>
         </refsect1>