From: oetiker Date: Mon, 18 Apr 2005 22:39:10 +0000 (+0000) Subject: src moved back to pod. this include thing was a neat idea but it just adds another... X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=1ed31d581dfed23377a61d4df88bb9c2b9b2c94b;p=rrdtool.git src moved back to pod. this include thing was a neat idea but it just adds another twist to things which is not necessary. fixed some pod errors git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@414 a5681a0c-68f1-0310-ab6d-d61299d08faa --- diff --git a/doc/Makefile.am b/doc/Makefile.am index 9f0ca9c..189c5c5 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,29 +1,26 @@ ## Process this file with automake to produce Makefile.in -SUFFIXES = .pod .1 .man .html .txt .pm .pdf .src .inc +SUFFIXES = .pod .1 .man .html .txt .pm .pdf .inc #AUTOMAKE_OPTIONS = foreign #ACLOCAL_M4 = $(top_srcdir)/config/aclocal.m4 -CLEANFILES = *.1 *.html *.txt *-dircache *.pm *.pdf *~ core *itemcache *.rej *.orig rrdgraph_*.pod *.tmp rrdgraph.pod +CLEANFILES = *.1 *.html *.txt *-dircache RRD?.pod *.pdf *~ core *itemcache *.rej *.orig *.tmp -SRC = rrdgraph.src rrdgraph_examples.src rrdgraph_rpn.src \ - rrdgraph_data.src rrdgraph_graph.src +POD = bin_dec_hex.pod rrddump.pod rrdgraph_examples.pod rrdrestore.pod rrdupdate.pod \ + cdeftutorial.pod rrdfetch.pod rrdgraph_graph.pod rrdthreads.pod rrdxport.pod \ + rpntutorial.pod rrdfirst.pod rrdgraph_rpn.pod rrdtool.pod \ + rrd-beginners.pod rrdinfo.pod rrdtune.pod \ + rrdcgi.pod rrdgraph.pod rrdlast.pod \ + rrdcreate.pod rrdgraph_data.pod rrdresize.pod rrdtutorial.pod -PODOLD = rrdgraph-old.pod -POD = rrdtool.pod rrdlast.pod rrdfirst.pod rrdcreate.pod rrdupdate.pod rrdtutorial.es.pod \ - cdeftutorial.pod rpntutorial.pod rrdthreads.pod bin_dec_hex.pod \ - rrdfetch.pod rrdrestore.pod rrddump.pod rrdtune.pod rrdresize.pod \ - rrdcgi.pod rrdtutorial.pod rrdinfo.pod rrdxport.pod rrd-beginners.pod \ - $(SRC:.src=.pod) +PMP = RRDs.pod RRDp.pod -PMP = RRDs.pm RRDp.pm - -MAN = $(POD:.pod=.1) $(PMP:.pm=.1) +MAN = $(POD:.pod=.1) TXT = $(MAN:.1=.txt) -HTML = $(POD:.pod=.html) $(PMP:.pm=.html) +HTML = $(POD:.pod=.html) $(PMP:.pod=.html) PDF = $(MAN:.1=.pdf) # what should go into the distribution @@ -54,16 +51,16 @@ all-local: link txt man html-local .pm.html .pod.html .pl.html: pod2html --infile=$< --outfile=$@ --noindex --htmlroot=. --podpath=. --title=$* -RRDs.pm: - ln -s ../bindings/perl-shared/RRDs.pm . +RRDs.pod: + ln -s ../bindings/perl-shared/RRDs.pm RRDs.pod -RRDp.pm: - ln -s ../bindings/perl-piped/RRDp.pm . +RRDp.pod: + ln -s ../bindings/perl-piped/RRDp.pm RRDp.pod index.html: rm -f index.html; ln -s rrdtool.html index.html -link: RRDp.pm RRDs.pm index.html +link: RRDp.pod RRDs.pod index.html man: $(MAN) diff --git a/doc/cdeftutorial.pod b/doc/cdeftutorial.pod index fb33770..49f8001 100644 --- a/doc/cdeftutorial.pod +++ b/doc/cdeftutorial.pod @@ -2,16 +2,11 @@ cdeftutorial - Alex van den Bogaerdt's CDEF tutorial -=for html
PDF version.
- =head1 DESCRIPTION -B. B - -I - -Alex van den Bogaerdt Ealex@ergens.op.het.netE +If you provide a question, I will try to provide an answer in the next +release of this tutorial. No feedback equals no changes! Additions to this document are also welcome. +-- Alex van den Bogaerdt Ealex@ergens.op.het.netE =head2 Why this tutorial ? diff --git a/doc/rrd-beginners.pod b/doc/rrd-beginners.pod index 85b4ade..1ad8c34 100644 --- a/doc/rrd-beginners.pod +++ b/doc/rrd-beginners.pod @@ -56,7 +56,7 @@ imperative to use scripts that runs at regular intervals to ensure a constant data flow to update the RRDtool database. =back - + RRDtool has a lot to do with time. With every data update, it also needs to know the time when that update occurred. Time is always expressed in seconds passed since epoch (01-01-1971). RRDtool can be installed on Unix as @@ -64,7 +64,7 @@ well as Windows. It has command set to carry out various operations on RRD database. This command set can be accessed from the command line, and from Shell or Perl scripts. The scripts act as wrappers for accessing data stored in RRDtool database. - + =head2 Understanding by an example The structure of an RRD database is different than other linear databases. @@ -83,11 +83,11 @@ terminologies related to RRDtool databases. The structure of a database and the terminology associated with it can be best explained with an example. - rrdtool create target.rrd - --start 1023654125 - --step 300 - DS:mem:GAUGE:600:0:671744 - RRA:AVERAGE:0.5:12:24 + rrdtool create target.rrd \ + --start 1023654125 \ + --step 300 \ + DS:mem:GAUGE:600:0:671744 \ + RRA:AVERAGE:0.5:12:24 \ RRA:AVERAGE:0.5:288:31 This example creates a database named F. Start time (1023654125) is @@ -248,8 +248,8 @@ scripts are as shown below: use lib qw( /usr/local/rrdtool-1.0.41/lib/perl ../lib/perl ); use RRDs; my $cur_time = time(); # setting current time - my $end_time = $cur_time - 86400; # setting end time to 24 hours behind current time - my $start_time = $end_time - 2592000; # setting start time to 30 days from end time + my $end_time = $cur_time - 86400; # setting end time 24 hours ago + my $start_time = $end_time - 2592000; # setting start 30 days in the future #fetching average values from RRD database between start and end time my ($start,$step,$ds_names,$data) = @@ -296,13 +296,13 @@ scripts are as shown below: "--rigid", \ "--base=1024", \ "DEF:tot_mem=target.rrd:mem:AVERAGE", \ - "CDEF:correct_tot_mem=tot_mem,0,671744,LIMIT,UN,0,tot_mem,IF,1024,/",\ + "CDEF:tot_mem_cor=tot_mem,0,671744,LIMIT,UN,0,tot_mem,IF,1024,/",\ "CDEF:machine_mem=tot_mem,656,+,tot_mem,-",\ "COMMENT:Memory Consumption between $start_time",\ "COMMENT: and $end_time ",\ "HRULE:656#000000:Maximum Available Memory - 656 MB",\ "AREA:machine_mem#CCFFFF:Memory Unused", \ - "AREA:correct_tot_mem#6699CC:Total memory consumed in MB"); + "AREA:tot_mem_cor#6699CC:Total memory consumed in MB"); my $err=RRDs::error; if ($err) {print "problem generating the graph: $err\n";} #printing the output diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod new file mode 100644 index 0000000..bd0d0d4 --- /dev/null +++ b/doc/rrdgraph.pod @@ -0,0 +1,343 @@ +=head1 NAME + +rrdgraph - Round Robin Database tool grapher functions + +=head1 SYNOPSIS + +B I +[I> ...] +[I> ...] +[I> ...] +[I> ...] +[I> ...] +[I> ...] + +=head1 DESCRIPTION + +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 +a numerical report. + +=head1 OVERVIEW + +B needs data to work with, 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). + +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 +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. + +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 + +=over 4 + +=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. + +I can be 'C<->' to send the image to C. In +that case, no other output is generated. + +=item Time range + +[B<-s>|B<--start> I