updated spec file -- Chris Adams <cmadams@hiwaay.net>

[rrdtool.git] / doc / rrdgraph.src

diff --git a/doc/rrdgraph.src b/doc/rrdgraph.src
index 89b4268..8bd8a1e 100644 (file)
--- a/doc/rrdgraph.src
+++ b/doc/rrdgraph.src
@@ -12,7 +12,7 @@ E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt>[ ...]
 
 =head1 DESCRIPTION
 
-The B<graph> function of B<RRDtool> is used to represent the
+The B<graph> function of B<RRDtool> is used to present the
 data from an B<RRD> to a human viewer.  Its main purpose is to
 create a nice graphical representation but it can also generate
 a numerical report.
@@ -71,7 +71,7 @@ Z<>
 
 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
@@ -103,10 +103,15 @@ Z<>
 
 B<[-w|--width E<lt>pixelsE<gt>]>
 B<[-h|--heigth E<lt>pixelsE<gt>]>
+B<[-j|--only-graph]>
 
 The width and height of the B<canvas> (the part of the graph with
 the actual lines and such). Defaults are 400 pixels by 100 pixels.
 
+If you sepcify the B<--only-graph> and set the hight < 32 pixels you will
+get a tiny graph image to use as an icon in a potential overview. All
+labeling will be stripped off the graph.
+
 Z<>
 
 =item Limits
@@ -153,7 +158,7 @@ To mimic the old B<rigid> option, you can do:
 --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
@@ -163,7 +168,7 @@ maximum y-axis from the actual minimum and maximum values. Our example
 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
@@ -171,7 +176,7 @@ 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.
 
-B<[--no-gridfit]>
+B<[-N|--no-gridfit]>
 
 To avoid antialiasing effects gridlines are placed on 
 integer pixel values. This is by default done by extending 
@@ -237,7 +242,7 @@ 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
@@ -248,7 +253,7 @@ B<[-o|--logarithmic]>
 
 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