]> git.ipfire.org Git - thirdparty/lxc.git/commitdiff
Update manpages to reflect some updated options.
authorSerge Hallyn <serge.hallyn@canonical.com>
Sun, 18 Mar 2012 23:31:40 +0000 (00:31 +0100)
committerDaniel Lezcano <daniel.lezcano@free.fr>
Sun, 18 Mar 2012 23:31:40 +0000 (00:31 +0100)
(which reminds me a lxc-clone manpage still needs to be written)

Signed-off-by: Serge Hallyn <serge.hallyn@ubuntu.com>
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.conf.sgml.in

index f3e852428c990002d7f4da38cea40cebf98b50b1..a3cca83f0240e9a3f394b1d46035b48f2f02fa2b 100644 (file)
@@ -50,7 +50,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <cmdsynopsis>
       <command>lxc-create <replaceable>-n name</replaceable>
        <optional>-f config_file</optional>
-       <optional>-t template</optional></command>
+       <optional>-t template</optional>
+       <optional>-B backingstore</optional>
+       <optional>-- template-options</optional>
+       </command>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -114,6 +117,45 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>
+         <option>-B <replaceable>backingstore</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           'backingstore' is one of 'none', 'lvm', or 'btrfs'.  The
+           default is 'none', meaning that the container root filesystem
+           will be a directory under <filename>@LXCPATH@/container/rootfs</filename>.
+           The option 'btrfs' need not be specified as it will be used
+           automatically if the <filename>@LXCPATH@</filename> filesystem is found to
+           be btrfs.  If backingstore is 'lvm', then an lvm block device will be
+           used and the following further options are available:
+           <replaceable>--lvname lvname1</replaceable> will create an LV
+           named <filename>lvname1</filename> rather than the default, which
+           is the container name.  <replaceable>--vgname vgname1</replaceable>
+           will create the LV in volume group <filename>vgname1</filename>
+           rather than the default, <filename>lxc</filename>.
+           <replaceable>--fstype FSTYPE</replaceable> will create an FSTYPE
+           filesystem on the LV, rather than the default, which is ext4.
+           <replaceable>--fssize SIZE</replaceable> will create a LV (and
+           filesystem) of size SIZE rather than the default, which is 1G.
+         </para>
+       </listitem>
+
+      <varlistentry>
+       <term>
+         <option>-- <replaceable>template-options</replaceable></option>
+       </term>
+       <listitem>
+         <para>
+           This will pass <replaceable>template-options</replaceable> to the
+           template as arguments.  To see the list of options supported by
+           the template, you can run
+           <command>lxc-create -t TEMPLATE -h</command>.
+         </para>
+       </listitem>
+      </varlistentry>
+
     </variablelist>
 
   </refsect1>
index eda425cfefa37e4f671764d03421bbdaf5d89ae6..e75de5750120bfe55da262f128f3f0750a25cae7 100644 (file)
@@ -49,7 +49,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>lxc-destroy <replaceable>-n
-      name</replaceable></command>
+      name</replaceable>
+      <optional>-f</optional>
+      </command>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -63,6 +65,27 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  <refsect1>
+
+    <title>Options</title>
+
+    <variablelist>
+      <varlistentry>
+       <term>
+         <option>-f</option>
+       </term>
+       <listitem>
+         <para>
+           If a container is running, stop it first.  If this option is
+           not specified and the container is running, then
+           <command>lxc-destroy</command> will be aborted.
+         </para>
+       </listitem>
+      </varlistentry>
+    </variablelist>
+
+  </refsect1>
+
   <refsect1>
     <title>Diagnostic</title>
 
index 1f6c293176fac536ead0764a04411a62188fa8ea..4504d589093a9ed8edb2ca00e200043c1ff65fe7 100644 (file)
@@ -51,7 +51,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     name</replaceable> <optional>-f
     config_file</optional> <optional>-c
     console_file</optional> <optional>-d</optional> <optional>-s
-    KEY=VAL</optional>
+    KEY=VAL</optional> <optional>-C</optional>
     <optional>command</optional></command></cmdsynopsis>
   </refsynopsisdiv>
 
@@ -147,6 +147,21 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>
+         <option>-C,
+         --close-all-fds</option>
+       </term>
+       <listitem>
+         <para>
+         If any file descriptors are inherited, close them.  If this option
+         is not specified, then <command>lxc-start</command> will exit with
+         failure instead. Note: <replaceable>--daemon</replaceable> implies
+         <replaceable>--close-all-fds</replaceable>.
+         </para>
+       </listitem>
+      </varlistentry>
+
     </variablelist>
 
   </refsect1>
index 532739e9fae52df84072ff6abd62ea79fbdc3328..9edabf83b2de24c2c3ee6cdc58974ff6fa89d50a 100644 (file)
@@ -452,6 +452,35 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       </variablelist>
     </refsect2>
 
+    <refsect2>
+      <title>Console devices location</title>
+      <para>
+        LXC consoles are provided through Unix98 PTYs created on the
+       host and bind-mounted over the expected devices in the container.
+       By default, they are bind-mounted over <filename>/dev/console</filename>
+       and <filename>/dev/ttyN</filename>.  This can prevent package upgrades
+       in the guest.  Therefore you can specify a directory location (under
+       <filename>/dev</filename> under which LXC will create the files and
+       bind-mount over them.  These will then be symbolically linked to
+       <filename>/dev/console</filename> and <filename>/dev/ttyN</filename>.
+       A package upgrade can then succeed as it is able to remove and replace
+       the symbolic links.
+      </para>
+      <variablelist>
+       <varlistentry>
+         <term>
+           <option>lxc.devttydir</option>
+         </term>
+         <listitem>
+           <para>
+             Specify a directory under <filename>/dev</filename>
+             under which to create the container console devices.
+           </para>
+         </listitem>
+       </varlistentry>
+      </variablelist>
+    </refsect2>
+
     <refsect2>
       <title>Mount points</title>
       <para>