0af993195cbd57cff700c7c90ee8f95c2a1ef8aaMichael H. Warfield

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graber<!--

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graber

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graberlxc: linux Container library

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graber

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graber(C) Copyright IBM Corp. 2007, 2008

a5c28c86f56835fa3e0915558e05390dd0a79580Aleksandr Mezin

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane GraberAuthors:

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane GraberDaniel Lezcano <dlezcano at fr.ibm.com>

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graber

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane GraberThis library is free software; you can redistribute it and/or

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Grabermodify it under the terms of the GNU Lesser General Public

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane GraberLicense as published by the Free Software Foundation; either

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graberversion 2.1 of the License, or (at your option) any later version.

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graber

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane GraberThis library is distributed in the hope that it will be useful,

dc0682900a79cfb47fd9a416902129bfa68fdcbfStéphane Graberbut WITHOUT ANY WARRANTY; without even the implied warranty of

87c7e080c8e2d4b702a23c38d10e39bccdfd03e1Stéphane GraberMERCHANTABILITY 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

-->

<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

<!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-wait</refentrytitle>

<manvolnum>1</manvolnum>

</refmeta>

<refnamediv>

<refname>lxc-wait</refname>

<refpurpose>

wait for a specific container state

</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>lxc-wait</command>

<arg choice="req">-n <replaceable>name</replaceable></arg>

<arg choice="req">-s <replaceable>states</replaceable></arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>

<command>lxc-wait</command> waits for a specific container state

before exiting, this is useful for scripting.

</para>

</refsect1>

<refsect1>

<title>Options</title>

<variablelist>

<varlistentry>

<term>

<option>-s <replaceable>states</replaceable></option>

</term>

<listitem>

<para>

Specify the container state(s) to wait for. The container

states can be ORed to specify several states.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-t <replaceable>timeout</replaceable></option>

</term>

<listitem>

<para>

Wait timeout seconds for desired state to be reached.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

&commonoptions;

<refsect1>

<title>Examples</title>

<variablelist>

<varlistentry>

<term>lxc-wait -n foo -s RUNNING</term>

<listitem>

<para>

exits when 'RUNNING' is reached.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>lxc-wait -n foo -s 'RUNNING|STOPPED'</term>

<listitem>

<para>

exits when 'RUNNING' or 'STOPPED' state is reached.

</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>

&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:

-->