Debian Codegraph @

doc/lxc-wait.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
6 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
7 ]>
8
9 <refentry>
10
11 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
12
13 <refmeta>
14 <refentrytitle>lxc-wait</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-wait</refname>
20
21 <refpurpose>
22 wait for a specific container state
23 </refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>lxc-wait</command>
29 <arg choice="req">-n <replaceable>name</replaceable></arg>
30 <arg choice="req">-s <replaceable>states</replaceable></arg>
31 </cmdsynopsis>
32 </refsynopsisdiv>
33
34 <refsect1>
35 <title>Description</title>
36 <para>
37 <command>lxc-wait</command> waits for a specific container state
38 before exiting, this is useful for scripting.
39 </para>
40 </refsect1>
41
42 <refsect1>
43 <title>Options</title>
44 <variablelist>
45
46 <varlistentry>
47 <term>
48 <option>-s, --state <replaceable>states</replaceable></option>
49 </term>
50 <listitem>
51 <para>
52 Specify the container state(s) to wait for. The container
53 states can be ORed to specify several states.
54 </para>
55 </listitem>
56 </varlistentry>
57
58 <varlistentry>
59 <term>
60 <option>-t, --timeout <replaceable>timeout</replaceable></option>
61 </term>
62 <listitem>
63 <para>
64 Wait timeout seconds for desired state to be reached.
65 </para>
66 </listitem>
67 </varlistentry>
68
69 </variablelist>
70
71 </refsect1>
72
73 &commonoptions;
74
75 <refsect1>
76 <title>Examples</title>
77 <variablelist>
78 <varlistentry>
79 <term>lxc-wait -n foo -s RUNNING</term>
80 <listitem>
81 <para>
82 exits when 'RUNNING' is reached.
83 </para>
84 </listitem>
85 </varlistentry>
86
87 <varlistentry>
88 <term>lxc-wait -n foo -s 'RUNNING|STOPPED'</term>
89 <listitem>
90 <para>
91 exits when 'RUNNING' or 'STOPPED' state is reached.
92 </para>
93 </listitem>
94 </varlistentry>
95
96 </variablelist>
97 </refsect1>
98
99 <refsect1>
100 <title>Diagnostic</title>
101
102 <variablelist>
103
104 <varlistentry>
105 <term>The container was not found</term>
106 <listitem>
107 <para>
108 The specified container was not created before with
109 the <command>lxc-create</command> command.
110 </para>
111 </listitem>
112 </varlistentry>
113
114
115 </variablelist>
116
117 </refsect1>
118
119 &seealso;
120
121 </refentry>
122
123 <!-- Keep this comment at the end of the file
124 Local variables:
125 mode: sgml
126 sgml-omittag:t
127 sgml-shorttag:t
128 sgml-minimize-attributes:nil
129 sgml-always-quote-attributes:t
130 sgml-indent-step:2
131 sgml-indent-data:t
132 sgml-parent-document:nil
133 sgml-default-dtd-file:nil
134 sgml-exposed-tags:nil
135 sgml-local-catalogs:nil
136 sgml-local-ecat-files:nil
137 End:
138 -->