File: lxc-ls.sgml.in

package info (click to toggle)
lxc 1%3A1.0.6-6%2Bdeb8u2~bpo70%2B1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy-backports
  • size: 5,280 kB
  • sloc: ansic: 33,888; sh: 11,928; python: 1,223; makefile: 735
file content (225 lines) | stat: -rw-r--r-- 5,582 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225

<!--

lxc: linux Container library

(C) Copyright IBM Corp. 2007, 2008

Authors:
Daniel Lezcano <daniel.lezcano at free.fr>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [

<!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">-f</arg>
      <arg choice="opt">-F <replaceable>format</replaceable></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>-f, --fancy</optional></option>
        </term>
        <listitem>
          <para>
            Use a fancy, column-based output.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-F, --fancy-format <replaceable>format</replaceable></optional></option>
        </term>
        <listitem>
          <para>
            Comma separated list of column to show in the fancy output.
            The list of accepted and default fields is listed in --help.
          </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>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:
-->