summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorTar Committer <tar@ocjtech.us>2005-08-15 00:51:41 +0000
committerTar Committer <tar@ocjtech.us>2005-08-15 00:51:41 +0000
commitc0482931956d127b5f09d4a8d72758cd4cb1f097 (patch)
treefb13010367c3c9e3e12dc698233b729d6dd669da /man
parent96dc4026054df77affedfe50380a661dcdba732a (diff)
downloadrancid-c0482931956d127b5f09d4a8d72758cd4cb1f097.zip
rancid-c0482931956d127b5f09d4a8d72758cd4cb1f097.tar.gz
rancid-c0482931956d127b5f09d4a8d72758cd4cb1f097.tar.xz
Imported from rancid-2.3.2a3.tar.gz.rancid-2.3.2a3
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.in2
-rw-r--r--man/rancid-cvs.133
-rw-r--r--man/rancid-run.115
-rw-r--r--man/rancid.conf.5.in40
-rw-r--r--man/rancid_intro.19
-rw-r--r--man/router.db.511
6 files changed, 61 insertions, 49 deletions
diff --git a/man/Makefile.in b/man/Makefile.in
index c7415a2..2bcf956 100644
--- a/man/Makefile.in
+++ b/man/Makefile.in
@@ -113,6 +113,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@
@@ -120,6 +121,7 @@ SHELL = @SHELL@
SORT = @SORT@
SSH = @SSH@
STRIP = @STRIP@
+SVN = @SVN@
TAR = @TAR@
TELNET = @TELNET@
TOUCH = @TOUCH@
diff --git a/man/rancid-cvs.1 b/man/rancid-cvs.1
index 2cb34bd..3149ad1 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" "13 August 2005"
.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 ...]]
.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,10 @@ 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 best method for adding groups is add the group name to
@@ -51,4 +47,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 bbb56a2..f6ebe23 100644
--- a/man/rancid-run.1
+++ b/man/rancid-run.1
@@ -1,6 +1,6 @@
.\"
.hys 50
-.TH "rancid-run" "1" "7 Jan 2004"
+.TH "rancid-run" "1" "13 August 2005"
.SH NAME
rancid-run \- run rancid for each of the groups
.SH SYNOPSIS
@@ -107,13 +107,12 @@ 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 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.
+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
.SH FILES
.TP
diff --git a/man/rancid.conf.5.in b/man/rancid.conf.5.in
index 4a86364..e89568a 100644
--- a/man/rancid.conf.5.in
+++ b/man/rancid.conf.5.in
@@ -1,8 +1,8 @@
.\"
-.\" $Id: rancid.conf.5.in,v 1.14 2005/07/07 01:09:13 heas Exp $
+.\" $Id: rancid.conf.5.in,v 1.15 2005/08/15 00:41:51 heas Exp $
.\"
.hys 50
-.TH "rancid.conf" "5" "5 July 2005"
+.TH "rancid.conf" "5" "13 August 2005"
.SH NAME
rancid.conf \- rancid environment configuration file
.SH DESCRIPTION
@@ -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
.\"
@@ -152,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
@@ -196,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 52d54e6..c00e428 100644
--- a/man/rancid_intro.1
+++ b/man/rancid_intro.1
@@ -1,8 +1,8 @@
.\"
-.\" $Id: rancid_intro.1,v 1.28 2004/01/13 21:52:44 heas Exp $
+.\" $Id: rancid_intro.1,v 1.29 2005/08/15 00:41:51 heas Exp $
.\"
.hys 50
-.TH "rancid_intro" "1" "7 Jan 2004"
+.TH "rancid_intro" "1" "13 August 2005"
.SH NAME
rancid_intro \- introduction to the Really Awesome New Cisco confIg Differ
.SH INTRODUCTION
@@ -40,7 +40,8 @@ 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, come with rancid. See
rancid's share directory (
@@ -89,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..2b9d654 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" "13 August 2005"
.SH NAME
router.db \- rancid group configuration file
.SH DESCRIPTION
@@ -160,12 +160,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