aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichel Normand <normand@fr.ibm.com>2010-04-29 10:03:59 +0200
committerDaniel Lezcano <dlezcano@fr.ibm.com>2010-04-29 10:03:59 +0200
commit94b81f611fde1efdda844171d7b0d1f2d8f86ce6 (patch)
tree4cee87dba38e1f94c97fd95fa6fb0a6df5bc9e4a /doc
parentman update lxc (diff)
downloadlxc-94b81f611fde1efdda844171d7b0d1f2d8f86ce6.tar.gz
lxc-94b81f611fde1efdda844171d7b0d1f2d8f86ce6.tar.bz2
lxc-94b81f611fde1efdda844171d7b0d1f2d8f86ce6.zip
man update lxc-execute and lxc-start (V2)
Signed-off-by: Michel Normand <normand@fr.ibm.com> Signed-off-by: Daniel Lezcano <dlezcano@fr.ibm.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/lxc-execute.sgml.in41
-rw-r--r--doc/lxc-start.sgml.in37
2 files changed, 46 insertions, 32 deletions
diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in
index 46d0d1a..fe51b9b 100644
--- a/doc/lxc-execute.sgml.in
+++ b/doc/lxc-execute.sgml.in
@@ -60,20 +60,32 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<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.
+ <command>lxc-execute</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>
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.
+ application in an isolated environment.
</para>
-
+ <para>
+ <command>lxc-execute</command> command will run the
+ specified command into the container via an intermediate
+ process, <command>lxc-init</command>.
+ This lxc-init after launching the specified command,
+ will wait for its end and all other reparented processes.
+ (that allows to support daemons in the container).
+ In other words, in the
+ container, <command>lxc-init</command> has the pid 1 and the
+ first process of the application has the pid 2.
+ </para>
</refsect1>
<refsect1>
@@ -82,18 +94,23 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry>
<term>
- <option>-f <replaceable>config_file</replaceable></option>
+ <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>-s <replaceable>KEY=VAL</replaceable></option>
+ <option>-s, --define <replaceable>KEY=VAL</replaceable></option>
</term>
<listitem>
<para>
diff --git a/doc/lxc-start.sgml.in b/doc/lxc-start.sgml.in
index 5bb34cd..24e467a 100644
--- a/doc/lxc-start.sgml.in
+++ b/doc/lxc-start.sgml.in
@@ -57,20 +57,27 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<title>Description</title>
<para>
- <command>lxc-start</command> runs the specified command inside
- the container specified by name. It will setup the container
- according the configuration previously defined with the
- lxc-create command or with the configuration file parameter and
- execute the command inside the container. If no configuration is
- defined, the default isolation is used. The orphan process group
+ <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>
@@ -96,7 +103,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry>
<term>
- <option>-f <replaceable>config_file</replaceable></option>
+ <option>-f, --rcfile <replaceable>config_file</replaceable></option>
</term>
<listitem>
<para>
@@ -108,7 +115,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry>
<term>
- <option>-s <replaceable>KEY=VAL</replaceable></option>
+ <option>-s, --define <replaceable>KEY=VAL</replaceable></option>
</term>
<listitem>
<para>
@@ -141,16 +148,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</listitem>
</varlistentry>
- <varlistentry>
- <term>The container was not found</term>
- <listitem>
- <para>
- The specified container was not created before with
- the <command>lxc-create</command>
- </para>
- </listitem>
- </varlistentry>
-
</variablelist>
</refsect1>