README

This is the distribution of Perl program(s) and library(s) dealing with
SGML DTDs.

---------------------------------------------------------------------------
    Copyright (C) 1994  Earl Hood, ehood@convex.com

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
---------------------------------------------------------------------------
CONTENTS of distribution:

COPYING		GNU General Public License
README		The file you are reading
doc/		Documentation
dtd/		Location of Perl libraries
dtd.pl		Symbolic link to dtd/dtd.pl
dtd2html*	Perl program to create HTML files to navigate a SGML DTD
dtdtree*	Perl program to output content hierarchies of SGML elements
ents/		SGML entity files
install_dtd*	Installation (csh) script
map.txt		Sample entity map file
sgm/		SGML files (mostly DTDs)


---------------------------------------------------------------------------
INSTALLATION

For installation, do the following:

	1. Read and edit the csh script, install_dtd.
	2. Run install_dtd.

You might have to run the script as root.

    Note:
	The Perl programs might need the first line editted to point
	to the location of the Perl interpreter at your site.  By 
	default, the programs assume /usr/loca/bin/perl.

See NOTES below for further information.
    
---------------------------------------------------------------------------
DOCUMENTATION

Documentation is located in the directory doc/.  The documentation is in
plain ASCII and in HTML.  Reading the files in doc/ should get you
started on how to the programs.

If you have a Web client like Mosaic, you can load the HTML files into
the viewer for reading.  The HTML files contain cross-references (that
hopefully help in describing things) to each other.

---------------------------------------------------------------------------
NOTES

 o  The Perl programs make use of the file "dtd.pl".  The installation
    script trys to install this file in a standard Perl library
    location in a sub-directory called "dtd".  However, if you
    install it in a location that Perl does not look for when
    requiring files, then make sure you set the PERLLIB environment
    variable.

---------------------------------------------------------------------------
BUGS/COMMENTS/SUGGESTIONS?

    If you have any bugs/comments/suggestions, feel free to drop me
    an e-mail message at ehood@convex.com.

---------------------------------------------------------------------------
Earl Hood, ehood@convex.com
