*** This is the README file for the linuxdoc-sgml package, version 1.5

*** For more uptodate information, visit the linuxdoc-sgml homepage
    at http://www.informatik.tu-muenchen.de/~schwarz/linuxdoc-sgml/

Linuxdoc-SGML is a text-formatting package based on SGML (Standard 
Generalized Markup Language), which allows you to produce LaTeX,
HTML, GNU info, LyX, RTF, and plain ASCII (via groff) from a single source;
due to the flexible nature of SGML many other target formats are possible.

This system is tailored for writing technical software documentation, 
an example of which are the Linux HOWTO documents. However, there is nothing
Linux-specific about this package; it can be used for many other types of
documentation on many other systems. The name is simply derived from its
use for the Linux HOWTO documents. It should be useful for all kinds of 
printed and online documentation.

The current version of linuxdoc-sgml can be found at
 ftp://ftp.cc.gatech.edu/pub/people/gregh/linuxdoc-sgml/linuxdoc-sgml-1.5.tar.gz
 ftp://tsx-11.mit.edu/pub/linux/docs/linuxdoc-sgml-1.5.tar.gz
 ftp://sunsite.unc.edu/pub/Linux/utils/text/linuxdoc-sgml-1.5.tar.gz

Uptodate patches to version 1.5 can be found at
  ftp://ftp.cc.gatech.edu/pub/people/gregh/linuxdoc-sgml

You can join the linuxdoc-sgml mailing list by sending mail to
majordomo@via.ecp.fr with 'subscribe linuxdoc-sgml' in the message
body.  The list address is linuxdoc-sgml@via.ecp.fr.

The file doc/guide.sgml is SGML source for the User's Guide. As you 
probably don't know how to format it yet, there is formatted plain ASCII
in doc/guide.txt. There's also guide.dvi and guide.ps, if you wish to
print them instead. The first thing you should read is doc/guide.txt, 
which explains how to install the software, and how to start writing 
documents with it. The file doc/example.sgml is a simple example document
which you can use as a tutorial. 

For real-life examples of uses of Linuxdoc-SGML, look at the Linux HOWTOs 
on sunsite.unc.edu:/pub/Linux/docs/HOWTO/other-formats/sgml. These HOWTOs 
are written in SGML and automatically translated into PostScript, DVI, and 
ASCII using this system. You can also look at the URL
  http://sunsite.unc.edu/mdw/HOWTO/
which has HTML formats of many Linux HOWTOs, produced using Linuxdoc-SGML.

Linuxdoc-SGML is based on James Clark's sgmls parser, and the QWERTZ
DTD by Tom Gordon.  The linuxdoc-sgml package was created by Matt Welsh. 
It is currently maintained by Greg Hankins <greg.hankins@cc.gatech.edu>.

Please send me any questions or bug reports, as well as suggestions for 
improvement. I prefer patches. Specifically, if you're using Linuxdoc-SGML 
to write Linux documentation, and would like to see a particular feature 
added or changed, please get in touch with me.  In this way Linuxdoc-SGML 
can be quasi-standard for Linux documentation, and any documents written 
in it can be formatted using the same software. 

Share and enjoy,
Matt Welsh
Greg Hankins
(and other contributers)
