==========================================================================
=    dxref: experimental C cross referencer using DWARF2 debugging info. = 
=    -- Copyright (c) 2003, gondow@jaist.ac.jp, All rights reserved.     =
==========================================================================

Disclaimer:
-----------
    WARNING: this software is not completely tested.
    This software is intended to be useful, but it has no warranty.
    Use this software at your own risk. We disclaim any liability of any 
    kind of damages whatsoever resulting from the use of this software.

Overview:
---------
    This is the beta version of dxref, an experimental cross referencer
    using DWARF2 debugging information.
    `dxref' is still under development; further debugging, testing, and
    refactoring are required.

    dxref requires `readelf+' and `dwarf2.dtd' to produce DWARF2-XML
    documents.

Platform:
---------
    Currently, we compiled and tested dxref in the following platform.

    - Solaris 8, GCC 3.3.2

Build and Installation:
------------
    Before do the following, please make sure that libxml2 is installed.

    To build, 

	% tar xvzf dxref-b2.tgz; cd dxref-b2
        % make

    To install, 
        % make install INSTALL_DIR=/somewhere/dxref/to/be/placed
        % set path = (/somewhere/dxref/to/be/placed $path)

Usage:
------
    	% gcc -g3 -gdwarf-2 foo.c
        % cp /somewhere/dxref/to/be/placed/dwarf2.dtd
        % readelf+ -X a.out > foo.xml
    	% dxref --src2html  foo.xml
        % /your/web/browser ./HTML/dxref_top.html
