gitignore doc/ja/legacy/*.1

[mirror_lxc.git] / doc / lxc-monitor.sgml.in

<!--

lxc: linux Container library

(C) Copyright IBM Corp. 2007, 2008

Authors:
Daniel Lezcano <daniel.lezcano at free.fr>

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 commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>

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

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

  <refnamediv>
    <refname>lxc-monitor</refname>

    <refpurpose>
      monitor the container state
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-monitor</command>
      <arg choice="req">-n <replaceable>name</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>
      <command>lxc-monitor</command> monitors the state of the
      specified containers. The <replaceable>name</replaceable> can be
      a regular expression, conforming with posix2, so it is possible
      to monitor all the containers, several of them or just one.
    </para>

    <para>
      The <option>-P, --lxcpath</option>=PATH option may be specified multiple
      times to monitor more than one container path. Note however that
      containers with the same name in multiple paths will be
      indistinguishable in the output.
    </para>

  </refsect1>

  &commonoptions;

  <refsect1>
    <title>Examples</title>
    <variablelist>
      <varlistentry>
	<term>lxc-monitor -n foo</term>
	<listitem>
	<para>
	  will monitor the different states for container foo.
	</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>lxc-monitor -n 'foo|bar'</term>
	<listitem>
	<para>
	  will monitor the different states for container foo and bar.
	</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>lxc-monitor -n '[f|b].*'</term>
	<listitem>
	<para>
	  will monitor the different states for container with the
	  name beginning with letter 'f' or 'b'.
	</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>lxc-monitor -n '.*'</term>
	<listitem>
	<para>
	  will monitor the different states for all containers.
	</para>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Diagnostic</title>

    <variablelist>

      <varlistentry>
        <term>The container was not found</term>
        <listitem>
          <para>
	    The specified container was not created before with
	    the <command>lxc-create</command> command.
          </para>
        </listitem>
      </varlistentry>


    </variablelist>

  </refsect1>

  <refsect1>
    <title>See Also</title>

    <simpara>
      <citerefentry>
	<refentrytitle>regex</refentrytitle>
	<manvolnum>7</manvolnum>
      </citerefentry>,
    </simpara>

  </refsect1>

  &seealso;

  <refsect1>
    <title>Author</title>
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</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:
-->