diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 21 | ||||
| -rw-r--r-- | man/Makefile.in | 135 | ||||
| -rw-r--r-- | man/arancid.1 | 1 | ||||
| -rw-r--r-- | man/brancid.1 | 1 | ||||
| -rw-r--r-- | man/clogin.1 | 55 | ||||
| -rw-r--r-- | man/cloginrc.5 | 68 | ||||
| -rw-r--r-- | man/control_rancid.1 | 14 | ||||
| -rw-r--r-- | man/drancid.1 | 1 | ||||
| -rw-r--r-- | man/lg.conf.5.in | 2 | ||||
| -rw-r--r-- | man/lg_intro.1.in | 4 | ||||
| -rw-r--r-- | man/rancid-cvs.1 | 42 | ||||
| -rw-r--r-- | man/rancid-run.1 | 36 | ||||
| -rw-r--r-- | man/rancid.1 | 152 | ||||
| -rw-r--r-- | man/rancid.conf.5.in | 73 | ||||
| -rw-r--r-- | man/rancid_intro.1 | 22 | ||||
| -rw-r--r-- | man/router.db.5 | 20 |
16 files changed, 413 insertions, 234 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index 4be3c26..5cf66fc 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,7 +1,7 @@ ## 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.44 2004/01/11 06:12:35 hank Exp $ +## $Id: Makefile.am,v 1.46 2006/09/05 02:26:52 asp Exp $ ## ## Copyright (C) 1997-2004 by Terrapin Communications, Inc. ## All rights reserved. @@ -25,15 +25,14 @@ AUTOMAKE_OPTIONS=foreign no-dependencies @SET_MAKE@ man_gen_MANS = lg.conf.5 rancid.conf.5 lg_intro.1 -man_nogen_MANS = alogin.1 blogin.1 clogin.1 control_rancid.1 \ - cssrancid.1 rancid.1 \ - rancid_intro.1 cloginrc.5 router.db.5 \ - elogin.1 f10rancid.1 flogin.1 fnrancid.1 \ - hlogin.1 hrancid.1 htlogin.1 htrancid.1 jlogin.1 \ - jrancid.1 jerancid.1 f10rancid.1 francid.1 cat5rancid.1 \ - erancid.1 mrancid.1 nlogin.1 nrancid.1 nslogin.1 nsrancid.1 \ - par.1 prancid.1 \ - rancid-cvs.1 rancid-run.1 rivlogin.1 rivrancid.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 \ + rancid_intro.1 rivlogin.1 rivrancid.1 router.db.5 \ tntlogin.1 tntrancid.1 xrancid.1 zrancid.1 man_MANS = $(man_nogen_MANS) $(man_gen_MANS) @@ -53,7 +52,7 @@ auto_edit = sed \ -e 's,@bindir\@,$(bindir),g' \ -e 's,@localstatedir\@,$(localstatedir),g' \ -e 's,@sysconfdir\@,$(sysconfdir),g' \ - -e 's,@pkgdatadir\@,$(sysconfdir),g' \ + -e 's,@pkgdatadir\@,$(pkgdatadir),g' \ -e 's,@ADMINMAILPLUS\@,$(ADMINMAILPLUS),g' \ -e 's,@MAILPLUS\@,$(MAILPLUS),g' diff --git a/man/Makefile.in b/man/Makefile.in index 135c237..f95580a 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -1,8 +1,8 @@ -# Makefile.in generated by automake 1.8 from Makefile.am. +# Makefile.in generated by automake 1.10 from Makefile.am. # @configure_input@ -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 -# Free Software Foundation, Inc. +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006 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. @@ -13,15 +13,11 @@ # PARTICULAR PURPOSE. @SET_MAKE@ -srcdir = @srcdir@ -top_srcdir = @top_srcdir@ VPATH = @srcdir@ pkgdatadir = $(datadir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ -top_builddir = .. am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd -INSTALL = @INSTALL@ install_sh_DATA = $(install_sh) -c -m 644 install_sh_PROGRAM = $(install_sh) -c install_sh_SCRIPT = $(install_sh) -c @@ -48,15 +44,13 @@ am__depfiles_maybe = SOURCES = DIST_SOURCES = man1dir = $(mandir)/man1 -am__installdirs = $(DESTDIR)$(man1dir) $(DESTDIR)$(man5dir) +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" man5dir = $(mandir)/man5 NROFF = nroff MANS = $(man_MANS) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ ADMINMAILPLUS = @ADMINMAILPLUS@ -AMDEP_FALSE = @AMDEP_FALSE@ -AMDEP_TRUE = @AMDEP_TRUE@ AMTAR = @AMTAR@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ @@ -85,6 +79,7 @@ EXPECT_PATH = @EXPECT_PATH@ FIND = @FIND@ GREP = @GREP@ ID = @ID@ +INSTALL = @INSTALL@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ @@ -98,6 +93,7 @@ MAILPLUS = @MAILPLUS@ MAKE = @MAKE@ MAKEINFO = @MAKEINFO@ MKDIR = @MKDIR@ +MKDIR_P = @MKDIR_P@ OBJEXT = @OBJEXT@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ @@ -109,6 +105,7 @@ PATH_SEPARATOR = @PATH_SEPARATOR@ PERLV = @PERLV@ PERLV_PATH = @PERLV_PATH@ PING_PATH = @PING_PATH@ +RCSSYS = @RCSSYS@ RSH = @RSH@ SENDMAIL = @SENDMAIL@ SET_MAKE = @SET_MAKE@ @@ -116,49 +113,63 @@ SHELL = @SHELL@ SORT = @SORT@ SSH = @SSH@ STRIP = @STRIP@ +SVN = @SVN@ TAR = @TAR@ TELNET = @TELNET@ TOUCH = @TOUCH@ U = @U@ VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ ac_ct_CC = @ac_ct_CC@ -ac_ct_STRIP = @ac_ct_STRIP@ -am__fastdepCC_FALSE = @am__fastdepCC_FALSE@ -am__fastdepCC_TRUE = @am__fastdepCC_TRUE@ am__include = @am__include@ am__leading_dot = @am__leading_dot@ am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ bindir = @bindir@ build_alias = @build_alias@ +builddir = @builddir@ datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ exec_prefix = @exec_prefix@ host_alias = @host_alias@ +htmldir = @htmldir@ includedir = @includedir@ infodir = @infodir@ install_sh = @install_sh@ libdir = @libdir@ libexecdir = @libexecdir@ +localedir = @localedir@ localstatedir = @localstatedir@ mandir = @mandir@ mkdir_p = @mkdir_p@ oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ prefix = @prefix@ program_transform_name = @program_transform_name@ +psdir = @psdir@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ sysconfdir = @sysconfdir@ target_alias = @target_alias@ +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 blogin.1 clogin.1 control_rancid.1 \ - cssrancid.1 rancid.1 \ - rancid_intro.1 cloginrc.5 router.db.5 \ - elogin.1 f10rancid.1 flogin.1 fnrancid.1 \ - hlogin.1 hrancid.1 htlogin.1 htrancid.1 jlogin.1 \ - jrancid.1 jerancid.1 f10rancid.1 francid.1 cat5rancid.1 \ - erancid.1 mrancid.1 nlogin.1 nrancid.1 nslogin.1 nsrancid.1 \ - par.1 prancid.1 \ - rancid-cvs.1 rancid-run.1 rivlogin.1 rivrancid.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 \ + rancid_intro.1 rivlogin.1 rivrancid.1 router.db.5 \ tntlogin.1 tntrancid.1 xrancid.1 zrancid.1 man_MANS = $(man_nogen_MANS) $(man_gen_MANS) @@ -176,7 +187,7 @@ auto_edit = sed \ -e 's,@bindir\@,$(bindir),g' \ -e 's,@localstatedir\@,$(localstatedir),g' \ -e 's,@sysconfdir\@,$(sysconfdir),g' \ - -e 's,@pkgdatadir\@,$(sysconfdir),g' \ + -e 's,@pkgdatadir\@,$(pkgdatadir),g' \ -e 's,@ADMINMAILPLUS\@,$(ADMINMAILPLUS),g' \ -e 's,@MAILPLUS\@,$(MAILPLUS),g' @@ -212,10 +223,9 @@ $(top_srcdir)/configure: $(am__configure_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(ACLOCAL_M4): $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh -uninstall-info-am: install-man1: $(man1_MANS) $(man_MANS) @$(NORMAL_INSTALL) - $(mkdir_p) $(DESTDIR)$(man1dir) + test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)" @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \ l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ for i in $$l2; do \ @@ -234,8 +244,8 @@ install-man1: $(man1_MANS) $(man_MANS) inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ inst=`echo $$inst | sed -e 's/^.*\///'`; \ inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " $(INSTALL_DATA) $$file $(DESTDIR)$(man1dir)/$$inst"; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(man1dir)/$$inst; \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst"; \ done uninstall-man1: @$(NORMAL_UNINSTALL) @@ -255,12 +265,12 @@ uninstall-man1: inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ inst=`echo $$inst | sed -e 's/^.*\///'`; \ inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " rm -f $(DESTDIR)$(man1dir)/$$inst"; \ - rm -f $(DESTDIR)$(man1dir)/$$inst; \ + echo " rm -f '$(DESTDIR)$(man1dir)/$$inst'"; \ + rm -f "$(DESTDIR)$(man1dir)/$$inst"; \ done install-man5: $(man5_MANS) $(man_MANS) @$(NORMAL_INSTALL) - $(mkdir_p) $(DESTDIR)$(man5dir) + test -z "$(man5dir)" || $(MKDIR_P) "$(DESTDIR)$(man5dir)" @list='$(man5_MANS) $(dist_man5_MANS) $(nodist_man5_MANS)'; \ l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ for i in $$l2; do \ @@ -279,8 +289,8 @@ install-man5: $(man5_MANS) $(man_MANS) inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ inst=`echo $$inst | sed -e 's/^.*\///'`; \ inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " $(INSTALL_DATA) $$file $(DESTDIR)$(man5dir)/$$inst"; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(man5dir)/$$inst; \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man5dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man5dir)/$$inst"; \ done uninstall-man5: @$(NORMAL_UNINSTALL) @@ -300,8 +310,8 @@ uninstall-man5: inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ inst=`echo $$inst | sed -e 's/^.*\///'`; \ inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " rm -f $(DESTDIR)$(man5dir)/$$inst"; \ - rm -f $(DESTDIR)$(man5dir)/$$inst; \ + echo " rm -f '$(DESTDIR)$(man5dir)/$$inst'"; \ + rm -f "$(DESTDIR)$(man5dir)/$$inst"; \ done tags: TAGS TAGS: @@ -311,22 +321,21 @@ CTAGS: distdir: $(DISTFILES) - @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ - topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ - list='$(DISTFILES)'; for file in $$list; do \ - case $$file in \ - $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ - $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ - esac; \ + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ - dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ - if test "$$dir" != "$$file" && test "$$dir" != "."; then \ - dir="/$$dir"; \ - $(mkdir_p) "$(distdir)$$dir"; \ - else \ - dir=''; \ - fi; \ if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ fi; \ @@ -341,7 +350,9 @@ check-am: all-am check: check-am all-am: Makefile $(MANS) installdirs: - $(mkdir_p) $(DESTDIR)$(man1dir) $(DESTDIR)$(man5dir) + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done install: install-am install-exec: install-exec-am install-data: install-data-am @@ -362,7 +373,7 @@ clean-generic: -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) distclean-generic: - -rm -f $(CONFIG_CLEAN_FILES) + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) maintainer-clean-generic: @echo "This command is intended for maintainers to use" @@ -387,12 +398,20 @@ info-am: install-data-am: install-man +install-dvi: install-dvi-am + install-exec-am: +install-html: install-html-am + install-info: install-info-am install-man: install-man1 install-man5 +install-pdf: install-pdf-am + +install-ps: install-ps-am + installcheck-am: maintainer-clean: maintainer-clean-am @@ -411,19 +430,23 @@ ps: ps-am ps-am: -uninstall-am: uninstall-info-am uninstall-man +uninstall-am: uninstall-man uninstall-man: uninstall-man1 uninstall-man5 +.MAKE: install-am install-strip + .PHONY: all all-am check check-am clean clean-generic distclean \ distclean-generic distdir dvi dvi-am html html-am info info-am \ - install install-am install-data install-data-am install-exec \ - install-exec-am install-info install-info-am install-man \ - install-man1 install-man5 install-strip installcheck \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-man1 install-man5 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ installcheck-am installdirs maintainer-clean \ maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ - pdf-am ps ps-am uninstall uninstall-am uninstall-info-am \ - uninstall-man uninstall-man1 uninstall-man5 + pdf-am ps ps-am uninstall uninstall-am uninstall-man \ + uninstall-man1 uninstall-man5 @SET_MAKE@ diff --git a/man/arancid.1 b/man/arancid.1 new file mode 100644 index 0000000..b4633ee --- /dev/null +++ b/man/arancid.1 @@ -0,0 +1 @@ +.so man1/rancid.1 diff --git a/man/brancid.1 b/man/brancid.1 new file mode 100644 index 0000000..b4633ee --- /dev/null +++ b/man/brancid.1 @@ -0,0 +1 @@ +.so man1/rancid.1 diff --git a/man/clogin.1 b/man/clogin.1 index 48e53ea..53f1971 100644 --- a/man/clogin.1 +++ b/man/clogin.1 @@ -1,12 +1,13 @@ .\" .hys 50 -.TH "clogin" "1" "6 Jan 2004" +.TH "clogin" "1" "23 November 2006" .SH NAME clogin \- Cisco/Foundry login script .SH SYNOPSIS .B clogin [\fB\-autoenable\fP] [\fB\-noenable\fP] +[\fB\-V\fR] [\c .BI \-c\ command] @@ -54,8 +55,9 @@ catalyst switch, Extreme switch, Juniper ERX/E-series, Procket Networks, or Redback router. There are complementary scripts for Alteon, -Bay Networks (nortel), ADC-kentrox EZ-T3 mux, +Bay Networks (nortel), +Cisco AGM, Foundry, HP Procurve Switches, Hitachi Routers, @@ -83,13 +85,15 @@ respectively. 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 +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 configuration file. .PP The command-line options are as follows: -.PP +.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 @@ -134,8 +138,10 @@ with the connection to the router intact, when it is done. Note that disables .IR log_user of -.BR expect (1). -Example script(s) can be found in util/*.exp. +.BR expect (1) when +.B \-s +is used. +Example script(s) can be found in share/rancid/*.exp. .\" .TP .B \-t @@ -209,6 +215,12 @@ will not change the banner on your xterm window if this includes the character 'x'. .\" .TP +.B CLOGINRC +Specifies an alternative location for the +.IR .cloginrc +file, like the \fB\-f\fP option. +.\" +.TP .B HOME Normally set by .BR login (1) @@ -227,6 +239,11 @@ configuration file. .BR expect (1) .\" .SH CAVEATS +.B clogin +expects CatOS devices to have a prompt which includes a '>', +such as "router> (enable)". It uses this to determine, for example, +whether the command to disable the pager is "set length 0" or "term length 0". +.PP The HP Procurve switches that are Foundry OEMs use flogin, not hlogin. .PP The Extreme is supported by @@ -245,13 +262,19 @@ when the device is ready for the next command. All these login scripts for separate devices should be rolled into one. This goal is exceedingly difficult. .PP -The HP Procurve switch CLI relies heavily upon curses for 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. Thus bin/hpuifilter, which must be found in the PATH, 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 typing CTRL-R to reprint the -current line. +The HP Procurve switch and Cisco AGM CLIs rely heavily upon terminal escape +codes for 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. +Thus bin/hpuifilter, which must be found in the user's PATH, is used by +hlogin to filter these escape sequences. +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 typing CTRL-R to reprint the current line. .PP +WARNING: repeated ssh login failures to HP Procurves cause the switch's +management interface to lock-up (this includes snmp, ping) and sometimes +it will crash. This is with the latest firmware; 5.33 at the time of this +writing. diff --git a/man/cloginrc.5 b/man/cloginrc.5 index 36709c2..49553fd 100644 --- a/man/cloginrc.5 +++ b/man/cloginrc.5 @@ -1,8 +1,8 @@ .\" -.\" $Id: cloginrc.5,v 1.31 2004/01/11 01:53:10 heas Exp $ +.\" $Id: cloginrc.5,v 1.37 2005/09/12 18:48:19 heas Exp $ .\" .hys 50 -.TH "cloginrc" "5" "11 Jan 2004" +.TH "cloginrc" "5" "12 September 2005" .SH NAME \.cloginrc \- clogin configuration file .SH DESCRIPTION @@ -42,12 +42,13 @@ include {<file>} .PP Note: the braces ({}) surrounding the values is significant when the values include TCL meta-characters. Best common practice is to always enclose the -values in braces. If a value includes a (left or right) brace, it must -be backslash-escaped, as in: +values in braces. If a value includes a (left or right) brace or space +character, it must be backslash-escaped, as in: .PP .in +1i .nf add user <hostname glob> {foo\\}bar} +add user <hostname glob> {foo\\ bar} .fi .in -1i .PP @@ -91,7 +92,7 @@ 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 +Example: add autoenable * {1} .sp Default: 0 .sp @@ -100,6 +101,10 @@ 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. +.sp +Also see the +.B noenable +directive. .\" .TP .B add cyphertype <router name glob> {<ssh encryption type>} @@ -119,7 +124,7 @@ may be used to adjust the prompt that 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:"} +Example: add enableprompt rc*.example.net {"\\[Ee]nter\\ the\\ enable\\ password:"} .sp Default: "\\[Pp]assword:" .\" @@ -153,7 +158,7 @@ add "mode character" to .telnetrc. See for more information on telnet command-line syntax, telnet options, and .telnetrc. .sp -Example: add method * {ssh} {telnet:3000} {rsh} +Example: add method * {ssh} {telnet:-3000} {rsh} .sp Which would cause .IR clogin @@ -166,13 +171,32 @@ Note that not all platforms support all of these connection methods. Default: {telnet} {ssh} .\" .TP -.B add noenable <router name glob> +.B add noenable <router name glob> {1} .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). +-noenable command-line option. +.sp +Note that this directive is meaningless for +.BR jlogin (1), +.BR nlogin (1) +and +.BR clogin (1) +[for Extreme] +which do not have the concept of "enabled" and/or no way to elevate +privleges once logged in; a user either has the necessary privleges or +doesn't. +.\" +.TP +.B add passphrase <router name glob> {"<SSH passphrase>"} +Specify the SSH passphrase. Note that this may be particular to an +.B identity +directive. The passphrase will default to the +.B password +for the given router. +.sp +Example: add passphrase rc*.example.net {the\\ bird\\ goes\\ tweet} .\" .TP .B add passprompt <router name glob> {"<password prompt>"} @@ -183,7 +207,7 @@ used to adjust the prompt that 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:"} +Example: add passprompt rc*.example.net {"\\[Ee]nter\\ the\\ password:"} .sp Default: "(\\[Pp]assword|passwd):" .\" @@ -194,6 +218,16 @@ 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 sshcmd <router name glob> {<ssh>} +<ssh> is the name of the ssh executable. OpenSSH uses a command-line +option to specify the protocol version, but other implementations use +a separate binary such as "ssh1". +.B sshcmd +allows this to be adjusted as necessary for the local environment. +.sp +Default: ssh +.\" .\" .TP .\" .B add rc <router name glob> {<cmd;cmd>} .\" rc is used to specifies a command that will be run by @@ -227,7 +261,7 @@ used to adjust the prompt that 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:"} +Example: add userprompt rc*.example.net {"\\[Ee]nter\\ your\\ username:"} .sp Default: "(Username|login|user name):" .\" @@ -246,16 +280,6 @@ file that is shared among a group of folks. If <file> is not a full pathname, $HOME/ will be prepended. .sp Example: include {.cloginrc.group} -.\" -.TP -.B add sshcmd {<ssh>} -<ssh> is the name of the ssh executable. OpenSSH uses a command-line -option to specify the protocol version, but other implementations use -a separate binary such as "ssh1". -.B sshcmd -allows this to be adjusted as necessary for the local environment. -.sp -Default: ssh .El .SH FILES .br diff --git a/man/control_rancid.1 b/man/control_rancid.1 index f502fb0..3dd34bf 100644 --- a/man/control_rancid.1 +++ b/man/control_rancid.1 @@ -1,11 +1,11 @@ .\" .hys 50 -.TH "control_rancid" "1" "7 Jan 2004" +.TH "control_rancid" "1" "5 October 2006" .SH NAME control_rancid \- run rancid for devices of a group .SH SYNOPSIS .B control_rancid -[\c +[\fB\-V\fR] [\c .BI \-m\ \c mail_rcpt]\ \c [\c @@ -18,13 +18,16 @@ 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. +run rancid for each of the devices, possibly re-run rancid for devices +that failed collection, e-mail diffs, and e-mail error reports. .\" .PP .\" The command-line options are as follows: .TP +.B \-V +Prints package name and version strings. +.TP .B \-m mail_rcpt Specify the recipient of diff mail, which is normally rancid-<group>. The argument may be a single address, multiple comma separated addresses, or @@ -45,7 +48,8 @@ with <group name>/<device name> rather than just the group name alone. .B control_rancid is normally (and best) run via .BR rancid-run (1) -which provides a locking mechanism on a group basis. +which provides a locking mechanism on a group basis and saves output +in a log file for each group. .\" .SH "SEE ALSO" .BR rancid-run (1), diff --git a/man/drancid.1 b/man/drancid.1 new file mode 100644 index 0000000..b4633ee --- /dev/null +++ b/man/drancid.1 @@ -0,0 +1 @@ +.so man1/rancid.1 diff --git a/man/lg.conf.5.in b/man/lg.conf.5.in index a2058d1..6e9f86c 100644 --- a/man/lg.conf.5.in +++ b/man/lg.conf.5.in @@ -9,7 +9,7 @@ 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 and/or to locate +It is used to set variables that affect run-time behavior and/or to locate resources. .\" .SH VARIABLES diff --git a/man/lg_intro.1.in b/man/lg_intro.1.in index a9a72c4..2ce66e6 100644 --- a/man/lg_intro.1.in +++ b/man/lg_intro.1.in @@ -35,8 +35,8 @@ run. .PP lg.cgi 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 +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 diff --git a/man/rancid-cvs.1 b/man/rancid-cvs.1 index 2cb34bd..41c68dd 100644 --- a/man/rancid-cvs.1 +++ b/man/rancid-cvs.1 @@ -1,29 +1,26 @@ .\" .hys 50 -.TH "rancid-cvs" "1" "7 Jan 2004" +.TH "rancid-cvs" "1" "5 October 2006" .SH NAME -rancid-cvs \- initialize CVS and rancid group files and directories +rancid-cvs \- initialize CVS or Subversion and rancid group files and directories .SH SYNOPSIS .B rancid-cvs -[group [group ...]] +[\fB\-V\fR] [group [group ...]] .SH DESCRIPTION .B rancid-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. +creates the directories and +.BR router.db (5) +for each rancid group and handles the revision control system (CVS or +Subversion) set-up. +It must be run after installation and whenever a rancid group is added. .\" .PP .B rancid-cvs reads .BR rancid.conf (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 +to configure itself, then proceeds with the initialization. +First of the CVS or Subversion 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 rancid.conf (5), @@ -33,11 +30,17 @@ if the argument is omitted. Running .B rancid-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 +directory already exists, the import into the revision control system +will be skipped, and if it's .BR router.db (5) -already exists, it will be left as-is. +already exists, it will not be altered. +.\" +.PP +.\" +The command-line options are as follows: +.TP +.B \-V +Prints package name and version strings. .\" .PP The best method for adding groups is add the group name to @@ -51,4 +54,5 @@ to do it. .SH "SEE ALSO" .BR cvs (1), .BR rancid.conf (5), -.BR router.db (5) +.BR router.db (5), +.BR svn (1) diff --git a/man/rancid-run.1 b/man/rancid-run.1 index 3e99b26..302bc72 100644 --- a/man/rancid-run.1 +++ b/man/rancid-run.1 @@ -1,10 +1,16 @@ .\" .hys 50 -.TH "rancid-run" "1" "7 Jan 2004" +.TH "rancid-run" "1" "5 October 2006" .SH NAME rancid-run \- run rancid for each of the groups .SH SYNOPSIS .B rancid-run +[\fB\-V\fR] [\c +.BI \-f\ \c +rancid.conf]\ \c +[\c +.BI \-f\ \c +rancid.conf]\ \c [\c .BI \-m\ \c mail_rcpt]\ \c @@ -63,6 +69,12 @@ For example: .\" The command-line options are as follows: .TP +.B \-V +Prints package name and version strings. +.TP +.B \-f rancid.conf +Specify an alternate configuration file. +.TP .B \-m mail_rcpt Specify the recipient of diff mail, which is normally rancid-<group>. The argument may be a single address, multiple comma separated addresses, or @@ -71,10 +83,12 @@ may be specified multiple times. .\" .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. +Run rancid for a single device, +.IR device_name . +.IR device_name +should be name, as it appears in a group's router.db. 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. .sp The .B \-r @@ -88,7 +102,8 @@ utilizes the following environment variables from .\" .TP .B BASEDIR -Location of group directories, etc. +Location of group directories, etc. This is set to the "localstatedir" +by the configure script at installation time. .\" .TP .B LIST_OF_GROUPS @@ -104,11 +119,10 @@ 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 +by the revision control system (CVS or Subversion) or any of the rancid +scripts should be included there, 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 diff --git a/man/rancid.1 b/man/rancid.1 index 15fca7d..934798c 100644 --- a/man/rancid.1 +++ b/man/rancid.1 @@ -1,77 +1,108 @@ .\" .hys 50 -.TH "rancid" "1" "6 Jan 2004" +.TH "rancid" "1" "8 January 2007" .SH NAME rancid \- Cisco configuration filter .SH SYNOPSIS .B rancid -[\fB\-dl\fP] -([\c -.BI \-f\ \c -filename]\ \c -| hostname) +[\fB\-dlV\fP] +(\fB\-f\fP filename | 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. +script which uses the login scripts (see +.BR clogin (1)) +to login to a device, 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. +For example, +.IR hostname.new . .PP -There are complementary scripts for -Alteon WebOS switches, -Bay Networks (nortel), -Cisco catalyst switches, -Cisco content services switches, -ADC-kentrox EZ-T3 mux, -Force10, -Foundry, -HP Procurve Switches, -Hitachi Routers, -Juniper Networks E-series, -Juniper Networks, -MRTd, -Procket Networks, -Riverstone, -Redback, -Lucent TNT, -Netscreen firewalls, -Netscaler, -Extreme, -and Zebra routing software -named -.B arancid, -.B brancid, -.B cat5rancid, -.B cssrancid, -.B erancid, -.B f10rancid, -.B fnrancid, -.B francid, -.B hrancid, -.B htrancid, -.B jerancid, -.B jrancid, -.B mrancid, -.B nrancid, -.B nsrancid, -.B prancid, -.B rivrancid, -.B rrancid, -.B tntrancid, -.B nrancid, -.B xrancid, -and -.B zrancid, -respectively. +There are complementary scripts for other platforms and/or manufacturers +that are supported by +.BR rancid (1). +Briefly, these are: +.sp +.TP 15 +.B agmrancid +Cisco Anomaly Guard Module (AGM) +.TP 15 +.B arancid +Alteon WebOS switches +.TP +.B brancid +Bay Networks (nortel) +.TP +.B cat5rancid +Cisco catalyst switches +.TP +.B cssrancid +Cisco content services switches +.TP +.B drancid +Dell switches +.TP +.B erancid +ADC-kentrox EZ-T3 mux +.TP +.B f10rancid +Force10 +.TP +.B fnrancid +Fortinet Firewalls +.TP +.B francid +Foundry and HP procurve OEMs of Foundry +.TP +.B hrancid +HP Procurve Switches +.TP +.B htranicd +Hitachi Routers +.TP +.B jerancid +Juniper Networks E-series +.TP +.B jrancid +Juniper Networks +.TP +.B mrancid +MRTd +.TP +.B prancid +Procket Networks +.TP +.B rivrancid +Riverstone +.TP +.B rrancid +Redback +.TP +.B srancid +SMC switch (some Dell OEMs) +.TP +.B tntrancid +Lucent TNT +.TP +.B nrancid +Netscreen firewalls +.TP +.B nsrancid +Netscaler +.TP +.B xrancid +Extreme switches +.TP +.B zrancid +Zebra routing software .PP The command-line options are as follows: .TP +.B \-V +Prints package name and version strings. +.TP .B \-d Display debugging information. .\" @@ -107,3 +138,8 @@ Password: cat5k> (enable) .fi .in -1i +.PP +.B rancid +works on Cisco Catalyst 1900 series switches that are running Enterprise +Edition software. This software provides a menu at connection time that +allows a command line interface to be used by entering 'K' at the prompt. diff --git a/man/rancid.conf.5.in b/man/rancid.conf.5.in index 75adc87..a3735eb 100644 --- a/man/rancid.conf.5.in +++ b/man/rancid.conf.5.in @@ -1,8 +1,8 @@ .\" -.\" $Id: rancid.conf.5.in,v 1.9 2004/01/11 06:12:35 hank Exp $ +.\" $Id: rancid.conf.5.in,v 1.16 2005/09/27 16:39:27 heas Exp $ .\" .hys 50 -.TH "rancid.conf" "5" "7 Jan 2004" +.TH "rancid.conf" "5" "23 September 2005" .SH NAME rancid.conf \- rancid environment configuration file .SH DESCRIPTION @@ -10,10 +10,10 @@ rancid.conf \- rancid environment configuration file contains environment configuration information for .BR rancid-run (1) and -.BR rancid (1) -including shell PATH, list of rancid groups, etc. and is read by -.BR rancid-run (1) -at run-time. +.BR rancid-cvs (1), +including shell PATH, list of rancid groups, etc. +It is read by several scripts at run-time and others inherit the +configration from a parent process which has read it. .PP The syntax of .B rancid.conf @@ -32,10 +32,12 @@ The following variables are used (listed alphabetically): .B BASEDIR BASEDIR is the directory where .B rancid-run's -log directory and where the CVS repository and rancid collection group -directories will be placed. Its value is configure's localstatedir and -should be modified if rancid is moved to a new location in the file -system without re-installing from the distribution. +log directory, the revision control system's repository, and rancid group +directories will be placed. +.sp +Its value is configure's localstatedir and should be modified if rancid is +moved to a new location in the file system without re-installing from the +distribution. .sp Default: @localstatedir@ .\" @@ -44,8 +46,9 @@ Default: @localstatedir@ .IR cvs (1) and .IR rancid-cvs (1) -use this environment variable to locate the CVS repository. It should -not be necessary to alter it. +use this environment variable to locate the CVS repository. +In some cases, and for Subversion, it is used as an argument to commands. +It should not be necessary to alter it. .sp Default: $BASEDIR/CVS .\" @@ -115,6 +118,31 @@ places log files. Default: $BASEDIR/logs .\" .TP +.B MAILDOMAIN +Define the domain part of addresses for administrative and diff e-mail. +The value of this variable is simply appended to the normal mail addresses. +For example @MAILPLUS@usfs@example.com, if +.B MAILDOMAIN +had been set to "@example.com". +.\" +.TP +.B MAILHEADERS +Define additional mail headers to be added to rancid mail, such as Precedence +or X- style headers. +Individual headers must be separated by a \\n (new line). +.sp +Default: Precedence: bulk +.sp +Example: Precedence: bulk\\nX-clamation: beef cake +.\" +.TP +.B MAX_ROUNDS +Defines how many times rancid should retry collection of devices that fail. +The minimum is 1. +.sp +Default: 4. +.\" +.TP .B NOCOMMSTR If set, .IR rancid (1) @@ -127,10 +155,11 @@ this is not set. 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. +these to build the file which will be saved in CVS (or Subversion). +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 @@ -171,6 +200,18 @@ Its value is set by configure. Should it be necessary to modify PATH, note that it must include @bindir@. .\" .TP +.B RCSSYS +Sets which revision control system is in use. +Valid values are +.B cvs +for CVS +or +.B svn +for Subversion. +.sp +Default: cvs +.\" +.TP .B TERM Some Unix utilities require TERM, the terminal type, to be set to a sane value. Some clients, such as diff --git a/man/rancid_intro.1 b/man/rancid_intro.1 index cf4c571..1ccf463 100644 --- a/man/rancid_intro.1 +++ b/man/rancid_intro.1 @@ -1,18 +1,18 @@ .\" -.\" $Id: rancid_intro.1,v 1.27 2004/01/11 00:43:19 heas Exp $ +.\" $Id: rancid_intro.1,v 1.30 2006/11/23 20:26:49 heas Exp $ .\" .hys 50 -.TH "rancid_intro" "1" "7 Jan 2004" +.TH "rancid_intro" "1" "23 November 2006" .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, 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. +(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. .PP .B rancid uses an expect script to login to each of a list of devices and run a set of @@ -40,10 +40,12 @@ 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. +Lastly, all the updated files are checked into the revision control system +(CVS or Subversion). .PP -Additional utilities, including a looking glass, can be found under -the util sub-directory. +Additional utilities, including a looking glass, come with rancid. See +rancid's share directory ( +.IR share/rancid ). .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. @@ -88,7 +90,7 @@ below or follow the basic instructions included in the README file. See http://www.shrubbery.net/rancid for information on new versions, mail lists, etc. .SH "ADDING NEW GROUPS" -Follow this procdure for adding new groups: +Follow this procedure for adding new groups: .TP o Update the diff --git a/man/router.db.5 b/man/router.db.5 index 8261556..d688440 100644 --- a/man/router.db.5 +++ b/man/router.db.5 @@ -1,6 +1,6 @@ .\" .hys 50 -.TH "router.db" "5" "7 Jan 2004" +.TH "router.db" "5" "8 January 2007" .SH NAME router.db \- rancid group configuration file .SH DESCRIPTION @@ -48,6 +48,11 @@ 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 .B alteon An Alteon WebOS switches. .TP @@ -119,6 +124,10 @@ A Redback router, NAS, etc. A Riverstone NAS or Cabletron (starting with version ~9.0.3) router. .TP .ID 15n +.B smc +A SMC switch (some Dell OEMs) +.TP +.ID 15n .B tnt A lucent TNT. .TP @@ -160,12 +169,9 @@ file, then .B rancid will clean up by removing the device's config file from \fI$BASEDIR/<group>/configs\fR. -The -.IR cvs (1) -information for the device will be moved to -.IR cvs (1)'s -Attic directory (using -.IR "cvs delete"). +The device will be removed from the revision control system. +It is possible, in most cases, to resurrect or check-out copies of +deleted device configurations. .PP .SH FILES .ta \w'xBASEDIR/<group>/router.db 'u |