seccomp: coding style

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

diff --git a/doc/lxc-info.sgml.in b/doc/lxc-info.sgml.in
index ba0a044d110432a46ae4c2d1480f8d7071dbf1ab..d18527d71f0334cc7f2b4c7d18f63cd965dfa7b2 100644 (file)
--- a/doc/lxc-info.sgml.in
+++ b/doc/lxc-info.sgml.in
@@ -17,7 +17,7 @@ Lesser General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
 -->
 
@@ -48,9 +48,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <cmdsynopsis>
       <command>lxc-info</command>
       <arg choice="req">-n <replaceable>name</replaceable></arg>
-      <arg choice="req">-s</arg>
-      <arg choice="req">-p</arg>
-      <arg choice="req">-t <replaceable>state</replaceable></arg>
+      <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
+      <arg choice="opt">-s</arg>
+      <arg choice="opt">-p</arg>
+      <arg choice="opt">-i</arg>
+      <arg choice="opt">-S</arg>
+      <arg choice="opt">-H</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -68,18 +71,19 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option>-n <replaceable>name</replaceable></option>
+          <option>-c, --config <replaceable>KEY</replaceable></option>
         </term>
         <listitem>
           <para>
-            The container name.
+            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>
@@ -90,7 +94,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>-p</optional></option>
+          <option>-p, --pid</option>
         </term>
         <listitem>
           <para>
@@ -101,11 +105,46 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>-t <replaceable>state</replaceable></optional></option>
+          <option>-i, --ips</option>
         </term>
         <listitem>
           <para>
-            Check whether the container is in the provided state.
+            Just print the container's IP addresses.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <option>-S, --stats</option>
+        </term>
+        <listitem>
+          <para>
+            Just print the container's statistics.
+            Note that for performance reasons the kernel does not account
+            kernel memory use unless a kernel memory limit is set. If a limit
+            is not set, <command>lxc-info</command> will display kernel memory
+            use as 0. A limit can be set by specifying
+            <programlisting>
+            lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable>
+            </programlisting>
+            in your container configuration file, see
+            <citerefentry>
+              <refentrytitle>lxc.conf</refentrytitle>
+              <manvolnum>5</manvolnum>
+            </citerefentry>.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <option>-H, --no-humanize</option>
+        </term>
+        <listitem>
+          <para>
+            Print the container's statistics in raw, non-humanized form. The
+            default is to print statistics in humanized form.
           </para>
         </listitem>
       </varlistentry>
@@ -127,10 +166,19 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       </varlistentry>
 
       <varlistentry>
-        <term>lxc-info -n foo -t RUNNING</term>
+        <term>lxc-info -n 'ubuntu.*'</term>
+        <listitem>
+          <para>
+            Show information for all containers whose name starts with ubuntu.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>lxc-info -n foo -c lxc.net.0.veth.pair</term>
         <listitem>
           <para>
-            exits 0 if foo is RUNNING, 1 otherwise.
+            prints the veth pair name of foo.
           </para>
         </listitem>
       </varlistentry>