4 lxc: linux Container library
6 (C) Copyright IBM Corp. 2007, 2008
9 Daniel Lezcano <daniel.lezcano at free.fr>
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 <!DOCTYPE refentry PUBLIC @docdtd@ [
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">-P <replaceable>lxcpath</replaceable></arg>
54 <arg choice="opt">--active</arg>
55 <arg choice="opt">--frozen</arg>
56 <arg choice="opt">--running</arg>
57 <arg choice="opt">--stopped</arg>
58 <arg choice="opt">-f</arg>
59 <arg choice="opt">-F <replaceable>format</replaceable></arg>
60 <arg choice="opt">-g <replaceable>groups</replaceable></arg>
61 <arg choice="opt">--nesting</arg>
62 <arg choice="opt">filter</arg>
63 <arg choice="opt">--version</arg>
68 <title>Description</title>
70 <command>lxc-ls</command> list the containers existing on the
76 <title>Options</title>
84 Show one entry per line. (default when /dev/stdout isn't a tty)
91 <option>-P, --lxcpath</option>
95 Use an alternate container path. The default is @LXCPATH@.
102 <option>--active</option>
106 List only active containers (same as --frozen --running).
113 <option>--frozen</option>
117 List only frozen containers.
124 <option>--running</option>
128 List only running containers.
135 <option>--stopped</option>
139 List only stopped containers.
146 <option>-f, --fancy</option>
150 Use a fancy, column-based output.
157 <option>-F, --fancy-format <replaceable>format</replaceable></option>
161 Comma separated list of column to show in the fancy output.
162 The list of accepted and default fields is listed in --help.
169 <option>-g, --groups <replaceable>groups</replaceable></option>
173 Comma separated list of groups the container must have to be displayed.
174 The parameter may be passed multiple times.
181 <option>--nesting</option>
185 Show nested containers.
192 <option>filter</option>
196 The filter passed to <command>lxc-ls</command> will be
197 applied to the container name. The format is a regular expression.
204 <option>--version</option>
208 Show the version number.
216 <title>Examples</title>
219 <term>lxc-ls --fancy</term>
222 list all the containers, listing one per line along with its
223 name, state, ipv4 and ipv6 addresses.
229 <term>lxc-ls --active -1</term>
232 list active containers and display the list in one column.
242 <title>Author</title>
243 <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
247 <!-- Keep this comment at the end of the file
252 sgml-minimize-attributes:nil
253 sgml-always-quote-attributes:t
256 sgml-parent-document:nil
257 sgml-default-dtd-file:nil
258 sgml-exposed-tags:nil
259 sgml-local-catalogs:nil
260 sgml-local-ecat-files:nil