index 6a3db054b6b3e551c84edd3e8f26f25e6df9de71..2364f54cbbc2da00f55917a07a78f401f8ce9a8e 100644 (file)
-=pod
+=pod
-=head1 NAME
+=head1 NAME
rrdgraph_graph - rrdtool graph command reference
B<COMMENT>B<:>I<text>
-B<VRULE>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
+B<VRULE>B<:>I<time>B<#>I<color>[B<:>I<legend>]
-B<LINE>[I<width>]B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
+B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
-B<AREA>B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
+B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
=cut
-B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
+#
+#B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
+#
=pod
=item B<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
-I<Deprecated. Use B<LINEx> in new scripts.>
+I<Deprecated. Use B<LINE> in new scripts.>
-=item B<VRULE>B<:>I<vname>B<#>I<color> [B<:>I<legend> ]
+=item B<VRULE>B<:>I<time>B<#>I<color> [B<:>I<legend> ]
Draw a vertical line at I<time>. Its color is composed from three
hexadecimal numbers specifying the rgb 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>]B<:>I<{vname or number}>B<#>I<color>[B<:>I<legend>]
-[ C<:STACK> ]
+=item B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
Draw a line of the specified width onto the graph. I<width> can be a
floating point number. If the color is not specified, the drawing is done
'invisibly'. This is useful when stacking something else on top of this
line. Also optional is the legend box and string which will be printed in
-the legend section if specified. The B<vname> can be generated by B<DEF>,
+the legend section if specified. The B<value> can be generated by B<DEF>,
B<VDEF>, and B<CDEF>. If the optional B<STACK> modifier is used, this line
is stacked on top of the previous element which can be a B<LINE> or an
-B<AREA>
+B<AREA>.
+
+When you do not specify a color, you cannot specify a legend. Should
+you want to use STACK, use the "LINEx:<value>::STACK" form.
-=item B<AREA>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>][B<:STACK>]
+=item B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
See B<LINE>, however the area between the x-axis and the line will
be filled.
on top of the previous element. There must be something to stack
upon.
-You can use an B<invisible> LINE or AREA to stacked upon.
+You can use an B<invisible> LINE or AREA to stacked upon.
An B<unknown> value makes the entire stack unknown from that moment on.
You don't know where to begin (the unknown value) and therefore do