X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_rpn.src;h=9e6f70ed0579c4c7b98555a9e592286bbbb7543d;hb=d50afc217aaec57e418a55bbe2d20fe996c6e026;hp=ae1a91b80b62eaaaf374c8def1e336681c634619;hpb=0209ff81818995fcd2e2b7080c0ca504fa14d949;p=rrdtool.git

diff --git a/doc/rrdgraph_rpn.src b/doc/rrdgraph_rpn.src
index ae1a91b..9e6f70e 100644
--- a/doc/rrdgraph_rpn.src
+++ b/doc/rrdgraph_rpn.src
@@ -1,10 +1,16 @@
-=include name
+=head1 NAME  
+
+=cut
+
+WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
+
+=pod
+
+rrdgraph_rpn - About RPN Math in rrdtool graph
 
 =head1 SYNOPSIS
 
-I<E<lt>RPN expressionE<gt>> := 
-I<E<lt>vnameE<gt>>|I<E<lt>operatorE<gt>>|I<E<lt>valueE<gt>>
-[ , I<E<lt>RPN expressionE<gt>>]
+I<RPN expression>:=I<vname>|I<operator>|I<value>[,I<RPN expression>]
 
 =head1 DESCRIPTION
 
@@ -21,6 +27,11 @@ this is what is put into the I<vname>.  For B<CDEF> instructions,
 the stack is processed for each data point on the graph. B<VDEF>
 instructions work on an entire data set in one run.
 
+Example: C<VDEF:maximum=mydata,MAXIMUM>
+
+This will set variable "maximum" which you now can use in the rest
+of your RRD script.
+
 Example: C<CDEF:mydatabits=mydata,8,*>
 
 This means:  push variable I<mydata>, push the number 8, execute
@@ -56,9 +67,7 @@ B<IF>
 Pops three elements from the stack.  If the last element is 0 (false),
 the first value is pushed back onto the stack, otherwise the second
 popped value is pushed back. This does, indeed, mean that any value
-other than 0 is considered true.
-I<Note: Should this change? It should IMHO as all the other functions
-would return unknown if A,B or C were unknown>
+other than 0 is considered to be true.
 
 Example: C<A,B,C,IF> should be read as C<if (A) then (B) else (C)>
 
@@ -108,7 +117,7 @@ Round down,up to the nearest integer
 
 Z<>
 
-=item Ordering Operations
+=item Set Operations
 
 B<SORT, REV>
 
@@ -120,6 +129,30 @@ Example: C<CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/> will
 compute the average of the values v1..v6 after removing the smallest and
 largest.
 
+B<TREND>
+
+Create a "sliding window" average of another data series.
+
+Usage:
+CDEF:smoothed=x,1800,TREND
+
+This will create a half-hour (1800 second) sliding window average of x.  The
+average is essentially computed as shown here:
+
+                 +---!---!---!---!---!---!---!---!--->
+                                                     now
+                       delay     t0
+                 <--------------->
+                         delay       t1
+                     <--------------->  
+                              delay      t2
+                         <--------------->
+
+
+     Value at sample (t0) will be the average between (t0-delay) and  (t0)
+     Value at sample (t1) will be the average between (t1-delay) and  (t1)
+     Value at sample (t2) will be the average between (t2-delay) and  (t2)
+
 =item Special values
 
 B<UNKN>
@@ -160,41 +193,21 @@ Z<>
 Time inside RRDtool is measured in seconds since the epoch. This
 epoch is defined to be S<C<Thu Jan  1 00:00:00 UTC 1970>>.
 
-Z<>
-
-=over 4
-
-=item NOW
+B<NOW>
 
 Pushes the current time on the stack.
 
-Z<>
-
-=item TIME
+B<TIME>
 
 Pushes the time the currently processed value was taken onto the stack.
 
-Z<>
-
-=item LTIME
+B<LTIME>
 
 Takes the time as defined by B<TIME>, applies the time zone offset
 valid at that time including daylight saving time if your OS supports
 it, and pushes the result on the stack.  There is an elaborate example
 in the examples section on how to use this.
 
-=back
-
-For B<VDEF> operations, B<TIME> and B<LTIME> have a different meaning
-I<not yet implemented>.  As the B<VDEF> statement does not work per
-value but rather on a complete time series, there is no such thing as
-the currently processed value.  However, if you have used an operator
-that returned a time component and would like to have this available
-in the value component in stead (so you can use it as a number), you
-can use B<TIME> or B<LTIME> for that.
-
-Z<>
-
 =item Processing the stack directly
 
 B<DUP, POP, EXC>
@@ -204,13 +217,11 @@ top elements.
 
 Z<>
 
-=item Selecting characteristics
+=back
 
-These operators work only on B<VDEF> statements.
-I<We can make most of them work at DEF and CDEF statements. If we do
-so, we have a moving (not rolling!) average, max,min etcetera>
+=head1 VARIABLES
 
-Z<>
+These operators work only on B<VDEF> statements.
 
 =over 4
 
@@ -221,8 +232,6 @@ the first occurrence 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.  The time for
@@ -231,8 +240,6 @@ the LAST time component returns the end of the corresponding interval.
 
 Example: C<VDEF:first=mydata,FIRST>
 
-Z<>
-
 =item TOTAL
 
 Returns the rate from each defined time slot multiplied with the
@@ -242,8 +249,6 @@ the amount of seconds
 
 Example: C<VDEF:total=mydata,TOTAL>
 
-Z<>
-
 =item PERCENT
 
 Should follow a B<DEF> or B<CDEF> I<vname>. This I<vname> is popped,
@@ -254,11 +259,10 @@ 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.  B<Inf>inite numbers are lesser, or more, than the
 finite numbers and are always more than the I<Unknown> numbers.
+(NaN E<lt> -INF E<lt> finite values E<lt> INF)
 
 Example: C<VDEF:perc95=mydata,95,PERCENT>
 
 =back
 
-=back
-
 =include see_also