X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdcgi.pod;h=e999fea0966071d0e3f04fb2129c22de9ba34ea2;hb=09fa22ce43438f77625e759d7b29d8ae6bc56084;hp=cfa79a511b092015d9ebdf672ea3f476844017aa;hpb=9e81c95f3ef30967ea08f70a22bae2fe0031c901;p=rrdtool.git

diff --git a/doc/rrdcgi.pod b/doc/rrdcgi.pod
index cfa79a5..e999fea 100644
--- a/doc/rrdcgi.pod
+++ b/doc/rrdcgi.pod
@@ -1,13 +1,10 @@
 =head1 NAME
 
-rrdcgi - create web pages containing RRD graphs based on templates
-
-=for html <div align="right"><a href="rrdcgi.pdf">PDF</a> version.</div>
+rrdcgi - Create web pages containing RRD graphs based on templates
 
 =head1 SYNOPSIS
 
-#!/path/to/B<rrdcgi> 
-S<[B<--filter>]>
+C<#!/path/to/>B<rrdcgi> S<[B<--filter>]>
 
 =head1 DESCRIPTION
 
@@ -30,7 +27,7 @@ Assume that rrdcgi is being run as a filter and not as a cgi.
 
 =back
 
-=head2 Pass 1
+=head2 Keywords
 
 =over 8
 
@@ -60,11 +57,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
 
-=back
-
-=head2 Pass 2
-
-=over 8
 
 =item RRD::GOODFOR I<seconds>
 
@@ -86,15 +78,26 @@ could use
 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
-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
-time is I<strftime>-formated with the string specified in the argument.
+This gets replaced by the current time of day. The time is
+I<strftime>-formatted with the string specified in the argument.
+
+Note that if you return : from your strftime format you may have to escape
+them using \ if the time is to be used as an argument to a GRAPH command. 
 
 =item RRD::TIME::STRFTIME I<START|END> I<start-spec> I<end-spec> I<strftime-format>
 
@@ -102,14 +105,11 @@ 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
+to allow pretty titles on graphs with times that are easier for non RRDtool
 folks to figure out than "-2weeks".
 
-=back
-
-=head2 Pass 3
-
-=over 8
+Note that if you return : from your strftime format you may have to escape
+them using \ if the time is to be used as an argument to a GRAPH command.
 
 =item RRD::GRAPH I<rrdgraph arguments>