man: explain a bit more detailed what happens on suspend

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index e3d22a7b5bf000281d7e849c10182b144b51a405..31f3b1a90986c48a71d884a805faf66ad380359d 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -87,14 +87,26 @@
                                 <term><option>--type=</option></term>
                                 <term><option>-t</option></term>
 
                                 <term><option>--type=</option></term>
                                 <term><option>-t</option></term>
 

-                                <listitem><para>When listing units,
-                                limit display to certain unit
-                                types. If not specified units of all
-                                types will be shown. The argument
-                                should be a unit type name such as
-                                <option>service</option>,
-                                <option>socket</option> and
-                                similar.</para></listitem>
+                                <listitem><para>The argument should
+                                be a unit type name such as
+                                <option>service</option> and
+                                <option>socket</option>,
+                                or a unit load state such as
+                                <option>loaded</option> and
+                                <option>masked</option>.
+                                </para>
+
+                                <para>If the argument is a unit type,
+                                when listing units, limit display to
+                                certain unit types. If not specified
+                                units of all types will be shown.</para>
+
+                                <para>If the argument is a unit load state,
+                                when listing units, limit display to
+                                certain unit types. If not specified
+                                units of in all load states will be
+                                shown.</para>
+                                </listitem>

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


@@ -166,7 +178,7 @@
                                 execute it immediately. If passed no
                                 required units of the unit passed will
                                 be pulled in, and no ordering
                                 execute it immediately. If passed no
                                 required units of the unit passed will
                                 be pulled in, and no ordering

-                                dependencies will be honoured. This is
+                                dependencies will be honored. This is

                                 mostly a debugging and rescue tool for
                                 the administrator and should not be
                                 used by
                                 mostly a debugging and rescue tool for
                                 the administrator and should not be
                                 used by


@@ -430,17 +442,6 @@
                                 10.</para></listitem>
                         </varlistentry>
 
                                 10.</para></listitem>
                         </varlistentry>
 

-                        <varlistentry>
-                                <term><option>--follow</option></term>
-                                <term><option>-f</option></term>
-
-                                <listitem><para>When used with
-                                <command>status</command> continously
-                                prints new journal entries as they are
-                                appended to the
-                                journal.</para></listitem>
-                        </varlistentry>
-

                         <varlistentry>
                                 <term><option>--output=</option></term>
                                 <term><option>-o</option></term>
                         <varlistentry>
                                 <term><option>--output=</option></term>
                                 <term><option>-o</option></term>


@@ -670,24 +671,29 @@
                         <varlistentry>
                                 <term><command>enable [NAME...]</command></term>
 
                         <varlistentry>
                                 <term><command>enable [NAME...]</command></term>
 

-                                <listitem><para>Enable one or more
-                                unit files, as specified on the
+                                <listitem><para>Enable one or
+                                more unit files or unit file
+                                instances, as specified on the

                                 command line. This will create a
                                 command line. This will create a

-                                number of symlinks as encoded in the
-                                <literal>[Install]</literal> sections
-                                of the unit files. After the symlinks
-                                have been created the systemd
-                                configuration is reloaded (in a way
-                                that is equivalent to
-                                <command>daemon-reload</command>) to
-                                ensure the changes are taken into
+                                number of symlinks as encoded in
+                                the <literal>[Install]</literal>
+                                sections of the unit files. After
+                                the symlinks have been created the
+                                systemd configuration is reloaded
+                                (in a way that is equivalent to
+                                <command>daemon-reload</command>)
+                                to ensure the changes are taken into

                                 account immediately. Note that this
                                 does not have the effect that any of
                                 the units enabled are also started at
                                 account immediately. Note that this
                                 does not have the effect that any of
                                 the units enabled are also started at

-                                the same time. If this is desired a
-                                separate <command>start</command>
-                                command must be invoked for the
-                                unit.</para>
+                                the same time.  If this is desired
+                                a separate <command>start</command>
+                                command must be invoked for the unit.
+                                Also note that in case of instance
+                                enablement, symlinks named same as
+                                instances are created in install
+                                location, however they all point to
+                                the same template unit file.</para>

 
                                 <para>This command will
                                 print the actions executed. This
 
                                 <para>This command will
                                 print the actions executed. This


@@ -760,7 +766,7 @@
                                 configuration after completing the
                                 disabling of the units. Note that this
                                 command does not implicitly stop the
                                 configuration after completing the
                                 disabling of the units. Note that this
                                 command does not implicitly stop the

-                                units that is being disabled. If this
+                                units that are being disabled. If this

                                 is desired an additional
                                 <command>stop</command> command should
                                 be executed afterwards.</para>
                                 is desired an additional
                                 <command>stop</command> command should
                                 be executed afterwards.</para>


@@ -783,7 +789,7 @@
                                 <term><command>is-enabled [NAME...]</command></term>
 
                                 <listitem><para>Checks whether any of
                                 <term><command>is-enabled [NAME...]</command></term>
 
                                 <listitem><para>Checks whether any of

-                                the specified unit files is enabled
+                                the specified unit files are enabled

                                 (as with
                                 <command>enable</command>). Returns an
                                 exit code of 0 if at least one is
                                 (as with
                                 <command>enable</command>). Returns an
                                 exit code of 0 if at least one is


@@ -1090,7 +1096,7 @@
                                 mounted read-only, immediately
                                 followed by the system halt.  If
                                 <option>--force</option> is specified
                                 mounted read-only, immediately
                                 followed by the system halt.  If
                                 <option>--force</option> is specified

-                                twice the the operation is immediately
+                                twice the operation is immediately

                                 executed without terminating any
                                 processes or unmounting any file
                                 systems. This may result in data
                                 executed without terminating any
                                 processes or unmounting any file
                                 systems. This may result in data


@@ -1111,7 +1117,7 @@
                                 unmounted or mounted read-only,
                                 immediately followed by the powering
                                 off. If <option>--force</option> is
                                 unmounted or mounted read-only,
                                 immediately followed by the powering
                                 off. If <option>--force</option> is

-                                specified twice the the operation is
+                                specified twice the operation is

                                 immediately executed without
                                 terminating any processes or
                                 unmounting any file systems. This may
                                 immediately executed without
                                 terminating any processes or
                                 unmounting any file systems. This may


@@ -1132,7 +1138,7 @@
                                 unmounted or mounted read-only,
                                 immediately followed by the reboot. If
                                 <option>--force</option> is specified
                                 unmounted or mounted read-only,
                                 immediately followed by the reboot. If
                                 <option>--force</option> is specified

-                                twice the the operation is immediately
+                                twice the operation is immediately

                                 executed without terminating any
                                 processes or unmounting any file
                                 systems. This may result in data
                                 executed without terminating any
                                 processes or unmounting any file
                                 systems. This may result in data


@@ -1167,12 +1173,29 @@
                         <varlistentry>
                                 <term><command>suspend</command></term>
 
                         <varlistentry>
                                 <term><command>suspend</command></term>
 

-                                <listitem><para>Suspend the system.</para></listitem>
+                                <listitem><para>Suspend the
+                                system. This will trigger activation
+                                of the special
+                                <filename>suspend.target</filename>
+                                target.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>hibernate</command></term>
 
                         </varlistentry>
                         <varlistentry>
                                 <term><command>hibernate</command></term>
 

-                                <listitem><para>Hibernate the system.</para></listitem>
+                                <listitem><para>Hibernate the
+                                system. This will trigger activation
+                                of the special
+                                <filename>hibernate.target</filename>
+                                target.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>hybrid-sleep</command></term>
+
+                                <listitem><para>Hibernate and suspend
+                                the system. This will trigger
+                                activation of the special
+                                <filename>hybrid-sleep.target</filename>
+                                target.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>switch-root [ROOT] [INIT]</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>switch-root [ROOT] [INIT]</command></term>


@@ -1190,10 +1213,10 @@
                                 directory, and the path to the new
                                 system manager binary below it to
                                 execute as PID 1. If the latter is
                                 directory, and the path to the new
                                 system manager binary below it to
                                 execute as PID 1. If the latter is

-                                ommitted or the empty string, a
+                                omitted or the empty string, a

                                 systemd binary will automatically be
                                 searched for and used as init. If the
                                 systemd binary will automatically be
                                 searched for and used as init. If the

-                                system manager path is ommitted or
+                                system manager path is omitted or

                                 equal the empty string the state of
                                 the initrd's system manager process is
                                 passed to the main system manager,
                                 equal the empty string the state of
                                 the initrd's system manager process is
                                 passed to the main system manager,