From d50afc217aaec57e418a55bbe2d20fe996c6e026 Mon Sep 17 00:00:00 2001 From: oetiker Date: Sun, 17 Apr 2005 22:43:11 +0000 Subject: [PATCH] fixed many pod bugs while creating the new website git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@411 a5681a0c-68f1-0310-ab6d-d61299d08faa --- doc/bin_dec_hex.pod | 5 +-- doc/rrd-beginners.pod | 2 +- doc/rrdcgi.pod | 2 +- doc/rrdcreate.pod | 2 +- doc/rrddump.pod | 2 +- doc/rrdfetch.pod | 2 +- doc/rrdfirst.pod | 2 +- doc/rrdgraph.src | 22 ++++++++--- doc/rrdgraph_data.src | 10 ++++- doc/rrdgraph_examples.src | 26 ++++++++++++- doc/rrdgraph_graph.src | 96 +++++++++++++++++++++-------------------------- doc/rrdgraph_rpn.src | 14 +++++-- doc/rrdinfo.pod | 2 +- doc/rrdlast.pod | 2 +- doc/rrdresize.pod | 2 +- doc/rrdrestore.pod | 2 +- doc/rrdthreads.pod | 26 +++++-------- doc/rrdtune.pod | 2 +- doc/rrdupdate.pod | 2 +- doc/rrdxport.pod | 4 +- 20 files changed, 129 insertions(+), 98 deletions(-) diff --git a/doc/bin_dec_hex.pod b/doc/bin_dec_hex.pod index 3a2f2fb..0ab2709 100644 --- a/doc/bin_dec_hex.pod +++ b/doc/bin_dec_hex.pod @@ -1,6 +1,6 @@ =head1 NAME -Binary Decimal Hexadecimal - How does it work +bin_dec_hex - How Binary, Decimal, Hexadecimal =for html
PDF version.
@@ -361,5 +361,4 @@ other people by pointing them to this document when they are asking basic questions. They will not only get their answer but at the same time learn a whole lot more. -Alex van den Bogaerdt - +Alex van den Bogaerdt Ealex@ergens.op.het.netE diff --git a/doc/rrd-beginners.pod b/doc/rrd-beginners.pod index 363cc2e..85b4ade 100644 --- a/doc/rrd-beginners.pod +++ b/doc/rrd-beginners.pod @@ -1,6 +1,6 @@ =head1 NAME -rrd-beginners - Beginners guide +rrd-beginners - RRDtool Beginners guide =head1 SYNOPSIS diff --git a/doc/rrdcgi.pod b/doc/rrdcgi.pod index 6a46ce2..b0ececb 100644 --- a/doc/rrdcgi.pod +++ b/doc/rrdcgi.pod @@ -1,6 +1,6 @@ =head1 NAME -rrdcgi - create web pages containing RRD graphs based on templates +rrdcgi - Create web pages containing RRD graphs based on templates =for html
PDF version.
diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod index affe461..84d405e 100644 --- a/doc/rrdcreate.pod +++ b/doc/rrdcreate.pod @@ -1,6 +1,6 @@ =head1 NAME -rrdtool create - Set up a new Round Robin Database +rrdcreate - Set up a new Round Robin Database =for html
PDF version.
diff --git a/doc/rrddump.pod b/doc/rrddump.pod index de6b0ec..f1e653f 100644 --- a/doc/rrddump.pod +++ b/doc/rrddump.pod @@ -1,6 +1,6 @@ =head1 NAME -rrdtool dump - dump the contents of an B to XML format +rrddump - dump the contents of an RRD to XML format =for html
PDF version.
diff --git a/doc/rrdfetch.pod b/doc/rrdfetch.pod index a4e87c5..80053f3 100644 --- a/doc/rrdfetch.pod +++ b/doc/rrdfetch.pod @@ -1,6 +1,6 @@ =head1 NAME -rrdtool fetch - fetch data from an RRD. +rrdfetch - Fetch data from an RRD. =for html
PDF version.
diff --git a/doc/rrdfirst.pod b/doc/rrdfirst.pod index 4d01273..85aae58 100644 --- a/doc/rrdfirst.pod +++ b/doc/rrdfirst.pod @@ -1,6 +1,6 @@ =head1 NAME -rrdfirst - Return the date of the first data sample in an B within an B +rrdfirst - Return the date of the first data sample in an RRA within an RRD =for html
PDF version.
diff --git a/doc/rrdgraph.src b/doc/rrdgraph.src index 18a5442..c6a91be 100644 --- a/doc/rrdgraph.src +++ b/doc/rrdgraph.src @@ -1,14 +1,24 @@ +=head1 NAME + +=cut + +WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED + +=pod + +rrdgraph - Round Robin Database tool grapher functions + =include name =head1 SYNOPSIS B I -[EB>E ...] -[EB>E ...] -[EB>E ...] -[EB>E ...] -[EB>E ...] -[EB>E ...] +[I> ...] +[I> ...] +[I> ...] +[I> ...] +[I> ...] +[I> ...] =head1 DESCRIPTION diff --git a/doc/rrdgraph_data.src b/doc/rrdgraph_data.src index f5c1114..5a8d51f 100644 --- a/doc/rrdgraph_data.src +++ b/doc/rrdgraph_data.src @@ -1,4 +1,12 @@ -=include name +=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 diff --git a/doc/rrdgraph_examples.src b/doc/rrdgraph_examples.src index 632c787..8ccf8eb 100644 --- a/doc/rrdgraph_examples.src +++ b/doc/rrdgraph_examples.src @@ -1,4 +1,12 @@ -=include name +=head1 NAME + +=cut + +WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED + +=pod + +rrdgraph_examples - Examples for rrdtool graph =head1 SYNOPSIS @@ -36,16 +44,24 @@ ready because comments are intermixed with the examples. VDEF:ds1avg=ds1,AVERAGE,8,* VDEF:ds1min=ds1,MINIMUM,8,* VDEF:ds1pct=95,ds1,PERCENTILE,8,* + Note: consolidation occurs here. + CDEF:ds0bits=ds0,8,* CDEF:ds1bits=ds1,8,* + Note: 10 spaces to move text to the right + COMMENT:" " + Note: three times size == 11 chars, "###.## xBps" + COMMENT:"Maximum " COMMENT:"Average " COMMENT:"Minimum " + Note: last line contains new-line character + COMMENT:"95th percentile\n" AREA:ds0bits#00C000:"Inbound " GPRINT:ds0max:"%6.2lf %Sbps" @@ -69,7 +85,9 @@ Depending on your needs you can do this in two ways: Offset the data, then graph this DEF:mydata=my.rrd:ds:AVERAGE + Note: this will also influence anything that uses "data" + CDEF:data=mydata,100,+ LINE1:data#FF0000:"Data with offset" @@ -78,9 +96,13 @@ Note: this will also influence anything that uses "data" Graph the original data, with an offset DEF:mydata=my.rrd:ds:AVERAGE + Note: no color in the first line so it is not visible + LINE1:100 + Note: the second line gets stacked on top of the first one + LINE1:data#FF0000:"Data with offset":STACK =back @@ -99,7 +121,9 @@ Note: the second line gets stacked on top of the first one --end now --start end-1w DEF:thisweek=router.rrd:ds0:AVERAGE DEF:lastweek=router.rrd:ds0:AVERAGE:end=now-1w:start=end-1w + shift the data forward by one week (604800 seconds) + SHIFT:lastweek:604800 [ more of the usual VDEF and CDEF stuff if you like ] AREA:lastweek#0000FF:Last\ week diff --git a/doc/rrdgraph_graph.src b/doc/rrdgraph_graph.src index 83ccae5..a683923 100644 --- a/doc/rrdgraph_graph.src +++ b/doc/rrdgraph_graph.src @@ -1,54 +1,44 @@ -=include name +=head1 NAME -=head1 SYNOPSIS - -=over 4 - -=item B - -=over 4 - -=item B : I : I : I - -=item B : I : I : I +=cut -=item B : I # I [ :I ] +WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED -=item B : I # I [ :I ] +=pod -=back +rrdgraph_graph - rrdtool graph command reference -Z<> +=head1 SYNOPSIS -=item B +BB<:>IB>I -=over 8 +BB<:>IB<:>I -=item B : I : I +BB<:>I -=item B : I : I +BB<:>IB<#>I[B<:>I] -=item B : I +BIB<:>IB<#>I[B<:>I][B<:>B] -=item B : I # I [ : I ] +BB<:>IB<#>I[B<:>I][B<:>B] -=item B{I} : I # I [ : I ] [ C<:STACK> ] +BB<:>IB<#>I[I][B<:>I[B<:>I]] -=item B C<:> I C<#> I [ C<:> I ] [ C<:STACK> ] +BB<:>IB<:>I =cut -# =item B : I B<#> I [ B<:> I ] +BB<:>IB<#>I[I][B<:>I] =pod -=item B : I B<#> I [ : I [ : I ] ] +BB<:>IB<:>IB<:>I (deprecated) -=item B : I , I +BB<:>IB<:>IB<:>I (deprecated) -=back +BB<:>IB<#>I[B<:>I] (deprecated) -=back +BB<:>IB<#>I[B<:>I] (deprecated) =head1 DESCRIPTION @@ -60,12 +50,12 @@ Similarly no report is generated if you don't use print options. =over 4 -=item B : I : I : I +=item BIB<:>I<:>I I The first form of this command is to be used with B Is. -=item B : I : I +=item BIB<:>I Depending on the context, either the value component or the time component of a B is printed using I. It is an error @@ -161,24 +151,24 @@ B<%Z> time zone =over 4 -=item B : I : I : I +=item BB<:>IB<:>IB<:>I I This is the same as C but now it is printed inside the graph. -=item B : I : I +=item BB<:>IB<:>I This is the same as C but now it is printed inside the graph. -=item B : I +=item BB<:>I Text is printed literally in the legend section of the graph -=item B : I # I [ :I ] +=item BB<:>IB<#>I [ :I ] I in new scripts.> -=item B : I # I [ : I ] +=item BB<:>IB<#>I [B<:>I ] Draw a vertical line at I