prepare for the release of rrdtool-1.3rc8

[rrdtool.git] / doc / rrdgraph.pod

diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod
index 812b247..159d6af 100644 (file)
--- a/doc/rrdgraph.pod
+++ b/doc/rrdgraph.pod
@@ -4,7 +4,7 @@ rrdgraph - Round Robin Database tool grapher functions
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<rrdtool graph> I<filename>
+B<rrdtool graph|graphv> I<filename>

 [I<L<option|rrdgraph/OPTIONS>> ...]
 [I<L<data definition|rrdgraph_data/DEF>> ...]
 [I<L<data calculation|rrdgraph_data/CDEF>> ...]
 [I<L<option|rrdgraph/OPTIONS>> ...]
 [I<L<data definition|rrdgraph_data/DEF>> ...]
 [I<L<data calculation|rrdgraph_data/CDEF>> ...]


@@ -52,6 +52,14 @@ graph it (or print it).  This ends the B<rrdtool graph> sequence.
 
 =over 4
 
 
 =over 4
 

+=item B<graphv>
+
+This alternate version of B<graph> takes the same arguments and performs the
+same function. The I<v> stands for I<verbose>, which describes the output
+returned. B<graphv> will return a lot of information about the graph using
+the same format as rrdtool info (key = value). See the bottom of the document for more information.
+
+

 =item filename
 
 The name and path of the graph to generate. It is recommended to
 =item filename
 
 The name and path of the graph to generate. It is recommended to


@@ -146,13 +154,12 @@ and thus the throughput may be higher than the WAN line speed.
 
 [B<-N>|B<--no-gridfit>]
 
 
 [B<-N>|B<--no-gridfit>]
 

-In order to avoid anti-aliasing effects gridlines are placed on
-integer pixel values. This is by default done by extending
-the scale so that gridlines happens to be spaced using an
-integer number of pixels and also start on an integer pixel value.
-This might extend the scale too much for some logarithmic scales
-and for linear scales where B<--alt-autoscale> is needed.
-Using B<--no-gridfit> disables modification of the scale.
+In order to avoid anti-aliasing blurring effects rrdtool snaps
+points to device resolution pixels, this results in a crisper
+aperance. If this is not to your liking, you can use this switch
+to turn this behaviour off.
+
+Gridfitting is turned off for PDF, EPS, SVG output by default.

 
 =item Grid
 
 
 =item Grid
 


@@ -187,7 +194,7 @@ This places grid lines every 10 minutes, major grid lines every hour,
 and labels every 4 hours. The labels are placed under the major grid
 lines as they specify exactly that time.
 
 and labels every 4 hours. The labels are placed under the major grid
 lines as they specify exactly that time.
 

- --x-grid HOUR:8:DAY:1:DAY:1:0:%A
+ --x-grid HOUR:8:DAY:1:DAY:1:86400:%A

 
 This places grid lines every 8 hours, major grid lines and labels
 each day. The labels are placed exactly between two major grid lines
 
 This places grid lines every 8 hours, major grid lines and labels
 each day. The labels are placed exactly between two major grid lines


@@ -320,13 +327,16 @@ gravity, and I<SIZE> is a decimal number (size in points) or optionally
 followed by the unit modifier "px" for absolute size. Any one of the options
 may be absent.
 
 followed by the unit modifier "px" for absolute size. Any one of the options
 may be absent.
 

-[B<-R>|B<--font-render-mode> {I<normal>,I<light>,I<mono>}]
+[B<-R>|B<--font-render-mode> {B<normal>,B<light>,B<mono>}]

 
 

-(this gets ignored in 1.3 for now!)
+There are 3 font render modes:
+
+B<normal>: Full Hinting and Antialiasing (default)
+
+B<light>: Slight Hinting and Antialiasing
+
+B<mono>: Full Hinting and NO Antialiasing

 
 

-This lets you customize the strength of the font smoothing,
-or disable it entirely using I<mono>. By default, I<normal>
-font smoothing is used.

 
 [B<-B>|B<--font-smoothing-threshold> I<size>]
 
 
 [B<-B>|B<--font-smoothing-threshold> I<size>]
 


@@ -336,6 +346,36 @@ This specifies the largest font size which will be rendered
 bitmapped, that is, without any font smoothing. By default,
 no text is rendered bitmapped.
 
 bitmapped, that is, without any font smoothing. By default,
 no text is rendered bitmapped.
 

+[B<-P>|B<--pango-markup>]
+
+All text in rrdtool is rendered using Pango. With the B<--pango-markup> option, all
+text will be processed by pango markup. This allows to embed some simple html
+like markup tags using 
+ 
+ <span key="value">text</span>
+
+Apart from the verbose syntax, there are also the following short tags available.
+
+ b     Bold
+ big   Makes font relatively larger, equivalent to <span size="larger">
+ i     Italic
+ s     Strikethrough
+ sub   Subscript
+ sup   Superscript
+ small Makes font relatively smaller, equivalent to <span size="smaller">
+ tt    Monospace font
+ u     Underline 
+ 
+More details on L<http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html>.
+
+[B<-G>|B<--graph-render-mode> {B<normal>,B<mono>}]
+
+There are 2 render modes:
+
+B<normal>: Graphs are fully Antialiased (default)
+
+B<mono>: No Antialiasing
+

 [B<-E>|B<--slope-mode>]
 
 RRDtool graphs are composed of stair case curves by default. This is in line with
 [B<-E>|B<--slope-mode>]
 
 RRDtool graphs are composed of stair case curves by default. This is in line with


@@ -399,29 +439,37 @@ You need at least one graph element to generate an image and/or
 at least one print statement to generate a report.
 See L<rrdgraph_graph> for the exact format.
 
 at least one print statement to generate a report.
 See L<rrdgraph_graph> for the exact format.
 

-=item Markup
-
-All text in rrdtool is rendered using Pango markup. This means text can contain embeded markup instructions.
-Simple html markup using 
- 
- <span key="value">text</span>
-
-can be used. Apart from the verbose syntax, there are also the following short tags available.
-
- b     Bold
- big   Makes font relatively larger, equivalent to <span size="larger">
- i     Italic
- s     Strikethrough
- sub   Subscript
- sup   Superscript
- small Makes font relatively smaller, equivalent to <span size="smaller">
- tt    Monospace font
- u     Underline 
- 
-More details on http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html.

 
 =back
 
 
 =back
 

+=head2 graphv
+
+Calling rrdtool with the graphv option will return information in the
+rrdtool info format. On the command line this means that all output will be
+in key=value format. When used from the perl and ruby bindings a hash
+pointer will be returned from the call.
+
+When the filename '-' is given, the contents of the graph itself will also
+be returned through this interface (hash key 'image'). On the command line
+the output will look like this:
+
+ print[0] = "0.020833"
+ print[1] = "0.0440833"
+ graph_left = 51
+ graph_top = 22
+ graph_width = 400
+ graph_height = 100
+ image_width = 481
+ image_height = 154
+ value_min = 0.0000000000e+00
+ value_max = 4.0000000000e-02
+ image = BLOB_SIZE:8196
+ [... 8196 bytes of image data ...]
+
+There is more information returned than in the standard interface.
+Especially the 'graph_*' keys are new. They help applications that want to
+know what is where on the graph.
+

 =head1 SEE ALSO
 
 L<rrdgraph> gives an overview of how B<rrdtool graph> works.
 =head1 SEE ALSO
 
 L<rrdgraph> gives an overview of how B<rrdtool graph> works.