X-Git-Url: https://git.tokkee.org/?p=pkg-rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph_rpn.1;h=a9ca9c63233b81a3f3632c7fba9a1c2c0aef32d4;hp=c765dddb3c774c57396ac6dd4fb9cd6d3c76b783;hb=645054bac6187b0e83fd4125fd59e4feda216b64;hpb=ffa00ac697dccce18dca8880ca7a14066521ac5c diff --git a/doc/rrdgraph_rpn.1 b/doc/rrdgraph_rpn.1 index c765ddd..a9ca9c6 100644 --- a/doc/rrdgraph_rpn.1 +++ b/doc/rrdgraph_rpn.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.08) .\" .\" 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 @@ -25,11 +17,11 @@ .. .\" 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. | will give a -.\" real vertical bar. \*(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-|\(bv\*(Tr +.\" 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- @@ -48,22 +40,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" 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 +.\" titles (.TH), headers (.SH), subsections (.SS), 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 \{\ +.ie \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 +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +124,11 @@ .\" ======================================================================== .\" .IX Title "RRDGRAPH_RPN 1" -.TH RRDGRAPH_RPN 1 "2009-02-21" "1.3.99909060808" "rrdtool" +.TH RRDGRAPH_RPN 1 "2009-06-09" "1.3.999" "rrdtool" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" rrdgraph_rpn \- About RPN Math in rrdtool graph .SH "SYNOPSIS" @@ -193,7 +192,7 @@ 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 .Sp -\&\& + .IP "Comparing values" 4 .IX Item "Comparing values" \&\fB\s-1MIN\s0, \s-1MAX\s0\fR @@ -217,7 +216,7 @@ will always return an \fIunknown\fR 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. .Sp -\&\& + .IP "Arithmetics" 4 .IX Item "Arithmetics" \&\fB+, \-, *, /, %\fR @@ -298,15 +297,14 @@ average is essentially computed as shown here: \& <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-> \& 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 .Sp -\&\s-1TRENDNAN\s0 is \- in contrast to \s-1TREND\s0 \- NAN\-safe. If you use \s-1TREND\s0 and one +\&\s-1TRENDNAN\s0 is \- in contrast to \s-1TREND\s0 \- NAN-safe. If you use \s-1TREND\s0 and one source value is \s-1NAN\s0 the complete sliding window is affected. The \s-1TRENDNAN\s0 operation ignores all NAN-values in a sliding window and computes the average of the remaining values. @@ -330,7 +328,7 @@ CDEF:predict=172800,86400,2,1800,x,PREDICT This will create a half-hour (1800 second) sliding window average/sigma of x, that average is essentially computed as shown here: .Sp -.Vb 18 +.Vb 10 \& +\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-!\-\-\-> \& now \& shift 1 t0 @@ -349,16 +347,14 @@ average is essentially computed as shown here: \& <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-> \& window \& <\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-> -.Ve -.Sp -.Vb 4 +\& \& Value at sample (t0) will be the average between (t0\-shift1\-window) and (t0\-shift1) \& and between (t0\-shift2\-window) and (t0\-shift2) \& Value at sample (t1) will be the average between (t1\-shift1\-window) and (t1\-shift1) \& and between (t1\-shift2\-window) and (t1\-shift2) .Ve .Sp -The function is by design NAN\-safe. +The function is by design NAN-safe. This also allows for extrapolation into the future (say a few days) \&\- you may need to define the data series whit the optional start= parameter, so that the source data series has enough data to provide prediction also at the beginning of a graph... @@ -421,7 +417,7 @@ 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. +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 @@ -444,7 +440,7 @@ in the examples section below on how to use this. Duplicate the top element, remove the top element, exchange the two top elements. .Sp -\&\& + .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. @@ -497,7 +493,7 @@ 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. +and represents the quality of fit for the approximation. .Sp Example: \f(CW\*(C`VDEF:slope=mydata,LSLSLOPE\*(C'\fR .SH "SEE ALSO"