Code

don't deprecate HRULE anymore
authoroetiker <oetiker@a5681a0c-68f1-0310-ab6d-d61299d08faa>
Sun, 21 May 2006 13:08:46 +0000 (13:08 +0000)
committeroetiker <oetiker@a5681a0c-68f1-0310-ab6d-d61299d08faa>
Sun, 21 May 2006 13:08:46 +0000 (13:08 +0000)
git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2@829 a5681a0c-68f1-0310-ab6d-d61299d08faa

program/doc/rrdgraph_graph.pod

index 3c54e24fabf59540eca5732feea9ae177c1a3571..7e3aaf2c47b910045b4d21a9d9b9710fa2b84a7d 100644 (file)
@@ -14,6 +14,8 @@ B<COMMENT>B<:>I<text>
 
 B<VRULE>B<:>I<time>B<#>I<color>[B<:>I<legend>]
 
+B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>]
+
 B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
 
 B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
@@ -34,7 +36,6 @@ B<PRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
 
 B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
 
-B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>] (deprecated)
 
 B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>] (deprecated)
 
@@ -167,18 +168,20 @@ Text is printed literally in the legend section of the graph. Note that in
 RRDtool 1.2 you have to escape colons in COMMENT text in the same way you
 have to escape them in B<*PRINT> commands by writing B<'\:'>.
 
-=item B<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
-
-I<Deprecated. Use B<LINE> in new scripts.>
-
 =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
-maximum) red, green and blue. Optionally, a legend box and string is
+maximum) red, green and blue followed by an optional alpha. 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<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
+
+Draw a horyzontal line at I<value>.  HRULE acts much like LINE except that
+will have no effect on the scale of the graph. If a HRULE is outside the
+graphing area it will just not be visible.
+
 =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