man: grammar and wording improvements

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index 5a15e5ca05042031b7a8f37abd8c65f7064a9968..250866a875ec754d24ffcb26d20136dd05cec9c5 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -174,10 +174,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--full</option></term>
 
         <listitem>
         <term><option>--full</option></term>
 
         <listitem>

-          <para>Do not ellipsize unit names, process tree entries, and
-          truncate unit descriptions in the output of
-          <command>list-units</command> and
-          <command>list-jobs</command>.</para>
+          <para>Do not ellipsize unit names, process tree entries,
+          journal output, or truncate unit descriptions in the output
+          of <command>status</command>, <command>list-units</command>,
+          <command>list-jobs</command>, and
+          <command>list-timers</command>.</para>

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


@@ -193,8 +194,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--job-mode=</option></term>
 
         <listitem>
         <term><option>--job-mode=</option></term>
 
         <listitem>

-        <para>When queuing a new job, control how to deal with already
-        queued jobs. Takes one of <literal>fail</literal>,
+        <para>When queuing a new job, this option controls how to deal with
+        already queued jobs. It takes one of <literal>fail</literal>,

         <literal>replace</literal>,
         <literal>replace-irreversibly</literal>,
         <literal>isolate</literal>,
         <literal>replace</literal>,
         <literal>replace-irreversibly</literal>,
         <literal>isolate</literal>,


@@ -237,7 +238,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         applications.</para>
 
         <para><literal>ignore-requirements</literal> is similar to
         applications.</para>
 
         <para><literal>ignore-requirements</literal> is similar to

-        <literal>ignore-dependencies</literal> but only causes the
+        <literal>ignore-dependencies</literal>, but only causes the

         requirement dependencies to be ignored, the ordering
         dependencies will still be honoured.</para>
         </listitem>
         requirement dependencies to be ignored, the ordering
         dependencies will still be honoured.</para>
         </listitem>


@@ -256,7 +257,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           sleep state. Any user may take these locks and privileged
           users may override these locks. If any locks are taken,
           shutdown and sleep state requests will normally fail
           sleep state. Any user may take these locks and privileged
           users may override these locks. If any locks are taken,
           shutdown and sleep state requests will normally fail

-          (regardless if privileged or not) and a list of active locks
+          (regardless of whether privileged or not) and a list of active locks

           is printed. However, if <option>--ignore-inhibitors</option>
           is specified, the locks are ignored and not printed, and the
           operation attempted anyway, possibly requiring additional
           is printed. However, if <option>--ignore-inhibitors</option>
           is specified, the locks are ignored and not printed, and the
           operation attempted anyway, possibly requiring additional


@@ -294,7 +295,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--no-legend</option></term>
 
         <listitem>
         <term><option>--no-legend</option></term>
 
         <listitem>

-          <para>Do not print a legend, i.e.  the column headers and
+          <para>Do not print the legend, i.e. the column headers and

           the footer with hints.</para>
         </listitem>
       </varlistentry>
           the footer with hints.</para>
         </listitem>
       </varlistentry>


@@ -443,7 +444,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
         <listitem>
           <para>When used with <command>enable</command>,
 
         <listitem>
           <para>When used with <command>enable</command>,

-          <command>disable</command>, <command>is-enabled</command>
+          <command>disable</command>,

           (and related commands), make changes only temporarily, so
           that they are lost on the next reboot. This will have the
           effect that changes are not made in subdirectories of
           (and related commands), make changes only temporarily, so
           that they are lost on the next reboot. This will have the
           effect that changes are not made in subdirectories of


@@ -451,7 +452,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           with identical immediate effects, however, since the latter
           is lost on reboot, the changes are lost too.</para>
 
           with identical immediate effects, however, since the latter
           is lost on reboot, the changes are lost too.</para>
 

-          <para>Similar, when used with
+          <para>Similarly, when used with

           <command>set-property</command>, make changes only
           temporarily, so that they are lost on the next
           reboot.</para>
           <command>set-property</command>, make changes only
           temporarily, so that they are lost on the next
           reboot.</para>


@@ -526,22 +527,26 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
       <variablelist>
         <varlistentry>
 
       <variablelist>
         <varlistentry>

-          <term><command>list-units</command></term>
+          <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>

 
           <listitem>
             <para>List known units (subject to limitations specified
 
           <listitem>
             <para>List known units (subject to limitations specified

-            with <option>-t</option>).</para>
+            with <option>-t</option>). If one or more
+            <replaceable>PATTERN</replaceable>s are specified, only
+            units matching one of them are shown.</para>

 
             <para>This is the default command.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
 
             <para>This is the default command.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>

-          <term><command>list-sockets</command></term>
+          <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>

 
           <listitem>
 
           <listitem>

-            <para>List socket units ordered by the listening address. Produces output
-            similar to
+            <para>List socket units ordered by listening address.
+            If one or more <replaceable>PATTERN</replaceable>s are
+            specified, only socket units matching one of them are
+            shown. Produces output similar to

             <programlisting>
 LISTEN           UNIT                        ACTIVATES
 /dev/initctl     systemd-initctl.socket      systemd-initctl.service
             <programlisting>
 LISTEN           UNIT                        ACTIVATES
 /dev/initctl     systemd-initctl.socket      systemd-initctl.service


@@ -561,10 +566,13 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
         </varlistentry>
 
         <varlistentry>

-          <term><command>list-timers</command></term>
+          <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>

 
           <listitem>
 
           <listitem>

-            <para>List timer units ordered by the time they elapse next.</para>
+            <para>List timer units ordered by the time they elapse
+            next. If one or more <replaceable>PATTERN</replaceable>s
+            are specified, only units matching one of them are shown.
+            </para>

 
             <para>See also the options <option>--all</option> and
             <option>--failed</option>.</para>
 
             <para>See also the options <option>--all</option> and
             <option>--failed</option>.</para>


@@ -684,7 +692,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <listitem>
             <para>Check whether any of the specified units are active
             (i.e. running). Returns an exit code 0 if at least one is
           <listitem>
             <para>Check whether any of the specified units are active
             (i.e. running). Returns an exit code 0 if at least one is

-            active, non-zero otherwise. Unless <option>--quiet</option>
+            active, or non-zero otherwise. Unless <option>--quiet</option>

             is specified, this will also print the current unit state to
             STDOUT.</para>
           </listitem>
             is specified, this will also print the current unit state to
             STDOUT.</para>
           </listitem>


@@ -701,7 +709,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
           </listitem>
         </varlistentry>
         <varlistentry>

-          <term><command>status [<replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...]</command></term>
+          <term><command>status</command> <optional><replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>

 
           <listitem>
             <para>Show terse runtime status information about one or
 
           <listitem>
             <para>Show terse runtime status information about one or


@@ -712,12 +720,22 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             belongs to.</para>
 
             <para>This function is intended to generate human-readable
             belongs to.</para>
 
             <para>This function is intended to generate human-readable

-            output. If you are looking for computer-parsable output, use
-            <command>show</command> instead.</para>
+            output. If you are looking for computer-parsable output,
+            use <command>show</command> instead. By default this
+            function only shows 10 lines of output and ellipsizes
+            lines to fit in the terminal window. This can be changes
+            with <option>--lines</option> and <option>--full</option>,
+            see above. In addition, <command>journalctl
+            --unit=<replaceable>NAME</replaceable></command> or
+            <command>journalctl
+            --user-unit=<replaceable>NAME</replaceable></command> use
+            a similar filter for messages and might be more
+            convenient.
+            </para>

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

-          <term><command>show [<replaceable>NAME</replaceable>...|<replaceable>JOB</replaceable>...]</command></term>
+          <term><command>show</command> <optional><replaceable>NAME</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>

 
           <listitem>
             <para>Show properties of one or more units, jobs, or the
 
           <listitem>
             <para>Show properties of one or more units, jobs, or the


@@ -737,10 +755,10 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <term><command>cat <replaceable>NAME</replaceable>...</command></term>
 
           <listitem>
           <term><command>cat <replaceable>NAME</replaceable>...</command></term>
 
           <listitem>

-            <para>Show backing files of one or more units.
-            Prints the fragment, drop-ins, and source (sysvinit compat)
-            of units. Each file is preceded by a comment which includes the
-            file name.</para>
+            <para>Show backing files of one or more units. Prints the
+            "fragment" and "drop-ins" (source files) of units. Each
+            file is preceded by a comment which includes the file
+            name.</para>

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


@@ -814,10 +832,13 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
       <variablelist>
         <varlistentry>
 
       <variablelist>
         <varlistentry>

-          <term><command>list-unit-files</command></term>
+          <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>

 
           <listitem>
 
           <listitem>

-            <para>List installed unit files.</para>
+            <para>List installed unit files. If one or more
+            <replaceable>PATTERN</replaceable>s are specified, only
+            units whose filename (just the last component of the path)
+            matches one of them are shown.</para>

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


@@ -910,10 +931,64 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
           <listitem>
             <para>Checks whether any of the specified unit files are
 
           <listitem>
             <para>Checks whether any of the specified unit files are

-            enabled (as with <command>enable</command>). Returns an exit
-            code of 0 if at least one is enabled, non-zero
-            otherwise. Prints the current enable status. To suppress
-            this output, use <option>--quiet</option>.</para>
+            enabled (as with <command>enable</command>). Returns an
+            exit code of 0 if at least one is enabled, non-zero
+            otherwise. Prints the current enable status (see table).
+            To suppress this output, use <option>--quiet</option>.
+            </para>
+
+            <table>
+              <title>
+                <command>is-enabled</command> output
+              </title>
+
+              <tgroup cols='3'>
+                <thead>
+                  <row>
+                    <entry>Printed string</entry>
+                    <entry>Meaning</entry>
+                    <entry>Return value</entry>
+                  </row>
+                </thead>
+                <tbody>
+                  <row>
+                    <entry><literal>enabled</literal></entry>
+                    <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
+                    <entry morerows='1'>0</entry>
+                  </row>
+                  <row>
+                    <entry><literal>enabled-runtime</literal></entry>
+                  </row>
+                  <row>
+                    <entry><literal>linked</literal></entry>
+                    <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
+                    <entry morerows='1'>1</entry>
+                  </row>
+                  <row>
+                    <entry><literal>linked-runtime</literal></entry>
+                  </row>
+                  <row>
+                    <entry><literal>masked</literal></entry>
+                    <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
+                    <entry morerows='1'>1</entry>
+                  </row>
+                  <row>
+                    <entry><literal>masked-runtime</literal></entry>
+                  </row>
+                  <row>
+                    <entry><literal>static</literal></entry>
+                    <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
+                    <entry>1</entry>
+                  </row>
+                  <row>
+                    <entry><literal>disabled</literal></entry>
+                    <entry>Unit is not enabled</entry>
+                    <entry>1</entry>
+                  </row>
+                </tbody>
+              </tgroup>
+            </table>
+

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


@@ -1013,10 +1088,12 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
       <variablelist>
         <varlistentry>
 
       <variablelist>
         <varlistentry>

-          <term><command>list-jobs</command></term>
+          <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>

 
           <listitem>
 
           <listitem>

-            <para>List jobs that are in progress.</para>
+            <para>List jobs that are in progress. If one or more
+            <replaceable>PATTERN</replaceable>s are specified, only
+            jobs for units matching one of them are shown.</para>

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


@@ -1036,7 +1113,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
       <variablelist>
         <varlistentry>
 
       <variablelist>
         <varlistentry>

-          <term><command>snapshot [<replaceable>NAME</replaceable>]</command></term>
+          <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>

 
           <listitem>
             <para>Create a snapshot. If a snapshot name is specified,
 
           <listitem>
             <para>Create a snapshot. If a snapshot name is specified,


@@ -1281,7 +1358,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
           </listitem>
         </varlistentry>
         <varlistentry>

-          <term><command>switch-root <replaceable>ROOT</replaceable> [<replaceable>INIT</replaceable>]</command></term>
+          <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>

 
           <listitem>
             <para>Switches to a different root directory and executes a
 
           <listitem>
             <para>Switches to a different root directory and executes a


@@ -1306,7 +1383,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
     <refsect2>
       <title>Parameter Syntax</title>
 
     <refsect2>
       <title>Parameter Syntax</title>
 

-    <para>For unit commands the specified
+    <para>For unit commands, the specified

     <replaceable>NAME</replaceable> should be the full name of the
     unit, or an abbreviated name which is automatically extended with
     the <literal>.service</literal> suffix.
     <replaceable>NAME</replaceable> should be the full name of the
     unit, or an abbreviated name which is automatically extended with
     the <literal>.service</literal> suffix.


@@ -1318,7 +1395,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
     <programlisting># systemctl status dev-sda.device
 # systemctl status home.mount</programlisting></para>
 
     <programlisting># systemctl status dev-sda.device
 # systemctl status home.mount</programlisting></para>
 

-    <para>For unit file commands the
+    <para>For unit file commands, the

     specified <replaceable>NAME</replaceable> should be the full name
     of the unit file, or the absolute path to the unit file.
     <programlisting># systemctl link /path/to/foo.service</programlisting>
     specified <replaceable>NAME</replaceable> should be the full name
     of the unit file, or the absolute path to the unit file.
     <programlisting># systemctl link /path/to/foo.service</programlisting>