lcdproc

Files

T

mmdolze 66023939a1 Cleanup and documentation updates:

- Remove shared/str.h where not used.
- Remove shared/debug.h from all files as it has been completely replaced
  by shared/report.h (it will be removed later).
- Add more doxygen comments to shared/* and clients/lcdproc/*.
- Include static functions in doxygen output.

2010-02-02 23:20:29 +00:00

.cvsignore

added .cvsignore files, thanks to Volker Boerchers for his contribution

2005-05-22 07:16:48 +00:00

add-your-driver.docbook

Replace <term><args> with <term><synopsis> or <term><option> as the first one

2009-06-12 11:15:20 +00:00

bookinfo.docbook

Post release update of version numbers.

2009-06-21 21:47:42 +00:00

driver-api.docbook

Replace <term><args> with <term><synopsis> or <term><option> as the first one

2009-06-12 11:15:20 +00:00

introduction.docbook

Check all http links, update permanent redirects. Do not remove links with

2010-01-30 18:53:43 +00:00

language.docbook

Use inline elements in term definition. Update to Docbook 4.5.

2009-06-20 13:10:40 +00:00

lcdproc-dev.docbook

Use inline elements in term definition. Update to Docbook 4.5.

2009-06-20 13:10:40 +00:00

license.docbook

FSF address change

2006-09-30 18:18:22 +00:00

make-driver.docbook

Replace <term><args> with <term><synopsis> or <term><option> as the first one

2009-06-12 11:15:20 +00:00

Makefile.am

add Makefile targets to compile & install clients & server separately

2008-10-10 10:08:10 +00:00

README.docbook

Check all http links, update permanent redirects. Do not remove links with

2010-01-30 18:53:43 +00:00

shared-files.docbook

Cleanup and documentation updates:

2010-02-02 23:20:29 +00:00

README.docbook

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 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

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