ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase<!--

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehaselxc: linux Container library

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase(C) Copyright IBM Corp. 2007, 2008

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase

3856b7bdf70cec553e0ca01ca823c7fc555a06f0Tim ReddehaseAuthors:

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim ReddehaseDaniel Lezcano <daniel.lezcano at free.fr>

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim ReddehaseThis library is free software; you can redistribute it and/or

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehasemodify it under the terms of the GNU Lesser General Public

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim ReddehaseLicense as published by the Free Software Foundation; either

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehaseversion 2.1 of the License, or (at your option) any later version.

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase

3856b7bdf70cec553e0ca01ca823c7fc555a06f0Tim ReddehaseThis library is distributed in the hope that it will be useful,

dd0506cc85faf35143d88d3547a5f432e812128bTim Reddehasebut WITHOUT ANY WARRANTY; without even the implied warranty of

3856b7bdf70cec553e0ca01ca823c7fc555a06f0Tim ReddehaseMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim ReddehaseLesser General Public License for more details.

ddcf1a7ed9d595e97418e9bc607184006e57d606Tim Reddehase

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

-->

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">

]>

<refentry>

<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

<refmeta>

<refentrytitle>lxc-ls</refentrytitle>

<manvolnum>1</manvolnum>

</refmeta>

<refnamediv>

<refname>lxc-ls</refname>

<refpurpose>

list the containers existing on the system

</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>lxc-ls</command>

<arg choice="opt">-1</arg>

<arg choice="opt">--active</arg>

<arg choice="opt">--frozen</arg>

<arg choice="opt">--running</arg>

<arg choice="opt">--stopped</arg>

<arg choice="opt">--fancy</arg>

<arg choice="opt">--fancy-format</arg>

<arg choice="opt">--nesting</arg>

<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>

<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:

-->