doc/rrdgraph_rpn.1

   1 .\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "RRDGRAPH_RPN 1"
 127 .TH RRDGRAPH_RPN 1 "2009-02-21" "1.3.8" "rrdtool"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 rrdgraph_rpn \- About RPN Math in rrdtool graph
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\fI\s-1RPN\s0 expression\fR:=\fIvname\fR|\fIoperator\fR|\fIvalue\fR[,\fI\s-1RPN\s0 expression\fR]
 137 .SH "DESCRIPTION"
 138 .IX Header "DESCRIPTION"
 139 If you have ever used a traditional \s-1HP\s0 calculator you already know
 140 \&\fB\s-1RPN\s0\fR (Reverse Polish Notation).
 141 The idea behind \fB\s-1RPN\s0\fR is that you have a stack and push
 142 your data onto this stack. Whenever you execute an operation, it
 143 takes as many elements from the stack as needed. Pushing is done
 144 implicitly, so whenever you specify a number or a variable, it gets
 145 pushed onto the stack automatically.
 146 .PP
 147 At the end of the calculation there should be one and only one value left on
 148 the stack.  This is the outcome of the function and this is what is put into
 149 the \fIvname\fR.  For \fB\s-1CDEF\s0\fR instructions, the stack is processed for each
 150 data point on the graph. \fB\s-1VDEF\s0\fR instructions work on an entire data set in
 151 one run. Note, that currently \fB\s-1VDEF\s0\fR instructions only support a limited
 152 list of functions.
 153 .PP
 154 Example: \f(CW\*(C`VDEF:maximum=mydata,MAXIMUM\*(C'\fR
 155 .PP
 156 This will set variable \*(L"maximum\*(R" which you now can use in the rest
 157 of your \s-1RRD\s0 script.
 158 .PP
 159 Example: \f(CW\*(C`CDEF:mydatabits=mydata,8,*\*(C'\fR
 160 .PP
 161 This means:  push variable \fImydata\fR, push the number 8, execute
 162 the operator \fI*\fR. The operator needs two elements and uses those
 163 to return one value.  This value is then stored in \fImydatabits\fR.
 164 As you may have guessed, this instruction means nothing more than
 165 \&\fImydatabits = mydata * 8\fR.  The real power of \fB\s-1RPN\s0\fR lies in the
 166 fact that it is always clear in which order to process the input.
 167 For expressions like \f(CW\*(C`a = b + 3 * 5\*(C'\fR you need to multiply 3 with
 168 5 first before you add \fIb\fR to get \fIa\fR. However, with parentheses
 169 you could change this order: \f(CW\*(C`a = (b + 3) * 5\*(C'\fR. In \fB\s-1RPN\s0\fR, you
 170 would do \f(CW\*(C`a = b, 3, +, 5, *\*(C'\fR without the need for parentheses.
 171 .SH "OPERATORS"
 172 .IX Header "OPERATORS"
 173 .IP "Boolean operators" 4
 174 .IX Item "Boolean operators"
 175 \&\fB\s-1LT\s0, \s-1LE\s0, \s-1GT\s0, \s-1GE\s0, \s-1EQ\s0, \s-1NE\s0\fR
 176 .Sp
 177 Pop two elements from the stack, compare them for the selected condition
 178 and return 1 for true or 0 for false. Comparing an \fIunknown\fR or an
 179 \&\fIinfinite\fR value will always result in 0 (false).
 180 .Sp
 181 \&\fB\s-1UN\s0, \s-1ISINF\s0\fR
 182 .Sp
 183 Pop one element from the stack, compare this to \fIunknown\fR respectively
 184 to \fIpositive or negative infinity\fR. Returns 1 for true or 0 for false.
 185 .Sp
 186 \&\fB\s-1IF\s0\fR
 187 .Sp
 188 Pops three elements from the stack.  If the element popped last is 0
 189 (false), the value popped first is pushed back onto the stack,
 190 otherwise the value popped second is pushed back. This does, indeed,
 191 mean that any value other than 0 is considered to be true.
 192 .Sp
 193 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
 194 .Sp
 195
 196 .IP "Comparing values" 4
 197 .IX Item "Comparing values"
 198 \&\fB\s-1MIN\s0, \s-1MAX\s0\fR
 199 .Sp
 200 Pops two elements from the stack and returns the smaller or larger,
 201 respectively.  Note that \fIinfinite\fR is larger than anything else.
 202 If one of the input numbers is \fIunknown\fR then the result of the operation will be
 203 \&\fIunknown\fR too.
 204 .Sp
 205 \&\fB\s-1LIMIT\s0\fR
 206 .Sp
 207 Pops two elements from the stack and uses them to define a range.
 208 Then it pops another element and if it falls inside the range, it
 209 is pushed back. If not, an \fIunknown\fR is pushed.
 210 .Sp
 211 The range defined includes the two boundaries (so: a number equal
 212 to one of the boundaries will be pushed back). If any of the three
 213 numbers involved is either \fIunknown\fR or \fIinfinite\fR this function
 214 will always return an \fIunknown\fR
 215 .Sp
 216 Example: \f(CW\*(C`CDEF:a=alpha,0,100,LIMIT\*(C'\fR will return \fIunknown\fR if
 217 alpha is lower than 0 or if it is higher than 100.
 218 .Sp
 219
 220 .IP "Arithmetics" 4
 221 .IX Item "Arithmetics"
 222 \&\fB+, \-, *, /, %\fR
 223 .Sp
 224 Add, subtract, multiply, divide, modulo
 225 .Sp
 226 \&\fB\s-1ADDNAN\s0\fR
 227 .Sp
 228 NAN-safe addition. If one parameter is \s-1NAN/UNKNOWN\s0 it'll be treated as
 229 zero. If both parameters are \s-1NAN/UNKNOWN\s0, \s-1NAN/UNKNOWN\s0 will be returned.
 230 .Sp
 231 \&\fB\s-1SIN\s0, \s-1COS\s0, \s-1LOG\s0, \s-1EXP\s0, \s-1SQRT\s0\fR
 232 .Sp
 233 Sine and cosine (input in radians), log and exp (natural logarithm),
 234 square root.
 235 .Sp
 236 \&\fB\s-1ATAN\s0\fR
 237 .Sp
 238 Arctangent (output in radians).
 239 .Sp
 240 \&\fB\s-1ATAN2\s0\fR
 241 .Sp
 242 Arctangent of y,x components (output in radians).
 243 This pops one element from the stack, the x (cosine) component, and then
 244 a second, which is the y (sine) component.
 245 It then pushes the arctangent of their ratio, resolving the ambiguity between
 246 quadrants.
 247 .Sp
 248 Example: \f(CW\*(C`CDEF:angle=Y,X,ATAN2,RAD2DEG\*(C'\fR will convert \f(CW\*(C`X,Y\*(C'\fR
 249 components into an angle in degrees.
 250 .Sp
 251 \&\fB\s-1FLOOR\s0, \s-1CEIL\s0\fR
 252 .Sp
 253 Round down or up to the nearest integer.
 254 .Sp
 255 \&\fB\s-1DEG2RAD\s0, \s-1RAD2DEG\s0\fR
 256 .Sp
 257 Convert angle in degrees to radians, or radians to degrees.
 258 .Sp
 259 \&\fB\s-1ABS\s0\fR
 260 .Sp
 261 Take the absolute value.
 262 .IP "Set Operations" 4
 263 .IX Item "Set Operations"
 264 \&\fB\s-1SORT\s0, \s-1REV\s0\fR
 265 .Sp
 266 Pop one element from the stack.  This is the \fIcount\fR of items to be sorted
 267 (or reversed).  The top \fIcount\fR of the remaining elements are then sorted
 268 (or reversed) in place on the stack.
 269 .Sp
 270 Example: \f(CW\*(C`CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/\*(C'\fR will
 271 compute the average of the values v1 to v6 after removing the smallest and
 272 largest.
 273 .Sp
 274 \&\fB\s-1AVG\s0\fR
 275 .Sp
 276 Pop one element (\fIcount\fR) from the stack. Now pop \fIcount\fR elements and build the
 277 average, ignoring all \s-1UNKNOWN\s0 values in the process.
 278 .Sp
 279 Example: \f(CW\*(C`CDEF:x=a,b,c,d,4,AVG\*(C'\fR
 280 .Sp
 281 \&\fB\s-1TREND\s0, \s-1TRENDNAN\s0\fR
 282 .Sp
 283 Create a \*(L"sliding window\*(R" average of another data series.
 284 .Sp
 285 Usage:
 286 CDEF:smoothed=x,1800,TREND
 287 .Sp
 288 This will create a half-hour (1800 second) sliding window average of x.  The
 289 average is essentially computed as shown here:
 290 .Sp
 291 .Vb 8
 292 \&                 +\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\->
 293 \&                                                     now
 294 \&                       delay     t0
 295 \&                 <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 296 \&                         delay       t1
 297 \&                     <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 298 \&                              delay      t2
 299 \&                         <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 300 \&
 301 \&
 302 \&     Value at sample (t0) will be the average between (t0\-delay) and (t0)
 303 \&     Value at sample (t1) will be the average between (t1\-delay) and (t1)
 304 \&     Value at sample (t2) will be the average between (t2\-delay) and (t2)
 305 .Ve
 306 .Sp
 307 \&\s-1TRENDNAN\s0 is \- in contrast to \s-1TREND\s0 \- NAN-safe. If you use \s-1TREND\s0 and one
 308 source value is \s-1NAN\s0 the complete sliding window is affected. The \s-1TRENDNAN\s0
 309 operation ignores all NAN-values in a sliding window and computes the
 310 average of the remaining values.
 311 .IP "Special values" 4
 312 .IX Item "Special values"
 313 \&\fB\s-1UNKN\s0\fR
 314 .Sp
 315 Pushes an unknown value on the stack
 316 .Sp
 317 \&\fB\s-1INF\s0, \s-1NEGINF\s0\fR
 318 .Sp
 319 Pushes a positive or negative infinite value on the stack. When
 320 such a value is graphed, it appears at the top or bottom of the
 321 graph, no matter what the actual value on the y\-axis is.
 322 .Sp
 323 \&\fB\s-1PREV\s0\fR
 324 .Sp
 325 Pushes an \fIunknown\fR value if this is the first value of a data
 326 set or otherwise the result of this \fB\s-1CDEF\s0\fR at the previous time
 327 step. This allows you to do calculations across the data.  This
 328 function cannot be used in \fB\s-1VDEF\s0\fR instructions.
 329 .Sp
 330 \&\fB\s-1PREV\s0(vname)\fR
 331 .Sp
 332 Pushes an \fIunknown\fR value if this is the first value of a data
 333 set or otherwise the result of the vname variable at the previous time
 334 step. This allows you to do calculations across the data. This
 335 function cannot be used in \fB\s-1VDEF\s0\fR instructions.
 336 .Sp
 337 \&\fB\s-1COUNT\s0\fR
 338 .Sp
 339 Pushes the number 1 if this is the first value of the data set, the
 340 number 2 if it is the second, and so on. This special value allows
 341 you to make calculations based on the position of the value within
 342 the data set. This function cannot be used in \fB\s-1VDEF\s0\fR instructions.
 343 .IP "Time" 4
 344 .IX Item "Time"
 345 Time inside RRDtool is measured in seconds since the epoch. The
 346 epoch is defined to be \f(CW\*(C`Thu\ Jan\ \ 1\ 00:00:00\ UTC\ 1970\*(C'\fR.
 347 .Sp
 348 \&\fB\s-1NOW\s0\fR
 349 .Sp
 350 Pushes the current time on the stack.
 351 .Sp
 352 \&\fB\s-1TIME\s0\fR
 353 .Sp
 354 Pushes the time the currently processed value was taken at onto the stack.
 355 .Sp
 356 \&\fB\s-1LTIME\s0\fR
 357 .Sp
 358 Takes the time as defined by \fB\s-1TIME\s0\fR, applies the time zone offset
 359 valid at that time including daylight saving time if your \s-1OS\s0 supports
 360 it, and pushes the result on the stack.  There is an elaborate example
 361 in the examples section below on how to use this.
 362 .IP "Processing the stack directly" 4
 363 .IX Item "Processing the stack directly"
 364 \&\fB\s-1DUP\s0, \s-1POP\s0, \s-1EXC\s0\fR
 365 .Sp
 366 Duplicate the top element, remove the top element, exchange the two
 367 top elements.
 368 .Sp
 369
 370 .SH "VARIABLES"
 371 .IX Header "VARIABLES"
 372 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.
 373 .IP "\s-1MAXIMUM\s0, \s-1MINIMUM\s0, \s-1AVERAGE\s0" 4
 374 .IX Item "MAXIMUM, MINIMUM, AVERAGE"
 375 Return the corresponding value, \s-1MAXIMUM\s0 and \s-1MINIMUM\s0 also return
 376 the first occurrence of that value in the time component.
 377 .Sp
 378 Example: \f(CW\*(C`VDEF:avg=mydata,AVERAGE\*(C'\fR
 379 .IP "\s-1STDEV\s0" 4
 380 .IX Item "STDEV"
 381 Returns the standard deviation of the values.
 382 .Sp
 383 Example: \f(CW\*(C`VDEF:stdev=mydata,STDEV\*(C'\fR
 384 .IP "\s-1LAST\s0, \s-1FIRST\s0" 4
 385 .IX Item "LAST, FIRST"
 386 Return the last/first value including its time.  The time for
 387 \&\s-1FIRST\s0 is actually the start of the corresponding interval, whereas
 388 \&\s-1LAST\s0 returns the end of the corresponding interval.
 389 .Sp
 390 Example: \f(CW\*(C`VDEF:first=mydata,FIRST\*(C'\fR
 391 .IP "\s-1TOTAL\s0" 4
 392 .IX Item "TOTAL"
 393 Returns the rate from each defined time slot multiplied with the
 394 step size.  This can, for instance, return total bytes transfered
 395 when you have logged bytes per second. The time component returns
 396 the number of seconds.
 397 .Sp
 398 Example: \f(CW\*(C`VDEF:total=mydata,TOTAL\*(C'\fR
 399 .IP "\s-1PERCENT\s0" 4
 400 .IX Item "PERCENT"
 401 This should follow a \fB\s-1DEF\s0\fR or \fB\s-1CDEF\s0\fR \fIvname\fR. The \fIvname\fR is popped,
 402 another number is popped which is a certain percentage (0..100). The
 403 data set is then sorted and the value returned is chosen such that
 404 \&\fIpercentage\fR percent of the values is lower or equal than the result.
 405 \&\fIUnknown\fR values are considered lower than any finite number for this
 406 purpose so if this operator returns an \fIunknown\fR you have quite a lot
 407 of them in your data.  \fBInf\fRinite numbers are lesser, or more, than the
 408 finite numbers and are always more than the \fIUnknown\fR numbers.
 409 (NaN < \-INF < finite values < \s-1INF\s0)
 410 .Sp
 411 Example: \f(CW\*(C`VDEF:perc95=mydata,95,PERCENT\*(C'\fR
 412 .IP "\s-1LSLSLOPE\s0, \s-1LSLINT\s0, \s-1LSLCORREL\s0" 4
 413 .IX Item "LSLSLOPE, LSLINT, LSLCORREL"
 414 Return the parameters for a \fBL\fReast \fBS\fRquares \fBL\fRine \fI(y = mx +b)\fR
 415 which approximate the provided dataset.  \s-1LSLSLOPE\s0 is the slope \fI(m)\fR of
 416 the line related to the \s-1COUNT\s0 position of the data.  \s-1LSLINT\s0 is the
 417 y\-intercept \fI(b)\fR, which happens also to be the first data point on the
 418 graph. \s-1LSLCORREL\s0 is the Correlation Coefficient (also know as Pearson's
 419 Product Moment Correlation Coefficient).  It will range from 0 to +/\-1
 420 and represents the quality of fit for the approximation.
 421 .Sp
 422 Example: \f(CW\*(C`VDEF:slope=mydata,LSLSLOPE\*(C'\fR
 423 .SH "SEE ALSO"
 424 .IX Header "SEE ALSO"
 425 rrdgraph gives an overview of how \fBrrdtool graph\fR works.
 426 rrdgraph_data describes \fB\s-1DEF\s0\fR,\fB\s-1CDEF\s0\fR and \fB\s-1VDEF\s0\fR in detail.
 427 rrdgraph_rpn describes the \fB\s-1RPN\s0\fR language used in the \fB?DEF\fR statements.
 428 rrdgraph_graph page describes all of the graph and print functions.
 429 .PP
 430 Make sure to read rrdgraph_examples for tips&tricks.
 431 .SH "AUTHOR"
 432 .IX Header "AUTHOR"
 433 Program by Tobias Oetiker <tobi@oetiker.ch>
 434 .PP
 435 This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl>
 436 with corrections and/or additions by several people