]> git.ipfire.org Git - thirdparty/lxc.git/commitdiff
update the man pages
authorDaniel Lezcano <daniel.lezcano@free.fr>
Fri, 20 Nov 2009 14:01:30 +0000 (15:01 +0100)
committerDaniel Lezcano <dlezcano@fr.ibm.com>
Fri, 20 Nov 2009 14:01:30 +0000 (15:01 +0100)
Update the man pages regarding the different modifications.

Signed-off-by: Daniel Lezcano <dlezcano@fr.ibm.com>
doc/lxc-create.sgml.in
doc/lxc-destroy.sgml.in
doc/lxc-start.sgml.in
doc/lxc.sgml.in

index 343f310cf71e1ca142761ff816b96a225dd60a71..ccc2b011394f3da2715cbd600f249b34a43733b1 100644 (file)
@@ -58,11 +58,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
     <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.
+      stored the configuration informations and where can be stored
+      user information. The identifier <replaceable>name</replaceable>
+      is used to specify the container to be used with the different
+      lxc commands.
     </para>
 
     <para>
@@ -99,8 +98,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
-  &commonoptions;
-
   <refsect1>
     <title>Diagnostic</title>
 
index f8c063ac43dba9a0cae1e8c637c42045379485d6..841755b73594f61f68c6e9f4e6f21f38493956ca 100644 (file)
@@ -48,8 +48,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>lxc-destroy <replaceable>-n name</replaceable>
-      </command>
+      <command>lxc-destroy <replaceable>-n
+      name</replaceable></command>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -57,15 +57,14 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <title>Description</title>
 
     <para>
-      <command>lxc-destroy</command> destroys the system container
-      object. After the destruction the container is no longer
+      <command>lxc-destroy</command> destroys the directory where is
+      stored the configuration and all the data contained in this
+      directory. After the destruction the container is no longer
       available and should be recreated.
     </para>
 
   </refsect1>
 
-  &commonoptions;
-
   <refsect1>
     <title>Diagnostic</title>
 
@@ -83,17 +82,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
         </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>
index fdf64c500e786c6d333aa847473b414a35c59dcd..827b589993e692def47ee9c0ef7835a9ee3f2cad 100644 (file)
@@ -47,11 +47,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
   </refnamediv>
 
   <refsynopsisdiv>
-    <cmdsynopsis>
-      <command>lxc-start <replaceable>-n name</replaceable>
-       <optional>command</optional>
-      </command>
-    </cmdsynopsis>
+    <cmdsynopsis><command>lxc-start <replaceable>-n
+    name</replaceable> <optional>-f
+    config_file</optional> <optional>command</optional></command></cmdsynopsis>
   </refsynopsisdiv>
 
   <refsect1>
@@ -63,8 +61,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       according the configuration previously defined with the
       lxc-create command or with the configuration file parameter and
       execute the command inside the container. If no configuration is
-      defined, the default isolation is used. The orphan process
-      group and daemon are not supported by this command.
+      defined, the default isolation is used. The orphan process group
+      and daemon are not supported by this command, use
+      the <command>lxc-execute</command> command instead.
       
       If no command is specified, <command>lxc-start</command> will
       use the default
index 8f08ef7f7ab739610f05a38c6c0e419e238b0e11..33d6845ff31bfad226dff899ccb58978075f51ee 100644 (file)
@@ -58,9 +58,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       without warranty, here are the commands to launch a shell inside
       a container with a predefined configuration template, it may
       work.
-      <command>
-       @BINDIR@/lxc-execute -n foo -f @DOCDIR@/examples/lxc-macvlan.conf /bin/bash
-      </command>
+      <command>@BINDIR@/lxc-execute -n foo -f
+      @DOCDIR@/examples/lxc-macvlan.conf /bin/bash</command>
     </para>
   </refsect1>
 
@@ -121,6 +120,15 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
                -> User namespace
                -> Pid namespace
                -> Network namespace
+           * Device Drivers
+             * Character devices
+               -> Support multiple instances of devpts
+             * Network device support
+               -> MAC-VLAN support
+               -> Virtual ethernet pair device
+           * Networking
+             * Networking options
+               -> 802.1d Ethernet Bridging
            * Security options
              -> File POSIX Capabilities
       </programlisting>
@@ -133,6 +141,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
        With the kernel 2.6.29, <command>lxc</command> is fully
        functional.
+
+       The helper script <command>lxc-checkconfig</command> will give
+       you information about your kernel configuration.
       </para>
 
       <para>
@@ -164,7 +175,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       A container is an object where the configuration is
       persistent. The application will be launched inside this
       container and it will use the configuration which was previously
-      created.
+      created or specified in parameter of the command.
     </para>
 
     <para>How to run an application in a container ?</para>
@@ -295,6 +306,13 @@ rootfs
       </programlisting>
     </refsect2>
 
+    <refsect2>
+      <title>Volatile containers</title>
+      <para>The container can be directly started with a
+       configuration file in parameter without creating them before.
+      </para>
+    </refsect2>
+
     <refsect2>
       <title>Configuration</title>
       <para>The container is configured through a configuration
@@ -325,9 +343,12 @@ rootfs
     <refsect2>
       <title>Starting / Stopping a container</title>
       <para>When the container has been created, it is ready to run an
-      application / system. When the application has to be destroyed
+      application / system. When the application has to be destroyed,
       the container can be stopped, that will kill all the processes
-      of the container.</para>
+      of the container. If the container was not created before
+      starting the application, the container will use the
+      configuration file passed as parameter to the command, otherwise
+      it will use the default isolation.</para>
       
       <para>
        Running an application inside a container is not exactly the