[lxc-devel] [PATCH 2/2] doc: Improve man pages

KATOH Yasufumi karma at jazz.email.ne.jp
Mon Dec 28 09:55:24 UTC 2015


* Add long options if not be written
* Remove optional tags in OPTIONS section

Signed-off-by: KATOH Yasufumi <karma at jazz.email.ne.jp>
---
 doc/ja/lxc-console.sgml.in         |  4 ++--
 doc/ja/lxc-create.sgml.in          |  6 +++---
 doc/ja/lxc-device.sgml.in          |  6 ++----
 doc/ja/lxc-info.sgml.in            | 14 +++++++-------
 doc/ja/lxc-ls.sgml.in              | 24 ++++++++++++------------
 doc/ja/lxc-start-ephemeral.sgml.in | 20 ++++++++++----------
 doc/ja/lxc-top.sgml.in             |  6 +++---
 doc/ja/lxc-wait.sgml.in            |  4 ++--
 doc/ko/lxc-console.sgml.in         |  4 ++--
 doc/ko/lxc-create.sgml.in          |  6 +++---
 doc/ko/lxc-device.sgml.in          |  6 ++----
 doc/ko/lxc-info.sgml.in            | 12 ++++++------
 doc/ko/lxc-ls.sgml.in              | 24 ++++++++++++------------
 doc/ko/lxc-start-ephemeral.sgml.in | 20 ++++++++++----------
 doc/ko/lxc-top.sgml.in             |  6 +++---
 doc/ko/lxc-wait.sgml.in            |  4 ++--
 doc/lxc-console.sgml.in            |  4 ++--
 doc/lxc-create.sgml.in             |  6 +++---
 doc/lxc-device.sgml.in             |  6 ++----
 doc/lxc-info.sgml.in               | 12 ++++++------
 doc/lxc-ls.sgml.in                 | 24 ++++++++++++------------
 doc/lxc-start-ephemeral.sgml.in    | 20 ++++++++++----------
 doc/lxc-top.sgml.in                |  6 +++---
 doc/lxc-wait.sgml.in               |  4 ++--
 24 files changed, 121 insertions(+), 127 deletions(-)

diff --git a/doc/ja/lxc-console.sgml.in b/doc/ja/lxc-console.sgml.in
index 3ab395c..fbf7b7b 100644
--- a/doc/ja/lxc-console.sgml.in
+++ b/doc/ja/lxc-console.sgml.in
@@ -120,7 +120,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
 	<term>
-	  <option>-e <optional><replaceable>escape character</replaceable></optional></option>
+	  <option>-e, --escape <replaceable>escape character</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -138,7 +138,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
       </varlistentry>
       <varlistentry>
 	<term>
-	  <option>-t <optional><replaceable>ttynum</replaceable></optional></option>
+	  <option>-t, --tty <replaceable>ttynum</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/ja/lxc-create.sgml.in b/doc/ja/lxc-create.sgml.in
index e319caa..3991976 100644
--- a/doc/ja/lxc-create.sgml.in
+++ b/doc/ja/lxc-create.sgml.in
@@ -112,7 +112,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
 	<term>
-	  <option>-f <replaceable>config_file</replaceable></option>
+	  <option>-f, --config <replaceable>config_file</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -127,7 +127,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
 	<term>
-	  <option>-t <replaceable>template</replaceable></option>
+	  <option>-t, --template <replaceable>template</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -151,7 +151,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
 	<term>
-	  <option>-B <replaceable>backingstore</replaceable></option>
+	  <option>-B, --bdev <replaceable>backingstore</replaceable></option>
 	</term>
 	<listitem>
           <para>
diff --git a/doc/ja/lxc-device.sgml.in b/doc/ja/lxc-device.sgml.in
index b7ce115..cb637e1 100644
--- a/doc/ja/lxc-device.sgml.in
+++ b/doc/ja/lxc-device.sgml.in
@@ -76,7 +76,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
     <variablelist>
       <varlistentry>
         <term>
-          <option><optional>-h</optional></option>
+          <option>-h</option>
         </term>
         <listitem>
           <para>
@@ -89,9 +89,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
       </varlistentry>
 
       <varlistentry>
-        <term>
-          <option>-n</option>
-        </term>
+        <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
         <listitem>
           <para>
             <!--
diff --git a/doc/ja/lxc-info.sgml.in b/doc/ja/lxc-info.sgml.in
index 8df1928..23d8cbb 100644
--- a/doc/ja/lxc-info.sgml.in
+++ b/doc/ja/lxc-info.sgml.in
@@ -80,7 +80,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-c <replaceable>KEY</replaceable></optional></option>
+          <option>-c, --config <replaceable>KEY</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -95,7 +95,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-s</optional></option>
+          <option>-s, --state</option>
         </term>
         <listitem>
           <para>
@@ -109,7 +109,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-p</optional></option>
+          <option>-p, --pid</option>
         </term>
         <listitem>
           <para>
@@ -123,21 +123,21 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-i</optional></option>
+          <option>-i, --ips</option>
         </term>
         <listitem>
           <para>
             <!--
             Just print the container's IP addresses.
             -->
-            コンテナの IP アドレスを表示します。。
+            コンテナの IP アドレスを表示します。
           </para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term>
-          <option><optional>-S</optional></option>
+          <option>-S, --stats</option>
         </term>
         <listitem>
           <para>
@@ -174,7 +174,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-H</optional></option>
+          <option>-H, --no-humanize</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ja/lxc-ls.sgml.in b/doc/ja/lxc-ls.sgml.in
index 5860783..0812216 100644
--- a/doc/ja/lxc-ls.sgml.in
+++ b/doc/ja/lxc-ls.sgml.in
@@ -85,7 +85,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
     <variablelist>
       <varlistentry>
         <term>
-          <option><optional>-1</optional></option>
+          <option>-1</option>
         </term>
         <listitem>
           <para>
@@ -99,7 +99,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-P, --lxcpath</optional></option>
+          <option>-P, --lxcpath</option>
         </term>
         <listitem>
           <para>
@@ -113,7 +113,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
 	<term>
-	  <option><optional>--active</optional></option>
+	  <option>--active</option>
 	</term>
 	<listitem>
 	  <para>
@@ -127,7 +127,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--frozen</optional></option>
+          <option>--frozen</option>
         </term>
         <listitem>
           <para>
@@ -141,7 +141,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--running</optional></option>
+          <option>--running</option>
         </term>
         <listitem>
           <para>
@@ -155,7 +155,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--stopped</optional></option>
+          <option>--stopped</option>
         </term>
         <listitem>
           <para>
@@ -169,7 +169,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-f, --fancy</optional></option>
+          <option>-f, --fancy</option>
         </term>
         <listitem>
           <para>
@@ -183,7 +183,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-F, --fancy-format <replaceable>format</replaceable></optional></option>
+          <option>-F, --fancy-format <replaceable>format</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -198,7 +198,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-g, --groups <replaceable>groups</replaceable></optional></option>
+          <option>-g, --groups <replaceable>groups</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -213,7 +213,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--nesting</optional></option>
+          <option>--nesting</option>
         </term>
         <listitem>
           <para>
@@ -227,7 +227,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>filter</optional></option>
+          <option>filter</option>
         </term>
         <listitem>
           <para>
@@ -243,7 +243,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--version</optional></option>
+          <option>--version</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ja/lxc-start-ephemeral.sgml.in b/doc/ja/lxc-start-ephemeral.sgml.in
index 3f79c74..0fb6738 100644
--- a/doc/ja/lxc-start-ephemeral.sgml.in
+++ b/doc/ja/lxc-start-ephemeral.sgml.in
@@ -82,7 +82,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
     <variablelist>
       <varlistentry>
         <term>
-          <option>-o</option>
+          <option>-o, --orig <replaceable>orig</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -96,7 +96,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-n</optional></option>
+          <option>-n, --name <replaceable>name</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -110,7 +110,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>-d</optional></option>
+          <option>-d, --daemon</option>
         </term>
         <listitem>
           <para>
@@ -126,7 +126,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--bdir</optional></option>
+          <option>-b, --bdir <replaceable>bdir</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -142,7 +142,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--user</optional></option>
+          <option>-u, --user <replaceable>user</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -158,7 +158,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--key</optional></option>
+          <option>-S, --key <replaceable>key</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -172,7 +172,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--storage-type</optional></option>
+          <option>-s, --storage-type <replaceable>storage type</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -186,7 +186,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--union-type</optional></option>
+          <option>-U, --union-type <replaceable>union type</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -202,7 +202,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>--keep-data</optional></option>
+          <option>-k, --keep-data</option>
         </term>
         <listitem>
           <para>
@@ -218,7 +218,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
         <term>
-          <option><optional>COMMAND</optional></option>
+          <option>COMMAND</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ja/lxc-top.sgml.in b/doc/ja/lxc-top.sgml.in
index c134b3a..66a79b4 100644
--- a/doc/ja/lxc-top.sgml.in
+++ b/doc/ja/lxc-top.sgml.in
@@ -79,7 +79,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-d, --delay <replaceable>delay</replaceable></optional></option>
+          <option>-d, --delay <replaceable>delay</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -93,7 +93,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       </varlistentry>
       <varlistentry>
         <term>
-          <option><optional>-s, --sort <replaceable>sortby</replaceable></optional></option>
+          <option>-s, --sort <replaceable>sortby</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -110,7 +110,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       </varlistentry>
       <varlistentry>
         <term>
-          <option><optional>-r, --reverse</optional></option>
+          <option>-r, --reverse</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ja/lxc-wait.sgml.in b/doc/ja/lxc-wait.sgml.in
index e51d964..e60493c 100644
--- a/doc/ja/lxc-wait.sgml.in
+++ b/doc/ja/lxc-wait.sgml.in
@@ -78,7 +78,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
 	<term>
-	  <option>-s <replaceable>states</replaceable></option>
+	  <option>-s, --state <replaceable>states</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -94,7 +94,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
 
       <varlistentry>
 	<term>
-	  <option>-t <replaceable>timeout</replaceable></option>
+	  <option>-t, --timeout <replaceable>timeout</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/ko/lxc-console.sgml.in b/doc/ko/lxc-console.sgml.in
index 8d435d9..fd6820a 100644
--- a/doc/ko/lxc-console.sgml.in
+++ b/doc/ko/lxc-console.sgml.in
@@ -118,7 +118,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option>-e <optional><replaceable>escape character</replaceable></optional></option>
+	  <option>-e, --escape <replaceable>escape character</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -136,7 +136,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
       </varlistentry>
       <varlistentry>
 	<term>
-	  <option>-t <optional><replaceable>ttynum</replaceable></optional></option>
+	  <option>-t, --tty <replaceable>ttynum</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/ko/lxc-create.sgml.in b/doc/ko/lxc-create.sgml.in
index d794306..ed685a4 100644
--- a/doc/ko/lxc-create.sgml.in
+++ b/doc/ko/lxc-create.sgml.in
@@ -112,7 +112,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option>-f <replaceable>config_file</replaceable></option>
+	  <option>-f, --config <replaceable>config_file</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -127,7 +127,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option>-t <replaceable>template</replaceable></option>
+	  <option>-t, --template <replaceable>template</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -150,7 +150,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option>-B <replaceable>backingstore</replaceable></option>
+	  <option>-B, --bdev <replaceable>backingstore</replaceable></option>
 	</term>
 	<listitem>
           <para>
diff --git a/doc/ko/lxc-device.sgml.in b/doc/ko/lxc-device.sgml.in
index 2c8cbd4..b2c5cf4 100644
--- a/doc/ko/lxc-device.sgml.in
+++ b/doc/ko/lxc-device.sgml.in
@@ -76,7 +76,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
     <variablelist>
       <varlistentry>
         <term>
-          <option><optional>-h</optional></option>
+          <option>-h</option>
         </term>
         <listitem>
           <para>
@@ -89,9 +89,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
       </varlistentry>
 
       <varlistentry>
-        <term>
-          <option>-n</option>
-        </term>
+        <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
         <listitem>
           <para>
             <!--
diff --git a/doc/ko/lxc-info.sgml.in b/doc/ko/lxc-info.sgml.in
index 08ebcf3..4f99c5a 100644
--- a/doc/ko/lxc-info.sgml.in
+++ b/doc/ko/lxc-info.sgml.in
@@ -80,7 +80,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-c <replaceable>KEY</replaceable></optional></option>
+          <option>-c, --config <replaceable>KEY</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -95,7 +95,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-s</optional></option>
+          <option>-s, --state</option>
         </term>
         <listitem>
           <para>
@@ -109,7 +109,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-p</optional></option>
+          <option>-p, --pid</option>
         </term>
         <listitem>
           <para>
@@ -124,7 +124,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-i</optional></option>
+          <option>-i, --ips</option>
         </term>
         <listitem>
           <para>
@@ -138,7 +138,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-S</optional></option>
+          <option>-S, --stats</option>
         </term>
         <listitem>
           <para>
@@ -174,7 +174,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-H</optional></option>
+          <option>-H, --no-humanize</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ko/lxc-ls.sgml.in b/doc/ko/lxc-ls.sgml.in
index d3323b0..a6b9f0b 100644
--- a/doc/ko/lxc-ls.sgml.in
+++ b/doc/ko/lxc-ls.sgml.in
@@ -85,7 +85,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
     <variablelist>
       <varlistentry>
         <term>
-          <option><optional>-1</optional></option>
+          <option>-1</option>
         </term>
         <listitem>
           <para>
@@ -99,7 +99,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option><optional>-P, --lxcpath</optional></option>
+	  <option>-P, --lxcpath</option>
 	</term>
 	<listitem>
 	  <para>
@@ -113,7 +113,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option><optional>--active</optional></option>
+	  <option>--active</option>
 	</term>
 	<listitem>
 	  <para>
@@ -127,7 +127,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--frozen</optional></option>
+          <option>--frozen</option>
         </term>
         <listitem>
           <para>
@@ -141,7 +141,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--running</optional></option>
+          <option>--running</option>
         </term>
         <listitem>
           <para>
@@ -155,7 +155,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--stopped</optional></option>
+          <option>--stopped</option>
         </term>
         <listitem>
           <para>
@@ -169,7 +169,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-f, --fancy</optional></option>
+          <option>-f, --fancy</option>
         </term>
         <listitem>
           <para>
@@ -183,7 +183,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-F, --fancy-format <replaceable>format</replaceable></optional></option>
+          <option>-F, --fancy-format <replaceable>format</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -199,7 +199,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-g, --groups <replaceable>groups</replaceable></optional></option>
+          <option>-g, --groups <replaceable>groups</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -215,7 +215,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--nesting</optional></option>
+          <option>--nesting</option>
         </term>
         <listitem>
           <para>
@@ -229,7 +229,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>filter</optional></option>
+          <option>filter</option>
         </term>
         <listitem>
           <para>
@@ -245,7 +245,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--version</optional></option>
+          <option>--version</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ko/lxc-start-ephemeral.sgml.in b/doc/ko/lxc-start-ephemeral.sgml.in
index 57f8be4..2ae544f 100644
--- a/doc/ko/lxc-start-ephemeral.sgml.in
+++ b/doc/ko/lxc-start-ephemeral.sgml.in
@@ -82,7 +82,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
     <variablelist>
       <varlistentry>
         <term>
-          <option>-o</option>
+          <option>-o, --orig <replaceable>orig</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -96,7 +96,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-n</optional></option>
+          <option>-n, --name <replaceable>name</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -110,7 +110,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-d</optional></option>
+          <option>-d, --daemon</option>
         </term>
         <listitem>
           <para>
@@ -126,7 +126,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--bdir</optional></option>
+          <option>-b, --bdir <replaceable>bdir</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -142,7 +142,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--user</optional></option>
+          <option>-u, --user <replaceable>user</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -158,7 +158,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--key</optional></option>
+          <option>-S, --key <replaceable>key</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -172,7 +172,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--storage-type</optional></option>
+          <option>-s, --storage-type <replaceable>storage type</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -186,7 +186,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--union-type</optional></option>
+          <option>-U, --union-type <replaceable>union type</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -202,7 +202,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>--keep-data</optional></option>
+          <option>-k, --keep-data</option>
         </term>
         <listitem>
           <para>
@@ -219,7 +219,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>COMMAND</optional></option>
+          <option>COMMAND</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ko/lxc-top.sgml.in b/doc/ko/lxc-top.sgml.in
index 7f4357f..3c34b6b 100644
--- a/doc/ko/lxc-top.sgml.in
+++ b/doc/ko/lxc-top.sgml.in
@@ -82,7 +82,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
         <term>
-          <option><optional>-d, --delay <replaceable>delay</replaceable></optional></option>
+          <option>-d, --delay <replaceable>delay</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -97,7 +97,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
       </varlistentry>
       <varlistentry>
         <term>
-          <option><optional>-s, --sort <replaceable>sortby</replaceable></optional></option>
+          <option>-s, --sort <replaceable>sortby</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -113,7 +113,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
       </varlistentry>
       <varlistentry>
         <term>
-          <option><optional>-r, --reverse</optional></option>
+          <option>-r, --reverse</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/ko/lxc-wait.sgml.in b/doc/ko/lxc-wait.sgml.in
index e780270..396c4d3 100644
--- a/doc/ko/lxc-wait.sgml.in
+++ b/doc/ko/lxc-wait.sgml.in
@@ -77,7 +77,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option>-s <replaceable>states</replaceable></option>
+	  <option>-s, --state <replaceable>states</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -93,7 +93,7 @@ by Sungbae Yoo <sungbae.yoo at samsung.com>
 
       <varlistentry>
 	<term>
-	  <option>-t <replaceable>timeout</replaceable></option>
+	  <option>-t, --timeout <replaceable>timeout</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/lxc-console.sgml.in b/doc/lxc-console.sgml.in
index fd4caa6..8f0bb1f 100644
--- a/doc/lxc-console.sgml.in
+++ b/doc/lxc-console.sgml.in
@@ -96,7 +96,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
 	<term>
-	  <option>-e <optional><replaceable>escape character</replaceable></optional></option>
+	  <option>-e, --escape <replaceable>escape character</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -109,7 +109,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       </varlistentry>
       <varlistentry>
 	<term>
-	  <option>-t <optional><replaceable>ttynum</replaceable></optional></option>
+	  <option>-t, --tty <replaceable>ttynum</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in
index ffaa738..1e97c40 100644
--- a/doc/lxc-create.sgml.in
+++ b/doc/lxc-create.sgml.in
@@ -92,7 +92,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
 	<term>
-	  <option>-f <replaceable>config_file</replaceable></option>
+	  <option>-f, --config <replaceable>config_file</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -104,7 +104,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
 	<term>
-	  <option>-t <replaceable>template</replaceable></option>
+	  <option>-t, --template <replaceable>template</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -122,7 +122,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
 	<term>
-	  <option>-B <replaceable>backingstore</replaceable></option>
+	  <option>-B, --bdev <replaceable>backingstore</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
diff --git a/doc/lxc-device.sgml.in b/doc/lxc-device.sgml.in
index c90d374..8e17bbf 100644
--- a/doc/lxc-device.sgml.in
+++ b/doc/lxc-device.sgml.in
@@ -67,7 +67,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
     <variablelist>
       <varlistentry>
         <term>
-          <option><optional>-h</optional></option>
+          <option>-h</option>
         </term>
         <listitem>
           <para>
@@ -77,9 +77,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       </varlistentry>
 
       <varlistentry>
-        <term>
-          <option>-n</option>
-        </term>
+        <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
         <listitem>
           <para>
              The name of the target container.
diff --git a/doc/lxc-info.sgml.in b/doc/lxc-info.sgml.in
index 5707975..02353a2 100644
--- a/doc/lxc-info.sgml.in
+++ b/doc/lxc-info.sgml.in
@@ -71,7 +71,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-c <replaceable>KEY</replaceable></optional></option>
+          <option>-c, --config <replaceable>KEY</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -83,7 +83,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-s</optional></option>
+          <option>-s, --state</option>
         </term>
         <listitem>
           <para>
@@ -94,7 +94,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-p</optional></option>
+          <option>-p, --pid</option>
         </term>
         <listitem>
           <para>
@@ -105,7 +105,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-i</optional></option>
+          <option>-i, --ips</option>
         </term>
         <listitem>
           <para>
@@ -116,7 +116,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-S</optional></option>
+          <option>-S, --stats</option>
         </term>
         <listitem>
           <para>
@@ -139,7 +139,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-H</optional></option>
+          <option>-H, --no-humanize</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in
index 63826e1..41a23e6 100644
--- a/doc/lxc-ls.sgml.in
+++ b/doc/lxc-ls.sgml.in
@@ -77,7 +77,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
     <variablelist>
       <varlistentry>
         <term>
-          <option><optional>-1</optional></option>
+          <option>-1</option>
         </term>
         <listitem>
           <para>
@@ -88,7 +88,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-P, --lxcpath</optional></option>
+          <option>-P, --lxcpath</option>
         </term>
         <listitem>
           <para>
@@ -99,7 +99,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--active</optional></option>
+          <option>--active</option>
         </term>
         <listitem>
           <para>
@@ -110,7 +110,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--frozen</optional></option>
+          <option>--frozen</option>
         </term>
         <listitem>
           <para>
@@ -121,7 +121,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--running</optional></option>
+          <option>--running</option>
         </term>
         <listitem>
           <para>
@@ -132,7 +132,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--stopped</optional></option>
+          <option>--stopped</option>
         </term>
         <listitem>
           <para>
@@ -143,7 +143,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-f, --fancy</optional></option>
+          <option>-f, --fancy</option>
         </term>
         <listitem>
           <para>
@@ -154,7 +154,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-F, --fancy-format <replaceable>format</replaceable></optional></option>
+          <option>-F, --fancy-format <replaceable>format</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -166,7 +166,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-g, --groups <replaceable>groups</replaceable></optional></option>
+          <option>-g, --groups <replaceable>groups</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -178,7 +178,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--nesting</optional></option>
+          <option>--nesting</option>
         </term>
         <listitem>
           <para>
@@ -189,7 +189,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>filter</optional></option>
+          <option>filter</option>
         </term>
         <listitem>
           <para>
@@ -201,7 +201,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--version</optional></option>
+          <option>--version</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/lxc-start-ephemeral.sgml.in b/doc/lxc-start-ephemeral.sgml.in
index 6f3a325..0e2c7ad 100644
--- a/doc/lxc-start-ephemeral.sgml.in
+++ b/doc/lxc-start-ephemeral.sgml.in
@@ -73,7 +73,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
     <variablelist>
       <varlistentry>
         <term>
-          <option>-o</option>
+          <option>-o, --orig <replaceable>orig</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -84,7 +84,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-n</optional></option>
+          <option>-n, --name <replaceable>name</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -95,7 +95,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-d</optional></option>
+          <option>-d, --daemon</option>
         </term>
         <listitem>
           <para>
@@ -107,7 +107,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--bdir</optional></option>
+          <option>-b, --bdir <replaceable>bdir</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -119,7 +119,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--user</optional></option>
+          <option>-u, --user <replaceable>user</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -131,7 +131,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--key</optional></option>
+          <option>-S, --key <replaceable>key</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -142,7 +142,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--storage-type</optional></option>
+          <option>-s, --storage-type <replaceable>storage type</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -153,7 +153,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--union-type</optional></option>
+          <option>-U, --union-type <replaceable>union type</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -165,7 +165,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>--keep-data</optional></option>
+          <option>-k, --keep-data</option>
         </term>
         <listitem>
           <para>
@@ -178,7 +178,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>COMMAND</optional></option>
+          <option>COMMAND</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/lxc-top.sgml.in b/doc/lxc-top.sgml.in
index 2e2f774..38aa951 100644
--- a/doc/lxc-top.sgml.in
+++ b/doc/lxc-top.sgml.in
@@ -72,7 +72,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
         <term>
-          <option><optional>-d, --delay <replaceable>delay</replaceable></optional></option>
+          <option>-d, --delay <replaceable>delay</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -83,7 +83,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       </varlistentry>
       <varlistentry>
         <term>
-          <option><optional>-s, --sort <replaceable>sortby</replaceable></optional></option>
+          <option>-s, --sort <replaceable>sortby</replaceable></option>
         </term>
         <listitem>
           <para>
@@ -96,7 +96,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       </varlistentry>
       <varlistentry>
         <term>
-          <option><optional>-r, --reverse</optional></option>
+          <option>-r, --reverse</option>
         </term>
         <listitem>
           <para>
diff --git a/doc/lxc-wait.sgml.in b/doc/lxc-wait.sgml.in
index 5c5c958..c32f8a5 100644
--- a/doc/lxc-wait.sgml.in
+++ b/doc/lxc-wait.sgml.in
@@ -69,7 +69,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
 	<term>
-	  <option>-s <replaceable>states</replaceable></option>
+	  <option>-s, --state <replaceable>states</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
@@ -81,7 +81,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
 	<term>
-	  <option>-t <replaceable>timeout</replaceable></option>
+	  <option>-t, --timeout <replaceable>timeout</replaceable></option>
 	</term>
 	<listitem>
 	  <para>
-- 
2.6.3



More information about the lxc-devel mailing list