RRDCGI(1)                           rrdtool                          RRDCGI(1)



[1mNAME[0m
       rrdcgi - create web pages containing RRD graphs based on templates

[1mSYNOPSIS[0m
       #!/path/to/[1mrrdcgi [22m[[1m--filter[22m]

[1mDESCRIPTION[0m
       [1mrrdcgi [22mis a sort of very limited script interpreter. Its purpose is to
       run as a cgi-program and parse a web page template containing special
       <RRD:: tags. [1mrrdcgi [22mwill interpret and act according to these tags.  In
       the end it will printout a web page including the necessary CGI head-
       ers.

       [1mrrdcgi [22mparses the contents of the template in 2 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.

       [1mPass 1[0m


       RRD::CV [4mname[0m
               Inserts the CGI variable of the given name.

       RRD::CV::QUOTE [4mname[0m
               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 as one argument.

       RRD::CV::PATH [4mname[0m
               Inserts the CGI variable of the given name, quotes it and makes
               sure the 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 [4mvariable[0m
               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

       [1mPass 2[0m


       RRD::GOODFOR [4mseconds[0m
               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 [4mnegative[24m a Refresh head-
               ers.

       RRD::INCLUDE [4mfilename[0m
               Include the contents of the given file into the page returned
               from the cgi

       RRD::SETENV [4mvariable[24m [4mvalue[0m
               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::TIME::LAST [4mrrd-file[24m [4mstrftime-format[0m
               This gets replaced by the last modification time of the
               selected RRD. The time is [4mstrftime[24m-formated with the string
               specified in the second argument.

       RRD::TIME::NOW [4mstrftime-format[0m
               This gets replaced by the current time of day. The time is
               [4mstrftime[24m-formated with the string specified in the argument.

       [1mPass 3[0m


       RRD::GRAPH [4mrrdgraph[24m [4marguments[0m
               This tag creates the RRD graph defined in its argument and then
               gets replaced by an appropriate <IMG> tag referring to the
               graph.  The [1m--lazy [22moption in RRD graph can be used to make sure
               that graphs are only regenerated when they are out of date. The
               arguments to the [1mRRD::GRAPH [22mtag work as described in the [1mrrd-[0m
               [1mgraph [22mmanual page.

               Use the [1m--lazy [22moption 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 [1m--imginfo [22mformat, the following
               will be used:

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

               Note that %s stands for the filename part of the graph gener-
               ated, all directories given in the GIF file argument will get
               dropped.

       RRD::PRINT [4mnumber[0m
               If the preceding  [1mRRD::GRAPH [22mtag contained and [1mPRINT [22marguments,
               then you can access their output with this tag. The [4mnumber[0m
               argument refers to the number of the [1mPRINT [22margument. This first
               [1mPRINT [22mhas [4mnumber[24m 0.

[1mEXAMPLE 1[0m
       The example below creates a web pages with a single RRD graph.

        #!/usr/local/bin/rrdcgi
        <HTML>
        <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
        <BODY>
        <H1>RRDCGI Example Page</H1>
        <P>
        <RRD::GRAPH demo.gif --lazy --title="Temperatures"
                 DEF:cel=demo.rrd:exhaust:AVERAGE
                 LINE2:cel#00a000:"D. Celsius">

        </P>
        </BODY>
        </HTML>

[1mEXAMPLE 2[0m
       This script is slightly more elaborate, it allows you to run it from a
       form which sets RRD_NAME. RRD_NAME is then used to select which RRD you
       want to use a source for your graph.

        #!/usr/local/bin/rrdcgi
        <HTML>
        <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
        <BODY>
        <H1>RRDCGI Example Page for <RRD::CV RRD_NAME></H1>
        <H2>Selection</H2>
        <FORM><INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomA> Room A,
              <INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomB> Room B.
              <INPUT TYPE=SUBMIT></FORM>
        <H2>Graph</H2>
        <P>
        <RRD::GRAPH <RRD::CV::PATH RRD_NAME>.gif --lazy
                 --title "Temperatures for "<RRD::CV::QUOTE RRD_NAME>
                 DEF:cel=<RRD::CV::PATH RRD_NAME>.rrd:exhaust:AVERAGE
                 LINE2:cel#00a000:"D. Celsius">

        </P>
        </BODY>
        </HTML>

[1mEXAMPLE 3[0m
       This example shows how to handle the case where the RRD, graphs and
       cgi-bins are seperate directories

        #!/.../bin/rrdcgi
        <HTML>
        <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
        <BODY>
        <H1>RRDCGI test Page</H1>
        <RRD::GRAPH
         /.../web/gifs/testhvt.gif
         --imginfo '<IMG SRC=/.../gifs/%s WIDTH=%lu HEIGHT=%lu >'
         --lazy --start -1d --end now
         DEF:http_src=/.../rrds/test.rrd:http_src:AVERAGE
         AREA:http_src#00ff00:http_src
        >
        </BODY>
        </HTML>

       Note 1: Replace /.../ with the relevant directories

       Note 2: The SRC=/.../gifs should be paths from the view of the web-
       server/browser

[1mAUTHOR[0m
       Tobias Oetiker <oetiker@ee.ethz.ch>



1.0.41                            2002-04-09                         RRDCGI(1)
