Merge pull request #2806 from brauner/2019-01-27/bugfixes

[mirror_lxc.git] / doc / lxc-info.sgml.in

diff --git a/doc/lxc-info.sgml.in b/doc/lxc-info.sgml.in
index 5f99994bb353a68adeb59647652955db28f69a26..d18527d71f0334cc7f2b4c7d18f63cd965dfa7b2 100644 (file)
--- a/doc/lxc-info.sgml.in
+++ b/doc/lxc-info.sgml.in
@@ -47,7 +47,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>lxc-info</command>
-      <arg choice="opt">-n <replaceable>name</replaceable></arg>
+      <arg choice="req">-n <replaceable>name</replaceable></arg>
       <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
       <arg choice="opt">-s</arg>
       <arg choice="opt">-p</arg>
@@ -60,8 +60,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
   <refsect1>
     <title>Description</title>
     <para>
-      <command>lxc-info</command> queries and shows information about
-      containers.
+      <command>lxc-info</command> queries and shows information about a
+      container.
     </para>
   </refsect1>
 
@@ -71,39 +71,19 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-n <replaceable>name</replaceable></optional></option>
+          <option>-c, --config <replaceable>KEY</replaceable></option>
         </term>
         <listitem>
           <para>
-            The container name. It is interpreted as a regular expression,
-            so it is possible to get information on all containers, several
-            of them or just one. See
-            <citerefentry>
-             <refentrytitle><command>regex</command></refentrytitle>
-            <manvolnum>7</manvolnum>
-            </citerefentry> for regular expression syntax. If not specified,
-            <replaceable>name</replaceable> will default to '.*' which
-            will give information on all containers in
-            <command>lxcpath</command>.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <option><optional>-c <replaceable>KEY</replaceable></optional></option>
-        </term>
-        <listitem>
-          <para>
-            Print a configuration key from the running container. This option
-            may be given mulitple times to print out multiple key = value pairs.
+            Print a configuration key from the container. This option
+            may be given multiple times to print out multiple key = value pairs.
           </para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term>
-          <option><optional>-s</optional></option>
+          <option>-s, --state</option>
         </term>
         <listitem>
           <para>
@@ -114,7 +94,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-p</optional></option>
+          <option>-p, --pid</option>
         </term>
         <listitem>
           <para>
@@ -125,7 +105,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-i</optional></option>
+          <option>-i, --ips</option>
         </term>
         <listitem>
           <para>
@@ -136,7 +116,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-S</optional></option>
+          <option>-S, --stats</option>
         </term>
         <listitem>
           <para>
@@ -159,7 +139,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-H</optional></option>
+          <option>-H, --no-humanize</option>
         </term>
         <listitem>
           <para>
@@ -195,7 +175,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       </varlistentry>
 
       <varlistentry>
-        <term>lxc-info -n foo -c lxc.network.0.veth.pair</term>
+        <term>lxc-info -n foo -c lxc.net.0.veth.pair</term>
         <listitem>
           <para>
             prints the veth pair name of foo.