Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrdcgi.txt
index 5920534b05b7f3e16d4c67743f4986a730a6301d..ee0ba0a50d57f14e7c77df77585bf53df5e0c171 100644 (file)
@@ -12,8 +12,8 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        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
-       headers.
+       the end it will printout a web page including the necessary CGI head-
+       ers.
 
        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.
@@ -24,7 +24,9 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        -\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.
 
@@ -87,13 +89,13 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                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
-               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_\band _\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 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_\bmust 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
@@ -104,8 +106,8 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                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\bdg\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\bd-\b-
+               g\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
@@ -116,9 +118,9 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
 
                 <IMG SRC="%s" WIDTH="%lu" HEIGHT="%lu">
 
-               Note that %s stands for the filename part of the graph
-               generated, all directories given in the PNG file argument will
-               get dropped.
+               Note that %s stands for the filename part of the graph gener-
+               ated, 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,
@@ -194,12 +196,12 @@ E\bEX\bXA\bAM\bMP\bPL\bLE\bE 3\b3
 
        Note 1: Replace /.../ with the relevant directories
 
-       Note 2: The SRC=/.../pngs should be paths from the view of the
-       webserver/browser
+       Note 2: The SRC=/.../pngs should be paths from the view of the web-
+       server/browser
 
 A\bAU\bUT\bTH\bHO\bOR\bR
        Tobias Oetiker <tobi@oetiker.ch>
 
 
 
-1.3.8                             2008-12-22                         RRDCGI(1)
+1.3.99909060808                   2008-12-22                         RRDCGI(1)