lxc-execute.sgml.in revision 99e4008cad9e959b683c6f48411fcf15a92be3b5
<!--
lxc: linux Container library
(C) Copyright IBM Corp. 2007, 2008
Authors:
Daniel Lezcano <dlezcano at fr.ibm.com>
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 "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>
<refentry>
<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
<refmeta>
<refentrytitle>lxc-execute</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>lxc-execute</refname>
<refpurpose>
run an application inside a container.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>lxc-execute <replaceable>-n name</replaceable>
<optional>-f config_file</optional>
<replaceable>command</replaceable>
</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>lxc-execute</command> runs
the <replaceable>command</replaceable> inside the container
specified by <replaceable>name</replaceable>. This command
should be used to launch an application, eg. sshd or bash.
</para>
<para>
If the container does not exist, it is automatically created and
destroyed at the end. The command can use the configuration file
to create itself the container
like <command>lxc-create</command> would do and will destroy the
container when the application exits. If the container was
previously created with the lxc-create command, when the
application exits, the container is not destroyed and it can be
reused later.
</para>
<para>
This command is mainly used when you want to quickly launch an
application in an isolated environment. It will create an
intermediate process allowing you application to daemonize in
the pid namespace and will mount the proc filesystem to complete
the pid isolation.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be executed.
</para>
</listitem>
</varlistentry>
<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>
</variablelist>
</refsect1>
<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:
-->