misc fixes for better display

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

diff --git a/program/doc/rrdcgi.pod b/program/doc/rrdcgi.pod
index b0ececb4c8f8614f4909a5bf2a7c92dbd9ebcabd..e999fea0966071d0e3f04fb2129c22de9ba34ea2 100644 (file)
--- a/program/doc/rrdcgi.pod
+++ b/program/doc/rrdcgi.pod
@@ -2,12 +2,9 @@
 
 rrdcgi - Create web pages containing RRD graphs based on templates
 
-=for html <div align="right"><a href="rrdcgi.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
-#!/path/to/B<rrdcgi> 
-S<[B<--filter>]>
+C<#!/path/to/>B<rrdcgi> S<[B<--filter>]>
 
 =head1 DESCRIPTION
 

diff --git a/program/doc/rrdcreate.pod b/program/doc/rrdcreate.pod
index 84d405e9f28c2ca9d7d4475bf9321c15e8368d17..80f397087a9f0403925cb46f4db40a8d571fbf5e 100644 (file)
--- a/program/doc/rrdcreate.pod
+++ b/program/doc/rrdcreate.pod
@@ -2,8 +2,6 @@
 
 rrdcreate - Set up a new Round Robin Database
 
-=for html <div align="right"><a href="rrdcreate.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<create> I<filename> 
@@ -189,8 +187,6 @@ I<rows> defines how many generations of data values are kept in an B<RRA>.
 
 =head1 Aberrant Behavior Detection with Holt-Winters Forecasting
 
-by Jake Brutlag E<lt>jakeb@corp.webtv.netE<gt>
-
 In addition to the aggregate functions, there are a set of specialized
 functions that enable B<RRDtool> to provide data smoothing (via the
 Holt-Winters forecasting algorithm), confidence bands, and the flagging
@@ -424,9 +420,12 @@ days on the x axis and one bar for each day).
 
 =head1 EXAMPLE
 
-C<rrdtool create temperature.rrd --step 300 DS:temp:GAUGE:600:-273:5000
-RRA:AVERAGE:0.5:1:1200 RRA:MIN:0.5:12:2400 RRA:MAX:0.5:12:2400
-RRA:AVERAGE:0.5:12:2400>
+ rrdtool create temperature.rrd --step 300 \
+  DS:temp:GAUGE:600:-273:5000 \
+  RRA:AVERAGE:0.5:1:1200 \
+  RRA:MIN:0.5:12:2400 \
+  RRA:MAX:0.5:12:2400 \
+  RRA:AVERAGE:0.5:12:2400
 
 This sets up an B<RRD> called F<temperature.rrd> which accepts one
 temperature value every 300 seconds. If no new data is supplied for
@@ -442,10 +441,10 @@ average temperature, respectively.
 
 =head1 EXAMPLE 2
 
-C<rrdtool create monitor.rrd --step 300 
-DS:ifOutOctets:COUNTER:1800:0:4294967295
-RRA:AVERAGE:0.5:1:2016
-RRA:HWPREDICT:1440:0.1:0.0035:288>
+ rrdtool create monitor.rrd --step 300        \ 
+   DS:ifOutOctets:COUNTER:1800:0:4294967295   \ 
+   RRA:AVERAGE:0.5:1:2016                     \
+   RRA:HWPREDICT:1440:0.1:0.0035:288 
 
 This example is a monitor of a router interface. The first B<RRA> tracks the
 traffic flow in octets; the second B<RRA> generates the specialized
@@ -468,25 +467,25 @@ the FAILURES B<RRA>.
 The same RRD file and B<RRAs> are created with the following command, which explicitly
 creates all specialized function B<RRAs>.
 
-C<rrdtool create monitor.rrd --step 300 
-DS:ifOutOctets:COUNTER:1800:0:4294967295
-RRA:AVERAGE:0.5:1:2016
-RRA:HWPREDICT:1440:0.1:0.0035:288:3
-RRA:SEASONAL:288:0.1:2
-RRA:DEVPREDICT:1440:5
-RRA:DEVSEASONAL:288:0.1:2
-RRA:FAILURES:288:7:9:5>
+ rrdtool create monitor.rrd --step 300 \ 
+   DS:ifOutOctets:COUNTER:1800:0:4294967295 \ 
+   RRA:AVERAGE:0.5:1:2016 \ 
+   RRA:HWPREDICT:1440:0.1:0.0035:288:3 \ 
+   RRA:SEASONAL:288:0.1:2 \ 
+   RRA:DEVPREDICT:1440:5 \ 
+   RRA:DEVSEASONAL:288:0.1:2 \ 
+   RRA:FAILURES:288:7:9:5 
 
 Of course, explicit creation need not replicate implicit create, a number of arguments 
 could be changed.
 
 =head1 EXAMPLE 3
 
-C<rrdtool create proxy.rrd --step 300 
-DS:TotalRequests:DERIVE:1800:0:U
-DS:AccumDuration:DERIVE:1800:0:U
-DS:AvgReqDuration:COMPUTE:AccumDuration,TotalRequests,0,EQ,1,TotalRequests,IF,/
-RRA:AVERAGE:0.5:1:2016>
+ rrdtool create proxy.rrd --step 300 \ 
+   DS:Total:DERIVE:1800:0:U  \ 
+   DS:Duration:DERIVE:1800:0:U  \ 
+   DS:AvgReqDur:COMPUTE:Duration,Requests,0,EQ,1,Requests,IF,/ \ 
+   RRA:AVERAGE:0.5:1:2016 
 
 This example is monitoring the average request duration during each 300 sec 
 interval for requests processed by a web proxy during the interval.

diff --git a/program/doc/rrddump.pod b/program/doc/rrddump.pod
index f1e653f7164e7b63553337ab18b864b557844ec1..f93c144a7d6a39ab086fe9b28e26ccf9b1429988 100644 (file)
--- a/program/doc/rrddump.pod
+++ b/program/doc/rrddump.pod
@@ -2,8 +2,6 @@
 
 rrddump - dump the contents of an RRD to XML format
 
-=for html <div align="right"><a href="rrddump.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<dump> I<filename.rrd> E<gt> I<filename.xml> 

diff --git a/program/doc/rrdfetch.pod b/program/doc/rrdfetch.pod
index 80053f3a2cd3405e99df1b3c9953fe3b023ef35c..16bee22a8b9c13f78ebba7f9b607ef2d6fc81867 100644 (file)
--- a/program/doc/rrdfetch.pod
+++ b/program/doc/rrdfetch.pod
@@ -2,8 +2,6 @@
 
 rrdfetch - Fetch data from an RRD.
 
-=for html <div align="right"><a href="rrdfetch.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<fetch> I<filename> I<CF> 
@@ -99,13 +97,16 @@ So, if time now is called "t",
 
 In e.g. bash this could look as:
 
- TIME=$(date +%s); RRDRES=900; rrdtool fetch subdata.rrd AVERAGE -r $RRDRES \
- -e $(echo $(($TIME/$RRDRES*$RRDRES))) -s e-1h
+ TIME=$(date +%s)
+ RRDRES=900
+ rrdtool fetch subdata.rrd AVERAGE -r $RRDRES \
+    -e $(echo $(($TIME/$RRDRES*$RRDRES))) -s e-1h
 
 Or in Perl:
 
- perl -e '$ctime = time; $rrdres = 900; system "rrdtool fetch subdata.rrd AVERAGE \
- -r $rrdres -e @{[int($ctime/$rrdres)*$rrdres]} -s e-1h"'
+ perl -e '$ctime = time; $rrdres = 900; \
+          system "rrdtool fetch subdata.rrd AVERAGE \
+                  -r $rrdres -e @{[int($ctime/$rrdres)*$rrdres]} -s e-1h"'
 
 
 =head2 AT-STYLE TIME SPECIFICATION
@@ -253,4 +254,3 @@ I<19970703 12:45> -- 12:45  July 3th, 1997
 =head1 AUTHOR
 
 Tobias Oetiker <oetiker@ee.ethz.ch>
-

diff --git a/program/doc/rrdfirst.pod b/program/doc/rrdfirst.pod
index 85aae587eaa8b43a7fd7ae8c0a971926d8367194..63ef79eed1442ab60e4ec9766aad853686ddaaea 100644 (file)
--- a/program/doc/rrdfirst.pod
+++ b/program/doc/rrdfirst.pod
@@ -2,8 +2,6 @@
 
 rrdfirst - Return the date of the first data sample in an RRA within an RRD
 
-=for html <div align="right"><a href="rrdfirst.pdf">PDF</a> version.</div>
-
 =head1 SYNOPSIS
 
 B<rrdtool> B<first> I<filename> [I<--rraindex number>]

diff --git a/program/doc/rrdgraph.src b/program/doc/rrdgraph.src
index c6a91be91adf56f68da432a4735371b95165555c..1faec254ce8339ed3c6a98e2044e136601f2b39c 100644 (file)
--- a/program/doc/rrdgraph.src
+++ b/program/doc/rrdgraph.src
@@ -8,8 +8,6 @@ WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
 
 rrdgraph - Round Robin Database tool grapher functions
 
-=include name
-
 =head1 SYNOPSIS
 
 B<rrdtool graph> I<filename>
@@ -332,6 +330,18 @@ 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.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
 
-=include see_also

diff --git a/program/doc/rrdgraph_data.src b/program/doc/rrdgraph_data.src
index 5a8d51f199cf4ecfc0b8fe088d8daa7223ae3bbd..bef369017200db68041c06bd00c0c3581e5a0237 100644 (file)
--- a/program/doc/rrdgraph_data.src
+++ b/program/doc/rrdgraph_data.src
@@ -1,11 +1,5 @@
 =head1 NAME
 
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
 rrdgraph_data - preparing data for graphing in rrdtool graph
 
 =head1 SYNOPSIS
@@ -85,4 +79,17 @@ the script, just as if it were generated by a B<DEF> instruction.
 
 Example: C<CDEF:mydatabits=mydata,8,*>
 
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>

diff --git a/program/doc/rrdgraph_examples.src b/program/doc/rrdgraph_examples.src
index 8ccf8ebddf6f884fc19ed33e3367fec673803e8a..9360e0667050c549c2b8e4c69b7718e681c30574 100644 (file)
--- a/program/doc/rrdgraph_examples.src
+++ b/program/doc/rrdgraph_examples.src
@@ -1,11 +1,5 @@
 =head1 NAME
 
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
 rrdgraph_examples - Examples for rrdtool graph
 
 =head1 SYNOPSIS
@@ -129,5 +123,17 @@ shift the data forward by one week (604800 seconds)
     AREA:lastweek#0000FF:Last\ week
     LINE1:thisweek#FF0000:This\ week
 
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
 
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>

diff --git a/program/doc/rrdgraph_graph.src b/program/doc/rrdgraph_graph.src
index 3826f08a31d27afd0270cefa9caa73af47f62049..bf92d454ac84c58000594b36dce362c478066e89 100644 (file)
--- a/program/doc/rrdgraph_graph.src
+++ b/program/doc/rrdgraph_graph.src
@@ -1,11 +1,5 @@
 =head1 NAME  
 
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
 rrdgraph_graph - rrdtool graph command reference
 
 =head1 SYNOPSIS
@@ -284,4 +278,17 @@ If you are using the proportional font in your graph, you can use tab characters
 or the sequence B<\t> to lin-up legend elements. Note that the tabs inserted are
 relative to the start of the current legend element!
 
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>

diff --git a/program/doc/rrdgraph_rpn.src b/program/doc/rrdgraph_rpn.src
index 9e6f70ed0579c4c7b98555a9e592286bbbb7543d..b79e4e2db3b42d7f7be588aaeee6cf91423beccd 100644 (file)
--- a/program/doc/rrdgraph_rpn.src
+++ b/program/doc/rrdgraph_rpn.src
@@ -1,11 +1,5 @@
 =head1 NAME  
 
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
 rrdgraph_rpn - About RPN Math in rrdtool graph
 
 =head1 SYNOPSIS
@@ -265,4 +259,17 @@ Example: C<VDEF:perc95=mydata,95,PERCENT>
 
 =back
 
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>

diff --git a/program/doc/rrdtool.pod b/program/doc/rrdtool.pod
index 58a85615dffa0a3cd2a6fb6b68a782656157375d..89030b8e5c1beceb669e5ad6193878b200ddb207 100644 (file)
--- a/program/doc/rrdtool.pod
+++ b/program/doc/rrdtool.pod
@@ -1,8 +1,6 @@
 =head1 NAME
 
-rrdtool - round robin database tool
-
-=for html <div align="right"><a href="rrdtool.pdf">PDF</a> version.</div>
+rrdtool - Round Robin Database Tool
 
 =head1 SYNOPSIS