4 lxc: linux Container library
6 (C) Copyright IBM Corp. 2007, 2008
9 Daniel Lezcano <dlezcano at fr.ibm.com>
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.
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.
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
27 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
34 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
37 <refentrytitle>lxc-ls</refentrytitle>
38 <manvolnum>1</manvolnum>
42 <refname>lxc-ls</refname>
45 list the containers existing on the system
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>
64 <title>Description</title>
66 <command>lxc-ls</command> list the containers existing on the
72 <title>Options</title>
76 <option><optional>-1</optional></option>
80 Show one entry per line. (default when /dev/stdout isn't a tty)
87 <option><optional>--active</optional></option>
91 List only active containers (same as --frozen --running).
98 <option><optional>--frozen</optional></option>
102 List only frozen containers.
109 <option><optional>--running</optional></option>
113 List only running containers.
120 <option><optional>--stopped</optional></option>
124 List only stopped containers.
131 <option><optional>--fancy</optional></option>
135 Use a fancy, column-based output.
142 <option><optional>--fancy-format</optional></option>
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
155 <option><optional>filter</optional></option>
159 The filter passed to <command>lxc-ls</command> will be
160 applied to the container name. The format is a regular expression.
168 <title>See Also</title>
172 <refentrytitle>ls</refentrytitle>
173 <manvolnum>1</manvolnum>
177 <title>Examples</title>
180 <term>lxc-ls --fancy</term>
183 list all the containers, listing one per line along with its
184 name, state, ipv4 and ipv6 addresses.
190 <term>lxc-ls --active -1</term>
193 list active containers and display the list in one column.
201 <title>Author</title>
202 <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
206 <!-- Keep this comment at the end of the file
211 sgml-minimize-attributes:nil
212 sgml-always-quote-attributes: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