summaryrefslogtreecommitdiffstats
path: root/man/do-diffs.1
diff options
context:
space:
mode:
authorTar Committer <tar@ocjtech.us>2004-01-12 03:17:26 +0000
committerTar Committer <tar@ocjtech.us>2004-01-12 03:17:26 +0000
commit989312339ea2e16579803a48700628c5469e327a (patch)
tree967ee77195819d70f2dc675444e92340bb98e0d6 /man/do-diffs.1
parentff168ecfe045c690c24d5bbc5a3062bf9d64120c (diff)
downloadrancid-989312339ea2e16579803a48700628c5469e327a.tar.gz
rancid-989312339ea2e16579803a48700628c5469e327a.tar.xz
rancid-989312339ea2e16579803a48700628c5469e327a.zip
Imported from rancid-2.3.rc1.tar.gz.rancid-2.3.rc1
Diffstat (limited to 'man/do-diffs.1')
-rw-r--r--man/do-diffs.1124
1 files changed, 0 insertions, 124 deletions
diff --git a/man/do-diffs.1 b/man/do-diffs.1
deleted file mode 100644
index 97b9664..0000000
--- a/man/do-diffs.1
+++ /dev/null
@@ -1,124 +0,0 @@
-.\"
-.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
-[\c
-.BI \-m\ \c
-mail_rcpt]\ \c
-[\c
-.BI \-r\ \c
-device_name]\ \c
-[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 .<group>.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 <group>.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
-.\"
-.PP
-.\"
-The command-line options are as follows:
-.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
-.B \-m
-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.
-.sp
-The
-.B \-r
-option alters the subject line of the diff mail. It will begin
-with <group name>/<device name> rather than just the group name alone.
-.\"
-.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 router.db (5),
-.BR env (5)