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">-f</arg>
  58       <arg choice="opt">-F <replaceable>format</replaceable></arg>
  59       <arg choice="opt">-g <replaceable>groups</replaceable></arg>
  60       <arg choice="opt">--nesting</arg>
  61       <arg choice="opt">filter</arg>
  62     </cmdsynopsis>
  63   </refsynopsisdiv>
  64
  65   <refsect1>
  66     <title>Description</title>
  67     <para>
  68       <command>lxc-ls</command> list the containers existing on the
  69       system.
  70     </para>
  71   </refsect1>
  72
  73   <refsect1>
  74     <title>Options</title>
  75     <variablelist>
  76       <varlistentry>
  77         <term>
  78           <option><optional>-1</optional></option>
  79         </term>
  80         <listitem>
  81           <para>
  82             Show one entry per line. (default when /dev/stdout isn't a tty)
  83           </para>
  84         </listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term>
  89           <option><optional>--active</optional></option>
  90         </term>
  91         <listitem>
  92           <para>
  93             List only active containers (same as --frozen --running).
  94           </para>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term>
 100           <option><optional>--frozen</optional></option>
 101         </term>
 102         <listitem>
 103           <para>
 104             List only frozen containers.
 105           </para>
 106         </listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110         <term>
 111           <option><optional>--running</optional></option>
 112         </term>
 113         <listitem>
 114           <para>
 115             List only running containers.
 116           </para>
 117         </listitem>
 118       </varlistentry>
 119
 120       <varlistentry>
 121         <term>
 122           <option><optional>--stopped</optional></option>
 123         </term>
 124         <listitem>
 125           <para>
 126             List only stopped containers.
 127           </para>
 128         </listitem>
 129       </varlistentry>
 130
 131       <varlistentry>
 132         <term>
 133           <option><optional>-f, --fancy</optional></option>
 134         </term>
 135         <listitem>
 136           <para>
 137             Use a fancy, column-based output.
 138           </para>
 139         </listitem>
 140       </varlistentry>
 141
 142       <varlistentry>
 143         <term>
 144           <option><optional>-F, --fancy-format <replaceable>format</replaceable></optional></option>
 145         </term>
 146         <listitem>
 147           <para>
 148             Comma separated list of column to show in the fancy output.
 149             The list of accepted and default fields is listed in --help.
 150           </para>
 151         </listitem>
 152       </varlistentry>
 153
 154       <varlistentry>
 155         <term>
 156           <option><optional>-g, --groups <replaceable>groups</replaceable></optional></option>
 157         </term>
 158         <listitem>
 159           <para>
 160             Comma separated list of groups the container must have to be displayed.
 161             The parameter may be passed multiple times.
 162           </para>
 163         </listitem>
 164       </varlistentry>
 165
 166       <varlistentry>
 167         <term>
 168           <option><optional>--nesting</optional></option>
 169         </term>
 170         <listitem>
 171           <para>
 172             Show nested containers.
 173           </para>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry>
 178         <term>
 179           <option><optional>filter</optional></option>
 180         </term>
 181         <listitem>
 182           <para>
 183             The filter passed to <command>lxc-ls</command> will be
 184             applied to the container name. The format is a regular expression.
 185           </para>
 186         </listitem>
 187       </varlistentry>
 188     </variablelist>
 189   </refsect1>
 190
 191   <refsect1>
 192     <title>Examples</title>
 193     <variablelist>
 194       <varlistentry>
 195         <term>lxc-ls --fancy</term>
 196         <listitem>
 197         <para>
 198           list all the containers, listing one per line along with its
 199           name, state, ipv4 and ipv6 addresses.
 200         </para>
 201         </listitem>
 202       </varlistentry>
 203
 204       <varlistentry>
 205         <term>lxc-ls --active -1</term>
 206         <listitem>
 207         <para>
 208           list active containers and display the list in one column.
 209         </para>
 210         </listitem>
 211       </varlistentry>
 212     </variablelist>
 213   </refsect1>
 214
 215   &seealso;
 216
 217   <refsect1>
 218     <title>Author</title>
 219     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 220   </refsect1>
 221 </refentry>
 222
 223 <!-- Keep this comment at the end of the file
 224 Local variables:
 225 mode: sgml
 226 sgml-omittag:t
 227 sgml-shorttag:t
 228 sgml-minimize-attributes:nil
 229 sgml-always-quote-attributes:t
 230 sgml-indent-step:2
 231 sgml-indent-data:t
 232 sgml-parent-document:nil
 233 sgml-default-dtd-file:nil
 234 sgml-exposed-tags:nil
 235 sgml-local-catalogs:nil
 236 sgml-local-ecat-files:nil
 237 End:
 238 -->