doc/rrdgraph_rpn.1

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
   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 "2013-05-23" "1.4.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 result in \fIunknown\fR returned ... which will also be
 180 treated as false by the \fB\s-1IF\s0\fR call.
 181 .Sp
 182 \&\fB\s-1UN\s0, \s-1ISINF\s0\fR
 183 .Sp
 184 Pop one element from the stack, compare this to \fIunknown\fR respectively
 185 to \fIpositive or negative infinity\fR. Returns 1 for true or 0 for false.
 186 .Sp
 187 \&\fB\s-1IF\s0\fR
 188 .Sp
 189 Pops three elements from the stack.  If the element popped last is 0
 190 (false), the value popped first is pushed back onto the stack,
 191 otherwise the value popped second is pushed back. This does, indeed,
 192 mean that any value other than 0 is considered to be true.
 193 .Sp
 194 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
 195 .Sp
 196
 197 .IP "Comparing values" 4
 198 .IX Item "Comparing values"
 199 \&\fB\s-1MIN\s0, \s-1MAX\s0\fR
 200 .Sp
 201 Pops two elements from the stack and returns the smaller or larger,
 202 respectively.  Note that \fIinfinite\fR is larger than anything else.
 203 If one of the input numbers is \fIunknown\fR then the result of the operation will be
 204 \&\fIunknown\fR too.
 205 .Sp
 206 \&\fB\s-1LIMIT\s0\fR
 207 .Sp
 208 Pops two elements from the stack and uses them to define a range.
 209 Then it pops another element and if it falls inside the range, it
 210 is pushed back. If not, an \fIunknown\fR is pushed.
 211 .Sp
 212 The range defined includes the two boundaries (so: a number equal
 213 to one of the boundaries will be pushed back). If any of the three
 214 numbers involved is either \fIunknown\fR or \fIinfinite\fR this function
 215 will always return an \fIunknown\fR
 216 .Sp
 217 Example: \f(CW\*(C`CDEF:a=alpha,0,100,LIMIT\*(C'\fR will return \fIunknown\fR if
 218 alpha is lower than 0 or if it is higher than 100.
 219 .Sp
 220
 221 .IP "Arithmetics" 4
 222 .IX Item "Arithmetics"
 223 \&\fB+, \-, *, /, %\fR
 224 .Sp
 225 Add, subtract, multiply, divide, modulo
 226 .Sp
 227 \&\fB\s-1ADDNAN\s0\fR
 228 .Sp
 229 NAN-safe addition. If one parameter is \s-1NAN/UNKNOWN\s0 it'll be treated as
 230 zero. If both parameters are \s-1NAN/UNKNOWN\s0, \s-1NAN/UNKNOWN\s0 will be returned.
 231 .Sp
 232 \&\fB\s-1SIN\s0, \s-1COS\s0, \s-1LOG\s0, \s-1EXP\s0, \s-1SQRT\s0\fR
 233 .Sp
 234 Sine and cosine (input in radians), log and exp (natural logarithm),
 235 square root.
 236 .Sp
 237 \&\fB\s-1ATAN\s0\fR
 238 .Sp
 239 Arctangent (output in radians).
 240 .Sp
 241 \&\fB\s-1ATAN2\s0\fR
 242 .Sp
 243 Arctangent of y,x components (output in radians).
 244 This pops one element from the stack, the x (cosine) component, and then
 245 a second, which is the y (sine) component.
 246 It then pushes the arctangent of their ratio, resolving the ambiguity between
 247 quadrants.
 248 .Sp
 249 Example: \f(CW\*(C`CDEF:angle=Y,X,ATAN2,RAD2DEG\*(C'\fR will convert \f(CW\*(C`X,Y\*(C'\fR
 250 components into an angle in degrees.
 251 .Sp
 252 \&\fB\s-1FLOOR\s0, \s-1CEIL\s0\fR
 253 .Sp
 254 Round down or up to the nearest integer.
 255 .Sp
 256 \&\fB\s-1DEG2RAD\s0, \s-1RAD2DEG\s0\fR
 257 .Sp
 258 Convert angle in degrees to radians, or radians to degrees.
 259 .Sp
 260 \&\fB\s-1ABS\s0\fR
 261 .Sp
 262 Take the absolute value.
 263 .IP "Set Operations" 4
 264 .IX Item "Set Operations"
 265 \&\fB\s-1SORT\s0, \s-1REV\s0\fR
 266 .Sp
 267 Pop one element from the stack.  This is the \fIcount\fR of items to be sorted
 268 (or reversed).  The top \fIcount\fR of the remaining elements are then sorted
 269 (or reversed) in place on the stack.
 270 .Sp
 271 Example: \f(CW\*(C`CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/\*(C'\fR will
 272 compute the average of the values v1 to v6 after removing the smallest and
 273 largest.
 274 .Sp
 275 \&\fB\s-1AVG\s0\fR
 276 .Sp
 277 Pop one element (\fIcount\fR) from the stack. Now pop \fIcount\fR elements and build the
 278 average, ignoring all \s-1UNKNOWN\s0 values in the process.
 279 .Sp
 280 Example: \f(CW\*(C`CDEF:x=a,b,c,d,4,AVG\*(C'\fR
 281 .Sp
 282 \&\fB\s-1TREND\s0, \s-1TRENDNAN\s0\fR
 283 .Sp
 284 Create a \*(L"sliding window\*(R" average of another data series.
 285 .Sp
 286 Usage:
 287 CDEF:smoothed=x,1800,TREND
 288 .Sp
 289 This will create a half-hour (1800 second) sliding window average of x.  The
 290 average is essentially computed as shown here:
 291 .Sp
 292 .Vb 8
 293 \&                 +\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\->
 294 \&                                                     now
 295 \&                       delay     t0
 296 \&                 <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 297 \&                         delay       t1
 298 \&                     <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 299 \&                              delay      t2
 300 \&                         <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 301 \&
 302 \&
 303 \&     Value at sample (t0) will be the average between (t0\-delay) and (t0)
 304 \&     Value at sample (t1) will be the average between (t1\-delay) and (t1)
 305 \&     Value at sample (t2) will be the average between (t2\-delay) and (t2)
 306 .Ve
 307 .Sp
 308 \&\s-1TRENDNAN\s0 is \- in contrast to \s-1TREND\s0 \- NAN-safe. If you use \s-1TREND\s0 and one
 309 source value is \s-1NAN\s0 the complete sliding window is affected. The \s-1TRENDNAN\s0
 310 operation ignores all NAN-values in a sliding window and computes the
 311 average of the remaining values.
 312 .Sp
 313 \&\fB\s-1PREDICT\s0, \s-1PREDICTSIGMA\s0\fR
 314 .Sp
 315 Create a \*(L"sliding window\*(R" average/sigma of another data series, that also
 316 shifts the data series by given amounts of of time as well
 317 .Sp
 318 Usage \- explicit stating shifts:
 319 CDEF:predict=<shift n>,...,<shift 1>,n,<window>,x,PREDICT
 320 CDEF:sigma=<shift n>,...,<shift 1>,n,<window>,x,PREDICTSIGMA
 321 .Sp
 322 Usage \- shifts defined as a base shift and a number of time this is applied
 323 CDEF:predict=<shift multiplier>,\-n,<window>,x,PREDICT
 324 CDEF:sigma=<shift multiplier>,\-n,<window>,x,PREDICTSIGMA
 325 .Sp
 326 Example:
 327 CDEF:predict=172800,86400,2,1800,x,PREDICT
 328 .Sp
 329 This will create a half-hour (1800 second) sliding window average/sigma of x, that
 330 average is essentially computed as shown here:
 331 .Sp
 332 .Vb 10
 333 \& +\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\->
 334 \&                                                                     now
 335 \&                                                  shift 1        t0
 336 \&                                         <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 337 \&                               window
 338 \&                         <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 339 \&                                       shift 2
 340 \&                 <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 341 \&       window
 342 \& <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 343 \&                                                      shift 1        t1
 344 \&                                             <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 345 \&                                   window
 346 \&                             <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 347 \&                                            shift 2
 348 \&                     <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 349 \&           window
 350 \&     <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->
 351 \&
 352 \& Value at sample (t0) will be the average between (t0\-shift1\-window) and (t0\-shift1)
 353 \&                                      and between (t0\-shift2\-window) and (t0\-shift2)
 354 \& Value at sample (t1) will be the average between (t1\-shift1\-window) and (t1\-shift1)
 355 \&                                      and between (t1\-shift2\-window) and (t1\-shift2)
 356 .Ve
 357 .Sp
 358 The function is by design NAN-safe.
 359 This also allows for extrapolation into the future (say a few days)
 360 \&\- you may need to define the data series whit the optional start= parameter, so that
 361 the source data series has enough data to provide prediction also at the beginning of a graph...
 362 .Sp
 363 Here an example, that will create a 10 day graph that also shows the
 364 prediction 3 days into the future with its uncertainty value (as defined by avg+\-4*sigma)
 365 This also shows if the prediction is exceeded at a certain point.
 366 .Sp
 367 rrdtool graph image.png \-\-imgformat=PNG \e
 368  \-\-start=\-7days \-\-end=+3days \-\-width=1000 \-\-height=200 \-\-alt\-autoscale\-max \e
 369  DEF:value=value.rrd:value:AVERAGE:start=\-14days \e
 370  LINE1:value#ff0000:value \e
 371  CDEF:predict=86400,\-7,1800,value,PREDICT \e
 372  CDEF:sigma=86400,\-7,1800,value,PREDICTSIGMA \e
 373  CDEF:upper=predict,sigma,3,*,+ \e
 374  CDEF:lower=predict,sigma,3,*,\- \e
 375  LINE1:predict#00ff00:prediction \e
 376  LINE1:upper#0000ff:upper\e certainty\e limit \e
 377  LINE1:lower#0000ff:lower\e certainty\e limit \e
 378  CDEF:exceeds=value,UN,0,value,lower,upper,LIMIT,UN,IF \e
 379  TICK:exceeds#aa000080:1
 380 .Sp
 381 Note: Experience has shown that a factor between 3 and 5 to scale sigma is a good
 382 discriminator to detect abnormal behavior. This obviously depends also on the type
 383 of data and how \*(L"noisy\*(R" the data series is.
 384 .Sp
 385 This prediction can only be used for short term extrapolations \- say a few days into the future\-
 386 .IP "Special values" 4
 387 .IX Item "Special values"
 388 \&\fB\s-1UNKN\s0\fR
 389 .Sp
 390 Pushes an unknown value on the stack
 391 .Sp
 392 \&\fB\s-1INF\s0, \s-1NEGINF\s0\fR
 393 .Sp
 394 Pushes a positive or negative infinite value on the stack. When
 395 such a value is graphed, it appears at the top or bottom of the
 396 graph, no matter what the actual value on the y\-axis is.
 397 .Sp
 398 \&\fB\s-1PREV\s0\fR
 399 .Sp
 400 Pushes an \fIunknown\fR value if this is the first value of a data
 401 set or otherwise the result of this \fB\s-1CDEF\s0\fR at the previous time
 402 step. This allows you to do calculations across the data.  This
 403 function cannot be used in \fB\s-1VDEF\s0\fR instructions.
 404 .Sp
 405 \&\fB\s-1PREV\s0(vname)\fR
 406 .Sp
 407 Pushes an \fIunknown\fR value if this is the first value of a data
 408 set or otherwise the result of the vname variable at the previous time
 409 step. This allows you to do calculations across the data. This
 410 function cannot be used in \fB\s-1VDEF\s0\fR instructions.
 411 .Sp
 412 \&\fB\s-1COUNT\s0\fR
 413 .Sp
 414 Pushes the number 1 if this is the first value of the data set, the
 415 number 2 if it is the second, and so on. This special value allows
 416 you to make calculations based on the position of the value within
 417 the data set. This function cannot be used in \fB\s-1VDEF\s0\fR instructions.
 418 .IP "Time" 4
 419 .IX Item "Time"
 420 Time inside RRDtool is measured in seconds since the epoch. The
 421 epoch is defined to be \f(CW\*(C`Thu\ Jan\ \ 1\ 00:00:00\ UTC\ 1970\*(C'\fR.
 422 .Sp
 423 \&\fB\s-1NOW\s0\fR
 424 .Sp
 425 Pushes the current time on the stack.
 426 .Sp
 427 \&\fB\s-1TIME\s0\fR
 428 .Sp
 429 Pushes the time the currently processed value was taken at onto the stack.
 430 .Sp
 431 \&\fB\s-1LTIME\s0\fR
 432 .Sp
 433 Takes the time as defined by \fB\s-1TIME\s0\fR, applies the time zone offset
 434 valid at that time including daylight saving time if your \s-1OS\s0 supports
 435 it, and pushes the result on the stack.  There is an elaborate example
 436 in the examples section below on how to use this.
 437 .IP "Processing the stack directly" 4
 438 .IX Item "Processing the stack directly"
 439 \&\fB\s-1DUP\s0, \s-1POP\s0, \s-1EXC\s0\fR
 440 .Sp
 441 Duplicate the top element, remove the top element, exchange the two
 442 top elements.
 443 .Sp
 444
 445 .SH "VARIABLES"
 446 .IX Header "VARIABLES"
 447 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.
 448 .IP "\s-1MAXIMUM\s0, \s-1MINIMUM\s0, \s-1AVERAGE\s0" 4
 449 .IX Item "MAXIMUM, MINIMUM, AVERAGE"
 450 Return the corresponding value, \s-1MAXIMUM\s0 and \s-1MINIMUM\s0 also return
 451 the first occurrence of that value in the time component.
 452 .Sp
 453 Example: \f(CW\*(C`VDEF:avg=mydata,AVERAGE\*(C'\fR
 454 .IP "\s-1STDEV\s0" 4
 455 .IX Item "STDEV"
 456 Returns the standard deviation of the values.
 457 .Sp
 458 Example: \f(CW\*(C`VDEF:stdev=mydata,STDEV\*(C'\fR
 459 .IP "\s-1LAST\s0, \s-1FIRST\s0" 4
 460 .IX Item "LAST, FIRST"
 461 Return the last/first non-nan or infinite value for the selected data
 462 stream, including its timestamp.
 463 .Sp
 464 Example: \f(CW\*(C`VDEF:first=mydata,FIRST\*(C'\fR
 465 .IP "\s-1TOTAL\s0" 4
 466 .IX Item "TOTAL"
 467 Returns the rate from each defined time slot multiplied with the
 468 step size.  This can, for instance, return total bytes transferred
 469 when you have logged bytes per second. The time component returns
 470 the number of seconds.
 471 .Sp
 472 Example: \f(CW\*(C`VDEF:total=mydata,TOTAL\*(C'\fR
 473 .IP "\s-1PERCENT\s0, \s-1PERCENTNAN\s0" 4
 474 .IX Item "PERCENT, PERCENTNAN"
 475 This should follow a \fB\s-1DEF\s0\fR or \fB\s-1CDEF\s0\fR \fIvname\fR. The \fIvname\fR is popped,
 476 another number is popped which is a certain percentage (0..100). The
 477 data set is then sorted and the value returned is chosen such that
 478 \&\fIpercentage\fR percent of the values is lower or equal than the result.
 479 For \s-1PERCENTNAN\s0 \fIUnknown\fR values are ignored, but for \s-1PERCENT\s0
 480 \&\fIUnknown\fR values are considered lower than any finite number for this
 481 purpose so if this operator returns an \fIunknown\fR you have quite a lot
 482 of them in your data.  \fBInf\fRinite numbers are lesser, or more, than the
 483 finite numbers and are always more than the \fIUnknown\fR numbers.
 484 (NaN < \-INF < finite values < \s-1INF\s0)
 485 .Sp
 486 Example: \f(CW\*(C`VDEF:perc95=mydata,95,PERCENT\*(C'\fR
 487          \f(CW\*(C`VDEF:percnan95=mydata,95,PERCENTNAN\*(C'\fR
 488 .IP "\s-1LSLSLOPE\s0, \s-1LSLINT\s0, \s-1LSLCORREL\s0" 4
 489 .IX Item "LSLSLOPE, LSLINT, LSLCORREL"
 490 Return the parameters for a \fBL\fReast \fBS\fRquares \fBL\fRine \fI(y = mx +b)\fR
 491 which approximate the provided dataset.  \s-1LSLSLOPE\s0 is the slope \fI(m)\fR of
 492 the line related to the \s-1COUNT\s0 position of the data.  \s-1LSLINT\s0 is the
 493 y\-intercept \fI(b)\fR, which happens also to be the first data point on the
 494 graph. \s-1LSLCORREL\s0 is the Correlation Coefficient (also know as Pearson's
 495 Product Moment Correlation Coefficient).  It will range from 0 to +/\-1
 496 and represents the quality of fit for the approximation.
 497 .Sp
 498 Example: \f(CW\*(C`VDEF:slope=mydata,LSLSLOPE\*(C'\fR
 499 .SH "SEE ALSO"
 500 .IX Header "SEE ALSO"
 501 rrdgraph gives an overview of how \fBrrdtool graph\fR works.
 502 rrdgraph_data describes \fB\s-1DEF\s0\fR,\fB\s-1CDEF\s0\fR and \fB\s-1VDEF\s0\fR in detail.
 503 rrdgraph_rpn describes the \fB\s-1RPN\s0\fR language used in the \fB?DEF\fR statements.
 504 rrdgraph_graph page describes all of the graph and print functions.
 505 .PP
 506 Make sure to read rrdgraph_examples for tips&tricks.
 507 .SH "AUTHOR"
 508 .IX Header "AUTHOR"
 509 Program by Tobias Oetiker <tobi@oetiker.ch>
 510 .PP
 511 This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl>
 512 with corrections and/or additions by several people