doc/lxc-monitor.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright IBM Corp. 2007, 2008
   6
   7 Authors:
   8 Daniel Lezcano <daniel.lezcano at free.fr>
   9
  10 This library is free software; you can redistribute it and/or
  11 modify it under the terms of the GNU Lesser General Public
  12 License as published by the Free Software Foundation; either
  13 version 2.1 of the License, or (at your option) any later version.
  14
  15 This library is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with this library; if not, write to the Free Software
  22 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC @docdtd@ [
  27
  28 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  30 ]>
  31
  32 <refentry>
  33
  34   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  35
  36   <refmeta>
  37     <refentrytitle>lxc-monitor</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-monitor</refname>
  43
  44     <refpurpose>
  45       monitor the container state
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-monitor</command>
  52       <arg choice="req">-n <replaceable>name</replaceable></arg>
  53     </cmdsynopsis>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para>
  60       <command>lxc-monitor</command> monitors the state of the
  61       specified containers. The <replaceable>name</replaceable> can be
  62       a regular expression, conforming with posix2, so it is possible
  63       to monitor all the containers, several of them or just one.
  64     </para>
  65
  66     <para>
  67       The <option>-P, --lxcpath</option>=PATH option may be specified multiple
  68       times to monitor more than one container path. Note however that
  69       containers with the same name in multiple paths will be
  70       indistinguishable in the output.
  71     </para>
  72
  73   </refsect1>
  74
  75   &commonoptions;
  76
  77   <refsect1>
  78     <title>Examples</title>
  79     <variablelist>
  80       <varlistentry>
  81         <term>lxc-monitor -n foo</term>
  82         <listitem>
  83         <para>
  84           will monitor the different states for container foo.
  85         </para>
  86         </listitem>
  87       </varlistentry>
  88
  89       <varlistentry>
  90         <term>lxc-monitor -n 'foo|bar'</term>
  91         <listitem>
  92         <para>
  93           will monitor the different states for container foo and bar.
  94         </para>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term>lxc-monitor -n '[f|b].*'</term>
 100         <listitem>
 101         <para>
 102           will monitor the different states for container with the
 103           name beginning with letter 'f' or 'b'.
 104         </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>lxc-monitor -n '.*'</term>
 110         <listitem>
 111         <para>
 112           will monitor the different states for all containers.
 113         </para>
 114         </listitem>
 115       </varlistentry>
 116
 117     </variablelist>
 118   </refsect1>
 119
 120   <refsect1>
 121     <title>Diagnostic</title>
 122
 123     <variablelist>
 124
 125       <varlistentry>
 126         <term>The container was not found</term>
 127         <listitem>
 128           <para>
 129             The specified container was not created before with
 130             the <command>lxc-create</command> command.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134
 135
 136     </variablelist>
 137
 138   </refsect1>
 139
 140   <refsect1>
 141     <title>See Also</title>
 142
 143     <simpara>
 144       <citerefentry>
 145         <refentrytitle>regex</refentrytitle>
 146         <manvolnum>7</manvolnum>
 147       </citerefentry>,
 148     </simpara>
 149
 150   </refsect1>
 151
 152   &seealso;
 153
 154   <refsect1>
 155     <title>Author</title>
 156     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 157   </refsect1>
 158
 159 </refentry>
 160
 161 <!-- Keep this comment at the end of the file
 162 Local variables:
 163 mode: sgml
 164 sgml-omittag:t
 165 sgml-shorttag:t
 166 sgml-minimize-attributes:nil
 167 sgml-always-quote-attributes:t
 168 sgml-indent-step:2
 169 sgml-indent-data:t
 170 sgml-parent-document:nil
 171 sgml-default-dtd-file:nil
 172 sgml-exposed-tags:nil
 173 sgml-local-catalogs:nil
 174 sgml-local-ecat-files:nil
 175 End:
 176 -->