lxc-ls.sgml.in revision 6f63931122721208aa8e4fe11ef01543b4b3693b
0N/A
0N/A<!--
0N/A
0N/Alxc: linux Container library
0N/A
0N/A(C) Copyright IBM Corp. 2007, 2008
0N/A
0N/AAuthors:
0N/ADaniel Lezcano <daniel.lezcano at free.fr>
0N/A
0N/AThis library is free software; you can redistribute it and/or
0N/Amodify it under the terms of the GNU Lesser General Public
0N/ALicense as published by the Free Software Foundation; either
0N/Aversion 2.1 of the License, or (at your option) any later version.
0N/A
0N/AThis library is distributed in the hope that it will be useful,
0N/Abut WITHOUT ANY WARRANTY; without even the implied warranty of
0N/AMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0N/ALesser General Public License for more details.
0N/A
0N/AYou should have received a copy of the GNU Lesser General Public
0N/ALicense along with this library; if not, write to the Free Software
0N/AFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
0N/A
0N/A-->
0N/A
0N/A<!DOCTYPE refentry PUBLIC @docdtd@ [
0N/A
0N/A<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
0N/A]>
0N/A
0N/A<refentry>
0N/A
0N/A <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
0N/A
0N/A <refmeta>
0N/A <refentrytitle>lxc-ls</refentrytitle>
0N/A <manvolnum>1</manvolnum>
0N/A </refmeta>
0N/A
0N/A <refnamediv>
0N/A <refname>lxc-ls</refname>
0N/A
0N/A <refpurpose>
0N/A list the containers existing on the system
0N/A </refpurpose>
0N/A </refnamediv>
0N/A
0N/A <refsynopsisdiv>
0N/A <cmdsynopsis>
0N/A <command>lxc-ls</command>
0N/A <arg choice="opt">-1</arg>
0N/A <arg choice="opt">--active</arg>
0N/A <arg choice="opt">--frozen</arg>
0N/A <arg choice="opt">--running</arg>
0N/A <arg choice="opt">--stopped</arg>
0N/A <arg choice="opt">--fancy</arg>
0N/A <arg choice="opt">--fancy-format</arg>
0N/A <arg choice="opt">--nesting</arg>
0N/A <arg choice="opt">filter</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>lxc-ls</command> list the containers existing on the
system.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option><optional>-1</optional></option>
</term>
<listitem>
<para>
Show one entry per line. (default when /dev/stdout isn't a tty)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>--active</optional></option>
</term>
<listitem>
<para>
List only active containers (same as --frozen --running).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>--frozen</optional></option>
</term>
<listitem>
<para>
List only frozen containers.
</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>--fancy</optional></option>
</term>
<listitem>
<para>
Use a fancy, column-based output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><optional>--fancy-format</optional></option>
</term>
<listitem>
<para>
Comma separate list of column to show in the fancy output.
Valid values are: name, state, ipv4, ipv6 and pid
Default is: name,state,ipv4,ipv6
</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>See Also</title>
<simpara>
<citerefentry>
<refentrytitle>ls</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
</simpara>
</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:
-->