From: Dwight Engen <dwight.engen@oracle.com>
Date: Tue, 9 Apr 2013 13:41:15 +0000 (-0400)
Subject: minor documentation fixes / clarification
X-Git-Tag: lxc-1.0.0.alpha1~1^2~322
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1354f952876e96b456425efc7ed9994caf687028;p=thirdparty%2Flxc.git

minor documentation fixes / clarification

Signed-off-by: Dwight Engen <dwight.engen@oracle.com>
Acked-by: Serge E. Hallyn <serge.hallyn@ubuntu.com>
Signed-off-by: Serge Hallyn <serge.hallyn@ubuntu.com>
---

diff --git a/doc/legacy/lxc-ls.sgml.in b/doc/legacy/lxc-ls.sgml.in
index c04a4a4c2..60c085cdc 100644
--- a/doc/legacy/lxc-ls.sgml.in
+++ b/doc/legacy/lxc-ls.sgml.in
@@ -50,7 +50,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <cmdsynopsis>
       <command>lxc-ls</command>
       <arg choice="opt">--active</arg>
-      <arg choice="opt">ls option</arg>
+      <arg choice="opt"><replaceable>ls options</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -79,7 +79,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
 	<term>
-	  <option><optional>ls options</optional></option>
+	  <option><optional><replaceable>ls options</replaceable></optional></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in
index c83a5eb53..de233f68f 100644
--- a/doc/lxc-execute.sgml.in
+++ b/doc/lxc-execute.sgml.in
@@ -132,12 +132,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 	  <para>
 	    Signal the end of options and disables further option
 	    processing. Any arguments after the -- are treated as
-	    arguments.
+	    arguments to <replaceable>command</replaceable>.
 	  </para>
 	  <para>
-	    This option is useful when you want to execute, with the
-	    command <command>lxc-execute</command>, a command line
-	    with its own options.
+	    This option is useful when you want specify options
+	    to <replaceable>command</replaceable> and don't want
+	    <command>lxc-execute</command> to interpret them.
 	  </para>
 	</listitem>
       </varlistentry>
diff --git a/doc/lxc-ps.sgml.in b/doc/lxc-ps.sgml.in
index f20bb0293..b0103cfd9 100644
--- a/doc/lxc-ps.sgml.in
+++ b/doc/lxc-ps.sgml.in
@@ -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">--lxc</arg>
       <arg choice="opt">--host</arg>
-      <arg choice="opt">-- ps option</arg>
+      <arg choice="opt">-- <replaceable>ps options</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -69,7 +69,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 	the container associated to processes.
     </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,
 	to be able to have the <command>lxc-ps</command> to find
 	the container associated to processes.
@@ -119,7 +119,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
       <varlistentry>
 	<term>
-	  <option><optional>ps options</optional></option>
+	  <option><optional><replaceable>ps options</replaceable></optional></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/lxc-unshare.sgml.in b/doc/lxc-unshare.sgml.in
index 1fbaf0bba..5c899b63d 100644
--- a/doc/lxc-unshare.sgml.in
+++ b/doc/lxc-unshare.sgml.in
@@ -49,7 +49,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>lxc-clone</command>
+      <command>lxc-unshare</command>
       <arg choice="req">-s <replaceable>namespaces</replaceable></arg>
       <arg choice="req">-u <replaceable>user</replaceable></arg>
       <arg choice="req">command</arg>
@@ -115,7 +115,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       <para>
         To spawn a new shell with its own UTS (hostname) namespace,
         <programlisting>
-          lxc-clone -s UTSNAME /bin/bash
+          lxc-unshare -s UTSNAME /bin/bash
         </programlisting>
 	If the hostname is changed in that shell, the change will not be
 	reflected on the host.
@@ -123,7 +123,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       <para>
         To spawn a shell in a new network, pid, and mount namespace,
         <programlisting>
-          lxc-clone -s "NETWORK|PID|MOUNT" /bin/bash
+          lxc-unshare -s "NETWORK|PID|MOUNT" /bin/bash
         </programlisting>
 	The resulting shell will have pid 1 and will see no network interfaces.
 	After re-mounting /proc in that shell,