
                           cxx2html, Version 1.2
                                     Patchlevel 2

            Copyright (c) 1995  Associated Universities, Inc.
                                Washington DC, USA.

				    Author:
			Darrell Schiebel <drs@nrao.edu>
------------------------------------------------------------------------
    This program is free software; you can redistribute it and/or modify
    it under the terms of the the GNU General Public License as
    published by the Free Software Foundation; either version 2, or
    (at your option) any later version. 

    Some individual files contain copyright information which applies
    to that file only and which may be less restrictive than the GNU
    General Public License (GPL). If a particular file contains
    copyright information, then that file is available under either
    the GNU GPL or the copyright contained in that file. 

    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 either
    the GNU General Public License for more details.
------------------------------------------------------------------------

This program, cxx2html, was written to extract documentation from C++
header files and generate HTML pages for the classes described in the
header files. It is written in Perl 5.0 (version 4.* of Perl will not
work), and it attempts to create all of the important hypertext links
implicit within the class description, e.g. links to parents or links
to documentation for function parameters. This script is used to
generate the class reference manual for the AIPS++ project. For
information on the AIPS++ project see the following URL:

    http://info.cv.nrao.edu/aips++/docs/html/aips++.html

If you would like to see what the output of this extractor looks like,
please look at the following URL:

    http://info.cv.nrao.edu/aips++/docs/aips/implement/Arrays/Array.html
    http://info.cv.nrao.edu/aips++/docs/aips/implement/Tables.html

The HTML documentation for cxx2html is also available:

    http://info.cv.nrao.edu/aips++/RELEASED/cxx2html/

The typical invocation for cxx2html is something like:

	cxx2html *.h

========================================================================

INSTALLATION

1) Run Configure. Configure will ask you a series of questions, and
provide its best guess of the answer as the default. After it has
completed, it will produce config.sh and the Makefiles which are used
to install cxx2html and its libraries.

You might possibly have to trim # comments from the front of Configure
if your shell doesn't handle them, but all other comments will be taken
care of.

2) Run make.

3) If make was successful, a sample set of HTML pages should have been
created in the "sample" subdirectory. To view these pages under Mosaic
or an equivalent browser do something like:

    Mosaic -home sample/Tables.html

The header files in the "sample" subdirectory also demonstrate the
sort of markup which is supported within the C++ comments.

3) If everything was successful up to this point and you like what you
see, you may wish to do "make install install.man". This is necessary
for cxx2html to work properly. Be sure you have write permission for
the directories in which you are installing this program. By not
running "make install.man", you avoid the installation of the manual
page. 

4) If you would like an HTML version of the man page, you should
change to the "pod" directory and do "make html". This will generate
"cxx2html.html". You then must copy it to where you would like it
to reside.

5) Read the manual entry before running.

6) Report any problems or suggested patches to cxx2html@nrao.edu, so we
can keep this distribution up to date. If you have a problem, there will
be someone else who had it or will have it too... 

7) If you wish to deinstall the package, you may run "make deinstall".
A separate "make deinstall.man" will remove the manual pages. Be sure
the makefiles are correctly set before running any deinstall target.
On USG systems, some executable have a chance to remain despite the
deinstall (text file busy...).

========================================================================

CURRENT VERSION

The most recent version of cxx2html is available by anonymous ftp from
`aips2.cv.nrao.edu' in the directory `/pub/aips++/RELEASED/cxx2html'.

========================================================================

KNOWN BUGS

The following are bugs know to exist in this distribution:

	o  enums are not handled
	o  nested classes and structs are not handled
