Imported from rancid-1.5.tar.gz.rancid-1.5

1 files changed, 32 insertions, 16 deletions

diff --git a/README b/README
index e595c2c..d273776 100644
--- a/README
+++ b/README
@@ -4,17 +4,20 @@ maintain CVS controlled copies of router configs.
 The following is the packing list for Rancid:
 
 README -    This file.
-env    -    Enviromental settings needed.
+CHANGES -   List of changes to Rancid.
+Todo -      partial Todo list of what needs to be done.
+env -       Enviromental settings needed.
 do-diffs -  Script designed to be run from cron calling control_rancid.
 control_rancid -    Builds router list, calls rancid on each router and
-                    handles cvs routines.
-rancid-fe - chooses between rancid/francid/jrancid/rrancid.
+		    handles cvs routines.
+rancid-fe - chooses between rancid/francid/jrancid/rrancid/cat5rancid.
 rancid -    Runs commands on cisco routers and processes the output - the meat.
 francid -   Runs commands on foundry switches and processes the output.
 jrancid -   Runs commands on juniper routers and processes the output.
 rrancid -   Runs commands on redback routers and processes the output.
+cat5rancid -Runs commands on cisco cat5 switches and processes the output.
 clogin -    Expect script that logs into routers either interactively,
-            runs a set of commands or runs another expect script.
+	    runs a set of commands or runs another expect script.
 flogin -    Expect script that logs into foundry switches.  once foundry
 	    cleans up their bloody UI, clogin should do the job.
 jlogin -    Expect script that logs into juniper routers similarly to
@@ -22,17 +25,27 @@ jlogin -    Expect script that logs into juniper routers similarly to
 	    -c and -s options.
 .cloginrc - TCL commands to set passwords, usernames etc. used by clogin and
 	    jlogin.
-par    -    Parallel processing of commands - any commands.
+par -       Parallel processing of commands - any commands.
+rename -    Perl script to rename files.
+create_cvs -Creates all of the CVS and config directories.
+util -      utilities / contribs
 
 rancid will also need to have the following packages:
 cvs	- code revision system available from prep.ai.mit.edu:/pub/gnu
 gnudiff - gnudiff provides the -u option.  if you do not have gnudiff,
-          you will have to modify control_rancid to use 'diff -c' or some
-          such.  see examples.
+	  you will have to modify control_rancid to use 'diff -c' or some
+	  such.  see examples.
 perl5	- perl version 5 or greater available from www.cpan.org
 expect	- http://expect.nist.gov/
 tcl	- required by expect.
 
+Bill Fenner has a cgi script for interacting with CVS repositories via
+a web interface.  This provides a great way to view rancid diffs and
+full configs, especially for those unfamiliar with cvs.  The package is
+not included here, but can be found here:
+
+	http://www.freebsd.org/~fenner/cvsweb/cvsweb-1.0.tar.gz
+
 Quick Installation Guide (an example):
 
 1) mkdir <basedir>
@@ -40,11 +53,14 @@ Quick Installation Guide (an example):
 
 2) mkdir <basedir>/bin
 
-3) Put the contents of rancid/bin in <basedir>/bin.  modify the location of
-   perl and expect in each of clogin, par, rancid, rancid-fe, jlogin,
-   jrancid, and rename if necessary.  Make sure that you are using perl
-   version 5 and not perl version 4.  There are also 3 calls to perl in
-   control_rancid.
+3) Put the contents of rancid/bin in <basedir>/bin.
+
+   Modify the location of perl and expect in each of cat5rancid,
+   clogin, flogin, francid, jlogin, jrancid, par, rancid, rancid-fe,
+   rename, and rrancid if necessary.  There are also 3 calls to
+   perl in control_rancid and one in do-diffs.
+
+   Make sure that you are using perl version 5 and not perl version 4.
 
 4) Modify <basedir>/bin/env.
 
@@ -80,10 +96,10 @@ Quick Installation Guide (an example):
 
 9) For each "group", modify the router.db file in the group directory.
    The file is of the form "router:mfg:state" where "router" is
-   the name (we use FQDN) of the router, mfg is the manufacturer from the
-   set of (cisco|foundry|juniper|redback), and "state" is either up or
-   down.  Each router listed as "up" will have the configuration
-   grabbed.
+   the name (we use FQDN) of the router, mfg is the manufacturer
+   from the set of (cisco|foundry|juniper|redback|cat5), and "state"
+   is either up or down.  Each router listed as "up" will have the
+   configuration grabbed.
 
 10) Put do-diffs in cron to be called however often you want it to run
     for each group (do-diffs [<GROUP>]).  eg: