Changed DEF:...

git-svn-id: svn://svn.oetiker.ch/rrdtool/trunk/program@153 a5681a0c-68f1-0310-ab6d-d61299d08faa

diff --git a/doc/rrdgraph.src b/doc/rrdgraph.src
index 108a80e..89b4268 100644 (file)
--- a/doc/rrdgraph.src
+++ b/doc/rrdgraph.src
@@ -4,8 +4,7 @@
 
 B<rrdtool graph> I<filename>
 [E<lt>B<L<option|rrdgraph/OPTIONS>>E<gt> ...]
-E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt>
-[E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt> ...]
+E<lt>B<L<data definition|rrdgraph_data/DEF>>E<gt>[ ...]
 [E<lt>B<L<data calculation|rrdgraph_data/CDEF>>E<gt> ...]
 [E<lt>B<L<variable definition|rrdgraph_data/VDEF>>E<gt> ...]
 [E<lt>B<L<graph element|rrdgraph_graph/GRAPH>>E<gt> ...]
@@ -334,7 +333,7 @@ Z<>
 
 =item Data and variables
 
-B<DEF:>I<E<lt>vnameE<gt>>=I<E<lt>rrdfileE<gt>>:I<E<lt>ds-nameE<gt>>:I<E<lt>CFE<gt>>[:[I<E<lt>time rangeE<gt>>][:I<E<lt>step timeE<gt>>]]
+B<DEF:>I<E<lt>vnameE<gt>>=I<E<lt>rrdfileE<gt>>:I<E<lt>ds-nameE<gt>>:I<E<lt>CFE<gt>>[:step=I<E<lt>stepE<gt>>][:start=I<E<lt>timeE<gt>>][:end=I<E<lt>timeE<gt>>]
 
 B<CDEF:>I<E<lt>vnameE<gt>>=I<E<lt>RPN expressionE<gt>>
 

diff --git a/doc/rrdgraph_data.src b/doc/rrdgraph_data.src
index 9b9ec8a..47a7bea 100644 (file)
--- a/doc/rrdgraph_data.src
+++ b/doc/rrdgraph_data.src
@@ -2,7 +2,7 @@
 
 =head1 SYNOPSYS
 
-B<DEF>:I<vname>=I<RRD file>:I<ds name>:I<CF>[:step=I<step size>][:<time range>>]
+B<DEF:>I<E<lt>vnameE<gt>>=I<E<lt>rrdfileE<gt>>:I<E<lt>ds-nameE<gt>>:I<E<lt>CFE<gt>>[:step=I<E<lt>stepE<gt>>][:start=I<E<lt>timeE<gt>>][:end=I<E<lt>timeE<gt>>]
 
 B<VDEF>:I<vname>=I<RPN expression>
 
@@ -18,7 +18,7 @@ a language called B<RPN> which is described in its own manual page.
 
 =head1 DEF
 
-B<DEF>:I<vname>=I<RRD file>:I<ds name>:I<CF>[:step=I<step size>][:<time range>>]
+B<DEF:>I<E<lt>vnameE<gt>>=I<E<lt>rrdfileE<gt>>:I<E<lt>ds-nameE<gt>>:I<E<lt>CFE<gt>>[:step=I<E<lt>stepE<gt>>][:start=I<E<lt>timeE<gt>>][:end=I<E<lt>timeE<gt>>]
 
 This command fetches data from an B<RRD> file.  The virtual name
 I<vname> can then be used throughout the rest of the script. By
@@ -26,9 +26,9 @@ default, an B<RRA> which contains the correct consolidated data
 at an appropriate resolution will be chosen.  The resolution can
 be overriden with the L<--step|rrdgraph/item_Time> option. 
 The resolution can again be overriden by specifying the B<step size>.
-I<Not yet implemented:> [ The time span of this data
-is the same as for the graph by default, you can override this by
-specifying the B<time range>. ]
+The time span of this data is the same as for the graph by default,
+you can override this by specifying B<start and end>.  Remember to
+escape colons in the time specification!
 
 If the resolution of the data is higher than the resolution of off
 graph, the data will be further consolidated.  This may result in
@@ -43,6 +43,8 @@ Example:
 
         DEF:ds0=router.rrd:ds0:AVERAGE
         DEF:ds0weekly=router.rrd:ds0:AVERAGE:step=7200
+        DEF:ds0weekly=router.rrd:ds0:AVERAGE:start=end-1h
+        DEF:ds0weekly=router.rrd:ds0:AVERAGE:start=11\:00:end=start+1h
 
 =head1 VDEF
 

diff --git a/doc/rrdgraph_graph.src b/doc/rrdgraph_graph.src
index 0209b05..5b163d4 100644 (file)
--- a/doc/rrdgraph_graph.src
+++ b/doc/rrdgraph_graph.src
@@ -2,26 +2,53 @@
 
 =head1 SYNOPSYS
 
-I<(to be) Depriciated commands>
+=over 4
+
+=item B<to be depriciated commands>
+
+=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
+
+=item B<available commands>
+
+=over 8
+
+=item B<PRINT> : I<vname> : I<format>
+
+=item B<GPRINT> : I<vname> : I<format>
+
+=item B<COMMENT> : I<text>
+
+=item B<VRULE> : I<vname> # I<color> [ : I<legend> ]
+
+=item B<LINE>{I<width>} : I<vname> # I<color> [ : I<legend> ] [ : STACK ]
+
+=item B<AREA> C<:> I<vname> C<#> I<color> [ C<:> I<legend> ] [ C<:> C<STACK> ]
+
+=item B<PART> : I<vname> B<#> I<rrggbbaa> [ B<:> I<legend> ]
 
-[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<rrggbbaa>[B<:>I<legend>]]
-[B<STACK:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]]]
+=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
 
-I<(soon) available commands>
+=back
+
+=item B<to be implemented 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<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>]]
+=over 8
 
-I<to be implemented commands>
+=item B<SHIFT> : I<vname> , I<offset>
 
-[B<SHIFT:>I<vname>]
+=back
+
+=back
 
 =head1 DESCRIPTION
 
@@ -31,12 +58,14 @@ Similarly no report is generated if you don't use print options.
 
 =head1 PRINT
 
-B<PRINT:>I<vname>B<:>I<CF>B<:>I<format>
+=over 4
+
+=item B<PRINT> : I<vname> : I<CF> : I<format>
 
 I<Depriciated. 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.
 
-B<PRINT:>I<vname>B<:>I<format>
+=item B<PRINT> : I<vname> : 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
@@ -125,24 +154,26 @@ B<%Z> time zone
 
 =back
 
+=back
+
 =head1 GRAPH
 
-B<GPRINT:>I<vname>B<:>I<CF>B<:>I<format>
+=over 4
+
+=item B<GPRINT> : I<vname> : I<CF> : 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|rrdgraph/PRINT> for more information.
+This is the same as C<PRINT> but now it is printed inside the graph.
 
-B<GPRINT:>I<vname>B<:>I<format>
+=item B<GPRINT> : I<vname> : I<format>
 
-This is the same as B<PRINT> but now it is printed inside the graph.
-See L<PRINT|rrdgraph/PRINT> for more information.
+This is the same as C<PRINT> but now it is printed inside the graph.
 
-B<COMMENT:>I<text>
+=item B<COMMENT> : I<text>
 
 Text is printed literally in the legend section of the graph
 
-B<HRULE:>I<value>B<#>I<rrggbbaa>[B<:>I<legend>]
+=item B<HRULE> : I<value> # I<color> [ :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
@@ -150,7 +181,7 @@ maximum) red, green and blue.  Optionally a legend box and string is
 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<rrggbbaa>[B<:>I<legend>]
+=item B<VRULE> : I<vname> # I<color> [ : 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
@@ -158,7 +189,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>{I<width>}B<:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]][B<:STACK>]
+=item B<LINE>{I<width>} : I<vname> # I<color> [ : I<legend> ] [ : 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
@@ -169,19 +200,19 @@ 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<rrggbbaa>[B<:>I<legend>]][B<:STACK>]
+=item B<AREA> C<:> I<vname> C<#> I<color> [ C<:> I<legend> ] [ C<:> C<STACK> ]
 
-See B<LINEx>, however the area between the x-axis and the line will
+See B<LINE>, however the area between the x-axis and the line will
 also be filled.
 
-B<STACK:>I<vname>[B<#>I<rrggbbaa>[B<:>I<legend>]]
+=item B<STACK> : I<vname> # I<color> [ :I<legend> ]
 
 I<Depriciated.  Use the B<STACK> modifiers on the other commands.>
 I<Note: the comments on stacking are still valid...>
 Repeats the last B<LINEx> or B<AREA> however it doesn't start at the
 x-axis but rather on top of the previous element. This implies that
 there needs to be something to stack on. An invisible B<LINEx> or
-B<AREA> is something you can stack on!
+B<AREA> is something you can stack on, an unknown value is not!
 
 Note: When you stack on something that was I<unknown>, the whole
 stack will be I<unknown> for that point in time. If the beginning
@@ -190,7 +221,7 @@ 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>]
+=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
@@ -203,9 +234,21 @@ 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>
+=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : 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
+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.
 
-B<SHIFT:>I<offset in seconds>
+=back
+
+B<THE NEXT COMMAND IS NOT YET IMPLEMENTED>
+
+=over 4
+
+=item B<SHIFT> : I<vname> , I<offset>
 
 Using this command B<RRDtool> will graph the following elements
 with the specified offset.  For instance, you can specify an
@@ -216,4 +259,6 @@ 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.
 
+=back
+
 =include see_also