File: lxc-info.sgml.in

package info (click to toggle)
lxc 1%3A1.0.6-6
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 4,800 kB
  • sloc: ansic: 33,735; sh: 11,868; python: 1,223; makefile: 734
file content (212 lines) | stat: -rw-r--r-- 5,542 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
<!--

(C) Copyright Canonical Ltd. 2013

Authors:
St├ęphane Graber <stgraber@ubuntu.com>

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 commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>

  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

  <refmeta>
    <refentrytitle>lxc-info</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>lxc-info</refname>

    <refpurpose>
      query information about a container
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-info</command>
      <arg choice="req">-n <replaceable>name</replaceable></arg>
      <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
      <arg choice="opt">-s</arg>
      <arg choice="opt">-p</arg>
      <arg choice="opt">-i</arg>
      <arg choice="opt">-S</arg>
      <arg choice="opt">-H</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      <command>lxc-info</command> queries and shows information about a
      container.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>

      <varlistentry>
        <term>
          <option><optional>-c <replaceable>KEY</replaceable></optional></option>
        </term>
        <listitem>
          <para>
            Print a configuration key from the container. This option
            may be given mulitple times to print out multiple key = value pairs.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-s</optional></option>
        </term>
        <listitem>
          <para>
            Just print the container's state.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-p</optional></option>
        </term>
        <listitem>
          <para>
            Just print the container's pid.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-i</optional></option>
        </term>
        <listitem>
          <para>
            Just print the container's IP addresses.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-S</optional></option>
        </term>
        <listitem>
          <para>
            Just print the container's statistics.
            Note that for performance reasons the kernel does not account
            kernel memory use unless a kernel memory limit is set. If a limit
            is not set, <command>lxc-info</command> will display kernel memory
            use as 0. A limit can be set by specifying
            <programlisting>
            lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable>
            </programlisting>
            in your container configuration file, see
            <citerefentry>
              <refentrytitle>lxc.conf</refentrytitle>
              <manvolnum>5</manvolnum>
            </citerefentry>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-H</optional></option>
        </term>
        <listitem>
          <para>
            Print the container's statistics in raw, non-humanized form. The
            default is to print statistics in humanized form.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  &commonoptions;

  <refsect1>
    <title>Examples</title>
    <variablelist>
      <varlistentry>
        <term>lxc-info -n foo</term>
        <listitem>
          <para>
            Show information for foo.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>lxc-info -n 'ubuntu.*'</term>
        <listitem>
          <para>
            Show information for all containers whose name starts with ubuntu.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>lxc-info -n foo -c lxc.network.0.veth.pair</term>
        <listitem>
          <para>
            prints the veth pair name of foo.
          </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:
-->