X-Git-Url: https://git.tokkee.org/?p=pkg-rrdtool.git;a=blobdiff_plain;f=doc%2Frrdcgi.html;h=359a6200a88a09e05dfa5758c670d71c5e6fdfd9;hp=67831b1a2c593ec5803c3b1ba23acfe4329f89fd;hb=645054bac6187b0e83fd4125fd59e4feda216b64;hpb=ffa00ac697dccce18dca8880ca7a14066521ac5c diff --git a/doc/rrdcgi.html b/doc/rrdcgi.html index 67831b1..359a620 100644 --- a/doc/rrdcgi.html +++ b/doc/rrdcgi.html @@ -1,14 +1,18 @@ + rrdcgi + -

+ +
+

+ + +

@@ -50,172 +58,138 @@ In the end it will printout a web page including the necessary CGI headers.

only for a subset of tags. This allows nesting of tags.

The argument parser uses the same semantics as you are used from your C-shell.

-
--filter
-
+
--filter
+
-Assume that rrdcgi is run as a filter and not as a cgi. +

Assume that rrdcgi is run as a filter and not as a cgi.

-

+

Keywords

-
RRD::CV name
-
+
RRD::CV name
+
-Inserts the CGI variable of the given name. +

Inserts the CGI variable of the given name.

-

-
RRD::CV::QUOTE name
-
+
RRD::CV::QUOTE name
+
-Inserts the CGI variable of the given name but quotes it, ready for +

Inserts the CGI variable of the given name but quotes it, ready for use as an argument in another RRD:: tag. So even when there are spaces in the -value of the CGI variable it will still be considered to be one argument. +value of the CGI variable it will still be considered to be one argument.

-

-
RRD::CV::PATH name
-
+
RRD::CV::PATH name
+
-Inserts the CGI variable of the given name, quotes it and makes sure +

Inserts the CGI variable of the given name, quotes it and makes sure it starts neither with a '/' nor contains '..'. This is to make sure that no problematic pathnames can be introduced through the -CGI interface. -

-

-
RRD::GETENV variable
-
-
-Get the value of an environment variable. +CGI interface.

+
RRD::GETENV variable
+
+

Get the value of an environment variable.

  <RRD::GETENV REMOTE_USER>
-
-

might give you the name of the remote user given you are using some sort of access control on the directory.

-

-
RRD::GOODFOR seconds
-
+
RRD::GOODFOR seconds
+
-Specify the number of seconds this page should remain valid. This will prompt +

Specify the number of seconds this page should remain valid. This will prompt the rrdcgi to output a Last-Modified, an Expire and if the number of -seconds is negative a Refresh header. +seconds is negative a Refresh header.

-

-
RRD::INCLUDE filename
-
-
-Include the contents of the specified file into the page returned from the cgi. -
-

-
RRD::SETENV variable value
-
+
RRD::INCLUDE filename
+
-If you want to present your graphs in another time zone than your own, you -could use +

Include the contents of the specified file into the page returned from the cgi.

+
RRD::SETENV variable value
+
+

If you want to present your graphs in another time zone than your own, you +could use

  <RRD::SETENV TZ UTC>
-
-

to make sure everything is presented in Universal Time. Note that the values permitted to TZ depend on your OS.

-

-
RRD::SETVAR variable value
-
-
-Analog to SETENV but for local variables. -
-

-
RRD::GETVAR variable
-
+
RRD::SETVAR variable value
+
-Analog to GETENV but for local variables. +

Analog to SETENV but for local variables.

-

-
RRD::TIME::LAST rrd-file strftime-format
-
+
RRD::GETVAR variable
+
-This gets replaced by the last modification time of the selected RRD. The -time is strftime-formatted with the string specified in the second argument. +

Analog to GETENV but for local variables.

-

-
RRD::TIME::NOW strftime-format
-
+
RRD::TIME::LAST rrd-file strftime-format
+
-This gets replaced by the current time of day. The time is -strftime-formatted with the string specified in the argument. +

This gets replaced by the last modification time of the selected RRD. The +time is strftime-formatted with the string specified in the second argument.

+
RRD::TIME::NOW strftime-format
+
+

This gets replaced by the current time of day. The time is +strftime-formatted with the string specified in the argument.

Note that if you return : (colons) 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.

-

-
RRD::TIME::STRFTIME START|END start-spec end-spec strftime-format
-
+
RRD::TIME::STRFTIME START|END start-spec end-spec strftime-format
+
-This gets replaced by a strftime-formatted time using the format +

This gets replaced by a strftime-formatted time using the format strftime-format on either start-spec or end-spec depending on whether START or END is specified. Both start-spec and 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''. -

-
+folks to figure out than "-2weeks".

Note that again, if you return : (colon) 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.

-

-
RRD::GRAPH rrdgraph arguments
-
+
RRD::GRAPH rrdgraph arguments
+
-This tag creates the RRD graph defined by its argument and then is +

This tag creates the RRD graph defined by its argument and then is replaced by an appropriate <IMG ... > tag referring to the graph. The --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 RRD::GRAPH tag work as described in the rrdgraph manual page. -

-
+to the RRD::GRAPH tag work as described in the rrdgraph manual page.

Use the --lazy option in your RRD::GRAPH tags, to reduce the load on your server. This option makes sure that graphs are only regenerated when the old ones are out of date.

-
-

If you do not specify your own --imginfo format, the following will be used:

-
-
  <IMG SRC="%s" WIDTH="%lu" HEIGHT="%lu">
-
-

Note that %s stands for the filename part of the graph generated, all directories given in the PNG file argument will get dropped.

-

-
RRD::PRINT number
-
+
RRD::PRINT number
+
-If the preceding RRD::GRAPH tag contained and PRINT arguments, +

If the preceding RRD::GRAPH tag contained and PRINT arguments, then you can access their output with this tag. The number argument refers to the -number of the PRINT argument. This first PRINT has number 0. +number of the PRINT argument. This first PRINT has number 0.

-

-
RRD::INTERNAL <var>
-
+
RRD::INTERNAL <var>
+
-This tag gets replaced by an internal var. Currently these vars are known: +

This tag gets replaced by an internal var. Currently these vars are known: VERSION, COMPILETIME. -These vars represent the compiled-in values. +These vars represent the compiled-in values.

-

+