Commit 1354f952 by Dwight Engen Committed by Serge Hallyn

minor documentation fixes / clarification

parent 190a2ea8
...@@ -50,7 +50,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -50,7 +50,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<cmdsynopsis> <cmdsynopsis>
<command>lxc-ls</command> <command>lxc-ls</command>
<arg choice="opt">--active</arg> <arg choice="opt">--active</arg>
<arg choice="opt">ls option</arg> <arg choice="opt"><replaceable>ls options</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
...@@ -79,7 +79,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -79,7 +79,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option><optional>ls options</optional></option> <option><optional><replaceable>ls options</replaceable></optional></option>
</term> </term>
<listitem> <listitem>
<para> <para>
......
...@@ -132,12 +132,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -132,12 +132,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<para> <para>
Signal the end of options and disables further option Signal the end of options and disables further option
processing. Any arguments after the -- are treated as processing. Any arguments after the -- are treated as
arguments. arguments to <replaceable>command</replaceable>.
</para> </para>
<para> <para>
This option is useful when you want to execute, with the This option is useful when you want specify options
command <command>lxc-execute</command>, a command line to <replaceable>command</replaceable> and don't want
with its own options. <command>lxc-execute</command> to interpret them.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
......
...@@ -52,7 +52,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -52,7 +52,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<arg choice="opt">--name <replaceable>name</replaceable></arg> <arg choice="opt">--name <replaceable>name</replaceable></arg>
<arg choice="opt">--lxc</arg> <arg choice="opt">--lxc</arg>
<arg choice="opt">--host</arg> <arg choice="opt">--host</arg>
<arg choice="opt">-- ps option</arg> <arg choice="opt">-- <replaceable>ps options</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
...@@ -69,7 +69,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -69,7 +69,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
the container associated to processes. the container associated to processes.
</para> </para>
<para> <para>
The additionnal specified ps options must not The additional specified <replaceable>ps options</replaceable> must not
remove the default ps header and the pid information, remove the default ps header and the pid information,
to be able to have the <command>lxc-ps</command> to find to be able to have the <command>lxc-ps</command> to find
the container associated to processes. the container associated to processes.
...@@ -119,7 +119,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -119,7 +119,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option><optional>ps options</optional></option> <option><optional><replaceable>ps options</replaceable></optional></option>
</term> </term>
<listitem> <listitem>
<para> <para>
......
...@@ -49,7 +49,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -49,7 +49,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>lxc-clone</command> <command>lxc-unshare</command>
<arg choice="req">-s <replaceable>namespaces</replaceable></arg> <arg choice="req">-s <replaceable>namespaces</replaceable></arg>
<arg choice="req">-u <replaceable>user</replaceable></arg> <arg choice="req">-u <replaceable>user</replaceable></arg>
<arg choice="req">command</arg> <arg choice="req">command</arg>
...@@ -115,7 +115,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -115,7 +115,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<para> <para>
To spawn a new shell with its own UTS (hostname) namespace, To spawn a new shell with its own UTS (hostname) namespace,
<programlisting> <programlisting>
lxc-clone -s UTSNAME /bin/bash lxc-unshare -s UTSNAME /bin/bash
</programlisting> </programlisting>
If the hostname is changed in that shell, the change will not be If the hostname is changed in that shell, the change will not be
reflected on the host. reflected on the host.
...@@ -123,7 +123,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -123,7 +123,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<para> <para>
To spawn a shell in a new network, pid, and mount namespace, To spawn a shell in a new network, pid, and mount namespace,
<programlisting> <programlisting>
lxc-clone -s "NETWORK|PID|MOUNT" /bin/bash lxc-unshare -s "NETWORK|PID|MOUNT" /bin/bash
</programlisting> </programlisting>
The resulting shell will have pid 1 and will see no network interfaces. The resulting shell will have pid 1 and will see no network interfaces.
After re-mounting /proc in that shell, After re-mounting /proc in that shell,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment