man: improve wording of systemctl's --after/--before

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index a80d3720e4a41fdd7fcf38e5fe0aed2115455d8c..77447dd122bdc17ceaaf72ae8fa93136c0f597d7 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -72,22 +72,6 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para>The following options are understood:</para>
 
     <variablelist>
     <para>The following options are understood:</para>
 
     <variablelist>

-      <varlistentry>
-        <term><option>-h</option></term>
-        <term><option>--help</option></term>
-
-        <listitem><para>Prints a short help
-        text and exits.</para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>--version</option></term>
-
-        <listitem>
-          <para>Prints a short version string and exits.</para>
-        </listitem>
-      </varlistentry>
-

       <varlistentry>
         <term><option>-t</option></term>
         <term><option>--type=</option></term>
       <varlistentry>
         <term><option>-t</option></term>
         <term><option>--type=</option></term>


@@ -147,6 +131,18 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 

+      <varlistentry>
+        <term><option>-r</option></term>
+        <term><option>--recursive</option></term>
+
+        <listitem>
+          <para>When listing units, also show units of local
+          containers. Units of local containers will be prefixed with
+          the container name, separated by a single colon character
+          (<literal>:</literal>).</para>
+        </listitem>
+      </varlistentry>
+

       <varlistentry>
         <term><option>--reverse</option></term>
 
       <varlistentry>
         <term><option>--reverse</option></term>
 


@@ -161,12 +157,27 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
       <varlistentry>
         <term><option>--after</option></term>
 
       <varlistentry>
         <term><option>--after</option></term>

+
+        <listitem>
+          <para>With <command>list-dependencies</command>, show the
+          units that are ordered before the specified unit. In other
+          words, list the units that are in the <varname>After=</varname>
+          directive of the specified unit, have the specified unit in
+          their <varname>Before=</varname> directive, or are otherwise
+          implicit dependencies of the specified unit.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>

         <term><option>--before</option></term>
 
         <listitem>
         <term><option>--before</option></term>
 
         <listitem>

-          <para>Show which units are started after or before
-          with <command>list-dependencies</command>, respectively.
-          </para>
+          <para>With <command>list-dependencies</command>, show the
+          units that are ordered after the specified unit. In other
+          words, list the units that are in the <varname>Before=</varname>
+          directive of the specified unit, have the specified unit in
+          their <varname>After=</varname> directive, or otherwise depend
+          on the specified unit.</para>

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


@@ -301,30 +312,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 

-      <varlistentry>
-        <term><option>--no-pager</option></term>
-
-        <listitem>
-          <para>Do not pipe output into a pager.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>--system</option></term>
-
-        <listitem>
-          <para>Talk to the systemd system manager. (Default)</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>--user</option></term>
-
-        <listitem>
-          <para>Talk to the systemd manager of the calling
-          user.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="user-system-options.xml" xpointer="user" />
+      <xi:include href="user-system-options.xml" xpointer="system" />

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


@@ -460,27 +449,6 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 

-      <varlistentry>
-        <term><option>-H</option></term>
-        <term><option>--host</option></term>
-
-        <listitem>
-          <para>Execute the operation remotely. Specify a hostname, or
-          username and hostname separated by <literal>@</literal>, to
-          connect to. This will use SSH to talk to the remote systemd
-          instance.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-          <term><option>-M</option></term>
-          <term><option>--machine=</option></term>
-
-          <listitem><para>Execute the operation on a local
-          container. Specify a container name to connect
-          to.</para></listitem>
-      </varlistentry>
-

       <varlistentry>
         <term><option>-n</option></term>
         <term><option>--lines=</option></term>
       <varlistentry>
         <term><option>-n</option></term>
         <term><option>--lines=</option></term>


@@ -515,6 +483,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 

+      <xi:include href="user-system-options.xml" xpointer="host" />
+      <xi:include href="user-system-options.xml" xpointer="machine" />
+
+      <xi:include href="standard-options.xml" xpointer="help" />
+      <xi:include href="standard-options.xml" xpointer="version" />
+      <xi:include href="standard-options.xml" xpointer="no-pager" />

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


@@ -591,7 +565,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             failed state usually are not loaded, and would not be
             matched by any pattern. In addition, in case of
             instantiated units, systemd is often unaware of the
             failed state usually are not loaded, and would not be
             matched by any pattern. In addition, in case of
             instantiated units, systemd is often unaware of the

-            instance name until the instance has been started. Therefore
+            instance name until the instance has been started. Therefore,

             using glob patterns with <command>start</command>
             has limited usefulness.</para>
           </listitem>
             using glob patterns with <command>start</command>
             has limited usefulness.</para>
           </listitem>


@@ -725,10 +699,11 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <listitem>
             <para>Show terse runtime status information about one or
             more units, followed by most recent log data from the
           <listitem>
             <para>Show terse runtime status information about one or
             more units, followed by most recent log data from the

-            journal. If no units are specified, show all units (subject
-            to limitations specified with <option>-t</option>). If a PID
-            is passed, show information about the unit the process
-            belongs to.</para>
+            journal. If no units are specified, show system status. If
+            combined with <option>--all</option> also shows status of
+            all units (subject to limitations specified with
+            <option>-t</option>). If a PID is passed, show information
+            about the unit the process belongs to.</para>

 
             <para>This function is intended to generate human-readable
             output. If you are looking for computer-parsable output,
 
             <para>This function is intended to generate human-readable
             output. If you are looking for computer-parsable output,


@@ -1094,6 +1069,24 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
       </variablelist>
     </refsect2>
 
       </variablelist>
     </refsect2>
 

+    <refsect2>
+      <title>Machine Commands</title>
+
+      <variablelist>
+        <varlistentry>
+          <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
+
+          <listitem>
+            <para>List the host and all running local containers with
+            their state. If one or more
+            <replaceable>PATTERN</replaceable>s are specified, only
+            containers matching one of them are shown.
+            </para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+

     <refsect2>
       <title>Job Commands</title>
 
     <refsect2>
       <title>Job Commands</title>
 


@@ -1199,9 +1192,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <listitem>
             <para>Import all, one or more environment variables set on
             the client into the systemd manager environment block. If
           <listitem>
             <para>Import all, one or more environment variables set on
             the client into the systemd manager environment block. If

-            no arguments are passed the entire environment block is
-            imported. Otherwise a list of one or more environment
-            variable names should be passed, whose client side values
+            no arguments are passed, the entire environment block is
+            imported. Otherwise, a list of one or more environment
+            variable names should be passed, whose client-side values

             are then imported into the manager's environment
             block.</para>
           </listitem>
             are then imported into the manager's environment
             block.</para>
           </listitem>


@@ -1432,7 +1425,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
       <programlisting># systemctl status dev-sda.device
 # systemctl status home.mount</programlisting>
       In the second case, shell-style globs will be matched against
       <programlisting># systemctl status dev-sda.device
 # systemctl status home.mount</programlisting>
       In the second case, shell-style globs will be matched against

-      currently loaded units, and literal unit names, with or without
+      currently loaded units; literal unit names, with or without

       a suffix, will be treated as in the first case. This means that
       literal unit names always refer to exactly one unit, but globs
       may match zero units and this is not considered an error.</para>
       a suffix, will be treated as in the first case. This means that
       literal unit names always refer to exactly one unit, but globs
       may match zero units and this is not considered an error.</para>


@@ -1444,7 +1437,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
       <literal>[]</literal> may be used. See
       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
       for more details. The patterns are matched against the names of
       <literal>[]</literal> may be used. See
       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
       for more details. The patterns are matched against the names of

-      currently loaded units, and patterns which don't match anything
+      currently loaded units, and patterns which do not match anything

       are silently skipped. For example:
       <programlisting># systemctl stop sshd@*.service</programlisting>
       will stop all <filename>sshd@.service</filename> instances.
       are silently skipped. For example:
       <programlisting># systemctl stop sshd@*.service</programlisting>
       will stop all <filename>sshd@.service</filename> instances.