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 check out the instructions in doc/rrdbuild.txt
  18
  19 Getting Started:
  20 ----------------
  21
  22 Either after compiling or after installing you can try the example
  23 RRDtool applications in the examples directory.
  24
  25 To learn:
  26 ---------
  27
  28 Read the documentation in the doc directory. Start of with
  29 RRDtool. All documents are available as html and as ASCII text.
  30
  31 If you are looking for a more slow paced introduction, make sure to read
  32 Alex van den Bogaerdt's rrdtutorial which is also available from the doc
  33 directory. Also read his cdeftutorial and Steve Rader's rpntutorial.
  34
  35 If you want to know about the format of the log files check
  36 src/rrd_format.h there are a lot of comments in there ...
  37
  38 How to make Tobi happy:
  39 -----------------------
  40
  41 If you want to show your appreciation for RRDtool you could make me happy
  42 by going to http://people.ee.ethz.ch/oetiker/wish and ordering a CD from
  43 my CD wish list ...
  44
  45
  46 How to keep in touch:
  47 ---------------------
  48
  49 There are 3 Mailing lists for RRDtool:
  50
  51 rrd-announce    LOW volume RRDtool Announcements List (Only Stable Releases)
  52 rrd-users       For discussion amongst people who use RRDtool in their applications
  53 rrd-developers  For people who actually HACK RRDtool code
  54
  55 To subscribe to <MAILGLIST> send a message with the subject 'subscribe'
  56 to <MAILGLIST>-request@list.ee.ethz.ch.
  57
  58 Note, that postings to rrd-announce will always be cross-posted
  59 to rrd-users and rrd-developers as well.
  60
  61 To Contribute:
  62 --------------
  63
  64 Contributed feature and bug patches are most welcome. But please
  65 send complete patches. A complete patch patches the CODE as well
  66 as the CHANGES, CONTRIBUTORS and the POD files.
  67
  68 Use GNU   diff --unified --recursive olddir newdir   to build your patches.
  69
  70 The latest Version:
  71 -------------------
  72 Is available from http://people.ee.ethz.ch/oetiker/webtools/rrdtool/
  73
  74
  75 Tobias Oetiker <oetiker@ee.ethz.ch>