summaryrefslogtreecommitdiffstats
path: root/man/rancid-run.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/rancid-run.1')
-rw-r--r--man/rancid-run.136
1 files changed, 25 insertions, 11 deletions
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