#
# Copyright (c) Xerox Corporation 1997, 1998. All rights reserved.
#
# License is granted to copy, to use, and to make and to use derivative
# works, provided that Xerox is acknowledged in all documentation
# pertaining to any such copy or derivative work. Xerox grants no other
# licenses expressed or implied. The Xerox trade name should not be used
# in any advertising without its written permission.
#
# XEROX CORPORATION MAKES NO REPRESENTATIONS CONCERNING EITHER THE
# MERCHANTABILITY OF THIS SOFTWARE OR THE SUITABILITY OF THIS SOFTWARE
# FOR ANY PARTICULAR PURPOSE.  The software is provided "as is" without
# express or implied warranty of any kind.
#
# These notices must be retained in any copies of any part of this software.
#



This directory contains programs which produce the html reports and collect
the long term routing statistics:

perl scripts which generate html and the route_stats file
---------------------------------------------------------
htmlmaker:  takes input from routemonitor and generates html output.
            htmlmaker also generates the route_stats file which is
	    search by the cgi scripts and stores long term statistics.
            htmlmaker may also archive copies of the route_stats files
	    and route_tables dumped by route_monitor, see the htmlmaker
	    man page for options to trigger archiving.

	    htmlmaker will run routemonitor/routewatch and is the principle
	    program in this package.

	    you can start the entire package by simply running htmlmaker.


helper perl scripts:
--------------------------------------------------
aslookup:  finds the AS number for source addresses.  htmlmaker will
           execute aslookup when it needs to find the AS number for
           a new source.
	   this program is run automatically by htmlmaker

asretry:   if aslookup fails to find an AS number for a source, the AS
           is set to -1.  asrety instructs htmlmaker to retry aslookup 
	   for every source which was assigned AS -1.  
           this utility can be run if a number of sources were assigned
           AS of -1 due to problems with the whois server.

statsedit: allows manipulation of individual entries in the htmlmaker
	   route statistics database.  statsedit will signal htmlmaker
	   and force htmlmaker to accept any changes generated by statsedit.
           this utility can be run to make adjustments to the database,
           for example manually changing the AS for a source, changing
           the stats count for a source, etc.


source directory:
---------------------------------------------------------
the source directory should be ignored unless you plan
to make changes to the htmlmaker source code.  if you
do plan to modify the source code, review the README 
file in ./source.
