implement CSV, TSC, SSV with JSON and XML as "graphics" formats for rrdgraph -- Marti...

[rrdtool.git] / doc / rrdgraph.pod

diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod
index e40b046..f8aae34 100644 (file)
--- a/doc/rrdgraph.pod
+++ b/doc/rrdgraph.pod
@@ -193,6 +193,11 @@ This places grid lines every 8 hours, major grid lines and labels
 each day. The labels are placed exactly between two major grid lines
 as they specify the complete day and not just midnight.
 
 each day. The labels are placed exactly between two major grid lines
 as they specify the complete day and not just midnight.
 

+[B<--week-fmt> I<strftime format string>]
+
+By default rrdtool uses "Week %V" to render the week number. With this option
+you can define your own format, without completely overriding the xaxis format.
+

 =head2 Y-Axis
 
 [B<-y>|B<--y-grid> I<grid step>B<:>I<label factor>]
 =head2 Y-Axis
 
 [B<-y>|B<--y-grid> I<grid step>B<:>I<label factor>]


@@ -263,7 +268,7 @@ for the right axis.
 
 By default the format of the axis labels gets determined automatically. If
 you want to do this your self, use this option with the same %lf arguments
 
 By default the format of the axis labels gets determined automatically. If
 you want to do this your self, use this option with the same %lf arguments

-you know from the PRING and GPRINT commands.
+you know from the PRINT and GPRINT commands.

 
 =head2 Legend
 
 
 =head2 Legend
 


@@ -354,7 +359,7 @@ color.
 
 Pick the shape of the color marker next to the label according to the element drawn on the graph.
 
 
 Pick the shape of the color marker next to the label according to the element drawn on the graph.
 

-[B<--zoom> I<factor>]
+[B<-m>|B<--zoom> I<factor>]

 
 Zoom the graphics by the given amount. The factor must be E<gt> 0
 
 
 Zoom the graphics by the given amount. The factor must be E<gt> 0
 


@@ -448,7 +453,7 @@ RRDtool graphs are composed of stair case curves by default. This is in line wit
 the way RRDtool calculates its data. Some people favor a more 'organic' look
 for their graphs even though it is not all that true.
 
 the way RRDtool calculates its data. Some people favor a more 'organic' look
 for their graphs even though it is not all that true.
 

-[B<-a>|B<--imgformat> B<PNG>|B<SVG>|B<EPS>|B<PDF>]
+[B<-a>|B<--imgformat> B<PNG>|B<SVG>|B<EPS>|B<PDF>|B<XML>|B<JSON>|B<CSV>|B<TSV>|B<SSV>]

 
 Image format for the generated graph. For the vector formats you can
 choose among the standard Postscript fonts Courier-Bold,
 
 Image format for the generated graph. For the vector formats you can
 choose among the standard Postscript fonts Courier-Bold,


@@ -456,6 +461,10 @@ Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold,
 Helvetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
 Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
 
 Helvetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
 Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
 

+For Export type you can define XML, JSON, CSV (=comma separated values),
+TSV (=tab separated values), SSV (=semicolon separated values)
+(for comma/tab/semicolon separated values the time format by default is in the form of unix time. to change it to something else use: --x-grid MINUTE:10:HOUR:1:HOUR:4:0:"%Y-%m-%d %H:%M:%S")
+

 [B<-i>|B<--interlaced>]
 
 (this gets ignored in 1.3 for now!)
 [B<-i>|B<--interlaced>]
 
 (this gets ignored in 1.3 for now!)


@@ -485,8 +494,9 @@ B<CDEF:>I<vname>B<=>I<RPN expression>
 
 B<VDEF:>I<vname>B<=>I<RPN expression>
 
 
 B<VDEF:>I<vname>B<=>I<RPN expression>
 

-You need at least one B<DEF> statement to generate anything. The
-other statements are useful but optional.
+You need at least one B<DEF> and one B<LINE>, B<AREA>, B<GPRINT>, B<PRINT>
+statement to generate anything useful.
+

 See L<rrdgraph_data> and L<rrdgraph_rpn> for the exact format.
 
 NOTE: B<Graph and print elements>
 See L<rrdgraph_data> and L<rrdgraph_rpn> for the exact format.
 
 NOTE: B<Graph and print elements>