X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdcgi.pod;h=9089c52f76356cc4844be800d8c20c3fb9bdc108;hp=96008ade990777cc91bdc8a22d6b89563a8eaaa2;hb=b837c0527f117b54845242ee7626df6d88394444;hpb=a5e4941495ccd729d4777dfe2682e924bffbb715 diff --git a/doc/rrdcgi.pod b/doc/rrdcgi.pod index 96008ad..9089c52 100644 --- 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 ERRD:: tags. B will interpret and act according to these tags. In the end it will printout a web page including the necessary CGI headers. -B parses the contents of the template in 2 steps. In each step it looks +B 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. @@ -30,7 +30,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 +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 -=back - -=head2 Pass 2 - -=over 8 =item RRD::GOODFOR I @@ -86,6 +81,14 @@ 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 I + +Analog to SETENV but for local variables + +=item RRD::GETVAR I + +Analog to GETENV but for local variables + =item RRD::TIME::LAST I I This gets replaced by the last modification time of the selected RRD. The @@ -96,16 +99,19 @@ time is I-formated with the string specified in the second argument. This gets replaced by the current time of day. The time is I-formated with the string specified in the argument. -=back +=item RRD::TIME::STRFTIME I I I I -=head2 Pass 3 - -=over 8 +This gets replaced by a strftime-formatted time using the format +I on either I or I depending on +whether I or I is specified. Both I and I +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 This tag creates the RRD graph defined in its argument and then gets -replaced by an appropriate EIMGE tag referring to the graph. +replaced by an appropriate EIMG 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 tag work as described in the B manual page.