Imported upstream version 1.3.8.

[pkg-rrdtool.git] / doc / rrdgraph.1

diff --git a/doc/rrdgraph.1 b/doc/rrdgraph.1
index 6dac276d369ecb9ee29fc5270fbaaaaf5384cdd4..d6459468617a28f5d75a0e72ab8b387edee62d82 100644 (file)
--- a/doc/rrdgraph.1
+++ b/doc/rrdgraph.1
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)

 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .\"
 .\" 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
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp


@@ -48,22 +40,25 @@
 .    ds R" ''
 'br\}
 .\"
 .    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
 .\" If the F register is turned on, we'll generate index entries on stderr for

-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index

 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.

-.if \nF \{\
+.ie \nF \{\

 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}

-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}

 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.


@@ -129,7 +124,11 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDGRAPH 1"
 .\" ========================================================================
 .\"
 .IX Title "RRDGRAPH 1"

-.TH RRDGRAPH 1 "2009-04-07" "1.3.7" "rrdtool"
+.TH RRDGRAPH 1 "2009-04-07" "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

 .SH "NAME"
 rrdgraph \- Round Robin Database tool grapher functions
 .SH "SYNOPSIS"
 .SH "NAME"
 rrdgraph \- Round Robin Database tool grapher functions
 .SH "SYNOPSIS"


@@ -168,7 +167,8 @@ well become unknown!
 .PP
 Sometimes data is not exactly in the format you would like to display
 it. For instance, you might be collecting \fBbytes\fR per second, but
 .PP
 Sometimes data is not exactly in the format you would like to display
 it. For instance, you might be collecting \fBbytes\fR per second, but

-want to display \fBbits\fR per second. This is what the \fBdata calculation\fR command is designed for. After
+want to display \fBbits\fR per second. This is what the \fBdata
+calculation\fR command is designed for. After

 \&\fBconsolidating\fR the data, a copy is made and this copy is modified
 using a rather powerful \fB\s-1RPN\s0\fR command set.
 .PP
 \&\fBconsolidating\fR the data, a copy is made and this copy is modified
 using a rather powerful \fB\s-1RPN\s0\fR command set.
 .PP


@@ -176,20 +176,20 @@ When you are done fetching and processing the data, it is time to
 graph it (or print it).  This ends the \fBrrdtool graph\fR sequence.
 .SH "OPTIONS"
 .IX Header "OPTIONS"
 graph it (or print it).  This ends the \fBrrdtool graph\fR sequence.
 .SH "OPTIONS"
 .IX Header "OPTIONS"

-.Sh "\fBgraphv\fP"
+.SS "\fBgraphv\fP"

 .IX Subsection "graphv"
 This alternate version of \fBgraph\fR takes the same arguments and performs the
 same function. The \fIv\fR stands for \fIverbose\fR, which describes the output
 returned. \fBgraphv\fR will return a lot of information about the graph using
 the same format as rrdtool info (key = value). See the bottom of the document for more information.
 .IX Subsection "graphv"
 This alternate version of \fBgraph\fR takes the same arguments and performs the
 same function. The \fIv\fR stands for \fIverbose\fR, which describes the output
 returned. \fBgraphv\fR will return a lot of information about the graph using
 the same format as rrdtool info (key = value). See the bottom of the document for more information.

-.Sh "\fIfilename\fP"
+.SS "\fIfilename\fP"

 .IX Subsection "filename"
 The name and path of the graph to generate. It is recommended to
 end this in \f(CW\*(C`.png\*(C'\fR, \f(CW\*(C`.svg\*(C'\fR or \f(CW\*(C`.eps\*(C'\fR, but \fBRRDtool\fR does not enforce this.
 .PP
 \&\fIfilename\fR can be '\f(CW\*(C`\-\*(C'\fR' to send the image to \f(CW\*(C`stdout\*(C'\fR. In
 this case, no other output is generated.
 .IX Subsection "filename"
 The name and path of the graph to generate. It is recommended to
 end this in \f(CW\*(C`.png\*(C'\fR, \f(CW\*(C`.svg\*(C'\fR or \f(CW\*(C`.eps\*(C'\fR, but \fBRRDtool\fR does not enforce this.
 .PP
 \&\fIfilename\fR can be '\f(CW\*(C`\-\*(C'\fR' to send the image to \f(CW\*(C`stdout\*(C'\fR. In
 this case, no other output is generated.

-.Sh "Time range"
+.SS "Time range"

 .IX Subsection "Time range"
 [\fB\-s\fR|\fB\-\-start\fR \fItime\fR]
 [\fB\-e\fR|\fB\-\-end\fR \fItime\fR]
 .IX Subsection "Time range"
 [\fB\-s\fR|\fB\-\-start\fR \fItime\fR]
 [\fB\-e\fR|\fB\-\-end\fR \fItime\fR]


@@ -206,14 +206,14 @@ resolution.  With the \fBstep\fR option you can alter this behaviour.
 If you want \fBrrdtool graph\fR to get data at a one-hour resolution
 from the \fB\s-1RRD\s0\fR, set \fBstep\fR to 3'600. Note: a step smaller than
 one pixel will silently be ignored.
 If you want \fBrrdtool graph\fR to get data at a one-hour resolution
 from the \fB\s-1RRD\s0\fR, set \fBstep\fR to 3'600. Note: a step smaller than
 one pixel will silently be ignored.

-.Sh "Labels"
+.SS "Labels"

 .IX Subsection "Labels"
 [\fB\-t\fR|\fB\-\-title\fR \fIstring\fR]
 [\fB\-v\fR|\fB\-\-vertical\-label\fR \fIstring\fR]
 .PP
 A horizontal string at the top of the graph and/or a vertically
 placed string at the left hand side of the graph.
 .IX Subsection "Labels"
 [\fB\-t\fR|\fB\-\-title\fR \fIstring\fR]
 [\fB\-v\fR|\fB\-\-vertical\-label\fR \fIstring\fR]
 .PP
 A horizontal string at the top of the graph and/or a vertically
 placed string at the left hand side of the graph.

-.Sh "Right Axis"
+.SS "Right Axis"

 .IX Subsection "Right Axis"
 [\fB\-\-right\-axis\fR \fIscale\fR\fB:\fR\fIshift\fR]
 [\fB\-\-right\-axis\-label\fR \fIlabel\fR]
 .IX Subsection "Right Axis"
 [\fB\-\-right\-axis\fR \fIscale\fR\fB:\fR\fIshift\fR]
 [\fB\-\-right\-axis\-label\fR \fIlabel\fR]


@@ -227,7 +227,7 @@ for the right axis.
 By default the format of the axis lables gets determined automatically. If
 you want todo this your self, use this option with the same \f(CW%lf\fR arguments
 you know from the \s-1PRING\s0 and \s-1GPRINT\s0 commands.
 By default the format of the axis lables gets determined automatically. If
 you want todo this your self, use this option with the same \f(CW%lf\fR arguments
 you know from the \s-1PRING\s0 and \s-1GPRINT\s0 commands.

-.Sh "Size"
+.SS "Size"

 .IX Subsection "Size"
 [\fB\-w\fR|\fB\-\-width\fR \fIpixels\fR]
 [\fB\-h\fR|\fB\-\-height\fR \fIpixels\fR]
 .IX Subsection "Size"
 [\fB\-w\fR|\fB\-\-width\fR \fIpixels\fR]
 [\fB\-h\fR|\fB\-\-height\fR \fIpixels\fR]


@@ -245,7 +245,7 @@ If you specify the \fB\-\-only\-graph\fR option and set the height < 32
 pixels you will get a tiny graph image (thumbnail) to use as an icon
 for use in an overview, for example. All labeling will be stripped off
 the graph.
 pixels you will get a tiny graph image (thumbnail) to use as an icon
 for use in an overview, for example. All labeling will be stripped off
 the graph.

-.Sh "Limits"
+.SS "Limits"

 .IX Subsection "Limits"
 [\fB\-u\fR|\fB\-\-upper\-limit\fR \fIvalue\fR]
 [\fB\-l\fR|\fB\-\-lower\-limit\fR \fIvalue\fR]
 .IX Subsection "Limits"
 [\fB\-u\fR|\fB\-\-upper\-limit\fR \fIvalue\fR]
 [\fB\-l\fR|\fB\-\-lower\-limit\fR \fIvalue\fR]


@@ -292,7 +292,7 @@ appearance. If this is not to your liking, you can use this switch
 to turn this behaviour off.
 .PP
 Gridfitting is turned off for \s-1PDF\s0, \s-1EPS\s0, \s-1SVG\s0 output by default.
 to turn this behaviour off.
 .PP
 Gridfitting is turned off for \s-1PDF\s0, \s-1EPS\s0, \s-1SVG\s0 output by default.

-.Sh "Grid"
+.SS "Grid"

 .IX Subsection "Grid"
 .IP "X\-Axis" 4
 .IX Item "X-Axis"
 .IX Subsection "Grid"
 .IP "X\-Axis" 4
 .IX Item "X-Axis"


@@ -388,7 +388,7 @@ fideling with the y\-axis labeling.
 With this option y\-axis values on logarithmic graphs will be scaled to 
 the appropriate units (k, M, etc.) instead of using exponential notation.
 Note that for linear graphs, \s-1SI\s0 notation is used by default.
 With this option y\-axis values on logarithmic graphs will be scaled to 
 the appropriate units (k, M, etc.) instead of using exponential notation.
 Note that for linear graphs, \s-1SI\s0 notation is used by default.

-.Sh "Miscellaneous"
+.SS "Miscellaneous"

 .IX Subsection "Miscellaneous"
 [\fB\-z\fR|\fB\-\-lazy\fR]
 .PP
 .IX Subsection "Miscellaneous"
 [\fB\-z\fR|\fB\-\-lazy\fR]
 .PP


@@ -410,7 +410,7 @@ suitable for including the graph into a web page, the command line
 would look like this:
 .PP
 .Vb 1
 would look like this:
 .PP
 .Vb 1

-\& \-\-imginfo \(aq<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">\(aq
+\& \-\-imginfo \*(Aq<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">\*(Aq

 .Ve
 .PP
 [\fB\-c\fR|\fB\-\-color\fR \fI\s-1COLORTAG\s0\fR#\fIrrggbb\fR[\fIaa\fR]]
 .Ve
 .PP
 [\fB\-c\fR|\fB\-\-color\fR \fI\s-1COLORTAG\s0\fR#\fIrrggbb\fR[\fIaa\fR]]


@@ -486,7 +486,7 @@ no text is rendered bitmapped.
 .PP
 All text in rrdtool is rendered using Pango. With the \fB\-\-pango\-markup\fR option, all
 text will be processed by pango markup. This allows to embed some simple html
 .PP
 All text in rrdtool is rendered using Pango. With the \fB\-\-pango\-markup\fR option, all
 text will be processed by pango markup. This allows to embed some simple html

-like markup tags using 
+like markup tags using

 .PP
 .Vb 1
 \& <span key="value">text</span>
 .PP
 .Vb 1
 \& <span key="value">text</span>


@@ -525,10 +525,10 @@ for their graphs even though it is not all that true.
 [\fB\-a\fR|\fB\-\-imgformat\fR \fB\s-1PNG\s0\fR|\fB\s-1SVG\s0\fR|\fB\s-1EPS\s0\fR|\fB\s-1PDF\s0\fR]
 .PP
 Image format for the generated graph. For the vector formats you can
 [\fB\-a\fR|\fB\-\-imgformat\fR \fB\s-1PNG\s0\fR|\fB\s-1SVG\s0\fR|\fB\s-1EPS\s0\fR|\fB\s-1PDF\s0\fR]
 .PP
 Image format for the generated graph. For the vector formats you can

-choose among the standard Postscript fonts Courier\-Bold,
-Courier\-BoldOblique, Courier\-Oblique, Courier, Helvetica\-Bold,
-Helvetica\-BoldOblique, Helvetica\-Oblique, Helvetica, Symbol,
-Times\-Bold, Times\-BoldItalic, Times\-Italic, Times\-Roman, and ZapfDingbats.
+choose among the standard Postscript fonts Courier-Bold,
+Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold,
+Helvetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
+Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.

 .PP
 [\fB\-i\fR|\fB\-\-interlaced\fR]
 .PP
 .PP
 [\fB\-i\fR|\fB\-\-interlaced\fR]
 .PP


@@ -560,7 +560,7 @@ measurement, 1 kb/s is 1000 b/s.
 .PP
 Adds the given string as a watermark, horizontally centered, at the bottom 
 of the graph.
 .PP
 Adds the given string as a watermark, horizontally centered, at the bottom 
 of the graph.

-.Sh "Data and variables"
+.SS "Data and variables"

 .IX Subsection "Data and variables"
 \&\fB\s-1DEF:\s0\fR\fIvname\fR\fB=\fR\fIrrdfile\fR\fB:\fR\fIds-name\fR\fB:\fR\fI\s-1CF\s0\fR[\fB:step=\fR\fIstep\fR][\fB:start=\fR\fItime\fR][\fB:end=\fR\fItime\fR]
 .PP
 .IX Subsection "Data and variables"
 \&\fB\s-1DEF:\s0\fR\fIvname\fR\fB=\fR\fIrrdfile\fR\fB:\fR\fIds-name\fR\fB:\fR\fI\s-1CF\s0\fR[\fB:step=\fR\fIstep\fR][\fB:start=\fR\fItime\fR][\fB:end=\fR\fItime\fR]
 .PP


@@ -577,7 +577,7 @@ See rrdgraph_data and rrdgraph_rpn for the exact format.
 You need at least one graph element to generate an image and/or
 at least one print statement to generate a report.
 See rrdgraph_graph for the exact format.
 You need at least one graph element to generate an image and/or
 at least one print statement to generate a report.
 See rrdgraph_graph for the exact format.

-.Sh "graphv"
+.SS "graphv"

 .IX Subsection "graphv"
 Calling rrdtool with the graphv option will return information in the
 rrdtool info format. On the command line this means that all output will be
 .IX Subsection "graphv"
 Calling rrdtool with the graphv option will return information in the
 rrdtool info format. On the command line this means that all output will be


@@ -588,7 +588,7 @@ When the filename '\-' is given, the contents of the graph itself will also
 be returned through this interface (hash key 'image'). On the command line
 the output will look like this:
 .PP
 be returned through this interface (hash key 'image'). On the command line
 the output will look like this:
 .PP

-.Vb 14
+.Vb 10

 \& print[0] = "0.020833"
 \& print[1] = "0.0440833"
 \& graph_left = 51
 \& print[0] = "0.020833"
 \& print[1] = "0.0440833"
 \& graph_left = 51