lxc-start.sgml.in revision 3114c9824220921bab15cc283907debccde17fa0
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graber<!--
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graber
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graberlxc: linux Container library
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graber
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graber(C) Copyright IBM Corp. 2007, 2008
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graber
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane GraberAuthors:
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane GraberDaniel Lezcano <dlezcano at fr.ibm.com>
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graber
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane GraberThis library is free software; you can redistribute it and/or
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Grabermodify it under the terms of the GNU Lesser General Public
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane GraberLicense as published by the Free Software Foundation; either
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graberversion 2.1 of the License, or (at your option) any later version.
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graber
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane GraberThis library is distributed in the hope that it will be useful,
71d3a6590fe665421d7a0026d699b0654ddfc7f6Stéphane Graberbut 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 "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!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-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</command>
<arg choice="req">-n <replaceable>name</replaceable></arg>
<arg choice="opt">-f <replaceable>config_file</replaceable></arg>
<arg choice="opt">-c <replaceable>console_file</replaceable></arg>
<arg choice="opt">-d</arg>
<arg choice="opt">-p <replaceable>pid_file</replaceable></arg>
<arg choice="opt">-s KEY=VAL</arg>
<arg choice="opt">-C</arg>
<arg choice="opt">command</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>lxc-start</command> runs the specified
<replaceable>command</replaceable> inside the container
specified by <replaceable>name</replaceable>.
</para>
<para>
It will setup the container
according to the configuration previously defined with the
lxc-create command or with the configuration file parameter.
If no configuration is
defined, the default isolation is used.
</para>
<para>
The orphan process group
and daemon are not supported by this command, use
the <command>lxc-execute</command> command instead.
</para>
<para>
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>-d, --daemon</option>
</term>
<listitem>
<para>
Run the container as a daemon. As the container has no
more tty, if an error occurs nothing will be displayed,
the log file can be used to check the error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-p, --pidfile <replaceable>pid_file</replaceable></option>
</term>
<listitem>
<para>
Create a file with the process id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-f, --rcfile <replaceable>config_file</replaceable></option>
</term>
<listitem>
<para>
Specify the configuration file to configure the virtualization
and isolation functionalities for the container.
</para>
<para>
This configuration file if present will be used even if there is
already a configuration file present in the previously created
container (via lxc-create).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-c,
--console <replaceable>console_file</replaceable></option>
</term>
<listitem>
<para>
Specify a file to output the container console. If the
option is not specified the output will go the terminal
except if the <option>-d</option> is specified.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-s, --define <replaceable>KEY=VAL</replaceable></option>
</term>
<listitem>
<para>
Assign value <replaceable>VAL</replaceable> to configuration
variable <replaceable>KEY</replaceable>. This overrides any
assignment done in <replaceable>config_file</replaceable>.
</para>
</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>
&commonoptions;
<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>
&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:
-->