← Back to branch summary

~ubuntu-branches/ubuntu/maverick/rrdtool/maverick

« back to all changes in this revision

Viewing changes to doc/rrdcgi.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Harl
  • Date: 2008-04-16 15:50:54 UTC
  • mfrom: (1.2.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20080416155054-asl84ug7em7lgx8m
Tags: 1.2.27-2
http://bugs.debian.org/476022
* Renamed global definition of LDFLAGS to LINKER_FLAGS in debian/rules to
  work around a broken behavior of dpkg which would use those flags
  unconditionally whenever invoking the linker, which is not wanted e.g.
  when compiling the python bindings (Closes: #476022).
* Actually pass the linker flags to configure.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rrdcgi.html
 
1
<?xml version="1.0" ?>
1
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
3
<html xmlns="http://www.w3.org/1999/xhtml">
3
4
<head>
4
5
<title>rrdcgi</title>
 
6
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
5
7
<link rev="made" href="mailto:root@localhost" />
6
8
</head>
7
9
 
50
52
only for a subset of tags. This allows nesting of tags.</p>
51
53
<p>The argument parser uses the same semantics as you are used from your C-shell.</p>
52
54
<dl>
53
 
<dt><strong><a name="item__2d_2dfilter"><strong>--filter</strong></a></strong><br />
54
 
</dt>
 
55
<dt><strong><a name="item__2d_2dfilter"><strong>--filter</strong></a></strong>
 
56
 
55
57
<dd>
56
 
Assume that rrdcgi is run as a filter and not as a cgi.
 
58
<p>Assume that rrdcgi is run as a filter and not as a cgi.</p>
57
59
</dd>
58
 
<p></p></dl>
 
60
</li>
 
61
</dl>
59
62
<p>
60
63
</p>
61
64
<h2><a name="keywords">Keywords</a></h2>
62
65
<dl>
63
 
<dt><strong><a name="item_rrd_3a_3acv_name">RRD::CV <em>name</em></a></strong><br />
64
 
</dt>
 
66
<dt><strong><a name="item_rrd_3a_3acv_name">RRD::CV <em>name</em></a></strong>
 
67
 
65
68
<dd>
66
 
Inserts the CGI variable of the given name.
 
69
<p>Inserts the CGI variable of the given name.</p>
67
70
</dd>
68
 
<p></p>
69
 
<dt><strong><a name="item_rrd_3a_3acv_3a_3aquote_name">RRD::CV::QUOTE <em>name</em></a></strong><br />
70
 
</dt>
 
71
</li>
 
72
<dt><strong><a name="item_rrd_3a_3acv_3a_3aquote_name">RRD::CV::QUOTE <em>name</em></a></strong>
 
73
 
71
74
<dd>
72
 
Inserts the CGI variable of the given name but quotes it, ready for
 
75
<p>Inserts the CGI variable of the given name but quotes it, ready for
73
76
use as an argument in another RRD:: tag. So even when there are spaces in the
74
 
value of the CGI variable it will still be considered to be one argument.
 
77
value of the CGI variable it will still be considered to be one argument.</p>
75
78
</dd>
76
 
<p></p>
77
 
<dt><strong><a name="item_rrd_3a_3acv_3a_3apath_name">RRD::CV::PATH <em>name</em></a></strong><br />
78
 
</dt>
 
79
</li>
 
80
<dt><strong><a name="item_rrd_3a_3acv_3a_3apath_name">RRD::CV::PATH <em>name</em></a></strong>
 
81
 
79
82
<dd>
80
 
Inserts the CGI variable of the given name, quotes it and makes sure
 
83
<p>Inserts the CGI variable of the given name, quotes it and makes sure
81
84
it starts neither with a '/' nor contains '..'. This is to make
82
85
sure that no problematic pathnames can be introduced through the
83
 
CGI interface.
 
86
CGI interface.</p>
84
87
</dd>
85
 
<p></p>
86
 
<dt><strong><a name="item_rrd_3a_3agetenv_variable">RRD::GETENV <em>variable</em></a></strong><br />
87
 
</dt>
 
88
</li>
 
89
<dt><strong><a name="item_rrd_3a_3agetenv_variable">RRD::GETENV <em>variable</em></a></strong>
 
90
 
88
91
<dd>
89
 
Get the value of an environment variable.
 
92
<p>Get the value of an environment variable.</p>
90
93
</dd>
91
94
<dd>
92
95
<pre>
96
99
<p>might give you the name of the remote user given you are using
97
100
some sort of access control on the directory.</p>
98
101
</dd>
99
 
<p></p>
100
 
<dt><strong><a name="item_rrd_3a_3agoodfor_seconds">RRD::GOODFOR <em>seconds</em></a></strong><br />
101
 
</dt>
 
102
</li>
 
103
<dt><strong><a name="item_rrd_3a_3agoodfor_seconds">RRD::GOODFOR <em>seconds</em></a></strong>
 
104
 
102
105
<dd>
103
 
Specify the number of seconds this page should remain valid. This will prompt
 
106
<p>Specify the number of seconds this page should remain valid. This will prompt
104
107
the rrdcgi to output a Last-Modified, an Expire and if the number of
105
 
seconds is <em>negative</em> a Refresh header.
106
 
</dd>
107
 
<p></p>
108
 
<dt><strong><a name="item_rrd_3a_3ainclude_filename">RRD::INCLUDE <em>filename</em></a></strong><br />
109
 
</dt>
110
 
<dd>
111
 
Include the contents of the specified file into the page returned from the cgi.
112
 
</dd>
113
 
<p></p>
114
 
<dt><strong><a name="item_rrd_3a_3asetenv_variable_value">RRD::SETENV <em>variable</em> <em>value</em></a></strong><br />
115
 
</dt>
116
 
<dd>
117
 
If you want to present your graphs in another time zone than your own, you
118
 
could use
 
108
seconds is <em>negative</em> a Refresh header.</p>
 
109
</dd>
 
110
</li>
 
111
<dt><strong><a name="item_rrd_3a_3ainclude_filename">RRD::INCLUDE <em>filename</em></a></strong>
 
112
 
 
113
<dd>
 
114
<p>Include the contents of the specified file into the page returned from the cgi.</p>
 
115
</dd>
 
116
</li>
 
117
<dt><strong><a name="item_rrd_3a_3asetenv_variable_value">RRD::SETENV <em>variable</em> <em>value</em></a></strong>
 
118
 
 
119
<dd>
 
120
<p>If you want to present your graphs in another time zone than your own, you
 
121
could use</p>
119
122
</dd>
120
123
<dd>
121
124
<pre>
125
128
<p>to make sure everything is presented in Universal Time. Note that the
126
129
values permitted to TZ depend on your OS.</p>
127
130
</dd>
128
 
<p></p>
129
 
<dt><strong><a name="item_rrd_3a_3asetvar_variable_value">RRD::SETVAR <em>variable</em> <em>value</em></a></strong><br />
130
 
</dt>
131
 
<dd>
132
 
Analog to SETENV but for local variables.
133
 
</dd>
134
 
<p></p>
135
 
<dt><strong><a name="item_rrd_3a_3agetvar_variable">RRD::GETVAR <em>variable</em></a></strong><br />
136
 
</dt>
137
 
<dd>
138
 
Analog to GETENV but for local variables.
139
 
</dd>
140
 
<p></p>
141
 
<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><br />
142
 
</dt>
143
 
<dd>
144
 
This gets replaced by the last modification time of the selected RRD. The
145
 
time is <em>strftime</em>-formatted with the string specified in the second argument.
146
 
</dd>
147
 
<p></p>
148
 
<dt><strong><a name="item_rrd_3a_3atime_3a_3anow_strftime_2dformat">RRD::TIME::NOW <em>strftime-format</em></a></strong><br />
149
 
</dt>
150
 
<dd>
151
 
This gets replaced by the current time of day. The time is
152
 
<em>strftime</em>-formatted with the string specified in the argument.
 
131
</li>
 
132
<dt><strong><a name="item_rrd_3a_3asetvar_variable_value">RRD::SETVAR <em>variable</em> <em>value</em></a></strong>
 
133
 
 
134
<dd>
 
135
<p>Analog to SETENV but for local variables.</p>
 
136
</dd>
 
137
</li>
 
138
<dt><strong><a name="item_rrd_3a_3agetvar_variable">RRD::GETVAR <em>variable</em></a></strong>
 
139
 
 
140
<dd>
 
141
<p>Analog to GETENV but for local variables.</p>
 
142
</dd>
 
143
</li>
 
144
<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>
 
145
 
 
146
<dd>
 
147
<p>This gets replaced by the last modification time of the selected RRD. The
 
148
time is <em>strftime</em>-formatted with the string specified in the second argument.</p>
 
149
</dd>
 
150
</li>
 
151
<dt><strong><a name="item_rrd_3a_3atime_3a_3anow_strftime_2dformat">RRD::TIME::NOW <em>strftime-format</em></a></strong>
 
152
 
 
153
<dd>
 
154
<p>This gets replaced by the current time of day. The time is
 
155
<em>strftime</em>-formatted with the string specified in the argument.</p>
153
156
</dd>
154
157
<dd>
155
158
<p>Note that if you return : (colons) from your strftime format you may
156
159
have to escape them using \ if the time is to be used as an argument
157
160
to a GRAPH command.</p>
158
161
</dd>
159
 
<p></p>
160
 
<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><br />
161
 
</dt>
 
162
</li>
 
163
<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>
 
164
 
162
165
<dd>
163
 
This gets replaced by a strftime-formatted time using the format
 
166
<p>This gets replaced by a strftime-formatted time using the format
164
167
<em>strftime-format</em> on either <em>start-spec</em> or <em>end-spec</em> depending on
165
168
whether <em>START</em> or <em>END</em> is specified.  Both <em>start-spec</em> and <em>end-spec</em>
166
169
must be supplied as either could be relative to the other.  This is intended
167
170
to allow pretty titles on graphs with times that are easier for non RRDtool
168
 
folks to figure out than ``-2weeks''.
 
171
folks to figure out than ``-2weeks''.</p>
169
172
</dd>
170
173
<dd>
171
174
<p>Note that again, if you return : (colon) from your strftime format,
172
175
you may have to escape them using \ if the time is to be used as an
173
176
argument to a GRAPH command.</p>
174
177
</dd>
175
 
<p></p>
176
 
<dt><strong><a name="item_rrd_3a_3agraph_rrdgraph_arguments">RRD::GRAPH <em>rrdgraph arguments</em></a></strong><br />
177
 
</dt>
 
178
</li>
 
179
<dt><strong><a name="item_rrd_3a_3agraph_rrdgraph_arguments">RRD::GRAPH <em>rrdgraph arguments</em></a></strong>
 
180
 
178
181
<dd>
179
 
This tag creates the RRD graph defined by its argument and then is
 
182
<p>This tag creates the RRD graph defined by its argument and then is
180
183
replaced by an appropriate &lt;IMG ... &gt; tag referring to the graph.
181
184
The <strong>--lazy</strong> option in RRD graph can be used to make sure that graphs
182
185
are only regenerated when they are out of date. The arguments
183
 
to the <strong>RRD::GRAPH</strong> tag work as described in the <strong>rrdgraph</strong> manual page.
 
186
to the <strong>RRD::GRAPH</strong> tag work as described in the <strong>rrdgraph</strong> manual page.</p>
184
187
</dd>
185
188
<dd>
186
189
<p>Use the <strong>--lazy</strong> option in your RRD::GRAPH tags, to reduce the load
199
202
<p>Note that %s stands for the filename part of the graph generated, all
200
203
directories given in the PNG file argument will get dropped.</p>
201
204
</dd>
202
 
<p></p>
203
 
<dt><strong><a name="item_rrd_3a_3aprint_number">RRD::PRINT <em>number</em></a></strong><br />
204
 
</dt>
 
205
</li>
 
206
<dt><strong><a name="item_rrd_3a_3aprint_number">RRD::PRINT <em>number</em></a></strong>
 
207
 
205
208
<dd>
206
 
If the preceding  <strong>RRD::GRAPH</strong> tag contained and <strong>PRINT</strong> arguments,
 
209
<p>If the preceding  <strong>RRD::GRAPH</strong> tag contained and <strong>PRINT</strong> arguments,
207
210
then you can access their output with this tag. The <em>number</em> argument refers to the
208
 
number of the <strong>PRINT</strong> argument. This first <strong>PRINT</strong> has <em>number</em> 0.
 
211
number of the <strong>PRINT</strong> argument. This first <strong>PRINT</strong> has <em>number</em> 0.</p>
209
212
</dd>
210
 
<p></p>
211
 
<dt><strong><a name="item_rrd_3a_3ainternal__3cvar_3e">RRD::INTERNAL &lt;var&gt;</a></strong><br />
212
 
</dt>
 
213
</li>
 
214
<dt><strong><a name="item_rrd_3a_3ainternal__3cvar_3e">RRD::INTERNAL &lt;var&gt;</a></strong>
 
215
 
213
216
<dd>
214
 
This tag gets replaced by an internal var. Currently these vars are known:
 
217
<p>This tag gets replaced by an internal var. Currently these vars are known:
215
218
VERSION, COMPILETIME.
216
 
These vars represent the compiled-in values.
 
219
These vars represent the compiled-in values.</p>
217
220
</dd>
218
 
<p></p></dl>
 
221
</li>
 
222
</dl>
219
223
<p>
220
224
</p>
221
225
<hr />