Debian Codegraph @

doc/lxc-monitor.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-monitor</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-monitor</refname>
20
21 <refpurpose>
22 monitor the container state
23 </refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>lxc-monitor</command>
29 <arg choice="opt">-n <replaceable>name</replaceable></arg>
30 <arg choice="opt">-Q <replaceable>name</replaceable></arg>
31 </cmdsynopsis>
32 </refsynopsisdiv>
33
34 <refsect1>
35 <title>Description</title>
36
37 <para>
38 <command>lxc-monitor</command> monitors the state of containers. The
39 <replaceable>name</replaceable> argument may be used to specify
40 which containers to monitor. It is a regular expression, conforming
41 with posix2, so it is possible to monitor all the containers,
42 several of them or just one. If not specified,
43 <replaceable>name</replaceable> will default to '.*' which will
44 monitor all containers in <command>lxcpath</command>.
45 </para>
46
47 <para>
48 The <option>-P, --lxcpath</option>=PATH option may be specified multiple
49 times to monitor more than one container path. Note however that
50 containers with the same name in multiple paths will be
51 indistinguishable in the output.
52 </para>
53
54 </refsect1>
55
56 <refsect1>
57 <title>Options</title>
58
59 <variablelist>
60 <varlistentry>
61 <term>
62 <option>-Q, --quit</option>
63 </term>
64 <listitem>
65 <para>
66 Ask the lxc-monitord daemon on each given <command>lxcpath</command>
67 to quit. After receiving this command, lxc-monitord will exit
68 immediately as soon as it has no clients instead of waiting the
69 normal 30 seconds for new clients. This is useful if you need to
70 unmount the filesystem <command>lxcpath</command> is on.
71 </para>
72 </listitem>
73 </varlistentry>
74 </variablelist>
75 </refsect1>
76
77 &commonoptions;
78
79 <refsect1>
80 <title>Examples</title>
81 <variablelist>
82 <varlistentry>
83 <term>lxc-monitor -n foo</term>
84 <listitem>
85 <para>
86 will monitor the different states for container foo.
87 </para>
88 </listitem>
89 </varlistentry>
90
91 <varlistentry>
92 <term>lxc-monitor -n 'foo|bar'</term>
93 <listitem>
94 <para>
95 will monitor the different states for container foo and bar.
96 </para>
97 </listitem>
98 </varlistentry>
99
100 <varlistentry>
101 <term>lxc-monitor -n '[fb].*'</term>
102 <listitem>
103 <para>
104 will monitor the different states for container with the
105 name beginning with letter 'f' or 'b'.
106 </para>
107 </listitem>
108 </varlistentry>
109
110 <varlistentry>
111 <term>lxc-monitor -n '.*'</term>
112 <listitem>
113 <para>
114 will monitor the different states for all containers.
115 </para>
116 </listitem>
117 </varlistentry>
118
119 </variablelist>
120 </refsect1>
121
122 <refsect1>
123 <title>Diagnostic</title>
124
125 <variablelist>
126
127 <varlistentry>
128 <term>The container was not found</term>
129 <listitem>
130 <para>
131 The specified container was not created before with
132 the <command>lxc-create</command> command.
133 </para>
134 </listitem>
135 </varlistentry>
136
137
138 </variablelist>
139
140 </refsect1>
141
142 <refsect1>
143 <title>See Also</title>
144
145 <simpara>
146 <citerefentry>
147 <refentrytitle>regex</refentrytitle>
148 <manvolnum>7</manvolnum>
149 </citerefentry>,
150 </simpara>
151
152 </refsect1>
153
154 &seealso;
155
156 </refentry>
157
158 <!-- Keep this comment at the end of the file
159 Local variables:
160 mode: sgml
161 sgml-omittag:t
162 sgml-shorttag:t
163 sgml-minimize-attributes:nil
164 sgml-always-quote-attributes:t
165 sgml-indent-step:2
166 sgml-indent-data:t
167 sgml-parent-document:nil
168 sgml-default-dtd-file:nil
169 sgml-exposed-tags:nil
170 sgml-local-catalogs:nil
171 sgml-local-ecat-files:nil
172 End:
173 -->