=head1 NAME
-Binary Decimal Hexadecimal - How does it work
+bin_dec_hex - How Binary, Decimal, Hexadecimal
=for html <div align="right"><a href="bin_dec_hex.pdf">PDF</a> version.</div>
basic questions. They will not only get their answer but at the same
time learn a whole lot more.
-Alex van den Bogaerdt
-<alex@ergens.op.het.net>
+Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
=head1 NAME
-rrd-beginners - Beginners guide
+rrd-beginners - RRDtool Beginners guide
=head1 SYNOPSIS
=head1 NAME
-rrdcgi - create web pages containing RRD graphs based on templates
+rrdcgi - Create web pages containing RRD graphs based on templates
=for html <div align="right"><a href="rrdcgi.pdf">PDF</a> version.</div>
=head1 NAME
-rrdtool create - Set up a new Round Robin Database
+rrdcreate - Set up a new Round Robin Database
=for html <div align="right"><a href="rrdcreate.pdf">PDF</a> version.</div>
=head1 NAME
-rrdtool dump - dump the contents of an B<RRD> to XML format
+rrddump - dump the contents of an RRD to XML format
=for html <div align="right"><a href="rrddump.pdf">PDF</a> version.</div>
=head1 NAME
-rrdtool fetch - fetch data from an RRD.
+rrdfetch - Fetch data from an RRD.
=for html <div align="right"><a href="rrdfetch.pdf">PDF</a> version.</div>
=head1 NAME
-rrdfirst - Return the date of the first data sample in an B<RRA> within an B<RRD>
+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 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<rrdtool graph> I<filename>
-[E<lt>B<L<option|rrdgraph/OPTIONS>>E<gt> ...]
-[E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt> ...]
-[E<lt>B<L<data calculation|rrdgraph_data/CDEF>>E<gt> ...]
-[E<lt>B<L<variable definition|rrdgraph_data/VDEF>>E<gt> ...]
-[E<lt>B<L<graph element|rrdgraph_graph/GRAPH>>E<gt> ...]
-[E<lt>B<L<print element|rrdgraph_graph/PRINT>>E<gt> ...]
+[I<L<option|rrdgraph/OPTIONS>> ...]
+[I<L<data definition|rrdgraph_data/DEF>> ...]
+[I<L<data calculation|rrdgraph_data/CDEF>> ...]
+[I<L<variable definition|rrdgraph_data/VDEF>> ...]
+[I<L<graph element|rrdgraph_graph/GRAPH>> ...]
+[I<L<print element|rrdgraph_graph/PRINT>> ...]
=head1 DESCRIPTION
-=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
-=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
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"
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"
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
--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
-=include name
+=head1 NAME
-=head1 SYNOPSIS
-
-=over 4
-
-=item B<old-style commands, for compatibility>
-
-=over 4
-
-=item B<PRINT> : I<vname> : I<CF> : I<format>
-
-=item B<GPRINT> : I<vname> : I<CF> : I<format>
+=cut
-=item B<HRULE> : I<value> # I<color> [ :I<legend> ]
+WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-=item B<STACK> : I<vname> # I<color> [ :I<legend> ]
+=pod
-=back
+rrdgraph_graph - rrdtool graph command reference
-Z<>
+=head1 SYNOPSIS
-=item B<available commands>
+B<PRINT>B<:>I<vname>B<B<:>>I<format>
-=over 8
+B<GPRINT>B<:>I<vname>B<:>I<format>
-=item B<PRINT> : I<vname> : I<format>
+B<COMMENT>B<:>I<text>
-=item B<GPRINT> : I<vname> : I<format>
+B<VRULE>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
-=item B<COMMENT> : I<text>
+B<LINE>I<width>B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
-=item B<VRULE> : I<vname> # I<color> [ : I<legend> ]
+B<AREA>B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
-=item B<LINE>{I<width>} : I<vname> # I<color> [ : I<legend> ] [ C<:STACK> ]
+B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
-=item B<AREA> C<:> I<vname> C<#> I<color> [ C<:> I<legend> ] [ C<:STACK> ]
+B<SHIFT>B<:>I<vname>B<:>I<offset>
=cut
-# =item B<PART> : I<vname> B<#> I<rrggbbaa> [ B<:> I<legend> ]
+B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
=pod
-=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
+B<PRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
-=item B<SHIFT> : I<vname> , I<offset>
+B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
-=back
+B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>] (deprecated)
-=back
+B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>] (deprecated)
=head1 DESCRIPTION
=over 4
-=item B<PRINT> : I<vname> : I<CF> : I<format>
+=item B<PRINT:>I<vname>B<:>I<CF><:>I<format>
I<Deprecated. Use the new form of this command in new scripts.>
The first form of this command is to be used with B<CDEF> I<vname>s.
-=item B<PRINT> : I<vname> : I<format>
+=item B<PRINT:>I<vname>B<:>I<format>
Depending on the context, either the value component or the time
component of a B<VDEF> is printed using I<format>. It is an error
=over 4
-=item B<GPRINT> : I<vname> : I<CF> : I<format>
+=item B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format>
I<Deprecated. Use the new form of this command in new scripts.>
This is the same as C<PRINT> but now it is printed inside the graph.
-=item B<GPRINT> : I<vname> : I<format>
+=item B<GPRINT>B<:>I<vname>B<:>I<format>
This is the same as C<PRINT> but now it is printed inside the graph.
-=item B<COMMENT> : I<text>
+=item B<COMMENT>B<:>I<text>
Text is printed literally in the legend section of the graph
-=item B<HRULE> : I<value> # I<color> [ :I<legend> ]
+=item B<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
I<Deprecated. Use B<LINEx> in new scripts.>
-=item B<VRULE> : I<vname> # I<color> [ : I<legend> ]
+=item B<VRULE>B<:>I<vname>B<#>I<color> [B<:>I<legend> ]
Draw a vertical line at I<time>. Its color is composed from three
hexadecimal numbers specifying the color components (00 is off, FF is
printed in the legend section. I<time> may be a number or a variable
from a B<VDEF>. It is an error to use I<vname>s from B<DEF> or B<CDEF> here.
-=item B<LINE>{I<width>} : I<{vname or number}> # I<color> [ : I<legend> ]
+=item B<LINE>I<width>B<:>I<{vname or number}>B<#>I<color>[B<:>I<legend>]
[ C<:STACK> ]
Draw a line of the specified width into the graph. If the color
stacked on top of the previous element which can be a B<LINEx> or
an B<AREA>
-=item B<AREA> C<:> I<vname> C<#> I<color> [ C<:> I<legend> ] [ C<:STACK> ]
+=item B<AREA>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>][B<:STACK>]
See B<LINE>, however the area between the x-axis and the line will
also be filled.
-=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
+=item B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
Plot a tick mark (a vertical line) for each value of I<vname> that is
non-zero and not *UNKNOWN*. The I<fraction> argument specifies the
is 0.1 (10% of the axis). Note that the color specification is not
optional.
-=item B<SHIFT> : I<vname> : I<offset>
+=item B<SHIFT>B<:>I<vname>B<:>I<offset>
Using this command B<RRDtool> will graph the following elements
with the specified offset. For instance, you can specify an
=cut
-#=item B<PART> : I<vname> B<#> I<rrggbbaa> [ B<:> I<legend> ]
-#
-
#B<RRDtool> has now support for B<pie charts>. If you include the
-
#B<PART> command, the canvas is extended to make room for a chart
-#The size of the canvas is determined by the lesser of
-#L<width and height|rrdgraph/item_Size>.
-#
-#Pie parts will be concatenated, the first one will start at the
-#top and parts will be created clockwise. The size of the part
-#is defined by the value part of the L<VDEF|rrdgraph_data/VDEF>
-#function. It should return a number between 0 and 100, being a
-#percentage. Providing wrong input will produce undefined results.
+=item B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
+
+B<RRDtool> has now support for B<pie charts>. If you include the
+B<PART> command, the canvas is extended to make room for a chart
+The size of the canvas is determined by the lesser of
+L<width and height|rrdgraph/item_Size>.
+
+Pie parts will be concatenated, the first one will start at the
+top and parts will be created clockwise. The size of the part
+is defined by the value part of the L<VDEF|rrdgraph_data/VDEF>
+function. It should return a number between 0 and 100, being a
+percentage. Providing wrong input will produce undefined results.
=pod
-=item B<STACK> : I<vname> # I<color> [ :I<legend> ]
+=item B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
I<Deprecated. Use the B<STACK> modifiers on the other commands.>
-=include name
+=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
-I<E<lt>RPN expressionE<gt>> :=
-I<E<lt>vnameE<gt>>|I<E<lt>operatorE<gt>>|I<E<lt>valueE<gt>>
-[ , I<E<lt>RPN expressionE<gt>>]
+I<RPN expression>:=I<vname>|I<operator>|I<value>[,I<RPN expression>]
=head1 DESCRIPTION
=head1 NAME
-rrdtool info - extract header information from an RRD
+rrdinfo - extract header information from an RRD
=for html <div align="right"><a href="rrdinfo.pdf">PDF</a> version.</div>
=head1 NAME
-rrdtool last - Return the date of the last data sample in an B<RRD>
+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 NAME
-rrdtool resize - alters the size of an RRA and creates new .rrd file
+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 NAME
-rrdtool restore - restore the contents of an B<RRD> from its XML dump format
+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 NAME
- rrdthreads - Provisions for linking the RRD library to use in multi-threaded programs
+rrdthreads - Provisions for linking the RRD library to use in multi-threaded programs
=head1 SYNOPSIS
In order to use the librrd in multi-threaded programs you must:
-=over 4
+=over
=item *
=back
-=head1 IMPORTANT NOTES FOR RRD CONTRIBUTORS:
+=head2 NOTES FOR RRD CONTRIBUTORS
Some precautions must be followed when developing RRD from now on:
-=over 4
+=over
=item *
functions aren't thread-safe. Take care in the following
situations/when using the following library functions:
-=over 8
+=over
=item *
=back
-As an aide(?) a header file named F<rrd_is_thread_safe.h> is provided
+=item *
+
+A header file named F<rrd_is_thread_safe.h> is provided
that works with the GNU C-preprocessor to "poison" some of the most
common non-thread-safe functions using the C<#pragma GCC poison>
directive. Just include this header in source files you want to keep
=back
-=head1 CURRENTLY IMPLEMENTED THREAD SAFE FUNCTIONS
+=head2 CURRENTLY IMPLEMENTED THREAD SAFE FUNCTIONS
Currently there exit thread-safe variants of C<rrd_update>,
C<rrd_create>, C<rrd_dump>, C<rrd_info> and C<rrd_last>.
=head1 AUTHOR
-Initial multi-threading support was implemented by Peter Stamfest
-<peter@stamfest.at> in Feb. 2003.
-
-This documentation was written by Peter Stamfest.
-
-Changes to the RRD library and this documentation are (c) 2003 by
-Peter Stamfest and are distributed under the GPL.
-
-=cut
+Peter Stamfest E<lt>peter@stamfest.atE<gt>
=head1 NAME
-rrdtool tune - Modify some basic properties of a Round Robin Database
+rrdtune - Modify some basic properties of a Round Robin Database
=for html <div align="right"><a href="rrdtune.pdf">PDF</a> version.</div>
=head1 NAME
-rrdtool update - Store a new set of values into the RRD
+rrdupdate - Store a new set of values into the RRD
=for html <div align="right"><a href="rrdupdate.pdf">PDF</a> version.</div>
=head1 NAME
-rrdtool xport - Export data in XML format based on data from one or several RRD
+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>
=item B<--step> I<value> (default automatic)
-See I<rrdgraph> documentation.
+See L<rrdgraph> documentation.
=item B<DEF:>I<vname>B<=>I<rrd>B<:>I<ds-name>B<:>I<CF>
projects / rrdtool.git / commitdiff