From: Michel Normand Date: Thu, 28 May 2009 13:32:29 +0000 (+0200) Subject: change man pages to use a seealso file for references X-Git-Tag: lxc_0_6_3~56 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=99e4008cad9e959b683c6f48411fcf15a92be3b5;p=thirdparty%2Flxc.git change man pages to use a seealso file for references the common references to lxc man pages are now placed in one file "see_also.sgml.in" Note that the few man pages that refer to man pages that are not lxc ones have two "See Also" paragraph. Signed-off-by: Michel Normand Signed-off-by: Daniel Lezcano --- diff --git a/configure.ac b/configure.ac index 6e2834502..f8d95c4e7 100644 --- 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/see_also.sgml scripts/Makefile scripts/lxc-debian diff --git a/doc/Makefile.am b/doc/Makefile.am index 46a7dbb96..6113e46d9 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -23,13 +23,15 @@ man_MANS = \ %.1 : %.sgml - docbook2man $< + docbook2man -w all $< %.5 : %.sgml - docbook2man $< + docbook2man -w all $< %.7 : %.sgml - docbook2man $< + docbook2man -w all $< + +lxc-%.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 47ab8d2c5..9a5ead073 100644 --- a/doc/lxc-cgroup.sgml.in +++ b/doc/lxc-cgroup.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -151,17 +154,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc.conf - 5 - , - - - + &seealso; Author diff --git a/doc/lxc-console.sgml.in b/doc/lxc-console.sgml.in index f86b85084..ef4d270c1 100644 --- a/doc/lxc-console.sgml.in +++ b/doc/lxc-console.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -125,18 +128,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc.conf - 5 - - - - - + &seealso; Author diff --git a/doc/lxc-create.sgml.in b/doc/lxc-create.sgml.in index f4022f28a..815ec2c83 100644 --- a/doc/lxc-create.sgml.in +++ b/doc/lxc-create.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -127,28 +130,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-destroy - 1 - , - - - lxc-execute - 1 - , - - - lxc.conf - 5 - - - - - + &seealso; Author diff --git a/doc/lxc-destroy.sgml.in b/doc/lxc-destroy.sgml.in index 4d540d804..ba265aa9a 100644 --- a/doc/lxc-destroy.sgml.in +++ b/doc/lxc-destroy.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -111,23 +114,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-create - 1 - , - - - lxc-stop - 1 - , - - - - + &seealso; Author diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in index c14ed72a5..0043d140c 100644 --- a/doc/lxc-execute.sgml.in +++ b/doc/lxc-execute.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -133,39 +136,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-create - 1 - , - - - lxc-destroy - 1 - , - - - lxc-start - 1 - , - - - lxc-stop - 1 - , - - - lxc.conf - 5 - - - - - - + &seealso; Author diff --git a/doc/lxc-freeze.sgml.in b/doc/lxc-freeze.sgml.in index 8fb66c696..5a3eb1d08 100644 --- a/doc/lxc-freeze.sgml.in +++ b/doc/lxc-freeze.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -101,18 +104,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-unfreeze - 1 - , - - - - + &seealso; Author diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in index 1fea4531b..3ffd4f898 100644 --- a/doc/lxc-ls.sgml.in +++ b/doc/lxc-ls.sgml.in @@ -24,7 +24,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -112,9 +115,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA , - + &seealso; + Author Daniel Lezcano daniel.lezcano@free.fr diff --git a/doc/lxc-monitor.sgml.in b/doc/lxc-monitor.sgml.in index 35df19002..bacae5eaa 100644 --- a/doc/lxc-monitor.sgml.in +++ b/doc/lxc-monitor.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -154,9 +157,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA , - + &seealso; + Author Daniel Lezcano daniel.lezcano@free.fr diff --git a/doc/lxc-ps.sgml.in b/doc/lxc-ps.sgml.in index ce0c4fa52..737457231 100644 --- a/doc/lxc-ps.sgml.in +++ b/doc/lxc-ps.sgml.in @@ -24,7 +24,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -126,9 +129,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA , - + &seealso; + Author Daniel Lezcano daniel.lezcano@free.fr diff --git a/doc/lxc-start.sgml.in b/doc/lxc-start.sgml.in index e536450eb..587b44505 100644 --- a/doc/lxc-start.sgml.in +++ b/doc/lxc-start.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -120,39 +123,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-create - 1 - , - - - lxc-destroy - 1 - , - - - lxc-start - 1 - , - - - lxc-stop - 1 - , - - - lxc.conf - 5 - - - - - - + &seealso; Author diff --git a/doc/lxc-stop.sgml.in b/doc/lxc-stop.sgml.in index 31e4b9666..6384c728b 100644 --- a/doc/lxc-stop.sgml.in +++ b/doc/lxc-stop.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -110,18 +113,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-start - 1 - , - - - - + &seealso; Author diff --git a/doc/lxc-unfreeze.sgml.in b/doc/lxc-unfreeze.sgml.in index 1e36fdf32..f2360a03d 100644 --- a/doc/lxc-unfreeze.sgml.in +++ b/doc/lxc-unfreeze.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -98,18 +101,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-unfreeze - 1 - , - - - - + &seealso; Author diff --git a/doc/lxc-wait.sgml.in b/doc/lxc-wait.sgml.in index dc6d1e5d5..5dc356628 100644 --- a/doc/lxc-wait.sgml.in +++ b/doc/lxc-wait.sgml.in @@ -24,7 +24,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -134,18 +137,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - See Also - - - - lxc-info - 1 - , - - - - + &seealso; Author diff --git a/doc/lxc.conf.sgml.in b/doc/lxc.conf.sgml.in index 66ea4d546..76319d185 100644 --- a/doc/lxc.conf.sgml.in +++ b/doc/lxc.conf.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -589,16 +592,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA See Also - - lxc-create - 1 - , - - - lxc-execute - 1 - , - chroot 1 @@ -617,6 +610,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + &seealso; + Author Daniel Lezcano daniel.lezcano@free.fr diff --git a/doc/lxc.sgml.in b/doc/lxc.sgml.in index 2dfd79feb..31f5e1807 100644 --- a/doc/lxc.sgml.in +++ b/doc/lxc.sgml.in @@ -23,7 +23,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA --> - + +]> @@ -577,86 +580,7 @@ rootfs the frozen version. - - See Also - - - lxc-create - 1 - , - - - lxc-destroy - 1 - , - - - lxc-start - 1 - , - - - lxc-execute - 1 - , - - - lxc-stop - 1 - , - - - lxc-console - 1 - , - - - lxc-monitor - 1 - , - - - lxc-wait - 1 - , - - - lxc-cgroup - 1 - , - - - lxc-ls - 1 - , - - - lxc-ps - 1 - , - - - lxc-info - 1 - , - - - lxc-freeze - 1 - , - - - lxc-unfreeze - 1 - , - - - lxc.conf - 5 - , - - - + &seealso; Author diff --git a/doc/see_also.sgml.in b/doc/see_also.sgml.in new file mode 100644 index 000000000..93b9344b9 --- /dev/null +++ b/doc/see_also.sgml.in @@ -0,0 +1,113 @@ + + + + See Also + + + + lxc + 1 + , + + + lxc-create + 1 + , + + + lxc-destroy + 1 + , + + + lxc-start + 1 + , + + + lxc-stop + 1 + , + + + lxc-execute + 1 + , + + + lxc-console + 1 + , + + + lxc-monitor + 1 + , + + + lxc-wait + 1 + , + + + lxc-cgroup + 1 + , + + + lxc-ls + 1 + , + + + lxc-ps + 1 + , + + + lxc-info + 1 + , + + + lxc-freeze + 1 + , + + + lxc-unfreeze + 1 + , + + + lxc.conf + 5 + + + + + +