]> git.ipfire.org Git - thirdparty/rrdtool-1.x.git/commitdiff
src moved back to pod. this include thing was a neat idea but it just adds another...
authorTobias Oetiker <tobi@oetiker.ch>
Mon, 18 Apr 2005 22:39:10 +0000 (22:39 +0000)
committerTobias Oetiker <tobi@oetiker.ch>
Mon, 18 Apr 2005 22:39:10 +0000 (22:39 +0000)
fixed some pod errors

git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@414 a5681a0c-68f1-0310-ab6d-d61299d08faa

16 files changed:
doc/Makefile.am
doc/cdeftutorial.pod
doc/rrd-beginners.pod
doc/rrdgraph.pod [moved from doc/rrdgraph.src with 98% similarity]
doc/rrdgraph_data.pod [moved from doc/rrdgraph_data.src with 100% similarity]
doc/rrdgraph_examples.pod [moved from doc/rrdgraph_examples.src with 100% similarity]
doc/rrdgraph_graph.pod [moved from doc/rrdgraph_graph.src with 100% similarity]
doc/rrdgraph_rpn.pod [moved from doc/rrdgraph_rpn.src with 100% similarity]
doc/rrdinfo.pod
doc/rrdlast.pod
doc/rrdresize.pod
doc/rrdrestore.pod
doc/rrdtune.pod
doc/rrdtutorial.pod
doc/rrdupdate.pod
doc/rrdxport.pod

index 9f0ca9c73da60d7464ecd78574dbe201f899b272..189c5c5e9e880bc62c9951b9bd94aeba76bbefac 100644 (file)
@@ -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)
 
index fb337702a3669b88043d7c38c31c211c1dd08349..49f80018d925261c93ea53ef890e42072cb961b0 100644 (file)
@@ -2,16 +2,11 @@
 
 cdeftutorial - Alex van den Bogaerdt's CDEF tutorial
 
-=for html <div align="right"><a href="cdeftutorial.pdf">PDF</a> version.</div> 
-
 =head1 DESCRIPTION
 
-B<You provide a question and I will try to provide an answer in the next
-release>. B<No feedback equals no changes!>
-
-I<Additions to this document are also welcome.>
-
-Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
+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 E<lt>alex@ergens.op.het.netE<gt>
 
 =head2 Why this tutorial ?
 
index 85b4adefdd75b0a73901650a84a569d1bcb1ac26..1ad8c34325f9f797a7efc355eb12e744ffdd74c6 100644 (file)
@@ -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<target.rrd>. 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
similarity index 98%
rename from doc/rrdgraph.src
rename to doc/rrdgraph.pod
index 1faec254ce8339ed3c6a98e2044e136601f2b39c..bd0d0d46265b281206803a8771e3a2f5550f593f 100644 (file)
@@ -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<rrdgraph_graph> for exact format.
 
+=back
+
 =head1 SEE ALSO
 
 L<rrdgraph> gives an overview of how B<rrdtool graph> works.
similarity index 100%
rename from doc/rrdgraph_data.src
rename to doc/rrdgraph_data.pod
similarity index 100%
rename from doc/rrdgraph_rpn.src
rename to doc/rrdgraph_rpn.pod
index b03032c3d6c34538e5693a7a91d6265bbe51238d..9ccaea2068b667859739fb6bc964fe0c3a88d173 100644 (file)
@@ -2,8 +2,6 @@
 
 rrdinfo - extract header information from an RRD
 
-=for html <div align="right"><a href="rrdinfo.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<info> I<filename.rrd>
index 44492369110b8f7f29d9ac892e414157bfeebae0..d709c5a429b5b449631ffddc2d060c088d411556 100644 (file)
@@ -2,8 +2,6 @@
 
 rrdlast - Return the date of the last data sample in an RRD
 
-=for html <div align="right"><a href="rrdlast.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<last> I<filename>
index f6acb9b6fe031c7b9d68daa1e097acb72fd988b9..a7c01b4926864d50419f028512ab90028e5a7e96 100644 (file)
@@ -2,8 +2,6 @@
 
 rrdresize - alters the size of an RRA and creates new .rrd file
 
-=for html <div align="right"><a href="rrdresize.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<resize> I<filename> I<rra-num>  B<GROW>I<|>B<SHRINK> I<rows>
index e30a25b2823844fe146a6783ce45d4a6a3205397..7f78d2792cfa8c1e10a55fe5f157126a2f5bdf33 100644 (file)
@@ -2,8 +2,6 @@
 
 rrdrestore - Restore the contents of an RRD from its XML dump format
 
-=for html <div align="right"><a href="rrdrestore.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<restore> I<filename.xml> I<filename.rrd>
index 3e96f6de8b4be300206d75d75775b7de065c4157..1a002ce4a907afa3e0c56957e2d4683e8ebb8879 100644 (file)
@@ -2,8 +2,6 @@
 
 rrdtune - Modify some basic properties of a Round Robin Database
 
-=for html <div align="right"><a href="rrdtune.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<tune> I<filename> 
index eaf7af6c1601fa79d01b1283aed5268db80eda86..3c9318a5d6b1832d392708e07a059eecb4a8dee4 100644 (file)
@@ -2,10 +2,6 @@
 
 rrdtutorial - Alex van den Bogaerdt's RRDtool tutorial
 
-=for html <div align="right">Go <a href="rrdtutorial.es.html">Spanish</a></div> 
-
-=for html <div align="right"><a href="rrdtutorial.pdf">PDF</a> version.</div> 
-
 =head1 DESCRIPTION
 
 RRDtool is written by Tobias Oetiker <oetiker@ee.ethz.ch> with
index fe5ff6d73124e5c99b26f99a1fe959a375c29a08..f2cd070f3f66a869f76974ad8be2d10abd4b3735 100644 (file)
@@ -2,8 +2,6 @@
 
 rrdupdate - Store a new set of values into the RRD
 
-=for html <div align="right"><a href="rrdupdate.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> {B<update> | B<updatev>} I<filename> 
index 1af2041b7aec1cd620252311ba8838ab9732c515..ca0e3aa2ac8c416e3e7241dc5884997bd20cacfe 100644 (file)
@@ -2,8 +2,6 @@
 
 rrdxport - Export data in XML format based on data from one or several RRD
 
-=for html <div align="right"><a href="rrdxport.pdf">PDF</a> version.</div> 
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<xport>