X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph_data.pod;h=02f9663ae345df4835199b703fdf518c5c2b66bb;hp=975c385d783733acf906d4d4b2e15f21165b390d;hb=acbc4860ec6b85e62f0710aab495113151524825;hpb=4b7345f9345915c8061e4b37b26ce8887828c973

diff --git a/doc/rrdgraph_data.pod b/doc/rrdgraph_data.pod
index 975c385..02f9663 100644
--- a/doc/rrdgraph_data.pod
+++ b/doc/rrdgraph_data.pod
@@ -19,6 +19,13 @@ useful information such as maximum, minimum etcetera. Two of the
 instructions use a language called B<RPN> which is described in its
 own manual page.
 
+Variable names (I<vname>) must be made up strings of the following characters
+C<A-Z, a-z, 0-9, -,_> and a maximum length of 255 characters.
+
+When picking variable names, make sure you do not choose a name that is
+already taken by an RPN operator. A safe bet it to use lowercase or
+mixedcase names for variables since operators will always be in uppercase.
+
 =head1 DEF
 
 B<DEF:>I<E<lt>vnameE<gt>>=I<E<lt>rrdfileE<gt>>:I<E<lt>ds-nameE<gt>>:I<E<lt>CFE<gt>>[:step=I<E<lt>stepE<gt>>][:start=I<E<lt>timeE<gt>>][:end=I<E<lt>timeE<gt>>][:reduce=I<E<lt>B<CF>E<gt>>]
@@ -27,7 +34,7 @@ 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 overridden with the L<--step|rrdgraph/item_Time> option. 
+be overridden with the L<--step|rrdgraph/item_Time> option.
 The resolution can again be overridden by specifying the B<step size>.
 The time span of this data is the same as for the graph by default,
 you can override this by specifying B<start and end>.  Remember to
@@ -41,8 +48,6 @@ from an B<RRA>.  For instance, if your B<RRD> has an B<RRA> with
 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>).
-=for comment
-XXX is the above start/end syntax correct? Fritz
 
 If consolidation needs to be done, the B<CF> of the B<RRA> specified in the
 B<DEF> itself will be used to reduce the data density. This behaviour can
@@ -70,6 +75,9 @@ elements.
 
 Example: C<VDEF:avg=mydata,AVERAGE>
 
+Note that currently only aggregation functions work in VDEF rpn expressions.
+Patches to change this are welcome.
+
 =head1 CDEF
 
 B<CDEF>:I<vname>=I<RPN expression>
@@ -82,6 +90,34 @@ the script, just as if it were generated by a B<DEF> instruction.
 
 Example: C<CDEF:mydatabits=mydata,8,*>
 
+=head1 About CDEF versus VDEF
+
+At some point in processing, B<RRDtool> has gathered an array of rates
+ready to display.
+
+B<CDEF> works on such an array.  For example, I<CDEF:new=ds0,8,*>
+would multiply each of the array members by eight (probably
+transforming bytes into bits). The result is an array containing the
+new values.
+
+B<VDEF> also works on such an array but in a different way.  For
+example, I<VDEF:max=ds0,MAXIMUM> would scan each of the array members
+and store the maximum value.
+
+=head2 When do you use B<VDEF> versus B<CDEF>?  
+
+Use B<CDEF> to transform your data prior to graphing.  In the above
+example, we'd use a B<CDEF> to transform bytes to bits before
+graphing the bits.
+
+You use a B<VDEF> if you want I<max(1,5,3,2,4)> to return five which
+would be displayed in the graph's legend (to answer, what was the
+maximum value during the graph period).
+
+If you want to apply 'complex' operations to the result of a VDEF you have
+to use a CDEF again since VDEFs only look like RPN expressions, they aren't
+realy.
+
 =head1 SEE ALSO
 
 L<rrdgraph> gives an overview of how B<rrdtool graph> works.
@@ -93,6 +129,7 @@ Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
 
 =head1 AUTHOR
 
-Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+Program by Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
 
-This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
+This manual page by Alex van den Bogaerdt E<lt>alex@vandenbogaerdt.nlE<gt>
+with corrections and/or additions by several people