misc fixes for better display
[rrdtool.git] / doc / rrdcgi.pod
index 66260ac..e999fea 100644 (file)
@@ -1,13 +1,10 @@
 =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
 
-#!/path/to/B<rrdcgi> 
-S<[B<--filter>]>
+C<#!/path/to/>B<rrdcgi> S<[B<--filter>]>
 
 =head1 DESCRIPTION
 
@@ -96,8 +93,11 @@ time is I<strftime>-formatted with the string specified in the second argument.
 
 =item RRD::TIME::NOW I<strftime-format>
 
-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. 
 
 =item RRD::TIME::STRFTIME I<START|END> I<start-spec> I<end-spec> I<strftime-format>
 
@@ -108,10 +108,13 @@ 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 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.
+
 =item RRD::GRAPH I<rrdgraph arguments>
 
 This tag creates the RRD graph defined in its argument and then gets
-replaced by an appropriate E<lt>IMG<gt> tag referring to the graph.
+replaced by an appropriate E<lt>IMGE<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.