summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorTar Committer <tar@ocjtech.us>2004-03-14 17:00:09 +0000
committerTar Committer <tar@ocjtech.us>2004-03-14 17:00:09 +0000
commit381d322caf5928732f3d478d80e70acfccd67f99 (patch)
treed52aa26f9698cd869eca3f09661bfc05a7008a28 /man
parent989312339ea2e16579803a48700628c5469e327a (diff)
downloadrancid-381d322caf5928732f3d478d80e70acfccd67f99.zip
rancid-381d322caf5928732f3d478d80e70acfccd67f99.tar.gz
rancid-381d322caf5928732f3d478d80e70acfccd67f99.tar.xz
Imported from rancid-2.3.tar.gz.rancid-2.3
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.in4
-rw-r--r--man/clogin.114
-rw-r--r--man/cloginrc.529
-rw-r--r--man/control_rancid.17
-rw-r--r--man/lg.conf.5.in2
-rw-r--r--man/lg_intro.1.in4
-rw-r--r--man/rancid-run.123
-rw-r--r--man/rancid.1126
-rw-r--r--man/rancid.conf.5.in18
-rw-r--r--man/rancid_intro.17
10 files changed, 143 insertions, 91 deletions
diff --git a/man/Makefile.in b/man/Makefile.in
index 135c237..f195f38 100644
--- a/man/Makefile.in
+++ b/man/Makefile.in
@@ -66,6 +66,8 @@ CC = @CC@
CCDEPMODE = @CCDEPMODE@
CFLAGS = @CFLAGS@
COMM = @COMM@
+CONF_INSTALL_FALSE = @CONF_INSTALL_FALSE@
+CONF_INSTALL_TRUE = @CONF_INSTALL_TRUE@
CPP = @CPP@
CPPFLAGS = @CPPFLAGS@
CVS = @CVS@
@@ -98,6 +100,8 @@ MAILPLUS = @MAILPLUS@
MAKE = @MAKE@
MAKEINFO = @MAKEINFO@
MKDIR = @MKDIR@
+MK_LCLSTATEDIR_FALSE = @MK_LCLSTATEDIR_FALSE@
+MK_LCLSTATEDIR_TRUE = @MK_LCLSTATEDIR_TRUE@
OBJEXT = @OBJEXT@
PACKAGE = @PACKAGE@
PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
diff --git a/man/clogin.1 b/man/clogin.1
index 48e53ea..a2e60cd 100644
--- a/man/clogin.1
+++ b/man/clogin.1
@@ -83,8 +83,8 @@ 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
@@ -134,8 +134,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
@@ -249,8 +251,8 @@ 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,
+or impossible. Thus bin/hpuifilter, which must be found in the user's 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.
diff --git a/man/cloginrc.5 b/man/cloginrc.5
index 36709c2..7bfb7aa 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.34 2004/03/11 19:37:30 heas Exp $
.\"
.hys 50
-.TH "cloginrc" "5" "11 Jan 2004"
+.TH "cloginrc" "5" "11 Mar 2004"
.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
@@ -119,7 +120,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 +154,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
@@ -175,6 +176,16 @@ device. This is equivalent to
.BR jlogin (1).
.\"
.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>"}
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
@@ -183,7 +194,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):"
.\"
@@ -227,7 +238,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):"
.\"
diff --git a/man/control_rancid.1 b/man/control_rancid.1
index f502fb0..225af07 100644
--- a/man/control_rancid.1
+++ b/man/control_rancid.1
@@ -18,8 +18,8 @@ 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
.\"
@@ -45,7 +45,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/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-run.1 b/man/rancid-run.1
index 3e99b26..bbb56a2 100644
--- a/man/rancid-run.1
+++ b/man/rancid-run.1
@@ -71,10 +71,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 +90,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
@@ -106,11 +109,11 @@ 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.
+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
.SH FILES
.TP
diff --git a/man/rancid.1 b/man/rancid.1
index 15fca7d..0e7e7ba 100644
--- a/man/rancid.1
+++ b/man/rancid.1
@@ -14,61 +14,83 @@ filename]\ \c
.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 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 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 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
diff --git a/man/rancid.conf.5.in b/man/rancid.conf.5.in
index 75adc87..b8c01e3 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.11 2004/03/12 23:13:09 heas Exp $
.\"
.hys 50
-.TH "rancid.conf" "5" "7 Jan 2004"
+.TH "rancid.conf" "5" "12 Mar 2004"
.SH NAME
rancid.conf \- rancid environment configuration file
.SH DESCRIPTION
@@ -11,9 +11,9 @@ 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.
+including shell PATH, list of rancid groups, etc. and is read by several
+scripts at run-time, including
+.BR rancid-run (1).
.PP
The syntax of
.B rancid.conf
@@ -115,6 +115,14 @@ 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 NOCOMMSTR
If set,
.IR rancid (1)
diff --git a/man/rancid_intro.1 b/man/rancid_intro.1
index cf4c571..52d54e6 100644
--- a/man/rancid_intro.1
+++ b/man/rancid_intro.1
@@ -1,5 +1,5 @@
.\"
-.\" $Id: rancid_intro.1,v 1.27 2004/01/11 00:43:19 heas Exp $
+.\" $Id: rancid_intro.1,v 1.28 2004/01/13 21:52:44 heas Exp $
.\"
.hys 50
.TH "rancid_intro" "1" "7 Jan 2004"
@@ -42,8 +42,9 @@ configuration file,
.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.
+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.