projects
/
rrdtool.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
new rrdcgi function RRD::INTERNAL for accessing VERSION, COPYRIGHT, COMPILETIME,...
[rrdtool.git]
/
doc
/
rrdcgi.pod
diff --git
a/doc/rrdcgi.pod
b/doc/rrdcgi.pod
index
763ab23
..
9860f31
100644
(file)
--- a/
doc/rrdcgi.pod
+++ b/
doc/rrdcgi.pod
@@
-1,13
+1,10
@@
=head1 NAME
=head1 NAME
-rrdcgi - create web pages containing RRD graphs based on templates
-
-=for html <div align="right"><a href="rrdcgi.pdf">PDF</a> version.</div>
+rrdcgi - Create web pages containing RRD graphs based on templates
=head1 SYNOPSIS
=head1 SYNOPSIS
-#!/path/to/B<rrdcgi>
-S<[B<--filter>]>
+C<#!/path/to/>B<rrdcgi> S<[B<--filter>]>
=head1 DESCRIPTION
=head1 DESCRIPTION
@@
-17,16
+14,15
@@
E<lt>RRD:: tags. B<rrdcgi> will interpret and act according to these tags.
In the end it will printout a web page including the necessary CGI headers.
B<rrdcgi> parses the contents of the template in 3 steps. In each step it looks
In the end it will printout a web page including the necessary CGI headers.
B<rrdcgi> parses the contents of the template in 3 steps. In each step it looks
-only for a subset of tags. This allows
to nest tags.
+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.
+The argument parser uses the same semantics as you are used from your
C-
shell.
=over 8
=over 8
-
=item B<--filter>
=item B<--filter>
-Assume that rrdcgi is
being
run as a filter and not as a cgi.
+Assume that rrdcgi is run as a filter and not as a cgi.
=back
=back
@@
-42,13
+38,13
@@
Inserts the CGI variable of the given 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
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.
+value of the CGI variable it will still be considered
to be
one argument.
=item RRD::CV::PATH I<name>
Inserts the CGI variable of the given name, quotes it and makes sure
=item RRD::CV::PATH I<name>
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
+it starts neither with a '/' nor contains '..'. This is to make
+sure that no problematic pathnames can be introduced through the
CGI interface.
=item RRD::GETENV I<variable>
CGI interface.
=item RRD::GETENV I<variable>
@@
-58,18
+54,18
@@
Get the value of an environment variable.
<RRD::GETENV REMOTE_USER>
might give you the name of the remote user given you are using
<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
+some sort of access control on the directory
.
=item RRD::GOODFOR I<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
=item RRD::GOODFOR I<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 I<negative> a Refresh header
s
.
+seconds is I<negative> a Refresh header.
=item RRD::INCLUDE I<filename>
=item RRD::INCLUDE I<filename>
-Include the contents of the
given file into the page returned from the cgi
+Include the contents of the
specified file into the page returned from the cgi.
=item RRD::SETENV I<variable> I<value>
=item RRD::SETENV I<variable> I<value>
@@
-83,11
+79,11
@@
values permitted to TZ depend on your OS.
=item RRD::SETVAR I<variable> I<value>
=item RRD::SETVAR I<variable> I<value>
-Analog to SETENV but for local variables
+Analog to SETENV but for local variables
.
-=item RRD::GETVAR I<variable>
+=item RRD::GETVAR I<variable>
-Analog to GETENV but for local variables
+Analog to GETENV but for local variables
.
=item RRD::TIME::LAST I<rrd-file> I<strftime-format>
=item RRD::TIME::LAST I<rrd-file> I<strftime-format>
@@
-99,8
+95,9
@@
time is I<strftime>-formatted with the string specified in the second argument.
This gets replaced by the current time of day. The time is
I<strftime>-formatted with the string specified in the argument.
This gets replaced by the current time of day. The time is
I<strftime>-formatted with the string specified in the argument.
-Note that if you return : 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.
+Note that if you return : (colons) 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.
=item RRD::TIME::STRFTIME I<START|END> I<start-spec> I<end-spec> I<strftime-format>
=item RRD::TIME::STRFTIME I<START|END> I<start-spec> I<end-spec> I<strftime-format>
@@
-111,13
+108,14
@@
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".
to allow pretty titles on graphs with times that are easier for non RRDtool
folks to figure out than "-2weeks".
-Note that if you return : 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.
+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.
=item RRD::GRAPH I<rrdgraph arguments>
=item RRD::GRAPH I<rrdgraph arguments>
-This tag creates the RRD graph defined
in its argument and then get
s
-replaced by an appropriate E<lt>IMG<gt> tag referring to the graph.
+This tag creates the RRD graph defined
by its argument and then i
s
+replaced by an appropriate E<lt>IMG
... E
<gt> tag referring to the graph.
The B<--lazy> option in RRD graph can be used to make sure that graphs
are only regenerated when they are out of date. The arguments
to the B<RRD::GRAPH> tag work as described in the B<rrdgraph> manual page.
The B<--lazy> option in RRD graph can be used to make sure that graphs
are only regenerated when they are out of date. The arguments
to the B<RRD::GRAPH> tag work as described in the B<rrdgraph> manual page.
@@
-140,6
+138,12
@@
If the preceding B<RRD::GRAPH> tag contained and B<PRINT> arguments,
then you can access their output with this tag. The I<number> argument refers to the
number of the B<PRINT> argument. This first B<PRINT> has I<number> 0.
then you can access their output with this tag. The I<number> argument refers to the
number of the B<PRINT> argument. This first B<PRINT> has I<number> 0.
+=item RRD::INTERNAL <var>
+
+This tag gets replaced by an internal var. Currently these vars are known:
+VERSION, COPYRIGHT, COMPILETIME, OS.
+These vars represent the compiled-in values.
+
=back
=head1 EXAMPLE 1
=back
=head1 EXAMPLE 1
@@
-162,9
+166,9
@@
The example below creates a web pages with a single RRD graph.
=head1 EXAMPLE 2
=head1 EXAMPLE 2
-This script is slightly more elaborate, it allows you to run it from
+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
a form which sets RRD_NAME. RRD_NAME is then used to select which RRD
-you want to use a source for your graph.
+you want to use a
s
source for your graph.
#!/usr/local/bin/rrdcgi
<HTML>
#!/usr/local/bin/rrdcgi
<HTML>
@@
-177,7
+181,7
@@
you want to use a source for your graph.
<INPUT TYPE=SUBMIT></FORM>
<H2>Graph</H2>
<P>
<INPUT TYPE=SUBMIT></FORM>
<H2>Graph</H2>
<P>
- <RRD::GRAPH <RRD::CV::PATH RRD_NAME>.png --lazy
+ <RRD::GRAPH <RRD::CV::PATH RRD_NAME>.png --lazy
--title "Temperatures for "<RRD::CV::QUOTE RRD_NAME>
DEF:cel=<RRD::CV::PATH RRD_NAME>.rrd:exhaust:AVERAGE
LINE2:cel#00a000:"D. Celsius">
--title "Temperatures for "<RRD::CV::QUOTE RRD_NAME>
DEF:cel=<RRD::CV::PATH RRD_NAME>.rrd:exhaust:AVERAGE
LINE2:cel#00a000:"D. Celsius">