]>
Commit | Line | Data |
---|---|---|
b0e505c9 | 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 | ||
99e4008c MN |
26 | <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ |
27 | ||
10fba81b | 28 | <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> |
99e4008c MN |
29 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> |
30 | ]> | |
b0e505c9 | 31 | |
32 | <refentry> | |
33 | ||
34 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
35 | ||
36 | <refmeta> | |
37 | <refentrytitle>lxc-cgroup</refentrytitle> | |
38 | <manvolnum>1</manvolnum> | |
39 | </refmeta> | |
40 | ||
41 | <refnamediv> | |
42 | <refname>lxc-cgroup</refname> | |
43 | ||
44 | <refpurpose> | |
45 | manage the control group associated with a container | |
46 | </refpurpose> | |
47 | </refnamediv> | |
48 | ||
49 | <refsynopsisdiv> | |
50 | <cmdsynopsis> | |
f10e7166 DW |
51 | <command>lxc-cgroup -n <replaceable>name</replaceable> |
52 | <replaceable>state-object</replaceable> <optional>value</optional> | |
b0e505c9 | 53 | </command> |
54 | </cmdsynopsis> | |
55 | </refsynopsisdiv> | |
56 | ||
57 | <refsect1> | |
58 | <title>Description</title> | |
59 | ||
60 | <para> | |
f10e7166 DW |
61 | <command>lxc-cgroup</command> gets or sets the value of a |
62 | <replaceable>state-object</replaceable> (e.g., 'cpuset.cpus') | |
63 | in the container's cgroup for the corresponding subsystem (e.g., | |
64 | 'cpuset'). If no <optional>value</optional> is specified, the | |
65 | current value of the <replaceable>state-object</replaceable> is | |
66 | displayed; otherwise it is set. | |
b0e505c9 | 67 | </para> |
68 | ||
f10e7166 DW |
69 | <para> |
70 | Note that <command>lxc-cgroup</command> does not check that the | |
71 | <replaceable>state-object</replaceable> is valid for the running | |
72 | kernel, or that the corresponding subsystem is contained in any | |
73 | mounted cgroup hierarchy. | |
74 | </para> | |
b0e505c9 | 75 | </refsect1> |
76 | ||
77 | <refsect1> | |
78 | <title>Options</title> | |
79 | <variablelist> | |
80 | ||
b0e505c9 | 81 | <varlistentry> |
82 | <term> | |
f10e7166 | 83 | <option><replaceable>state-object</replaceable></option> |
b0e505c9 | 84 | </term> |
85 | <listitem> | |
86 | <para> | |
f10e7166 | 87 | Specify the state object name. |
b0e505c9 | 88 | </para> |
89 | </listitem> | |
90 | </varlistentry> | |
91 | ||
92 | <varlistentry> | |
93 | <term> | |
94 | <option><optional>value</optional></option> | |
95 | </term> | |
96 | <listitem> | |
97 | <para> | |
f10e7166 | 98 | Specify the value to assign to the state object. |
b0e505c9 | 99 | </para> |
100 | </listitem> | |
101 | </varlistentry> | |
102 | ||
103 | </variablelist> | |
104 | ||
105 | </refsect1> | |
106 | ||
10fba81b MN |
107 | &commonoptions; |
108 | ||
b0e505c9 | 109 | <refsect1> |
110 | <title>Examples</title> | |
111 | <variablelist> | |
112 | <varlistentry> | |
113 | <term>lxc-cgroup -n foo devices.list</term> | |
114 | <listitem> | |
115 | <para> | |
116 | display the allowed devices to be used. | |
117 | </para> | |
118 | </listitem> | |
119 | </varlistentry> | |
120 | ||
121 | <varlistentry> | |
122 | <term>lxc-cgroup -n foo cpuset.cpus "0,3"</term> | |
123 | <listitem> | |
124 | <para> | |
125 | assign the processors 0 and 3 to the container. | |
126 | </para> | |
127 | </listitem> | |
128 | </varlistentry> | |
129 | ||
130 | </variablelist> | |
131 | </refsect1> | |
132 | ||
133 | <refsect1> | |
134 | <title>Diagnostic</title> | |
135 | ||
136 | <variablelist> | |
137 | ||
138 | <varlistentry> | |
139 | <term>The container was not found</term> | |
140 | <listitem> | |
141 | <para> | |
142 | The container is not running. | |
143 | </para> | |
144 | </listitem> | |
145 | </varlistentry> | |
146 | ||
147 | ||
148 | </variablelist> | |
149 | ||
150 | </refsect1> | |
151 | ||
99e4008c | 152 | &seealso; |
b0e505c9 | 153 | |
154 | <refsect1> | |
155 | <title>Author</title> | |
156 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
157 | </refsect1> | |
158 | ||
159 | </refentry> | |
160 | ||
161 | <!-- Keep this comment at the end of the file | |
162 | Local variables: | |
163 | mode: sgml | |
164 | sgml-omittag:t | |
165 | sgml-shorttag:t | |
166 | sgml-minimize-attributes:nil | |
167 | sgml-always-quote-attributes:t | |
168 | sgml-indent-step:2 | |
169 | sgml-indent-data:t | |
170 | sgml-parent-document:nil | |
171 | sgml-default-dtd-file:nil | |
172 | sgml-exposed-tags:nil | |
173 | sgml-local-catalogs:nil | |
174 | sgml-local-ecat-files:nil | |
175 | End: | |
176 | --> |