Add the lxc-cgroup man page

From: Daniel Lezcano <dlezcano@fr.ibm.com>

Added the lxc-cgroup man page

Signed-off-by: Daniel Lezcano <dlezcano@fr.ibm.com>

diff --git a/configure.in b/configure.in
index 1859c905718e8fd409c3f60e9f9d31c706283482..a4d22c561e671e5c79b07bad68bb44c2b9ab9898 100644 (file)
--- a/configure.in
+++ b/configure.in
@@ -56,6 +56,7 @@ AC_CONFIG_FILES([
        doc/lxc-wait.sgml
        doc/lxc-ls.sgml
        doc/lxc-ps.sgml
+       doc/lxc-cgroup.sgml
 
         src/Makefile
        src/lxc/Makefile

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 451549b6eab05f2da07a45aa362d782988afc6a3..1cb0a455d4b5e118f708ba0731bfe5992ea18724 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -10,7 +10,8 @@ man_MANS = \
        lxc-monitor.1 \
        lxc-wait.1 \
        lxc-ls.1 \
-       lxc-ps.1
+       lxc-ps.1 \
+       lxc-cgroup.1
 
 
 %.1 : %.sgml 

diff --git a/doc/lxc-cgroup.sgml.in b/doc/lxc-cgroup.sgml.in
new file mode 100644 (file)
index 0000000..47ab8d2
--- /dev/null
+++ b/doc/lxc-cgroup.sgml.in
@@ -0,0 +1,188 @@
+<!-- 
+
+lxc: linux Container library
+
+(C) Copyright IBM Corp. 2007, 2008
+
+Authors:
+Daniel Lezcano <dlezcano at fr.ibm.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+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
+
+-->
+
+<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
+
+<refentry>
+
+  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
+
+  <refmeta>
+    <refentrytitle>lxc-cgroup</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-cgroup</refname>
+
+    <refpurpose>
+      manage the control group associated with a container
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-start <replaceable>-n name</replaceable>
+       <replaceable>subsystem</replaceable> <optional>value</optional>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <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.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <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>
+       </term>
+       <listitem>
+         <para>
+           Specify the subsystem control group name.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+         <option><optional>value</optional></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the subsystem control group value to be set.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <variablelist>
+      <varlistentry>
+       <term>lxc-cgroup -n foo devices.list</term>
+       <listitem>
+       <para>
+         display the allowed devices to be used.
+       </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>lxc-cgroup -n foo cpuset.cpus "0,3"</term>
+       <listitem>
+       <para>
+         assign the processors 0 and 3 to the container.
+       </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The container is not running.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc.conf</command></refentrytitle>
+       <manvolnum>5</manvolnum>
+      </citerefentry>,
+    </simpara>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Author</title>
+    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
+  </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->