This patch introduces a feature whereby rrdcached will disallow updates
[rrdtool.git] / doc / rrdtutorial.pod
index e43830c..30a4868 100644 (file)
@@ -4,9 +4,9 @@ rrdtutorial - Alex van den Bogaerdt's RRDtool tutorial
 
 =head1 DESCRIPTION
 
-RRDtool is written by Tobias Oetiker <oetiker@ee.ethz.ch> with
+RRDtool is written by Tobias Oetiker E<lt>tobi@oetiker.chE<gt> with
 contributions from many people all around the world. This document is
-written by Alex van den Bogaerdt <alex@ergens.op.het.net> to help you
+written by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt> to help you
 understand what RRDtool is and what it can do for you.
 
 The documentation provided with RRDtool can be too technical for some
@@ -61,7 +61,7 @@ RRDtool originated from MRTG (Multi Router Traffic Grapher). MRTG
 started as a tiny little script for graphing the use of a university's
 connection to the Internet. MRTG was later (ab-)used as a tool for
 graphing other data sources including temperature, speed, voltage,
-number of printouts and the like. 
+number of printouts and the like.
 
 Most likely you will start to use RRDtool to store and process data
 collected via SNMP. The data will most likely be bytes (or bits)
@@ -98,7 +98,7 @@ and not only for this particular one. Look in the documentation that
 came with RRDtool for the location and usage of the list.
 
 I suggest you take a moment to subscribe to the mailing list right now
-by sending an email to E<lt>rrd-users-request@list.ee.ethz.chE<gt> with a
+by sending an email to E<lt>rrd-users-request@lists.oetiker.chE<gt> with a
 subject of "subscribe". If you ever want to leave this list, just write
 an email to the same address but now with a subject of "unsubscribe".
 
@@ -219,16 +219,15 @@ and skip all of the '\' characters.
 
 =head2 What has been created?
 
-We created the round robin database called test (test.rrd) which
-starts at noon the day I started writing this document, 7th of March,
-1999 (this date translates to 920'804'400 seconds as explained
-below). Our database holds one data source (DS) named "speed" that
-represents a counter. This counter is read every five minutes
-(default).  In the same database two round robin archives (RRAs) are
-kept, one averages the data every time it is read (e.g., there's
-nothing to average) and keeps 24 samples (24 times 5 minutes is 2
-hours). The other averages 6 values (half hour) and contains 10
-such averages (e.g., 5 hours).
+We created the round robin database called test (test.rrd) which starts at
+noon the day I started writing this document, 7th of March, 1999 (this date
+translates to 920'804'400 seconds as explained below). Our database holds
+one data source (DS) named "speed" that represents a counter. This counter
+is read every five minutes (this is the default therefore you don't have to
+put C<--step=300>).  In the same database two round robin archives (RRAs)
+are kept, one averages the data every time it is read (e.g., there's nothing
+to average) and keeps 24 samples (24 times 5 minutes is 2 hours). The other
+averages 6 values (half hour) and contains 10 such averages (e.g. 5 hours).
 
 RRDtool works with special time stamps coming from the UNIX world.
 This time stamp is the number of seconds that passed since January
@@ -375,7 +374,7 @@ kilometers or millimeters! RRDtool doesn't know about the physical
 units of our data, it just works with dimensionless numbers.
 
 If we had measured our distances in meters, this would have been
-(12'357'000-12'345'000)/300 = 12'000/300 = 40. 
+(12'357'000-12'345'000)/300 = 12'000/300 = 40.
 
 As most people have a better feel for numbers in this range, we'll
 correct that. We could recreate our database and store the correct
@@ -491,7 +490,7 @@ or ctrl-F5).
 
 =head2 Updates in Reality
 
-We've already used the "update" command: it took one or more
+We've already used the C<update> command: it took one or more
 parameters in the form of "<time>:<value>". You'll be glad to know
 that you can specify the current time by filling in a "N" as the time.
 Or you could use the "time" function in Perl (the shortest example in
@@ -1027,9 +1026,9 @@ Correction numbers:
  Should become: 18'446'744'073'709'551'800
  But really is:                        184
  Delta:        -18'446'744'073'709'550'816
- Correction1:  -18'446'744'073'709'550'816 
+ Correction1:  -18'446'744'073'709'550'816
                                + 4'294'967'296 = -18'446'744'069'414'583'520
- Correction2:  -18'446'744'069'414'583'520 
+ Correction2:  -18'446'744'069'414'583'520
                   + 18'446'744'069'414'584'320 = 800
 
  Before:        18'446'744'073'709'551'615 ( maximum value )
@@ -1138,7 +1137,7 @@ Create output
 
 View both images together (add them to your index.html file)
 and compare. Both graphs should show the same, despite the
-input being different.  
+input being different.
 
 =head1 WRAPUP