Gentoo Archives: gentoo-dev

From: AGottinger@t-online.de (Achim Gottinger)
To: gentoo-dev@g.o
Subject: [gentoo-dev] Gentoo doc docbook example
Date: Wed, 21 Mar 2001 00:57:48
Message-Id: 3AB858EE.77A4DB39@gottinger.de
1 Hi there,
2
3 I tried to convert our ebuild man pages to Linux Doc style first, but I
4 found that it misses too much of the
5 docbook stuff and is only usefull for small howto's.
6 So I decided to use sgml-docbook-dtd-4.1 for my tests.
7
8 There are three new files in gentoo-doc/files.
9
10 ebuild.sgml The Book
11 refentry/ebuild-1.sgml The ebuild(1) man page sgmlized
12 refentry/ebuild-5.sgml The ebuild(5) man page
13
14 If you have a working docbook environment you can make html, pdf and man
15 output from that (texi makes problems , others should work).
16
17 If you run "docbook2man ebuild.sgml" you will get the two man pages
18 ebuild.1 and ebuild.2 without the other
19 book stuff.
20
21 If you run "docbook2html ebuild.sgml" you will get a bunch of html pages
22 index.html contains the TOC.
23
24 Give "docbook2pdf ebuild.sgml" a try and open ebuild.pdf with acroread.
25 You will see that you have a nice toc
26 in there too.
27
28 Assuming you have updated kdelibs to the version that installs docbook
29 stuff in /usr/share/sgml, you can
30 even run "kdb2html ebuild.sgml".
31 The result will be a dir called HTML with a bunch of html's, that fit
32 perfectly into kde's documentation.
33
34 Please guys give this stuff a try and me feedback. !
35
36
37 achim~

Replies

Subject Author
Re: [gentoo-dev] Gentoo doc docbook example AGottinger@t-online.de (Achim Gottinger)