X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph.pod;h=57359ac66972b176f1f253067e8711a376030f22;hp=bd0d0d46265b281206803a8771e3a2f5550f593f;hb=07de871981951c5ff711ae94ce2c69f0423c3987;hpb=1ed31d581dfed23377a61d4df88bb9c2b9b2c94b diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod index bd0d0d4..57359ac 100644 --- a/doc/rrdgraph.pod +++ b/doc/rrdgraph.pod @@ -4,7 +4,7 @@ rrdgraph - Round Robin Database tool grapher functions =head1 SYNOPSIS -B I +B I [I> ...] [I> ...] [I> ...] @@ -16,70 +16,73 @@ B I 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. -Currently this makes no difference but in a future version +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 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 -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 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 -=over 4 -=item filename + +=head2 I 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. +this case, no other output is generated. -=item Time range +=head2 Time range [B<-s>|B<--start> I