new command rrdtool xport integrated

[rrdtool.git] / doc / rrdgraph_graph.src

diff --git a/doc/rrdgraph_graph.src b/doc/rrdgraph_graph.src
index 44beac7..0209b05 100644 (file)
--- a/doc/rrdgraph_graph.src
+++ b/doc/rrdgraph_graph.src
@@ -2,26 +2,26 @@
 
 =head1 SYNOPSYS
 
-I<Depriciated commands>
+I<(to be) Depriciated commands>
 
 [B<PRINT:>I<vname>B<:>I<CF>B<:>I<format>]
 [B<GPRINT:>I<vname>B<:>I<CF>B<:>I<format>]
-[B<HRULE:>I<value>B<#>I<rrggbb>[B<:>I<legend>]]
-[B<STACK:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]]
+[B<HRULE:>I<value>B<#>I<rrggbbaa>[B<:>I<legend>]]
+[B<STACK:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]]]
 
-I<available commands>
+I<(soon) available commands>
 
 [B<PRINT:>I<vname>B<:>I<format>]
 [B<GPRINT:>I<vname>B<:>I<format>]
 [B<COMMENT:>I<text>]
-[B<VRULE:>I<vname>B<#>I<rrggbb>[B<:>I<legend>]]
-[B<LINE>{B<1>|B<2>|B<3>}B<:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]][B<:STACK>]
-[B<AREA:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]][B<:STACK>]
+[B<VRULE:>I<vname>B<#>I<rrggbbaa>[B<:>I<legend>]]
+[B<LINE>{I<width>}B<:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]]][B<:STACK>]
+[B<AREA:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]]][B<:STACK>]
+[B<PART:>I<vname>B<#>I<rrggbbaa>[B<:>I<legend>]]
 
 I<to be implemented commands>
 
 [B<SHIFT:>I<vname>]
-[B<PART:>I<vname>B<#>I<rrggbb>[B<:>I<legend>]]
 
 =head1 DESCRIPTION
 
@@ -131,27 +131,26 @@ B<GPRINT:>I<vname>B<:>I<CF>B<:>I<format>
 
 I<Depriciated. Use the new form of this command in new scripts.>
 This is the same as B<PRINT> but now it is printed inside the graph.
-See L<PRINT> for more information.
+See L<PRINT|rrdgraph/PRINT> for more information.
 
 B<GPRINT:>I<vname>B<:>I<format>
 
 This is the same as B<PRINT> but now it is printed inside the graph.
-See L<PRINT> for more information.
+See L<PRINT|rrdgraph/PRINT> for more information.
 
 B<COMMENT:>I<text>
 
 Text is printed literally in the legend section of the graph
 
-B<HRULE:>I<value>B<#>I<rrggbb>[B<:>I<legend>]
-
-I<Depriciated. Use a VDEF and a LINEx in new scripts.>
+B<HRULE:>I<value>B<#>I<rrggbbaa>[B<:>I<legend>]
 
 Draw an horizontal line at I<value>. Its color is composed from three
 hexadecimal numbers specifying the color components (00 is off, FF is
 maximum) red, green and blue.  Optionally a legend box and string is
-printed in the legend section.
+printed in the legend section. I<value> can be a variable from a B<VDEF>.
+It is an error to use I<vname>s from B<DEF> or B<CDEF> here.
 
-B<VRULE:>I<time>B<#>I<rrggbb>[B<:>I<legend>]
+B<VRULE:>I<time>B<#>I<rrggbbaa>[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
@@ -159,7 +158,7 @@ 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.
 
-B<LINE>{B<1>|B<2>|B<3>}B<:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]][B<:STACK>]
+B<LINE>{I<width>}B<:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]][B<:STACK>]
 
 Draw a line of the specified width into the graph. If the color
 is not specified, the drawing is done 'blind'.  This is useful when
@@ -170,12 +169,12 @@ 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>
 
-B<AREA:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]][B<:STACK>]
+B<AREA:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]][B<:STACK>]
 
 See B<LINEx>, however the area between the x-axis and the line will
 also be filled.
 
-B<STACK:>I<vname>[B<#>I<rrggbb>[B<:>I<legend>]]
+B<STACK:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]]
 
 I<Depriciated.  Use the B<STACK> modifiers on the other commands.>
 I<Note: the comments on stacking are still valid...>
@@ -191,6 +190,19 @@ graph this stacked variable anyway you need to make sure that the
 B<LINEx> or B<AREA> it gets stacked on is not unknown. Use a CDEF
 instruction with B<IF> and B<UN> to do so.
 
+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.
+
 B<THE NEXT STUFF IS NOT YET IMPLEMENTED>
 
 B<SHIFT:>I<offset in seconds>
@@ -204,19 +216,4 @@ can have an offset of zero to restore normal graphing.
 As with the other grapher elements, you can specify a number or
 a variable here.
 
-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
-(or, if no other graph elements are used, the canvas is solely
-used for the pie chart). The size of the canvas is determined by
-the lesser of L<width and height|rrdgraph/item_Size>.
-
-B<PART:>I<vname>B<#>I<rrggbb>[B<:>I<legend>]
-
-Draw a part of pie. 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.
-
 =include see_also