![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.1 b/doc/rrdgraph.1
index e3f81d4c1e995824edf8848eeaece047dac7dd24..66e3d07a8098bb1e6df29a42014a5a698aaf0ec6 100644 (file)
--- a/doc/rrdgraph.1
+++ b/doc/rrdgraph.1
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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. | 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
+.\" 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-
.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 (.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.
-.if \nF \{\
+.ie \nF \{\
. 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.
.\" ========================================================================
.\"
.IX Title "RRDGRAPH 1"
-.TH RRDGRAPH 1 "2009-05-21" "1.3.99909060808" "rrdtool"
+.TH RRDGRAPH 1 "2010-12-07" "1.4.7" "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
+rrdgraph \- Round Robin Database tool graphing functions
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBrrdtool graph|graphv\fR \fIfilename\fR
it is best to collect them now using the
\&\fBvariable definition\fR statement.
Currently this makes no difference, but in a future version
-of rrdtool you may want to collect these values before consolidation.
+of RRDtool you may want to collect these values before consolidation.
.PP
The data fetched from the \fB\s-1RRA\s0\fR is then \fBconsolidated\fR so that
-there is exactly one datapoint per pixel in the graph. If you do
+there is exactly one data point per pixel in the graph. If you do
not take care yourself, \fBRRDtool\fR will expand the range slightly
if necessary. Note, in that case the first and/or last pixel may very
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
-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
more information.
.SH "OPTIONS"
.IX Header "OPTIONS"
-.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.
-.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]
AT-STYLE \s-1TIME\s0 \s-1SPECIFICATION\s0 and rrdgraph_examples.
By default, \fBrrdtool graph\fR calculates the width of one pixel in
the time domain and tries to get data from an \fB\s-1RRA\s0\fR with that
-resolution. With the \fBstep\fR option you can alter this behaviour.
+resolution. With the \fBstep\fR option you can alter this behavior.
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.
-.Sh "Size"
+.SS "Size"
.IX Subsection "Size"
[\fB\-w\fR|\fB\-\-width\fR \fIpixels\fR]
[\fB\-h\fR|\fB\-\-height\fR \fIpixels\fR]
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]
[\fB\-r\fR|\fB\-\-rigid\fR]
.PP
By default the graph will be autoscaling so that it will adjust the
-y\-axis to the range of the data. You can change this behaviour by
+y\-axis to the range of the data. You can change this behavior by
explicitly setting the limits. The displayed y\-axis will then range at
least from \fBlower-limit\fR to \fBupper-limit\fR. Autoscaling will still
permit those boundaries to be stretched unless the \fBrigid\fR option is
.PP
[\fB\-N\fR|\fB\-\-no\-gridfit\fR]
.PP
-In order to avoid anti-aliasing blurring effects rrdtool snaps
+In order to avoid anti-aliasing blurring effects RRDtool snaps
points to device resolution pixels, this results in a crisper
appearance. If this is not to your liking, you can use this switch
-to turn this behaviour off.
+to turn this behavior off.
.PP
-Gridfitting is turned off for \s-1PDF\s0, \s-1EPS\s0, \s-1SVG\s0 output by default.
-.Sh "X\-Axis"
+Grid-fitting is turned off for \s-1PDF\s0, \s-1EPS\s0, \s-1SVG\s0 output by default.
+.SS "X\-Axis"
.IX Subsection "X-Axis"
[\fB\-x\fR|\fB\-\-x\-grid\fR \fI\s-1GTM\s0\fR\fB:\fR\fI\s-1GST\s0\fR\fB:\fR\fI\s-1MTM\s0\fR\fB:\fR\fI\s-1MST\s0\fR\fB:\fR\fI\s-1LTM\s0\fR\fB:\fR\fI\s-1LST\s0\fR\fB:\fR\fI\s-1LPR\s0\fR\fB:\fR\fI\s-1LFM\s0\fR]
.PP
[\fB\-x\fR|\fB\-\-x\-grid\fR \fBnone\fR]
.PP
The x\-axis label is quite complex to configure. If you don't have
-very special needs it is probably best to rely on the autoconfiguration
+very special needs it is probably best to rely on the auto configuration
to get this right. You can specify the string \f(CW\*(C`none\*(C'\fR to suppress the grid
and labels altogether.
.PP
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.
-.Sh "Y\-Axis"
+.SS "Y\-Axis"
.IX Subsection "Y-Axis"
[\fB\-y\fR|\fB\-\-y\-grid\fR \fIgrid step\fR\fB:\fR\fIlabel factor\fR]
.PP
of 0 to prevent any scaling of the y\-axis values.
.PP
This option is very effective at confusing the heck out of the default
-rrdtool autoscaler and grid painter. If rrdtool detects that it is not
+RRDtool autoscaling function and grid painter. If RRDtool detects that it is not
successful in labeling the graph under the given circumstances, it will switch
to the more robust \fB\-\-alt\-y\-grid\fR mode.
.PP
[\fB\-L\fR|\fB\-\-units\-length\fR \fIvalue\fR]
.PP
-How many digits should rrdtool assume the y\-axis labels to be? You
+How many digits should RRDtool assume the y\-axis labels to be? You
may have to use this option to make enough space once you start
fiddling with the y\-axis labeling.
.PP
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 "Right Y Axis"
+.SS "Right Y Axis"
.IX Subsection "Right Y Axis"
[\fB\-\-right\-axis\fR \fIscale\fR\fB:\fR\fIshift\fR]
[\fB\-\-right\-axis\-label\fR \fIlabel\fR]
.PP
[\fB\-\-right\-axis\-format\fR \fIformat-string\fR]
.PP
-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 "Legend"
+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 \f(CW%lf\fR arguments
+you know from the \s-1PRINT\s0 and \s-1GPRINT\s0 commands.
+.SS "Legend"
.IX Subsection "Legend"
[\fB\-g\fR|\fB\-\-no\-legend\fR]
.PP
.PP
Force the generation of \s-1HRULE\s0 and \s-1VRULE\s0 legends even if those \s-1HRULE\s0 or
\&\s-1VRULE\s0 will not be drawn because out of graph boundaries (mimics
-behaviour of pre 1.0.42 versions).
+behavior of pre 1.0.42 versions).
.PP
[\fB\-\-legend\-position\fR=(north|south|west|east)]
.PP
Place the legend items in the given vertical order. The default is topdown.
Using bottomup the legend items appear in the same vertical order as a
stack of lines or areas.
-.Sh "Miscellaneous"
+.SS "Miscellaneous"
.IX Subsection "Miscellaneous"
[\fB\-z\fR|\fB\-\-lazy\fR]
.PP
Only generate the graph if the current graph is out of date or not existent.
Note, that all the calculations will happen regardless so that the output of
-\&\s-1PRINT\s0 and graphv will be complete regardless. Note that the behaviour of
+\&\s-1PRINT\s0 and graphv will be complete regardless. Note that the behavior of
lazy in this regard has seen several changes over time. The only thing you
-can realy rely on before rrdtool 1.3.7 is that lazy will not generate the
+can really rely on before RRDtool 1.3.7 is that lazy will not generate the
graph when it is already there and up to date, and also that it will output
-the size of the graph.
+the size of the graph.
.PP
[\fB\-\-daemon\fR \fIaddress\fR]
.PP
would look like this:
.PP
.Vb 1
-\& \-\-imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
+\& \-\-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]]
.PP
A green arrow is made by: \f(CW\*(C`\-\-color ARROW#00FF00\*(C'\fR
.PP
-[\fB\-\-zoom\fR \fIfactor\fR]
+[\fB\-\-grid\-dash\fR \fIon\fR\fB:\fR\fIoff\fR]
+.PP
+by default the grid is drawn in a 1 on, 1 off pattern. With this option you can set this yourself
+.PP
+.Vb 1
+\& \-\-grid\-dash 1:3 for a dot grid
+\&
+\& \-\-grid\-dash 1:0 for uninterrupted grid lines
+.Ve
+.PP
+[\fB\-\-border\fR \fIwidth\fR]]
+.PP
+Width in pixels for the 3d border drawn around the image. Default 2, 0
+disables the border. See \f(CW\*(C`SHADEA\*(C'\fR and \f(CW\*(C`SHADEB\*(C'\fR above for setting the border
+color.
+.PP
+[\fB\-\-dynamic\-labels\fR]
+.PP
+Pick the shape of the color marker next to the label according to the element drawn on the graph.
+.PP
+[\fB\-m\fR|\fB\-\-zoom\fR \fIfactor\fR]
.PP
Zoom the graphics by the given amount. The factor must be > 0
.PP
.PP
Use Times for the title: \f(CW\*(C`\-\-font TITLE:13:Times\*(C'\fR
.PP
+Note that you need to quote the argument to \fB\-\-font\fR if the font-name
+contains whitespace:
+\&\-\-font \*(L"TITLE:13:Some Font\*(R"
+.PP
If you do not give a font string you can modify just the size of the default font:
\&\f(CW\*(C`\-\-font TITLE:13:\*(C'\fR.
.PP
.PP
There are 3 font render modes:
.PP
-\&\fBnormal\fR: Full Hinting and Antialiasing (default)
+\&\fBnormal\fR: Full Hinting and Anti-aliasing (default)
.PP
-\&\fBlight\fR: Slight Hinting and Antialiasing
+\&\fBlight\fR: Slight Hinting and Anti-aliasing
.PP
-\&\fBmono\fR: Full Hinting and \s-1NO\s0 Antialiasing
+\&\fBmono\fR: Full Hinting and \s-1NO\s0 Anti-aliasing
.PP
[\fB\-B\fR|\fB\-\-font\-smoothing\-threshold\fR \fIsize\fR]
.PP
.PP
[\fB\-P\fR|\fB\-\-pango\-markup\fR]
.PP
-All text in rrdtool is rendered using Pango. With the \fB\-\-pango\-markup\fR option, all
+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>
@@ -541,9 +565,9 @@ More details on <http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.
.PP
There are 2 render modes:
.PP
-\&\fBnormal\fR: Graphs are fully Antialiased (default)
+\&\fBnormal\fR: Graphs are fully Anti-aliased (default)
.PP
-\&\fBmono\fR: No Antialiasing
+\&\fBmono\fR: No Anti-aliasing
.PP
[\fB\-E\fR|\fB\-\-slope\-mode\fR]
.PP
[\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
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
.PP
\&\fB\s-1VDEF:\s0\fR\fIvname\fR\fB=\fR\fI\s-1RPN\s0 expression\fR
.PP
-You need at least one \fB\s-1DEF\s0\fR statement to generate anything. The
-other statements are useful but optional.
+You need at least one \fB\s-1DEF\s0\fR and one \fB\s-1LINE\s0\fR, \fB\s-1AREA\s0\fR, \fB\s-1GPRINT\s0\fR, \fB\s-1PRINT\s0\fR
+statement to generate anything useful.
+.PP
See rrdgraph_data and rrdgraph_rpn for the exact format.
.PP
\&\s-1NOTE:\s0 \fBGraph and print elements\fR
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
+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
in key=value format. When used from the Perl and Ruby bindings a hash
pointer will be returned from the call.
.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