From: Alex van den Bogaerdt <alex@vandenbogaerdt.nl>
Date: Sun, 23 Jun 2002 23:13:53 +0000 (+0000)
Subject: Updated docs for the "DEF ...  :step=nnnn" case
X-Git-Tag: 1.2rc1~185
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0b72dad029933e4f2fc4b5c126ef59aef8145577;p=thirdparty%2Frrdtool-1.x.git

Updated docs for the "DEF ...  :step=nnnn" case


git-svn-id: svn://svn.oetiker.ch/rrdtool/trunk/program@149 a5681a0c-68f1-0310-ab6d-d61299d08faa
---

diff --git a/doc/rrdgraph_data.src b/doc/rrdgraph_data.src
index 938fb105..9b9ec8ad 100644
--- a/doc/rrdgraph_data.src
+++ b/doc/rrdgraph_data.src
@@ -2,7 +2,7 @@
 
 =head1 SYNOPSYS
 
-B<DEF>:I<vname>=I<RRD file>:I<ds name>:I<CF>[:[I<time range>][:I<step size>]]
+B<DEF>:I<vname>=I<RRD file>:I<ds name>:I<CF>[:step=I<step size>][:<time range>>]
 
 B<VDEF>:I<vname>=I<RPN expression>
 
@@ -18,15 +18,15 @@ a language called B<RPN> which is described in its own manual page.
 
 =head1 DEF
 
-B<DEF>:I<vname>=I<RRD file>:I<ds name>:I<CF>[:[I<time range>][:I<step size>]]
+B<DEF>:I<vname>=I<RRD file>:I<ds name>:I<CF>[:step=I<step size>][:<time range>>]
 
 This command fetches data from an B<RRD> file.  The virtual name
 I<vname> can then be used throughout the rest of the script. By
 default, an B<RRA> which contains the correct consolidated data
 at an appropriate resolution will be chosen.  The resolution can
 be overriden with the L<--step|rrdgraph/item_Time> option. 
-I<Not yet implemented:>[ The resolution can be overriden by specifying
-the B<step size>.]  I<Not yet implemented:> [ The time span of this data
+The resolution can again be overriden by specifying the B<step size>.
+I<Not yet implemented:> [ The time span of this data
 is the same as for the graph by default, you can override this by
 specifying the B<time range>. ]
 
@@ -39,9 +39,10 @@ a resolution of 1800 seconds per B<CDP>, you should create an
 image with width 400 and time span 400*1800 seconds (use appropriate
 start and end times, such as C<--start end-8days8hours>).
 
-Example: C<DEF:mydata=router.rrd:ds0:AVERAGE>
+Example:
 
-Example: C<DEF:januari=router.rrd:ds0:AVERAGE:start=20010101 end=20010201>
+        DEF:ds0=router.rrd:ds0:AVERAGE
+        DEF:ds0weekly=router.rrd:ds0:AVERAGE:step=7200
 
 =head1 VDEF
 
diff --git a/doc/rrdgraph_examples.src b/doc/rrdgraph_examples.src
index 2c61c40f..958c8e8d 100644
--- a/doc/rrdgraph_examples.src
+++ b/doc/rrdgraph_examples.src
@@ -14,6 +14,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