X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.pod;h=2364f54cbbc2da00f55917a07a78f401f8ce9a8e;hb=c5d2a40e2cad0e082c55b0fa6542ebdb231ab03a;hp=94bfdbcfb5dc1240f4a7753979fbbbcfe9236aa2;hpb=4b7345f9345915c8061e4b37b26ce8887828c973;p=rrdtool.git

diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod
index 94bfdbc..2364f54 100644
--- a/doc/rrdgraph_graph.pod
+++ b/doc/rrdgraph_graph.pod
@@ -1,4 +1,6 @@
-=head1 NAME  
+=pod
+
+=head1 NAME
 
 rrdgraph_graph - rrdtool graph command reference
 
@@ -10,11 +12,11 @@ B<GPRINT>B<:>I<vname>B<:>I<format>
 
 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>]]
 
@@ -22,7 +24,9 @@ B<SHIFT>B<:>I<vname>B<:>I<offset>
 
 =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
 
@@ -44,10 +48,6 @@ Similarly, no report is generated if you don't use print options.
 
 =over 4
 
-=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>B<:>I<format>
 
@@ -141,30 +141,37 @@ B<%Z> prints the time zone.
 
 =back
 
+=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.
+
 =back
 
 =head1 GRAPH
 
 =over 4
 
-=item B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format>
+=item B<GPRINT>B<:>I<vname>B<:>I<format>
 
-I<Deprecated. Use the new form of this command in new scripts.>
 This is the same as C<PRINT>, but printed inside the graph.
 
-=item B<GPRINT>B<:>I<vname>B<:>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 printed inside the graph.
 
 =item B<COMMENT>B<:>I<text>
 
-Text is printed literally in the legend section of the graph.
+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<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
@@ -172,19 +179,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<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>.
 
-Draw a line of the specified width onto the graph. 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>, 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<LINEx> or
-an 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.
@@ -208,21 +217,23 @@ a variable here.
 
 =cut
 
-=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.
-
-=for comment
-XXX Above: shouldn't this be caught and and error be generated? Fritz
+# This section describes the curruently defunct
+# PieChart code.
+#
+# =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
 
@@ -238,7 +249,7 @@ When stacking, an element is not placed above the X-axis but rather
 on top of the previous element.  There must be something to stack
 upon.
 
-You can use an B<invisible> LINEx 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