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