index 3f9bda8fd251f9217951f3ad223d49ea883359de..0f8489d798ca676c6ef69cde853e98d3c30aa6ad 100644 (file)
--- a/program/doc/rrdgraph.src
+++ b/program/doc/rrdgraph.src
B<rrdtool graph> I<filename>
[E<lt>B<L<option|rrdgraph/OPTIONS>>E<gt> ...]
-E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt>
-[E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt> ...]
+E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt>[ ...]
[E<lt>B<L<data calculation|rrdgraph_data/CDEF>>E<gt> ...]
[E<lt>B<L<variable definition|rrdgraph_data/VDEF>>E<gt> ...]
[E<lt>B<L<graph element|rrdgraph_graph/GRAPH>>E<gt> ...]
=item filename
The name and path of the graph to generate. It is recommended to
-end this in C<.png> or C<.gif> but B<rrdtool> does not enforce this.
+end this in C<.png>, C<.svg> or C<.eps> but B<rrdtool> does not enforce this.
I<filename> can be 'C<->' to send the image to C<stdout>. In
that case, no other output is generated.
B<[-s|--start E<lt>timeE<gt>]>
B<[-e|--end E<lt>timeE<gt>]>
-B<[--step E<lt>secondsE<gt>]>
+B<[-S|--step E<lt>secondsE<gt>]>
The start and end of what you would like to display, and which
B<RRA> the data should come from. Defaults are: 1 day ago until
--maximum-upper-limit 4000 --minimum-upper-limit 4000
--maximum-lower-limit -3000 --minimum-lower-limit -3000
-B<[--alt-autoscale]>
+B<[-A|--alt-autoscale]>
Sometimes the default algorithm for selecting the y-axis scale is not
performing very well. Normally the scale is selected from a predefined
would display slightly less than C<260-0.001> to slightly more than
C<260+0.001> (Contributed by Sasha Mikheev).
-B<[--alt-autoscale-max]>
+B<[-M|--alt-autoscale-max]>
Where C<--alt-autoscale> will modify both the absolute maximum AND minimum
values, this option will only affect the maximum value. The minimum
be useful when graphing router traffic when the WAN line uses compression,
and thus the throughput may be higher than the WAN line speed.
+B<[-N|--no-gridfit]>
+
+To avoid antialiasing effects gridlines are placed on
+integer pixel values. This is by default done by extending
+the scale so gridlines happends to be spaced using an
+integer number of pixels, and starts on integer pixel value.
+This might extend the scale too much for some logarithmic scales
+and for linear scales where --alt-autoscale is needed.
+Using --no-gridfit disables modification of the scale,
+and just truncates y-coordinates to integer values for bitmap
+formats.
+
Z<>
=item Grid
=item X-Axis
-B<[-x|--x-grid E<lt>I<GTMC<:>GSTC<:>MTMC<:>MSTC<:>LTMC<:>LSTC<:>LPRC<:>LFM>E<gt>|C<none>]>
+B<[-x|--x-grid E<lt>I<GTMC<:>GSTC<:>MTMC<:>MSTC<:>LTMC<:>LSTC<:>LPRC<:>LFM>E<gt>]>
+
+B<[-x|--x-grid C<none>]>
The x-axis label is quite complex to configure, if you don't have
very special needs it is probably best to rely on the autoconfiguration
=item Y-Axis
-B<[-y|--y-grid I<E<lt>grid stepE<gt>:E<lt>label factorE<gt>>|C<none>]>
+B<[-y|--y-grid I<E<lt>grid stepE<gt>:E<lt>label factorE<gt>>]>
+
+B<[-y|--y-grid C<none>]>
Y-axis grid lines appear at each I<grid step> interval. Labels are
placed every I<label factor> lines. You can specify C<-y none> to
skip the grid and labels altogether. The default for this option is
to automatically select sensible values.
-B<[--alt-y-grid]>
+B<[-Y|--alt-y-grid]>
Place Y grid dynamically based on graph Y range. Algorithm ensures
that you always have grid, that there are enough but not too many
Logarithmic y-axis scaling.
-B<[--units-exponent E<lt>valueE<gt>]>
+B<[-X|--units-exponent E<lt>valueE<gt>]>
This sets the 10**exponent scaling of the y-axis values. Normally
values will be scaled to the appropriate units (k, M, etc.). However
--imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
-B<[-c|--color I<COLORTAG#rrggbb>]>
+B<[-c|--color I<COLORTAG>#I<rrggbb>[I<aa>]]>
Override the default colors for the standard elements of the graph.
The I<COLORTAG> is one of C<BACK> ground, C<CANVAS>, C<SHADEA> for the
C<MGRID> for the major grid, C<FONT>, C<FRAME> and axis, C<ARROW>.
Each color is composed out of three hexadecimal numbers specifying
its color component (00 is off, FF is maximum) of red, green and blue.
+Optionally you may add another hexademimal number specifying the
+transparency (FF is solid).
You may set this option several times to alter multiple defaults.
A green arrow is made by: C<--color ARROW:00FF00>
-B<[-a|--imgformat C<GIF>|C<PNG>]>
+B<[--zoom I<factor>]>
+
+Zoom the graphics by the given amount ... The factor must be E<gt> 0
+
+B<[-n|--font I<FONTTAG>B<:>I<size>B<:>I<font>]>
+
+Lets you customize which font to use for the various text elements on the
+rrd graphs. C<DEFAULT> sets the default value for all elements C<TITLE>,
+C<AXIS> for the axis labels, C<UNIT> for the vertical unit label, C<LEGEND>
+for the graph legend.
+
+Use Times for the title: C<--font TITLE:13:/usr/lib/fonts/times.ttf>
+
+B<[-a|--imgformat C<PNG>|C<SVG>|C<EPS>|C<PDF>]>
+
+Image format for the generated graph.
+
B<[-i|--interlaced]>
-The default is to generate a non-interlaced GIF image. It is recommended
-to generate PNG graphics as they take up to 40% less disk space and
-20-30% less time to generate.
+If images are interlaced they become visible on browsers more quickly.
B<[-g|--no-legend]>
=item Data and variables
-B<DEF:>I<E<lt>vnameE<gt>>=I<E<lt>rrdfileE<gt>>:I<E<lt>ds-nameE<gt>>:I<E<lt>CFE<gt>>[:[I<E<lt>time rangeE<gt>>][:I<E<lt>step timeE<gt>>]]
+B<DEF:>I<E<lt>vnameE<gt>>=I<E<lt>rrdfileE<gt>>:I<E<lt>ds-nameE<gt>>:I<E<lt>CFE<gt>>[:step=I<E<lt>stepE<gt>>][:start=I<E<lt>timeE<gt>>][:end=I<E<lt>timeE<gt>>]
B<CDEF:>I<E<lt>vnameE<gt>>=I<E<lt>RPN expressionE<gt>>