big spell checking patch -- slif@bellsouth.net

[rrdtool.git] / doc / rrdcgi.pod

diff --git a/doc/rrdcgi.pod b/doc/rrdcgi.pod
index 96008ad..66260ac 100644 (file)
--- a/doc/rrdcgi.pod
+++ b/doc/rrdcgi.pod
@@ -16,7 +16,7 @@ is to run as a cgi-program and parse a web page template containing special
 E<lt>RRD:: tags. B<rrdcgi> will interpret and act according to these tags.
 In the end it will printout a web page including the necessary CGI headers.
 
 E<lt>RRD:: tags. B<rrdcgi> will interpret and act according to these tags.
 In the end it will printout a web page including the necessary CGI headers.
 

-B<rrdcgi> parses the contents of the template in 2 steps. In each step it looks
+B<rrdcgi> parses the contents of the template in 3 steps. In each step it looks

 only for a subset of tags. This allows to nest tags. 
 
 The argument parser uses the same semantics as you are used from your c shell.
 only for a subset of tags. This allows to nest tags. 
 
 The argument parser uses the same semantics as you are used from your c shell.


@@ -30,7 +30,7 @@ Assume that rrdcgi is being run as a filter and not as a cgi.
 
 =back
 
 
 =back
 

-=head2 Pass 1
+=head2 Keywords

 
 =over 8
 
 
 =over 8
 


@@ -60,11 +60,6 @@ Get the value of an environment variable.
 might give you the name of the remote user given you are using
 some sort of access control on the directory
 
 might give you the name of the remote user given you are using
 some sort of access control on the directory
 

-=back
-
-=head2 Pass 2
-
-=over 8

 
 =item RRD::GOODFOR I<seconds>
 
 
 =item RRD::GOODFOR I<seconds>
 


@@ -86,26 +81,37 @@ could use
 to make sure everything is presented in Universal Time. Note that the
 values permitted to TZ depend on your OS.
 
 to make sure everything is presented in Universal Time. Note that the
 values permitted to TZ depend on your OS.
 

+=item RRD::SETVAR I<variable> I<value>
+
+Analog to SETENV but for local variables
+
+=item RRD::GETVAR I<variable> 
+
+Analog to GETENV but for local variables
+

 =item RRD::TIME::LAST I<rrd-file> I<strftime-format>
 
 This gets replaced by the last modification time of the selected RRD. The
 =item RRD::TIME::LAST I<rrd-file> I<strftime-format>
 
 This gets replaced by the last modification time of the selected RRD. The

-time is I<strftime>-formated with the string specified in the second argument.
+time is I<strftime>-formatted with the string specified in the second argument.

 
 =item RRD::TIME::NOW I<strftime-format>
 
 This gets replaced by the current time of day. The
 
 =item RRD::TIME::NOW I<strftime-format>
 
 This gets replaced by the current time of day. The

-time is I<strftime>-formated with the string specified in the argument.
+time is I<strftime>-formatted with the string specified in the argument.

 
 

-=back
+=item RRD::TIME::STRFTIME I<START|END> I<start-spec> I<end-spec> I<strftime-format>

 
 

-=head2 Pass 3
-
-=over 8
+This gets replaced by a strftime-formatted time using the format
+I<strftime-format> on either I<start-spec> or I<end-spec> depending on
+whether I<START> or I<END> is specified.  Both I<start-spec> and I<end-spec>
+must be supplied as either could be relative to the other.  This is intended
+to allow pretty titles on graphs with times that are easier for non RRDtool
+folks to figure out than "-2weeks".

 
 =item RRD::GRAPH I<rrdgraph arguments>
 
 This tag creates the RRD graph defined in its argument and then gets
 
 =item RRD::GRAPH I<rrdgraph arguments>
 
 This tag creates the RRD graph defined in its argument and then gets

-replaced by an appropriate E<lt>IMGE<gt> tag referring to the graph.
+replaced by an appropriate E<lt>IMG<gt> tag referring to the graph.

 The B<--lazy> option in RRD graph can be used to make sure that graphs
 are only regenerated when they are out of date. The arguments
 to the B<RRD::GRAPH> tag work as described in the B<rrdgraph> manual page.
 The B<--lazy> option in RRD graph can be used to make sure that graphs
 are only regenerated when they are out of date. The arguments
 to the B<RRD::GRAPH> tag work as described in the B<rrdgraph> manual page.