-----------------------------------------------------------------------------
 $Id: README,v 1.4 1999/01/03 19:25:37 lindig Exp $
-----------------------------------------------------------------------------

Tony is a simple XML parser and pretty printer. The parser is non
validating and does neither comply fully to the standard nor does it
use the DOM for internal representation of a parsed XML file. For more
information about XML and DOM see http://www.w3.org/.

This software release is experimental - you should not expect it to do
someful useful. It serves simply as a test case for the XML parser
which I perhaps like to use in future projects.


VERSION  
-------

See Makefile for the current version number or call the program
with -version flag to get the version.
 
BUILDING
--------

Compiling Tony requires OCaml 2.0 or above because the lexer uses the
'let' constructed introduced in OCaml 2.0. Simply typing 'make' should
work. There is no 'install' target. The executable 'tony' does not
need additional files so you can simply copy it somewhere in your
$PATH. Sorry, no man page.

INVOKING TONY
-------------

`tony -print doc/tony.xml' reads doc/tony.xml and pretty prints it to
stdout.

LIMITATIONS
-----------

* Character references are not resolved.
* White space is not exactly preseved.
* Document type can not be placed inline.
* No conditional section support.
* No Unicode support.
* Strings " .. " are not allowed to cross lines.
* ...

COPYING
-------

You can modify and redistribute this software under certain terms. See
the file COPYING for details.  In short:  do what you like but do not
blame me for any problems.

FEEDBACK
--------

Any feedback is appreciated - bug reports, patches, enhancements.
Please send them to the address given below.

AUTHOR 
------

Christian Lindig
TU Braunschweig
Software Institute
D-38106 Braunschweig
Germany 

lindig@ips.cs.tu-bs.de
http://www.cs.tu-bs.de/softech/people/lindig



