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