lxc-ls.sgml.in revision 0e21ea4b15b1f1a066da54aed04f4fcac45d5741
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanolxc: linux Container library
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano(C) Copyright IBM Corp. 2007, 2008
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoDaniel Lezcano <dlezcano at fr.ibm.com>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoThis library is free software; you can redistribute it and/or
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanomodify it under the terms of the GNU Lesser General Public
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLicense as published by the Free Software Foundation; either
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoversion 2.1 of the License, or (at your option) any later version.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoThis library is distributed in the hope that it will be useful,
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanobut WITHOUT ANY WARRANTY; without even the implied warranty of
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLesser General Public License for more details.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoYou should have received a copy of the GNU Lesser General Public
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLicense along with this library; if not, write to the Free Software
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoFoundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
aa8d013ec5b09cd1cd904173d6234ef126eb2126Peter Simons<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refentrytitle>lxc-ls</refentrytitle>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <manvolnum>1</manvolnum>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refnamediv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refname>lxc-ls</refname>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refpurpose>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano list the containers existing on the system
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refpurpose>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refnamediv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refsynopsisdiv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <cmdsynopsis>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <command>lxc-ls</command>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <arg choice="opt">-1</arg>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="opt">--active</arg>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <arg choice="opt">--frozen</arg>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <arg choice="opt">--running</arg>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <arg choice="opt">--stopped</arg>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <arg choice="opt">--fancy</arg>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <arg choice="opt">--fancy-format</arg>
0e21ea4b15b1f1a066da54aed04f4fcac45d5741Stéphane Graber <arg choice="opt">--nesting</arg>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <arg choice="opt">filter</arg>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </cmdsynopsis>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsynopsisdiv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <title>Description</title>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <command>lxc-ls</command> list the containers existing on the
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <title>Options</title>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <variablelist>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>-1</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber Show one entry per line. (default when /dev/stdout isn't a tty)
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber </varlistentry>
7ef0141356454503ab81460290b5dffa32c1f441David Ward <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>--active</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber List only active containers (same as --frozen --running).
7ef0141356454503ab81460290b5dffa32c1f441David Ward </varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>--frozen</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber List only frozen containers.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>--running</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber List only running containers.
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber </varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>--stopped</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber List only stopped containers.
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber </varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>--fancy</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber Use a fancy, column-based output.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>--fancy-format</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber Comma separate list of column to show in the fancy output.
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber Valid values are: name, state, ipv4, ipv6 and pid
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber Default is: name,state,ipv4,ipv6
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </varlistentry>
0e21ea4b15b1f1a066da54aed04f4fcac45d5741Stéphane Graber <varlistentry>
0e21ea4b15b1f1a066da54aed04f4fcac45d5741Stéphane Graber <option><optional>--nesting</optional></option>
0e21ea4b15b1f1a066da54aed04f4fcac45d5741Stéphane Graber Show nested containers.
0e21ea4b15b1f1a066da54aed04f4fcac45d5741Stéphane Graber </varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <option><optional>filter</optional></option>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber The filter passed to <command>lxc-ls</command> will be
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber applied to the container name. The format is a regular expression.
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber </varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </variablelist>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <title>See Also</title>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <citerefentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <refentrytitle>ls</refentrytitle>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <manvolnum>1</manvolnum>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </citerefentry>,
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <title>Examples</title>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <variablelist>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <term>lxc-ls --fancy</term>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber list all the containers, listing one per line along with its
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber name, state, ipv4 and ipv6 addresses.
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber </varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <term>lxc-ls --active -1</term>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber list active containers and display the list in one column.
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber </varlistentry>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber </variablelist>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <title>Author</title>
4e7186c53554cdbf4b4b85568daf84740c120505Stéphane Graber <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano<!-- Keep this comment at the end of the file
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLocal variables:
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-omittag:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-shorttag:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-minimize-attributes:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-always-quote-attributes:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-indent-step:2
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-indent-data:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-parent-document:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-default-dtd-file:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-exposed-tags:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-local-catalogs:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-local-ecat-files:nil