This introduces manpages for:
- lxc-checkconfig
- lxc-device
- lxc-info
- lxc-netstat
- lxc-shutdown (wasn't in Makefile)
- lxc-start-ephemeral
- lxc-version
This commit also sorts configure.ac and Makefile.am.
Signed-off-by: Stéphane Graber <stgra...@ubuntu.com>
---
configure.ac | 34 +++---
doc/Makefile.am | 25 +++--
doc/lxc-checkconfig.sgml.in | 98 ++++++++++++++++
doc/lxc-device.sgml.in | 174 +++++++++++++++++++++++++++++
doc/lxc-info.sgml.in | 164 +++++++++++++++++++++++++++
doc/lxc-ls.sgml.in | 2 +
doc/lxc-netstat.sgml.in | 143 ++++++++++++++++++++++++
doc/lxc-ps.sgml.in | 2 +-
doc/lxc-start-ephemeral.sgml.in | 239 ++++++++++++++++++++++++++++++++++++++++
doc/lxc-version.sgml.in | 96 ++++++++++++++++
10 files changed, 954 insertions(+), 23 deletions(-)
create mode 100644 doc/lxc-checkconfig.sgml.in
create mode 100644 doc/lxc-device.sgml.in
create mode 100644 doc/lxc-info.sgml.in
create mode 100644 doc/lxc-netstat.sgml.in
create mode 100644 doc/lxc-start-ephemeral.sgml.in
create mode 100644 doc/lxc-version.sgml.in
diff --git a/configure.ac b/configure.ac
index eb4b714..1dff441 100644
--- a/configure.ac
+++ b/configure.ac
@@ -302,31 +302,39 @@ AC_CONFIG_FILES([
config/Makefile
doc/Makefile
+ doc/legacy/lxc-ls.sgml
+ doc/lxc-attach.sgml
+ doc/lxc-cgroup.sgml
+ doc/lxc-checkconfig.sgml
+ doc/lxc-checkpoint.sgml
doc/lxc-clone.sgml
+ doc/lxc-console.sgml
doc/lxc-create.sgml
doc/lxc-destroy.sgml
+ doc/lxc-device.sgml
doc/lxc-execute.sgml
- doc/lxc-start.sgml
- doc/lxc-checkpoint.sgml
- doc/lxc-restart.sgml
- doc/lxc-stop.sgml
- doc/lxc-console.sgml
doc/lxc-freeze.sgml
- doc/lxc-unfreeze.sgml
- doc/lxc-monitor.sgml
- doc/lxc-wait.sgml
+ doc/lxc-info.sgml
+ doc/lxc-kill.sgml
doc/lxc-ls.sgml
+ doc/lxc-monitor.sgml
+ doc/lxc-netstat.sgml
doc/lxc-ps.sgml
+ doc/lxc-restart.sgml
+ doc/lxc-shutdown.sgml
+ doc/lxc-start-ephemeral.sgml
+ doc/lxc-start.sgml
+ doc/lxc-stop.sgml
doc/lxc-top.sgml
- doc/lxc-cgroup.sgml
- doc/lxc-kill.sgml
- doc/lxc-attach.sgml
+ doc/lxc-unfreeze.sgml
+ doc/lxc-unshare.sgml
+ doc/lxc-version.sgml
+ doc/lxc-wait.sgml
+
doc/lxc.conf.sgml
doc/lxc.sgml
doc/common_options.sgml
doc/see_also.sgml
- doc/legacy/lxc-ls.sgml
- doc/lxc-unshare.sgml
doc/rootfs/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 750398c..df5ad73 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -7,31 +7,38 @@ EXTRA_DIST = \
if ENABLE_DOCBOOK
man_MANS = \
+ lxc-attach.1 \
+ lxc-cgroup.1 \
+ lxc-checkconfig.1 \
+ lxc-checkpoint.1 \
lxc-clone.1 \
+ lxc-console.1 \
lxc-create.1 \
lxc-destroy.1 \
lxc-execute.1 \
+ lxc-freeze.1 \
+ lxc-info.1 \
+ lxc-kill.1 \
+ lxc-monitor.1 \
+ lxc-netstat.1 \
+ lxc-ps.1 \
+ lxc-restart.1 \
+ lxc-shutdown.1 \
lxc-start.1 \
lxc-stop.1 \
- lxc-checkpoint.1 \
- lxc-restart.1 \
- lxc-console.1 \
- lxc-freeze.1 \
lxc-unfreeze.1 \
lxc-unshare.1 \
- lxc-monitor.1 \
+ lxc-version.1 \
lxc-wait.1 \
- lxc-ps.1 \
- lxc-cgroup.1 \
- lxc-kill.1 \
- lxc-attach.1 \
\
lxc.conf.5 \
\
lxc.7
if ENABLE_PYTHON
+ man_MANS += lxc-device.1
man_MANS += lxc-ls.1
+ man_MANS += lxc-start-ephemeral.1
else
man_MANS += legacy/lxc-ls.1
endif
diff --git a/doc/lxc-checkconfig.sgml.in b/doc/lxc-checkconfig.sgml.in
new file mode 100644
index 0000000..ec7a4c1
--- /dev/null
+++ b/doc/lxc-checkconfig.sgml.in
@@ -0,0 +1,98 @@
+<!--
+
+(C) Copyright Canonical Ltd. 2013
+
+Authors:
+Stéphane Graber <stgra...@ubuntu.com>
+
+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 "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+
+<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
+]>
+
+<refentry>
+
+ <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
+
+ <refmeta>
+ <refentrytitle>lxc-checkconfig</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>lxc-checkconfig</refname>
+
+ <refpurpose>
+ check the current kernel for lxc support
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>lxc-checkconfig</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>lxc-checkconfig</command> check the current kernel for
+ lxc support
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Examples</title>
+ <variablelist>
+ <varlistentry>
+ <term>lxc-checkconfig</term>
+ <listitem>
+ <para>
+ check the current kernel.
+ CONFIG can be set in the environment to an alternate location.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ &seealso;
+
+ <refsect1>
+ <title>Author</title>
+ <para>Stéphane Graber <email>stgra...@ubuntu.com</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:
+-->
diff --git a/doc/lxc-device.sgml.in b/doc/lxc-device.sgml.in
new file mode 100644
index 0000000..e777382
--- /dev/null
+++ b/doc/lxc-device.sgml.in
@@ -0,0 +1,174 @@
+
+<!--
+
+(C) Copyright Canonical Ltd. 2013
+
+Authors:
+Stéphane Graber <stgra...@ubuntu.com>
+
+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 "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+
+<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
+]>
+
+<refentry>
+
+ <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
+
+ <refmeta>
+ <refentrytitle>lxc-device</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>lxc-device</refname>
+
+ <refpurpose>
+ manage deices of running containers
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>lxc-device</command>
+ <arg choice="opt">-h</arg>
+ <arg choice="opt">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">add</arg>
+ <arg choice="opt">DEVICE</arg>
+ <arg choice="opt">NAME</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>lxc-device</command> manages devices in running container.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option><optional>-h</optional></option>
+ </term>
+ <listitem>
+ <para>
+ The full command help message.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>-n</option>
+ </term>
+ <listitem>
+ <para>
+ The name of the target container.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>action</option>
+ </term>
+ <listitem>
+ <para>
+ What action to perform. Only 'add' is supported at this point.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>DEVICE</option>
+ </term>
+ <listitem>
+ <para>
+ The device to add to the container.
+ It can either be the path to a device under /dev or a network
+ interface name.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>NAME</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Name for the device within the container.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Examples</title>
+ <variablelist>
+ <varlistentry>
+ <term>lxc-device -n p1 add /dev/video0</term>
+ <listitem>
+ <para>
+ Creates a /dev/video0 device in container p1 based on the matching
+ device on the host.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>lxc-device -n p1 add eth0 eth1</term>
+ <listitem>
+ <para>
+ Moves eth0 from the host as eth1 in p1.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ &seealso;
+
+ <refsect1>
+ <title>Author</title>
+ <para>Stéphane Graber <email>stgra...@ubuntu.com</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:
+-->
diff --git a/doc/lxc-info.sgml.in b/doc/lxc-info.sgml.in
new file mode 100644
index 0000000..03212b0
--- /dev/null
+++ b/doc/lxc-info.sgml.in
@@ -0,0 +1,164 @@
+<!--
+
+(C) Copyright Canonical Ltd. 2013
+
+Authors:
+Stéphane Graber <stgra...@ubuntu.com>
+
+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 "-//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-info</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>lxc-info</refname>
+
+ <refpurpose>
+ query information about a container
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>lxc-info</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="req">-s</arg>
+ <arg choice="req">-p</arg>
+ <arg choice="req">-t <replaceable>state</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>lxc-info</command> queries and shows information about a
+ container.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+
+ <varlistentry>
+ <term>
+ <option>-n <replaceable>name</replaceable></option>
+ </term>
+ <listitem>
+ <para>
+ The container name.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>-s</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Just print the container's state.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>-p</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Just print the container's pid.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>-t
<replaceable>state</replaceable></optional></option>
+ </term>
+ <listitem>
+ <para>
+ Check whether the container is in the provided state.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ &commonoptions;
+
+ <refsect1>
+ <title>Examples</title>
+ <variablelist>
+ <varlistentry>
+ <term>lxc-info -n foo</term>
+ <listitem>
+ <para>
+ Show information for foo.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>lxc-info -n foo -t RUNNING</term>
+ <listitem>
+ <para>
+ exits 0 if foo is RUNNING, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ &seealso;
+
+ <refsect1>
+ <title>Author</title>
+ <para>Stéphane Graber <email>stgra...@ubuntu.com</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:
+-->
diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in
index 75c70be..83618e5 100644
--- a/doc/lxc-ls.sgml.in
+++ b/doc/lxc-ls.sgml.in
@@ -197,6 +197,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
</variablelist>
</refsect1>
+ &seealso;
+
<refsect1>
<title>Author</title>
<para>Stéphane Graber <email>stgra...@ubuntu.com</email></para>
diff --git a/doc/lxc-netstat.sgml.in b/doc/lxc-netstat.sgml.in
new file mode 100644
index 0000000..ab475f3
--- /dev/null
+++ b/doc/lxc-netstat.sgml.in
@@ -0,0 +1,143 @@
+<!--
+
+(C) Copyright Canonical Ltd. 2013
+
+Authors:
+Stéphane Graber <stgra...@ubuntu.com>
+
+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 "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+
+<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
+]>
+
+<refentry>
+
+ <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
+
+ <refmeta>
+ <refentrytitle>lxc-netstat</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>lxc-netstat</refname>
+
+ <refpurpose>
+ run netstat for the specified container
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>lxc-netstat</command>
+ <arg choice="opt">--name <replaceable>name</replaceable></arg>
+ <arg choice="opt">-- netstat option</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>lxc-netstat</command> is a wrapper to the netstat command.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+
+ <varlistentry>
+ <term>
+ <option>-n, --name <replaceable>name</replaceable></option>
+ </term>
+ <listitem>
+ <para>
+ The container name.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>netstat options</optional></option>
+ </term>
+ <listitem>
+ <para>
+ The <command>netstat</command> options must be separated
+ from <command>lxc-netstat</command> options by
+ the <option>--</option> parameter.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Example</title>
+ <variablelist>
+ <varlistentry>
+ <term>lxc-netstat --name foo -- -lnp</term>
+ <listitem>
+ <para>
+ Call netstat -lnp for container foo.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <simpara>
+ <citerefentry>
+ <refentrytitle>netstat</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+ </simpara>
+
+ </refsect1>
+
+ &seealso;
+
+ <refsect1>
+ <title>Author</title>
+ <para>Stéphane Graber <email>stgra...@ubuntu.com</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:
+-->
diff --git a/doc/lxc-ps.sgml.in b/doc/lxc-ps.sgml.in
index fb8e4c7..e266ba8 100644
--- a/doc/lxc-ps.sgml.in
+++ b/doc/lxc-ps.sgml.in
@@ -58,7 +58,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsect1>
<title>Description</title>
<para>
- <command>lxc-ps</command> is a wrapper tp ps command
+ <command>lxc-ps</command> is a wrapper to the ps command
to report the name of lxc container associated
to reported processes.
</para>
diff --git a/doc/lxc-start-ephemeral.sgml.in b/doc/lxc-start-ephemeral.sgml.in
new file mode 100644
index 0000000..b753a9b
--- /dev/null
+++ b/doc/lxc-start-ephemeral.sgml.in
@@ -0,0 +1,239 @@
+
+<!--
+
+(C) Copyright Canonical Ltd. 2013
+
+Authors:
+Stéphane Graber <stgra...@ubuntu.com>
+
+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 "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+
+<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
+]>
+
+<refentry>
+
+ <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
+
+ <refmeta>
+ <refentrytitle>lxc-start-ephemeral</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>lxc-start-ephemeral</refname>
+
+ <refpurpose>
+ start an ephemeral copy of an existing container
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>lxc-start-ephemeral</command>
+ <arg choice="opt">-o</arg>
+ <arg choice="opt">-n</arg>
+ <arg choice="opt">-d</arg>
+ <arg choice="opt">--bdir</arg>
+ <arg choice="opt">--user</arg>
+ <arg choice="opt">--key</arg>
+ <arg choice="opt">--union-type</arg>
+ <arg choice="opt">--keep-data</arg>
+ <arg choice="opt">COMMAND</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>lxc-start-ephemeral</command> start an ephemeral copy of an
+ existing container.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>-o</option>
+ </term>
+ <listitem>
+ <para>
+ Original container name
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>-n</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Name of the ephemeral container (defaults to a random suffix).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>-d</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Start the container in background and print the name and IP.
+ This option can't be used if a command is passed.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>--bdir</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Directory to bind mount into container.
+ Can be passed multiple times.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>--user</optional></option>
+ </term>
+ <listitem>
+ <para>
+ The user to connect to the container as.
+ Used when passing a command to lxc-start-ephemeral.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>--key</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Copy the provided SSH public key into the container.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>--union-type</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Force a specific union file system.
+ Can be one of: overlayfs aufs
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>--keep-data</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Use a persistent backend instead of tmpfs.
+ With this option, you can lxc-stop and lxc-start the no longer so
+ ephemeral container (it's still an overlay, but a persistent one).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option><optional>COMMAND</optional></option>
+ </term>
+ <listitem>
+ <para>
+ Immediately run the provided command in the container.
+ This currently uses ssh (not attach) and is incompatible
+ with daemon mode.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <simpara>
+ <citerefentry>
+ <refentrytitle>lxc-start</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+ </simpara>
+
+ <title>Examples</title>
+ <variablelist>
+ <varlistentry>
+ <term>lxc-start-ephemeral -o p1</term>
+ <listitem>
+ <para>
+ Simply start an ephemeral container and attach to the console.
+ This container will be based on existing container "p1".
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>lxc-start-ephemeral -o p1 -n p1-ephemeral -d</term>
+ <listitem>
+ <para>
+ Start an ephemeral container based on p1 called p1-ephemeral and
+ print its IP and name to the console instead of attaching.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ &seealso;
+
+ <refsect1>
+ <title>Author</title>
+ <para>Stéphane Graber <email>stgra...@ubuntu.com</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:
+-->
diff --git a/doc/lxc-version.sgml.in b/doc/lxc-version.sgml.in
new file mode 100644
index 0000000..3833e9f
--- /dev/null
+++ b/doc/lxc-version.sgml.in
@@ -0,0 +1,96 @@
+<!--
+
+(C) Copyright Canonical Ltd.
+
+Authors:
+Stéphane Graber <stgra...@ubuntu.com>
+
+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 "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+
+<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
+]>
+
+<refentry>
+
+ <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
+
+ <refmeta>
+ <refentrytitle>lxc-version</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>lxc-version</refname>
+
+ <refpurpose>
+ print the currently installed lxc version
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>lxc-version</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>lxc-version</command> print the currently installed lxc version
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Examples</title>
+ <variablelist>
+ <varlistentry>
+ <term>lxc-version</term>
+ <listitem>
+ <para>
+ print the currently installed lxc version.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ &seealso;
+
+ <refsect1>
+ <title>Author</title>
+ <para>Stéphane Graber <email>stgra...@ubuntu.com</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:
+-->
--
1.8.1.2
------------------------------------------------------------------------------
Free Next-Gen Firewall Hardware Offer
Buy your Sophos next-gen firewall before the end March 2013
and get the hardware for free! Learn more.
http://p.sf.net/sfu/sophos-d2d-feb
_______________________________________________
Lxc-devel mailing list
Lxc-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/lxc-devel
