X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdcgi.html;h=359a6200a88a09e05dfa5758c670d71c5e6fdfd9;hb=HEAD;hp=6cdda17c46f6818a78f9749a3fee100b99ed7690;hpb=1559397b94b4af3de73cfa23c04be31d8bee53e7;p=pkg-rrdtool.git diff --git a/doc/rrdcgi.html b/doc/rrdcgi.html index 6cdda17..359a620 100644 --- a/doc/rrdcgi.html +++ b/doc/rrdcgi.html @@ -9,8 +9,10 @@ -

+ +
+

+ + +

@@ -52,7 +58,7 @@ 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.

@@ -62,19 +68,19 @@ only for a subset of tags. This allows nesting of tags.

Keywords

-
RRD::CV name
+
RRD::CV 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 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.

-
RRD::CV::PATH name
+
RRD::CV::PATH name

Inserts the CGI variable of the given name, quotes it and makes sure @@ -82,7 +88,7 @@ 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
+
RRD::GETENV variable

Get the value of an environment variable.

@@ -91,19 +97,19 @@ CGI interface.

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 the rrdcgi to output a Last-Modified, an Expire and if the number of seconds is negative a Refresh header.

-
RRD::INCLUDE filename
+
RRD::INCLUDE filename

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

-
RRD::SETENV variable value
+
RRD::SETENV variable value

If you want to present your graphs in another time zone than your own, you @@ -113,23 +119,23 @@ could use

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

-
RRD::SETVAR variable value
+
RRD::SETVAR variable value

Analog to SETENV but for local variables.

-
RRD::GETVAR variable
+
RRD::GETVAR variable

Analog to GETENV but for local variables.

-
RRD::TIME::LAST rrd-file strftime-format
+
RRD::TIME::LAST rrd-file strftime-format

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
+
RRD::TIME::NOW strftime-format

This gets replaced by the current time of day. The time is @@ -138,7 +144,7 @@ time is strftime-formatted with the string specified in the second argu 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 @@ -146,12 +152,12 @@ to a GRAPH command.

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 @@ -169,14 +175,14 @@ be used:

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, 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.

-
RRD::INTERNAL <var>
+
RRD::INTERNAL <var>

This tag gets replaced by an internal var. Currently these vars are known: