man/control_rancid.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

.\"
.hys 50
.TH "control_rancid" "1" "22 Jan 2001"
.SH NAME
control_rancid \- run rancid for devices of a group
.SH SYNOPSIS
.B create_cvs
[\c
.BI \-m\ \c
mail_rcpt]\ \c
[\c
.BI \-r\ \c
device_name]\ \c
group
.SH DESCRIPTION
.B control_rancid
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.
.\"
.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 the router.db, of a particular device 
to collect and generate diffs for.  The device must be marked "up".
.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.
.\"
.PP
.B control_rancid
is normally (and best) run via
.BR do-diffs (1)
which provides a locking mechanism on a group basis.
.\"
.SH SEE ALSO
.BR do-diffs (1),
.BR env (5),
.BR router.db (5)