[tokkee]

tokkee.org

Code

projects / pkg-rrdtool.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Imported upstream version 1.3.8.
[pkg-rrdtool.git] / doc / rrdgraph_rpn.html
diff --git a/doc/rrdgraph_rpn.html b/doc/rrdgraph_rpn.html
index ef20291cda955eb90a863b4ff63a7e75105696fb..bed66325f395102095325ac47665002bb4ccf7c1 100644 (file)
--- a/doc/rrdgraph_rpn.html
+++ b/doc/rrdgraph_rpn.html
@@ -9,8 +9,10 @@
 
 <body style="background-color: white">
 
-<p><a name="__index__"></a></p>
+
 <!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
 <!--
 
 <ul>
@@ -23,7 +25,11 @@
        <li><a href="#see_also">SEE ALSO</a></li>
        <li><a href="#author">AUTHOR</a></li>
 </ul>
+
 -->
+
+
+</div>
 <!-- INDEX END -->
 
 <p>
@@ -40,7 +46,8 @@
 <hr />
 <h1><a name="description">DESCRIPTION</a></h1>
 <p>If you have ever used a traditional HP calculator you already know
-<strong>RPN</strong>. The idea behind <strong>RPN</strong> is that you have a stack and push
+<strong>RPN</strong> (Reverse Polish Notation).
+The idea behind <strong>RPN</strong> is that you have a stack and push
 your data onto this stack. Whenever you execute an operation, it
 takes as many elements from the stack as needed. Pushing is done
 implicitly, so whenever you specify a number or a variable, it gets
@@ -52,7 +59,7 @@ data point on the graph. <strong>VDEF</strong> instructions work on an entire da
 one run. Note, that currently <strong>VDEF</strong> instructions only support a limited
 list of functions.</p>
 <p>Example: <code>VDEF:maximum=mydata,MAXIMUM</code></p>
-<p>This will set variable ``maximum'' which you now can use in the rest
+<p>This will set variable &quot;maximum&quot; which you now can use in the rest
 of your RRD script.</p>
 <p>Example: <code>CDEF:mydatabits=mydata,8,*</code></p>
 <p>This means:  push variable <em>mydata</em>, push the number 8, execute
@@ -70,7 +77,7 @@ would do <code>a = b, 3, +, 5, *</code> without the need for parentheses.</p>
 <hr />
 <h1><a name="operators">OPERATORS</a></h1>
 <dl>
-<dt><strong><a name="item_boolean_operators">Boolean operators</a></strong></dt>
+<dt><strong><a name="boolean_operators" class="item">Boolean operators</a></strong></dt>
 
 <dd>
 <p><strong>LT, LE, GT, GE, EQ, NE</strong></p>
@@ -88,7 +95,7 @@ mean that any value other than 0 is considered to be true.</p>
 <p>Example: <code>A,B,C,IF</code> should be read as <code>if (A) then (B) else (C)</code></p>
 <p></p>
 </dd>
-<dt><strong><a name="item_comparing_values">Comparing values</a></strong></dt>
+<dt><strong><a name="comparing_values" class="item">Comparing values</a></strong></dt>
 
 <dd>
 <p><strong>MIN, MAX</strong></p>
@@ -108,7 +115,7 @@ will always return an <em>unknown</em></p>
 alpha is lower than 0 or if it is higher than 100.</p>
 <p></p>
 </dd>
-<dt><strong><a name="item_arithmetics">Arithmetics</a></strong></dt>
+<dt><strong><a name="arithmetics" class="item">Arithmetics</a></strong></dt>
 
 <dd>
 <p><strong>+, -, *, /, %</strong></p>
@@ -136,7 +143,7 @@ components into an angle in degrees.</p>
 <p><strong>ABS</strong></p>
 <p>Take the absolute value.</p>
 </dd>
-<dt><strong><a name="item_set_operations">Set Operations</a></strong></dt>
+<dt><strong><a name="set_operations" class="item">Set Operations</a></strong></dt>
 
 <dd>
 <p><strong>SORT, REV</strong></p>
@@ -151,7 +158,7 @@ largest.</p>
 average, ignoring all UNKNOWN values in the process.</p>
 <p>Example: <code>CDEF:x=a,b,c,d,4,AVG</code></p>
 <p><strong>TREND, TRENDNAN</strong></p>
-<p>Create a ``sliding window'' average of another data series.</p>
+<p>Create a &quot;sliding window&quot; average of another data series.</p>
 <p>Usage:
 CDEF:smoothed=x,1800,TREND</p>
 <p>This will create a half-hour (1800 second) sliding window average of x.  The
@@ -174,7 +181,7 @@ source value is NAN the complete sliding window is affected. The TRENDNAN
 operation ignores all NAN-values in a sliding window and computes the 
 average of the remaining values.</p>
 </dd>
-<dt><strong><a name="item_special_values">Special values</a></strong></dt>
+<dt><strong><a name="special_values" class="item">Special values</a></strong></dt>
 
 <dd>
 <p><strong>UNKN</strong></p>
@@ -199,7 +206,7 @@ number 2 if it is the second, and so on. This special value allows
 you to make calculations based on the position of the value within
 the data set. This function cannot be used in <strong>VDEF</strong> instructions.</p>
 </dd>
-<dt><strong><a name="item_time">Time</a></strong></dt>
+<dt><strong><a name="time" class="item">Time</a></strong></dt>
 
 <dd>
 <p>Time inside RRDtool is measured in seconds since the epoch. The
@@ -214,7 +221,7 @@ 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 below on how to use this.</p>
 </dd>
-<dt><strong><a name="item_processing_the_stack_directly">Processing the stack directly</a></strong></dt>
+<dt><strong><a name="processing_the_stack_directly" class="item">Processing the stack directly</a></strong></dt>
 
 <dd>
 <p><strong>DUP, POP, EXC</strong></p>
@@ -229,20 +236,20 @@ top elements.</p>
 <h1><a name="variables">VARIABLES</a></h1>
 <p>These operators work only on <strong>VDEF</strong> statements. Note that currently ONLY these work for <strong>VDEF</strong>.</p>
 <dl>
-<dt><strong><a name="item_maximum_2c_minimum_2c_average">MAXIMUM, MINIMUM, AVERAGE</a></strong></dt>
+<dt><strong><a name="maximum_minimum_average" class="item">MAXIMUM, MINIMUM, AVERAGE</a></strong></dt>
 
 <dd>
 <p>Return the corresponding value, MAXIMUM and MINIMUM also return
 the first occurrence of that value in the time component.</p>
 <p>Example: <code>VDEF:avg=mydata,AVERAGE</code></p>
 </dd>
-<dt><strong><a name="item_stdev">STDEV</a></strong></dt>
+<dt><strong><a name="stdev" class="item">STDEV</a></strong></dt>
 
 <dd>
 <p>Returns the standard deviation of the values.</p>
 <p>Example: <code>VDEF:stdev=mydata,STDEV</code></p>
 </dd>
-<dt><strong><a name="item_last_2c_first">LAST, FIRST</a></strong></dt>
+<dt><strong><a name="last_first" class="item">LAST, FIRST</a></strong></dt>
 
 <dd>
 <p>Return the last/first value including its time.  The time for
@@ -250,7 +257,7 @@ FIRST is actually the start of the corresponding interval, whereas
 LAST returns the end of the corresponding interval.</p>
 <p>Example: <code>VDEF:first=mydata,FIRST</code></p>
 </dd>
-<dt><strong><a name="item_total">TOTAL</a></strong></dt>
+<dt><strong><a name="total" class="item">TOTAL</a></strong></dt>
 
 <dd>
 <p>Returns the rate from each defined time slot multiplied with the
@@ -259,7 +266,7 @@ when you have logged bytes per second. The time component returns
 the number of seconds.</p>
 <p>Example: <code>VDEF:total=mydata,TOTAL</code></p>
 </dd>
-<dt><strong><a name="item_percent">PERCENT</a></strong></dt>
+<dt><strong><a name="percent" class="item">PERCENT</a></strong></dt>
 
 <dd>
 <p>This should follow a <strong>DEF</strong> or <strong>CDEF</strong> <em>vname</em>. The <em>vname</em> is popped,
@@ -273,7 +280,7 @@ finite numbers and are always more than the <em>Unknown</em> numbers.
 (NaN &lt; -INF &lt; finite values &lt; INF)</p>
 <p>Example: <code>VDEF:perc95=mydata,95,PERCENT</code></p>
 </dd>
-<dt><strong><a name="item_lslslope_2c_lslint_2c_lslcorrel">LSLSLOPE, LSLINT, LSLCORREL</a></strong></dt>
+<dt><strong><a name="lslslope_lslint_lslcorrel" class="item">LSLSLOPE, LSLINT, LSLCORREL</a></strong></dt>
 
 <dd>
 <p>Return the parameters for a <strong>L</strong>east <strong>S</strong>quares <strong>L</strong>ine <em>(y = mx +b)</em> 
@@ -300,7 +307,8 @@ and represents the quality of fit for the approximation.</p>
 <hr />
 <h1><a name="author">AUTHOR</a></h1>
 <p>Program by Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
-<p>This manual page by Alex van den Bogaerdt &lt;<a href="mailto:alex@ergens.op.het.net">alex@ergens.op.het.net</a>&gt;</p>
+<p>This manual page by Alex van den Bogaerdt &lt;<a href="mailto:alex@vandenbogaerdt.nl">alex@vandenbogaerdt.nl</a>&gt;
+with corrections and/or additions by several people</p>
 
 </body>
 
Unnamed repository; edit this file 'description' to name the repository.