← Back to branch summary

~xnox/ubuntu/saucy/lxc/dep8

« back to all changes in this revision

Viewing changes to doc/legacy/lxc-ls.sgml.in

  • Committer: Stéphane Graber
  • Date: 2013-02-18 15:20:18 UTC
  • mto: This revision was merged to the branch mainline in revision 190.
  • Revision ID: stgraber@ubuntu.com-20130218152018-ls2gi9hkqs2kuhj8
Tags: upstream-0.9.0~alpha3
Import upstream version 0.9.0~alpha3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/legacy/lxc-ls.sgml.in
 
1
 
 
2
<!--
 
3
 
 
4
lxc: linux Container library
 
5
 
 
6
(C) Copyright IBM Corp. 2007, 2008
 
7
 
 
8
Authors:
 
9
Daniel Lezcano <dlezcano at fr.ibm.com>
 
10
 
 
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.
 
15
 
 
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.
 
20
 
 
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
 
24
 
 
25
-->
 
26
 
 
27
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
28
 
 
29
<!ENTITY seealso SYSTEM "@builddir@/../see_also.sgml">
 
30
]>
 
31
 
 
32
<refentry>
 
33
 
 
34
  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
 
35
 
 
36
  <refmeta>
 
37
    <refentrytitle>lxc-ls</refentrytitle>
 
38
    <manvolnum>1</manvolnum>
 
39
  </refmeta>
 
40
 
 
41
  <refnamediv>
 
42
    <refname>lxc-ls</refname>
 
43
 
 
44
    <refpurpose>
 
45
      list the containers existing on the system
 
46
    </refpurpose>
 
47
  </refnamediv>
 
48
 
 
49
  <refsynopsisdiv>
 
50
    <cmdsynopsis>
 
51
      <command>lxc-ls</command>
 
52
      <arg choice="opt">--active</arg>
 
53
      <arg choice="opt">ls option</arg>
 
54
    </cmdsynopsis>
 
55
  </refsynopsisdiv>
 
56
 
 
57
  <refsect1>
 
58
    <title>Description</title>
 
59
    <para>
 
60
      <command>lxc-ls</command> list the containers existing on the
 
61
      system.
 
62
    </para>
 
63
  </refsect1>
 
64
 
 
65
  <refsect1>
 
66
    <title>Options</title>
 
67
    <variablelist>
 
68
 
 
69
      <varlistentry>
 
70
        <term>
 
71
          <option><optional>--active</optional></option>
 
72
        </term>
 
73
        <listitem>
 
74
          <para>
 
75
            List active containers.
 
76
          </para>
 
77
        </listitem>
 
78
      </varlistentry>
 
79
 
 
80
      <varlistentry>
 
81
        <term>
 
82
          <option><optional>ls options</optional></option>
 
83
        </term>
 
84
        <listitem>
 
85
          <para>
 
86
            The option passed to <command>lxc-ls</command> are the
 
87
            same as the <command>ls</command> command.
 
88
          </para>
 
89
        </listitem>
 
90
      </varlistentry>
 
91
 
 
92
    </variablelist>
 
93
 
 
94
  </refsect1>
 
95
 
 
96
  <refsect1>
 
97
    <title>Examples</title>
 
98
    <variablelist>
 
99
      <varlistentry>
 
100
        <term>lxc-ls -l</term>
 
101
        <listitem>
 
102
        <para>
 
103
          list all the container and their permissions.
 
104
        </para>
 
105
        </listitem>
 
106
      </varlistentry>
 
107
 
 
108
      <varlistentry>
 
109
        <term>lxc-ls --active -1</term>
 
110
        <listitem>
 
111
        <para>
 
112
          list active containers and display the list in one column.
 
113
        </para>
 
114
        </listitem>
 
115
      </varlistentry>
 
116
 
 
117
    </variablelist>
 
118
  </refsect1>
 
119
 
 
120
  <refsect1>
 
121
    <title>See Also</title>
 
122
 
 
123
    <simpara>
 
124
      <citerefentry>
 
125
        <refentrytitle>ls</refentrytitle>
 
126
        <manvolnum>1</manvolnum>
 
127
      </citerefentry>,
 
128
    </simpara>
 
129
 
 
130
  </refsect1>
 
131
 
 
132
  &seealso;
 
133
 
 
134
  <refsect1>
 
135
    <title>Author</title>
 
136
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 
137
  </refsect1>
 
138
 
 
139
</refentry>
 
140
 
 
141
<!-- Keep this comment at the end of the file
 
142
Local variables:
 
143
mode: sgml
 
144
sgml-omittag:t
 
145
sgml-shorttag:t
 
146
sgml-minimize-attributes:nil
 
147
sgml-always-quote-attributes:t
 
148
sgml-indent-step:2
 
149
sgml-indent-data:t
 
150
sgml-parent-document:nil
 
151
sgml-default-dtd-file:nil
 
152
sgml-exposed-tags:nil
 
153
sgml-local-catalogs:nil
 
154
sgml-local-ecat-files:nil
 
155
End:
 
156
-->