X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph.pod;h=54fd5b0cbae83ada1ff137f7b4a9ca90c6e20418;hb=92b77493980c67a4fde8ae001ac4b939210d6a8d;hp=b605fae5de2cf5e994e8b2bf077d36e38c68f36e;hpb=f8c81c20d9fe8183cb481944cd9b29ace3ee37aa;p=rrdtool.git diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod index b605fae..54fd5b0 100644 --- a/doc/rrdgraph.pod +++ b/doc/rrdgraph.pod @@ -4,7 +4,7 @@ rrdgraph - Round Robin Database tool grapher functions =head1 SYNOPSIS -B I +B I [I> ...] [I> ...] [I> ...] @@ -52,6 +52,14 @@ graph it (or print it). This ends the B sequence. =over 4 +=item B + +This alternate version of B takes the same arguments and performs the +same function. The I stands for I, which describes the output +returned. B 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 @@ -186,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. - --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 @@ -432,6 +440,34 @@ More details on http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.h =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 gives an overview of how B works.