systemctl: filter shown units by their load state

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index dd0ff786ece1b8a3ae591274a1fabfd4ba0bcc59..bf31b6114d9b7923c2a075f78f4b48bf1db54056 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>


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


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


@@ -632,7 +644,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>
 


@@ -754,7 +774,7 @@
                                 command does not implicitly stop the
                                 units that is being disabled. If this
                                 is desired an additional
                                 command does not implicitly stop the
                                 units that is being disabled. If this
                                 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


@@ -806,12 +826,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>
 


@@ -1149,6 +1176,43 @@
                                 <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.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>hibernate</command></term>
+
+                                <listitem><para>Hibernate the system.</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
+                                ommitted or the empty string, a
+                                systemd binary will automatically be
+                                searched for and used as init. If the
+                                system manager path is ommitted 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>


@@ -1185,7 +1249,8 @@
                         <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>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>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>