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 <dlezcano at fr.ibm.com>
  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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  24
  25 -->
  26
  27 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  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">filter</arg>
  60     </cmdsynopsis>
  61   </refsynopsisdiv>
  62
  63   <refsect1>
  64     <title>Description</title>
  65     <para>
  66       <command>lxc-ls</command> list the containers existing on the
  67       system.
  68     </para>
  69   </refsect1>
  70
  71   <refsect1>
  72     <title>Options</title>
  73     <variablelist>
  74       <varlistentry>
  75         <term>
  76           <option><optional>-1</optional></option>
  77         </term>
  78         <listitem>
  79           <para>
  80             Show one entry per line. (default when /dev/stdout isn't a tty)
  81           </para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term>
  87           <option><optional>--active</optional></option>
  88         </term>
  89         <listitem>
  90           <para>
  91             List only active containers (same as --frozen --running).
  92           </para>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term>
  98           <option><optional>--frozen</optional></option>
  99         </term>
 100         <listitem>
 101           <para>
 102             List only frozen containers.
 103           </para>
 104         </listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term>
 109           <option><optional>--running</optional></option>
 110         </term>
 111         <listitem>
 112           <para>
 113             List only running containers.
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117
 118       <varlistentry>
 119         <term>
 120           <option><optional>--stopped</optional></option>
 121         </term>
 122         <listitem>
 123           <para>
 124             List only stopped containers.
 125           </para>
 126         </listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term>
 131           <option><optional>--fancy</optional></option>
 132         </term>
 133         <listitem>
 134           <para>
 135             Use a fancy, column-based output.
 136           </para>
 137         </listitem>
 138       </varlistentry>
 139
 140       <varlistentry>
 141         <term>
 142           <option><optional>--fancy-format</optional></option>
 143         </term>
 144         <listitem>
 145           <para>
 146             Comma separate list of column to show in the fancy output.
 147             Valid values are: name, state, ipv4, ipv6 and pid
 148             Default is: name,state,ipv4,ipv6
 149           </para>
 150         </listitem>
 151       </varlistentry>
 152
 153       <varlistentry>
 154         <term>
 155           <option><optional>filter</optional></option>
 156         </term>
 157         <listitem>
 158           <para>
 159             The filter passed to <command>lxc-ls</command> will be
 160             applied to the container name. The format is a regular expression.
 161           </para>
 162         </listitem>
 163       </varlistentry>
 164     </variablelist>
 165   </refsect1>
 166
 167   <refsect1>
 168     <title>See Also</title>
 169
 170     <simpara>
 171       <citerefentry>
 172         <refentrytitle>ls</refentrytitle>
 173         <manvolnum>1</manvolnum>
 174       </citerefentry>,
 175     </simpara>
 176
 177     <title>Examples</title>
 178     <variablelist>
 179       <varlistentry>
 180         <term>lxc-ls --fancy</term>
 181         <listitem>
 182         <para>
 183           list all the containers, listing one per line along with its
 184           name, state, ipv4 and ipv6 addresses.
 185         </para>
 186         </listitem>
 187       </varlistentry>
 188
 189       <varlistentry>
 190         <term>lxc-ls --active -1</term>
 191         <listitem>
 192         <para>
 193           list active containers and display the list in one column.
 194         </para>
 195         </listitem>
 196       </varlistentry>
 197     </variablelist>
 198   </refsect1>
 199
 200   <refsect1>
 201     <title>Author</title>
 202     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 203   </refsect1>
 204 </refentry>
 205
 206 <!-- Keep this comment at the end of the file
 207 Local variables:
 208 mode: sgml
 209 sgml-omittag:t
 210 sgml-shorttag:t
 211 sgml-minimize-attributes:nil
 212 sgml-always-quote-attributes:t
 213 sgml-indent-step:2
 214 sgml-indent-data:t
 215 sgml-parent-document:nil
 216 sgml-default-dtd-file:nil
 217 sgml-exposed-tags:nil
 218 sgml-local-catalogs:nil
 219 sgml-local-ecat-files:nil
 220 End:
 221 -->