← Back to branch summary

~ubuntu-branches/ubuntu/precise/lxc/precise

« back to all changes in this revision

Viewing changes to doc/lxc-monitor.sgml.in

  • Committer: Bazaar Package Importer
  • Author(s): Guido Trotter
  • Date: 2009-04-29 17:49:13 UTC
  • Revision ID: james.westby@ubuntu.com-20090429174913-jvahs1ykizqtodje
Tags: upstream-0.6.2
Import upstream version 0.6.2

Show diffs side-by-side

added added

removed removed

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