X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.src;h=bf92d454ac84c58000594b36dce362c478066e89;hb=09fa22ce43438f77625e759d7b29d8ae6bc56084;hp=83ccae58aa29f6fe16e5ce3aac93a490d3add621;hpb=3392d4474ce348fcee1a65bf8f2d9e9a90b7c8f4;p=rrdtool.git

diff --git a/doc/rrdgraph_graph.src b/doc/rrdgraph_graph.src
index 83ccae5..bf92d45 100644
--- a/doc/rrdgraph_graph.src
+++ b/doc/rrdgraph_graph.src
@@ -1,54 +1,38 @@
-=include name
+=head1 NAME  
 
-=head1 SYNOPSIS
-
-=over 4
-
-=item B<old-style commands, for compatibility>
-
-=over 4
-
-=item B<PRINT> : I<vname> : I<CF> : I<format>
-
-=item B<GPRINT> : I<vname> : I<CF> : I<format>
-
-=item B<HRULE> : I<value> # I<color> [ :I<legend> ]
-
-=item B<STACK> : I<vname> # I<color> [ :I<legend> ]
-
-=back
+rrdgraph_graph - rrdtool graph command reference
 
-Z<>
+=head1 SYNOPSIS
 
-=item B<available commands>
+B<PRINT>B<:>I<vname>B<:>I<format>
 
-=over 8
+B<GPRINT>B<:>I<vname>B<:>I<format>
 
-=item B<PRINT> : I<vname> : I<format>
+B<COMMENT>B<:>I<text>
 
-=item B<GPRINT> : I<vname> : I<format>
+B<VRULE>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
 
-=item B<COMMENT> : I<text>
+B<LINE>I<width>B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
 
-=item B<VRULE> : I<vname> # I<color> [ : I<legend> ]
+B<AREA>B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
 
-=item B<LINE>{I<width>} : I<vname> # I<color> [ : I<legend> ] [ C<:STACK> ]
+B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
 
-=item B<AREA> C<:> I<vname> C<#> I<color> [ C<:> I<legend> ] [ C<:STACK> ]
+B<SHIFT>B<:>I<vname>B<:>I<offset>
 
 =cut
 
-# =item B<PART> : I<vname> B<#> I<rrggbbaa> [ B<:> I<legend> ]
+B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
 
 =pod
 
-=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
+B<PRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
 
-=item B<SHIFT> : I<vname> , I<offset>
+B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
 
-=back
+B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>] (deprecated)
 
-=back
+B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>] (deprecated)
 
 =head1 DESCRIPTION
 
@@ -60,12 +44,12 @@ Similarly no report is generated if you don't use print options.
 
 =over 4
 
-=item B<PRINT> : I<vname> : I<CF> : I<format>
+=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> : I<format>
+=item B<PRINT:>I<vname>B<:>I<format>
 
 Depending on the context, either the value component or the time
 component of a B<VDEF> is printed using I<format>. It is an error
@@ -161,24 +145,24 @@ B<%Z> time zone
 
 =over 4
 
-=item B<GPRINT> : I<vname> : I<CF> : 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 now it is printed inside the graph.
 
-=item B<GPRINT> : I<vname> : I<format>
+=item B<GPRINT>B<:>I<vname>B<:>I<format>
 
 This is the same as C<PRINT> but now it is printed inside the graph.
 
-=item B<COMMENT> : I<text>
+=item B<COMMENT>B<:>I<text>
 
 Text is printed literally in the legend section of the graph
 
-=item B<HRULE> : I<value> # I<color> [ :I<legend> ]
+=item B<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
 
 I<Deprecated. Use B<LINEx> in new scripts.>
 
-=item B<VRULE> : I<vname> # I<color> [ : I<legend> ]
+=item B<VRULE>B<:>I<vname>B<#>I<color> [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
@@ -186,7 +170,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.
 
-=item B<LINE>{I<width>} : I<{vname or number}> # I<color> [ : I<legend> ]
+=item B<LINE>I<width>B<:>I<{vname or number}>B<#>I<color>[B<:>I<legend>]
 [ C<:STACK> ]
 
 Draw a line of the specified width into the graph. If the color
@@ -198,12 +182,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>
 
-=item B<AREA> C<:> I<vname> C<#> I<color> [ C<:> I<legend> ] [ C<:STACK> ]
+=item B<AREA>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>][B<:STACK>]
 
 See B<LINE>, however the area between the x-axis and the line will
 also be filled.
 
-=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
+=item B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
 
 Plot a tick mark (a vertical line) for each value of I<vname> that is
 non-zero and not *UNKNOWN*. The I<fraction> argument specifies the
@@ -211,7 +195,7 @@ length of the tick mark as a fraction of the y-axis; the default value
 is 0.1 (10% of the axis). Note that the color specification is not
 optional.
 
-=item B<SHIFT> : I<vname> : I<offset>
+=item B<SHIFT>B<:>I<vname>B<:>I<offset>
 
 Using this command B<RRDtool> will graph the following elements
 with the specified offset.  For instance, you can specify an
@@ -222,22 +206,22 @@ a variable here.
 
 =cut
 
-#=item 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.
+=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
 
-=item B<STACK> : I<vname> # I<color> [ :I<legend> ]
+=item B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
 
 I<Deprecated.  Use the B<STACK> modifiers on the other commands.>
 
@@ -294,4 +278,17 @@ If you are using the proportional font in your graph, you can use tab characters
 or the sequence B<\t> to lin-up legend elements. Note that the tabs inserted are
 relative to the start of the current legend element!
 
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>