]> git.proxmox.com Git - mirror_lxc.git/blobdiff - doc/lxc-wait.sgml.in
meson: Simplify if statements
[mirror_lxc.git] / doc / lxc-wait.sgml.in
index 5dc3566283c6402706619ab18549dab4aa9ac338..c32f8a5107f7eba8b2280d2c390b1308832c9e3d 100644 (file)
@@ -1,12 +1,12 @@
 
-<!-- 
+<!--
 
 lxc: linux Container library
 
 (C) Copyright IBM Corp. 2007, 2008
 
 Authors:
-Daniel Lezcano <dlezcano at fr.ibm.com>
+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
@@ -20,12 +20,13 @@ 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
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
 -->
 
-<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!DOCTYPE refentry PUBLIC @docdtd@ [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -48,9 +49,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>lxc-wait <replaceable>-n name</replaceable>
-       <replaceable>-s states</replaceable>
-      </command>
+      <command>lxc-wait</command>
+      <arg choice="req">-n <replaceable>name</replaceable></arg>
+      <arg choice="req">-s <replaceable>states</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -68,23 +69,23 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
        <term>
-         <option>-n <replaceable>name</replaceable></option>
+         <option>-s, --state <replaceable>states</replaceable></option>
        </term>
        <listitem>
          <para>
-           Specify the container name to be waited.
+           Specify the container state(s) to wait for. The container
+           states can be ORed to specify several states.
          </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>
-         <option>-s <replaceable>states</replaceable></option>
+         <option>-t, --timeout <replaceable>timeout</replaceable></option>
        </term>
        <listitem>
          <para>
-           Specify the container state(s) to wait for. The container
-           states can be ORed to specify several states.
+           Wait timeout seconds for desired state to be reached.
          </para>
        </listitem>
       </varlistentry>
@@ -93,6 +94,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Examples</title>
     <variablelist>
@@ -106,7 +109,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       </varlistentry>
 
       <varlistentry>
-       <term>lxc-wait -n 'RUNNING|STOPPED'</term>
+       <term>lxc-wait -n foo -s 'RUNNING|STOPPED'</term>
        <listitem>
        <para>
          exits when 'RUNNING' or 'STOPPED' state is reached.
@@ -130,7 +133,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
            the <command>lxc-create</command> command.
           </para>
         </listitem>
-      </varlistentry>    
+      </varlistentry>
 
 
     </variablelist>