fixed format

[rrdtool.git] / doc / rrdgraph_examples.src

diff --git a/doc/rrdgraph_examples.src b/doc/rrdgraph_examples.src
index 2c61c40..8ccf8eb 100644 (file)
--- a/doc/rrdgraph_examples.src
+++ b/doc/rrdgraph_examples.src
@@ -1,6 +1,14 @@
-=include name
+=head1 NAME
 
-=head1 SYNOPSYS
+=cut
+
+WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
+
+=pod
+
+rrdgraph_examples - Examples for rrdtool graph
+
+=head1 SYNOPSIS
 
 B<rrdtool graph /home/httpd/html/test.png --img-format PNG \>
 
@@ -14,6 +22,16 @@ ready because comments are intermixed with the examples.
 
 =head1 EXAMPLES
 
+=head2 Data with multiple resolutions
+
+    --end now --start end-120000s --width 400
+    DEF:ds0a=/home/rrdtool/data/router1.rrd:ds0:AVERAGE
+    DEF:ds0b=/home/rrdtool/data/router1.rrd:ds0:AVERAGE:step=1800
+    DEF:ds0c=/home/rrdtool/data/router1.rrd:ds0:AVERAGE:step=7200
+    LINE1:ds0a#0000FF:"default resolution\n"
+    LINE1:ds0b#00CCFF:"resolution 1800 seconds per interval\n"
+    LINE1:ds0c#FF00FF:"resolution 7200 seconds per interval\n"
+
 =head2 Nicely formatted legend section
 
     DEF:ds0=/home/rrdtool/data/router1.rrd:ds0:AVERAGE
@@ -26,16 +44,24 @@ ready because comments are intermixed with the examples.
     VDEF:ds1avg=ds1,AVERAGE,8,*
     VDEF:ds1min=ds1,MINIMUM,8,*
     VDEF:ds1pct=95,ds1,PERCENTILE,8,*
+
 Note: consolidation occurs here.
+
     CDEF:ds0bits=ds0,8,*
     CDEF:ds1bits=ds1,8,*
+
 Note: 10 spaces to move text to the right
+
     COMMENT:"          "
+
 Note: three times size == 11 chars, "###.## xBps"
+
     COMMENT:"Maximum    "
     COMMENT:"Average    "
     COMMENT:"Minimum    "
+
 Note: last line contains new-line character
+
     COMMENT:"95th percentile\n"
     AREA:ds0bits#00C000:"Inbound "
     GPRINT:ds0max:"%6.2lf %Sbps"
@@ -59,7 +85,9 @@ Depending on your needs you can do this in two ways:
 Offset the data, then graph this
 
     DEF:mydata=my.rrd:ds:AVERAGE
+
 Note: this will also influence anything that uses "data"
+
     CDEF:data=mydata,100,+
     LINE1:data#FF0000:"Data with offset"
 
@@ -68,9 +96,13 @@ Note: this will also influence anything that uses "data"
 Graph the original data, with an offset
 
     DEF:mydata=my.rrd:ds:AVERAGE
+
 Note: no color in the first line so it is not visible
+
     LINE1:100
+
 Note: the second line gets stacked on top of the first one
+
     LINE1:data#FF0000:"Data with offset":STACK
 
 =back
@@ -84,28 +116,18 @@ Note: the second line gets stacked on top of the first one
     Last 24 hours:   <nothing at all>
     Yesterday:       --end 00:00
 
-=head2 Viewing Januari+Februari 2000 and 2001 together
-
-Define a graph area of 31+29 days (!) spanning Jan. and Feb.
-    --start 20000101 --end 20000301
-    DEF:jan2000=router.rrd:ds0:AVERAGE:start 20000101 end start+31d
-    DEF:jan2001=router.rrd:ds0:AVERAGE:start 20010101 end start+31d
-Note: mind the extra day in 2000 ...
-    DEF:feb2000=router.rrd:ds0:AVERAGE:start 20000201 end start+29d
-Note: 29 feb 2001 is *unknown*
-    DEF:feb2001=router.rrd:ds0:AVERAGE:start 20010201 end start+28d
-    VDEF:offset=jan2001,FIRST,jan2000,FIRST,-,-1,*
+=head2 Viewing This week and last week together
+
+    --end now --start end-1w
+    DEF:thisweek=router.rrd:ds0:AVERAGE
+    DEF:lastweek=router.rrd:ds0:AVERAGE:end=now-1w:start=end-1w
+
+shift the data forward by one week (604800 seconds)
+
+    SHIFT:lastweek:604800
     [ more of the usual VDEF and CDEF stuff if you like ]
-    LINE1:jan2000#00003F:"Januari 2000"
-    [ gprint stuff ]
-    LINE1:feb2001#003F00:"Februari 2000"
-    [ gprint stuff ]
-Note: offset is made negative by the VDEF statement
-    SHIFT:offset
-    LINE1:jan2001#0000FF:"Januari 2001"
-    [ gprint stuff ]
-    LINE1:feb2001#00FF00:"Februari 2001"
-    [ gprint stuff ]
+    AREA:lastweek#0000FF:Last\ week
+    LINE1:thisweek#FF0000:This\ week
 
 =include see_also