mirror of
https://git.proxmox.com/git/mirror_lxc
synced 2025-06-13 08:51:45 +00:00
7f95145833
Commit 69fe23ff added checking for the older docbook2man back into
configure, but this breaks building the docs on at least Oracle Linux and
Fedora when docbook2X is not installed as docbook2man will be found but the
docs don't actually build with that tool.
This change makes it so the docs can be built with either the older
docbook2man or the newer 2X tools by using configure to set the dtd
string to an appropriate value depending on use of docbook2man or
db2x_docbook2man.
Also fixed a small error in lxc-destroy.sgml.in that was noticed
by the old tools.
Signed-off-by: Dwight Engen <dwight.engen@oracle.com>
Signed-off-by: Serge Hallyn <serge.hallyn@ubuntu.com>
216 lines
6.4 KiB
Plaintext
216 lines
6.4 KiB
Plaintext
<!--
|
|
|
|
lxc: linux Container library
|
|
|
|
(C) Copyright IBM Corp. 2007, 2008
|
|
|
|
Authors:
|
|
Daniel Lezcano <daniel.lezcano at free.fr>
|
|
|
|
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 @docdtd@ [
|
|
|
|
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
|
|
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
|
|
]>
|
|
|
|
<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</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="opt">-B <replaceable>backingstore</replaceable></arg>
|
|
<arg choice="opt">-- <replaceable>template-options</replaceable></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para>
|
|
<command>lxc-create</command> creates a system object where is
|
|
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>
|
|
The object is a directory created in <filename>@LXCPATH@</filename>
|
|
and identified by its name.
|
|
</para>
|
|
|
|
<para>
|
|
The 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>-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>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<option>-t <replaceable>template</replaceable></option>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
'template' is the short name of an existing 'lxc-template'
|
|
script that is called by lxc-create,
|
|
eg. busybox, debian, fedora, ubuntu or sshd.
|
|
Refer to the examples in <filename>@LXCTEMPLATEDIR@</filename>
|
|
for details of the expected script structure.
|
|
Alternatively, the full path to an executable template script
|
|
can also be passed as a parameter.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<option>-B <replaceable>backingstore</replaceable></option>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
'backingstore' is one of 'none', 'dir', 'lvm', or 'btrfs'. The
|
|
default is 'none', 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
|
|
<replaceable>--dir ROOTFS</replaceable> to be specified, meaning
|
|
that the container rootfs should be placed under the specified path,
|
|
rather than the default.
|
|
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>
|
|
|
|
<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>
|
|
|
|
<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>
|
|
|
|
&seealso;
|
|
|
|
<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:
|
|
-->
|