]>
Commit | Line | Data |
---|---|---|
f080ffd7 DE |
1 | <!-- |
2 | ||
3 | Copyright © 2012 Oracle. | |
4 | ||
5 | Authors: | |
6 | Dwight Engen <dwight.engen@oracle.com> | |
7 | ||
8 | This library is free software; you can redistribute it and/or | |
9 | modify it under the terms of the GNU Lesser General Public | |
10 | License as published by the Free Software Foundation; either | |
11 | version 2.1 of the License, or (at your option) any later version. | |
12 | ||
13 | This library is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | Lesser General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU Lesser General Public | |
19 | License along with this library; if not, write to the Free Software | |
250b1eec | 20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
f080ffd7 DE |
21 | |
22 | --> | |
23 | ||
7f951458 | 24 | <!DOCTYPE refentry PUBLIC @docdtd@ [ |
f080ffd7 DE |
25 | |
26 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> | |
27 | ]> | |
28 | ||
29 | <refentry> | |
30 | ||
31 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
32 | ||
33 | <refmeta> | |
34 | <refentrytitle>lxc-top</refentrytitle> | |
35 | <manvolnum>1</manvolnum> | |
36 | </refmeta> | |
37 | ||
38 | <refnamediv> | |
39 | <refname>lxc-top</refname> | |
40 | ||
41 | <refpurpose> | |
42 | monitor container statistics | |
43 | </refpurpose> | |
44 | </refnamediv> | |
45 | ||
46 | <refsynopsisdiv> | |
47 | <cmdsynopsis> | |
48 | <command>lxc-top</command> | |
49 | <arg choice="opt">--help</arg> | |
f080ffd7 DE |
50 | <arg choice="opt">--delay <replaceable>delay</replaceable></arg> |
51 | <arg choice="opt">--sort <replaceable>sortby</replaceable></arg> | |
52 | <arg choice="opt">--reverse</arg> | |
53 | </cmdsynopsis> | |
54 | </refsynopsisdiv> | |
55 | ||
56 | <refsect1> | |
57 | <title>Description</title> | |
58 | <para> | |
59 | <command>lxc-top</command> displays container statistics. The output | |
2752ecec DE |
60 | is updated every <replaceable>delay</replaceable> seconds, and is |
61 | ordered according to the <replaceable>sortby</replaceable> value | |
7dc6f6e2 DE |
62 | given. <command>lxc-top</command> will display as many containers as |
63 | can fit in your terminal. Press 'q' to quit. Press one of the sort | |
64 | key letters to sort by that statistic. Pressing a sort key letter a | |
65 | second time reverses the sort order. | |
f080ffd7 DE |
66 | </para> |
67 | </refsect1> | |
68 | ||
69 | <refsect1> | |
70 | <title>Options</title> | |
71 | <variablelist> | |
72 | ||
f080ffd7 DE |
73 | <varlistentry> |
74 | <term> | |
1bc07a5b | 75 | <option>-d, --delay <replaceable>delay</replaceable></option> |
f080ffd7 DE |
76 | </term> |
77 | <listitem> | |
78 | <para> | |
79 | Amount of time in seconds to delay between screen updates. | |
7dc6f6e2 | 80 | The default is 3 seconds. |
f080ffd7 DE |
81 | </para> |
82 | </listitem> | |
83 | </varlistentry> | |
84 | <varlistentry> | |
85 | <term> | |
1bc07a5b | 86 | <option>-s, --sort <replaceable>sortby</replaceable></option> |
f080ffd7 DE |
87 | </term> |
88 | <listitem> | |
89 | <para> | |
90 | Sort the containers by name, cpu use, or memory use. The | |
91 | <replaceable>sortby</replaceable> argument should be one of | |
7dc6f6e2 | 92 | the letters n,c,b,m,k to sort by name, cpu use, block I/O, memory, |
2752ecec | 93 | or kernel memory use respectively. The default is 'n'. |
f080ffd7 DE |
94 | </para> |
95 | </listitem> | |
96 | </varlistentry> | |
97 | <varlistentry> | |
98 | <term> | |
1bc07a5b | 99 | <option>-r, --reverse</option> |
f080ffd7 DE |
100 | </term> |
101 | <listitem> | |
102 | <para> | |
103 | Reverse the default sort order. By default, names sort in | |
104 | ascending alphabetical order and values sort in descending | |
105 | amounts (ie. largest value first). | |
106 | </para> | |
107 | </listitem> | |
108 | </varlistentry> | |
109 | </variablelist> | |
110 | </refsect1> | |
111 | ||
112 | <refsect1> | |
113 | <title>Example</title> | |
114 | <variablelist> | |
115 | <varlistentry> | |
116 | <term>lxc-top --delay 1 --sort m</term> | |
117 | <listitem> | |
118 | <para> | |
119 | Display containers, updating every second, sorted by memory use. | |
120 | </para> | |
121 | </listitem> | |
122 | </varlistentry> | |
123 | </variablelist> | |
124 | </refsect1> | |
125 | ||
2752ecec DE |
126 | <refsect1> |
127 | <title>Notes</title> | |
128 | <para> | |
129 | For performance reasons the kernel does not account kernel memory use | |
130 | unless a kernel memory limit is set. If a limit is not set, <command> | |
131 | lxc-top</command> will display kernel memory use as 0. If no containers | |
132 | are being accounted, the KMem column will not be displayed. A limit can | |
133 | be set by specifying | |
134 | <programlisting> | |
135 | lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable> | |
136 | </programlisting> | |
137 | in your container configuration file, see | |
138 | <citerefentry> | |
139 | <refentrytitle>lxc.conf</refentrytitle> | |
140 | <manvolnum>5</manvolnum> | |
141 | </citerefentry>. | |
142 | </para> | |
143 | </refsect1> | |
144 | ||
f080ffd7 DE |
145 | &seealso; |
146 | ||
147 | <refsect1> | |
148 | <title>Author</title> | |
149 | <para>Dwight Engen <email>dwight.engen@oracle.com</email></para> | |
150 | </refsect1> | |
151 | ||
152 | </refentry> | |
153 | ||
154 | <!-- Keep this comment at the end of the file | |
155 | Local variables: | |
156 | mode: sgml | |
157 | sgml-omittag:t | |
158 | sgml-shorttag:t | |
159 | sgml-minimize-attributes:nil | |
160 | sgml-always-quote-attributes:t | |
161 | sgml-indent-step:2 | |
162 | sgml-indent-data:t | |
163 | sgml-parent-document:nil | |
164 | sgml-default-dtd-file:nil | |
165 | sgml-exposed-tags:nil | |
166 | sgml-local-catalogs:nil | |
167 | sgml-local-ecat-files:nil | |
168 | End: | |
169 | --> |