Initial revision
[rrdtool.git] / bindings / tcl / README
1 TCLRRD -- A TCL interpreter extension to access the RRD library,
2           contributed to Tobias Oetiker's RRD tools.
3
4 Copyright (c) 1999,2000 Frank Strauss, Technical University of Braunschweig.
5
6 See the file "COPYING" for information on usage and redistribution
7 of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8
9 TCLRRD adds a dynamically loadable package to the Tcl 8.x interpreter
10 to access all RRD functions as of RRDtool 1.0.13. All command names
11 and arguments are equal to those of RRDtool. They are assigned to the
12 namespace `Rrd', e.g.  `Rrd::create'. Return values are a bit
13 different from plain rrdtool behavior to enable more native Tcl
14 usage. Errors are mapped to the TCL_ERROR return code together with
15 the RRD error strings.
16
17 TCLRRD makes it easy to combine RRD use with advanced SNMP functionality
18 of scotty (http://wwwsnmp.cs.utwente.nl/~schoenw/scotty/). E.g., it's easy
19 to use some scotty code to get the counters of some interfaces by their
20 interface name and then use Rrd::update to store the values. Furthermore,
21 data source types (see RRD::create documentation) and integer value ranges
22 could be easily retrieved from MIB information.
23
24 TCLRRD has been written on a Linux system for use with Tcl 8.x. It should
25 work on many other platforms, although it has not been tested. There are
26 no fool proof installation procedures. Take a look at Makefile.am and
27 adapt it, if required.
28
29 TCLRRD has been written for RRD 1.0.13.
30
31         Frank Strauss <strauss@ibr.cs.tu-bs.de>, 09-Mar-2000