X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph.pod;h=9a2f752d46cb8b1449c82093e2c1b2372b9093a3;hp=89ea6f75cb409af48f0e80d45d54de5bbffaadbd;hb=22129bb15a8ad204cf8a5e88e8834ec0b51908c0;hpb=02e00a5b3ef9181c8233c59da672732ece15d47d diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod index 89ea6f7..9a2f752 100644 --- a/doc/rrdgraph.pod +++ b/doc/rrdgraph.pod @@ -43,7 +43,7 @@ it. For instance, you might be collecting B per second, but want to display B per second. This is what the B> command is designed for. After B the data, a copy is made and this copy is modified -using a rather powerful B> command set. +using a rather powerful B> command set. When you are done fetching and processing the data, it is time to graph it (or print it). This ends the B sequence. @@ -77,7 +77,7 @@ The start and end of the time series you would like to display, and which B the data should come from. Defaults are: 1 day ago until now, with the best possible resolution. B and B can be specified in several formats, see -L and L. +L and L. By default, B calculates the width of one pixel in the time domain and tries to get data from an B with that resolution. With the B option you can alter this behaviour. @@ -248,7 +248,7 @@ to the more robust B<--alt-y-grid> mode. How many digits should rrdtool assume the y-axis labels to be? You may have to use this option to make enough space once you start -fideling with the y-axis labeling. +fiddling with the y-axis labeling. [B<--units=si>] @@ -267,6 +267,15 @@ Note, that only the image size will be returned, if you run with lazy even when using graphv and even when using PRINT. +[B<--daemon> I
] + +Address of the L daemon. If specified, a C command is sent +to the server before reading the RRD files. This allows the graph to contain +fresh data even if the daemon is configured to cache values for a long time. +For a list of accepted formats, see the B<-l> option in the L manual. + + rrdtool graph [...] --daemon unix:/var/run/rrdcached.sock [...] + [B<-f>|B<--imginfo> I] After the image has been created, the graph function uses printf @@ -285,7 +294,7 @@ I is one of C background, C for the background of the actual graph, C for the left and top border, C for the right and bottom border, C, C for the major grid, C for the color of the font, C for the axis of the graph, C for the -line around the color spots and finally C for the arrow head pointing +line around the color spots, and finally C for the arrow head pointing up and forward. Each color is composed out of three hexadecimal numbers specifying its rgb color component (00 is off, FF is maximum) of red, green and blue. Optionally you may add another hexadecimal number specifying the @@ -300,10 +309,11 @@ Zoom the graphics by the given amount. The factor must be E 0 [B<-n>|B<--font> IB<:>IB<:>[I]] -This lets you customize which font to use for the various text -elements on the RRD graphs. C sets the default value for all -elements, C for the title, C<AXIS> for the axis labels, C<UNIT> -for the vertical unit label, C<LEGEND> for the graph legend. +This 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> +for the title, C<AXIS> for the axis labels, C<UNIT> for the vertical unit +label, C<LEGEND> for the graph legend, C<WATERMARK> for the watermark on the +edge of the graph. Use Times for the title: C<--font TITLE:13:Times> @@ -352,7 +362,7 @@ no text is rendered bitmapped. 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. @@ -366,7 +376,7 @@ Apart from the verbose syntax, there are also the following short tags available 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>}] @@ -434,15 +444,12 @@ You need at least one B<DEF> statement to generate anything. The other statements are useful but optional. See L<rrdgraph_data> and L<rrdgraph_rpn> for the exact format. -=head2 Graph and print elements +NOTE: B<Graph and print elements> 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. - -=back - =head2 graphv Calling rrdtool with the graphv option will return information in the @@ -471,6 +478,21 @@ 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 ENVIRONMENT VARIABLES + +The following environment variables may be used to change the behavior of +C<rrdtoolE<nbsp>graph>: + +=over 4 + +=item B<RRDCACHED_ADDRESS> + +If this environment variable is set it will have the same effect as specifying +the C<--daemon> option on the command line. If both are present, the command +line argument takes precedence. + +=back + =head1 SEE ALSO L<rrdgraph> gives an overview of how B<rrdtool graph> works.