rrd_update and rrd_rpncalc - fix casts introduced by win32 patch to make gcc happy too
[rrdtool.git] / doc / rrdgraph_data.pod
index 02f9663..57b9d0a 100644 (file)
@@ -4,7 +4,7 @@ rrdgraph_data - preparing data for graphing in rrdtool graph
 
 =head1 SYNOPSIS
 
-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>>][:reduce=I<E<lt>B<CF>E<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>>][:reduce=I<E<lt>B<CF>E<gt>>][:daemon=I<E<lt>addressE<gt>>]
 
 B<VDEF>:I<vname>=I<RPN expression>
 
@@ -24,11 +24,11 @@ C<A-Z, a-z, 0-9, -,_> and a maximum length of 255 characters.
 
 When picking variable names, make sure you do not choose a name that is
 already taken by an RPN operator. A safe bet it to use lowercase or
-mixedcase names for variables since operators will always be in uppercase.
+mixed case names for variables since operators will always be in uppercase.
 
 =head1 DEF
 
-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>>][:reduce=I<E<lt>B<CF>E<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>>][:reduce=I<E<lt>B<CF>E<gt>>][:daemon=I<E<lt>addressE<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
@@ -50,16 +50,24 @@ image with width 400 and time span 400*1800 seconds (use appropriate
 start and end times, such as C<--start end-8days8hours>).
 
 If consolidation needs to be done, the B<CF> of the B<RRA> specified in the
-B<DEF> itself will be used to reduce the data density. This behaviour can
+B<DEF> itself will be used to reduce the data density. This behavior can
 be changed using C<:reduce=I<E<lt>B<CF>E<gt>>>.  This optional parameter
 specifies the B<CF> to use during the data reduction phase.
 
+It is possible to request single data sources from a specific I<RRDCacheD>, see
+L<rrdcached(1)>, using the C<:daemon=I<E<lt>addressE<gt>>> parameter. The
+value given to this parameter follows the same syntax as other means to specify
+the address of the caching daemon. It is described in detail in the
+L<rrdcached(1)> manual page. Beware, however, that colons (in IPv6 addresses
+and as a port separator, for example) need to be escaped using a backslash.
+
 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
+        DEF:ds0weekly=router.rrd:ds0:AVERAGE:daemon=collect1.example.com
 
 =head1 VDEF
 
@@ -116,7 +124,7 @@ maximum value during the graph period).
 
 If you want to apply 'complex' operations to the result of a VDEF you have
 to use a CDEF again since VDEFs only look like RPN expressions, they aren't
-realy.
+really.
 
 =head1 SEE ALSO