README.md

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