X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph.src;h=ae3f8a68bd962f0ee767735cba481babe676ac5a;hp=8bd8a1ee810673ca394b60a031f793a5f58fc254;hb=d828f3eccac8dbad7bfc14812e406377669baaa4;hpb=87264104167c04f84e61e3580292217269bab14f diff --git a/doc/rrdgraph.src b/doc/rrdgraph.src index 8bd8a1e..ae3f8a6 100644 --- a/doc/rrdgraph.src +++ b/doc/rrdgraph.src @@ -1,6 +1,6 @@ =include name -=head1 SYNOPSYS +=head1 SYNOPSIS B I [EB>E ...] @@ -60,7 +60,7 @@ statements (after all, most of them do define graph elements...). =item filename The name and path of the graph to generate. It is recommended to -end this in C<.png>, C<.svg> or C<.eps> but B does not enforce this. +end this in C<.png>, C<.svg> or C<.eps> but B does not enforce this. I can be 'C<->' to send the image to C. In that case, no other output is generated. @@ -102,13 +102,13 @@ Z<> =item Size B<[-w|--width EpixelsE]> -B<[-h|--heigth EpixelsE]> +B<[-h|--height EpixelsE]> B<[-j|--only-graph]> The width and height of the B (the part of the graph with the actual lines and such). Defaults are 400 pixels by 100 pixels. -If you sepcify the B<--only-graph> and set the hight < 32 pixels you will +If you specify the B<--only-graph> and set the height < 32 pixels you will get a tiny graph image to use as an icon in a potential overview. All labeling will be stripped off the graph. @@ -138,7 +138,7 @@ By default the graph will be autoscaling so that it displays the portion of the y-axis that is actually used. You can change this behaviour by setting the limits. The displayed y-axis will show at most B and at least B -at the top, and similarily at least B and +at the top, and similarly at least B and at most B at the bottom. The default is to display at most B (so: no limit) and at least B (no minimal value) at the top. The bottom of @@ -178,9 +178,9 @@ and thus the throughput may be higher than the WAN line speed. B<[-N|--no-gridfit]> -To avoid antialiasing effects gridlines are placed on +To avoid anti-aliasing effects gridlines are placed on integer pixel values. This is by default done by extending -the scale so gridlines happends to be spaced using an +the scale so gridlines happens to be spaced using an integer number of pixels, and starts on integer pixel value. This might extend the scale too much for some logarithmic scales and for linear scales where --alt-autoscale is needed. @@ -215,7 +215,7 @@ in I and a I format string in I. I defines where each label will be placed. If it is zero, the label will be placed right under the corresponding line (useful for hours, dates etcetera). If you specify a number of seconds here the label is -centered in this interval (useful for monday, januari etcetera). +centered in this interval (useful for Monday, January etcetera). Example: C<--x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X> @@ -297,7 +297,7 @@ left and top border, C for the right and bottom border, C, C for the major grid, C, C and axis, C. Each color is composed out of three hexadecimal numbers specifying its color component (00 is off, FF is maximum) of red, green and blue. -Optionally you may add another hexademimal number specifying the +Optionally you may add another hexadecimal number specifying the transparency (FF is solid). You may set this option several times to alter multiple defaults. @@ -310,7 +310,7 @@ Zoom the graphics by the given amount ... The factor must be E 0 B<[-n|--font IB<:>IB<:>I]> 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, +RRD graphs. C<DEFAULT> sets the default value for all elements C<TITLE>, C<AXIS> for the axis labels, C<UNIT> for the vertical unit label, C<LEGEND> for the graph legend.