projects
/
rrdtool.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
remove pdf link
[rrdtool.git]
/
doc
/
rrdgraph-old.pod
diff --git
a/doc/rrdgraph-old.pod
b/doc/rrdgraph-old.pod
index
b464c42
..
1043d69
100644
(file)
--- a/
doc/rrdgraph-old.pod
+++ b/
doc/rrdgraph-old.pod
@@
-11,10
+11,10
@@
S<[B<-s>|B<--start> I<seconds>]>
S<[B<-e>|B<--end> I<seconds>]>
S<[B<-x>|B<--x-grid> I<x-axis grid and label>]>
S<[B<-y>|B<--y-grid> I<y-axis grid and label>]>
S<[B<-e>|B<--end> I<seconds>]>
S<[B<-x>|B<--x-grid> I<x-axis grid and label>]>
S<[B<-y>|B<--y-grid> I<y-axis grid and label>]>
-S<[B<--alt-y-grid>]>
-S<[B<--alt-autoscale>]>
-S<[B<--alt-autoscale-max>]>
-S<[B<--units-exponent>]> I<value>]>
+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<value>]>
S<[B<-v>|B<--vertical-label> I<text>]>
S<[B<-w>|B<--width> I<pixels>]>
S<[B<-h>|B<--height> I<pixels>]>
S<[B<-v>|B<--vertical-label> I<text>]>
S<[B<-w>|B<--width> I<pixels>]>
S<[B<-h>|B<--height> I<pixels>]>
@@
-27,7
+27,7
@@
S<[B<-u>|B<--upper-limit> I<value>]>
S<[B<-l>|B<--lower-limit> I<value>]>
S<[B<-g>|B<--no-legend>]>
S<[B<-r>|B<--rigid>]>
S<[B<-l>|B<--lower-limit> I<value>]>
S<[B<-g>|B<--no-legend>]>
S<[B<-r>|B<--rigid>]>
-S<[B<--step> I<value>]>
+S<[B<-
S>|B<-
-step> I<value>]>
S<[B<-b>|B<--base> I<value>]>
S<[B<-c>|B<--color> I<COLORTAG>B<#>I<rrggbb>]>
S<[B<-t>|B<--title> I<title>]>
S<[B<-b>|B<--base> I<value>]>
S<[B<-c>|B<--color> I<COLORTAG>B<#>I<rrggbb>]>
S<[B<-t>|B<--title> I<title>]>
@@
-53,9
+53,9
@@
from generating graphs, it can also extract numerical reports.
=item I<filename>
=item I<filename>
-The name of the graph to generate. Since B<
rrd
tool> outputs
+The name of the graph to generate. Since B<
RRD
tool> outputs
SVGs and PNGs, it's recommended that the filename end in either
SVGs and PNGs, it's recommended that the filename end in either
-F<.svg> or F<.png>. B<
rrd
tool> does not enforce this, however.
+F<.svg> or F<.png>. B<
RRD
tool> 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.
If the I<filename> is set to '-' the image file will be written
to standard out. All other output will get suppressed.
@@
-196,7
+196,7
@@
would look like this:
=item B<-a>|B<--imgformat> B<SVG>|B<PNG> (default: PNG)
=item B<-a>|B<--imgformat> B<SVG>|B<PNG> (default: PNG)
-Allows you to produce PNG output from
rrd
tool.
+Allows you to produce PNG output from
RRD
tool.
=item B<-z>|B<--lazy> (default: false)
=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
Defines the value normally located at the upper border of the
graph. If the graph contains higher values, the upper border will
-move upward
s to acco
modate these values as well.
+move upward
to accom
modate 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.
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)
=item B<--step> I<value> (default automatic)
-By default rrdgraph calculates the width of one pix
le
in the time domain and
+By default rrdgraph calculates the width of one pix
el
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
resolution from the RRD, then you can set the step to 3600 seconds. Note,
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
resolution from the RRD, then you can set the step to 3600 seconds. Note,
-that a step smaller than 1 pix
le
will be silently ignored.
+that a step smaller than 1 pix
el
will be silently ignored.
=item B<DEF:>I<vname>B<=>I<rrd>B<:>I<ds-name>B<:>I<CF>
=item B<DEF:>I<vname>B<=>I<rrd>B<:>I<ds-name>B<:>I<CF>
@@
-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.
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
=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
hours ahead of UTC.
Note that the timezone offset is always calculated for the time the
-current sample was taken at. It has n
uthing to
do with the time you are
+current sample was taken at. It has n
othing to
do with the time you are
doing the calculation.
=back
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>.
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
place where the number should be printed.
If an additional '%s' is found AFTER the marker, the value will be scaled
@@
-469,7
+476,7
@@
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 ;)
B<AREA> or B<LINE?> -- you need something to stack something onto in
the first place ;)
-Note, that when you STACK onto *UNKNOWN* data,
rrd
tool will not draw
+Note, that when you STACK onto *UNKNOWN* data,
RRD
tool 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 ...
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
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
sqush
es any space
+putting a B<\g> at the end of the string. The B<\g> also
ignor
es any space
inside the string if it is at the very end of the string. This can be used
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 sup
p
ress empty unit strings.
GPRINT:a:MAX:%lf%s\g
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
=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
=head1 EXAMPLE 1
@@
-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
to signal any unknown data.
Note that this example assumes that your data is in the positive half of the y-axis
-otherw
h
ise 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
a
rea to whole graph.
=head1 EXAMPLE 4
=head1 EXAMPLE 4