Code

Imported upstream version 1.3rc9.
[pkg-rrdtool.git] / doc / rrdcgi.html
1 <?xml version="1.0" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <title>rrdcgi</title>
6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
7 <link rev="made" href="mailto:root@localhost" />
8 </head>
10 <body style="background-color: white">
12 <p><a name="__index__"></a></p>
13 <!-- INDEX BEGIN -->
14 <!--
16 <ul>
18         <li><a href="#name">NAME</a></li>
19         <li><a href="#synopsis">SYNOPSIS</a></li>
20         <li><a href="#description">DESCRIPTION</a></li>
21         <ul>
23                 <li><a href="#keywords">Keywords</a></li>
24         </ul>
26         <li><a href="#example_1">EXAMPLE 1</a></li>
27         <li><a href="#example_2">EXAMPLE 2</a></li>
28         <li><a href="#example_3">EXAMPLE 3</a></li>
29         <li><a href="#author">AUTHOR</a></li>
30 </ul>
31 -->
32 <!-- INDEX END -->
34 <p>
35 </p>
36 <h1><a name="name">NAME</a></h1>
37 <p>rrdcgi - Create web pages containing RRD graphs based on templates</p>
38 <p>
39 </p>
40 <hr />
41 <h1><a name="synopsis">SYNOPSIS</a></h1>
42 <p><code>#!/path/to/</code><strong>rrdcgi</strong> [<strong>--filter</strong>]</p>
43 <p>
44 </p>
45 <hr />
46 <h1><a name="description">DESCRIPTION</a></h1>
47 <p><strong>rrdcgi</strong> is a sort of very limited script interpreter. Its purpose
48 is to run as a cgi-program and parse a web page template containing special
49 &lt;RRD:: tags. <strong>rrdcgi</strong> will interpret and act according to these tags.
50 In the end it will printout a web page including the necessary CGI headers.</p>
51 <p><strong>rrdcgi</strong> parses the contents of the template in 3 steps. In each step it looks
52 only for a subset of tags. This allows nesting of tags.</p>
53 <p>The argument parser uses the same semantics as you are used from your C-shell.</p>
54 <dl>
55 <dt><strong><a name="item__2d_2dfilter"><strong>--filter</strong></a></strong></dt>
57 <dd>
58 <p>Assume that rrdcgi is run as a filter and not as a cgi.</p>
59 </dd>
60 </dl>
61 <p>
62 </p>
63 <h2><a name="keywords">Keywords</a></h2>
64 <dl>
65 <dt><strong><a name="item_rrd_3a_3acv_name">RRD::CV <em>name</em></a></strong></dt>
67 <dd>
68 <p>Inserts the CGI variable of the given name.</p>
69 </dd>
70 <dt><strong><a name="item_rrd_3a_3acv_3a_3aquote_name">RRD::CV::QUOTE <em>name</em></a></strong></dt>
72 <dd>
73 <p>Inserts the CGI variable of the given name but quotes it, ready for
74 use as an argument in another RRD:: tag. So even when there are spaces in the
75 value of the CGI variable it will still be considered to be one argument.</p>
76 </dd>
77 <dt><strong><a name="item_rrd_3a_3acv_3a_3apath_name">RRD::CV::PATH <em>name</em></a></strong></dt>
79 <dd>
80 <p>Inserts the CGI variable of the given name, quotes it and makes sure
81 it starts neither with a '/' nor contains '..'. This is to make
82 sure that no problematic pathnames can be introduced through the
83 CGI interface.</p>
84 </dd>
85 <dt><strong><a name="item_rrd_3a_3agetenv_variable">RRD::GETENV <em>variable</em></a></strong></dt>
87 <dd>
88 <p>Get the value of an environment variable.</p>
89 <pre>
90  &lt;RRD::GETENV REMOTE_USER&gt;</pre>
91 <p>might give you the name of the remote user given you are using
92 some sort of access control on the directory.</p>
93 </dd>
94 <dt><strong><a name="item_rrd_3a_3agoodfor_seconds">RRD::GOODFOR <em>seconds</em></a></strong></dt>
96 <dd>
97 <p>Specify the number of seconds this page should remain valid. This will prompt
98 the rrdcgi to output a Last-Modified, an Expire and if the number of
99 seconds is <em>negative</em> a Refresh header.</p>
100 </dd>
101 <dt><strong><a name="item_rrd_3a_3ainclude_filename">RRD::INCLUDE <em>filename</em></a></strong></dt>
103 <dd>
104 <p>Include the contents of the specified file into the page returned from the cgi.</p>
105 </dd>
106 <dt><strong><a name="item_rrd_3a_3asetenv_variable_value">RRD::SETENV <em>variable</em> <em>value</em></a></strong></dt>
108 <dd>
109 <p>If you want to present your graphs in another time zone than your own, you
110 could use</p>
111 <pre>
112  &lt;RRD::SETENV TZ UTC&gt;</pre>
113 <p>to make sure everything is presented in Universal Time. Note that the
114 values permitted to TZ depend on your OS.</p>
115 </dd>
116 <dt><strong><a name="item_rrd_3a_3asetvar_variable_value">RRD::SETVAR <em>variable</em> <em>value</em></a></strong></dt>
118 <dd>
119 <p>Analog to SETENV but for local variables.</p>
120 </dd>
121 <dt><strong><a name="item_rrd_3a_3agetvar_variable">RRD::GETVAR <em>variable</em></a></strong></dt>
123 <dd>
124 <p>Analog to GETENV but for local variables.</p>
125 </dd>
126 <dt><strong><a name="item_rrd_3a_3atime_3a_3alast_rrd_2dfile_strftime_2dform">RRD::TIME::LAST <em>rrd-file</em> <em>strftime-format</em></a></strong></dt>
128 <dd>
129 <p>This gets replaced by the last modification time of the selected RRD. The
130 time is <em>strftime</em>-formatted with the string specified in the second argument.</p>
131 </dd>
132 <dt><strong><a name="item_rrd_3a_3atime_3a_3anow_strftime_2dformat">RRD::TIME::NOW <em>strftime-format</em></a></strong></dt>
134 <dd>
135 <p>This gets replaced by the current time of day. The time is
136 <em>strftime</em>-formatted with the string specified in the argument.</p>
137 <p>Note that if you return : (colons) from your strftime format you may
138 have to escape them using \ if the time is to be used as an argument
139 to a GRAPH command.</p>
140 </dd>
141 <dt><strong><a name="item_rrd_3a_3atime_3a_3astrftime_start_7cend_start_2dsp">RRD::TIME::STRFTIME <em>START|END</em> <em>start-spec</em> <em>end-spec</em> <em>strftime-format</em></a></strong></dt>
143 <dd>
144 <p>This gets replaced by a strftime-formatted time using the format
145 <em>strftime-format</em> on either <em>start-spec</em> or <em>end-spec</em> depending on
146 whether <em>START</em> or <em>END</em> is specified.  Both <em>start-spec</em> and <em>end-spec</em>
147 must be supplied as either could be relative to the other.  This is intended
148 to allow pretty titles on graphs with times that are easier for non RRDtool
149 folks to figure out than ``-2weeks''.</p>
150 <p>Note that again, if you return : (colon) from your strftime format,
151 you may have to escape them using \ if the time is to be used as an
152 argument to a GRAPH command.</p>
153 </dd>
154 <dt><strong><a name="item_rrd_3a_3agraph_rrdgraph_arguments">RRD::GRAPH <em>rrdgraph arguments</em></a></strong></dt>
156 <dd>
157 <p>This tag creates the RRD graph defined by its argument and then is
158 replaced by an appropriate &lt;IMG ... &gt; tag referring to the graph.
159 The <strong>--lazy</strong> option in RRD graph can be used to make sure that graphs
160 are only regenerated when they are out of date. The arguments
161 to the <strong>RRD::GRAPH</strong> tag work as described in the <strong>rrdgraph</strong> manual page.</p>
162 <p>Use the <strong>--lazy</strong> option in your RRD::GRAPH tags, to reduce the load
163 on your server. This option makes sure that graphs are only regenerated when
164 the old ones are out of date.</p>
165 <p>If you do not specify your own <strong>--imginfo</strong> format, the following will
166 be used:</p>
167 <pre>
168  &lt;IMG SRC=&quot;%s&quot; WIDTH=&quot;%lu&quot; HEIGHT=&quot;%lu&quot;&gt;</pre>
169 <p>Note that %s stands for the filename part of the graph generated, all
170 directories given in the PNG file argument will get dropped.</p>
171 </dd>
172 <dt><strong><a name="item_rrd_3a_3aprint_number">RRD::PRINT <em>number</em></a></strong></dt>
174 <dd>
175 <p>If the preceding  <strong>RRD::GRAPH</strong> tag contained and <strong>PRINT</strong> arguments,
176 then you can access their output with this tag. The <em>number</em> argument refers to the
177 number of the <strong>PRINT</strong> argument. This first <strong>PRINT</strong> has <em>number</em> 0.</p>
178 </dd>
179 <dt><strong><a name="item_rrd_3a_3ainternal__3cvar_3e">RRD::INTERNAL &lt;var&gt;</a></strong></dt>
181 <dd>
182 <p>This tag gets replaced by an internal var. Currently these vars are known:
183 VERSION, COMPILETIME.
184 These vars represent the compiled-in values.</p>
185 </dd>
186 </dl>
187 <p>
188 </p>
189 <hr />
190 <h1><a name="example_1">EXAMPLE 1</a></h1>
191 <p>The example below creates a web pages with a single RRD graph.</p>
192 <pre>
193  #!/usr/local/bin/rrdcgi
194  &lt;HTML&gt;
195  &lt;HEAD&gt;&lt;TITLE&gt;RRDCGI Demo&lt;/TITLE&gt;&lt;/HEAD&gt;
196  &lt;BODY&gt;
197  &lt;H1&gt;RRDCGI Example Page&lt;/H1&gt;
198  &lt;P&gt;
199  &lt;RRD::GRAPH demo.png --lazy --title=&quot;Temperatures&quot;
200           DEF:cel=demo.rrd:exhaust:AVERAGE
201           LINE2:cel#00a000:&quot;D. Celsius&quot;&gt;</pre>
202 <pre>
203  &lt;/P&gt;
204  &lt;/BODY&gt;
205  &lt;/HTML&gt;</pre>
206 <p>
207 </p>
208 <hr />
209 <h1><a name="example_2">EXAMPLE 2</a></h1>
210 <p>This script is slightly more elaborate, it allows you to run it from
211 a form which sets RRD_NAME. RRD_NAME is then used to select which RRD
212 you want to use as source for your graph.</p>
213 <pre>
214  #!/usr/local/bin/rrdcgi
215  &lt;HTML&gt;
216  &lt;HEAD&gt;&lt;TITLE&gt;RRDCGI Demo&lt;/TITLE&gt;&lt;/HEAD&gt;
217  &lt;BODY&gt;
218  &lt;H1&gt;RRDCGI Example Page for &lt;RRD::CV RRD_NAME&gt;&lt;/H1&gt;
219  &lt;H2&gt;Selection&lt;/H2&gt;
220  &lt;FORM&gt;&lt;INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomA&gt; Room A,
221        &lt;INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomB&gt; Room B.
222        &lt;INPUT TYPE=SUBMIT&gt;&lt;/FORM&gt;
223  &lt;H2&gt;Graph&lt;/H2&gt;
224  &lt;P&gt;
225  &lt;RRD::GRAPH &lt;RRD::CV::PATH RRD_NAME&gt;.png --lazy
226           --title &quot;Temperatures for &quot;&lt;RRD::CV::QUOTE RRD_NAME&gt;
227           DEF:cel=&lt;RRD::CV::PATH RRD_NAME&gt;.rrd:exhaust:AVERAGE
228           LINE2:cel#00a000:&quot;D. Celsius&quot;&gt;</pre>
229 <pre>
230  &lt;/P&gt;
231  &lt;/BODY&gt;
232  &lt;/HTML&gt;</pre>
233 <p>
234 </p>
235 <hr />
236 <h1><a name="example_3">EXAMPLE 3</a></h1>
237 <p>This example shows how to handle the case where the RRD, graphs and
238 cgi-bins are seperate directories</p>
239 <pre>
240  #!/.../bin/rrdcgi
241  &lt;HTML&gt;
242  &lt;HEAD&gt;&lt;TITLE&gt;RRDCGI Demo&lt;/TITLE&gt;&lt;/HEAD&gt;
243  &lt;BODY&gt;
244  &lt;H1&gt;RRDCGI test Page&lt;/H1&gt;
245  &lt;RRD::GRAPH
246   /.../web/pngs/testhvt.png
247   --imginfo '&lt;IMG SRC=/.../pngs/%s WIDTH=%lu HEIGHT=%lu &gt;'
248   --lazy --start -1d --end now
249   DEF:http_src=/.../rrds/test.rrd:http_src:AVERAGE
250   AREA:http_src#00ff00:http_src
251  &gt;
252  &lt;/BODY&gt;
253  &lt;/HTML&gt;</pre>
254 <p>Note 1: Replace /.../ with the relevant directories</p>
255 <p>Note 2: The SRC=/.../pngs should be paths from the view of the
256 webserver/browser</p>
257 <p>
258 </p>
259 <hr />
260 <h1><a name="author">AUTHOR</a></h1>
261 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
263 </body>
265 </html>