summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorunknown <unknown@unknown>2008-02-13 20:34:57 +0000
committerunknown <unknown@unknown>2008-02-13 20:34:57 +0000
commitb73f299e731fbddae095c0b5eff04717b6dce1af (patch)
treed8ca33707e5504dfd33714c39900160f3a2598f7 /man
parentac54243f382e817c08c1f895ccfdc05dcacdb044 (diff)
downloadrancid-master.zip
rancid-master.tar.gz
rancid-master.tar.xz
Imported from rancid-2.3.2a8.tar.gz.HEADrancid-2.3.2a8master
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am68
-rw-r--r--man/Makefile.in24
-rw-r--r--man/agmrancid.1 (renamed from man/drancid.1)0
-rw-r--r--man/avologin.11
-rw-r--r--man/avorancid.11
-rw-r--r--man/clogin.124
-rw-r--r--man/cloginrc.52
-rw-r--r--man/par.18
-rw-r--r--man/rancid.117
-rw-r--r--man/rancid.conf.5.in14
-rw-r--r--man/rancid_intro.130
-rw-r--r--man/router.db.546
-rw-r--r--man/rrancid.11
-rw-r--r--man/srancid.11
14 files changed, 171 insertions, 66 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index 5cf66fc..585c7a2 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,39 +1,65 @@
## Process this file with automake to produce Makefile.in
## A Makefile.in is supplied, in case you do not have automake.
-## $Id: Makefile.am,v 1.46 2006/09/05 02:26:52 asp Exp $
+## $Id$
##
-## Copyright (C) 1997-2004 by Terrapin Communications, Inc.
+## Copyright (c) 1997-2007 by Terrapin Communications, Inc.
## All rights reserved.
##
-## This software may be freely copied, modified and redistributed
-## without fee for non-commerical purposes provided that this license
-## remains intact and unmodified with any RANCID distribution.
+## This code is derived from software contributed to and maintained by
+## Terrapin Communications, Inc. by Henry Kilmer, John Heasley, Andrew Partan,
+## Pete Whiting, Austin Schutz, and Andrew Fort.
##
-## There is no warranty or other guarantee of fitness of this software.
-## It is provided solely "as is". The author(s) disclaim(s) all
-## responsibility and liability with respect to this software's usage
-## or its effect upon hardware, computer systems, other software, or
-## anything else.
-##
-## Except where noted otherwise, rancid was written by and is maintained by
-## Henry Kilmer, John Heasley, Andrew Partan, Pete Whiting, and Austin Schutz.
+## Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions
+## are met:
+## 1. Redistributions of source code must retain the above copyright
+## notice, this list of conditions and the following disclaimer.
+## 2. Redistributions in binary form must reproduce the above copyright
+## notice, this list of conditions and the following disclaimer in the
+## documentation and/or other materials provided with the distribution.
+## 3. All advertising materials mentioning features or use of this software
+## must display the following acknowledgement:
+## This product includes software developed by Terrapin Communications,
+## Inc. and its contributors for RANCID.
+## 4. Neither the name of Terrapin Communications, Inc. nor the names of its
+## contributors may be used to endorse or promote products derived from
+## this software without specific prior written permission.
+## 5. It is requested that non-binding fixes and modifications be contributed
+## back to Terrapin Communications, Inc.
##
+## THIS SOFTWARE IS PROVIDED BY Terrapin Communications, INC. AND CONTRIBUTORS
+## ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+## TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+## PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COMPANY OR CONTRIBUTORS
+## BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+## CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+## SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+## INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+## CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+## POSSIBILITY OF SUCH DAMAGE.
+#
+# The expect login scripts were based on Erik Sherk's gwtn, by permission.
+#
+# The original looking glass software was written by Ed Kern, provided by
+# permission and modified beyond recognition.
AUTOMAKE_OPTIONS=foreign no-dependencies
@SET_MAKE@
man_gen_MANS = lg.conf.5 rancid.conf.5 lg_intro.1
-man_nogen_MANS = alogin.1 arancid.1 blogin.1 brancid.1 cat5rancid.1 \
- clogin.1 cloginrc.5 control_rancid.1 cssrancid.1 \
- drancid.1 elogin.1 erancid.1 f10rancid.1 flogin.1 \
- fnrancid.1 francid.1 hlogin.1 hrancid.1 htlogin.1 \
- htrancid.1 jerancid.1 jlogin.1 jrancid.1 mrancid.1 \
- nlogin.1 nrancid.1 nslogin.1 nsrancid.1 par.1 \
- prancid.1 rancid-cvs.1 rancid-run.1 rancid.1 \
+man_nogen_MANS = agmrancid.1 alogin.1 arancid.1 avologin.1 avorancid.1 \
+ blogin.1 brancid.1 cat5rancid.1 clogin.1 cloginrc.5 \
+ control_rancid.1 cssrancid.1 elogin.1 erancid.1 f10rancid.1 \
+ flogin.1 fnrancid.1 francid.1 hlogin.1 hrancid.1 \
+ htlogin.1 htrancid.1 jerancid.1 jlogin.1 jrancid.1 \
+ mrancid.1 nlogin.1 nrancid.1 nslogin.1 nsrancid.1 \
+ par.1 prancid.1 rancid-cvs.1 rancid-run.1 rancid.1 \
rancid_intro.1 rivlogin.1 rivrancid.1 router.db.5 \
- tntlogin.1 tntrancid.1 xrancid.1 zrancid.1
+ rrancid.1 srancid.1 tntlogin.1 tntrancid.1 xrancid.1 \
+ zrancid.1
man_MANS = $(man_nogen_MANS) $(man_gen_MANS)
diff --git a/man/Makefile.in b/man/Makefile.in
index f95580a..c2a23de 100644
--- a/man/Makefile.in
+++ b/man/Makefile.in
@@ -13,6 +13,12 @@
# PARTICULAR PURPOSE.
@SET_MAKE@
+
+#
+# The expect login scripts were based on Erik Sherk's gwtn, by permission.
+#
+# The original looking glass software was written by Ed Kern, provided by
+# permission and modified beyond recognition.
VPATH = @srcdir@
pkgdatadir = $(datadir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
@@ -114,6 +120,7 @@ SORT = @SORT@
SSH = @SSH@
STRIP = @STRIP@
SVN = @SVN@
+SVN_FSTYPE = @SVN_FSTYPE@
TAR = @TAR@
TELNET = @TELNET@
TOUCH = @TOUCH@
@@ -162,15 +169,16 @@ top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
AUTOMAKE_OPTIONS = foreign no-dependencies
man_gen_MANS = lg.conf.5 rancid.conf.5 lg_intro.1
-man_nogen_MANS = alogin.1 arancid.1 blogin.1 brancid.1 cat5rancid.1 \
- clogin.1 cloginrc.5 control_rancid.1 cssrancid.1 \
- drancid.1 elogin.1 erancid.1 f10rancid.1 flogin.1 \
- fnrancid.1 francid.1 hlogin.1 hrancid.1 htlogin.1 \
- htrancid.1 jerancid.1 jlogin.1 jrancid.1 mrancid.1 \
- nlogin.1 nrancid.1 nslogin.1 nsrancid.1 par.1 \
- prancid.1 rancid-cvs.1 rancid-run.1 rancid.1 \
+man_nogen_MANS = agmrancid.1 alogin.1 arancid.1 avologin.1 avorancid.1 \
+ blogin.1 brancid.1 cat5rancid.1 clogin.1 cloginrc.5 \
+ control_rancid.1 cssrancid.1 elogin.1 erancid.1 f10rancid.1 \
+ flogin.1 fnrancid.1 francid.1 hlogin.1 hrancid.1 \
+ htlogin.1 htrancid.1 jerancid.1 jlogin.1 jrancid.1 \
+ mrancid.1 nlogin.1 nrancid.1 nslogin.1 nsrancid.1 \
+ par.1 prancid.1 rancid-cvs.1 rancid-run.1 rancid.1 \
rancid_intro.1 rivlogin.1 rivrancid.1 router.db.5 \
- tntlogin.1 tntrancid.1 xrancid.1 zrancid.1
+ rrancid.1 srancid.1 tntlogin.1 tntrancid.1 xrancid.1 \
+ zrancid.1
man_MANS = $(man_nogen_MANS) $(man_gen_MANS)
EXTRA_DIST = $(man_nogen_MANS) $(man_gen_MANS:%=%.in)
diff --git a/man/drancid.1 b/man/agmrancid.1
index b4633ee..b4633ee 100644
--- a/man/drancid.1
+++ b/man/agmrancid.1
diff --git a/man/avologin.1 b/man/avologin.1
new file mode 100644
index 0000000..4c83247
--- /dev/null
+++ b/man/avologin.1
@@ -0,0 +1 @@
+.so man1/clogin.1
diff --git a/man/avorancid.1 b/man/avorancid.1
new file mode 100644
index 0000000..b4633ee
--- /dev/null
+++ b/man/avorancid.1
@@ -0,0 +1 @@
+.so man1/rancid.1
diff --git a/man/clogin.1 b/man/clogin.1
index 53f1971..1f22ff2 100644
--- a/man/clogin.1
+++ b/man/clogin.1
@@ -1,13 +1,13 @@
.\"
.hys 50
-.TH "clogin" "1" "23 November 2006"
+.TH "clogin" "1" "7 February 2008"
.SH NAME
clogin \- Cisco/Foundry login script
.SH SYNOPSIS
.B clogin
[\fB\-autoenable\fP]
[\fB\-noenable\fP]
-[\fB\-V\fR]
+[\fB\-dV\fR]
[\c
.BI \-c\
command]
@@ -55,11 +55,11 @@ catalyst switch, Extreme switch, Juniper ERX/E-series, Procket Networks,
or Redback router.
There are complementary scripts for
Alteon,
-ADC-kentrox EZ-T3 mux,
+Avocent (Cyclades),
Bay Networks (nortel),
-Cisco AGM,
+ADC-kentrox EZ-T3 mux,
Foundry,
-HP Procurve Switches,
+HP Procurve Switches and Cisco AGMs,
Hitachi Routers,
Juniper Networks,
Netscreen firewalls,
@@ -68,6 +68,7 @@ Riverstone,
and Lucent TNT,
named
.B alogin,
+.B avologin,
.B blogin,
.B elogin,
.B flogin,
@@ -84,7 +85,7 @@ respectively.
.B clogin
reads the
.IR .cloginrc
-file for its configuration, then connects and logins into each of the
+file for its configuration, then connects and logs into each of the
routers specified on the command line in the order listed. Command-line
options exist to override some of the directives found in the
.IR .cloginrc
@@ -94,6 +95,7 @@ The command-line options are as follows:
.TP
.B \-V
Prints package name and version strings.
+.\"
.TP
.B \-c
Command to be run on each router list on the command-line. Multiple
@@ -101,6 +103,10 @@ commands maybe listed by separating them with semi-colons (;). The argument
should be quoted to avoid shell expansion.
.\"
.TP
+.B \-d
+Enable expect debugging.
+.\"
+.TP
.B \-E
Specifies a variable to pass through to scripts (\-s). For example, the
command-line option \-Efoo=bar will produce a global variable by the name
@@ -196,6 +202,12 @@ Specifies the encryption algorithm for use with the
.BR ssh (1)
man page for details. The default is 3des.
.El
+.\"
+.SH RETURNS
+If the login script fails for any of the devices on the command-line, the
+exit value of the script will be non-zero and the value will be the number
+of failures.
+.\"
.SH ENVIRONMENT
.B clogin
recognizes the following environment variables.
diff --git a/man/cloginrc.5 b/man/cloginrc.5
index 49553fd..bc3541e 100644
--- a/man/cloginrc.5
+++ b/man/cloginrc.5
@@ -1,5 +1,5 @@
.\"
-.\" $Id: cloginrc.5,v 1.37 2005/09/12 18:48:19 heas Exp $
+.\" $Id$
.\"
.hys 50
.TH "cloginrc" "5" "12 September 2005"
diff --git a/man/par.1 b/man/par.1
index 7f4ebd4..63d5b71 100644
--- a/man/par.1
+++ b/man/par.1
@@ -1,11 +1,11 @@
.\"
.hys 50
-.TH "par" "1" "9 Jan 2004"
+.TH "par" "1" "18 December 2007"
.SH NAME
par \- parallel command processing
.SH SYNOPSIS
.B par
-[\fB\-diqx\fP]
+[\fB\-dfiqx\fP]
[\c
.BI \-c\
command]
@@ -69,6 +69,10 @@ options, where the first line of the input file(s) begins with a pound-sign
Print debugging information on standard error (stderr).
.\"
.TP
+.B \-f
+No file or STDIN, just run a quantity of the command specified with -c.
+.\"
+.TP
.B \-i
Run commands interactively through (multiple)
.BR xterm (1)
diff --git a/man/rancid.1 b/man/rancid.1
index 934798c..18e3c39 100644
--- a/man/rancid.1
+++ b/man/rancid.1
@@ -1,6 +1,6 @@
.\"
.hys 50
-.TH "rancid" "1" "8 January 2007"
+.TH "rancid" "1" "24 January 2007"
.SH NAME
rancid \- Cisco configuration filter
.SH SYNOPSIS
@@ -41,9 +41,6 @@ Cisco catalyst switches
.B cssrancid
Cisco content services switches
.TP
-.B drancid
-Dell switches
-.TP
.B erancid
ADC-kentrox EZ-T3 mux
.TP
@@ -71,6 +68,12 @@ Juniper Networks
.B mrancid
MRTd
.TP
+.B nrancid
+Netscreen firewalls
+.TP
+.B nsrancid
+Netscaler
+.TP
.B prancid
Procket Networks
.TP
@@ -86,12 +89,6 @@ SMC switch (some Dell OEMs)
.B tntrancid
Lucent TNT
.TP
-.B nrancid
-Netscreen firewalls
-.TP
-.B nsrancid
-Netscaler
-.TP
.B xrancid
Extreme switches
.TP
diff --git a/man/rancid.conf.5.in b/man/rancid.conf.5.in
index a3735eb..84c3720 100644
--- a/man/rancid.conf.5.in
+++ b/man/rancid.conf.5.in
@@ -1,8 +1,8 @@
.\"
-.\" $Id: rancid.conf.5.in,v 1.16 2005/09/27 16:39:27 heas Exp $
+.\" $Id$
.\"
.hys 50
-.TH "rancid.conf" "5" "23 September 2005"
+.TH "rancid.conf" "5" "18 December 2007"
.SH NAME
rancid.conf \- rancid environment configuration file
.SH DESCRIPTION
@@ -29,6 +29,14 @@ The following variables are used (listed alphabetically):
.Bl -tag -width flag
.\"
.TP
+.B ACLSORT
+Permits disabling of access-list sorting, which could alter statement order
+that had been cleverly crafted by the administrator for optimal performance,
+thus making recovery and comparsion more difficult.
+.sp
+Default: YES
+.\"
+.TP
.B BASEDIR
BASEDIR is the directory where
.B rancid-run's
@@ -171,7 +179,7 @@ the number of hours between
.B rancid-run
cron runs.
.sp
-Default: 4
+Default: 24
.\"
.TP
.B PAR_COUNT
diff --git a/man/rancid_intro.1 b/man/rancid_intro.1
index 1ccf463..b0dd142 100644
--- a/man/rancid_intro.1
+++ b/man/rancid_intro.1
@@ -1,18 +1,34 @@
.\"
-.\" $Id: rancid_intro.1,v 1.30 2006/11/23 20:26:49 heas Exp $
+.\" $Id$
.\"
.hys 50
-.TH "rancid_intro" "1" "23 November 2006"
+.TH "rancid_intro" "1" "24 January 2007"
.SH NAME
rancid_intro \- introduction to the Really Awesome New Cisco confIg Differ
.SH INTRODUCTION
.B rancid
is really more than just a Cisco configuration differ. It handles several
-different device's configurations; currently including Alteon, Bay Networks
-(Nortel), Cisco, Cisco AGM, Extreme, Force10, Foundry, HP Procurve switches,
-Juniper Routers and edge (ERX) routers, Redback, MRTd daemon, Lucent TNT,
-Netscalar load balancers, Netscreen firewalls, Zebra routing software, and
-the ADC-Kentrox EZ-T3 mux.
+different device's configurations; currently including
+Alteon,
+Bay Networks (Nortel),
+Cisco,
+Extreme,
+F5 BigIP,
+Force10,
+Fortinet,
+Foundry,
+HP Procurve switches,
+Hitachi,
+Juniper Routers and edge (ERX) routers,
+Lucent TNT,
+MRTd daemon,
+Netscalar load balancers,
+Netscreen firewalls,
+Procket,
+Redback,
+SMC switches,
+Zebra routing software,
+and the ADC-Kentrox EZ-T3 mux.
.PP
.B rancid
uses an expect script to login to each of a list of devices and run a set of
diff --git a/man/router.db.5 b/man/router.db.5
index d688440..a58e3be 100644
--- a/man/router.db.5
+++ b/man/router.db.5
@@ -1,6 +1,6 @@
.\"
.hys 50
-.TH "router.db" "5" "8 January 2007"
+.TH "router.db" "5" "15 November 2007"
.SH NAME
router.db \- rancid group configuration file
.SH DESCRIPTION
@@ -48,25 +48,33 @@ Domain Name) works best, as in the example above.
The type of device from the set:
.RS 8n
.TP
-.B agm
-A Cisco Anomoly Guard Module (aka Riverhead).
-We suspect that at some point the UI will become more cisco-like and it
-can be merged with the IOS rancid module.
-.TP
+.ID 15n
.B alteon
An Alteon WebOS switches.
.TP
+.ID 15n
+.B avocent
+An Avocent Cyclades console server.
+.TP
+.ID 15n
.B baynet
A Bay Networks router.
.TP
+.ID 15n
+.B bigip
+A F5 BigIP switch.
+.TP
+.ID 15n
.B cat5
A Cisco catalyst series 5000 and 4000 switches (i.e.: running the catalyst OS,
not IOS).
.TP
+.ID 15n
.B cisco
A Cisco router, PIX, or switch such as the 3500XL or 6000 running IOS (or
IOS-like) OS.
.TP
+.ID 15n
.B css
A Cisco content services switch.
.TP
@@ -76,31 +84,43 @@ An enterasys NAS. This is currently an alias for the
.B riverstone
device type.
.TP
+.ID 15n
.B erx
A Juniper E-series edge router.
.TP
+.ID 15n
.B extreme
An Extreme switch.
.TP
+.ID 15n
.B ezt3
An ADC-Kentrox EZ-T3 mux.
.TP
+.ID 15n
.B force10
A Force10 router.
.TP
+.ID 15n
+.B fortigate
+A Fortinet firewall.
+.TP
+.ID 15n
.B foundry
A Foundry router, switch, or router-switch. This includes HP
Procurve switches that are OEMs of Foundry products, such as the
HP9304M.
.TP
+.ID 15n
.B hitachi
A Hitachi routers.
.TP
+.ID 15n
.B hp
A HP Procurve switch such as the 2524 or 4108 procurve switches. Also see the
.B foundry
type.
.TP
+.ID 15n
.B juniper
A Juniper router.
.TP
@@ -116,20 +136,30 @@ A Netscalar load balancer.
A Netscreen firewall.
.TP
.ID 15n
+.B procket
+A Procket router.
+.TP
+.ID 15n
.B redback
A Redback router, NAS, etc.
.TP
.ID 15n
+.B riverhead
+A Cisco Anomoly Guard Module (aka Riverhead).
+We suspect that at some point the UI will become more cisco-like and it
+can be merged with the IOS rancid module.
+.TP
+.ID 15n
.B riverstone
A Riverstone NAS or Cabletron (starting with version ~9.0.3) router.
.TP
.ID 15n
.B smc
-A SMC switch (some Dell OEMs)
+A SMC switch (some Dell OEMs).
.TP
.ID 15n
.B tnt
-A lucent TNT.
+A Lucent TNT.
.TP
.ID 15n
.B zebra
diff --git a/man/rrancid.1 b/man/rrancid.1
new file mode 100644
index 0000000..b4633ee
--- /dev/null
+++ b/man/rrancid.1
@@ -0,0 +1 @@
+.so man1/rancid.1
diff --git a/man/srancid.1 b/man/srancid.1
new file mode 100644
index 0000000..b4633ee
--- /dev/null
+++ b/man/srancid.1
@@ -0,0 +1 @@
+.so man1/rancid.1