I was getting raw nroff ".SH DESCRIPTION" in my man pages. This fixes
the synopsis cmd args so that doesn't happen. Added replaceable to a few
arguments.
Signed-off-by: Dwight Engen <dwight.en...@oracle.com>
---
doc/lxc-attach.sgml.in | 11 +++++++----
doc/lxc-cgroup.sgml.in | 7 ++++---
doc/lxc-checkpoint.sgml.in | 8 ++++----
doc/lxc-console.sgml.in | 8 ++++----
doc/lxc-create.sgml.in | 12 ++++++------
doc/lxc-destroy.sgml.in | 7 +++----
doc/lxc-execute.sgml.in | 10 +++++-----
doc/lxc-freeze.sgml.in | 4 ++--
doc/lxc-kill.sgml.in | 4 +++-
doc/lxc-ls.sgml.in | 5 +++--
doc/lxc-monitor.sgml.in | 4 ++--
doc/lxc-ps.sgml.in | 14 +++++++-------
doc/lxc-restart.sgml.in | 11 ++++++-----
doc/lxc-shutdown.sgml.in | 7 ++++---
doc/lxc-start.sgml.in | 16 ++++++++++------
doc/lxc-stop.sgml.in | 4 ++--
doc/lxc-unfreeze.sgml.in | 4 ++--
doc/lxc-wait.sgml.in | 6 +++---
18 files changed, 77 insertions(+), 65 deletions(-)
diff --git a/doc/lxc-attach.sgml.in b/doc/lxc-attach.sgml.in
index 7092f16..5d6263f 100644
--- a/doc/lxc-attach.sgml.in
+++ b/doc/lxc-attach.sgml.in
@@ -47,10 +47,13 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
</refnamediv>
<refsynopsisdiv>
- <cmdsynopsis><command>lxc-attach <replaceable>-n
- name</replaceable> <optional>-a
- arch</optional> <optional>-e</optional>
- <optional>-- command</optional></command></cmdsynopsis>
+ <cmdsynopsis>
+ <command>lxc-attach</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">-a <replaceable>arch</replaceable></arg>
+ <arg choice="opt">-e</arg>
+ <arg choice="opt">-- <replaceable>command</replaceable></arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1>
diff --git a/doc/lxc-cgroup.sgml.in b/doc/lxc-cgroup.sgml.in
index 8062148..9d49aa8 100644
--- a/doc/lxc-cgroup.sgml.in
+++ b/doc/lxc-cgroup.sgml.in
@@ -48,9 +48,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-cgroup -n <replaceable>name</replaceable>
- <replaceable>state-object</replaceable> <optional>value</optional>
- </command>
+ <command>lxc-cgroup</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="req"><replaceable>state-object</replaceable></arg>
+ <arg choice="opt">value</arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-checkpoint.sgml.in b/doc/lxc-checkpoint.sgml.in
index bf0efd9..9cf0c79 100644
--- a/doc/lxc-checkpoint.sgml.in
+++ b/doc/lxc-checkpoint.sgml.in
@@ -49,10 +49,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-checkpoint
- --statefile=<replaceable>FILE</replaceable>
- --statefd=<replaceable>FD</replaceable>
- --name=<replaceable>NAME</replaceable> </command>
+ <command>lxc-checkpoint</command>
+ <arg choice="req">--statefile=<replaceable>FILE</replaceable></arg>
+ <arg choice="req">--statefd=<replaceable>FD</replaceable></arg>
+ <arg choice="req">--name=<replaceable>NAME</replaceable></arg>
<arg><option>-k</option>|<option>-p</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-console.sgml.in b/doc/lxc-console.sgml.in
index 606c868..2afba86 100644
--- a/doc/lxc-console.sgml.in
+++ b/doc/lxc-console.sgml.in
@@ -48,9 +48,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-console <replaceable>-n name</replaceable>
- <optional>-t ttynum</optional>
- </command>
+ <command>lxc-console</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">-t <replaceable>ttynum</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -84,7 +84,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<varlistentry>
<term>
- <option>-t <optional>ttynum</optional></option>
+ <option>-t
<optional><replaceable>ttynum</replaceable></optional></option>
</term>
<listitem>
<para>
diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in
index a3cca83..0ffb21c 100644
--- a/doc/lxc-create.sgml.in
+++ b/doc/lxc-create.sgml.in
@@ -48,12 +48,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-create <replaceable>-n name</replaceable>
- <optional>-f config_file</optional>
- <optional>-t template</optional>
- <optional>-B backingstore</optional>
- <optional>-- template-options</optional>
- </command>
+ <command>lxc-create</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">-f <replaceable>config_file</replaceable></arg>
+ <arg choice="opt">-t <replaceable>template</replaceable></arg>
+ <arg choice="opt">-B <replaceable>backingstore</replaceable></arg>
+ <arg choice="opt">-- <replaceable>template-options</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-destroy.sgml.in b/doc/lxc-destroy.sgml.in
index e75de57..a51e484 100644
--- a/doc/lxc-destroy.sgml.in
+++ b/doc/lxc-destroy.sgml.in
@@ -48,10 +48,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-destroy <replaceable>-n
- name</replaceable>
- <optional>-f</optional>
- </command>
+ <command>lxc-destroy</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">-f</arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in
index 77d132a..6371751 100644
--- a/doc/lxc-execute.sgml.in
+++ b/doc/lxc-execute.sgml.in
@@ -48,11 +48,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-execute <replaceable>-n name</replaceable>
- <optional>-f config_file</optional> <optional>-s KEY=VAL
- </optional>
- <optional>--</optional>
- <replaceable>command</replaceable></command>
+ <command>lxc-execute</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">-f <replaceable>config_file</replaceable></arg>
+ <arg choice="opt">-s KEY=VAL</arg>
+ <arg choice="opt">-- <replaceable>command</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-freeze.sgml.in b/doc/lxc-freeze.sgml.in
index 798ccf4..7b7be49 100644
--- a/doc/lxc-freeze.sgml.in
+++ b/doc/lxc-freeze.sgml.in
@@ -48,8 +48,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-freeze <replaceable>-n name</replaceable>
- </command>
+ <command>lxc-freeze</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-kill.sgml.in b/doc/lxc-kill.sgml.in
index 5bec922..d1e3f69 100644
--- a/doc/lxc-kill.sgml.in
+++ b/doc/lxc-kill.sgml.in
@@ -49,7 +49,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-kill --name=<replaceable>NAME</replaceable>
<replaceable>SIGNUM</replaceable></command>
+ <command>lxc-kill</command>
+ <arg choice="req">--name=<replaceable>NAME</replaceable></arg>
+ <arg choice="req"><replaceable>SIGNUM</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in
index d33e9b3..5a32f1d 100644
--- a/doc/lxc-ls.sgml.in
+++ b/doc/lxc-ls.sgml.in
@@ -48,8 +48,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-ls <optional>--active</optional> <optional>ls
option</optional>
- </command>
+ <command>lxc-ls</command>
+ <arg choice="opt">--active</arg>
+ <arg choice="opt">ls option</arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-monitor.sgml.in b/doc/lxc-monitor.sgml.in
index 9d8711c..d3951ff 100644
--- a/doc/lxc-monitor.sgml.in
+++ b/doc/lxc-monitor.sgml.in
@@ -48,8 +48,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-monitor <replaceable>-n name</replaceable>
- </command>
+ <command>lxc-monitor</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-ps.sgml.in b/doc/lxc-ps.sgml.in
index bb7b5a6..f3275ae 100644
--- a/doc/lxc-ps.sgml.in
+++ b/doc/lxc-ps.sgml.in
@@ -48,10 +48,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-ps <optional>--name name</optional>
- <optional>--lxc</optional>
- <optional>ps option</optional>
- </command>
+ <command>lxc-ps</command>
+ <arg choice="opt">--name <replaceable>name</replaceable></arg>
+ <arg choice="opt">--lxc</arg>
+ <arg choice="opt">ps option</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -81,11 +81,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<varlistentry>
<term>
- <option><replaceable>--name NAME</replaceable></option>
+ <option>--name <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
- specify the container <replaceable>NAME</replaceable>
+ specify the container <replaceable>name</replaceable>
to limit the output to the processes belonging
to this container name.
</para>
@@ -94,7 +94,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<varlistentry>
<term>
- <option><replaceable>--lxc</replaceable></option>
+ <option>--lxc</option>
</term>
<listitem>
<para>
diff --git a/doc/lxc-restart.sgml.in b/doc/lxc-restart.sgml.in
index eb556d9..ffc0ad2 100644
--- a/doc/lxc-restart.sgml.in
+++ b/doc/lxc-restart.sgml.in
@@ -49,11 +49,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-restart <optional>-f
- config_file</optional><optional>-s KEY=VAL</optional>
- --statefile=<replaceable>FILE</replaceable>
- --statefd=<replaceable>FD</replaceable></command>
- <arg
choice="req"><option>--name=<replaceable>NAME</replaceable></option></arg>
+ <command>lxc-restart</command>
+ <arg choice="opt">-f <replaceable>config_file</replaceable></arg>
+ <arg choice="opt">-s KEY=VAL</arg>
+ <arg choice="req">--statefile=<replaceable>FILE</replaceable></arg>
+ <arg choice="req">--statefd=<replaceable>FD</replaceable></arg>
+ <arg choice="req">--name=<replaceable>NAME</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-shutdown.sgml.in b/doc/lxc-shutdown.sgml.in
index c54e54d..f64f575 100644
--- a/doc/lxc-shutdown.sgml.in
+++ b/doc/lxc-shutdown.sgml.in
@@ -45,9 +45,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-shutdown <replaceable>-n name</replaceable>
- <optional>-w</optional> <optional>-r</optional>
- </command>
+ <command>lxc-shutdown</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">-w</arg>
+ <arg choice="opt">-r</arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-start.sgml.in b/doc/lxc-start.sgml.in
index 4504d58..2b6778f 100644
--- a/doc/lxc-start.sgml.in
+++ b/doc/lxc-start.sgml.in
@@ -47,12 +47,16 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
</refnamediv>
<refsynopsisdiv>
- <cmdsynopsis><command>lxc-start <replaceable>-n
- name</replaceable> <optional>-f
- config_file</optional> <optional>-c
- console_file</optional> <optional>-d</optional> <optional>-s
- KEY=VAL</optional> <optional>-C</optional>
- <optional>command</optional></command></cmdsynopsis>
+ <cmdsynopsis>
+ <command>lxc-start</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="opt">-f <replaceable>config_file</replaceable></arg>
+ <arg choice="opt">-c <replaceable>console_file</replaceable></arg>
+ <arg choice="opt">-d</arg>
+ <arg choice="opt">-s KEY=VAL</arg>
+ <arg choice="opt">-C</arg>
+ <arg choice="opt">command</arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1>
diff --git a/doc/lxc-stop.sgml.in b/doc/lxc-stop.sgml.in
index d15e649..d16cab5 100644
--- a/doc/lxc-stop.sgml.in
+++ b/doc/lxc-stop.sgml.in
@@ -48,8 +48,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-stop <replaceable>-n name</replaceable>
- </command>
+ <command>lxc-stop</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-unfreeze.sgml.in b/doc/lxc-unfreeze.sgml.in
index bb00d85..c4c545e 100644
--- a/doc/lxc-unfreeze.sgml.in
+++ b/doc/lxc-unfreeze.sgml.in
@@ -48,8 +48,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-unfreeze <replaceable>-n name</replaceable>
- </command>
+ <command>lxc-unfreeze</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
diff --git a/doc/lxc-wait.sgml.in b/doc/lxc-wait.sgml.in
index 97a4c39..4160e38 100644
--- a/doc/lxc-wait.sgml.in
+++ b/doc/lxc-wait.sgml.in
@@ -49,9 +49,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA
<refsynopsisdiv>
<cmdsynopsis>
- <command>lxc-wait <replaceable>-n name</replaceable>
- <replaceable>-s states</replaceable>
- </command>
+ <command>lxc-wait</command>
+ <arg choice="req">-n <replaceable>name</replaceable></arg>
+ <arg choice="req">-s <replaceable>states</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Lxc-devel mailing list
Lxc-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/lxc-devel
