diff --git a/doc/rrdcgi.txt b/doc/rrdcgi.txt
index c53f96741c44e446e60ba90747720e3fe6af085c..0317f50033ebeaa7f7646c46753ce40532be9a69 100644 (file)
--- a/doc/rrdcgi.txt
+++ b/doc/rrdcgi.txt
r\brr\brd\bdc\bcg\bgi\bi is 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. r\brr\brd\bdc\bcg\bgi\bi will interpret and act according to these tags. In
- the end it will printout a web page including the necessary CGI head-
- ers.
+ the end it will printout a web page including the necessary CGI
+ headers.
r\brr\brd\bdc\bcg\bgi\bi parses the contents of the template in 3 steps. In each step it
looks only for a subset of tags. This allows nesting of tags.
-\b--\b-f\bfi\bil\blt\bte\ber\br
Assume that rrdcgi is run as a filter and not as a cgi.
- K\bKe\bey\byw\bwo\bor\brd\bds\bs
-
-
+ K\bKe\bey\byw\bwo\bor\brd\bds\bs
RRD::CV _\bn_\ba_\bm_\be
Inserts the CGI variable of the given name.
as an argument to a GRAPH command.
RRD::TIME::STRFTIME _\bS_\bT_\bA_\bR_\bT_\b|_\bE_\bN_\bD _\bs_\bt_\ba_\br_\bt_\b-_\bs_\bp_\be_\bc _\be_\bn_\bd_\b-_\bs_\bp_\be_\bc _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be_\b-_\bf_\bo_\br_\bm_\ba_\bt
- This gets replaced by a strftime-formatted time using the for-
- mat _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be_\b-_\bf_\bo_\br_\bm_\ba_\bt on either _\bs_\bt_\ba_\br_\bt_\b-_\bs_\bp_\be_\bc or _\be_\bn_\bd_\b-_\bs_\bp_\be_\bc depending
- on whether _\bS_\bT_\bA_\bR_\bT or _\bE_\bN_\bD is specified. Both _\bs_\bt_\ba_\br_\bt_\b-_\bs_\bp_\be_\bc and _\be_\bn_\bd_\b-
- _\bs_\bp_\be_\bc 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".
+ This gets replaced by a strftime-formatted time using the
+ format _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be_\b-_\bf_\bo_\br_\bm_\ba_\bt on either _\bs_\bt_\ba_\br_\bt_\b-_\bs_\bp_\be_\bc or _\be_\bn_\bd_\b-_\bs_\bp_\be_\bc
+ depending on whether _\bS_\bT_\bA_\bR_\bT or _\bE_\bN_\bD is specified. Both _\bs_\bt_\ba_\br_\bt_\b-
+ _\bs_\bp_\be_\bc and _\be_\bn_\bd_\b-_\bs_\bp_\be_\bc 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".
Note that again, if you return : (colon) from your strftime
format, you may have to escape them using \ if the time is to
is replaced by an appropriate <IMG ... > tag referring to the
graph. The -\b--\b-l\bla\baz\bzy\by 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 R\bRR\bRD\bD:\b::\b:G\bGR\bRA\bAP\bPH\bH tag work as described in the r\brr\brd\bd-\b-
- g\bgr\bra\bap\bph\bh manual page.
+ arguments to the R\bRR\bRD\bD:\b::\b:G\bGR\bRA\bAP\bPH\bH tag work as described in the
+ r\brr\brd\bdg\bgr\bra\bap\bph\bh manual page.
Use the -\b--\b-l\bla\baz\bzy\by option in your RRD::GRAPH tags, to reduce the
load on your server. This option makes sure that graphs are
<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 PNG file argument will get
- dropped.
+ Note that %s stands for the filename part of the graph
+ generated, all directories given in the PNG file argument will
+ get dropped.
RRD::PRINT _\bn_\bu_\bm_\bb_\be_\br
If the preceding R\bRR\bRD\bD:\b::\b:G\bGR\bRA\bAP\bPH\bH tag contained and P\bPR\bRI\bIN\bNT\bT arguments,
E\bEX\bXA\bAM\bMP\bPL\bLE\bE 3\b3
This example shows how to handle the case where the RRD, graphs and
- cgi-bins are seperate directories
+ cgi-bins are separate directories
#!/.../bin/rrdcgi
<HTML>
Note 1: Replace /.../ with the relevant directories
- Note 2: The SRC=/.../pngs should be paths from the view of the web-
- server/browser
+ Note 2: The SRC=/.../pngs should be paths from the view of the
+ webserver/browser
A\bAU\bUT\bTH\bHO\bOR\bR
Tobias Oetiker <tobi@oetiker.ch>
-1.3.1 2008-03-15 RRDCGI(1)
+1.4.8 2013-05-23 RRDCGI(1)