Files
lcdproc/docs/lcdproc-user
mmdolze 8bdfdaaaa1 - Convert function comments to Doxygen.
- Remove instructions that have been transfered to the User's Guide.
- Remove the unused line drawing function.
- Pass through indent.
- Add more comments to the initialization code.
- In the user guide remove table with wiring scheme by LCD pin but add a new
  one for bitshaker wiring.
2011-01-15 19:32:01 +00:00
..
2006-09-30 18:18:22 +00:00

README.docbook
--------------

The documentation for LCDproc is written in DocBook,
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/software/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

should create HTML documents, but currently fails.

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.

Peter Marschall