From: oetiker Date: Sun, 10 Apr 2005 18:10:56 +0000 (+0000) Subject: get the docs ready for the 1.2 release. remove notes about things that never got... X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=commitdiff_plain;h=3392d4474ce348fcee1a65bf8f2d9e9a90b7c8f4 get the docs ready for the 1.2 release. remove notes about things that never got implemented. -- alex git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@390 a5681a0c-68f1-0310-ab6d-d61299d08faa --- diff --git a/doc/name.inc b/doc/name.inc index 056f27f..dffcae4 100644 --- a/doc/name.inc +++ b/doc/name.inc @@ -8,11 +8,4 @@ WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED rrdtool graph - Round Robin Database tool grapher functions -WARNING: This is for version 1.1.x which is B> software. -The software may contain serious bugs. Some of the items -described in here may not yet exist (although this should -be mentioned) or still be in the alpha stage. As with every -other RRDtool release: use at your own risk. In contrast with -the stable version of RRDtool, this release may contain bugs -known to the authors. It is highly recommended that you subscribe -to the mailing list. +Documentation for version 1.2.0 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 diff --git a/doc/rrdgraph_data.src b/doc/rrdgraph_data.src index 1f8fcb7..f5c1114 100644 --- a/doc/rrdgraph_data.src +++ b/doc/rrdgraph_data.src @@ -61,8 +61,7 @@ functions used, have a value and a time component. When you use this I in another B expression, you are effectively inserting its value just as if you had put a number at that place. The variable can also be used in the various graph and print -elements. I [ Everywhere you can insert a -number, you can also use the B (provided that it is set of course) ] +elements. Example: C diff --git a/doc/rrdgraph_examples.src b/doc/rrdgraph_examples.src index a597ece..632c787 100644 --- a/doc/rrdgraph_examples.src +++ b/doc/rrdgraph_examples.src @@ -94,28 +94,16 @@ Note: the second line gets stacked on top of the first one Last 24 hours: Yesterday: --end 00:00 -=head2 Viewing Januari+Februari 2000 and 2001 together - -Define a graph area of 31+29 days (!) spanning Jan. and Feb. - --start 20000101 --end 20000301 - DEF:jan2000=router.rrd:ds0:AVERAGE:start 20000101 end start+31d - DEF:jan2001=router.rrd:ds0:AVERAGE:start 20010101 end start+31d -Note: mind the extra day in 2000 ... - DEF:feb2000=router.rrd:ds0:AVERAGE:start 20000201 end start+29d -Note: 29 feb 2001 is *unknown* - DEF:feb2001=router.rrd:ds0:AVERAGE:start 20010201 end start+28d - VDEF:offset=jan2001,FIRST,jan2000,FIRST,-,-1,* +=head2 Viewing This week and last week together + + --end now --start end-1w + DEF:thisweek=router.rrd:ds0:AVERAGE + DEF:lastweek=router.rrd:ds0:AVERAGE:end=now-1w:start=end-1w +shift the data forward by one week (604800 seconds) + SHIFT:lastweek:604800 [ more of the usual VDEF and CDEF stuff if you like ] - LINE1:jan2000#00003F:"Januari 2000" - [ gprint stuff ] - LINE1:feb2001#003F00:"Februari 2000" - [ gprint stuff ] -Note: offset is made negative by the VDEF statement - SHIFT:offset - LINE1:jan2001#0000FF:"Januari 2001" - [ gprint stuff ] - LINE1:feb2001#00FF00:"Februari 2001" - [ gprint stuff ] + AREA:lastweek#0000FF:Last\ week + LINE1:thisweek#FF0000:This\ week =include see_also diff --git a/doc/rrdgraph_graph.src b/doc/rrdgraph_graph.src index 4d4a557..83ccae5 100644 --- a/doc/rrdgraph_graph.src +++ b/doc/rrdgraph_graph.src @@ -4,7 +4,7 @@ =over 4 -=item B +=item B =over 4 @@ -18,6 +18,8 @@ =back +Z<> + =item B =over 8 @@ -30,9 +32,9 @@ =item B : I # I [ : I ] -=item B{I} : I # I [ : I ] [ : STACK ] +=item B{I} : I # I [ : I ] [ C<:STACK> ] -=item B C<:> I C<#> I [ C<:> I ] [ C<:> C ] +=item B C<:> I C<#> I [ C<:> I ] [ C<:STACK> ] =cut @@ -174,11 +176,7 @@ Text is printed literally in the legend section of the graph =item B : I # I [ :I ] -Draw an horizontal line at I. Its color is composed from three -hexadecimal numbers specifying the color components (00 is off, FF is -maximum) red, green and blue. Optionally a legend box and string is -printed in the legend section. I can be a variable from a B. -It is an error to use Is from B or B here. +I in new scripts.> =item B : I # I [ : I ] @@ -188,7 +186,8 @@ maximum) red, green and blue. Optionally a legend box and string is printed in the legend section. I