spelling: control

[mirror_lxc.git] / doc / lxc-create.sgml.in

diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in
index b9537466883129a459e3e08c0841a1b440d6b64b..1e97c40b15dcde396b793aff0d2c51bf37483c67 100644 (file)
--- a/doc/lxc-create.sgml.in
+++ b/doc/lxc-create.sgml.in
@@ -51,7 +51,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       <command>lxc-create</command>
       <arg choice="req">-n <replaceable>name</replaceable></arg>
       <arg choice="opt">-f <replaceable>config_file</replaceable></arg>
-      <arg choice="opt">-t <replaceable>template</replaceable></arg>
+      <arg choice="req">-t <replaceable>template</replaceable></arg>
       <arg choice="opt">-B <replaceable>backingstore</replaceable></arg>
       <arg choice="opt">-- <replaceable>template-options</replaceable></arg>
     </cmdsynopsis>
@@ -92,7 +92,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
        <term>
-         <option>-f <replaceable>config_file</replaceable></option>
+         <option>-f, --config <replaceable>config_file</replaceable></option>
        </term>
        <listitem>
          <para>
@@ -104,7 +104,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
        <term>
-         <option>-t <replaceable>template</replaceable></option>
+         <option>-t, --template <replaceable>template</replaceable></option>
        </term>
        <listitem>
          <para>
@@ -115,23 +115,25 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
            for details of the expected script structure.
            Alternatively, the full path to an executable template script
            can also be passed as a parameter.
+           "none" can be used to force lxc-create to skip rootfs creation.
          </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>
-         <option>-B <replaceable>backingstore</replaceable></option>
+         <option>-B, --bdev <replaceable>backingstore</replaceable></option>
        </term>
        <listitem>
          <para>
-           'backingstore' is one of 'none', 'dir', 'lvm', 'loop', or 'btrfs'.  The
-           default is 'none', meaning that the container root filesystem
+           'backingstore' is one of 'dir', 'lvm', 'loop', 'btrfs', 'zfs', 'rbd', or 'best'.  The
+           default is 'dir', meaning that the container root filesystem
            will be a directory under <filename>@LXCPATH@/container/rootfs</filename>.
-           'dir' has the same meaning as 'none', but also allows the optional
+           This backing store type allows the optional
            <replaceable>--dir ROOTFS</replaceable> to be specified, meaning
            that the container rootfs should be placed under the specified path,
-           rather than the default.  If 'btrfs' is specified, then the
+           rather than the default.  (The 'none' backingstore type is an alias for
+           'dir'.)  If 'btrfs' is specified, then the
            target filesystem must be btrfs, and the container rootfs will be
            created as a new subvolume.  This allows snapshotted clones to be
            created, but also causes rsync --one-filesystem to treat it as a
@@ -152,6 +154,19 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
            <replaceable>--fssize SIZE</replaceable> will create a LV (and
            filesystem) of size SIZE rather than the default, which is 1G.
          </para>
+         <para>
+           If backingstore is 'loop', you can use <replaceable>--fstype FSTYPE</replaceable> and <replaceable>--fssize SIZE</replaceable> as 'lvm'. The default values for these options are the same as 'lvm'.
+         </para>
+         <para>
+           If backingstore is 'rbd', then you will need to have a valid configuration in <filename>ceph.conf</filename> and a <filename>ceph.client.admin.keyring</filename> defined.
+           You can specify the following options :
+           <replaceable>--rbdname RBDNAME</replaceable> will create a blockdevice named RBDNAME rather than the default, which is the container name.
+           <replaceable>--rbdpool POOL</replaceable> will create the blockdevice in the pool named POOL, rather than the default, which is 'lxc'.
+         </para>
+         <para>
+           If backingstore is 'best', then lxc will try, in order, btrfs,
+           zfs, lvm, and finally a directory backing store.
+         </para>
        </listitem>
       </varlistentry>
 
@@ -173,6 +188,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Diagnostic</title>
 
@@ -184,7 +201,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
           <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
+           the <command>lxc-ls</command> command to list the
            available containers on the system.
           </para>
         </listitem>