X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph.pod;h=54fd5b0cbae83ada1ff137f7b4a9ca90c6e20418;hb=92b77493980c67a4fde8ae001ac4b939210d6a8d;hp=59d3ac4ad65910b62e2519ae6abecacc451d0c87;hpb=4414926d4c2ab02e84ffe1d55d26b27632cb18aa;p=rrdtool.git diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod index 59d3ac4..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 @@ -91,10 +99,15 @@ placed string at the left hand side of the graph. [B<-w>|B<--width> I] [B<-h>|B<--height> I] [B<-j>|B<--only-graph>] +[B<-D>|B<--full-size-mode>] -The width and height of the B (the part of the graph with +By default, the width and height of the B (the part with the actual data and such). This defaults to 400 pixels by 100 pixels. +If you specify the B<--full-size-mode> option, the width and height +specify the final dimensions of the output image and the canvas +is automatically resized to fit. + If you specify the B<--only-graph> option and set the height E 32 pixels you will get a tiny graph image (thumbnail) to use as an icon for use in an overview, for example. All labeling will be stripped off @@ -123,6 +136,14 @@ maximum y-axis from the actual minimum and maximum data values. Our example would display slightly less than C<260-0.001> to slightly more than C<260+0.001> (this feature was contributed by Sasha Mikheev). +[B<-J>|B<--alt-autoscale-min>] + +Where C<--alt-autoscale> will modify both the absolute maximum AND minimum +values, this option will only affect the minimum value. The maximum +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<-M>|B<--alt-autoscale-max>] Where C<--alt-autoscale> will modify both the absolute maximum AND minimum @@ -133,13 +154,12 @@ and thus the throughput may be higher than the WAN line speed. [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 @@ -174,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 @@ -284,32 +304,56 @@ 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. -Use Times for the title: C<--font TITLE:13:/usr/lib/fonts/times.ttf> +Use Times for the title: C<--font TITLE:13:Times> If you do not give a font string you can modify just the sice of the default font: C<--font TITLE:13:>. If you specify the size 0 then you can modify just the font without touching the size. This is especially usefull for altering the default font without -resetting the default fontsizes: C<--font DEFAULT:0:/usr/lib/fonts/times.ttf>. +resetting the default fontsizes: C<--font DEFAULT:0:Courier>. RRDtool comes with a preset default font. You can set the environment variable C<RRD_DEFAULT_FONT> if you want to change this. -Truetype fonts are only supported for PNG output. See below. +RRDtool uses Pango for its font handling. This means you can to use +the full Pango syntax when selecting your font: + +The font name has the form "[I<FAMILY-LIST>] [I<STYLE-OPTIONS>] [I<SIZE>]", +where I<FAMILY-LIST> is a comma separated list of families optionally +terminated by a comma, I<STYLE_OPTIONS> is a whitespace separated list of +words where each WORD describes one of style, variant, weight, stretch, or +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. + +[B<-R>|B<--font-render-mode> {B<normal>,B<light>,B<mono>}] + +There are 3 font render modes: -[B<-R>|B<--font-render-mode> {I<normal>,I<light>,I<mono>}] +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>] +(this gets ignored in 1.3 for now!) + This specifies the largest font size which will be rendered bitmapped, that is, without any font smoothing. By default, no text is rendered bitmapped. +[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 @@ -326,6 +370,8 @@ Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats. [B<-i>|B<--interlaced>] +(this gets ignored in 1.3 for now!) + If images are interlaced they become visible on browsers more quickly. [B<-g>|B<--no-legend>] @@ -371,8 +417,57 @@ 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. +=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 +=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.