lxc-top.sgml.in revision 2752ecec3232c231469a2ad8513a5527fef66fd6
b94d7d4b3d3472197238271e200468b55c5e6102henning mueller<!--
3b378eef3a571df8cc27122e08f5106170cd3643henning mueller
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerCopyright © 2012 Oracle.
3b378eef3a571df8cc27122e08f5106170cd3643henning mueller
0dda23492d6edbe1392af2e3267ef7e2648a641cTim ReddehaseAuthors:
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerDwight Engen <dwight.engen@oracle.com>
3b378eef3a571df8cc27122e08f5106170cd3643henning mueller
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerThis library is free software; you can redistribute it and/or
3b378eef3a571df8cc27122e08f5106170cd3643henning muellermodify it under the terms of the GNU Lesser General Public
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerLicense as published by the Free Software Foundation; either
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerversion 2.1 of the License, or (at your option) any later version.
ee5342a8882c2fc7631fcffb5497e6597747887cTim Reddehase
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerThis library is distributed in the hope that it will be useful,
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerbut WITHOUT ANY WARRANTY; without even the implied warranty of
3b378eef3a571df8cc27122e08f5106170cd3643henning muellerMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen KuksaLesser General Public License for more details.
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen KuksaYou should have received a copy of the GNU Lesser General Public
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen KuksaLicense along with this library; if not, write to the Free Software
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen KuksaFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa-->
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa<!DOCTYPE refentry PUBLIC @docdtd@ [
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa]>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa<refentry>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <refmeta>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <refentrytitle>lxc-top</refentrytitle>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <manvolnum>1</manvolnum>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa </refmeta>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <refnamediv>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <refname>lxc-top</refname>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <refpurpose>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa monitor container statistics
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa </refpurpose>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa </refnamediv>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <refsynopsisdiv>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <cmdsynopsis>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <command>lxc-top</command>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <arg choice="opt">--help</arg>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <arg choice="opt">--max <replaceable>count</replaceable></arg>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <arg choice="opt">--delay <replaceable>delay</replaceable></arg>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <arg choice="opt">--sort <replaceable>sortby</replaceable></arg>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <arg choice="opt">--reverse</arg>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa </cmdsynopsis>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa </refsynopsisdiv>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <refsect1>
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa <title>Description</title>
075e8216f719a593d9111ce303e5028bcb0400faEugen Kuksa <para>
075e8216f719a593d9111ce303e5028bcb0400faEugen Kuksa <command>lxc-top</command> displays container statistics. The output
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa is updated every <replaceable>delay</replaceable> seconds, and is
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa ordered according to the <replaceable>sortby</replaceable> value
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa given. Specifying <replaceable>count</replaceable> will limit the
b299dbef5e70f4f78937112b19370a4d5d0e04e3Eugen Kuksa number of containers displayed, otherwise <command>lxc-top</command>
b94d7d4b3d3472197238271e200468b55c5e6102henning mueller 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:
-->