doc/lxc-wait.sgml.in

   1
   2 <!--
   3
   4 lxc: linux Container library
   5
   6 (C) Copyright IBM Corp. 2007, 2008
   7
   8 Authors:
   9 Daniel Lezcano <dlezcano at fr.ibm.com>
  10
  11 This library is free software; you can redistribute it and/or
  12 modify it under the terms of the GNU Lesser General Public
  13 License as published by the Free Software Foundation; either
  14 version 2.1 of the License, or (at your option) any later version.
  15
  16 This library is distributed in the hope that it will be useful,
  17 but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 Lesser General Public License for more details.
  20
  21 You should have received a copy of the GNU Lesser General Public
  22 License along with this library; if not, write to the Free Software
  23 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  24
  25 -->
  26
  27 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
  28
  29 <refentry>
  30
  31   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  32
  33   <refmeta>
  34     <refentrytitle>lxc-wait</refentrytitle>
  35     <manvolnum>1</manvolnum>
  36   </refmeta>
  37
  38   <refnamediv>
  39     <refname>lxc-wait</refname>
  40
  41     <refpurpose>
  42       wait for a specific container state
  43     </refpurpose>
  44   </refnamediv>
  45
  46   <refsynopsisdiv>
  47     <cmdsynopsis>
  48       <command>lxc-wait <replaceable>-n name</replaceable>
  49         <replaceable>-s states</replaceable>
  50       </command>
  51     </cmdsynopsis>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56     <para>
  57       <command>lxc-wait</command> waits for a specific container state
  58       before exiting, this is useful for scripting.
  59     </para>
  60   </refsect1>
  61
  62   <refsect1>
  63     <title>Options</title>
  64     <variablelist>
  65
  66       <varlistentry>
  67         <term>
  68           <option>-n <replaceable>name</replaceable></option>
  69         </term>
  70         <listitem>
  71           <para>
  72             Specify the container name to be waited.
  73           </para>
  74         </listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term>
  79           <option>-s <replaceable>states</replaceable></option>
  80         </term>
  81         <listitem>
  82           <para>
  83             Specify the container state(s) to wait for. The container
  84             states can be ORed to specify several states.
  85           </para>
  86         </listitem>
  87       </varlistentry>
  88
  89     </variablelist>
  90
  91   </refsect1>
  92
  93   <refsect1>
  94     <title>Examples</title>
  95     <variablelist>
  96       <varlistentry>
  97         <term>lxc-wait -n foo -s RUNNING</term>
  98         <listitem>
  99         <para>
 100           exits when 'RUNNING' is reached.
 101         </para>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term>lxc-wait -n 'RUNNING|STOPPED'</term>
 107         <listitem>
 108         <para>
 109           exits when 'RUNNING' or 'STOPPED' state is reached.
 110         </para>
 111         </listitem>
 112       </varlistentry>
 113
 114     </variablelist>
 115   </refsect1>
 116
 117   <refsect1>
 118     <title>Diagnostic</title>
 119
 120     <variablelist>
 121
 122       <varlistentry>
 123         <term>The container was not found</term>
 124         <listitem>
 125           <para>
 126             The specified container was not created before with
 127             the <command>lxc-create</command> command.
 128           </para>
 129         </listitem>
 130       </varlistentry>
 131
 132
 133     </variablelist>
 134
 135   </refsect1>
 136
 137   <refsect1>
 138     <title>See Also</title>
 139
 140     <simpara>
 141       <citerefentry>
 142         <refentrytitle>lxc-info</refentrytitle>
 143         <manvolnum>1</manvolnum>
 144       </citerefentry>,
 145     </simpara>
 146
 147
 148   </refsect1>
 149
 150   <refsect1>
 151     <title>Author</title>
 152     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 153   </refsect1>
 154
 155 </refentry>
 156
 157 <!-- Keep this comment at the end of the file
 158 Local variables:
 159 mode: sgml
 160 sgml-omittag:t
 161 sgml-shorttag:t
 162 sgml-minimize-attributes:nil
 163 sgml-always-quote-attributes:t
 164 sgml-indent-step:2
 165 sgml-indent-data:t
 166 sgml-parent-document:nil
 167 sgml-default-dtd-file:nil
 168 sgml-exposed-tags:nil
 169 sgml-local-catalogs:nil
 170 sgml-local-ecat-files:nil
 171 End:
 172 -->