This file describes things you might want to know about
the Router Audit Tool (rat).  rat is a free tool for
checking the configuration of Cisco routers and
similar files.

INSTALL-AND-GO

  See etc/INSTALL.txt for quick-start instructions.

FOR MORE USEFUL READING

  See the doc/ directory.  It contains documentation
  for each program that is a part of the router
  audit tool in text, html and man formats.

RELEASE FILES

  The files in the tar file for this release are:

        rat-1.1/bin/ncat_report.PL      - Report Generator
        rat-1.1/bin/ncat.PL             - Audit tool checker
        rat-1.1/bin/rat.PL              - Main program
        rat-1.1/bin/snarf.PL            - Config grabber
        rat-1.1/bin/ncat_config.PL      - Program to localize rules

        rat-1.1/etc/README.WIN32.txt    - Windows README
        rat-1.1/etc/INSTALL.txt         - Top level Installation Instructions
        rat-1.1/etc/INSTALL.WIN32.txt   - Windows Installation Instructions
        rat-1.1/etc/INSTALL.cygwin.txt  - Cygwin Installation instructions
        rat-1.1/etc/INSTALL.unix.txt    - Unix Installation instructions
        rat-1.1/etc/CIS_TERMS.txt       - CIS Terms of use
        rat-1.1/etc/FAQ.txt             - Frequently Asked Questions
        rat-1.1/etc/GPL.txt             - GNU Public License
        rat-1.1/etc/LICENSING.txt       - Licensing info
	rat-1.1/etc/LOCALIZE.txt	- Instructions for localization

        rat-1.1/ChangeLog               - History of major changes
        rat-1.1/Makefile-nosnarf.PL     - Perl makefile w/o snarf
        rat-1.1/Makefile.PL             - Perl makefile
        rat-1.1/NSA_NOTICE.txt          - NSA distribution notice
        rat-1.1/README.txt              - This file
        rat-1.1/RELEASE-NOTES.txt       - Important low level changes
        rat-1.1/WISHLIST.txt            - Feature wishlist/future work.
        rat-1.1/cisco-ios-benchmark.html - The benchmark
        rat-1.1/rscg.pdf                - The NSA Router Security 
                                          Configuration Guide
        rat-1.1/winmake.PL		- Windows Makefile
        rat-1.1/doc/ncat_report.1       - Program documentation
        rat-1.1/doc/ncat.1                "     "       "
        rat-1.1/doc/ncat.html             "     "       "
        rat-1.1/doc/ncat.txt              "     "       "
        rat-1.1/doc/ncat_report.htm       "     "       "
        rat-1.1/doc/ncat_report.txt       "     "       "
        rat-1.1/doc/rat.1                 "     "       "
        rat-1.1/doc/rat.html              "     "       "
        rat-1.1/doc/rat.txt               "     "       "
        rat-1.1/doc/snarf.1               "     "       "
        rat-1.1/doc/snarf.html            "     "       "
        rat-1.1/doc/snarf.txt             "     "       "
        rat-1.1/etc/ncat.conf           - The raw config/rules file.
        rat-1.1/etc/ncat.conf.MASTER    - The MASTER config/rules file.
        rat-1.1/lib/NCAT.pm             - Shared config module  (versions)
        rat-1.1/t/placeholder.t         - A placeholder test

HOW YOU CAN HELP

  See WISHLIST.txt

AUTHOR

  George M. Jones

MAJOR CONTRIBUTORS

  John Stewart          - Much code cleanup, Perl make/install code/makefile
  Joshua Wright		- Windows port
  Neal Ziring           - Editor/Author of the configuration guide.

FEEDBACK 

  Please send bugs/feedback to 

    rat-feedback@cisecurity.org

$Id: README.txt,v 1.2 2002/03/07 12:25:32 gmj Exp $
