From 2b3007f355c165ddf90696a4d84a3e072303f4d0 Mon Sep 17 00:00:00 2001 From: oetiker Date: Mon, 18 Apr 2005 22:13:20 +0000 Subject: [PATCH] misc fixes for better display git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2@413 a5681a0c-68f1-0310-ab6d-d61299d08faa --- program/doc/rrdcgi.pod | 5 +--- program/doc/rrdcreate.pod | 47 +++++++++++++++---------------- program/doc/rrddump.pod | 2 -- program/doc/rrdfetch.pod | 14 ++++----- program/doc/rrdfirst.pod | 2 -- program/doc/rrdgraph.src | 18 +++++++++--- program/doc/rrdgraph_data.src | 21 +++++++++----- program/doc/rrdgraph_examples.src | 20 ++++++++----- program/doc/rrdgraph_graph.src | 21 +++++++++----- program/doc/rrdgraph_rpn.src | 21 +++++++++----- program/doc/rrdtool.pod | 4 +-- 11 files changed, 101 insertions(+), 74 deletions(-) diff --git a/program/doc/rrdcgi.pod b/program/doc/rrdcgi.pod index b0ececb4..e999fea0 100644 --- 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
PDF version.
- =head1 SYNOPSIS -#!/path/to/B -S<[B<--filter>]> +C<#!/path/to/>B S<[B<--filter>]> =head1 DESCRIPTION diff --git a/program/doc/rrdcreate.pod b/program/doc/rrdcreate.pod index 84d405e9..80f39708 100644 --- a/program/doc/rrdcreate.pod +++ b/program/doc/rrdcreate.pod @@ -2,8 +2,6 @@ rrdcreate - Set up a new Round Robin Database -=for html
PDF version.
- =head1 SYNOPSIS B B I @@ -189,8 +187,6 @@ I defines how many generations of data values are kept in an B. =head1 Aberrant Behavior Detection with Holt-Winters Forecasting -by Jake Brutlag Ejakeb@corp.webtv.netE - In addition to the aggregate functions, there are a set of specialized functions that enable B 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 This sets up an B called F 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 This example is a monitor of a router interface. The first B tracks the traffic flow in octets; the second B generates the specialized @@ -468,25 +467,25 @@ the FAILURES B. The same RRD file and B are created with the following command, which explicitly creates all specialized function B. -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 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: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 f1e653f7..f93c144a 100644 --- 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
PDF version.
- =head1 SYNOPSIS B B I E I diff --git a/program/doc/rrdfetch.pod b/program/doc/rrdfetch.pod index 80053f3a..16bee22a 100644 --- a/program/doc/rrdfetch.pod +++ b/program/doc/rrdfetch.pod @@ -2,8 +2,6 @@ rrdfetch - Fetch data from an RRD. -=for html
PDF version.
- =head1 SYNOPSIS B B I I @@ -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 - diff --git a/program/doc/rrdfirst.pod b/program/doc/rrdfirst.pod index 85aae587..63ef79ee 100644 --- 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
PDF version.
- =head1 SYNOPSIS B B I [I<--rraindex number>] diff --git a/program/doc/rrdgraph.src b/program/doc/rrdgraph.src index c6a91be9..1faec254 100644 --- 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 I @@ -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 for exact format. -=back +=head1 SEE ALSO + +L gives an overview of how B works. +L describes B,B and B in detail, +L describes the B language used in the B statements, +L page describes all of the graph and print functions. + +Make sure to read L for tipsEtricks. + +=head1 AUTHOR + +Program by Tobias Oetiker Eoetiker@ee.ethz.chE + +This manual page by Alex van den Bogaerdt Ealex@ergens.op.het.netE -=include see_also diff --git a/program/doc/rrdgraph_data.src b/program/doc/rrdgraph_data.src index 5a8d51f1..bef36901 100644 --- 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 instruction. Example: C -=include see_also +=head1 SEE ALSO + +L gives an overview of how B works. +L describes B,B and B in detail, +L describes the B language used in the B statements, +L page describes all of the graph and print functions. + +Make sure to read L for tipsEtricks. + +=head1 AUTHOR + +Program by Tobias Oetiker Eoetiker@ee.ethz.chE + +This manual page by Alex van den Bogaerdt Ealex@ergens.op.het.netE diff --git a/program/doc/rrdgraph_examples.src b/program/doc/rrdgraph_examples.src index 8ccf8ebd..9360e066 100644 --- 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 gives an overview of how B works. +L describes B,B and B in detail, +L describes the B language used in the B statements, +L page describes all of the graph and print functions. + +Make sure to read L for tipsEtricks. + +=head1 AUTHOR + +Program by Tobias Oetiker Eoetiker@ee.ethz.chE +This manual page by Alex van den Bogaerdt Ealex@ergens.op.het.netE diff --git a/program/doc/rrdgraph_graph.src b/program/doc/rrdgraph_graph.src index 3826f08a..bf92d454 100644 --- 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 gives an overview of how B works. +L describes B,B and B in detail, +L describes the B language used in the B statements, +L page describes all of the graph and print functions. + +Make sure to read L for tipsEtricks. + +=head1 AUTHOR + +Program by Tobias Oetiker Eoetiker@ee.ethz.chE + +This manual page by Alex van den Bogaerdt Ealex@ergens.op.het.netE diff --git a/program/doc/rrdgraph_rpn.src b/program/doc/rrdgraph_rpn.src index 9e6f70ed..b79e4e2d 100644 --- 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 =back -=include see_also +=head1 SEE ALSO + +L gives an overview of how B works. +L describes B,B and B in detail, +L describes the B language used in the B statements, +L page describes all of the graph and print functions. + +Make sure to read L for tipsEtricks. + +=head1 AUTHOR + +Program by Tobias Oetiker Eoetiker@ee.ethz.chE + +This manual page by Alex van den Bogaerdt Ealex@ergens.op.het.netE diff --git a/program/doc/rrdtool.pod b/program/doc/rrdtool.pod index 58a85615..89030b8e 100644 --- a/program/doc/rrdtool.pod +++ b/program/doc/rrdtool.pod @@ -1,8 +1,6 @@ =head1 NAME -rrdtool - round robin database tool - -=for html
PDF version.
+rrdtool - Round Robin Database Tool =head1 SYNOPSIS -- 2.30.2