]> git.proxmox.com Git - mirror_lxc.git/commitdiff
Added the man.1 pages
authordlezcano <dlezcano>
Tue, 18 Nov 2008 13:45:49 +0000 (13:45 +0000)
committerdlezcano <dlezcano>
Tue, 18 Nov 2008 13:45:49 +0000 (13:45 +0000)
From: Daniel Lezcano <dlezcano@fr.ibm.com>

Added the different man pages for the lxc commands. The generation of the
man pages relies on the docbook tool.

Signed-off-by: Daniel Lezcano <dlezcano@fr.ibm.com>
15 files changed:
Makefile.am
configure.in
doc/lxc-create.sgml.in [new file with mode: 0644]
doc/lxc-destroy.sgml.in [new file with mode: 0644]
doc/lxc-execute.sgml.in [new file with mode: 0644]
doc/lxc-freeze.sgml.in [new file with mode: 0644]
doc/lxc-ls.sgml.in [new file with mode: 0644]
doc/lxc-monitor.sgml.in [new file with mode: 0644]
doc/lxc-ps.sgml.in [new file with mode: 0644]
doc/lxc-start.sgml.in [new file with mode: 0644]
doc/lxc-stop.sgml.in [new file with mode: 0644]
doc/lxc-unfreeze.sgml.in [new file with mode: 0644]
doc/lxc-wait.sgml.in [new file with mode: 0644]
lxc.spec.in
src/lxc/lxc-ls.in

index 43edcfc241d8aaa85d7a9df955ff503357e9cd97..7188153161ee19f8b587373398899d1e90112e6a 100644 (file)
@@ -1,7 +1,7 @@
 # Makefile.am
 
-SUBDIRS = src test etc
-DIST_SUBDIRS = config src test etc
+SUBDIRS = doc src test etc
+DIST_SUBDIRS = config doc src test etc
 EXTRA_DIST = lxc.spec CONTRIBUTING MAINTAINERS
 
 ChangeLog::
index 7a187f22a9923b670a1b02d641bf5e2eaea672f9..52e6cb32ff597694680377b4d8bbf42205102483 100644 (file)
@@ -41,9 +41,24 @@ AC_CONFIG_FILES([
         Makefile
        lxc.spec
         config/Makefile
+
+        doc/Makefile
+       doc/lxc-create.sgml
+       doc/lxc-destroy.sgml
+       doc/lxc-execute.sgml
+       doc/lxc-start.sgml
+       doc/lxc-stop.sgml
+       doc/lxc-freeze.sgml
+       doc/lxc-unfreeze.sgml
+       doc/lxc-monitor.sgml
+       doc/lxc-wait.sgml
+       doc/lxc-ls.sgml
+       doc/lxc-ps.sgml
+
         src/Makefile
        src/lxc/Makefile
        src/lxc/lxc-ps
+       src/lxc/lxc-ls
        src/lxc/lxc-checkconfig 
        etc/Makefile
        etc/lxc-macvlan.conf
diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in
new file mode 100644 (file)
index 0000000..f4022f2
--- /dev/null
@@ -0,0 +1,175 @@
+<!-- 
+
+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-create</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-create</refname>
+
+    <refpurpose>
+      creates a container
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-create <replaceable>-n name</replaceable>
+       <optional>-f config_file</optional></command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-create</command> creates a system object where is
+      stored the configuration informations and where will be stored
+      runtime information. The
+      identifier <replaceable>name</replaceable> is used to
+      specify the container to be used with the different lxc
+      commands.
+    </para>
+
+    <para>
+      This object is the definition of the different resources an
+      application can use or can see. The more the configuration file
+      contains informations, the more the container is isolated and
+      the more the application is jailed.
+    </para>
+
+    <para>
+      If the configuration file <replaceable>config_file</replaceable>
+      is not specified, the container will be created with the default
+      isolation: processes, sysv ipc and mount points.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be created.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+         <option>-f <replaceable>config_file</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the configuration file to configure the virtualization
+           and isolation functionalities for the container.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container already exists</term>
+        <listitem>
+          <para>
+           As the message mention it, you try to create a container
+           but there is a container with the same name. You can use
+           the <command>lxc-ls -l</command> command to list the
+           available containers on the system.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc-destroy</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-execute</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <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:
+-->
diff --git a/doc/lxc-destroy.sgml.in b/doc/lxc-destroy.sgml.in
new file mode 100644 (file)
index 0000000..4d540d8
--- /dev/null
@@ -0,0 +1,154 @@
+<!-- 
+
+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-destroy</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-destroy</refname>
+
+    <refpurpose>
+      destroy a container.
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-destroy <replaceable>-n name</replaceable>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-destroy</command> destroys the system container
+      object. After the destruction the container is no longer
+      available and should be recreated.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be destroyed.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The specified container for destruction was not found. It
+           is probable it does not exists and was already
+           destroyed.You can use the <command>lxc-ls -l</command>
+           command to list the available containers on the system.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+      <varlistentry>
+        <term>The container is busy</term>
+        <listitem>
+          <para>
+           The specified container is running an application. At this
+           point it is not destroyable, and it should be stopped
+           before trying to destroy it.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc-create</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-stop</command></refentrytitle>
+       <manvolnum>1</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:
+-->
diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in
new file mode 100644 (file)
index 0000000..c14ed72
--- /dev/null
@@ -0,0 +1,192 @@
+<!-- 
+
+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-execute</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-execute</refname>
+
+    <refpurpose>
+      run an application inside a container.
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-execute <replaceable>-n name</replaceable>
+       <optional>-f config_file</optional>
+       <replaceable>command</replaceable>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-execute</command> runs
+      the <replaceable>command</replaceable> inside the container
+      specified by <replaceable>name</replaceable>. This command
+      should be used to launch an application, eg. sshd or bash.
+    </para>
+
+    <para>
+      If the container does not exist, it is automatically created and
+      destroyed at the end. The command can use the configuration file
+      to create itself the container
+      like <command>lxc-create</command> would do and will destroy the
+      container when the application exits. If the container was
+      previously created with the lxc-create command, when the
+      application exits, the container is not destroyed and it can be
+      reused later.
+    </para>
+
+    <para>
+      This command is mainly used when you want to quickly launch an
+      application in an isolated environment. It will create an
+      intermediate process allowing you application to daemonize in
+      the pid namespace and will mount the proc filesystem to complete
+      the pid isolation.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be executed.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+         <option>-f <replaceable>config_file</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the configuration file to configure the virtualization
+           and isolation functionalities for the container.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container is busy</term>
+        <listitem>
+          <para>
+           The specified container is already running an
+           application. You should stop it before reuse this
+           container or create a new one.
+          </para>
+        </listitem>
+      </varlistentry>   
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc-create</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-destroy</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-start</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-stop</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <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:
+-->
diff --git a/doc/lxc-freeze.sgml.in b/doc/lxc-freeze.sgml.in
new file mode 100644 (file)
index 0000000..45bc9d8
--- /dev/null
@@ -0,0 +1,139 @@
+<!-- 
+
+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-freeze</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-freeze</refname>
+
+    <refpurpose>
+      freeze all the container's processes
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-freeze <replaceable>-n name</replaceable>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-freeze</command> freeze all the processes running
+      inside the container. The processes will be blocked until they
+      are explicitly thawed by the <command>lxc-unfreeze</command>
+      command. This command is useful for batch managers to schedule a
+      group of processes.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be frozen.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The specified container was not created before with
+           the <command>lxc-create</command> command.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc-unfreeze</command></refentrytitle>
+       <manvolnum>1</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:
+-->
diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in
new file mode 100644 (file)
index 0000000..1fea453
--- /dev/null
@@ -0,0 +1,140 @@
+
+<!-- 
+
+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-ls</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-ls</refname>
+
+    <refpurpose>
+      list the containers existing on the system
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-ls <optional>ls option</optional>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      <command>lxc-ls</command> list the containers existing on the
+      system.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option><optional>ls options</optional></option>
+       </term>
+       <listitem>
+         <para>
+           The option passed to <command>lxc-ls</command> are the
+           same as the <command>ls</command> command.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <variablelist>
+      <varlistentry>
+       <term>lxc-ls -l</term>
+       <listitem>
+       <para>
+         list all the container and their permissions.
+       </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>lxc-ls -1</term>
+       <listitem>
+       <para>
+         list all the containers and display the list in one column.
+       </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle>ls</refentrytitle>
+       <manvolnum>1</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:
+-->
diff --git a/doc/lxc-monitor.sgml.in b/doc/lxc-monitor.sgml.in
new file mode 100644 (file)
index 0000000..35df190
--- /dev/null
@@ -0,0 +1,182 @@
+<!-- 
+
+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-monitor</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-monitor</refname>
+
+    <refpurpose>
+      monitor the container state
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-monitor <replaceable>-n name</replaceable>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-monitor</command> monitors the state of the
+      specified containers. The <replaceable>name</replaceable> can be
+      a regular expression, conforming with posix2, so it is possible
+      to monitor all the containers, several of them or just one.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be monitored. This option
+           can be a regular expression conforming POSIX2.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <variablelist>
+      <varlistentry>
+       <term>lxc-monitor -n foo</term>
+       <listitem>
+       <para>
+         will monitor the different states for container foo.
+       </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>lxc-monitor -n 'foo|bar'</term>
+       <listitem>
+       <para>
+         will monitor the different states for container foo and bar.
+       </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>lxc-monitor -n '[f|b].*'</term>
+       <listitem>
+       <para>
+         will monitor the different states for container with the
+         name beginning with letter 'f' or 'b'.
+       </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>lxc-monitor -n '.*'</term>
+       <listitem>
+       <para>
+         will monitor the different states for all containers.
+       </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The specified container was not created before with
+           the <command>lxc-create</command> command.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle>regex</refentrytitle>
+       <manvolnum>7</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:
+-->
diff --git a/doc/lxc-ps.sgml.in b/doc/lxc-ps.sgml.in
new file mode 100644 (file)
index 0000000..ce0c4fa
--- /dev/null
@@ -0,0 +1,154 @@
+
+<!-- 
+
+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-ps</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-ps</refname>
+
+    <refpurpose>
+      list the processes belonging to a specific container.
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-ps <replaceable>-n name</replaceable>
+       <optional>ps option</optional>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      <command>lxc-ps</command> list the processes belonging to a
+      specific container.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option><replaceable>-n name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           specify the container <replaceable>name</replaceable> to
+           list the processes.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+         <option><optional>ps options</optional></option>
+       </term>
+       <listitem>
+         <para>
+           The option passed to <command>lxc-ps</command> are the
+           same as the <command>ps</command> command.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <variablelist>
+      <varlistentry>
+       <term>lxc-ps -n foo --forest</term>
+       <listitem>
+       <para>
+         list all the processes belonging to container 'foo' and show
+         dependencies.
+       </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>lxc-ps -n foo -o pid=</term>
+       <listitem>
+       <para>
+         list all the containers and display the list in one column.
+       </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle>ps</refentrytitle>
+       <manvolnum>1</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:
+-->
diff --git a/doc/lxc-start.sgml.in b/doc/lxc-start.sgml.in
new file mode 100644 (file)
index 0000000..e536450
--- /dev/null
@@ -0,0 +1,179 @@
+<!-- 
+
+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-start</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-start</refname>
+
+    <refpurpose>
+      run an application inside a container.
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-start <replaceable>-n name</replaceable>
+       <optional>command</optional>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-start</command> runs the specified command inside
+      the container specified by name. It will setup the container
+      according with the configuration defined previously with the
+      lxc-create command and execute the command inside the
+      container. The orphan process group and daemon are not supported
+      by this command.
+      
+      If no command is specified, <command>lxc-start</command> will
+      use the default
+      <command>"/sbin/init"</command> command to run a system
+      container.
+      
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be started.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container is busy</term>
+        <listitem>
+          <para>
+           The specified container is already running an
+           application. You should stop it before reuse this
+           container or create a new one.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The specified container was not created before with
+           the <command>lxc-create</command>
+          </para>
+        </listitem>
+      </varlistentry>    
+
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc-create</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-destroy</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-start</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+       <refentrytitle><command>lxc-stop</command></refentrytitle>
+       <manvolnum>1</manvolnum>
+      </citerefentry>,
+
+      <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:
+-->
diff --git a/doc/lxc-stop.sgml.in b/doc/lxc-stop.sgml.in
new file mode 100644 (file)
index 0000000..31e4b96
--- /dev/null
@@ -0,0 +1,148 @@
+<!-- 
+
+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-stop</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-stop</refname>
+
+    <refpurpose>
+      stop the application running inside a container
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-stop <replaceable>-n name</replaceable>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-stop</command> kills all the processes inside the
+      container. This command should be used if the processes are no
+      longer accessible and can no be exited normally.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be stopped.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container is busy</term>
+        <listitem>
+          <para>
+           The specified container is already running an
+           application. You should stop it before reuse this
+           container or create a new one.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The specified container was not created before with
+           the <command>lxc-create</command> command.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc-start</command></refentrytitle>
+       <manvolnum>1</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:
+-->
diff --git a/doc/lxc-unfreeze.sgml.in b/doc/lxc-unfreeze.sgml.in
new file mode 100644 (file)
index 0000000..1e36fdf
--- /dev/null
@@ -0,0 +1,136 @@
+<!-- 
+
+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-unfreeze</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-unfreeze</refname>
+
+    <refpurpose>
+      thaw all the container's processes
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-unfreeze <replaceable>-n name</replaceable>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>lxc-unfreeze</command> will thaw all the processes
+      previously frozen by the <command>lxc-freeze</command> command.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be frozen.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The specified container was not created before with
+           the <command>lxc-create</command> command.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle><command>lxc-unfreeze</command></refentrytitle>
+       <manvolnum>1</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:
+-->
diff --git a/doc/lxc-wait.sgml.in b/doc/lxc-wait.sgml.in
new file mode 100644 (file)
index 0000000..dc6d1e5
--- /dev/null
@@ -0,0 +1,172 @@
+
+<!-- 
+
+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-wait</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>lxc-wait</refname>
+
+    <refpurpose>
+      wait for a specific container state
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lxc-wait <replaceable>-n name</replaceable>
+       <replaceable>-s states</replaceable>
+      </command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      <command>lxc-wait</command> waits for a specific container state
+      before exiting, this is useful for scripting.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+
+      <varlistentry>
+       <term>
+         <option>-n <replaceable>name</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container name to be waited.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+         <option>-s <replaceable>states</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           Specify the container state(s) to wait for. The container
+           states can be ORed to specify several states.
+         </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <variablelist>
+      <varlistentry>
+       <term>lxc-wait -n foo -s RUNNING</term>
+       <listitem>
+       <para>
+         exits when 'RUNNING' is reached.
+       </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>lxc-wait -n 'RUNNING|STOPPED'</term>
+       <listitem>
+       <para>
+         exits when 'RUNNING' or 'STOPPED' state is reached.
+       </para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Diagnostic</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>The container was not found</term>
+        <listitem>
+          <para>
+           The specified container was not created before with
+           the <command>lxc-create</command> command.
+          </para>
+        </listitem>
+      </varlistentry>    
+
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simpara>    
+      <citerefentry>
+       <refentrytitle>lxc-info</refentrytitle>
+       <manvolnum>1</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:
+-->
index 96dfcfba92ff7735d1df86522f3e65977bf36433..3df8b7d931299456e54c030e651075097a08278d 100644 (file)
@@ -135,6 +135,7 @@ fi
 %{_sysconfdir}/%{name}/*
 %{_libdir}/*.so*
 %{_bindir}/*
+%{_mandir}/*
 
 %files devel
 %defattr(-,root,root)
index f7dd15dd3d714f3428ebbd3e65a43ab2a0c45afa..5809ab31ed38501047dbe384efccebfb375422d7 100644 (file)
@@ -6,4 +6,4 @@ if [ ! -r $lxcpath ]; then
     exit 0
 fi
 
-ls -1 $lxcpath
+ls $* $lxcpath