Debian Codegraph @

doc/lxc-ls.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
6 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
7 ]>
8
9 <refentry>
10
11 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
12
13 <refmeta>
14 <refentrytitle>lxc-ls</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-ls</refname>
20
21 <refpurpose>
22 list the containers existing on the system
23 </refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>lxc-ls</command>
29 <arg choice="opt">-1</arg>
30 <arg choice="opt">--active</arg>
31 <arg choice="opt">--frozen</arg>
32 <arg choice="opt">--running</arg>
33 <arg choice="opt">--stopped</arg>
34 <arg choice="opt">--defined</arg>
35 <arg choice="opt">-f</arg>
36 <arg choice="opt">-F <replaceable>format</replaceable></arg>
37 <arg choice="opt">-g <replaceable>groups</replaceable></arg>
38 <arg choice="opt">--nesting=<replaceable>NUM</replaceable></arg>
39 <arg choice="opt">--filter=<replaceable>regex</replaceable></arg>
40 </cmdsynopsis>
41 </refsynopsisdiv>
42
43 <refsect1>
44 <title>Description</title>
45 <para>
46 <command>lxc-ls</command> list the containers existing on the
47 system.
48 </para>
49 </refsect1>
50
51 <refsect1>
52 <title>Options</title>
53 <variablelist>
54 <varlistentry>
55 <term>
56 <option>-1</option>
57 </term>
58 <listitem>
59 <para>
60 Show one entry per line. (default when /dev/stdout isn't a tty)
61 </para>
62 </listitem>
63 </varlistentry>
64
65 <varlistentry>
66 <term>
67 <option>--active</option>
68 </term>
69 <listitem>
70 <para>
71 List only active containers (same as --frozen --running).
72 </para>
73 </listitem>
74 </varlistentry>
75
76 <varlistentry>
77 <term>
78 <option>--frozen</option>
79 </term>
80 <listitem>
81 <para>
82 List only frozen containers.
83 </para>
84 </listitem>
85 </varlistentry>
86
87 <varlistentry>
88 <term>
89 <option>--running</option>
90 </term>
91 <listitem>
92 <para>
93 List only running containers.
94 </para>
95 </listitem>
96 </varlistentry>
97
98 <varlistentry>
99 <term>
100 <option>--stopped</option>
101 </term>
102 <listitem>
103 <para>
104 List only stopped containers.
105 </para>
106 </listitem>
107 </varlistentry>
108
109 <varlistentry>
110 <term>
111 <option>--defined</option>
112 </term>
113 <listitem>
114 <para>
115 List only defined containers.
116 </para>
117 </listitem>
118 </varlistentry>
119
120 <varlistentry>
121 <term>
122 <option>-f,--fancy</option>
123 </term>
124 <listitem>
125 <para>
126 Use a fancy, column-based output.
127 </para>
128 </listitem>
129 </varlistentry>
130
131 <varlistentry>
132 <term>
133 <option>-F,--fancy-format <replaceable>format</replaceable></option>
134 </term>
135 <listitem>
136 <para>
137 Comma separated list of columns to show in the fancy output.
138 The list of accepted and default fields is listed in --help.
139 </para>
140 </listitem>
141 </varlistentry>
142
143 <varlistentry>
144 <term>
145 <option>-g,--groups <replaceable>groups</replaceable></option>
146 </term>
147 <listitem>
148 <para>
149 Comma separated list of groups the container must have to be displayed.
150 The parameter may be passed multiple times.
151 </para>
152 </listitem>
153 </varlistentry>
154
155 <varlistentry>
156 <term>
157 <option>--nesting=<replaceable>NUM</replaceable></option>
158 </term>
159 <listitem>
160 <para>
161 Show nested containers. The number of nesting levels to be shown can
162 be specified by passing a number as argument.
163 </para>
164 </listitem>
165 </varlistentry>
166
167 <varlistentry>
168 <term>
169 <option>--filter=<replaceable>regex</replaceable></option>
170 </term>
171 <listitem>
172 <para>
173 The regular expression passed to <command>lxc-ls</command> will be
174 applied to the container name. The format is a POSIX extended
175 regular expression. It can also be given as additional argument
176 without explicitly using <option>--filter</option>.
177 </para>
178 </listitem>
179 </varlistentry>
180 </variablelist>
181 </refsect1>
182
183 <refsect1>
184 <title>Examples</title>
185 <variablelist>
186 <varlistentry>
187 <term>lxc-ls --fancy</term>
188 <listitem>
189 <para>
190 list all the containers, listing one per line along with its
191 name, state, ipv4 and ipv6 addresses.
192 </para>
193 </listitem>
194 </varlistentry>
195
196 <varlistentry>
197 <term>lxc-ls --active -1</term>
198 <listitem>
199 <para>
200 list active containers and display the list in one column.
201 </para>
202 </listitem>
203 </varlistentry>
204 </variablelist>
205 </refsect1>
206
207 &commonoptions;
208
209 &seealso;
210
211 <refsect1>
212 <title>History</title>
213 Written originally as a shell script by Daniel Lezcano and Serge Hallyn.
214 Later reimplemented and extended in Python by Stéphane Graber and then
215 reimplemented and extended in C by Christian Brauner.
216 </refsect1>
217
218 </refentry>
219
220 <!-- Keep this comment at the end of the file
221 Local variables:
222 mode: sgml
223 sgml-omittag:t
224 sgml-shorttag:t
225 sgml-minimize-attributes:nil
226 sgml-always-quote-attributes:t
227 sgml-indent-step:2
228 sgml-indent-data:t
229 sgml-parent-document:nil
230 sgml-default-dtd-file:nil
231 sgml-exposed-tags:nil
232 sgml-local-catalogs:nil
233 sgml-local-ecat-files:nil
234 End:
235 -->