README

   1 RRDtool - Round Robin Database Tool
   2 ===================================
   3
   4 RRDtool is a little program for easily maintaining a database of time-series
   5 data. It comes with a charting program for drawing pretty graphs based on
   6 the data stored.
   7
   8 It is pretty easy to gather status information from all sorts of things,
   9 ranging from the temperature in your office to the number of octets which
  10 have passed through the FDDI interface of your router. But it is not so
  11 trivial to store this data in a efficient and systematic manner. This is
  12 where RRDtool kicks in. It lets you log and analyze the data you gather from
  13 all kinds of data-sources (DS). The data analysis part of RRDtool is based
  14 on the ability to quickly generate graphical representations of the data
  15 values collected over a definable time period.
  16
  17
  18 To compile:
  19 -----------
  20
  21 check out the instructions in [[doc/rrdbuild.pod]]
  22
  23 Getting Started:
  24 ----------------
  25
  26 Either after compiling or after installing you can try the example
  27 RRDtool applications in the examples directory.
  28
  29 To learn:
  30 ---------
  31
  32 Read the documentation in the doc directory.
  33
  34 If you are looking for a more slow paced introduction, make sure to read
  35 Alex van den Bogaerdt's rrdtutorial which is also available from the doc
  36 directory. Also read his cdeftutorial and Steve Rader's rpntutorial.
  37
  38 If you want to know about the format of the log files check
  39 [[src/rrd_format.h]] there are a lot of comments in there ...
  40
  41 How to make Tobi happy:
  42 -----------------------
  43
  44 If you want to show your appreciation for RRDtool you could make me happy
  45 by going to http://tobi.oetiker.ch/wish and ordering a CD from
  46 my CD wish list ...
  47
  48 How to keep in touch:
  49 ---------------------
  50
  51 There are 3 Mailing lists for RRDtool:
  52
  53 rrd-announce    LOW volume RRDtool Announcements List (Only Stable Releases)
  54 rrd-users       For discussion amongst people who use RRDtool in their applications
  55 rrd-developers  For people who actually HACK RRDtool code
  56
  57 To subscribe to <MAILGLIST> send a message with the subject 'subscribe'
  58 to <MAILGLIST>-request@lists.oetiker.ch
  59
  60 Note, that postings to rrd-announce will always be cross-posted
  61 to rrd-users and rrd-developers as well.
  62
  63 To Contribute:
  64 --------------
  65
  66 Contributed feature and bug patches are most welcome. Since rrdtool lives on
  67 github, it is now very easy to create pull requests. Work from the master
  68 branch unless you are creating bugfixes. No new features should go into the
  69 1.2, 1.3 and 1.4 branches.
  70
  71 If you contribute new features, make sure to also update the documentation
  72 pod files.
  73
  74 The latest released Version:
  75 -------------------
  76 Is always available from http://oss.oetiker.ch/rrdtool/
  77
  78
  79 Tobias Oetiker <tobi@oetiker.ch>