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 3266333be1b41b80174508f2758c4a2941780740..31f3b1a90986c48a71d884a805faf66ad380359d 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -8,16 +8,16 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it

-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or

   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

-  General Public License for more details.
+  Lesser General Public License for more details.

 
 

-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License

   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 


@@ -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


@@ -200,17 +212,17 @@
                         <varlistentry>
                                 <term><option>--no-legend</option></term>
 
                         <varlistentry>
                                 <term><option>--no-legend</option></term>
 

-                               <listitem><para>Do not print a legend, i.e.
+                                <listitem><para>Do not print a legend, i.e.

                                 the column headers and the footer with hints.
                                 the column headers and the footer with hints.

-                               </para></listitem>
-                       </varlistentry>
+                                </para></listitem>
+                        </varlistentry>

 
                         <varlistentry>
                                 <term><option>--no-pager</option></term>
 
 
                         <varlistentry>
                                 <term><option>--no-pager</option></term>
 

-                               <listitem><para>Do not pipe output into a
-                               pager.</para></listitem>
-                       </varlistentry>
+                                <listitem><para>Do not pipe output into a
+                                pager.</para></listitem>
+                        </varlistentry>

 
                         <varlistentry>
                                 <term><option>--system</option></term>
 
                         <varlistentry>
                                 <term><option>--system</option></term>


@@ -299,11 +311,13 @@
                                 <command>systemctl</command> will
                                 query the user on the terminal for the
                                 necessary secrets. Use this option to
                                 <command>systemctl</command> will
                                 query the user on the terminal for the
                                 necessary secrets. Use this option to

-                                switch this behavior off. In this
-                                case the password must be supplied by
-                                some other means (for example
-                                graphical password agents) or the
-                                service might fail.</para></listitem>
+                                switch this behavior off. In this case
+                                the password must be supplied by some
+                                other means (for example graphical
+                                password agents) or the service might
+                                fail. This also disables querying the
+                                user for authentication for privileged
+                                operations.</para></listitem>

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


@@ -341,7 +355,7 @@
                                 <term><option>-f</option></term>
 
                                 <listitem><para>When used with
                                 <term><option>-f</option></term>
 
                                 <listitem><para>When used with

-                                <command>enable</command>, override any
+                                <command>enable</command>, overwrite any

                                 existing conflicting
                                 symlinks.</para></listitem>
 
                                 existing conflicting
                                 symlinks.</para></listitem>
 


@@ -414,6 +428,34 @@
                                 PolicyKit before executing the
                                 operation.</para></listitem>
                         </varlistentry>
                                 PolicyKit before executing the
                                 operation.</para></listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term><option>--lines=</option></term>
+                                <term><option>-n</option></term>
+
+                                <listitem><para>When used with
+                                <command>status</command> controls the
+                                number of journal lines to show,
+                                counting from the most recent
+                                ones. Takes a positive integer
+                                argument. Defaults to
+                                10.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--output=</option></term>
+                                <term><option>-o</option></term>
+
+                                <listitem><para>When used with
+                                <command>status</command> controls the
+                                formatting of the journal entries that
+                                are shown. For the available choices
+                                see
+                                <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Defaults
+                                to
+                                <literal>short</literal>.</para></listitem>
+                        </varlistentry>
+

                 </variablelist>
 
                 <para>The following commands are understood:</para>
                 </variablelist>
 
                 <para>The following commands are understood:</para>


@@ -558,14 +600,15 @@
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more

-                                units. This function is intended to
-                                generate human-readable output. If you
-                                are looking for computer-parsable
-                                output, use <command>show</command>
-                                instead. If a PID is passed
-                                information about the unit the process
-                                of the PID belongs to is
-                                shown.</para></listitem>
+                                units, followed by its most recent log
+                                data from the journal. This function
+                                is intended to generate human-readable
+                                output. If you are looking for
+                                computer-parsable output, use
+                                <command>show</command> instead. If a
+                                PID is passed information about the
+                                unit the process of the PID belongs to
+                                is shown.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>show [NAME...|JOB...]</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>show [NAME...|JOB...]</command></term>


@@ -590,7 +633,15 @@
                                 looking for formatted human-readable
                                 output.</para></listitem>
                         </varlistentry>
                                 looking for formatted human-readable
                                 output.</para></listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><command>help [NAME...|PID...]</command></term>

 
 

+                                <listitem><para>Show manual pages for
+                                one or more units, if available. If a
+                                PID is passed the manual pages for the
+                                unit the process of the PID belongs to
+                                is shown.</para></listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><command>reset-failed [NAME...]</command></term>
 
                         <varlistentry>
                                 <term><command>reset-failed [NAME...]</command></term>
 


@@ -620,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


@@ -710,9 +766,9 @@
                                 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
                                 is desired an additional

-                                <command>stop</command>command should
+                                <command>stop</command> command should

                                 be executed afterwards.</para>
 
                                 <para>This command will print the
                                 be executed afterwards.</para>
 
                                 <para>This command will print the


@@ -733,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


@@ -764,12 +820,19 @@
 
                                 <listitem><para>Reset one or more unit
                                 files, as specified on the command
 
                                 <listitem><para>Reset one or more unit
                                 files, as specified on the command

-                                line, to the defaults configured in a
-                                preset file. This has the same effect
-                                as <command>disable</command> or
+                                line, to the defaults configured in
+                                the preset policy files. This has the
+                                same effect as
+                                <command>disable</command> or

                                 <command>enable</command>, depending
                                 how the unit is listed in the preset
                                 <command>enable</command>, depending
                                 how the unit is listed in the preset

-                                files.</para>
+                                files. For more information on preset
+                                policy format see
+                                <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
+                                more information on the concept of
+                                presets please consult the <ulink
+                                url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
+                                document.</para>

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


@@ -1033,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


@@ -1054,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


@@ -1075,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


@@ -1107,6 +1170,60 @@
                                 <option>--user</option> option) and
                                 will fail otherwise.</para></listitem>
                         </varlistentry>
                                 <option>--user</option> option) and
                                 will fail otherwise.</para></listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><command>suspend</command></term>
+
+                                <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>
+
+                                <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>
+
+                                <listitem><para>Switches to a
+                                different root directory and executes
+                                a new system manager process below
+                                it. This is intended for usage in
+                                initial RAM disks ("initrd"), and will
+                                transition from the initrd's system
+                                manager process (a.k.a "init" process)
+                                to the main system manager
+                                process. Takes two arguments: the
+                                directory to make the new root
+                                directory, and the path to the new
+                                system manager binary below it to
+                                execute as PID 1. If the latter is
+                                omitted or the empty string, a
+                                systemd binary will automatically be
+                                searched for and used as init. If the
+                                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,
+                                which allows later introspection of the
+                                state of the services involved in the
+                                initrd boot.</para></listitem>
+                        </varlistentry>

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


@@ -1139,10 +1256,12 @@
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

-                        <citerefentry><refentrytitle>systemd-loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,

-                        <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>

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