-=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.>
projects / rrdtool.git / blobdiff