[pkg-rrdtool.git] / doc / rrdgraph_rpn.1

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RRDGRAPH_RPN 1"
.TH RRDGRAPH_RPN 1 "2008-02-17" "1.2.27" "rrdtool"
.SH "NAME"
rrdgraph_rpn \- About RPN Math in rrdtool graph
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fI\s-1RPN\s0 expression\fR:=\fIvname\fR|\fIoperator\fR|\fIvalue\fR[,\fI\s-1RPN\s0 expression\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
If you have ever used a traditional \s-1HP\s0 calculator you already know
\&\fB\s-1RPN\s0\fR. The idea behind \fB\s-1RPN\s0\fR 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
pushed onto the stack automatically.
.PP
At the end of the calculation there should be one and only one value left on
the stack.  This is the outcome of the function and this is what is put into
the \fIvname\fR.  For \fB\s-1CDEF\s0\fR instructions, the stack is processed for each
data point on the graph. \fB\s-1VDEF\s0\fR instructions work on an entire data set in
one run. Note, that currently \fB\s-1VDEF\s0\fR instructions only support a limited
list of functions.
.PP
Example: \f(CW\*(C`VDEF:maximum=mydata,MAXIMUM\*(C'\fR
.PP
This will set variable \*(L"maximum\*(R" which you now can use in the rest
of your \s-1RRD\s0 script.
.PP
Example: \f(CW\*(C`CDEF:mydatabits=mydata,8,*\*(C'\fR
.PP
This means:  push variable \fImydata\fR, push the number 8, execute
the operator \fI*\fR. The operator needs two elements and uses those
to return one value.  This value is then stored in \fImydatabits\fR.
As you may have guessed, this instruction means nothing more than
\&\fImydatabits = mydata * 8\fR.  The real power of \fB\s-1RPN\s0\fR lies in the
fact that it is always clear in which order to process the input.
For expressions like \f(CW\*(C`a = b + 3 * 5\*(C'\fR you need to multiply 3 with
5 first before you add \fIb\fR to get \fIa\fR. However, with parentheses
you could change this order: \f(CW\*(C`a = (b + 3) * 5\*(C'\fR. In \fB\s-1RPN\s0\fR, you
would do \f(CW\*(C`a = b, 3, +, 5, *\*(C'\fR without the need for parentheses.
.SH "OPERATORS"
.IX Header "OPERATORS"
.IP "Boolean operators" 4
.IX Item "Boolean operators"
\&\fB\s-1LT\s0, \s-1LE\s0, \s-1GT\s0, \s-1GE\s0, \s-1EQ\s0, \s-1NE\s0\fR
.Sp
Pop two elements from the stack, compare them for the selected condition
and return 1 for true or 0 for false. Comparing an \fIunknown\fR or an
\&\fIinfinite\fR value will always result in 0 (false).
.Sp
\&\fB\s-1UN\s0, \s-1ISINF\s0\fR
.Sp
Pop one element from the stack, compare this to \fIunknown\fR respectively
to \fIpositive or negative infinity\fR. Returns 1 for true or 0 for false.
.Sp
\&\fB\s-1IF\s0\fR
.Sp
Pops three elements from the stack.  If the element popped last is 0
(false), the value popped first is pushed back onto the stack,
otherwise the value popped second is pushed back. This does, indeed,
mean that any value other than 0 is considered to be true.
.Sp
Example: \f(CW\*(C`A,B,C,IF\*(C'\fR should be read as \f(CW\*(C`if (A) then (B) else (C)\*(C'\fR
.IP "Comparing values" 4
.IX Item "Comparing values"
\&\fB\s-1MIN\s0, \s-1MAX\s0\fR
.Sp
Pops two elements from the stack and returns the smaller or larger,
respectively.  Note that \fIinfinite\fR is larger than anything else.
If one of the input numbers is \fIunknown\fR then the result of the operation will be
\&\fIunknown\fR too.
.Sp
\&\fB\s-1LIMIT\s0\fR
.Sp
Pops two elements from the stack and uses them to define a range.
Then it pops another element and if it falls inside the range, it
is pushed back. If not, an \fIunknown\fR is pushed.
.Sp
The range defined includes the two boundaries (so: a number equal
to one of the boundaries will be pushed back). If any of the three
numbers involved is either \fIunknown\fR or \fIinfinite\fR this function
will always return an \fIunknown\fR
.Sp
Example: \f(CW\*(C`CDEF:a=alpha,0,100,LIMIT\*(C'\fR will return \fIunknown\fR if
alpha is lower than 0 or if it is higher than 100.
.IP "Arithmetics" 4
.IX Item "Arithmetics"
\&\fB+, \-, *, /, %\fR
.Sp
Add, subtract, multiply, divide, modulo
.Sp
\&\fB\s-1SIN\s0, \s-1COS\s0, \s-1LOG\s0, \s-1EXP\s0, \s-1SQRT\s0\fR
.Sp
Sine and cosine (input in radians), log and exp (natural logarithm),
square root.
.Sp
\&\fB\s-1ATAN\s0\fR
.Sp
Arctangent (output in radians).
.Sp
\&\fB\s-1ATAN2\s0\fR
.Sp
Arctangent of y,x components (output in radians).
This pops one element from the stack, the x (cosine) component, and then
a second, which is the y (sine) component.
It then pushes the arctangent of their ratio, resolving the ambiguity between
quadrants.
.Sp
Example: \f(CW\*(C`CDEF:angle=Y,X,ATAN2,RAD2DEG\*(C'\fR will convert \f(CW\*(C`X,Y\*(C'\fR
components into an angle in degrees.
.Sp
\&\fB\s-1FLOOR\s0, \s-1CEIL\s0\fR
.Sp
Round down or up to the nearest integer.
.Sp
\&\fB\s-1DEG2RAD\s0, \s-1RAD2DEG\s0\fR
.Sp
Convert angle in degrees to radians, or radians to degrees.
.Sp
\&\fB\s-1ABS\s0\fR
.Sp
Take the absolute value.
.IP "Set Operations" 4
.IX Item "Set Operations"
\&\fB\s-1SORT\s0, \s-1REV\s0\fR
.Sp
Pop one element from the stack.  This is the \fIcount\fR of items to be sorted
(or reversed).  The top \fIcount\fR of the remaining elements are then sorted
(or reversed) in place on the stack.
.Sp
Example: \f(CW\*(C`CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/\*(C'\fR will
compute the average of the values v1 to v6 after removing the smallest and
largest.
.Sp
\&\fB\s-1AVG\s0\fR
.Sp
Pop one element (\fIcount\fR) from the stack. Now pop \fIcount\fR elements and build the
average, ignoring all \s-1UNKNOWN\s0 values in the process.
.Sp
Example: \f(CW\*(C`CDEF:x=a,b,c,d,4,AVG\*(C'\fR
.Sp
\&\fB\s-1TREND\s0\fR
.Sp
Create a \*(L"sliding window\*(R" average of another data series.
.Sp
Usage:
CDEF:smoothed=x,1800,TREND
.Sp
This will create a half-hour (1800 second) sliding window average of x.  The
average is essentially computed as shown here:
.Sp
.Vb 8
\&                 +\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\->
\&                                                     now
\&                       delay     t0
\&                 <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
\&                         delay       t1
\&                     <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
\&                              delay      t2
\&                         <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
.Ve
.Sp
.Vb 3
\&     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)
.Ve
.IP "Special values" 4
.IX Item "Special values"
\&\fB\s-1UNKN\s0\fR
.Sp
Pushes an unknown value on the stack
.Sp
\&\fB\s-1INF\s0, \s-1NEGINF\s0\fR
.Sp
Pushes a positive or negative infinite value on the stack. When
such a value is graphed, it appears at the top or bottom of the
graph, no matter what the actual value on the y\-axis is.
.Sp
\&\fB\s-1PREV\s0\fR
.Sp
Pushes an \fIunknown\fR value if this is the first value of a data
set or otherwise the result of this \fB\s-1CDEF\s0\fR at the previous time
step. This allows you to do calculations across the data.  This
function cannot be used in \fB\s-1VDEF\s0\fR instructions.
.Sp
\&\fB\s-1PREV\s0(vname)\fR
.Sp
Pushes an \fIunknown\fR value if this is the first value of a data
set or otherwise the result of the vname variable at the previous time
step. This allows you to do calculations across the data. This
function cannot be used in \fB\s-1VDEF\s0\fR instructions.
.Sp
\&\fB\s-1COUNT\s0\fR
.Sp
Pushes the number 1 if this is the first value of the data set, the
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 \fB\s-1VDEF\s0\fR instructions.
.IP "Time" 4
.IX Item "Time"
Time inside RRDtool is measured in seconds since the epoch. The
epoch is defined to be \f(CW\*(C`Thu\ Jan\ 1\ 00:00:00\ UTC\ 1970\*(C'\fR.
.Sp
\&\fB\s-1NOW\s0\fR
.Sp
Pushes the current time on the stack.
.Sp
\&\fB\s-1TIME\s0\fR
.Sp
Pushes the time the currently processed value was taken at onto the stack.
.Sp
\&\fB\s-1LTIME\s0\fR
.Sp
Takes the time as defined by \fB\s-1TIME\s0\fR, applies the time zone offset
valid at that time including daylight saving time if your \s-1OS\s0 supports
it, and pushes the result on the stack.  There is an elaborate example
in the examples section below on how to use this.
.IP "Processing the stack directly" 4
.IX Item "Processing the stack directly"
\&\fB\s-1DUP\s0, \s-1POP\s0, \s-1EXC\s0\fR
.Sp
Duplicate the top element, remove the top element, exchange the two
top elements.
.SH "VARIABLES"
.IX Header "VARIABLES"
These operators work only on \fB\s-1VDEF\s0\fR statements. Note that currently \s-1ONLY\s0 these work for \fB\s-1VDEF\s0\fR.
.IP "\s-1MAXIMUM\s0, \s-1MINIMUM\s0, \s-1AVERAGE\s0" 4
.IX Item "MAXIMUM, MINIMUM, AVERAGE"
Return the corresponding value, \s-1MAXIMUM\s0 and \s-1MINIMUM\s0 also return
the first occurrence of that value in the time component.
.Sp
Example: \f(CW\*(C`VDEF:avg=mydata,AVERAGE\*(C'\fR
.IP "\s-1LAST\s0, \s-1FIRST\s0" 4
.IX Item "LAST, FIRST"
Return the last/first value including its time.  The time for
\&\s-1FIRST\s0 is actually the start of the corresponding interval, whereas
\&\s-1LAST\s0 returns the end of the corresponding interval.
.Sp
Example: \f(CW\*(C`VDEF:first=mydata,FIRST\*(C'\fR
.IP "\s-1TOTAL\s0" 4
.IX Item "TOTAL"
Returns the rate from each defined time slot 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 number of seconds.
.Sp
Example: \f(CW\*(C`VDEF:total=mydata,TOTAL\*(C'\fR
.IP "\s-1PERCENT\s0" 4
.IX Item "PERCENT"
This should follow a \fB\s-1DEF\s0\fR or \fB\s-1CDEF\s0\fR \fIvname\fR. The \fIvname\fR is popped,
another number is popped which is a certain percentage (0..100). The
data set is then sorted and the value returned is chosen such that
\&\fIpercentage\fR percent of the values is lower or equal than the result.
\&\fIUnknown\fR values are considered lower than any finite number for this
purpose so if this operator returns an \fIunknown\fR you have quite a lot
of them in your data.  \fBInf\fRinite numbers are lesser, or more, than the
finite numbers and are always more than the \fIUnknown\fR numbers.
(NaN < \-INF < finite values < \s-1INF\s0)
.Sp
Example: \f(CW\*(C`VDEF:perc95=mydata,95,PERCENT\*(C'\fR
.IP "\s-1LSLSLOPE\s0, \s-1LSLINT\s0, \s-1LSLCORREL\s0" 4
.IX Item "LSLSLOPE, LSLINT, LSLCORREL"
Return the parameters for a \fBL\fReast \fBS\fRquares \fBL\fRine \fI(y = mx +b)\fR 
which approximate the provided dataset.  \s-1LSLSLOPE\s0 is the slope \fI(m)\fR of
the line related to the \s-1COUNT\s0 position of the data.  \s-1LSLINT\s0 is the 
y\-intercept \fI(b)\fR, which happens also to be the first data point on the 
graph. \s-1LSLCORREL\s0 is the Correlation Coefficient (also know as Pearson's 
Product Moment Correlation Coefficient).  It will range from 0 to +/\-1 
and represents the quality of fit for the approximation.   
.Sp
Example: \f(CW\*(C`VDEF:slope=mydata,LSLSLOPE\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
rrdgraph gives an overview of how \fBrrdtool graph\fR works.
rrdgraph_data describes \fB\s-1DEF\s0\fR,\fB\s-1CDEF\s0\fR and \fB\s-1VDEF\s0\fR in detail.
rrdgraph_rpn describes the \fB\s-1RPN\s0\fR language used in the \fB?DEF\fR statements.
rrdgraph_graph page describes all of the graph and print functions.
.PP
Make sure to read rrdgraph_examples for tips&tricks.
.SH "AUTHOR"
.IX Header "AUTHOR"
Program by Tobias Oetiker <tobi@oetiker.ch>
.PP
This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>