Edited Makefile.am and the rrdgraph_*.src files. By mistake the

previous update was made on the rrdgraph_*.pod files however they
are not to be edited. This is now corrected.

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

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1515f18..ba22f05 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -6,7 +6,7 @@ SUFFIXES = .pod .1 .man .html .txt .pm .pdf .src .inc
 
 #ACLOCAL_M4 = $(top_srcdir)/config/aclocal.m4
 
-CLEANFILES = *.1 *.html *.txt *-dircache *.pm *.pdf *~ core *itemcache *.rej *.orig
+CLEANFILES = *.1 *.html *.txt *-dircache *.pm *.pdf *~ core *itemcache *.rej *.orig rrdgraph_*.pod
 
 SRC = rrdgraph.src rrdgraph_examples.src  rrdgraph_rpn.src \
       rrdgraph_data.src rrdgraph_graph.src    
@@ -57,7 +57,10 @@ RRDs.pm:
 RRDp.pm:
        ln -s ../bindings/perl-piped/RRDp.pm .
 
-link: RRDp.pm RRDs.pm
+index.html:
+       rm index.html; ln -s rrdtool.html index.html
+
+link: RRDp.pm RRDs.pm index.html
 
 man: $(MAN)
 

diff --git a/doc/name.inc b/doc/name.inc
index 97754e0..056f27f 100644 (file)
--- a/doc/name.inc
+++ b/doc/name.inc
@@ -1,5 +1,11 @@
 =head1 NAME
 
+=cut
+
+WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
+
+=pod
+
 rrdtool graph - Round Robin Database tool grapher functions
 
 WARNING: This is for version 1.1.x which is B<I<BETA>> software.

diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod
index eeab6bb..8689feb 100644 (file)
--- a/doc/rrdgraph.pod
+++ b/doc/rrdgraph.pod
@@ -1,5 +1,11 @@
 =head1 NAME
 
+=cut
+
+WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
+
+=pod
+
 rrdtool graph - Round Robin Database tool grapher functions
 
 WARNING: This is for version 1.1.x which is B<I<BETA>> software.

diff --git a/doc/rrdgraph_graph.src b/doc/rrdgraph_graph.src
index 44beac7..2120d0f 100644 (file)
--- a/doc/rrdgraph_graph.src
+++ b/doc/rrdgraph_graph.src
@@ -2,14 +2,14 @@
 
 =head1 SYNOPSYS
 
-I<Depriciated commands>
+I<(to be) Depriciated commands>
 
 [B<PRINT:>I<vname>B<:>I<CF>B<:>I<format>]
 [B<GPRINT:>I<vname>B<:>I<CF>B<:>I<format>]
 [B<HRULE:>I<value>B<#>I<rrggbb>[B<:>I<legend>]]
 [B<STACK:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]]
 
-I<available commands>
+I<(soon) available commands>
 
 [B<PRINT:>I<vname>B<:>I<format>]
 [B<GPRINT:>I<vname>B<:>I<format>]
@@ -144,12 +144,11 @@ Text is printed literally in the legend section of the graph
 
 B<HRULE:>I<value>B<#>I<rrggbb>[B<:>I<legend>]
 
-I<Depriciated. Use a VDEF and a LINEx in new scripts.>
-
 Draw an horizontal line at I<value>. Its color is composed from three
 hexadecimal numbers specifying the color components (00 is off, FF is
 maximum) red, green and blue.  Optionally a legend box and string is
-printed in the legend section.
+printed in the legend section. I<value> can be a variable from a B<VDEF>.
+It is an error to use I<vname>s from B<DEF> or B<CDEF> here.
 
 B<VRULE:>I<time>B<#>I<rrggbb>[B<:>I<legend>]
 

diff --git a/doc/rrdgraph_rpn.src b/doc/rrdgraph_rpn.src
index 3278f84..7952a3f 100644 (file)
--- a/doc/rrdgraph_rpn.src
+++ b/doc/rrdgraph_rpn.src
@@ -190,17 +190,35 @@ Z<>
 
 =item MAXIMUM, MINIMUM, AVERAGE
 
-Return the corresponding value
+Return the corresponding value, MAXIMUM and MINIMUM also return
+the first occurance of that value in the time component.
+
+Example: C<VDEF:avg=mydata,AVERAGE>
 
 Z<>
 
 =item LAST, FIRST
 
-Return the last,first value including its time 
+Return the last,first value including its time.  The time for
+FIRST is actually the start of the corresponding interval, where
+LASTs time component returns the end of the corresponding interval.
+
+Example: C<VDEF:first=mydata,FIRST>
+
+Z<>
+
+=item TOTAL
+
+Returns the rate from each defined timeslot multiplied with the
+step size.  This can for instance return total bytes transfered
+when you have logged bytes per second. The time component returns
+the amount of seconds 
+
+Example: C<VDEF:total=mydata,TOTAL>
 
 Z<>
 
-=item PERCENTILE
+=item PERCENT
 
 Should follow a B<DEF> or B<CDEF> I<vname>. This I<vname> is popped,
 another number is popped which is a certain percentage (0..100). The
@@ -208,9 +226,10 @@ data set is then sorted and the value returned is chosen such that
 I<percentage> percent of the values is lower or equal than the result.
 I<Unknown> values are considered lower than any finite number for this
 purpose so if this operator returns an I<unknown> you have quite a lot
-of them in your data...
+of them in your data.  B<Inf>inite numbers are lesser, or more, than the
+finite numbers and are always more than the I<Unknown> numbers.
 
-Example: C<VDEF:perc95=95,mydata,PERCENTILE>
+Example: C<VDEF:perc95=mydata,95,PERCENT>
 
 =back