lxc-cgroup.sgml.in revision 7f95145833bb24f54e037f73ecc37444d6635697
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber<!--
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanolxc: linux Container library
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano(C) Copyright IBM Corp. 2007, 2008
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoAuthors:
9afe19d634946d50eab30e3b90cb5cebcde39eeaDaniel LezcanoDaniel Lezcano <daniel.lezcano at free.fr>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoThis library is free software; you can redistribute it and/or
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanomodify it under the terms of the GNU Lesser General Public
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoLicense as published by the Free Software Foundation; either
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoversion 2.1 of the License, or (at your option) any later version.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoThis library is distributed in the hope that it will be useful,
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanobut WITHOUT ANY WARRANTY; without even the implied warranty of
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoLesser General Public License for more details.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoYou should have received a copy of the GNU Lesser General Public
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoLicense along with this library; if not, write to the Free Software
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoFoundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano-->
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
7f95145833bb24f54e037f73ecc37444d6635697Dwight Engen<!DOCTYPE refentry PUBLIC @docdtd@ [
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand]>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano<refentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refmeta>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refentrytitle>lxc-cgroup</refentrytitle>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <manvolnum>1</manvolnum>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refmeta>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refnamediv>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refname>lxc-cgroup</refname>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refpurpose>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano manage the control group associated with a container
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refpurpose>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refnamediv>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refsynopsisdiv>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <cmdsynopsis>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <command>lxc-cgroup</command>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="req">-n <replaceable>name</replaceable></arg>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="req"><replaceable>state-object</replaceable></arg>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="opt">value</arg>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </cmdsynopsis>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refsynopsisdiv>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <title>Description</title>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <para>
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward <command>lxc-cgroup</command> gets or sets the value of a
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward <replaceable>state-object</replaceable> (e.g., 'cpuset.cpus')
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward in the container's cgroup for the corresponding subsystem (e.g.,
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward 'cpuset'). If no <optional>value</optional> is specified, the
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward current value of the <replaceable>state-object</replaceable> is
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward displayed; otherwise it is set.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward <para>
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward Note that <command>lxc-cgroup</command> does not check that the
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward <replaceable>state-object</replaceable> is valid for the running
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward kernel, or that the corresponding subsystem is contained in any
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward mounted cgroup hierarchy.
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward </para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <title>Options</title>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <variablelist>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <term>
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward <option><replaceable>state-object</replaceable></option>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </term>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <para>
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward Specify the state object name.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <term>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <option><optional>value</optional></option>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </term>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <para>
f10e7166ab7f6d2a6665842b2613dd45d1795cc9David Ward Specify the value to assign to the state object.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </variablelist>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand &commonoptions;
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <title>Examples</title>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <variablelist>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <term>lxc-cgroup -n foo devices.list</term>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano display the allowed devices to be used.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <term>lxc-cgroup -n foo cpuset.cpus "0,3"</term>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano assign the processors 0 and 3 to the container.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </variablelist>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <title>Diagnostic</title>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <variablelist>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <term>The container was not found</term>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <listitem>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano The container is not running.
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </listitem>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber </varlistentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </variablelist>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand &seealso;
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <title>Author</title>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano </refsect1>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano</refentry>
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano<!-- Keep this comment at the end of the file
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoLocal variables:
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanomode: sgml
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-omittag:t
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-shorttag:t
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-minimize-attributes:nil
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-always-quote-attributes:t
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-indent-step:2
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-indent-data:t
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-parent-document:nil
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-default-dtd-file:nil
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-exposed-tags:nil
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-local-catalogs:nil
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanosgml-local-ecat-files:nil
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcanoEnd:
b0e505c974ff7b018350f99f32199a52e18ed55bdlezcano-->