Code

Imported upstream version 1.3.8.
[pkg-rrdtool.git] / doc / rrdcgi.html
index 6cdda17c46f6818a78f9749a3fee100b99ed7690..359a6200a88a09e05dfa5758c670d71c5e6fdfd9 100644 (file)
@@ -9,8 +9,10 @@
 
 <body style="background-color: white">
 
-<p><a name="__index__"></a></p>
+
 <!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
 <!--
 
 <ul>
        <li><a href="#example_3">EXAMPLE 3</a></li>
        <li><a href="#author">AUTHOR</a></li>
 </ul>
+
 -->
+
+
+</div>
 <!-- INDEX END -->
 
 <p>
@@ -52,7 +58,7 @@ In the end it will printout a web page including the necessary CGI headers.</p>
 only for a subset of tags. This allows nesting of tags.</p>
 <p>The argument parser uses the same semantics as you are used from your C-shell.</p>
 <dl>
-<dt><strong><a name="item__2d_2dfilter"><strong>--filter</strong></a></strong></dt>
+<dt><strong><a name="filter" class="item"><strong>--filter</strong></a></strong></dt>
 
 <dd>
 <p>Assume that rrdcgi is run as a filter and not as a cgi.</p>
@@ -62,19 +68,19 @@ only for a subset of tags. This allows nesting of tags.</p>
 </p>
 <h2><a name="keywords">Keywords</a></h2>
 <dl>
-<dt><strong><a name="item_rrd_3a_3acv_name">RRD::CV <em>name</em></a></strong></dt>
+<dt><strong><a name="rrd_cv_name" class="item">RRD::CV <em>name</em></a></strong></dt>
 
 <dd>
 <p>Inserts the CGI variable of the given name.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3acv_3a_3aquote_name">RRD::CV::QUOTE <em>name</em></a></strong></dt>
+<dt><strong><a name="rrd_cv_quote_name" class="item">RRD::CV::QUOTE <em>name</em></a></strong></dt>
 
 <dd>
 <p>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.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3acv_3a_3apath_name">RRD::CV::PATH <em>name</em></a></strong></dt>
+<dt><strong><a name="rrd_cv_path_name" class="item">RRD::CV::PATH <em>name</em></a></strong></dt>
 
 <dd>
 <p>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.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3agetenv_variable">RRD::GETENV <em>variable</em></a></strong></dt>
+<dt><strong><a name="rrd_getenv_variable" class="item">RRD::GETENV <em>variable</em></a></strong></dt>
 
 <dd>
 <p>Get the value of an environment variable.</p>
@@ -91,19 +97,19 @@ CGI interface.</p>
 <p>might give you the name of the remote user given you are using
 some sort of access control on the directory.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3agoodfor_seconds">RRD::GOODFOR <em>seconds</em></a></strong></dt>
+<dt><strong><a name="rrd_goodfor_seconds" class="item">RRD::GOODFOR <em>seconds</em></a></strong></dt>
 
 <dd>
 <p>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 <em>negative</em> a Refresh header.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3ainclude_filename">RRD::INCLUDE <em>filename</em></a></strong></dt>
+<dt><strong><a name="rrd_include_filename" class="item">RRD::INCLUDE <em>filename</em></a></strong></dt>
 
 <dd>
 <p>Include the contents of the specified file into the page returned from the cgi.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3asetenv_variable_value">RRD::SETENV <em>variable</em> <em>value</em></a></strong></dt>
+<dt><strong><a name="rrd_setenv_variable_value" class="item">RRD::SETENV <em>variable</em> <em>value</em></a></strong></dt>
 
 <dd>
 <p>If you want to present your graphs in another time zone than your own, you
@@ -113,23 +119,23 @@ could use</p>
 <p>to make sure everything is presented in Universal Time. Note that the
 values permitted to TZ depend on your OS.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3asetvar_variable_value">RRD::SETVAR <em>variable</em> <em>value</em></a></strong></dt>
+<dt><strong><a name="rrd_setvar_variable_value" class="item">RRD::SETVAR <em>variable</em> <em>value</em></a></strong></dt>
 
 <dd>
 <p>Analog to SETENV but for local variables.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3agetvar_variable">RRD::GETVAR <em>variable</em></a></strong></dt>
+<dt><strong><a name="rrd_getvar_variable" class="item">RRD::GETVAR <em>variable</em></a></strong></dt>
 
 <dd>
 <p>Analog to GETENV but for local variables.</p>
 </dd>
-<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>
+<dt><strong><a name="rrd_time_last_rrd_file_strftime_format" class="item">RRD::TIME::LAST <em>rrd-file</em> <em>strftime-format</em></a></strong></dt>
 
 <dd>
 <p>This gets replaced by the last modification time of the selected RRD. The
 time is <em>strftime</em>-formatted with the string specified in the second argument.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3atime_3a_3anow_strftime_2dformat">RRD::TIME::NOW <em>strftime-format</em></a></strong></dt>
+<dt><strong><a name="rrd_time_now_strftime_format" class="item">RRD::TIME::NOW <em>strftime-format</em></a></strong></dt>
 
 <dd>
 <p>This gets replaced by the current time of day. The time is
@@ -138,7 +144,7 @@ time is <em>strftime</em>-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.</p>
 </dd>
-<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>
+<dt><strong><a name="rrd_time_strftime_start_end_start_spec_end_spec_strftime_format" class="item">RRD::TIME::STRFTIME <em>START|END</em> <em>start-spec</em> <em>end-spec</em> <em>strftime-format</em></a></strong></dt>
 
 <dd>
 <p>This gets replaced by a strftime-formatted time using the format
@@ -146,12 +152,12 @@ to a GRAPH command.</p>
 whether <em>START</em> or <em>END</em> is specified.  Both <em>start-spec</em> and <em>end-spec</em>
 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''.</p>
+folks to figure out than &quot;-2weeks&quot;.</p>
 <p>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.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3agraph_rrdgraph_arguments">RRD::GRAPH <em>rrdgraph arguments</em></a></strong></dt>
+<dt><strong><a name="rrd_graph_rrdgraph_arguments" class="item">RRD::GRAPH <em>rrdgraph arguments</em></a></strong></dt>
 
 <dd>
 <p>This tag creates the RRD graph defined by its argument and then is
@@ -169,14 +175,14 @@ be used:</p>
 <p>Note that %s stands for the filename part of the graph generated, all
 directories given in the PNG file argument will get dropped.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3aprint_number">RRD::PRINT <em>number</em></a></strong></dt>
+<dt><strong><a name="rrd_print_number" class="item">RRD::PRINT <em>number</em></a></strong></dt>
 
 <dd>
 <p>If the preceding  <strong>RRD::GRAPH</strong> tag contained and <strong>PRINT</strong> arguments,
 then you can access their output with this tag. The <em>number</em> argument refers to the
 number of the <strong>PRINT</strong> argument. This first <strong>PRINT</strong> has <em>number</em> 0.</p>
 </dd>
-<dt><strong><a name="item_rrd_3a_3ainternal__3cvar_3e">RRD::INTERNAL &lt;var&gt;</a></strong></dt>
+<dt><strong><a name="rrd_internal_var" class="item">RRD::INTERNAL &lt;var&gt;</a></strong></dt>
 
 <dd>
 <p>This tag gets replaced by an internal var. Currently these vars are known: