lxc-wait.sgml.in revision f282a2f4b8f1d44702eb746c8554408d802f402d
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainenlxc: linux Container library
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen(C) Copyright IBM Corp. 2007, 2008
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenDaniel Lezcano <dlezcano at fr.ibm.com>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenThis library is free software; you can redistribute it and/or
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenmodify it under the terms of the GNU Lesser General Public
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenLicense as published by the Free Software Foundation; either
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenversion 2.1 of the License, or (at your option) any later version.
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenThis library is distributed in the hope that it will be useful,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenbut WITHOUT ANY WARRANTY; without even the implied warranty of
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenLesser General Public License for more details.
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenYou should have received a copy of the GNU Lesser General Public
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenLicense along with this library; if not, write to the Free Software
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenFoundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <refentrytitle>lxc-wait</refentrytitle>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <manvolnum>1</manvolnum>
8aacc9e7c84f8376822823ec98c2f551d4919b2eTimo Sirainen <refname>lxc-wait</refname>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen wait for a specific container state
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </refpurpose>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </refnamediv>
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen <refsynopsisdiv>
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen <cmdsynopsis>
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen <command>lxc-wait</command>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <arg choice="req">-n <replaceable>name</replaceable></arg>
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen <arg choice="req">-s <replaceable>states</replaceable></arg>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </cmdsynopsis>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </refsynopsisdiv>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <title>Description</title>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <command>lxc-wait</command> waits for a specific container state
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen before exiting, this is useful for scripting.
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen <title>Options</title>
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen <variablelist>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <varlistentry>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <option>-s <replaceable>states</replaceable></option>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen Specify the container state(s) to wait for. The container
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen states can be ORed to specify several states.
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen </varlistentry>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <varlistentry>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <option>-t <replaceable>timeout</replaceable></option>
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen Wait timeout seconds for desired state to be reached.
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </varlistentry>
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen </variablelist>
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen &commonoptions;
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <title>Examples</title>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <variablelist>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <varlistentry>
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen <term>lxc-wait -n foo -s RUNNING</term>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen exits when 'RUNNING' is reached.
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </varlistentry>
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen <varlistentry>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <term>lxc-wait -n foo -s 'RUNNING|STOPPED'</term>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen exits when 'RUNNING' or 'STOPPED' state is reached.
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen </varlistentry>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </variablelist>
a40d26f83af808a0ea1e212c001d682a96d870b0Timo Sirainen <title>Diagnostic</title>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen <variablelist>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <varlistentry>
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainen <term>The container was not found</term>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen The specified container was not created before with
37e6cf44d61a81c6839e3ab76234b54309d8d292Timo Sirainen the <command>lxc-create</command> command.
a40d26f83af808a0ea1e212c001d682a96d870b0Timo Sirainen </varlistentry>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen </variablelist>
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainen <title>Author</title>
56f45b3f3ae20e5c933701f4657dda5ef1916855Timo Sirainen <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!-- Keep this comment at the end of the file
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo SirainenLocal variables:
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-omittag:t
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-shorttag:t
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainensgml-minimize-attributes:nil
fd2f5fbc1f07aa93e2214a28cdf02437fb7d06c8Timo Sirainensgml-always-quote-attributes:t
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainensgml-indent-step:2
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-indent-data:t
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-parent-document:nil
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-default-dtd-file:nil
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-exposed-tags:nil
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-local-catalogs:nil
1098fc409a45e7603701dc94635927a673bee0c1Timo Sirainensgml-local-ecat-files:nil