README.md

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