do as R. Buchholz wants

This commit is contained in:
marschap
2006-10-02 18:00:38 +00:00
parent 81f2dc9fc4
commit 960b039b98
3 changed files with 53 additions and 25 deletions
+3 -3
View File
@@ -36,9 +36,9 @@ In order to compile LCDproc, you'll need the following programs:
Depending on the ./configure options and your choice of drivers, you will Depending on the ./configure options and your choice of drivers, you will
need some additional programs or libraries installed: need some additional programs or libraries installed:
* DocBook if you want to create the documentation or Doxygen when used with * DocBook XML converter "xmlto" if you want to create the documentation
--enable-doxygen, also see or Doxygen when used with --enable-doxygen, also see
http://sources.redhat.com/docbook-tools/ and http://cyberelk.net/tim/xmlto/ and
http://www.stack.nl/~dimitri/doxygen/ http://www.stack.nl/~dimitri/doxygen/
* OpenLDAP if you --enable-ldap, see http://www.openldap.org/software/ * OpenLDAP if you --enable-ldap, see http://www.openldap.org/software/
+25 -11
View File
@@ -1,18 +1,32 @@
README.docbook README.docbook
--------------
You can generate the documentation of LCDproc using The documentation for LCDproc is written in DocBook,
the Docbook utilities. to be exact: DocBook V4.x XML.
You can generate the documentation of LCDproc using 'xmlto',
which is a shell-script frontend to an XML toolchain.
Get it from http://cyberelk.net/tim/xmlto/ or pre-packaged
from your distribution.
To convert the Admin Guide to a single XHTML document, simply do:
$ xmlto xhtml-nochunks lcdproc-dev.docbook
See xlmto's man page for further conversion targets.
In earlier releases it was possible to convert the LCDproc documentation
using the Docbook utilities, but unfortunately this is not possible any
more.
$ docbook2html lcdproc-dev.docbook $ docbook2html lcdproc-dev.docbook
should generate ist as HTML. should create HTML documents, but currently fails.
On my box (Mdk 8.1) I have to run Unfortunately I am not expert enough in DocBook and SGML to find out why.
If you find out the cause of this failure, please do not hesitate to post
the fix tho the LCDproc mailing list.
$ docbook2html -c /etc/sgml/catalog lcdproc-dev.docbook Peter Marschall
(-c defines the location of the SGML catalog)
Another tool is 'xmlto', use it this way:
$ xmlto html lcdproc-dev.docbook
+25 -11
View File
@@ -1,18 +1,32 @@
README.docbook README.docbook
--------------
You can generate the documentation of LCDproc using The documentation for LCDproc is written in DocBook,
the Docbook utilities. to be exact: DocBook V4.x XML.
You can generate the documentation of LCDproc using 'xmlto',
which is a shell-script frontend to an XML toolchain.
Get it from http://cyberelk.net/tim/xmlto/ or pre-packaged
from your distribution.
To convert the User Guide to a single XHTML document, simply do:
$ xmlto xhtml-nochunks lcdproc-user.docbook
See xlmto's man page for further conversion targets.
In earlier releases it was possible to convert the LCDproc documentation
using the Docbook utilities, but unfortunately this is not possible any
more.
$ docbook2html lcdproc-user.docbook $ docbook2html lcdproc-user.docbook
should generate ist as HTML. should create HTML documents, but currently fails.
On my box (Mdk 8.1) I have to run Unfortunately I am not expert enough in DocBook and SGML to find out why.
If you find out the cause of this failure, please do not hesitate to post
the fix tho the LCDproc mailing list.
$ docbook2html -c /etc/sgml/catalog lcdproc-user.docbook Peter Marschall
(-c defines the location of the SGML catalog)
Another tool is 'xmlto', use it this way:
$ xmlto html lcdproc-dev.docbook