README

   1 Round Robin Database Tools
   2 ==========================
   3
   4 It is pretty easy to gather status information from all sorts of things,
   5 ranging from the temperature in your office to the number of octets which
   6 have passed through the FDDI interface of your router. But it is not so
   7 trivial to store this data in a efficient and systematic manner. This is
   8 where RRDtool kicks in. It lets you log and analyze the data you gather from
   9 all kinds of data-sources (DS). The data analysis part of RRDtool is based
  10 on the ability to quickly generate graphical representations of the data
  11 values collected over a definable time period.
  12
  13
  14 To compile:
  15 -----------
  16
  17   sh configure
  18   make             <------ GNU make
  19   make install     <------ GNU make
  20
  21 This will configure, compile and install RRDtool in
  22 /usr/local/rrdtool-VERSION. If you prefer to install RRDtool in some other
  23 place, use
  24
  25   sh configure --prefix=/some/other/RRDtool-dir
  26
  27 If you prefer to live with shared libraries, make sure you add the
  28 --enable-shared option to your configure call.
  29
  30   sh configure --enable-shared
  31
  32 The configure script will try to find your perl installation (5.004
  33 preferred). If it does not find it, you can still build RRDtool but no perl
  34 modules will be generated.
  35
  36 By default the perl modules will be installed under the RRDtool install
  37 directory. This will require you to use a 'use lib' statement in your
  38 RRDtool perl programs. If you do not care what happens to your site-perl
  39 directory, you can also use
  40
  41   make site-perl-install
  42
  43 will install the perl modules whereever you keep your local perl modules.
  44 Doing this reliefs you from using 'use lib' in your scripts.
  45
  46 Configure will also look for an TCL installation on your system. If it finds
  47 one it will build a TCL interface for rrdtool. If you keep tcl in a non
  48 standard location you can use
  49
  50   sh configure --with-tcllib=/sw/tcl-8.3/lib
  51
  52 to indicte the right version (note, this must point to the directory where
  53 tclConfig.sh is located). Note that install will integrate the tcl bindings
  54 into your tcl installation. It will use a separate directory for each
  55 version though, so this is not much of a problem. Never the less the TCL
  56 module will not get intalled by default as TCL wants its module in the base
  57 tcl installation where you might not be able to write to. So if you want the
  58 tcl stuff installed, type
  59
  60   make site-tcl-install
  61
  62
  63 Getting Started:
  64 ----------------
  65
  66 Either after compiling or after installing you can try the example
  67 RRDtool applications in the examples directory.
  68
  69 To learn:
  70 ---------
  71
  72 Read the documentation in the doc directory. Start of with
  73 RRDtool. All documents are available as html and as ASCII text.
  74
  75 If you are looking for a more slow paced introduction, make sure to read
  76 Alex van den Bogaerdt's rrdtutorial which is also available from the doc
  77 directory. Also read his cdeftutorial and Steve Rader's rpntutorial.
  78
  79 If you want to know about the format of the log files check
  80 src/rrd_format.h there are a lot of comments in there ...
  81
  82 How to make Tobi happy:
  83 -----------------------
  84
  85 If you want to show your appreciation for RRDtool you could make me happy
  86 by going to ee-staff.ethz.ch/~oetiker/wish and ordering a CD from
  87 my CD wish list ...
  88
  89
  90 How to keep in touch:
  91 ---------------------
  92
  93 There are 3 Mailing lists for RRDtool:
  94
  95 rrd-announce    LOW volume RRDtool Announcements List (Only Stable Releases)
  96 rrd-users       For discussion amongst people who use RRDtool in their applications
  97 rrd-developers  For people who actually HACK RRDtool code
  98
  99 To subscribe to <MAILGLIST> send a message with the subject 'subscribe'
 100 to <MAILGLIST>-request@list.ee.ethz.ch.
 101
 102 Note, that postings to rrd-announce will always be cross-posted
 103 to rrd-users and rrd-developers as well.
 104
 105 To Contribute:
 106 --------------
 107
 108 Contributed feature and bug patches are most welcome. But please
 109 send complete patches. A complete patch patches the CODE as well
 110 as the CHANGES, CONTRIBUTORS and the POD files.
 111
 112 Use GNU   diff --unified --recursive olddir newdir   to build your patches.
 113
 114 The latest Version:
 115 -------------------
 116 Is available from http://ee-staff.ethz.ch/~oetiker/webtools/rrdtool/
 117
 118
 119 Tobias Oetiker <oetiker@ee.ethz.ch>