doc/lxc-top.sgml.in

   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
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21
  22 -->
  23
  24 <!DOCTYPE refentry PUBLIC @docdtd@ [
  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>
  50       <arg choice="opt">--max <replaceable>count</replaceable></arg>
  51       <arg choice="opt">--delay <replaceable>delay</replaceable></arg>
  52       <arg choice="opt">--sort <replaceable>sortby</replaceable></arg>
  53       <arg choice="opt">--reverse</arg>
  54     </cmdsynopsis>
  55   </refsynopsisdiv>
  56
  57   <refsect1>
  58     <title>Description</title>
  59     <para>
  60       <command>lxc-top</command> displays container statistics. The output
  61         is updated every <replaceable>delay</replaceable> seconds, and is
  62         ordered according to the <replaceable>sortby</replaceable> value
  63         given. Specifying <replaceable>count</replaceable> will limit the
  64         number of containers displayed, otherwise <command>lxc-top</command>
  65         will display as many containers as can fit in your terminal.
  66     </para>
  67   </refsect1>
  68
  69   <refsect1>
  70     <title>Options</title>
  71     <variablelist>
  72
  73       <varlistentry>
  74         <term>
  75           <option><optional>-m, --max <replaceable>count</replaceable></optional></option>
  76         </term>
  77         <listitem>
  78           <para>
  79             Limit the number of containers displayed to
  80             <replaceable>count</replaceable>.
  81           </para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term>
  87           <option><optional>-d, --delay <replaceable>delay</replaceable></optional></option>
  88         </term>
  89         <listitem>
  90           <para>
  91             Amount of time in seconds to delay between screen updates.
  92             This can be specified as less than a second by giving a
  93             rational number, for example 0.5 for a half second delay. The
  94             default is 3 seconds.
  95           </para>
  96         </listitem>
  97       </varlistentry>
  98       <varlistentry>
  99         <term>
 100           <option><optional>-s, --sort <replaceable>sortby</replaceable></optional></option>
 101         </term>
 102         <listitem>
 103           <para>
 104             Sort the containers by name, cpu use, or memory use. The
 105             <replaceable>sortby</replaceable> argument should be one of
 106             the letters n,c,d,m to sort by name, cpu use, disk I/O, or
 107             memory use respectively. The default is 'n'.
 108           </para>
 109         </listitem>
 110       </varlistentry>
 111       <varlistentry>
 112         <term>
 113           <option><optional>-r, --reverse</optional></option>
 114         </term>
 115         <listitem>
 116           <para>
 117             Reverse the default sort order. By default, names sort in
 118             ascending alphabetical order and values sort in descending
 119             amounts (ie. largest value first).
 120           </para>
 121         </listitem>
 122       </varlistentry>
 123     </variablelist>
 124   </refsect1>
 125
 126   <refsect1>
 127     <title>Example</title>
 128     <variablelist>
 129       <varlistentry>
 130         <term>lxc-top --delay 1 --sort m</term>
 131         <listitem>
 132         <para>
 133           Display containers, updating every second, sorted by memory use.
 134         </para>
 135         </listitem>
 136       </varlistentry>
 137     </variablelist>
 138   </refsect1>
 139
 140   &seealso;
 141
 142   <refsect1>
 143     <title>Author</title>
 144     <para>Dwight Engen <email>dwight.engen@oracle.com</email></para>
 145   </refsect1>
 146
 147 </refentry>
 148
 149 <!-- Keep this comment at the end of the file
 150 Local variables:
 151 mode: sgml
 152 sgml-omittag:t
 153 sgml-shorttag:t
 154 sgml-minimize-attributes:nil
 155 sgml-always-quote-attributes:t
 156 sgml-indent-step:2
 157 sgml-indent-data:t
 158 sgml-parent-document:nil
 159 sgml-default-dtd-file:nil
 160 sgml-exposed-tags:nil
 161 sgml-local-catalogs:nil
 162 sgml-local-ecat-files:nil
 163 End:
 164 -->