From 91762ee46b0bb601e27a5a20bbc92bf4854d2599 Mon Sep 17 00:00:00 2001 From: oetiker Date: Mon, 18 Apr 2005 22:39:10 +0000 Subject: [PATCH] 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@414 a5681a0c-68f1-0310-ab6d-d61299d08faa --- program/doc/Makefile.am | 35 +++++++++---------- program/doc/cdeftutorial.pod | 11 ++---- program/doc/rrd-beginners.pod | 22 ++++++------ program/doc/{rrdgraph.src => rrdgraph.pod} | 12 +++---- .../{rrdgraph_data.src => rrdgraph_data.pod} | 0 ...aph_examples.src => rrdgraph_examples.pod} | 0 ...{rrdgraph_graph.src => rrdgraph_graph.pod} | 0 .../{rrdgraph_rpn.src => rrdgraph_rpn.pod} | 0 program/doc/rrdinfo.pod | 2 -- program/doc/rrdlast.pod | 2 -- program/doc/rrdresize.pod | 2 -- program/doc/rrdrestore.pod | 2 -- program/doc/rrdtune.pod | 2 -- program/doc/rrdtutorial.pod | 4 --- program/doc/rrdupdate.pod | 2 -- program/doc/rrdxport.pod | 2 -- 16 files changed, 34 insertions(+), 64 deletions(-) rename program/doc/{rrdgraph.src => rrdgraph.pod} (98%) rename program/doc/{rrdgraph_data.src => rrdgraph_data.pod} (100%) rename program/doc/{rrdgraph_examples.src => rrdgraph_examples.pod} (100%) rename program/doc/{rrdgraph_graph.src => rrdgraph_graph.pod} (100%) rename program/doc/{rrdgraph_rpn.src => rrdgraph_rpn.pod} (100%) diff --git a/program/doc/Makefile.am b/program/doc/Makefile.am index 9f0ca9c7..189c5c5e 100644 --- a/program/doc/Makefile.am +++ b/program/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/program/doc/cdeftutorial.pod b/program/doc/cdeftutorial.pod index fb337702..49f80018 100644 --- a/program/doc/cdeftutorial.pod +++ b/program/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/program/doc/rrd-beginners.pod b/program/doc/rrd-beginners.pod index 85b4adef..1ad8c343 100644 --- a/program/doc/rrd-beginners.pod +++ b/program/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/program/doc/rrdgraph.src b/program/doc/rrdgraph.pod similarity index 98% rename from program/doc/rrdgraph.src rename to program/doc/rrdgraph.pod index 1faec254..bd0d0d46 100644 --- a/program/doc/rrdgraph.src +++ b/program/doc/rrdgraph.pod @@ -1,11 +1,5 @@ =head1 NAME -=cut - -WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED - -=pod - rrdgraph - Round Robin Database tool grapher functions =head1 SYNOPSIS @@ -174,13 +168,13 @@ placed right under the corresponding line (useful for hours, dates etcetera). If you specify a number of seconds here the label is centered in this interval (useful for Monday, January etcetera). -Example: C<--x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X> + --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X This places grid lines every 10 minutes, major grid lines every hour and labels every 4 hours. The labels are placed under the major grid lines as they specify exactly that time. -Example: C<--x-grid HOUR:8:DAY:1:DAY:1:0:%A> + --x-grid HOUR:8:DAY:1:DAY:1:0:%A This places grid lines every 8 hours, major grid lines and labels each day. The labels are placed exactly between two major grid lines @@ -330,6 +324,8 @@ You need at least one graph element to generate an image and/or at least one print statement to generate a report. See L for exact format. +=back + =head1 SEE ALSO L gives an overview of how B works. diff --git a/program/doc/rrdgraph_data.src b/program/doc/rrdgraph_data.pod similarity index 100% rename from program/doc/rrdgraph_data.src rename to program/doc/rrdgraph_data.pod diff --git a/program/doc/rrdgraph_examples.src b/program/doc/rrdgraph_examples.pod similarity index 100% rename from program/doc/rrdgraph_examples.src rename to program/doc/rrdgraph_examples.pod diff --git a/program/doc/rrdgraph_graph.src b/program/doc/rrdgraph_graph.pod similarity index 100% rename from program/doc/rrdgraph_graph.src rename to program/doc/rrdgraph_graph.pod diff --git a/program/doc/rrdgraph_rpn.src b/program/doc/rrdgraph_rpn.pod similarity index 100% rename from program/doc/rrdgraph_rpn.src rename to program/doc/rrdgraph_rpn.pod diff --git a/program/doc/rrdinfo.pod b/program/doc/rrdinfo.pod index b03032c3..9ccaea20 100644 --- a/program/doc/rrdinfo.pod +++ b/program/doc/rrdinfo.pod @@ -2,8 +2,6 @@ rrdinfo - extract header information from an RRD -=for html
PDF version.
- =head1 SYNOPSIS B B I diff --git a/program/doc/rrdlast.pod b/program/doc/rrdlast.pod index 44492369..d709c5a4 100644 --- a/program/doc/rrdlast.pod +++ b/program/doc/rrdlast.pod @@ -2,8 +2,6 @@ rrdlast - Return the date of the last data sample in an RRD -=for html
PDF version.
- =head1 SYNOPSIS B B I diff --git a/program/doc/rrdresize.pod b/program/doc/rrdresize.pod index f6acb9b6..a7c01b49 100644 --- a/program/doc/rrdresize.pod +++ b/program/doc/rrdresize.pod @@ -2,8 +2,6 @@ rrdresize - alters the size of an RRA and creates new .rrd file -=for html
PDF version.
- =head1 SYNOPSIS B B I I BI<|>B I diff --git a/program/doc/rrdrestore.pod b/program/doc/rrdrestore.pod index e30a25b2..7f78d279 100644 --- a/program/doc/rrdrestore.pod +++ b/program/doc/rrdrestore.pod @@ -2,8 +2,6 @@ rrdrestore - Restore the contents of an RRD from its XML dump format -=for html
PDF version.
- =head1 SYNOPSIS B B I I diff --git a/program/doc/rrdtune.pod b/program/doc/rrdtune.pod index 3e96f6de..1a002ce4 100644 --- a/program/doc/rrdtune.pod +++ b/program/doc/rrdtune.pod @@ -2,8 +2,6 @@ rrdtune - Modify some basic properties of a Round Robin Database -=for html
PDF version.
- =head1 SYNOPSIS B B I diff --git a/program/doc/rrdtutorial.pod b/program/doc/rrdtutorial.pod index eaf7af6c..3c9318a5 100644 --- a/program/doc/rrdtutorial.pod +++ b/program/doc/rrdtutorial.pod @@ -2,10 +2,6 @@ rrdtutorial - Alex van den Bogaerdt's RRDtool tutorial -=for html - -=for html
PDF version.
- =head1 DESCRIPTION RRDtool is written by Tobias Oetiker with diff --git a/program/doc/rrdupdate.pod b/program/doc/rrdupdate.pod index fe5ff6d7..f2cd070f 100644 --- a/program/doc/rrdupdate.pod +++ b/program/doc/rrdupdate.pod @@ -2,8 +2,6 @@ rrdupdate - Store a new set of values into the RRD -=for html
PDF version.
- =head1 SYNOPSIS B {B | B} I diff --git a/program/doc/rrdxport.pod b/program/doc/rrdxport.pod index 1af2041b..ca0e3aa2 100644 --- a/program/doc/rrdxport.pod +++ b/program/doc/rrdxport.pod @@ -2,8 +2,6 @@ rrdxport - Export data in XML format based on data from one or several RRD -=for html
PDF version.
- =head1 SYNOPSIS B B -- 2.30.2