Debian Codegraph @

doc/lxc-cgroup.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-cgroup</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-cgroup</refname>
20
21 <refpurpose>
22 manage the control group associated with a container
23 </refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>lxc-cgroup</command>
29 <arg choice="req">-n <replaceable>name</replaceable></arg>
30 <arg choice="req"><replaceable>state-object</replaceable></arg>
31 <arg choice="opt">value</arg>
32 </cmdsynopsis>
33 </refsynopsisdiv>
34
35 <refsect1>
36 <title>Description</title>
37
38 <para>
39 <command>lxc-cgroup</command> gets or sets the value of a
40 <replaceable>state-object</replaceable> (e.g., 'cpuset.cpus')
41 in the container's cgroup for the corresponding subsystem (e.g.,
42 'cpuset'). If no <optional>value</optional> is specified, the
43 current value of the <replaceable>state-object</replaceable> is
44 displayed; otherwise it is set.
45 </para>
46
47 <para>
48 Note that <command>lxc-cgroup</command> does not check that the
49 <replaceable>state-object</replaceable> is valid for the running
50 kernel, or that the corresponding subsystem is contained in any
51 mounted cgroup hierarchy.
52 </para>
53 </refsect1>
54
55 <refsect1>
56 <title>Options</title>
57 <variablelist>
58
59 <varlistentry>
60 <term>
61 <option><replaceable>state-object</replaceable></option>
62 </term>
63 <listitem>
64 <para>
65 Specify the state object name.
66 </para>
67 </listitem>
68 </varlistentry>
69
70 <varlistentry>
71 <term>
72 <option><optional>value</optional></option>
73 </term>
74 <listitem>
75 <para>
76 Specify the value to assign to the state object.
77 </para>
78 </listitem>
79 </varlistentry>
80
81 </variablelist>
82
83 </refsect1>
84
85 &commonoptions;
86
87 <refsect1>
88 <title>Examples</title>
89 <variablelist>
90 <varlistentry>
91 <term>lxc-cgroup -n foo devices.list</term>
92 <listitem>
93 <para>
94 display the allowed devices to be used.
95 </para>
96 </listitem>
97 </varlistentry>
98
99 <varlistentry>
100 <term>lxc-cgroup -n foo cpuset.cpus "0,3"</term>
101 <listitem>
102 <para>
103 assign the processors 0 and 3 to the container.
104 </para>
105 </listitem>
106 </varlistentry>
107
108 </variablelist>
109 </refsect1>
110
111 <refsect1>
112 <title>Diagnostic</title>
113
114 <variablelist>
115
116 <varlistentry>
117 <term>The container was not found</term>
118 <listitem>
119 <para>
120 The container is not running.
121 </para>
122 </listitem>
123 </varlistentry>
124
125
126 </variablelist>
127
128 </refsect1>
129
130 &seealso;
131
132 </refentry>
133
134 <!-- Keep this comment at the end of the file
135 Local variables:
136 mode: sgml
137 sgml-omittag:t
138 sgml-shorttag:t
139 sgml-minimize-attributes:nil
140 sgml-always-quote-attributes:t
141 sgml-indent-step:2
142 sgml-indent-data:t
143 sgml-parent-document:nil
144 sgml-default-dtd-file:nil
145 sgml-exposed-tags:nil
146 sgml-local-catalogs:nil
147 sgml-local-ecat-files:nil
148 End:
149 -->