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