X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph-old.pod;h=ac661a9a85c0abc5dad8d64c3c8cdf0982745c74;hp=b464c4266408ba496dbc576dae382c2ae0b67beb;hb=dc4997373f9cc1c170bc378ff12fa2c3a23161e9;hpb=0fe03275068c0e55d01a7cc2308fa12fdee569cf
diff --git a/doc/rrdgraph-old.pod b/doc/rrdgraph-old.pod
index b464c42..ac661a9 100644
--- a/doc/rrdgraph-old.pod
+++ b/doc/rrdgraph-old.pod
@@ -2,32 +2,32 @@
rrdtool graph - Create a graph based on data from one or several RRD
-=for html
+=for html
=head1 SYNOPSIS
-B B I
-S<[B<-s>|B<--start> I]>
+B B I
+S<[B<-s>|B<--start> I]>
S<[B<-e>|B<--end> I]>
S<[B<-x>|B<--x-grid> I]>
S<[B<-y>|B<--y-grid> I]>
-S<[B<--alt-y-grid>]>
-S<[B<--alt-autoscale>]>
-S<[B<--alt-autoscale-max>]>
-S<[B<--units-exponent>]> I]>
+S<[B<-Y>|B<--alt-y-grid>]>
+S<[B<-A>|B<--alt-autoscale>]>
+S<[B<-M>|B<--alt-autoscale-max>]>
+S<[B<-X>|B<--units-exponent>]> I]>
S<[B<-v>|B<--vertical-label> I]>
S<[B<-w>|B<--width> I]>
-S<[B<-h>|B<--height> I]>
-S<[B<-i>|B<--interlaced>]>
-S<[B<-f>|B<--imginfo> I]>
-S<[B<-a>|B<--imgformat> B|B]>
-S<[B<-z>|B<--lazy>]>
+S<[B<-h>|B<--height> I]>
+S<[B<-i>|B<--interlaced>]>
+S<[B<-f>|B<--imginfo> I]>
+S<[B<-a>|B<--imgformat> B|B]>
+S<[B<-z>|B<--lazy>]>
S<[B<-o>|B<--logarithmic>]>
-S<[B<-u>|B<--upper-limit> I]>
+S<[B<-u>|B<--upper-limit> I]>
S<[B<-l>|B<--lower-limit> I]>
S<[B<-g>|B<--no-legend>]>
S<[B<-r>|B<--rigid>]>
-S<[B<--step> I]>
+S<[B<-S>|B<--step> I]>
S<[B<-b>|B<--base> I]>
S<[B<-c>|B<--color> IB<#>I]>
S<[B<-t>|B<--title> I]>
@@ -51,11 +51,11 @@ from generating graphs, it can also extract numerical reports.
=over
-=item I<filename>
+=item I<filename>
-The name of the graph to generate. Since B<rrdtool> outputs
+The name of the graph to generate. Since B<RRDtool> outputs
SVGs and PNGs, it's recommended that the filename end in either
-F<.svg> or F<.png>. B<rrdtool> does not enforce this, however.
+F<.svg> or F<.png>. B<RRDtool> does not enforce this, however.
If the I<filename> is set to '-' the image file will be written
to standard out. All other output will get suppressed.
@@ -78,7 +78,7 @@ documentation for a detailed explanation of ways to specify time.
=item B<-x>|B<--x-grid> I<x-axis grid and label> (default autoconfigure)
The x-axis label is quite complex to configure. So if you don't have
-very special needs, you can rely on the autoconfiguration to get this
+very special needs, you can rely on the auto configuration to get this
right.
If you want no x-grid at all, use the magic setting B<none>.
@@ -115,7 +115,7 @@ you make sure that this happens.
=item B<-y>|B<--y-grid> I<grid step>:I<label factor> (default autoconfigure)
Makes vertical grid lines appear at I<grid step> interval. Every
-I<label factor> gridstep, a major grid line is printed, along with
+I<label factor> grid step, a major grid line is printed, along with
label showing the value of the grid line.
If you want no y-grid at all set specify the magic word B<none>.
@@ -124,16 +124,16 @@ If you want no y-grid at all set specify the magic word B<none>.
Place Y grid dynamically based on graph Y range. Algorithm ensures
that you always have grid, that there are enough but not too many
-grid lines and the grid is metric. That is grid lines are placed
+grid lines and the grid is metric. That is grid lines are placed
every 1, 2, 5 or 10 units. (contributed by Sasha Mikheev)
=item B<--alt-autoscale>
-Compute Y range based on function absolute minimum and
-maximum values. Default algorithm uses predefined set of ranges.
+Compute Y range based on function absolute minimum and
+maximum values. Default algorithm uses predefined set of ranges.
This is good in many cases but it fails miserably when you need
-to graph something like 260 + 0.001 * sin(x). Default algorithm
+to graph something like 260 + 0.001 * sin(x). Default algorithm
will use Y range from 250 to 300 and on the graph you will see
almost straight line. With --alt-autoscale Y range will be
from slightly less the 260 - 0.001 to slightly more then 260 + 0.001
@@ -142,7 +142,7 @@ and periodic behavior will be seen. (contributed by Sasha Mikheev)
=item B<--alt-autoscale-max>
Where --alt-autoscale will modify both the absolute maximum AND minimum
-values, this option will only affect the maximum value. The minimum
+values, this option will only affect the maximum value. The minimum
value, if not defined on the command line, will be 0. This option can
be useful when graphing router traffic when the WAN line uses compression,
and thus the throughput may be higher than the WAN line speed.
@@ -161,7 +161,7 @@ of 0 to prevent any scaling of the y-axis values.
=item B<-v>|B<--vertical-label> I<text>
-vertical label on the left side of the graph. This is normally used to
+Vertical label on the left side of the graph. This is normally used to
specify the units used.
=item B<-w>|B<--width> I<pixels> (default 400 pixel)
@@ -196,7 +196,7 @@ would look like this:
=item B<-a>|B<--imgformat> B<SVG>|B<PNG> (default: PNG)
-Allows you to produce PNG output from rrdtool.
+Allows you to produce PNG output from RRDtool.
=item B<-z>|B<--lazy> (default: false)
@@ -207,7 +207,7 @@ existent.
Defines the value normally located at the upper border of the
graph. If the graph contains higher values, the upper border will
-move upwards to accomodate these values as well.
+move upward to accommodate these values as well.
If you want to define an upper-limit which will not move in any
event you have to set the B<--rigid> option as well.
@@ -253,11 +253,11 @@ Define a title to be written into the graph
=item B<--step> I<value> (default automatic)
-By default rrdgraph calculates the width of one pixle in the time domain and
+By default rrdgraph calculates the width of one pixel in the time domain and
tries to get data at that resolution from the RRD. With this switch you can
-override this behaviour. If you want rrdgraph to get data at 1 hour
+override this behavior. If you want rrdgraph to get data at 1 hour
resolution from the RRD, then you can set the step to 3600 seconds. Note,
-that a step smaller than 1 pixle will be silently ignored.
+that a step smaller than 1 pixel will be silently ignored.
=item B<DEF:>I<vname>B<=>I<rrd>B<:>I<ds-name>B<:>I<CF>
@@ -274,11 +274,11 @@ consolidated according to the consolidation function (I<CF>) chosen.
Create a new virtual data source by evaluating a mathematical expression,
specified in Reverse Polish Notation (RPN). If you have ever used a traditional
-HP calculator you already know RPN. The idea behind RPN notation is,
+HP calculator you already know RPN. The idea behind RPN notation is,
that you have a stack and push your data onto this stack. When ever
you execute an operation, it takes as many data values from the stack
as needed. The pushing of data is implicit, so when ever you specify a number
-or a variable, it gets pushed automatically.
+or a variable, it gets pushed automatically.
If this is all a big load of incomprehensible words for you, maybe an
example helps (a more complete explanation is given in [1]): The
@@ -294,30 +294,30 @@ expression.
The I<rpn-expression> in the B<CDEF> function takes both, constant values
as well as I<vname> variables. The following operators can be used on these
-values:
+values:
=over
=item +, -, *, /, %
-pops two values from the stack applies the selected operator and pushes
+Pops two values from the stack applies the selected operator and pushes
the result back onto the stack. The % operator stands for the modulo
operation.
=item SIN, COS, LOG, EXP, FLOOR, CEIL
-pops one value from the stack, applies the selected function and pushes
+Pops one value from the stack, applies the selected function and pushes
the result back onto the stack.
=item LT, LE, GT, GE, EQ
-pops two values from the stack, compares them according to the selected
+Pops two values from the stack, compares them according to the selected
condition and pushes either 1 back onto the stack if the condition is true
and 0 if the condition was not true.
=item IF
-pops three values from the stack. If the last value is not 0, the
+Pops three values from the stack. If the last value is not 0, the
second value will be pushed back onto the stack, otherwise the
first value is pushed back.
@@ -328,11 +328,11 @@ E will be sent back to the stack.
=item MIN, MAX
-selects the lesser or larger of the two top stack values respectively
+Selects the lesser or larger of the two top stack values respectively
=item LIMIT
-replaces the value with I<*UNKNOWN*> if it is outside the limits specified
+Replaces the value with I<*UNKNOWN*> if it is outside the limits specified
by the two values above it on the stack.
CDEF:a=alpha,0,100,LIMIT
@@ -360,6 +360,13 @@ Push I<*UNKNOWN*> if its at the first value of a data set or otherwise
the value of this CDEF at the previous time step. This allows you to
perform calculations across the data.
+=item COUNT
+
+Pushes the number 1 if it is at the first value of the data set, the
+number 2 if it is at the second, and so on. This special value, allows
+you to make calculations based on the position of the value within
+the data set.
+
=item INF, NEGINF
Push a positive or negative infinite (oo) value onto the stack. When
@@ -384,7 +391,7 @@ offset would be 2*3600 seconds, as Zurich at that time of year is 2
hours ahead of UTC.
Note that the timezone offset is always calculated for the time the
-current sample was taken at. It has nuthing todo with the time you are
+current sample was taken at. It has nothing to do with the time you are
doing the calculation.
=back
@@ -399,7 +406,7 @@ message but not a I<vname> fourtytwo that's always equal to 42.
Calculate the chosen consolidation function I<CF> over the data-source
variable I<vname> and C<printf> the result to stdout using I<format>.
-In the I<format> string there should be a '%lf' or '%le' marker in the
+In the I<format> string there should be a '%lf', '%le' or'%lg' marker in the
place where the number should be printed.
If an additional '%s' is found AFTER the marker, the value will be scaled
@@ -449,15 +456,15 @@ Draw a vertical rule into the graph and optionally add a legend
=item B<LINE>{B<1>|B<2>|B<3>}B<:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]
Plot for the requested data, using the color specified. Write a legend
-into the graph. The 3 possible keywords B<LINE1>, B<LINE2>, and B<LINE3>
-generate increasingly wide lines. If no color is defined,
-the drawing is done 'blind' this is useful in connection with the
-B<STACK> function when you want to ADD the values of two
+into the graph. The 3 possible keywords B<LINE1>, B<LINE2>, and B<LINE3>
+generate increasingly wide lines. If no color is defined,
+the drawing is done 'blind' this is useful in connection with the
+B<STACK> function when you want to ADD the values of two
data-sources without showing it in the graph.
=item B<AREA>:I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]
-Does the same as B<LINE?>, but the area between 0 and
+Does the same as B<LINE?>, but the area between 0 and
the graph will be filled with the color specified.
=item B<STACK>:I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]
@@ -467,9 +474,9 @@ B<LINE?>, B<AREA> or B<STACK> graph. Depending on the type of the
previous graph, the B<STACK> will be either a B<LINE?> or an B<AREA>.
This obviously implies that the first B<STACK> must be preceded by an
B<AREA> or B<LINE?> -- you need something to stack something onto in
-the first place ;)
+the first place ;)
-Note, that when you STACK onto *UNKNOWN* data, rrdtool will not draw
+Note, that when you STACK onto *UNKNOWN* data, RRDtool will not draw
any graphics ... *UNKNOWN* is not zero ... if you want it to be zero
then you might want to use a CDEF argument with IF and UN functions to
turn *UNKNOWN* into zero ...
@@ -506,9 +513,9 @@ example showing how to use centered formating.
Normally there are two space characters inserted between every two items
printed into the graph. The space following a string can be suppressed by
-putting a B<\g> at the end of the string. The B<\g> also squshes any space
+putting a B<\g> at the end of the string. The B<\g> also ignores any space
inside the string if it is at the very end of the string. This can be used
-in connection with B<%s> to supress empty unit strings.
+in connection with B<%s> to suppress empty unit strings.
GPRINT:a:MAX:%lf%s\g
@@ -518,7 +525,7 @@ before placing the next row of legends.
=head1 NOTE on Return Values
Whenever rrd_graph gets called, it prints a line telling the size of
-the image it has just created to STDOUT. This line looks like this: XSIZExYSIZE.
+the image it has just created to stdout. This line looks like this: XSIZExYSIZE.
=head1 EXAMPLE 1
@@ -544,15 +551,15 @@ doesn't match.
CDEF:aggoutput=odat1,UN,0,odat1,IF,odat2,UN,0,odat2,IF,+,8,* \
AREA:agginput#00cc00:Input Aggregate \
LINE1:agginput#0000FF:Output Aggregate
-
-Assuming that idat1 has a data value of I<*UNKNOWN*>, the CDEF expression
- idat1,UN,0,idat1,IF
+Assuming that idat1 has a data value of I<*UNKNOWN*>, the CDEF expression
+
+ idat1,UN,0,idat1,IF
leaves us with a stack with contents of 1,0,NaN and the IF function
will pop off the 3 values and replace them with 0. If idat1 had a
real value like 7942099, then the stack would have 0,0,7942099 and the
-real value would be the replacement.
+real value would be the replacement.
=head1 EXAMPLE 3
@@ -590,8 +597,8 @@ not least, overlay everything with eye-hurting red
to signal any unknown data.
Note that this example assumes that your data is in the positive half of the y-axis
-otherwhise you would would have to add NEGINF in order to extend the coverage
-of the rea to whole graph.
+otherwise you would would have to add NEGINF in order to extend the coverage
+of the area to whole graph.
=head1 EXAMPLE 4
@@ -650,7 +657,7 @@ be misleading.
=head1 AUTHOR
-Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
=head1 REFERENCES