File: lxc-top.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 (183 lines) | stat: -rw-r--r-- 5,470 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
<!--

Copyright © 2012 Oracle.

Authors:
Dwight Engen <dwight.engen@oracle.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 seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>

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

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

  <refnamediv>
    <refname>lxc-top</refname>

    <refpurpose>
      monitor container statistics
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-top</command>
      <arg choice="opt">--help</arg>
      <arg choice="opt">--max <replaceable>count</replaceable></arg>
      <arg choice="opt">--delay <replaceable>delay</replaceable></arg>
      <arg choice="opt">--sort <replaceable>sortby</replaceable></arg>
      <arg choice="opt">--reverse</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      <command>lxc-top</command> displays container statistics. The output
      is updated every <replaceable>delay</replaceable> seconds, and is
      ordered according to the <replaceable>sortby</replaceable> value
      given. Specifying <replaceable>count</replaceable> will limit the
      number of containers displayed, otherwise <command>lxc-top</command>
      will display as many containers as can fit in your terminal.
    </para>
  </refsect1>

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

      <varlistentry>
        <term>
          <option><optional>-m, --max <replaceable>count</replaceable></optional></option>
        </term>
        <listitem>
          <para>
            Limit the number of containers displayed to
            <replaceable>count</replaceable>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option><optional>-d, --delay <replaceable>delay</replaceable></optional></option>
        </term>
        <listitem>
          <para>
            Amount of time in seconds to delay between screen updates.
            This can be specified as less than a second by giving a
            rational number, for example 0.5 for a half second delay. The
            default is 3 seconds.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option><optional>-s, --sort <replaceable>sortby</replaceable></optional></option>
        </term>
        <listitem>
          <para>
            Sort the containers by name, cpu use, or memory use. The
            <replaceable>sortby</replaceable> argument should be one of
            the letters n,c,d,m,k to sort by name, cpu use, disk I/O, memory,
            or kernel memory use respectively. The default is 'n'.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option><optional>-r, --reverse</optional></option>
        </term>
        <listitem>
          <para>
            Reverse the default sort order. By default, names sort in
            ascending alphabetical order and values sort in descending
            amounts (ie. largest value first).
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Example</title>
    <variablelist>
      <varlistentry>
        <term>lxc-top --delay 1 --sort m</term>
        <listitem>
        <para>
          Display containers, updating every second, sorted by memory use.
        </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Notes</title>
    <para>
      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-top</command> will display kernel memory use as 0. If no containers
      are being accounted, the KMem column will not be displayed. 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>
  </refsect1>

  &seealso;

  <refsect1>
    <title>Author</title>
    <para>Dwight Engen <email>dwight.engen@oracle.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:
-->