Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrdcgi.1
index ed28c913ded02b4b8d5067ba996265908f811397..4b740106b2954843dbb6080e7d59ed110071e6a4 100644 (file)
@@ -1,7 +1,15 @@
-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" Standard preamble:
 .\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .    ds R" ''
 'br\}
 .\"
-.\" Escape single quotes in literal strings from groff's Unicode transform.
-.ie \n(.g .ds Aq \(aq
-.el       .ds Aq '
-.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.ie \nF \{\
+.if \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.el \{\
-.    de IX
-..
-.\}
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "RRDCGI 1"
-.TH RRDCGI 1 "2008-12-22" "1.3.8" "rrdtool"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.if n .ad l
-.nh
+.TH RRDCGI 1 "2008-12-22" "1.3.99909060808" "rrdtool"
 .SH "NAME"
 rrdcgi \- Create web pages containing RRD graphs based on templates
 .SH "SYNOPSIS"
@@ -148,7 +149,7 @@ The argument parser uses the same semantics as you are used from your C\-shell.
 .IP "\fB\-\-filter\fR" 8
 .IX Item "--filter"
 Assume that rrdcgi is run as a filter and not as a cgi.
-.SS "Keywords"
+.Sh "Keywords"
 .IX Subsection "Keywords"
 .IP "\s-1RRD::CV\s0 \fIname\fR" 8
 .IX Item "RRD::CV name"
@@ -177,7 +178,7 @@ some sort of access control on the directory.
 .IP "\s-1RRD::GOODFOR\s0 \fIseconds\fR" 8
 .IX Item "RRD::GOODFOR 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
+the rrdcgi to output a Last\-Modified, an Expire and if the number of
 seconds is \fInegative\fR a Refresh header.
 .IP "\s-1RRD::INCLUDE\s0 \fIfilename\fR" 8
 .IX Item "RRD::INCLUDE filename"
@@ -253,7 +254,7 @@ number of the \fB\s-1PRINT\s0\fR argument. This first \fB\s-1PRINT\s0\fR has \fI
 .IX Item "RRD::INTERNAL <var>"
 This tag gets replaced by an internal var. Currently these vars are known:
 \&\s-1VERSION\s0, \s-1COMPILETIME\s0.
-These vars represent the compiled-in values.
+These vars represent the compiled-in values. 
 .SH "EXAMPLE 1"
 .IX Header "EXAMPLE 1"
 The example below creates a web pages with a single \s-1RRD\s0 graph.
@@ -268,7 +269,9 @@ The example below creates a web pages with a single \s-1RRD\s0 graph.
 \& <RRD::GRAPH demo.png \-\-lazy \-\-title="Temperatures"
 \&          DEF:cel=demo.rrd:exhaust:AVERAGE
 \&          LINE2:cel#00a000:"D. Celsius">
-\&
+.Ve
+.PP
+.Vb 3
 \& </P>
 \& </BODY>
 \& </HTML>
@@ -279,7 +282,7 @@ This script is slightly more elaborate, it allows you to run it from
 a form which sets \s-1RRD_NAME\s0. \s-1RRD_NAME\s0 is then used to select which \s-1RRD\s0
 you want to use as source for your graph.
 .PP
-.Vb 10
+.Vb 15
 \& #!/usr/local/bin/rrdcgi
 \& <HTML>
 \& <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
@@ -295,7 +298,9 @@ you want to use as source for your graph.
 \&          \-\-title "Temperatures for "<RRD::CV::QUOTE RRD_NAME>
 \&          DEF:cel=<RRD::CV::PATH RRD_NAME>.rrd:exhaust:AVERAGE
 \&          LINE2:cel#00a000:"D. Celsius">
-\&
+.Ve
+.PP
+.Vb 3
 \& </P>
 \& </BODY>
 \& </HTML>
@@ -305,7 +310,7 @@ you want to use as source for your graph.
 This example shows how to handle the case where the \s-1RRD\s0, graphs and
 cgi-bins are separate directories
 .PP
-.Vb 10
+.Vb 14
 \& #!/.../bin/rrdcgi
 \& <HTML>
 \& <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
@@ -313,7 +318,7 @@ cgi-bins are separate directories
 \& <H1>RRDCGI test Page</H1>
 \& <RRD::GRAPH
 \&  /.../web/pngs/testhvt.png
-\&  \-\-imginfo \*(Aq<IMG SRC=/.../pngs/%s WIDTH=%lu HEIGHT=%lu >\*(Aq
+\&  \-\-imginfo '<IMG SRC=/.../pngs/%s WIDTH=%lu HEIGHT=%lu >'
 \&  \-\-lazy \-\-start \-1d \-\-end now
 \&  DEF:http_src=/.../rrds/test.rrd:http_src:AVERAGE
 \&  AREA:http_src#00ff00:http_src