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   you need the following libraries installed on your system.
  18
  19    cgilib-0.5.tar.gz
  20    freetype-2.1.5.tar.gz
  21    libart_lgpl-2.3.16.tar.gz
  22    libpng-1.2.5.tar.gz
  23    zlib-1.2.1.tar.gz
  24
  25   you can either get these libraries directly from their original sites
  26   or you can get copies from
  27
  28    http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/pub/libs
  29
  30   if the libraries are not installed in standard places you may need
  31   to set CPPFLAGS and LDFLAGS accordingly. This will be improved in further
  32   editions of this developers series. Here is an example call.
  33
  34   env CPPFLAGS="-I/scratch/oetiker/cgilib-0.5 \
  35                 -I/scratch/oetiker/lib/include/libart-2.0 \
  36                 -I/scratch/oetiker/lib/include \
  37                 -I/scratch/oetiker/lib/include/freetype2" \
  38        LDFLAGS="-L/scratch/oetiker/lib/lib -R/scratch/oetiker/lib/lib \
  39                 -L/scratch/oetiker/cgilib-0.5" \
  40       ./configure --prefix=/scratch/oetiker/lib
  41
  42   make             <------ GNU make
  43
  44   make install     <------ GNU make
  45
  46 This will configure, compile and install RRDtool in
  47 /usr/local/rrdtool-VERSION. If you prefer to install RRDtool in some other
  48 place, use
  49
  50   sh configure --prefix=/some/other/RRDtool-dir
  51
  52 The configure script will try to find your perl installation (5.004
  53 preferred). If it does not find it, you can still build RRDtool but no perl
  54 modules will be generated.
  55
  56 By default the perl modules will be installed under the RRDtool install
  57 directory. This will require you to use a 'use lib' statement in your
  58 RRDtool perl programs. If you do not care what happens to your site-perl
  59 directory, you can also use
  60
  61   make site-perl-install
  62
  63 this will install the perl modules whereever you keep your local perl
  64 modules. Doing this reliefs you from using 'use lib' in your scripts.
  65
  66 Configure will also look for an TCL installation on your system. If it finds
  67 one it will build a TCL interface for rrdtool. If you keep tcl in a non
  68 standard location you can use
  69
  70   sh configure --with-tcllib=/sw/tcl-8.3/lib
  71
  72 to indicte the right version (note, this must point to the directory where
  73 tclConfig.sh is located). Note that install will integrate the tcl bindings
  74 into your tcl installation. It will use a separate directory for each
  75 version though, so this is not much of a problem. Never the less the TCL
  76 module will not get intalled by default as TCL wants its module in the base
  77 tcl installation where you might not be able to write to. So if you want the
  78 tcl stuff installed, type
  79
  80   make site-tcl-install
  81
  82
  83 Getting Started:
  84 ----------------
  85
  86 Either after compiling or after installing you can try the example
  87 RRDtool applications in the examples directory.
  88
  89 To learn:
  90 ---------
  91
  92 Read the documentation in the doc directory. Start of with
  93 RRDtool. All documents are available as html and as ASCII text.
  94
  95 If you are looking for a more slow paced introduction, make sure to read
  96 Alex van den Bogaerdt's rrdtutorial which is also available from the doc
  97 directory. Also read his cdeftutorial and Steve Rader's rpntutorial.
  98
  99 If you want to know about the format of the log files check
 100 src/rrd_format.h there are a lot of comments in there ...
 101
 102 How to make Tobi happy:
 103 -----------------------
 104
 105 If you want to show your appreciation for RRDtool you could make me happy
 106 by going to ee-staff.ethz.ch/~oetiker/wish and ordering a CD from
 107 my CD wish list ...
 108
 109
 110 How to keep in touch:
 111 ---------------------
 112
 113 There are 3 Mailing lists for RRDtool:
 114
 115 rrd-announce    LOW volume RRDtool Announcements List (Only Stable Releases)
 116 rrd-users       For discussion amongst people who use RRDtool in their applications
 117 rrd-developers  For people who actually HACK RRDtool code
 118
 119 To subscribe to <MAILGLIST> send a message with the subject 'subscribe'
 120 to <MAILGLIST>-request@list.ee.ethz.ch.
 121
 122 Note, that postings to rrd-announce will always be cross-posted
 123 to rrd-users and rrd-developers as well.
 124
 125 To Contribute:
 126 --------------
 127
 128 Contributed feature and bug patches are most welcome. But please
 129 send complete patches. A complete patch patches the CODE as well
 130 as the CHANGES, CONTRIBUTORS and the POD files.
 131
 132 Use GNU   diff --unified --recursive olddir newdir   to build your patches.
 133
 134 The latest Version:
 135 -------------------
 136 Is available from http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/
 137
 138
 139 Tobias Oetiker <oetiker@ee.ethz.ch>