Thu Nov  2 13:03:00 1995 - autodoc version 1.8.4 release notes: INSTALL

 CONFIRMING AUTODOC RESOURCES
	
The complete autodoc package should include the following files:
----------------------------------------------------------------
	CHANGES
	README
	INSTALL
	bin/autodoc                                 (rev-1.5)
	lib/perl5/Autodoc/DumpDocs.pm               (rev-1.3)
	lib/perl5/Autodoc/GenerateRTF.pm            (rev-1.3)
	lib/perl5/Autodoc/ParseComments.pm          (rev-1.2)
	lib/perl5/Autodoc/ReadSource.pm             (rev-1.2)
	lib/perl5/Autodoc/ScanFile.pm               (rev-1.2)
	lib/perl5/Autodoc/FileSupport.pm            (rev-1.3)
	lib/perl5/Autodoc/LogDebug.pm               (rev-1.2)
	Guide/Autodoc.rtf
	htdocs/Autodoc.html
	htdocs/Autodoc_OptsHist.html
	Examples/README
	Examples/Documentation/MyView.rtf
	Examples/Documentation/MyFooProtocol.rtf
	Examples/Source/MyView.h
	Examples/Source/MyView.m
	Examples/Source/MyFooProtocol.h
	Examples/Source/MyFooProtocol.mdoc
	Notes/TODO
	Notes/BUGS


 INSTALLING THE AUTODOC EXECUTABLE

The file autodoc should be copied to a directory which is in your execution path (eg. /usr/local/bin)


 INSTALLING THE AUTODOC SUPPORT MODULES

The lib/perl5 modules (.pm files) should be copied to the directory where perl looks for its modules (usually: /usr/local/lib/perl5).  

For example, move DumpDocs.pm to "/usr/local/lib/perl5/Autodoc/DumpDocs.pm"
Alternatively, you can set the environment variable AD_PMLIBDIR to specify an alternate location.  Note that AD_PMLIBDIR should refer to the directory containing the "Autodoc/*.pm" directory.


 TESTING

To confirm that you have the correct version installed and is accessible in your path, try executing:
	% autodoc -version
You should see the following output (verbatim):
-----------------------------------------------
This is autodoc Release 1.8.4 (rev-1.5)
Module versions:
	FileSupport.pm (rev-1.3)
	LogDebug.pm (rev-1.2)
	ScanFile.pm (rev-1.2)
	ReadSource.pm (rev-1.2)
	ParseComments.pm (rev-1.2)
	DumpDocs.pm (rev-1.3)
	GenerateRTF.pm (rev-1.3)
Written by Adam Swift <aswift@friday.com>
Copyright Friday Software and Consulting, 1995 - All Rights Reserved
Please send bugs and suggestions to:<autodoc@friday.com>
Contributions by:
	Bill Bumgarner <bbum@friday.com>
	Todd Anthony Nathan <todd@icebox.com>
	Kim Shrier <kim@media.com>
	Craig Kelley <ckelley@capaccess.org>


 TROUBLE SHOOTING

If you run into trouble setting up your environment to run autodoc, read the installation section of the autodoc guide to see a more detailed description of how to configure autodoc to your environment.  If you still have problems, email me at: aswift@apdg.com