chiark / gitweb /
main: add a few more useful diagnostic log messages
[elogind.git] / man / systemctl.xml
index 2ffc87d..a7065f9 100644 (file)
@@ -70,7 +70,7 @@
                 <variablelist>
                         <varlistentry>
                                 <term><option>--help</option></term>
-                                <term><option>--h</option></term>
+                                <term><option>-h</option></term>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
@@ -78,6 +78,7 @@
 
                         <varlistentry>
                                 <term><option>--type=</option></term>
+                                <term><option>-t</option></term>
 
                                 <listitem><para>When listing units,
                                 limit display to certain unit
                         </varlistentry>
 
                         <varlistentry>
+                                <term><option>--property=</option></term>
+                                <term><option>-p</option></term>
+
+                                <listitem><para>When showing
+                                unit/job/manager information, limit
+                                display to certain property names. If
+                                not specified all set properties are
+                                shown. The argument should be a
+                                property name, such as
+                                <literal>MainPID</literal>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
                                 <term><option>--all</option></term>
+                                <term><option>-a</option></term>
 
                                 <listitem><para>When listing units,
                                 show all units, regardless of their
-                                state, including inactive
-                                units.</para></listitem>
+                                state, including inactive units. When
+                                showing unit/job/manager information,
+                                show all properties regardless whether
+                                they are set or not.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--block</option></term>
+                                <term><option>--no-block</option></term>
+
+                               <listitem><para>Do not synchronously wait for
+                               the requested operation to finish. If this is
+                               not specified the job will be verified,
+                               enqueued and <command>systemctl</command> will
+                               wait until it is completed. By passing this
+                               argument it is only verified and
+                               enqueued.</para></listitem> </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--quiet</option></term>
+                                <term><option>-q</option></term>
 
-                                <listitem><para>Synchronously wait for
-                                the requested operation to
-                                finish.</para></listitem>
+                                <listitem><para>Suppress output to
+                                STDOUT for <command>snapshot</command>
+                                and
+                                <command>check</command>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <listitem><para>List known units.</para></listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term><command>list-jobs</command></term>
-
-                                <listitem><para>List jobs that are in progress.</para></listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><command>clear-jobs</command></term>
-
-                                <listitem><para>Cancel all jobs that are in progress.</para></listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><command>load [NAME...]</command></term>
-
-                                <listitem><para>Load one or more units
-                                specified on the command line. This
-                                will simply load their configuration
-                                from disk, but not start them. To
-                                start them you need to use the
-                                <command>start</command> command which
-                                will implicitly load a unit that has
-                                not been loaded yet. Note that systemd
-                                garbage collects loaded units that are
-                                not active or referenced by an active
-                                unit. This means that units loaded
-                                this way will usually not stay loaded
-                                for long. Also note that this command
-                                cannot be used to reload unit
-                                configuration. Use the
-                                <command>daemon-reload</command>
-                                command for that. All in all this
-                                command is of little use except for
-                                debugging.</para>
-                                <para>This command should not be
-                                confused with the
-                                <command>daemon-reload</command> or
-                                <command>reload</command>
-                                commands.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><command>cancel [JOB...]</command></term>
-
-                                <listitem><para>Cancel one or more
-                                jobs specified on the command line by
-                                their numeric job
-                                IDs.</para></listitem>
-                        </varlistentry>
-                        <varlistentry>
                                 <term><command>start [NAME...]</command></term>
 
                                 <listitem><para>Start one or more
                                 others.</para></listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><command>check [NAME...]</command></term>
+
+                                <listitem><para>Check whether any of
+                                the specified units is active
+                                (i.e. running). Returns 0 if at least
+                                one is active, non-zero
+                                otherwise. Unless
+                                <option>--quiet</option> is specified
+                                this will also print the current unit
+                                state to STDOUT.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>status [NAME...]</command></term>
+
+                                <listitem><para>Show short status
+                                information about one or more
+                                units. This shows terse runtime
+                                information about
+                                units.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>show [NAME...|JOB...]</command></term>
+
+                                <listitem><para>Show properties of
+                                one or more units, jobs or the manager
+                                itself. If no argument is specified
+                                properties of the manager will be
+                                shown. If a unit name is specified
+                                properties of the unit is shown,
+                                and if a job id is specified
+                                properties of the job is
+                                shown.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>load [NAME...]</command></term>
+
+                                <listitem><para>Load one or more units
+                                specified on the command line. This
+                                will simply load their configuration
+                                from disk, but not start them. To
+                                start them you need to use the
+                                <command>start</command> command which
+                                will implicitly load a unit that has
+                                not been loaded yet. Note that systemd
+                                garbage collects loaded units that are
+                                not active or referenced by an active
+                                unit. This means that units loaded
+                                this way will usually not stay loaded
+                                for long. Also note that this command
+                                cannot be used to reload unit
+                                configuration. Use the
+                                <command>daemon-reload</command>
+                                command for that. All in all, this
+                                command is of little use except for
+                                debugging.</para>
+                                <para>This command should not be
+                                confused with the
+                                <command>daemon-reload</command> or
+                                <command>reload</command>
+                                commands.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>list-jobs</command></term>
+
+                                <listitem><para>List jobs that are in progress.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>cancel [JOB...]</command></term>
+
+                                <listitem><para>Cancel one or more
+                                jobs specified on the command line by
+                                their numeric job
+                                IDs.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>clear-jobs</command></term>
+
+                                <listitem><para>Cancel all jobs that are in progress.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><command>monitor</command></term>
 
                                 <listitem><para>Monitor unit/job
                                 <term><command>snapshot [NAME]</command></term>
 
                                 <listitem><para>Create a snapshot. If
-                                a snapshot name is specified the new
+                                a snapshot name is specified, the new
                                 snapshot will be named after it. If
                                 none is specified an automatic
                                 snapshot name is generated. In either
-                                case the snapshot name used is printed
-                                to STDOUT.</para>
+                                case, the snapshot name used is
+                                printed to STDOUT, unless
+                                <option>--quiet</option> is
+                                specified.</para>
 
                                 <para>A snapshot refers to a saved
                                 state of the systemd manager. It is
                                 on reboot.</para>
                         </varlistentry>
                         <varlistentry>
+                                <term><command>delete [NAME...]</command></term>
+
+                                <listitem><para>Remove a snapshot
+                                previously created with
+                                <command>snapshot</command>.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><command>daemon-reload</command></term>
 
                                 <listitem><para>Reload systemd manager
                                 configuration. This will reload all
                                 unit files and recreate the entire
                                 dependency tree. While the daemon is
-                                reloaded all sockets systemd listens
+                                reloaded, all sockets systemd listens
                                 on on behalf of user configuration will
                                 stay accessible.</para> <para>This
                                 command should not be confused with