clarify LINE/AREA syntax
authoroetiker <oetiker@a5681a0c-68f1-0310-ab6d-d61299d08faa>
Thu, 5 May 2005 22:15:10 +0000 (22:15 +0000)
committeroetiker <oetiker@a5681a0c-68f1-0310-ab6d-d61299d08faa>
Thu, 5 May 2005 22:15:10 +0000 (22:15 +0000)
-- Alex van den Bogaerdt alex with ergens.op.het.net

git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@485 a5681a0c-68f1-0310-ab6d-d61299d08faa

doc/rrdgraph_graph.pod

index d045676..7ceac61 100644 (file)
@@ -14,9 +14,9 @@ B<COMMENT>B<:>I<text>
 
 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>]]
 
@@ -177,19 +177,21 @@ maximum) red, green and blue. Optionally, a legend box and string 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>.
 
-=item B<AREA>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>][B<:STACK>]
+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<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.