Return to PG.readme CVS log

Up to [Development] / failsafe / FailSafe-books / LnxFailSafe_PG

New documentation files for the Programmers' Guide.

Linux FailSafe Programmer's Guide README
----------------------------------------

This book is written in SGML using the DocBook 3.0 DTD.  The web site
http://www.oasis-open.org/docbook/ is the official home page for DocBook
and serves as a great source for information and mailing lists.

To process these SGML files into various output formats such as HTML and
PDF files, consult the following:
 + DocBook stylesheets - http://www.nwalsh.com/docbook/index.html
 + SGMLTools Lite - http://sgmltools-lite.sourceforge.net/
 + OpenJade stylesheet processor - http://openjade.sourceforge.net/

Providing Feedback
------------------

Please send comments and questions regarding the Linux FailSafe Programmer's 
Guide to: linuxfailsafe@lists.tummy.com

If you want to submit a patch of documentation changes, please send it to:
owner-failsafe@oss.sgi.com

Online vs. Print Figures
------------------------

The figures directory contains both GIF files for online display and
EPS files for printing.  The entities for the figures in the main book.sgml
file determine which version of the figures will be used in the book.  To
switch between the GIF and EPS files requires replacing all 'gif' strings
with 'eps' as needed.

The following command switches from GIF files to EPS files:
perl -pi.bak -e 's/\.gif" NDATA gif/.eps" NDATA eps/' *.sgml

Likewise, the following command switches from EPS to GIF:
perl -pi.bak -e 's/\.eps" NDATA eps/.gif" NDATA gif/' *.sgml

Generated index.sgml file
-------------------------

The index.sgml file was generated using collateindex.pl along
with the DocBook DSSSL stylesheets.