lxc-ls.sgml.in revision 860490af5db945c37e9e6e24c019899fbe739dc5
70N/A
70N/A<!--
286N/A
70N/Alxc: linux Container library
70N/A
70N/A(C) Copyright IBM Corp. 2007, 2008
70N/A
70N/AAuthors:
70N/ADaniel Lezcano <daniel.lezcano at free.fr>
70N/A
70N/AThis library is free software; you can redistribute it and/or
70N/Amodify it under the terms of the GNU Lesser General Public
70N/ALicense as published by the Free Software Foundation; either
70N/Aversion 2.1 of the License, or (at your option) any later version.
70N/A
70N/AThis library is distributed in the hope that it will be useful,
70N/Abut WITHOUT ANY WARRANTY; without even the implied warranty of
70N/AMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
70N/ALesser General Public License for more details.
70N/A
70N/AYou should have received a copy of the GNU Lesser General Public
70N/ALicense along with this library; if not, write to the Free Software
70N/AFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
70N/A
70N/A-->
70N/A
70N/A<!DOCTYPE refentry PUBLIC @docdtd@ [
70N/A
70N/A<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
70N/A]>
326N/A
70N/A<refentry>
70N/A
70N/A <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
98N/A
321N/A <refmeta>
321N/A <refentrytitle>lxc-ls</refentrytitle>
213N/A <manvolnum>1</manvolnum>
304N/A </refmeta>
325N/A
320N/A <refnamediv>
231N/A <refname>lxc-ls</refname>
98N/A
324N/A <refpurpose>
310N/A list the containers existing on the system
316N/A </refpurpose>
290N/A </refnamediv>
304N/A
321N/A <refsynopsisdiv>
309N/A <cmdsynopsis>
210N/A <command>lxc-ls</command>
128N/A <arg choice="opt">-1</arg>
326N/A <arg choice="opt">--active</arg>
70N/A <arg choice="opt">--frozen</arg>
294N/A <arg choice="opt">--running</arg>
98N/A <arg choice="opt">--stopped</arg>
277N/A <arg choice="opt">-f</arg>
289N/A <arg choice="opt">-F <replaceable>format</replaceable></arg>
326N/A <arg choice="opt">--nesting</arg>
290N/A <arg choice="opt">filter</arg>
286N/A </cmdsynopsis>
90N/A </refsynopsisdiv>
295N/A
70N/A <refsect1>
299N/A <title>Description</title>
262N/A <para>
277N/A <command>lxc-ls</command> list the containers existing on the
280N/A system.
309N/A </para>
70N/A </refsect1>
70N/A
319N/A <refsect1>
280N/A <title>Options</title>
319N/A <variablelist>
70N/A <varlistentry>
70N/A <term>
98N/A <option><optional>-1</optional></option>
98N/A </term>
231N/A <listitem>
98N/A <para>
156N/A Show one entry per line. (default when /dev/stdout isn't a tty)
156N/A </para>
98N/A </listitem>
70N/A </varlistentry>
70N/A
70N/A <varlistentry>
70N/A <term>
70N/A <option><optional>--active</optional></option>
70N/A </term>
70N/A <listitem>
70N/A <para>
70N/A List only active containers (same as --frozen --running).
70N/A </para>
70N/A </listitem>
70N/A </varlistentry>
70N/A
70N/A <varlistentry>
70N/A <term>
70N/A <option><optional>--frozen</optional></option>
70N/A </term>
70N/A <listitem>
253N/A <para>
70N/A List only frozen containers.
70N/A </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>--running</optional></option>
</term>
<listitem>
<para>
List only running containers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>--stopped</optional></option>
</term>
<listitem>
<para>
List only stopped containers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>-f, --fancy</optional></option>
</term>
<listitem>
<para>
Use a fancy, column-based output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>-F, --fancy-format <replaceable>format</replaceable></optional></option>
</term>
<listitem>
<para>
Comma separate list of column 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>
</term>
<listitem>
<para>
Show nested containers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>filter</optional></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.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<variablelist>
<varlistentry>
<term>lxc-ls --fancy</term>
<listitem>
<para>
list all the containers, listing one per line along with its
name, state, ipv4 and ipv6 addresses.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>lxc-ls --active -1</term>
<listitem>
<para>
list active containers and display the list in one column.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
&seealso;
<refsect1>
<title>Author</title>
<para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->