spelling: output

[mirror_lxc.git] / doc / lxc-cgroup.sgml.in

diff --git a/doc/lxc-cgroup.sgml.in b/doc/lxc-cgroup.sgml.in
index 47ab8d2c56d2db28769ccc1088d71a71d1b199b2..4546574d0244a239651ac58bfd76058b367bda22 100644 (file)
--- a/doc/lxc-cgroup.sgml.in
+++ b/doc/lxc-cgroup.sgml.in
@@ -1,11 +1,11 @@
-<!-- 
+<!--
 
 lxc: linux Container library
 
 (C) Copyright IBM Corp. 2007, 2008
 
 Authors:
-Daniel Lezcano <dlezcano at fr.ibm.com>
+Daniel Lezcano <daniel.lezcano at free.fr>
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
@@ -19,11 +19,15 @@ Lesser General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
 -->
 
-<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
+<!DOCTYPE refentry PUBLIC @docdtd@ [
+
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
+<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
+]>
 
 <refentry>
 
@@ -44,9 +48,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>lxc-start <replaceable>-n name</replaceable>
-       <replaceable>subsystem</replaceable> <optional>value</optional>
-      </command>
+      <command>lxc-cgroup</command>
+      <arg choice="req">-n <replaceable>name</replaceable></arg>
+      <arg choice="req"><replaceable>state-object</replaceable></arg>
+      <arg choice="opt">value</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -54,17 +59,20 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <title>Description</title>
 
     <para>
-      <command>lxc-cgroup</command> get or set value from the control
-      group associated with the
-      container <replaceable>name</replaceable>. If
-      no <optional>value</optional> is specified, the value of
-      the <replaceable>subsystem</replaceable> is displayed, otherwise
-      it is set. The <command>lxc-cgroup</command> does not assume the
-      correctness of the <replaceable>subsystem</replaceable> name, it
-      is up to the user to specify the
-      right <replaceable>subsystem</replaceable> name.
+      <command>lxc-cgroup</command> gets or sets the value of a
+      <replaceable>state-object</replaceable> (e.g., 'cpuset.cpus')
+      in the container's cgroup for the corresponding subsystem (e.g.,
+      'cpuset'). If no <optional>value</optional> is specified, the
+      current value of the <replaceable>state-object</replaceable> is
+      displayed; otherwise it is set.
     </para>
 
+    <para>
+      Note that <command>lxc-cgroup</command> does not check that the
+      <replaceable>state-object</replaceable> is valid for the running
+      kernel, or that the corresponding subsystem is contained in any
+      mounted cgroup hierarchy.
+    </para>
   </refsect1>
 
   <refsect1>
@@ -73,22 +81,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
        <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name associated with a control group.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>
-         <option><replaceable>subsystem</replaceable></option>
+         <option><replaceable>state-object</replaceable></option>
        </term>
        <listitem>
          <para>
-           Specify the subsystem control group name.
+           Specify the state object name.
          </para>
        </listitem>
       </varlistentry>
@@ -99,7 +96,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
        </term>
        <listitem>
          <para>
-           Specify the subsystem control group value to be set.
+           Specify the value to assign to the state object.
          </para>
        </listitem>
       </varlistentry>
@@ -108,6 +105,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Examples</title>
     <variablelist>
@@ -144,24 +143,14 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
            The container is not running.
           </para>
         </listitem>
-      </varlistentry>    
+      </varlistentry>
 
 
     </variablelist>
 
   </refsect1>
 
-  <refsect1>
-    <title>See Also</title>
-
-    <simpara>    
-      <citerefentry>
-       <refentrytitle><command>lxc.conf</command></refentrytitle>
-       <manvolnum>5</manvolnum>
-      </citerefentry>,
-    </simpara>
-
-  </refsect1>
+  &seealso;
 
   <refsect1>
     <title>Author</title>