X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph.src;h=7f912bed5c5cb7f36eea08aac3cabdbf55fd2837;hb=85531c9fe3758d08f782503f888fff12b7c002f5;hp=69a2fc9141476d8046ef3018f560b493f3b9a54d;hpb=200476039d2419e66e925c422099e062390880c0;p=rrdtool.git diff --git a/doc/rrdgraph.src b/doc/rrdgraph.src index 69a2fc9..7f912be 100644 --- a/doc/rrdgraph.src +++ b/doc/rrdgraph.src @@ -26,16 +26,15 @@ collect data from two or more databases (one per statement though). If you want to display averages, maxima, percentiles etcetera it is best to collect them now using the -B> statement. At this -stage, this command works at the unprocessed data from the B. -I<(Note: this is not yet true; it works on consolidated information -right now)> +B> statement. +Currently this makes no difference but in a future version +of rrdtool you may want to collect these values before consolidation. The data fetched from the B is then B so that there is exactly one datapoint per pixel in the graph. If you do not take care yourself, B will expand the range slightly -if necessary (in that case the first pixel may very well become -unknown!). +if necessary (in that case the first and/or last pixel may very +well become unknown!). Sometimes data is not exactly as you would like to display it. For instance, you might be collecting B per second but want to @@ -43,18 +42,13 @@ display B per second. This is where the B> command is designed for. After B the data, a copy is made and this copy is modified using a rather flexible B> command -set. If you use B> -statements after this, they work on the consolidated data and may -return other values for maximum, minimum etcetera! +set. When you are done fetching and processing the data, it is time to graph it (or print it). This ends the B sequence. =head1 OPTIONS -It is expected that most options will move to the graph definition -statements (after all, most of them do define graph elements...). - =over 4 =item filename @@ -93,9 +87,7 @@ B<[-t|--title EstringE]> B<[-v|--vertical-label EstringE]> A horizontal string at the top of the graph and/or a vertically -placed string at the left hand side of the graph. I The string can contain formatter options that -are used to include variables (from Bs) and newlines. +placed string at the left hand side of the graph. Z<> @@ -108,15 +100,14 @@ 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 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. +If you specify the B<--only-graph> option and set the height E 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. Z<> =item Limits -I B<[-u|--upper-limit EvalueE]> B<[-l|--lower-limit EvalueE]> B<[-r|--rigid]> @@ -128,36 +119,6 @@ at least from B to B. Autoscaling will still permit those boundaries to be stretched unless the B option is set. -I -B<[--maximum-upper-limit EvalueE]> -B<[--minimum-upper-limit EvalueE]> -B<[--maximum-lower-limit EvalueE]> -B<[--minimum-lower-limit EvalueE]> - -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 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 -the graph has similar defaults. Note that the minimum lower limit -is the lowest one so you should compare this with maximum upper -limit when you try to figure out what you should set. - -To make sure the graph shows the range of I<-1000> to I<2000>, -optionally expanding to no more than I<-3000> to I<4000>, -set the following options: - ---maximum-upper-limit 4000 --minimum-upper-limit 2000 ---maximum-lower-limit -1000 --minimum-lower-limit -3000 - -To mimic the old B option, you can do: - ---maximum-upper-limit 4000 --minimum-upper-limit 4000 ---maximum-lower-limit -3000 --minimum-lower-limit -3000 - B<[-A|--alt-autoscale]> Sometimes the default algorithm for selecting the y-axis scale is not