chiark / gitweb /
man: update systemctl man page
authorLennart Poettering <lennart@poettering.net>
Sun, 4 Jul 2010 18:46:12 +0000 (20:46 +0200)
committerLennart Poettering <lennart@poettering.net>
Sun, 4 Jul 2010 18:46:12 +0000 (20:46 +0200)
man/systemctl.xml
src/systemctl.c

index e3a07d5..1bd08da 100644 (file)
                         </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>
                                 <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
                                 state to STDOUT.</para></listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><command>show [NAME...|JOB...]</command></term>
+
+                                <listitem><para>Show information about
+                                one or more units, jobs or the manager
+                                itself. If no argument is specified
+                                information about the manager will be
+                                shown. If a unit name is specified
+                                information about the unit is shown,
+                                and if a job id is specified
+                                information about 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
index 12ddae8..72bb7d8 100644 (file)
@@ -2106,7 +2106,7 @@ static int systemctl_help(void) {
                "Send control commands to the systemd manager.\n\n"
                "  -h --help          Show this help\n"
                "  -t --type=TYPE     List only units of a particular type\n"
-               "  -p --property=NAME Show only property by this name\n"
+               "  -p --property=NAME Show only properties by this name\n"
                "  -a --all           Show all units/properties, including dead/empty ones\n"
                "     --replace       When installing a new job, replace existing conflicting ones\n"
                "     --system        Connect to system bus\n"
@@ -2122,7 +2122,7 @@ static int systemctl_help(void) {
                "  reload [NAME...]                Reload one or more units\n"
                "  isolate [NAME]                  Start one unit and stop all others\n"
                "  check [NAME...]                 Check whether any of the passed units are active\n"
-               "  show [NAME...|JOB...]           Show information about one or more units\n"
+               "  show [NAME...|JOB...]           Show information about one or more units/jobs/manager\n"
                "  load [NAME...]                  Load one or more units\n"
                "  list-jobs                       List jobs\n"
                "  cancel [JOB...]                 Cancel one or more jobs\n"