doc/lxc-ls.sgml.in

   1
   2 <!--
   3
   4 lxc: linux Container library
   5
   6 (C) Copyright IBM Corp. 2007, 2008
   7
   8 Authors:
   9 Daniel Lezcano <daniel.lezcano at free.fr>
  10
  11 This library is free software; you can redistribute it and/or
  12 modify it under the terms of the GNU Lesser General Public
  13 License as published by the Free Software Foundation; either
  14 version 2.1 of the License, or (at your option) any later version.
  15
  16 This library is distributed in the hope that it will be useful,
  17 but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 Lesser General Public License for more details.
  20
  21 You should have received a copy of the GNU Lesser General Public
  22 License along with this library; if not, write to the Free Software
  23 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 -->
  26
  27 <!DOCTYPE refentry PUBLIC @docdtd@ [
  28
  29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  30 ]>
  31
  32 <refentry>
  33
  34   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  35
  36   <refmeta>
  37     <refentrytitle>lxc-ls</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-ls</refname>
  43
  44     <refpurpose>
  45       list the containers existing on the system
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-ls</command>
  52       <arg choice="opt">-1</arg>
  53       <arg choice="opt">--active</arg>
  54       <arg choice="opt">--frozen</arg>
  55       <arg choice="opt">--running</arg>
  56       <arg choice="opt">--stopped</arg>
  57       <arg choice="opt">--fancy</arg>
  58       <arg choice="opt">--fancy-format</arg>
  59       <arg choice="opt">--nesting</arg>
  60       <arg choice="opt">filter</arg>
  61     </cmdsynopsis>
  62   </refsynopsisdiv>
  63
  64   <refsect1>
  65     <title>Description</title>
  66     <para>
  67       <command>lxc-ls</command> list the containers existing on the
  68       system.
  69     </para>
  70   </refsect1>
  71
  72   <refsect1>
  73     <title>Options</title>
  74     <variablelist>
  75       <varlistentry>
  76         <term>
  77           <option><optional>-1</optional></option>
  78         </term>
  79         <listitem>
  80           <para>
  81             Show one entry per line. (default when /dev/stdout isn't a tty)
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85
  86       <varlistentry>
  87         <term>
  88           <option><optional>--active</optional></option>
  89         </term>
  90         <listitem>
  91           <para>
  92             List only active containers (same as --frozen --running).
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96
  97       <varlistentry>
  98         <term>
  99           <option><optional>--frozen</optional></option>
 100         </term>
 101         <listitem>
 102           <para>
 103             List only frozen containers.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>
 110           <option><optional>--running</optional></option>
 111         </term>
 112         <listitem>
 113           <para>
 114             List only running containers.
 115           </para>
 116         </listitem>
 117       </varlistentry>
 118
 119       <varlistentry>
 120         <term>
 121           <option><optional>--stopped</optional></option>
 122         </term>
 123         <listitem>
 124           <para>
 125             List only stopped containers.
 126           </para>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry>
 131         <term>
 132           <option><optional>--fancy</optional></option>
 133         </term>
 134         <listitem>
 135           <para>
 136             Use a fancy, column-based output.
 137           </para>
 138         </listitem>
 139       </varlistentry>
 140
 141       <varlistentry>
 142         <term>
 143           <option><optional>--fancy-format</optional></option>
 144         </term>
 145         <listitem>
 146           <para>
 147             Comma separate list of column to show in the fancy output.
 148             Valid values are: name, state, ipv4, ipv6 and pid
 149             Default is: name,state,ipv4,ipv6
 150           </para>
 151         </listitem>
 152       </varlistentry>
 153
 154       <varlistentry>
 155         <term>
 156           <option><optional>--nesting</optional></option>
 157         </term>
 158         <listitem>
 159           <para>
 160             Show nested containers.
 161           </para>
 162         </listitem>
 163       </varlistentry>
 164
 165       <varlistentry>
 166         <term>
 167           <option><optional>filter</optional></option>
 168         </term>
 169         <listitem>
 170           <para>
 171             The filter passed to <command>lxc-ls</command> will be
 172             applied to the container name. The format is a regular expression.
 173           </para>
 174         </listitem>
 175       </varlistentry>
 176     </variablelist>
 177   </refsect1>
 178
 179   <refsect1>
 180     <title>See Also</title>
 181
 182     <simpara>
 183       <citerefentry>
 184         <refentrytitle>ls</refentrytitle>
 185         <manvolnum>1</manvolnum>
 186       </citerefentry>,
 187     </simpara>
 188
 189     <title>Examples</title>
 190     <variablelist>
 191       <varlistentry>
 192         <term>lxc-ls --fancy</term>
 193         <listitem>
 194         <para>
 195           list all the containers, listing one per line along with its
 196           name, state, ipv4 and ipv6 addresses.
 197         </para>
 198         </listitem>
 199       </varlistentry>
 200
 201       <varlistentry>
 202         <term>lxc-ls --active -1</term>
 203         <listitem>
 204         <para>
 205           list active containers and display the list in one column.
 206         </para>
 207         </listitem>
 208       </varlistentry>
 209     </variablelist>
 210   </refsect1>
 211
 212   &seealso;
 213
 214   <refsect1>
 215     <title>Author</title>
 216     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 217   </refsect1>
 218 </refentry>
 219
 220 <!-- Keep this comment at the end of the file
 221 Local variables:
 222 mode: sgml
 223 sgml-omittag:t
 224 sgml-shorttag:t
 225 sgml-minimize-attributes:nil
 226 sgml-always-quote-attributes:t
 227 sgml-indent-step:2
 228 sgml-indent-data:t
 229 sgml-parent-document:nil
 230 sgml-default-dtd-file:nil
 231 sgml-exposed-tags:nil
 232 sgml-local-catalogs:nil
 233 sgml-local-ecat-files:nil
 234 End:
 235 -->