X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph.pod;h=848567500d4981b129faa5744c29daff589e8ccd;hp=9060bd831b97d695edbe6d1ac3392bd79174ee4d;hb=04ed1c285ff739ad2cd1384e6cfe24aea82cfa7e;hpb=6a2ad1ab269ec4c1dab0a47eecd4570f4e842a7f diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod index 9060bd8..8485675 100644 --- a/doc/rrdgraph.pod +++ b/doc/rrdgraph.pod @@ -91,10 +91,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 @@ -141,13 +146,10 @@ 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. =item Grid @@ -292,32 +294,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 @@ -334,6 +360,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>] @@ -379,6 +407,27 @@ 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 =head1 SEE ALSO