]>
Commit | Line | Data |
---|---|---|
d823d5b9 | 1 | |
f79d43bb | 2 | <!-- |
d823d5b9 | 3 | |
4 | lxc: linux Container library | |
5 | ||
6 | (C) Copyright IBM Corp. 2007, 2008 | |
7 | ||
8 | Authors: | |
9afe19d6 | 9 | Daniel Lezcano <daniel.lezcano at free.fr> |
d823d5b9 | 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 | |
250b1eec | 23 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
d823d5b9 | 24 | |
25 | --> | |
26 | ||
7f951458 | 27 | <!DOCTYPE refentry PUBLIC @docdtd@ [ |
99e4008c | 28 | |
10fba81b | 29 | <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> |
99e4008c MN |
30 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> |
31 | ]> | |
d823d5b9 | 32 | |
33 | <refentry> | |
34 | ||
35 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
36 | ||
37 | <refmeta> | |
38 | <refentrytitle>lxc-wait</refentrytitle> | |
39 | <manvolnum>1</manvolnum> | |
40 | </refmeta> | |
41 | ||
42 | <refnamediv> | |
43 | <refname>lxc-wait</refname> | |
44 | ||
45 | <refpurpose> | |
46 | wait for a specific container state | |
47 | </refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <cmdsynopsis> | |
b4578c5b DE |
52 | <command>lxc-wait</command> |
53 | <arg choice="req">-n <replaceable>name</replaceable></arg> | |
54 | <arg choice="req">-s <replaceable>states</replaceable></arg> | |
d823d5b9 | 55 | </cmdsynopsis> |
56 | </refsynopsisdiv> | |
57 | ||
58 | <refsect1> | |
59 | <title>Description</title> | |
60 | <para> | |
61 | <command>lxc-wait</command> waits for a specific container state | |
62 | before exiting, this is useful for scripting. | |
63 | </para> | |
64 | </refsect1> | |
65 | ||
66 | <refsect1> | |
67 | <title>Options</title> | |
68 | <variablelist> | |
69 | ||
d823d5b9 | 70 | <varlistentry> |
71 | <term> | |
1bc07a5b | 72 | <option>-s, --state <replaceable>states</replaceable></option> |
d823d5b9 | 73 | </term> |
74 | <listitem> | |
75 | <para> | |
76 | Specify the container state(s) to wait for. The container | |
77 | states can be ORed to specify several states. | |
78 | </para> | |
79 | </listitem> | |
80 | </varlistentry> | |
81 | ||
b486346a JK |
82 | <varlistentry> |
83 | <term> | |
1bc07a5b | 84 | <option>-t, --timeout <replaceable>timeout</replaceable></option> |
b486346a JK |
85 | </term> |
86 | <listitem> | |
87 | <para> | |
88 | Wait timeout seconds for desired state to be reached. | |
89 | </para> | |
90 | </listitem> | |
91 | </varlistentry> | |
92 | ||
d823d5b9 | 93 | </variablelist> |
94 | ||
95 | </refsect1> | |
96 | ||
10fba81b MN |
97 | &commonoptions; |
98 | ||
d823d5b9 | 99 | <refsect1> |
100 | <title>Examples</title> | |
101 | <variablelist> | |
102 | <varlistentry> | |
103 | <term>lxc-wait -n foo -s RUNNING</term> | |
104 | <listitem> | |
105 | <para> | |
106 | exits when 'RUNNING' is reached. | |
107 | </para> | |
108 | </listitem> | |
109 | </varlistentry> | |
110 | ||
111 | <varlistentry> | |
10fba81b | 112 | <term>lxc-wait -n foo -s 'RUNNING|STOPPED'</term> |
d823d5b9 | 113 | <listitem> |
114 | <para> | |
115 | exits when 'RUNNING' or 'STOPPED' state is reached. | |
116 | </para> | |
117 | </listitem> | |
118 | </varlistentry> | |
119 | ||
120 | </variablelist> | |
121 | </refsect1> | |
122 | ||
123 | <refsect1> | |
124 | <title>Diagnostic</title> | |
125 | ||
126 | <variablelist> | |
127 | ||
128 | <varlistentry> | |
129 | <term>The container was not found</term> | |
130 | <listitem> | |
131 | <para> | |
132 | The specified container was not created before with | |
133 | the <command>lxc-create</command> command. | |
134 | </para> | |
135 | </listitem> | |
f79d43bb | 136 | </varlistentry> |
d823d5b9 | 137 | |
138 | ||
139 | </variablelist> | |
140 | ||
141 | </refsect1> | |
142 | ||
99e4008c | 143 | &seealso; |
d823d5b9 | 144 | |
145 | <refsect1> | |
146 | <title>Author</title> | |
147 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
148 | </refsect1> | |
149 | ||
150 | </refentry> | |
151 | ||
152 | <!-- Keep this comment at the end of the file | |
153 | Local variables: | |
154 | mode: sgml | |
155 | sgml-omittag:t | |
156 | sgml-shorttag:t | |
157 | sgml-minimize-attributes:nil | |
158 | sgml-always-quote-attributes:t | |
159 | sgml-indent-step:2 | |
160 | sgml-indent-data:t | |
161 | sgml-parent-document:nil | |
162 | sgml-default-dtd-file:nil | |
163 | sgml-exposed-tags:nil | |
164 | sgml-local-catalogs:nil | |
165 | sgml-local-ecat-files:nil | |
166 | End: | |
167 | --> |