af_unix: add lxc_abstract_unix_send_fds_iov

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

diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in
index 877404d12cf44ff2006312b53f3394a344ec4706..7f55f4f9e20e768adcae6baa9ea41dff2b373cb5 100644 (file)
--- a/doc/lxc-ls.sgml.in
+++ b/doc/lxc-ls.sgml.in
@@ -6,7 +6,7 @@ lxc: linux Container library
 (C) Copyright IBM Corp. 2007, 2008
 
 Authors:
-Daniel Lezcano <dlezcano at fr.ibm.com>
+Daniel Lezcano <daniel.lezcano at free.fr>
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
@@ -20,12 +20,13 @@ 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
 
 -->
 
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC @docdtd@ [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -54,10 +55,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       <arg choice="opt">--frozen</arg>
       <arg choice="opt">--running</arg>
       <arg choice="opt">--stopped</arg>
-      <arg choice="opt">--fancy</arg>
-      <arg choice="opt">--fancy-format</arg>
-      <arg choice="opt">--nesting</arg>
-      <arg choice="opt">filter</arg>
+      <arg choice="opt">--defined</arg>
+      <arg choice="opt">-f</arg>
+      <arg choice="opt">-F <replaceable>format</replaceable></arg>
+      <arg choice="opt">-g <replaceable>groups</replaceable></arg>
+      <arg choice="opt">--nesting=<replaceable>NUM</replaceable></arg>
+      <arg choice="opt">--filter=<replaceable>regex</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -74,7 +77,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <variablelist>
       <varlistentry>
         <term>
-          <option><optional>-1</optional></option>
+          <option>-1</option>
         </term>
         <listitem>
           <para>
@@ -85,7 +88,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>--active</optional></option>
+          <option>--active</option>
         </term>
         <listitem>
           <para>
@@ -96,7 +99,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>--frozen</optional></option>
+          <option>--frozen</option>
         </term>
         <listitem>
           <para>
@@ -107,7 +110,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>--running</optional></option>
+          <option>--running</option>
         </term>
         <listitem>
           <para>
@@ -118,7 +121,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>--stopped</optional></option>
+          <option>--stopped</option>
         </term>
         <listitem>
           <para>
@@ -129,7 +132,18 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>--fancy</optional></option>
+          <option>--defined</option>
+        </term>
+        <listitem>
+          <para>
+            List only defined containers.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <option>-f,--fancy</option>
         </term>
         <listitem>
           <para>
@@ -140,36 +154,50 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
         <term>
-          <option><optional>--fancy-format</optional></option>
+          <option>-F,--fancy-format <replaceable>format</replaceable></option>
         </term>
         <listitem>
           <para>
-            Comma separate list of column to show in the fancy output.
-            Valid values are: name, state, ipv4, ipv6 and pid
-            Default is: name,state,ipv4,ipv6
+            Comma separated list of columns to show in the fancy output.
+            The list of accepted and default fields is listed in --help.
           </para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term>
-          <option><optional>--nesting</optional></option>
+          <option>-g,--groups <replaceable>groups</replaceable></option>
         </term>
         <listitem>
           <para>
-            Show nested containers.
+            Comma separated list of groups the container must have to be displayed.
+            The parameter may be passed multiple times.
           </para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term>
-          <option><optional>filter</optional></option>
+          <option>--nesting=<replaceable>NUM</replaceable></option>
         </term>
         <listitem>
           <para>
-            The filter passed to <command>lxc-ls</command> will be
-            applied to the container name. The format is a regular expression.
+            Show nested containers. The number of nesting levels to be shown can
+            be specified by passing a number as argument.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <option>--filter=<replaceable>regex</replaceable></option>
+        </term>
+        <listitem>
+          <para>
+            The regular expression passed to <command>lxc-ls</command> will be
+            applied to the container name. The format is a POSIX extended
+            regular expression. It can also be given as additional argument
+            without explicitly using <option>--filter</option>.
           </para>
         </listitem>
       </varlistentry>
@@ -177,15 +205,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
   </refsect1>
 
   <refsect1>
-    <title>See Also</title>
-
-    <simpara>
-      <citerefentry>
-        <refentrytitle>ls</refentrytitle>
-        <manvolnum>1</manvolnum>
-      </citerefentry>,
-    </simpara>
-
     <title>Examples</title>
     <variablelist>
       <varlistentry>
@@ -209,12 +228,23 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     </variablelist>
   </refsect1>
 
+  &commonoptions;
+
   &seealso;
 
+  <refsect1>
+    <title>History</title>
+    Written originally as a shell script by Daniel Lezcano and Serge Hallyn.
+    Later reimplemented and extended in Python by Stéphane Graber and then
+    reimplemented and extended in C by Christian Brauner.
+  </refsect1>
+
   <refsect1>
     <title>Author</title>
-    <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
+    <para>Christian Brauner <email>christian.brauner@mailbox.org</email>,
+    Stéphane Graber <email>stgraber@ubuntu.com</email></para>
   </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file