← Back to branch summary

~stgraber/ubuntu/quantal/lxc/apparmor-profiles-rework

« back to all changes in this revision

Viewing changes to doc/lxc-cgroup.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-cgroup.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-cgroup</refentrytitle>
 
34
    <manvolnum>1</manvolnum>
 
35
  </refmeta>
 
36
 
 
37
  <refnamediv>
 
38
    <refname>lxc-cgroup</refname>
 
39
 
 
40
    <refpurpose>
 
41
      manage the control group associated with a container
 
42
    </refpurpose>
 
43
  </refnamediv>
 
44
 
 
45
  <refsynopsisdiv>
 
46
    <cmdsynopsis>
 
47
      <command>lxc-start <replaceable>-n name</replaceable>
 
48
        <replaceable>subsystem</replaceable> <optional>value</optional>
 
49
      </command>
 
50
    </cmdsynopsis>
 
51
  </refsynopsisdiv>
 
52
 
 
53
  <refsect1>
 
54
    <title>Description</title>
 
55
 
 
56
    <para>
 
57
      <command>lxc-cgroup</command> get or set value from the control
 
58
      group associated with the
 
59
      container <replaceable>name</replaceable>. If
 
60
      no <optional>value</optional> is specified, the value of
 
61
      the <replaceable>subsystem</replaceable> is displayed, otherwise
 
62
      it is set. The <command>lxc-cgroup</command> does not assume the
 
63
      correctness of the <replaceable>subsystem</replaceable> name, it
 
64
      is up to the user to specify the
 
65
      right <replaceable>subsystem</replaceable> name.
 
66
    </para>
 
67
 
 
68
  </refsect1>
 
69
 
 
70
  <refsect1>
 
71
    <title>Options</title>
 
72
    <variablelist>
 
73
 
 
74
      <varlistentry>
 
75
        <term>
 
76
          <option>-n <replaceable>name</replaceable></option>
 
77
        </term>
 
78
        <listitem>
 
79
          <para>
 
80
            Specify the container name associated with a control group.
 
81
          </para>
 
82
        </listitem>
 
83
      </varlistentry>
 
84
 
 
85
      <varlistentry>
 
86
        <term>
 
87
          <option><replaceable>subsystem</replaceable></option>
 
88
        </term>
 
89
        <listitem>
 
90
          <para>
 
91
            Specify the subsystem control group name.
 
92
          </para>
 
93
        </listitem>
 
94
      </varlistentry>
 
95
 
 
96
      <varlistentry>
 
97
        <term>
 
98
          <option><optional>value</optional></option>
 
99
        </term>
 
100
        <listitem>
 
101
          <para>
 
102
            Specify the subsystem control group value to be set.
 
103
          </para>
 
104
        </listitem>
 
105
      </varlistentry>
 
106
 
 
107
    </variablelist>
 
108
 
 
109
  </refsect1>
 
110
 
 
111
  <refsect1>
 
112
    <title>Examples</title>
 
113
    <variablelist>
 
114
      <varlistentry>
 
115
        <term>lxc-cgroup -n foo devices.list</term>
 
116
        <listitem>
 
117
        <para>
 
118
          display the allowed devices to be used.
 
119
        </para>
 
120
        </listitem>
 
121
      </varlistentry>
 
122
 
 
123
      <varlistentry>
 
124
        <term>lxc-cgroup -n foo cpuset.cpus "0,3"</term>
 
125
        <listitem>
 
126
        <para>
 
127
          assign the processors 0 and 3 to the container.
 
128
        </para>
 
129
        </listitem>
 
130
      </varlistentry>
 
131
 
 
132
    </variablelist>
 
133
  </refsect1>
 
134
 
 
135
  <refsect1>
 
136
    <title>Diagnostic</title>
 
137
 
 
138
    <variablelist>
 
139
 
 
140
      <varlistentry>
 
141
        <term>The container was not found</term>
 
142
        <listitem>
 
143
          <para>
 
144
            The container is not running.
 
145
          </para>
 
146
        </listitem>
 
147
      </varlistentry>    
 
148
 
 
149
 
 
150
    </variablelist>
 
151
 
 
152
  </refsect1>
 
153
 
 
154
  <refsect1>
 
155
    <title>See Also</title>
 
156
 
 
157
    <simpara>    
 
158
      <citerefentry>
 
159
        <refentrytitle><command>lxc.conf</command></refentrytitle>
 
160
        <manvolnum>5</manvolnum>
 
161
      </citerefentry>,
 
162
    </simpara>
 
163
 
 
164
  </refsect1>
 
165
 
 
166
  <refsect1>
 
167
    <title>Author</title>
 
168
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 
169
  </refsect1>
 
170
 
 
171
</refentry>
 
172
 
 
173
<!-- Keep this comment at the end of the file
 
174
Local variables:
 
175
mode: sgml
 
176
sgml-omittag:t
 
177
sgml-shorttag:t
 
178
sgml-minimize-attributes:nil
 
179
sgml-always-quote-attributes:t
 
180
sgml-indent-step:2
 
181
sgml-indent-data:t
 
182
sgml-parent-document:nil
 
183
sgml-default-dtd-file:nil
 
184
sgml-exposed-tags:nil
 
185
sgml-local-catalogs:nil
 
186
sgml-local-ecat-files:nil
 
187
End:
 
188
-->