summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorTar Committer <tar@ocjtech.us>2002-01-04 21:31:49 +0000
committerTar Committer <tar@ocjtech.us>2002-01-04 21:31:49 +0000
commit9f2402b0d86333f5f7e9d50437036cd3124bde47 (patch)
tree163861dc0a0052447f838d3674a35870a80026f5 /man
parentb0d71377c1854271b4511488422427f73d9473d1 (diff)
downloadrancid-9f2402b0d86333f5f7e9d50437036cd3124bde47.zip
rancid-9f2402b0d86333f5f7e9d50437036cd3124bde47.tar.gz
rancid-9f2402b0d86333f5f7e9d50437036cd3124bde47.tar.xz
Imported from rancid-2.2.tar.gz.rancid-2.2
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am11
-rw-r--r--man/Makefile.in21
-rw-r--r--man/clogin.130
-rw-r--r--man/cloginrc.559
-rw-r--r--man/control_rancid.111
-rw-r--r--man/do-diffs.114
-rw-r--r--man/env.5.in17
-rw-r--r--man/hlogin.11
-rw-r--r--man/hrancid.11
-rw-r--r--man/lg.conf.5.in18
-rw-r--r--man/mrancid.11
-rw-r--r--man/par.1109
-rw-r--r--man/rancid.124
-rw-r--r--man/rancid_intro.117
-rw-r--r--man/router.db.541
15 files changed, 299 insertions, 76 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index 845cba6..b9e5b04 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -9,11 +9,16 @@ man_gen_MANS = env.5 lg.conf.5 lg_intro.1
man_nogen_MANS = do-diffs.1 alogin.1 blogin.1 clogin.1 control_rancid.1 \
create_cvs.1 rancid.1 \
rancid_intro.1 cloginrc.5 router.db.5 \
- elogin.1 flogin.1 jlogin.1 \
- jrancid.1 francid.1 cat5rancid.1 erancid.1 xrancid.1
+ elogin.1 flogin.1 hlogin.1 hrancid.1 jlogin.1 \
+ jrancid.1 francid.1 cat5rancid.1 erancid.1 mrancid.1 \
+ par.1 xrancid.1
man_MANS = $(man_gen_MANS) $(man_nogen_MANS)
EXTRA_DIST = $(man_nogen_MANS)
-CLEANFILES = Makefile env.5 lg.conf.5 lg_intro.1
+#CLEANFILES = Makefile env.5 lg.conf.5 lg_intro.1
+
+all:
+
+distclean: clean
diff --git a/man/Makefile.in b/man/Makefile.in
index 598e4f7..ae55555 100644
--- a/man/Makefile.in
+++ b/man/Makefile.in
@@ -1,6 +1,6 @@
-# Makefile.in generated automatically by automake 1.4 from Makefile.am
+# Makefile.in generated automatically by automake 1.4-p5 from Makefile.am
-# Copyright (C) 1994, 1995-8, 1999 Free Software Foundation, Inc.
+# Copyright (C) 1994, 1995-8, 1999, 2001 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
@@ -58,7 +58,9 @@ NORMAL_UNINSTALL = :
PRE_UNINSTALL = :
POST_UNINSTALL = :
AUTOMAKE = @AUTOMAKE@
+CC = @CC@
COMM = @COMM@
+CPP = @CPP@
CVS = @CVS@
DIFF = @DIFF@
DIFF_CMD = @DIFF_CMD@
@@ -90,20 +92,20 @@ SSH = @SSH@
TAR = @TAR@
TELNET = @TELNET@
TOUCH = @TOUCH@
+U = @U@
VERSION = @VERSION@
AUTOMAKE_OPTIONS = foreign no-dependencies
man_gen_MANS = env.5 lg.conf.5 lg_intro.1
-man_nogen_MANS = do-diffs.1 alogin.1 blogin.1 clogin.1 control_rancid.1 create_cvs.1 rancid.1 rancid_intro.1 cloginrc.5 router.db.5 elogin.1 flogin.1 jlogin.1 jrancid.1 francid.1 cat5rancid.1 erancid.1 xrancid.1
+man_nogen_MANS = do-diffs.1 alogin.1 blogin.1 clogin.1 control_rancid.1 create_cvs.1 rancid.1 rancid_intro.1 cloginrc.5 router.db.5 elogin.1 flogin.1 hlogin.1 hrancid.1 jlogin.1 jrancid.1 francid.1 cat5rancid.1 erancid.1 mrancid.1 par.1 xrancid.1
man_MANS = $(man_gen_MANS) $(man_nogen_MANS)
EXTRA_DIST = $(man_nogen_MANS)
-
-CLEANFILES = Makefile env.5 lg.conf.5 lg_intro.1
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
+CONFIG_HEADER = ../include/config.h
CONFIG_CLEAN_FILES = env.5 lg.conf.5 lg_intro.1
man1dir = $(mandir)/man1
man5dir = $(mandir)/man5
@@ -216,7 +218,7 @@ distdir: $(DISTFILES)
@for file in $(DISTFILES); do \
d=$(srcdir); \
if test -d $$d/$$file; then \
- cp -pr $$/$$file $(distdir)/$$file; \
+ cp -pr $$d/$$file $(distdir)/$$file; \
else \
test -f $(distdir)/$$file \
|| ln $$d/$$file $(distdir)/$$file 2> /dev/null \
@@ -253,7 +255,6 @@ installdirs:
mostlyclean-generic:
clean-generic:
- -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES)
distclean-generic:
-rm -f Makefile $(CONFIG_CLEAN_FILES)
@@ -289,6 +290,12 @@ mostlyclean distclean maintainer-clean
@SET_MAKE@
+#CLEANFILES = Makefile env.5 lg.conf.5 lg_intro.1
+
+all:
+
+distclean: clean
+
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:
diff --git a/man/clogin.1 b/man/clogin.1
index d257a5f..a888d99 100644
--- a/man/clogin.1
+++ b/man/clogin.1
@@ -49,16 +49,23 @@ router
.B clogin
is an
.BR expect (1)
-script to automate the process of logging into a Cisco router, catalyst
-switch, Extreme switch, or Redback router. There are complementary scripts
-for Alteon, Bay Networks (nortel), Juniper, Foundry, and ADC-kentrox EZ-T3 mux
-named
+script to automate the process of logging into a Cisco router,
+catalyst switch, Extreme switch, or Redback router. There are
+complementary scripts for
+Alteon,
+Bay Networks (nortel),
+ADC-kentrox EZ-T3 mux,
+Foundry,
+HP Procurve Switches,
+and Juniper,
+named
.B alogin,
.B blogin,
-.B jlogin,
+.B elogin,
.B flogin,
+.B hlogin,
and
-.B elogin,
+.B jlogin,
respectively.
.PP
.B clogin
@@ -202,5 +209,16 @@ configuration file.
.SH "SEE ALSO"
.BR cloginrc (5),
.BR expect (1)
+.SH CAVEATS
+The HP Procurve switches that are Foundry OEMs use flogin, not hlogin.
.SH BUGS
All these login scripts for separate devices should be rolled into one.
+.PP
+The HP Procurve switch CLI relies heavily upon curses based cursor/screen
+manipulation and assumes a vt100 terminal type. They do not provide a way
+to set a different terminal type or adjust this behavior. The resulting
+escape codes make automating interaction with these devices very difficult
+or impossible. Therefore, bin/hpfilter is used by hlogin to filter these.
+While this works for rancid's collection, there are side effects for
+interactive logins via hlogin; most of which are formatting annoyances that
+may be remedied by hitting CTRL-R to reprint the current line.
diff --git a/man/cloginrc.5 b/man/cloginrc.5
index d9ee4ed..e91bfea 100644
--- a/man/cloginrc.5
+++ b/man/cloginrc.5
@@ -7,9 +7,11 @@
.B .cloginrc
contains configuration information for
.BR alogin (1),
+.BR blogin (1),
.BR clogin (1),
.BR elogin (1),
.BR flogin (1),
+.BR hlogin (1),
and
.BR jlogin (1),
such as usernames, passwords, ssh encryption type, etc., and is read at
@@ -23,7 +25,7 @@ Each line containing a directive is of the form:
.PP
.in +1i
.nf
-add <directive> <hostname regex> {<value>} [{<value>} ...]
+add <directive> <hostname glob> {<value>} [{<value>} ...]
.sp
or
.sp
@@ -34,7 +36,7 @@ include {<file>}
As
.B .cloginrc
is searched for a directive for a hostname, it is always the first instance
-of a directive, whose hostname regular expression matches the hostname, that
+of a directive, whose hostname glob expression matches the hostname, that
is used. For example; looking up the password for hostname foo in a
.B .cloginrc
file containing
@@ -70,7 +72,7 @@ The accepted directives are (alphabetically):
.PP
.\"
.TP
-.B add autoenable <router name regexp> {[01]}
+.B add autoenable <router name glob> {[01]}
When using locally defined usernames or AAA, it is possible to have a login
which is automatically enabled. This is, that user has enable privileges
without the need to execute the enable command. The router's prompt is
@@ -87,7 +89,7 @@ should execute the enable command to gain enable privileges, unless
negated by the noenable directive or \-noenable command\-line option.
.\"
.TP
-.B add cyphertype <router name regexp> {<ssh encryption type>}
+.B add cyphertype <router name glob> {<ssh encryption type>}
cyphertype defines which encryption algorithm is used with ssh. A device
may not support the type ssh uses by default. See
.BR ssh (1)'s\c
@@ -96,7 +98,7 @@ may not support the type ssh uses by default. See
Default: {3des}
.\"
.TP
-.B add enableprompt <router name regexp> {"<enable prompt>"}
+.B add enableprompt <router name glob> {"<enable prompt>"}
When using AAA with a Cisco router or switch, it is possible to redefine the
prompt the device presents to the user for the enable password. enableprompt
may be used to adjust the prompt that
@@ -109,35 +111,47 @@ Example: add enableprompt rc*.example.net {"\\[Ee]nter the enable password:"}
Default: "\\[Pp]assword:"
.\"
.TP
-.B add enauser <router name regexp> {<username>}
+.B add enauser <router name glob> {<username>}
This is only needed if a device prompts for a username when gaining
enable privileges and where this username is different from that defined
by or the default of the user directive.
.\"
.TP
-.B add identity <router name regexp> {<ssh identity file path>}
+.B add identity <router name glob> {<ssh identity file path>}
May be used to specify an alternate identity file for use with ssh(1).
See ssh's \-i option for details.
.sp
Default: your default identity file. see ssh(1).
.\"
.TP
-.B add method <router name regexp> {ssh} [{...}]
+.B add method <router name glob> {ssh} [{...}]
Defines, in order, the connection methods to use for a device from the
-set {ssh, telnet, rsh}.
-.sp
-Example: add method * {ssh} {telnet} {rsh}
+set {ssh, telnet, rsh}. Method telnet may have a suffix, indicating an
+alternate TCP port, of the form ":port".
+.sp
+Note: Different versions of telnet treat the specification of a
+port differently. In particular, BSD derived telnets do not do
+option negotiation when a port is given. Some devices, Extreme
+switches for example, have undesirable telnet default options such
+as linemode. In the BSD case, to enable option negotiation when
+specifying a port the method should be "{telnet:-23}" or you should
+add "mode character" to .telnetrc. See
+.BR telnet (1)
+for more information on telnet command-line syntax, telnet options,
+and .telnetrc.
+.sp
+Example: add method * {ssh} {telnet:3000} {rsh}
.sp
Which would cause
.IR clogin
-to first attempt an ssh connection to the device and if that were to
-fail with connection refused, a telnet connection would be tried, and
-then rsh.
+to first attempt an ssh connection to the device and if that were
+to fail with connection refused, a telnet connection to port 3000
+would be tried, and then a rsh connection.
.sp
Default: {telnet} {ssh}
.\"
.TP
-.B add noenable <router name regexp>
+.B add noenable <router name glob>
.IR clogin
will not try to gain enable privileges when noenable is matched for a
device. This is equivalent to
@@ -146,7 +160,7 @@ device. This is equivalent to
.BR jlogin (1).
.\"
.TP
-.B add passprompt <router name regexp> {"<password prompt>"}
+.B add passprompt <router name glob> {"<password prompt>"}
When using AAA with a Cisco router or switch, it is possible to redefine the
prompt the device presents to the user for the password. passprompt may be
used to adjust the prompt that
@@ -159,14 +173,14 @@ Example: add passprompt rc*.example.net {"\\[Ee]nter the password:"}
Default: "(\\[Pp]assword|passwd):"
.\"
.TP
-.B add password <router name regexp> {<vty passwd>} [{<enable passwd>}]
+.B add password <router name glob> {<vty passwd>} [{<enable passwd>}]
Specifies a vty password, that which is prompted for upon the connection
to the router. The last argument is the enable password and need not be
specified if the device also has a matching noenable or autoenable
directive or the corresponding command-line options are used.
.\"
.\" .TP
-.\" .B add rc <router name regexp> {<cmd;cmd>}
+.\" .B add rc <router name glob> {<cmd;cmd>}
.\" rc is used to specifies a command that will be run by
.\" .IR clogin
.\" immediately after logging into the device. Multiple commands may be
@@ -177,7 +191,7 @@ directive or the corresponding command-line options are used.
.\" Example: add rc *.domain.net {terminal monitor;show version}
.\"
.TP
-.B add user <router name regexp> {<username>}
+.B add user <router name glob> {<username>}
Specifies a username
.IR clogin
should use if or when prompted for one.
@@ -185,12 +199,12 @@ should use if or when prompted for one.
Default: $USER, ie: your Unix username.
.\"
.TP
-.B add userpassword <router name regexp> {<user password>}
+.B add userpassword <router name glob> {<user password>}
Specifies a password to be associated with a user, if different from that
defined with the password directive.
.\"
.TP
-.B add userprompt <router name regexp> {"<username prompt>"}
+.B add userprompt <router name glob> {"<username prompt>"}
When using AAA with a Cisco router or switch, it is possible to redefine the
prompt the device presents to the user for the username. userprompt may be
used to adjust the prompt that
@@ -229,4 +243,5 @@ Example: include {.cloginrc.group}
is interpreted directly by Tcl, so its syntax follows that of Tcl. Errors
may produce quite unexpected results.
.SH "SEE ALSO"
-.BR clogin (1)
+.BR clogin (1),
+.BR glob (3)
diff --git a/man/control_rancid.1 b/man/control_rancid.1
index b5b31c4..8bd719f 100644
--- a/man/control_rancid.1
+++ b/man/control_rancid.1
@@ -5,6 +5,9 @@
control_rancid \- run rancid for devices of a group
.SH SYNOPSIS
.B create_cvs
+[\c
+.BI \-r\ \c
+device_name]\ \c
group
.SH DESCRIPTION
.B control_rancid
@@ -16,6 +19,14 @@ run rancid for each of the devices, possibly re-run rancid for missed devices,
e-mail diffs, and e-mail error reports.
.\"
.PP
+.\"
+The command-line options are as follows:
+.TP
+.B \-r device_name
+Specify the name, as it appears in the router.db, of a particular device
+to collect and generate diffs for. The device must be marked "up".
+.\"
+.PP
.B control_rancid
is normally (and best) run via
.BR do-diffs (1).
diff --git a/man/do-diffs.1 b/man/do-diffs.1
index cb42bb5..6202227 100644
--- a/man/do-diffs.1
+++ b/man/do-diffs.1
@@ -5,6 +5,9 @@
do-diffs \- run rancid for each of the groups
.SH SYNOPSIS
.B do-diffs
+[\c
+.BI \-r\ \c
+device_name]\ \c
[group [group ...]]
.SH DESCRIPTION
.B do-diffs
@@ -53,6 +56,16 @@ For example:
.fi
.in -1i
.\"
+.PP
+.\"
+The command-line options are as follows:
+.TP
+.B \-r device_name
+Specify the name, as it appears in a group's router.db, of a particular
+device to collect and generate diffs for. The device must be marked "up".
+If a group is not specified on the command-line, rancid will be run
+against any group in which the device_name appears.
+.\"
.SH ENVIRONMENT
.B do-diffs
utilizes the following environment variables from
@@ -92,4 +105,5 @@ configuration file.
.El
.SH SEE ALSO
.BR control_rancid (1),
+.BR router.db (5),
.BR env (5)
diff --git a/man/env.5.in b/man/env.5.in
index 854edbb..1050ac7 100644
--- a/man/env.5.in
+++ b/man/env.5.in
@@ -45,6 +45,17 @@ not be necessary to alter CVSROOT.
Default: $BASEDIR/CVS
.\"
.TP
+.B FILTER_PWDS
+Determines which passwords will be filtered from configs. The value may be
+"NO", "YES", or "ALL" to filter none of the passwords, only those which are
+reversable or plain-text, or all (plus ssh keys, etc), respectively.
+Note that passwords whose value cycles and would produce erroneous diffs
+are always filtered (eg: Alteon passwords). Note that a value of "NO" could
+be a security issue.
+.sp
+Default: YES
+.\"
+.TP
.B LIST_OF_GROUPS
Defines a list of group names of routers separated by white-space. These
names become the directory names in $BASEDIR which contain the data
@@ -112,9 +123,9 @@ will start simultaneously as
.IR control_rancid (1)
attempts to perform collections. Raising this value will decrease the amount
of time necessary for a complete collection of a (or all) rancid groups at the
-of system load. The default is relatively cautious. If collections are not
-completing quickly enough for users, use trial and error of speed versus
-system load to find a suitable value.
+expense of system load. The default is relatively cautious. If collections
+are not completing quickly enough for users, use trial and error of speed
+versus system load to find a suitable value.
.sp
Default: 5
.\"
diff --git a/man/hlogin.1 b/man/hlogin.1
new file mode 100644
index 0000000..4c83247
--- /dev/null
+++ b/man/hlogin.1
@@ -0,0 +1 @@
+.so man1/clogin.1
diff --git a/man/hrancid.1 b/man/hrancid.1
new file mode 100644
index 0000000..b4633ee
--- /dev/null
+++ b/man/hrancid.1
@@ -0,0 +1 @@
+.so man1/rancid.1
diff --git a/man/lg.conf.5.in b/man/lg.conf.5.in
index 3b07f75..cb052f7 100644
--- a/man/lg.conf.5.in
+++ b/man/lg.conf.5.in
@@ -70,6 +70,14 @@ simply handed off to print().
Example: $LG_IMAGE="<img src=/icons/rancid.gif hspace=0>\n <font size=+2>FOO</font>";
.\"
.TP
+.B LG_INFO
+Defines information in html format which, if defined, will be included at
+the bottom of the looking glass form page. It may contain any html as it is
+simply handed off to print().
+.sp
+Example: $LG_INFO="For Support contact <a href=mailto:webmaster\@localhost>webmaster</a>";
+.\"
+.TP
.B LG_LOG
Defines the fully qualified path name for the log file or the
.BR syslog (3)
@@ -87,7 +95,7 @@ Sets the location for the
file in rancid's
.BR router.db (5)
format. It lists the devices that should be available to the looking glass
-users. Only those devices of supported types and with status 'up' are made
+users. Only those devices of supported types and with state 'up' are made
available. If not defined and the default file does not exist, the looking
glass will compile a list from the router.db files of all the groups present
in rancid, that is a concatenation of $BASEDIR/*/router.db.
@@ -108,7 +116,7 @@ debugging clogin problems.
.\"
.TP
.B PATH
-Is a colon separated list of directory pathnames in the the file system
+Is a colon separated list of directory pathnames in the file system
where rancid's login scripts,
.IR clogin (1)
etc. )
@@ -133,7 +141,11 @@ results.
Configuration file described here, where $BASEDIR is set at the time that
the rancid package was configured. In this case, $BASEDIR is
.IR @prefix@ .
+.B lg.conf
+is located by the value of the environment variable LG_CONF, in the CWD
+(current working directory), or rancid install directory ($BASEDIR/util/lg).
.El
.SH SEE ALSO
.BR cloginrc (5),
-.BR lg_intro (1)
+.BR lg_intro (1),
+.BR router.db (5)
diff --git a/man/mrancid.1 b/man/mrancid.1
new file mode 100644
index 0000000..b4633ee
--- /dev/null
+++ b/man/mrancid.1
@@ -0,0 +1 @@
+.so man1/rancid.1
diff --git a/man/par.1 b/man/par.1
new file mode 100644
index 0000000..b0f0cee
--- /dev/null
+++ b/man/par.1
@@ -0,0 +1,109 @@
+.\"
+.hys 50
+.TH "par" "1" "17 Nov 2001"
+.SH NAME
+par \- parallel command processing
+.SH SYNOPSIS
+.B par
+[\fB\-diqx\fP]
+[\c
+.BI \-c\
+command]
+[\c
+.BI \-l\
+logfile]
+[\c
+.BI \-n\c
+ #]
+file
+[file...]
+.SH DESCRIPTION
+.B par
+takes a list of files to run a command on. The first line of each file begins
+with a colon (:) or a pound-sign (#). If a colon, the remainder of the
+line is a command to run for each of the subsequent lines. If a pound-sign,
+then each subsequent line is command, unless the
+.B \-c
+option was specified, in which case it operates as if the argument to
+.B \-c
+had followed a colon on the first line.
+.PP
+In each of the cases where the lines of the file following the first are
+not commands (ie: colon or -c), instances of open-close braces ({}) in the
+command will be replaced by these values.
+.PP
+For example, a inputfile whose contents is:
+.sp
+ : echo {}
+.br
+ a
+.br
+ b
+.br
+ c
+.sp
+run with
+.B par
+like so:
+.sp
+ %par -q inputfile
+.sp
+will produce the following output (order will vary):
+.sp
+ b
+.br
+ a
+.br
+ c
+.PP
+The command-line options are as follows:
+.PP
+.TP
+.B \-c
+Command to be run on each each of the arguments following the command-line
+options, when the first line of the input file(s) begin with a pound-sign
+(#).
+.\"
+.TP
+.B \-d
+Print debugging information on standard error (stderr).
+.\"
+.TP
+.B \-i
+Run commands interactively though (multiple)
+.BR xterm (1)
+processes.
+.\"
+.TP
+.B \-l
+Prefix of logfile name, as in prefix.N where N is the
+.B par
+process number ([0..]).
+.sp
+Default: par.log.<time>.[0..]
+.\"
+.TP
+.B \-n
+Number of simultaneous processes.
+.sp
+Default: 3
+.\"
+.TP
+.B \-q
+Quiet mode. Do not log anything.
+.\"
+.TP
+.B \-x
+View par logs in real-time via an
+.BR xterm (1).
+.El
+.SH FILES
+.br
+.nf
+.\" set tabstop to longest possible filename, plus a wee bit
+.ta \w'par.log.1006028679.00 'u
+\fIpar.log.T.N\fR Log file; where T is the current time in seconds since the
+epoch and N is the par process number ([0..]).
+.\"
+.\" .SH "SEE ALSO"
+.\" .BR expect (1)
diff --git a/man/rancid.1 b/man/rancid.1
index bcccd26..4d4ba51 100644
--- a/man/rancid.1
+++ b/man/rancid.1
@@ -23,17 +23,29 @@ and so on.
product is a file with the name of it's last argument plus the suffix .new.
For example, hostname.new.
.PP
-There are complementary scripts for Alteon WebOS switches, Cisco catalyst
-switch, Bay Networks (nortel), Juniper, Foundry, Extreme, and ADC-kentrox EZ-T3
-mux named
+There are complementary scripts for
+Alteon WebOS switches,
+Bay Networks (nortel),
+Cisco catalyst switch,
+ADC-kentrox EZ-T3 mux,
+Foundry,
+HP Procurve Switches,
+Juniper,
+MRTd,
+Redback,
+and Extreme,
+named
.B arancid,
.B brancid,
.B cat5rancid,
-.B jrancid,
+.B erancid,
.B francid,
-.B xrancid,
+.B hrancid,
+.B jrancid,
+.B mrancid,
+.B rrancid,
and
-.B erancid,
+.B xrancid,
respectively.
.PP
The command-line options are as follows:
diff --git a/man/rancid_intro.1 b/man/rancid_intro.1
index e238637..f392fd5 100644
--- a/man/rancid_intro.1
+++ b/man/rancid_intro.1
@@ -7,19 +7,20 @@ rancid_intro \- introduction to the Really Awesome New Cisco confIg Differ
.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, Extreme, Foundry, Juniper, Redback, and the ADC-Kentrox
-EZ-T3 mux.
+(nortel), Cisco, Extreme, Foundry, HP Procurve switches, Juniper, Redback,
+MRTd daemon, and the ADC-Kentrox EZ-T3 mux.
.PP
.B rancid
-uses an expect script to login to a list of devices and run a set of
+uses an expect script to login to each of a list of devices and run a set of
commands for that device-type and collects the output. The output
is run through some filtering to summarize, reformat, and/or snip
unwanted or security related data such as chassis temperature and easily
reverse-able passwords.
.PP
-Named after the device's name in the group's configuration file, the
-resulting files are saved in the directory <group>/configs. Except for the
-data filtered from the configuration file for security reasons, such as
+Named after the device's name in the group's configuration file (\c
+.B router.db\c
+), the resulting files are saved in the directory <group>/configs. Except for
+the data filtered from the configuration file for security reasons, such as
reversable passwords, these files are suitable for loading directly to restore
a lost configuration. See
.BR env (5)
@@ -69,8 +70,8 @@ diff -u -4 -r1.144 dfw.shrubbery.net
.fi
.PP
In this example, we see that a Gigabit Ethernet linecard was removed
-from slot 6. Since this data is collected from "show" commands on the
-router, it could just as easily be that the card crashed so the RP
+from slot 6. However, since this data is collected from "show" commands on
+the router, it could just as easily be that the card crashed so the RP
can not communicate with it to collect information.
.SH "GETTING STARTED"
Installation instructions are included in the distribution's top-level
diff --git a/man/router.db.5 b/man/router.db.5
index 8bc879e..2e12d14 100644
--- a/man/router.db.5
+++ b/man/router.db.5
@@ -14,7 +14,7 @@ One device is listed per-line, where the syntax is:
.PP
.in +1i
.nf
-<device_name>:<device_type>:<state>[:][comments]
+<device_name>:<device_type>:<state>[:comments]
.fi
.in -1i
.PP
@@ -55,27 +55,35 @@ An Alteon WebOS switches.
A Bay Networks router.
.TP
.B cat5
-A cisco catalyst switch (ie: running the catalyst OS, not IOS).
+A cisco catalyst series 5000 and 4000 switches (ie: running the catalyst OS,
+not IOS).
.TP
.B cisco
A cisco router or switch such as the 3500XL or 6000 running IOS (or IOS-like)
OS.
.TP
+.B extreme
+An Extreme switch.
+.TP
.B ezt3
An ADC-Kentrox EZ-T3 mux.
.TP
-.B extreme
-A Extreme switch.
-.TP
.B foundry
-A Foundry router, switch, or router-switch.
+A Foundry router, switch, or router-switch. This includes HP
+Procurve switches that are OEMs of Foundry products, such as the
+HP9304M.
.TP
.B hp
-A HP switch such as the 2524 or 4108 procurve switches.
+A HP Procurve switch such as the 2524 or 4108 procurve switches. Also see the
+.B foundry
+type.
.TP
.B juniper
A Juniper router.
.TP
+.B mrtd
+A host running the (merit) MRTd daemon.
+.TP
.ID 15n
.B redback
A Redback router, NAS, etc.
@@ -89,24 +97,21 @@ collected.
It is highly recommended that comments are made for
any router not listed as up, so as to indicate the
reason a router is not to be polled, e.g.:
-.TP
-.PP
+.sp
dial1.paris:cisco:up:
+.br
core1.paris:cisco:down:in testing until 5/5/2001.
+.br
core2.paris:cisco:ticketed:Ticket 6054234, 5/3/2001
+.br
border1.paris:juniper:up:
-.TP
-.PP
-Please see the script "downreport" in util/ for a
-daily report of routers in router.db that aren't
-marked "up".
+.sp
+The script "downreport" in util/ can be used to produce a
+report of routers in router.db that are not marked "up".
.PP
.TP
.B [comments]
-.TP
-.PP
-Freeform string to describe the current state of
-the router.
+Freeform string to describe the current state of the router.
.PP
A ``#'' at the begining of a line is a comment; the entire line is
ignored.