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