From b88919bea4b222a616adbdd2b82fc262a14afc8d Mon Sep 17 00:00:00 2001 From: Tar Committer Date: Mon, 5 Feb 2001 17:47:18 +0000 Subject: Imported from rancid-2.1.tar.gz. --- man/Makefile.am | 18 ++++ man/Makefile.in | 295 +++++++++++++++++++++++++++++++++++++++++++++++++++ man/cat5rancid.1 | 1 + man/clogin.1 | 193 +++++++++++++++++++++++++++++++++ man/cloginrc.5 | 231 ++++++++++++++++++++++++++++++++++++++++ man/control_rancid.1 | 26 +++++ man/create_cvs.1 | 53 +++++++++ man/do-diffs.1 | 95 +++++++++++++++++ man/elogin.1 | 1 + man/env.5.in | 154 +++++++++++++++++++++++++++ man/erancid.1 | 1 + man/flogin.1 | 1 + man/francid.1 | 1 + man/jlogin.1 | 1 + man/jrancid.1 | 1 + man/lg.conf.5.in | 129 ++++++++++++++++++++++ man/lg_intro.1.in | 64 +++++++++++ man/rancid.1 | 55 ++++++++++ man/rancid_intro.1 | 113 ++++++++++++++++++++ man/router.db.5 | 106 ++++++++++++++++++ 20 files changed, 1539 insertions(+) create mode 100644 man/Makefile.am create mode 100644 man/Makefile.in create mode 100644 man/cat5rancid.1 create mode 100644 man/clogin.1 create mode 100644 man/cloginrc.5 create mode 100644 man/control_rancid.1 create mode 100644 man/create_cvs.1 create mode 100644 man/do-diffs.1 create mode 100644 man/elogin.1 create mode 100644 man/env.5.in create mode 100644 man/erancid.1 create mode 100644 man/flogin.1 create mode 100644 man/francid.1 create mode 100644 man/jlogin.1 create mode 100644 man/jrancid.1 create mode 100644 man/lg.conf.5.in create mode 100644 man/lg_intro.1.in create mode 100644 man/rancid.1 create mode 100644 man/rancid_intro.1 create mode 100644 man/router.db.5 (limited to 'man') diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..828fa06 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,18 @@ +## Process this file with automake to produce Makefile.in +## A Makefile.in is supplied, in case you do not have automake. + +AUTOMAKE_OPTIONS=foreign no-dependencies + +@SET_MAKE@ + +man_gen_MANS = env.5 lg.conf.5 lg_intro.1 +man_nogen_MANS = do-diffs.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 + +man_MANS = $(man_gen_MANS) $(man_nogen_MANS) + +EXTRA_DIST = $(man_nogen_MANS) + +CLEANFILES = Makefile env.5 lg.conf.5 lg_intro.1 diff --git a/man/Makefile.in b/man/Makefile.in new file mode 100644 index 0000000..36aff3e --- /dev/null +++ b/man/Makefile.in @@ -0,0 +1,295 @@ +# Makefile.in generated automatically by automake 1.4 from Makefile.am + +# Copyright (C) 1994, 1995-8, 1999 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. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + + +SHELL = @SHELL@ + +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +prefix = @prefix@ +exec_prefix = @exec_prefix@ + +bindir = @bindir@ +sbindir = @sbindir@ +libexecdir = @libexecdir@ +datadir = @datadir@ +sysconfdir = @sysconfdir@ +sharedstatedir = @sharedstatedir@ +localstatedir = @localstatedir@ +libdir = @libdir@ +infodir = @infodir@ +mandir = @mandir@ +includedir = @includedir@ +oldincludedir = /usr/include + +DESTDIR = + +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ + +top_builddir = .. + +ACLOCAL = @ACLOCAL@ +AUTOCONF = @AUTOCONF@ +AUTOMAKE = @AUTOMAKE@ +AUTOHEADER = @AUTOHEADER@ + +INSTALL = @INSTALL@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ $(AM_INSTALL_PROGRAM_FLAGS) +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +transform = @program_transform_name@ + +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +AUTOMAKE = @AUTOMAKE@ +COMM = @COMM@ +CVS = @CVS@ +DIFF = @DIFF@ +DIFF_CMD = @DIFF_CMD@ +DIRNAME = @DIRNAME@ +ENV_PATH = @ENV_PATH@ +EXPECT_PATH = @EXPECT_PATH@ +FIND = @FIND@ +GREP = @GREP@ +ID = @ID@ +INST_PROGS = @INST_PROGS@ +LG_PING_CMD = @LG_PING_CMD@ +MAILPLUS = @MAILPLUS@ +MAINT = @MAINT@ +MAKE = @MAKE@ +MAKEINFO = @MAKEINFO@ +MKDIR = @MKDIR@ +PACKAGE = @PACKAGE@ +PERLV = @PERLV@ +PERLV_PATH = @PERLV_PATH@ +PING_PATH = @PING_PATH@ +RD_BIN_DATAS = @RD_BIN_DATAS@ +RD_BIN_PROGS = @RD_BIN_PROGS@ +RD_UTIL_LG_PROGS = @RD_UTIL_LG_PROGS@ +RD_UTIL_PROGS = @RD_UTIL_PROGS@ +RSH = @RSH@ +SENDMAIL = @SENDMAIL@ +SORT = @SORT@ +SSH = @SSH@ +TAR = @TAR@ +TELNET = @TELNET@ +TOUCH = @TOUCH@ +UCBMAIL = @UCBMAIL@ +VERSION = @VERSION@ + +AUTOMAKE_OPTIONS = foreign no-dependencies + +man_gen_MANS = env.5 lg.conf.5 lg_intro.1 +man_nogen_MANS = do-diffs.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 + + +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_CLEAN_FILES = env.5 lg.conf.5 lg_intro.1 +man1dir = $(mandir)/man1 +man5dir = $(mandir)/man5 +MANS = $(man_MANS) + +NROFF = nroff +DIST_COMMON = Makefile.am Makefile.in env.5.in lg.conf.5.in \ +lg_intro.1.in + + +DISTFILES = $(DIST_COMMON) $(SOURCES) $(HEADERS) $(TEXINFOS) $(EXTRA_DIST) + +GZIP_ENV = --best +all: all-redirect +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ Makefile.am $(top_srcdir)/configure.in $(ACLOCAL_M4) + cd $(top_srcdir) && $(AUTOMAKE) --foreign man/Makefile + +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + cd $(top_builddir) \ + && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status + +env.5: $(top_builddir)/config.status env.5.in + cd $(top_builddir) && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status +lg.conf.5: $(top_builddir)/config.status lg.conf.5.in + cd $(top_builddir) && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status +lg_intro.1: $(top_builddir)/config.status lg_intro.1.in + cd $(top_builddir) && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status + +install-man1: + $(mkinstalldirs) $(DESTDIR)$(man1dir) + @list='$(man1_MANS)'; \ + l2='$(man_MANS)'; for i in $$l2; do \ + case "$$i" in \ + *.1*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \ + else file=$$i; fi; \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " $(INSTALL_DATA) $$file $(DESTDIR)$(man1dir)/$$inst"; \ + $(INSTALL_DATA) $$file $(DESTDIR)$(man1dir)/$$inst; \ + done + +uninstall-man1: + @list='$(man1_MANS)'; \ + l2='$(man_MANS)'; for i in $$l2; do \ + case "$$i" in \ + *.1*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " rm -f $(DESTDIR)$(man1dir)/$$inst"; \ + rm -f $(DESTDIR)$(man1dir)/$$inst; \ + done + +install-man5: + $(mkinstalldirs) $(DESTDIR)$(man5dir) + @list='$(man5_MANS)'; \ + l2='$(man_MANS)'; for i in $$l2; do \ + case "$$i" in \ + *.5*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \ + else file=$$i; fi; \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " $(INSTALL_DATA) $$file $(DESTDIR)$(man5dir)/$$inst"; \ + $(INSTALL_DATA) $$file $(DESTDIR)$(man5dir)/$$inst; \ + done + +uninstall-man5: + @list='$(man5_MANS)'; \ + l2='$(man_MANS)'; for i in $$l2; do \ + case "$$i" in \ + *.5*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " rm -f $(DESTDIR)$(man5dir)/$$inst"; \ + rm -f $(DESTDIR)$(man5dir)/$$inst; \ + done +install-man: $(MANS) + @$(NORMAL_INSTALL) + $(MAKE) $(AM_MAKEFLAGS) install-man1 install-man5 +uninstall-man: + @$(NORMAL_UNINSTALL) + $(MAKE) $(AM_MAKEFLAGS) uninstall-man1 uninstall-man5 +tags: TAGS +TAGS: + + +distdir = $(top_builddir)/$(PACKAGE)-$(VERSION)/$(subdir) + +subdir = man + +distdir: $(DISTFILES) + @for file in $(DISTFILES); do \ + d=$(srcdir); \ + if test -d $$d/$$file; then \ + cp -pr $$/$$file $(distdir)/$$file; \ + else \ + test -f $(distdir)/$$file \ + || ln $$d/$$file $(distdir)/$$file 2> /dev/null \ + || cp -p $$d/$$file $(distdir)/$$file || :; \ + fi; \ + done +info-am: +info: info-am +dvi-am: +dvi: dvi-am +check-am: all-am +check: check-am +installcheck-am: +installcheck: installcheck-am +install-exec-am: +install-exec: install-exec-am + +install-data-am: install-man +install-data: install-data-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am +install: install-am +uninstall-am: uninstall-man +uninstall: uninstall-am +all-am: Makefile $(MANS) +all-redirect: all-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) AM_INSTALL_PROGRAM_FLAGS=-s install +installdirs: + $(mkinstalldirs) $(DESTDIR)$(mandir)/man1 $(DESTDIR)$(mandir)/man5 + + +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -rm -f Makefile $(CONFIG_CLEAN_FILES) + -rm -f config.cache config.log stamp-h stamp-h[0-9]* + +maintainer-clean-generic: +mostlyclean-am: mostlyclean-generic + +mostlyclean: mostlyclean-am + +clean-am: clean-generic mostlyclean-am + +clean: clean-am + +distclean-am: distclean-generic clean-am + +distclean: distclean-am + +maintainer-clean-am: maintainer-clean-generic distclean-am + @echo "This command is intended for maintainers to use;" + @echo "it deletes files that may require special tools to rebuild." + +maintainer-clean: maintainer-clean-am + +.PHONY: install-man1 uninstall-man1 install-man5 uninstall-man5 \ +install-man uninstall-man tags distdir info-am info dvi-am dvi check \ +check-am installcheck-am installcheck install-exec-am install-exec \ +install-data-am install-data install-am install uninstall-am uninstall \ +all-redirect all-am all installdirs mostlyclean-generic \ +distclean-generic clean-generic maintainer-clean-generic clean \ +mostlyclean distclean maintainer-clean + + +@SET_MAKE@ + +# 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/cat5rancid.1 b/man/cat5rancid.1 new file mode 100644 index 0000000..b4633ee --- /dev/null +++ b/man/cat5rancid.1 @@ -0,0 +1 @@ +.so man1/rancid.1 diff --git a/man/clogin.1 b/man/clogin.1 new file mode 100644 index 0000000..e40224b --- /dev/null +++ b/man/clogin.1 @@ -0,0 +1,193 @@ +.\" +.hys 50 +.TH "clogin" "1" "13 Jan 2001" +.SH NAME +clogin \- Cisco/Foundry login script +.SH SYNOPSIS +.B clogin +[\fB\-autoenable\fP] +[\fB\-noenable\fP] +[\c +.BI \-c\ +command] +[\c +.BI \-e\ +enable-password] +[\c +.BI \-f\ +cloginrc-file] +[\c +.BI \-p\ +user-password] +[\c +.BI \-s\ +script-file] +[\c +.BI \-t\ +timeout] +[\c +.BI \-u\ +username] +[\c +.BI \-v\ +vty-password] +[\c +.BI \-w\ +enable-username] +[\c +.BI \-x\ +command-file] +[\c +.BI \-y\ +ssh_cypher_type] +router +[router...] +.SH DESCRIPTION +.B clogin +is an +.BR expect (1) +script to automate the process of logging into a Cisco router, catalyst +switch, or Redback router. There are complementary scripts for Juniper, +Foundry, and ADC-kentrox EZ-T3 mux named +.B jlogin, +.B flogin, +and +.B elogin, +respectively. +.PP +.B clogin +reads the +.IR .cloginrc +file for its configuration, then connects and logins into each of the +routers specified on the command line in the order listed. Some command-line +options exist to override directives found in the +.IR .cloginrc +configuration file. +.PP +The command-line options are as follows: +.PP +.TP +.B \-c +Command to be run on each router list on the command-line. Multiple +commands maybe listed by separating them with semi-colons (;). The argument +should be quoted to avoid shell expansion. +.\" +.TP +.B \-e +Specify a password to be supplied when gaining enable privileges on the +router(s). Also see the password directive of the +.IR .cloginrc +file. +.\" +.TP +.B \-f +Specifies an alternate configuration file. The default is +.IR "$HOME/.cloginrc" . +.\" +.TP +.B \-p +Specifies a password associated with the user specified by the +.B \-u +option, user directive of the +.IR .cloginrc +file, or the Unix username of the user. +.\" +.TP +.B \-s +The filename of an +.BR expect (1) +script which will be sourced after the login is successful and is expected +to return control to +.B clogin, +with the connection to the router intact, when it is done. +.\" +.TP +.B \-t +Alters the timeout interval; the period that +.B clogin +waits for an individual command to return a prompt or the login process to +produce a prompt or failure. The argument is in seconds. +.\" +.TP +.B \-u +Specifies the username used when prompted. The command-line option overrides +any user directive found in +.IR .cloginrc . +The default is the current Unix username. +.\" +.TP +.B \-v +Specifies a vty password, that which is prompted for upon connection +to the router. This overrides the vty password of the +.IR .cloginrc +file's password directive. +.\" +.TP +.B \-w +Specifies the username used if prompted when gaining enable privileges. The +command-line option overrides any user or enauser directives found in +.IR .cloginrc . +The default is the current Unix username. +.\" +.TP +.B \-x +Similar to the +.B \-c +option; +.B \-x +specifies a file with commands to run on each of the routers. The commands +must not expect additional input, such as 'copy rcp startup-config' does. +For example: +.PP +.in +1i +.nf +show version +show logging +.fi +.in -1i +.\" +.TP +.B \-y +Specifies the encryption algorithm for use with the +.BR ssh (1) +\-c option. The default encryption type is often not supported. See the +.BR ssh (1) +man page for details. The default is 3des. +.El +.SH ENVIRONMENT +.B clogin +recognizes the following environment variables. +.PP +.TP +.B CISCO_USER +Overrides the user directive found in the +.IR .cloginrc +file, but may be overridden by the +.B \-u +option. +.\" +.TP +.B CLOGIN +.B clogin +will not change the banner on your xterm window if this includes the +character 'x'. +.\" +.TP +.B HOME +Normally set by +.BR login (1) +to the user's home directory, +HOME is used by +.B clogin +to locate the +.IR .cloginrc +configuration file. +.El +.SH FILES +.ta \w'xHOME/xcloginrc 'u +\fI$HOME/.cloginrc\fR Configuration file. +.SH "SEE ALSO" +.BR cloginrc (5), +.BR expect (1) +.SH BUGS +All these login scripts for separate devices should be rolled into one. diff --git a/man/cloginrc.5 b/man/cloginrc.5 new file mode 100644 index 0000000..9933a50 --- /dev/null +++ b/man/cloginrc.5 @@ -0,0 +1,231 @@ +.\" +.hys 50 +.TH "cloginrc" "5" "22 Jan 2001" +.SH NAME + \.cloginrc \- clogin configuration file +.SH DESCRIPTION +.B .cloginrc +contains configuration information for +.BR clogin (1), +.BR elogin (1), +.BR flogin (1), +and +.BR jlogin (1), +such as usernames, passwords, ssh encryption type, etc., and is read at +run-time. +.PP +Each line contains either white-space (blank line), a comment which begins +with the comment character '#' and may be preceded by white-space, or one +of the directives listed below. +.PP +Each line containing a directive is of the form: +.PP +.in +1i +.nf +add {} [{} ...] +.sp +or +.sp +include {} +.fi +.in -1i +.PP +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 +is used. For example; looking up the password for hostname foo in a +.B .cloginrc +file containing +.sp +.in +1i +.nf +add password * {bar} {table} +add password foo {bar} {table} +.fi +.in -1i +.sp +would return the first line, even though the second is an exact match. +.PP +.B .cloginrc +is expected to exist in the user's home directory and +must not be readable, writable, or executable by "others". +.B .cloginrc +should be +mode 0600, or 0640 if it is to be shared with other users who are members +of the same unix group. See +.BR chgrp (1) +and +.BR chmod (1) +for more information on ownership and file modes. +.PP +A sample +.B .cloginrc +file can be found in the top-level directory of the rancid distribution by the +name +.IR "cloginrc.sample" . +.SH DIRECTIVES +The accepted directives are (alphabetically): +.PP +.\" +.TP +.B add autoenable {[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 +different for enabled mode, ending with a # rather than a >. +.sp +Example: add autoenable * 1 +.sp +Default: 0 +.sp +zero, meaning that +the user is not automatically enabled and +.IR clogin +should execute the enable command to gain enable privileges, unless +negated by the noenable directive or \-noenable command\-line option. +.\" +.TP +.B add cyphertype {} +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 + \-c option for details. +.sp +Default: {3des} +.\" +.TP +.B add enableprompt {""} +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 +.IR clogin +should look for when trying to login. Note that enableprompt can be a Tcl +style regular expression. +.sp +Example: add enableprompt rc*.example.net {"\\[Ee]nter the enable password:"} +.sp +Default: "\\[Pp]assword:" +.\" +.TP +.B add enauser {} +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 {} +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 {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} +.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. +.sp +Default: {telnet} {ssh} +.\" +.TP +.B add noenable +.IR clogin +will not try to gain enable privileges when noenable is matched for a +device. This is equivalent to +.IR "clogin" 's +-noenable command-line option. This does not apply to +.BR jlogin (1). +.\" +.TP +.B add passprompt {""} +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 +.IR clogin +should look for when trying to login. Note that passprompt can be a Tcl +style regular expression. +.sp +Example: add passprompt rc*.example.net {"\\[Ee]nter the password:"} +.sp +Default: "(\\[Pp]assword|passwd):" +.\" +.TP +.B add password {} [{}] +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 {} +.\" rc is used to specifies a command that will be run by +.\" .IR clogin +.\" immediately after logging into the device. Multiple commands may be +.\" specified by separating them with semi-colons (;). The command must +.\" not be one which expects additional input from the user, such as 'copy +.\" rcp startup-config' on a Cisco. +.\" .sp +.\" Example: add rc *.domain.net {terminal monitor;show version} +.\" +.TP +.B add user {} +Specifies a username +.IR clogin +should use if or when prompted for one. +.sp +Default: $USER, ie: your Unix username. +.\" +.TP +.B add userpassword {} +Specifies a password to be associated with a user, if different from that +defined with the password directive. +.\" +.TP +.B add userprompt {""} +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 +.IR clogin +should look for when trying to login. Note that userprompt can be a Tcl +style regular expression. +.sp +Example: add userprompt rc*.example.net {"\\[Ee]nter your username:"} +.sp +Default: "(Username|login|user name):" +.\" +.TP +.B include {} + is the pathname of an additional +.B .cloginrc +file to include at that point. It is evaluated immediately. That is +important with regard to the order of matching hostnames for a given +directive, as mentioned above. This is useful if you have your own +.B .cloginrc +plus an additional +.B .cloginrc +file that is shared among a group of folks. +.sp +If is not a full pathname, $HOME/ will be prepended. +.sp +Example: include {.cloginrc.group} +.El +.SH FILES +.br +.nf +.\" set tabstop to longest possible filename, plus a wee bit +.ta \w'xHOME/xcloginrc 'u +\fI$HOME/.cloginrc\fR Configuration file described here. +.SH ERRORS +.B .cloginrc +is interpreted directly by Tcl, so its syntax follows that of Tcl. Errors +may produce quite unexpected results. +.SH "SEE ALSO" +.BR clogin (1) diff --git a/man/control_rancid.1 b/man/control_rancid.1 new file mode 100644 index 0000000..b5b31c4 --- /dev/null +++ b/man/control_rancid.1 @@ -0,0 +1,26 @@ +.\" +.hys 50 +.TH "control_rancid" "1" "22 Jan 2001" +.SH NAME +control_rancid \- run rancid for devices of a group +.SH SYNOPSIS +.B create_cvs +group +.SH DESCRIPTION +.B control_rancid +is a +.IR sh (1) +script to parse a group's +.BR router.db (5), +run rancid for each of the devices, possibly re-run rancid for missed devices, +e-mail diffs, and e-mail error reports. +.\" +.PP +.B control_rancid +is normally (and best) run via +.BR do-diffs (1). +.\" +.SH SEE ALSO +.BR do-diffs (1), +.BR env (5), +.BR router.db (5) diff --git a/man/create_cvs.1 b/man/create_cvs.1 new file mode 100644 index 0000000..353e92b --- /dev/null +++ b/man/create_cvs.1 @@ -0,0 +1,53 @@ +.\" +.hys 50 +.TH "create_cvs" "1" "13 Jan 2001" +.SH NAME +create_cvs \- initialize CVS and rancid group files and directories +.SH SYNOPSIS +.B create_cvs +[group [group ...]] +.SH DESCRIPTION +.B create_cvs +is a +.IR sh (1) +script to create the directories, +.BR router.db (5), +and +.BR cvs (1) +directories necessary for a rancid group. +.\" +.PP +.B create_cvs +reads +.BR env (5) +to configure itself. Then proceeds with the initialization first of the +.BR cvs (1) +repository, if necessary, and then for each of the rancid groups listed on +the command-line or those in the variable +.I LIST_OF_GROUPS +from +.BR env (5), +if the argument is omitted. +.\" +.PP +Running +.B create_cvs +for groups which already exist will not cause problems. If the group's +directory already exists, the +.BR cvs (1) +import will be skipped, and if it's +.BR router.db (5) +already exists, it will be left as-is. +.\" +.PP +The best method for adding groups is add the group name to +.I LIST_OF_GROUPS +in +.BR env (5), +then run +.B create_cvs. +.\" +.SH SEE ALSO +.BR cvs (1), +.BR env (5), +.BR router.db (5) diff --git a/man/do-diffs.1 b/man/do-diffs.1 new file mode 100644 index 0000000..cb42bb5 --- /dev/null +++ b/man/do-diffs.1 @@ -0,0 +1,95 @@ +.\" +.hys 50 +.TH "do-diffs" "1" "13 Jan 2001" +.SH NAME +do-diffs \- run rancid for each of the groups +.SH SYNOPSIS +.B do-diffs +[group [group ...]] +.SH DESCRIPTION +.B do-diffs +is a +.IR sh (1) +script to run +.IR rancid (1) +for a set of rancid group(s). +.PP +.B do-diffs +reads +.BR env (5) +to configure itself, then uses +.IR control_rancid (1) +to run +.IR rancid (1) +for each rancid group. The set of rancid groups can either be provided +as command-line arguments or via the +.I LIST_OF_GROUPS +variable in +.BR env (5), +if the group argument is omitted. +.PP +A lock file is maintained per-group to prevent simultaneous runs for a given +group by +.IR do-diffs (1). +The lock file will be named +.IR ..run.lock +and will be located in +.IR $TMPDIR +(see below). +.PP +A log file is produced under +.IR $BASEDIR/logs +for each rancid group processed. The file name will be .YYYYMMDD.HHMMSS +(year month day . hour minute second). +.PP +.B do-diffs +is normally used to run rancid from +.BR cron (8). +For example: +.PP +.in +1i +.nf +0 * * * * /usr/local/rancid/bin/do-diffs +.fi +.in -1i +.\" +.SH ENVIRONMENT +.B do-diffs +utilizes the following environment variables from +.BR env (5). +.\" +.TP +.B BASEDIR +Location of group directories, etc. +.\" +.TP +.B LIST_OF_GROUPS +List of rancid groups to collect. +.\" +.TP +.B PATH +Search path for utilities. +.\" +.TP +.B TMPDIR +Directory to hold temporary and lock files. +.SH ERRORS +If rancid fails to run or collect a device's configuration, the particular +group's log file (mentioned above) should be consulted. Any errors produced +by +.BR cvs (1) +or any of the rancid scripts should be included, whether they be a botched +cvs tree, login authentication failure, rancid configuration error, etc. If +the log file produces no clues, the next debugging step should be run the +commands manually. For example, can the user who runs rancid login to the +device with 'clogin hostname', and so on. +.BR +.SH FILES +.TP +.B $BASEDIR/bin/env +.B do-diffs +configuration file. +.El +.SH SEE ALSO +.BR control_rancid (1), +.BR env (5) diff --git a/man/elogin.1 b/man/elogin.1 new file mode 100644 index 0000000..4c83247 --- /dev/null +++ b/man/elogin.1 @@ -0,0 +1 @@ +.so man1/clogin.1 diff --git a/man/env.5.in b/man/env.5.in new file mode 100644 index 0000000..f12acdc --- /dev/null +++ b/man/env.5.in @@ -0,0 +1,154 @@ +.\" +.hys 50 +.TH "env" "5" "22 Jan 2001" +.SH NAME +env \- rancid environment configuration file +.SH DESCRIPTION +.B env +contains environment configuration information for +.BR do-diffs (1) +and +.BR rancid (1) +including shell PATH, list of rancid groups, etc. and is read by +.BR do-diffs (1) +at run-time. +.PP +The syntax of +.B env +is that of +.IR sh (1). +.B env +is used to set environment variables used by other rancid scripts to +effect their run-time behavior or to enable them to find their resources. +.PP +.SH VARIABLES +The following variables are used (alphabetically): +.PP +.Bl -tag -width flag +.\" +.TP +.B BASEDIR +BASEDIR is the top-level directory where rancid is installed. Its value +is set by configure and should be modified if rancid is moved to a new +location in the file system without re-installing from the distribution. +.sp +Default: @prefix@ +.\" +.TP +.B CVSROOT +.IR cvs (1) +and +.IR create_cvs (1) +use this environment variable to locate the CVS repository. It should +not be necessary to alter CVSROOT. +.sp +Default: $BASEDIR/CVS +.\" +.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 +for that set of devices. +.BR do-diffs (1) +also uses this variable to determine which device groups it should collect. +Choose these names to be descriptive of the set of devices and do not use +spaces, unprintable characters, etc. +.sp +Example: LIST_OF_GROUPS="UofO USFS" +.sp +Two groups are defined; UofO (University of Oregon) and USFS (US Forest +Service). Each will have a directory created (see +.IR create_cvs (1)) +$BASEDIR/UofO and $BASEDIR/USFS respectively, which will contain their data. +.sp +Each group must also have aliases for the administrative and diff recipients +set-up in +.IR /etc/aliases . +For example: +.sp +.in +1i +.nf +@MAILPLUS@uofo: frank +@MAILPLUS@admin-uofo: joe,bob +@MAILPLUS@usfs: frank +@MAILPLUS@admin-usfs: joe,bob +.fi +.sp +.in -1i +.\" +.TP +.B NOCOMMSTR +If set, +.IR rancid (1) +will filter SNMP community strings from configs. Otherwise, they will +be retained and may appear in clear-text in e-mail diffs. By default, +this is not set. +.\" +.TP +.B NOPIPE +If set, +.IR rancid (1) +will use temporary files to save the output from the router and then read +these to build the file which will be saved in CVS. Otherwise, an IPC +pipe will be used. We have found that the buffering mechanisms used in +perl and expect are heinous. Using temporary files may result in a noticeable +improvement in speed. By default, this is not set. +.\" +.TP +.B OLDTIME +Specified as a number of hours, OLDTIME defines how many hours should pass +since a successful collection of a device's configuration and when +.IR control_rancid (1) +should start complaining about failures. +.sp +Default: 4 +.\" +.TP +.B PATH +Is a colon separate list of directory pathnames in the the file system +where rancid's +.IR sh (1) +and +.IR perl (1) +scripts should look for the programs that it needs, such as +.IR telnet (1). +Its value is set by configure. Should it be necessary to modify PATH, +note that it must include $BASEDIR/bin (see above). +.\" +.TP +.B TERM +Some Unix utilities require TERM, the terminal type, to be set to a sane +value. The default should suffice. +.sp +Default: network +.\" +.TP +.B TMPDIR +Some Unix utilities recognize TMPDIR as a directory where temporary files +can be stored. In some cases, rancid utilizes this directory for lock +files and other temporary files. +.sp +Default: /tmp +.\" +.PP +Each of these are simply environment variables. In order for them to be +present in the environment of child processes, each must be exported. See +.IR sh (1) +for more information on the built-in command export. +.SH ERRORS +.B env +is interpreted directly by +.IR sh (1), +so its syntax follows that of the bourne shell. Errors +may produce quite unexpected results. +.SH FILES +.Bl -tag -width .BASEDIR/bin/ENV -compact +.TP +.B $BASEDIR/bin/env +Configuration file described here. +.El +.SH SEE ALSO +.BR control_rancid (1), +.BR create_cvs (1), +.BR do-diffs (1), +.BR rancid (1) diff --git a/man/erancid.1 b/man/erancid.1 new file mode 100644 index 0000000..b4633ee --- /dev/null +++ b/man/erancid.1 @@ -0,0 +1 @@ +.so man1/rancid.1 diff --git a/man/flogin.1 b/man/flogin.1 new file mode 100644 index 0000000..4c83247 --- /dev/null +++ b/man/flogin.1 @@ -0,0 +1 @@ +.so man1/clogin.1 diff --git a/man/francid.1 b/man/francid.1 new file mode 100644 index 0000000..b4633ee --- /dev/null +++ b/man/francid.1 @@ -0,0 +1 @@ +.so man1/rancid.1 diff --git a/man/jlogin.1 b/man/jlogin.1 new file mode 100644 index 0000000..4c83247 --- /dev/null +++ b/man/jlogin.1 @@ -0,0 +1 @@ +.so man1/clogin.1 diff --git a/man/jrancid.1 b/man/jrancid.1 new file mode 100644 index 0000000..b4633ee --- /dev/null +++ b/man/jrancid.1 @@ -0,0 +1 @@ +.so man1/rancid.1 diff --git a/man/lg.conf.5.in b/man/lg.conf.5.in new file mode 100644 index 0000000..fe7bdc7 --- /dev/null +++ b/man/lg.conf.5.in @@ -0,0 +1,129 @@ +.\" +.hys 50 +.TH "lg.conf" "5" "22 Jan 2001" +.SH NAME +lg.conf \- looking glass configuration file +.SH DESCRIPTION +.B lg.conf +contains configuration for the looking glass scripts. +.PP +The syntax is that of +.IR perl (1). +It is used to set variables to affect run-time behavior or to locate resources. +.\" +.SH VARIABLES +The following variables are used (alphabetically): +.Bl -tag -width flag +.\" +.TP +.B LG_AS_REG +*** not implemented. +.\" +.TP +.B LG_CACHE_DIR +Sets the location of the cache directory. The looking glass uses this +to hold lock files, log files, and output from cached commands. +.sp +Default: ./tmp +.sp +Note that the default is relative to the directory where +.IR lg.cgi +runs in the server's document root (eg: /usr/local/www/data/lg/tmp). +.\" +.TP +.B LG_CACHE_TIME +Sets the number of seconds that the looking glass should cache output from +commands that tend to produce a lot of output, such as 'show ip bgp +dampened-paths'. +.sp +Default: 600 +.\" +.TP +.B LG_CLOGINRC +Defines the +.BR cloginrc (5) +that the looking glass should use. The path may be relative to the directory +where the CGI scripts run in the server's document root. +.sp +Default: @prefix@/.cloginrc +.sp +Note that the .cloginrc must be readable by the user or group that will be +running the CGI and that +.BR clogin (1) +will not allow a world readable +.IR .cloginrc . +The user is normally that of the http server (httpd). +.\" +.TP +.B LG_IMAGE +Defines a html image tag () which, if defined, will be included at +the top of the looking glass pages. It may contain any html as it is +simply handed off to print(). +.sp +Example: $LG_IMAGE="\n FOO"; +.\" +.TP +.B LG_LOG +Defines the fully qualified path name for the log file or the +.BR syslog (3) +facility to use for logging. For syslog, the argument is the lowercase name +of a syslog facility (see syslog.h) without the 'LOG_' prefix. +.sp +Example: local0 +.sp +Default: $LG_CACHE_DIR/lg.log +.\" +.TP +.B LG_ROUTERDB +Sets the location for the +.IR router.db +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 +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. +.sp +Default: @prefix@/util/lg/router.db +.sp +Note that if the concatenation method is used, it may be necessary to alter +the mode of the router.db files in the rancid group directories, since the +default umask is 027 (see +.BR env (5)). +.\" +.TP +.B LG_SINGLE +*** not implemented. +.\" +.TP +.B PATH +Is a colon separate list of directory pathnames in the the file system +where rancid's login scripts, +.IR clogin (1) +etc. ) +and programs needed within these, such as +.IR telnet (1), +are located. +Its value is set by configure. Should it be necessary to modify PATH, +note that it must include $BASEDIR/bin (see above). +.\" +.El +.\" +.SH ERRORS +.B lg.conf +is interpreted directly by +.IR perl (1), +so its syntax follows that of perl. Errors may produce quite unexpected +results. +.SH FILES +.Bl -tag -width .BASEDIR/bin/ENV -compact +.TP +.B $BASEDIR/util/lg/lg.conf +Configuration file described here, where $BASEDIR is set at the time that +the rancid package was configured. In this case, $BASEDIR is +.IR @prefix@ . +.El +.SH SEE ALSO +.BR cloginrc (5), +.BR lg_intro (1) diff --git a/man/lg_intro.1.in b/man/lg_intro.1.in new file mode 100644 index 0000000..1af8942 --- /dev/null +++ b/man/lg_intro.1.in @@ -0,0 +1,64 @@ +.\" +.hys 50 +.TH "lg_intro" "1" "24 Jan 2001" +.SH NAME +lg_intro \- introduction to the looking glass +.\" +.SH INTRODUCTION +The +.B looking glass +offers a web based interface to routers to users without their needing +permission to login to the router. This may be a perfect interface for customer +support or less savvy folks, and many ISPs have given public access to such +an interface as a "route server." +.\" +.SH DESCRIPTION +The looking glass consists of two CGI +.BR perl (1) +scripts, +.IR lg.cgi +and +.IR lg.form.cgi , +and the +.BR lg.conf (5) +configuration file. +.PP +Both of these scripts begin with reading the configuration file. If +there is an error in the file's syntax or if the file can not be found, error +messages will be displayed on standard-error. The Apache http server +redirects standard-error to its error log file by default. +.PP +lg.form.cgi displays a html form consisting of a list of possible +router commands that can be run and a scrolling list of routers that +these commands may be run on. When the form is submitted, lg.cgi is +run. +.PP +When lg.cgi is run, it begins by performing some basic checks on the +arguments passed to it. If these checks pass, lg.cgi either displays +cached data from a previous invocation if that data exists and is +within the cache interval or uses +.BR clogin (1) +to login to the device and execute the command. The +results of the command are cached if applicable and displayed for the +user. +.\" +.SH "GETTING STARTED" +Besides +.BR lg.conf (5), +additional instructions for setting up the looking glass can be found +in the README file under +.IR @prefix@/util/lg . +.PP +Note that the looking glass scripts require a few perl modules not +included with rancid. Rancid's configure process does not check for +these. See the README file. +.\" +.SH "SEE ALSO" +.BR cloginrc (5), +.BR clogin (1), +.BR lg.conf (5) +.SH HISTORY +Rancid's looking glass is based on Ed Kern's (included by permission, +thanks Ed!), which can be found on http://nitrous.digex.net/. Support +for Junipers, rancid's device login scripts, and additional commands have +been added to the original. diff --git a/man/rancid.1 b/man/rancid.1 new file mode 100644 index 0000000..dd860df --- /dev/null +++ b/man/rancid.1 @@ -0,0 +1,55 @@ +.\" +.hys 50 +.TH "rancid" "1" "13 Jan 2001" +.SH NAME +rancid \- Cisco configuration filter +.SH SYNOPSIS +.B rancid +[\fB\-dl\fP] +([\c +.BI \-f\ \c +filename]\ \c +| hostname) +.SH DESCRIPTION +.B rancid +is a +.BR perl (1) +script which uses +.BR clogin (1) +to login to a Cisco router, execute commands to display +the configuration, etc, then filters the output for formatting, security, +and so on. +.B rancid's +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 Cisco catalyst switch, Juniper, Foundry, +and ADC-kentrox EZ-T3 mux named +.B cat5rancid, +.B jrancid, +.B francid, +and +.B erancid, +respectively. +.PP +The command-line options are as follows: +.TP +.B \-d +Display debugging information. +.\" +.TP +.B \-l +Display somewhat less debugging information. +.\" +.TP +.B \-f +.B rancid +should interpret the next argument as a filename which contains the +output it would normally collect from the device ( +.I hostname\c +) with +.IR clogin (1). +.SH "SEE ALSO" +.BR control_rancid (1), +.BR clogin (1), +.BR env (5) diff --git a/man/rancid_intro.1 b/man/rancid_intro.1 new file mode 100644 index 0000000..3d866c1 --- /dev/null +++ b/man/rancid_intro.1 @@ -0,0 +1,113 @@ +.\" +.hys 50 +.TH "rancid_intro" "1" "22 Jan 2001" +.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 Cisco, Foundry, +Juniper, Redback, 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 +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 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 /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) +for more information on 's. +.PP +After filtering, a uni-diff (see diff(1)) of the result is produced +for each of the devices in a group against that of the previous run of +.B rancid +and is e-mailed to that group's mail list, "rancid-". This e-mail +will also include any differences of the device list in the group's +configuration file, +.IR "router.db". +.PP +Lastly, all the updated files are checked into the CVS repository. +.PP +Additional utilities, including a looking glass, can be found under +the util sub-directory. +.SH "EXAMPLE E-MAIL" +Below is a sample of a uni-diff produced from the group "shrubbery" +for the device named dfw.shrubbery.net, which happens to be a Cisco GSR. +.PP +.nf +From: rancid +To: rancid-shrubbery@shrubbery.net +Subject: shrubbery router config diffs +Precedence: bulk + +Index: configs/dfw.shrubbery.net +=================================================================== +retrieving revision 1.144 +diff -u -4 -r1.144 dfw.shrubbery.net +@@ -57,14 +57,8 @@ + !Slot 2/MBUS: hvers 1.1 + !Slot 2/MBUS: software 01.36 (RAM) (ROM version is 01.33) + !Slot 2/MBUS: 128 Mbytes DRAM, 16384 Kbytes SDRAM + ! +- !Slot 6: 1 Port Gigabit Ethernet +- !Slot 6/PCA: part 73-3302-03 rev C0 ver 3, serial CAB031216OL +- !Slot 6/PCA: hvers 1.1 +- !Slot 6/MBUS: part 73-2146-07 rev B0 dev 0, serial CAB031112SB +- !Slot 6/MBUS: hvers 1.2 +- !Slot 6/MBUS: software 01.36 (RAM) (ROM version is 01.33) + !Slot 7: Route Processor + !Slot 7/PCA: part 73-2170-03 rev B0 ver 3, serial CAB024901SI + !Slot 7/PCA: hvers 1.4 + !Slot 7/MBUS: part 73-2146-06 rev A0 dev 0, serial CAB02060044 +.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 +can not communicate with it to collect information. +.SH "GETTING STARTED" +Installation instructions are included in the distribution's top-level +directory in the README file. Once the installation is complete, start +by reading the man pages listed below or follow the basic instructions +included in the README file. +.PP +See http://www.shrubbery.net/rancid for information on new versions, +mail lists, etc. +.B rancid +can be retrieved from ftp://ftp.shrubbery.net/pub/rancid. +.SH "ADDING NEW GROUPS" +Follow this procdure for adding new groups: +.TP +o +Update the +.IR LIST_OF_GROUPS +variable in +.IR bin/env +(see +.BR env (5)). +.TP +o +Run +.BR create_cvs (1). +.TP +o +Update the system's mail aliases file +.IR /etc/aliases ( +see +.BR env (5)). +.\" +.SH "SEE ALSO" +.BR cloginrc (5), +.BR clogin (1), +.BR control_rancid (1), +.BR env (5), +.BR do-diffs (1), +.BR lg_intro (1), +.BR router.db (5) , +.BR rancid (1) diff --git a/man/router.db.5 b/man/router.db.5 new file mode 100644 index 0000000..b51153b --- /dev/null +++ b/man/router.db.5 @@ -0,0 +1,106 @@ +.\" +.hys 50 +.TH "router.db" "5" "22 Jan 2001" +.SH NAME +router.db \- rancid group configuration file +.SH DESCRIPTION +.B router.db +contains information for devices which are members of a rancid group. +.IR control_rancid (1) +reads this file to compile a list of devices which it should collect. +.\" +.SH SYNTAX +One device is listed per-line, where the syntax is: +.PP +.in +1i +.nf +::[:] +.fi +.in -1i +.PP +For example: +.in +1i +.nf +scooby.shrubbery.net:cisco:up +.fi +.in -1i +.PP +.\" +The fields are as follows: +.TP +.B +The name of the device, which must resolve via +.I gethostbyname\c +, used as the argument to +.IR telnet (1), +.IR rsh (1), +or +.IR ssh (1), +to connect to the device. Once converted to lower-case, this +also becomes the name of the file used to store the configuration under +\fI$BASEDIR//configs\fR. +.sp +Experience has shown that using the device's FQDN (Fully Qualified +Domain Name) works best, as in the example above. +.\" +.TP +.B +The type of device from the set: +.RS 8n +.TP +.B cat5 +A cisco catalyst switch (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 ezt3 +An ADC-Kentrox EZ-T3 mux. +.TP +.B foundry +A Foundry router, switch, or router-switch. +.TP +.B juniper +A Juniper router. +.TP +.ID 15n +.B redback +A Redback router, NAS, etc. +.RE +.\" +.TP +.B +The state is either "up" or "down". If the device is marked "down", the +device's +configuration will not be collected. +.PP +A ``#'' at the begining of a line is a comment; the entire line is +ignored. +.PP +If you delete a device from the +.B router.db +file, then +.B rancid +will clean up by removing the device's config file from +\fI$BASEDIR//configs\fR. +The +.IR cvs (1) +information for the device will be moved to +.IR cvs (1)'s +Attic directory (using +.IR "cvs delete"). +.PP +.SH FILES +.ta \w'xBASEDIR//router.db 'u +.TP +.B $BASEDIR//router.db +Configuration file described here, where is a device group name +defined in the variable +.I LIST_OF_GROUPS +within \fI$BASEDIR/bin/env\fR. +.El +.SH SEE ALSO +.BR control_rancid (1), +.BR env (5), +.BR rancid (1) -- cgit