X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph.pod;h=ca3c12840245fc8fd248bcba06b7962fc39da07b;hp=8689febaf0e9c5eb1d51b43a9a59ed301ddcb095;hb=3501907ea29f921eefcae6bd50c3f31eca0e49b2;hpb=5cbf604e8be474094aef371c53917ec9046bad32 diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod index 8689feb..ca3c128 100644 --- a/doc/rrdgraph.pod +++ b/doc/rrdgraph.pod @@ -1,187 +1,147 @@ =head1 NAME -=cut +rrdgraph - Round Robin Database tool graphing functions -WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED +=head1 SYNOPSIS -=pod - -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. - -=head1 SYNOPSYS - -B I -[EB>E ...] -EB>E -[EB>E ...] -[EB>E ...] -[EB>E ...] -[EB>E ...] -[EB>E ...] +B I +[I> ...] +[I> ...] +[I> ...] +[I> ...] +[I> ...] +[I> ...] =head1 DESCRIPTION -The B function of B is used to represent the +The B function of B is used to present the data from an B to a human viewer. Its main purpose is to -create a nice graphical representation but it can also generate +create a nice graphical representation, but it can also generate a numerical report. =head1 OVERVIEW -B needs data to work with, use one or more +B needs data to work with, so you must use one or more B> statements to collect this data. You are not limited to one database, it's perfectly legal to -collect data from two or more databases (one per statement though). +collect data from two or more databases (one per statement, though). -If you want to display averages, maxima, percentiles etcetera +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 +there is exactly one data point 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!). - -Sometimes data is not exactly as you would like to display it. For -instance, you might be collecting B per second but want to -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! +if necessary. Note, in that case the first and/or last pixel may very +well become unknown! + +Sometimes data is not exactly in the format you would like to display +it. For instance, you might be collecting B per second, but +want to display B per second. This is what the B> command is designed for. After +B the data, a copy is made and this copy is modified +using a rather powerful B> command set. When you are done fetching and processing the data, it is time to graph it (or print it). This ends the B sequence. +Use B instead of B to get detailed information about the +graph geometry and data once it is drawn. See the bottom of the document for +more information. + =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 +=head2 I The name and path of the graph to generate. It is recommended to -end this in C<.png> or C<.gif> 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. - -Z<> +this case, no other output is generated. -=item Time range +=head2 Time range -B<[-s|--start EtimeE]> -B<[-e|--end EtimeE]> -B<[--step EsecondsE]> +[B<-s>|B<--start> I