change man pages to use a common file for common options

the common options of lxc commands
are now described in one file "common_options.sgml.in"

Signed-off-by: Michel Normand <normand@fr.ibm.com>
Signed-off-by: Daniel Lezcano <dlezcano@fr.ibm.com>

diff --git a/configure.ac b/configure.ac
index f8d95c4e77826fee63b0442eabca887a8a048a27..2de68add3fc2dc7a1fcc52c8db69878e79b6a4d2 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -78,6 +78,7 @@ AC_CONFIG_FILES([
        doc/lxc-cgroup.sgml
        doc/lxc.conf.sgml
        doc/lxc.sgml
+       doc/common_options.sgml
        doc/see_also.sgml
 
        scripts/Makefile

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 6113e46d975f2018f226d14e1ee10c8b1cec0f5d..2af6f752e965be0055e2f860f11786d10f03b499 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -31,7 +31,7 @@ man_MANS = \
 %.7 : %.sgml 
        docbook2man -w all $<
 
-lxc-%.sgml : see_also.sgml
+lxc-%.sgml : common_options.sgml see_also.sgml
 
 clean-local:
        $(RM) manpage.* *.7 *.5 *.1 *.sgml $(man_MANS)

diff --git a/doc/lxc-cgroup.sgml.in b/doc/lxc-cgroup.sgml.in
index 9a5ead07397d3cb3dc83317191729de8587ff2f7..5acd313d4bc97a520cb577f7c4b900d350e753a2 100644 (file)
--- a/doc/lxc-cgroup.sgml.in
+++ b/doc/lxc-cgroup.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -74,17 +75,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <title>Options</title>
     <variablelist>
 
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name associated with a control group.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>
          <option><replaceable>subsystem</replaceable></option>
@@ -111,6 +101,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Examples</title>
     <variablelist>

diff --git a/doc/lxc-console.sgml.in b/doc/lxc-console.sgml.in
index ef4d270c1cb2d50c68eb59248683c8355f49c649..606c868ac2211caa50f93ba5e9fab050d8bb7fd2 100644 (file)
--- a/doc/lxc-console.sgml.in
+++ b/doc/lxc-console.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -81,17 +82,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <title>Options</title>
     <variablelist>
 
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to open a console.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>
          <option>-t <optional>ttynum</optional></option>
@@ -108,6 +98,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Diagnostic</title>
 

diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in
index 815ec2c832f42b24a168ff4598a13f773d99bdb4..343f310cf71e1ca142761ff816b96a225dd60a71 100644 (file)
--- a/doc/lxc-create.sgml.in
+++ b/doc/lxc-create.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -82,17 +83,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <title>Options</title>
     <variablelist>
 
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be created.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>
          <option>-f <replaceable>config_file</replaceable></option>
@@ -109,6 +99,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Diagnostic</title>
 

diff --git a/doc/lxc-destroy.sgml.in b/doc/lxc-destroy.sgml.in
index ba265aa9a1688997fd432e505d9addf7a371bc6a..f8c063ac43dba9a0cae1e8c637c42045379485d6 100644 (file)
--- a/doc/lxc-destroy.sgml.in
+++ b/doc/lxc-destroy.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -63,24 +64,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
-  <refsect1>
-    <title>Options</title>
-    <variablelist>
-
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be destroyed.
-         </para>
-       </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </refsect1>
+  &commonoptions;
 
   <refsect1>
     <title>Diagnostic</title>

diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in
index 0043d140c8414b5aa2305474626d6e37ff1a8bf4..6d5bcd4c9f6490a0556b96a46c611d6c4670139d 100644 (file)
--- a/doc/lxc-execute.sgml.in
+++ b/doc/lxc-execute.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -89,17 +90,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <title>Options</title>
     <variablelist>
 
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be executed.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>
          <option>-f <replaceable>config_file</replaceable></option>
@@ -116,6 +106,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Diagnostic</title>
 

diff --git a/doc/lxc-freeze.sgml.in b/doc/lxc-freeze.sgml.in
index 5a3eb1d0835e97b93d54d25b8ee869264b9c95a3..798ccf4087c37dd8b53bcdc43c1af7dc1919dd70 100644 (file)
--- a/doc/lxc-freeze.sgml.in
+++ b/doc/lxc-freeze.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -65,24 +66,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
-  <refsect1>
-    <title>Options</title>
-    <variablelist>
-
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be frozen.
-         </para>
-       </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </refsect1>
+  &commonoptions;
 
   <refsect1>
     <title>Diagnostic</title>

diff --git a/doc/lxc-monitor.sgml.in b/doc/lxc-monitor.sgml.in
index bacae5eaad70969e7e1daefe64707b512f0f1197..7f7e6b2ad3163c3882466f1a99feba11c3c38efa 100644 (file)
--- a/doc/lxc-monitor.sgml.in
+++ b/doc/lxc-monitor.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -64,25 +65,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
-  <refsect1>
-    <title>Options</title>
-    <variablelist>
-
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be monitored. This option
-           can be a regular expression conforming POSIX2.
-         </para>
-       </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </refsect1>
+  &commonoptions;
 
   <refsect1>
     <title>Examples</title>

diff --git a/doc/lxc-start.sgml.in b/doc/lxc-start.sgml.in
index 587b44505ce2a2a68c5d7b0be9bacbeba0c75614..34a983707a55295213b0b49931fe99696e83ce48 100644 (file)
--- a/doc/lxc-start.sgml.in
+++ b/doc/lxc-start.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -73,24 +74,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
-  <refsect1>
-    <title>Options</title>
-    <variablelist>
-
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be started.
-         </para>
-       </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </refsect1>
+  &commonoptions;
 
   <refsect1>
     <title>Diagnostic</title>

diff --git a/doc/lxc-stop.sgml.in b/doc/lxc-stop.sgml.in
index 6384c728b755ade12b9e4e8f7f93cbaf964fa6e4..d15e6497fa7c0cf03fd026971e9f7e97ad4fc3f8 100644 (file)
--- a/doc/lxc-stop.sgml.in
+++ b/doc/lxc-stop.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -63,24 +64,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
-  <refsect1>
-    <title>Options</title>
-    <variablelist>
-
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be stopped.
-         </para>
-       </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </refsect1>
+  &commonoptions;
 
   <refsect1>
     <title>Diagnostic</title>

diff --git a/doc/lxc-unfreeze.sgml.in b/doc/lxc-unfreeze.sgml.in
index f2360a03d5914187646d53cf281468919eae9bb4..bb00d852a8c4ded1bdd16e5b127fea01c4b6ad0f 100644 (file)
--- a/doc/lxc-unfreeze.sgml.in
+++ b/doc/lxc-unfreeze.sgml.in
@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -62,24 +63,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
-  <refsect1>
-    <title>Options</title>
-    <variablelist>
-
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be frozen.
-         </para>
-       </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </refsect1>
+  &commonoptions;
 
   <refsect1>
     <title>Diagnostic</title>

diff --git a/doc/lxc-wait.sgml.in b/doc/lxc-wait.sgml.in
index 5dc3566283c6402706619ab18549dab4aa9ac338..97a4c3987bde4a6a0c800921b54f2026393a6270 100644 (file)
--- a/doc/lxc-wait.sgml.in
+++ b/doc/lxc-wait.sgml.in
@@ -26,6 +26,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 ]>
 
@@ -66,17 +67,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
     <title>Options</title>
     <variablelist>
 
-      <varlistentry>
-       <term>
-         <option>-n <replaceable>name</replaceable></option>
-       </term>
-       <listitem>
-         <para>
-           Specify the container name to be waited.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>
          <option>-s <replaceable>states</replaceable></option>
@@ -93,6 +83,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
   </refsect1>
 
+  &commonoptions;
+
   <refsect1>
     <title>Examples</title>
     <variablelist>
@@ -106,7 +98,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
       </varlistentry>
 
       <varlistentry>
-       <term>lxc-wait -n 'RUNNING|STOPPED'</term>
+       <term>lxc-wait -n foo -s 'RUNNING|STOPPED'</term>
        <listitem>
        <para>
          exits when 'RUNNING' or 'STOPPED' state is reached.