![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.html b/doc/rrdgraph.html
index 5415923f3cb7066c42d1214f2909834a959aaed1..dbf4e1351e40829e5b3a53598c1575fc64c6122e 100644 (file)
--- a/doc/rrdgraph.html
+++ b/doc/rrdgraph.html
<body style="background-color: white">
-<p><a name="__index__"></a></p>
+
<!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
<!--
<ul>
<li><a href="#options">OPTIONS</a></li>
<ul>
+ <li><a href="#graphv"><strong>graphv</strong></a></li>
+ <li><a href="#filename"><em>filename</em></a></li>
+ <li><a href="#time_range">Time range</a></li>
+ <li><a href="#labels">Labels</a></li>
+ <li><a href="#right_axis">Right Axis</a></li>
+ <li><a href="#size">Size</a></li>
+ <li><a href="#limits">Limits</a></li>
+ <li><a href="#grid">Grid</a></li>
+ <li><a href="#miscellaneous">Miscellaneous</a></li>
+ <li><a href="#data_and_variables">Data and variables</a></li>
<li><a href="#graphv">graphv</a></li>
</ul>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#author">AUTHOR</a></li>
</ul>
+
-->
+
+
+</div>
<!-- INDEX END -->
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
-<dl>
-<dt><strong><a name="item_graphv"><strong>graphv</strong></a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="graphv"><strong>graphv</strong></a></h2>
<p>This alternate version of <strong>graph</strong> takes the same arguments and performs the
same function. The <em>v</em> stands for <em>verbose</em>, which describes the output
returned. <strong>graphv</strong> 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.</p>
-</dd>
-<dt><strong><a name="item_filename">filename</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="filename"><em>filename</em></a></h2>
<p>The name and path of the graph to generate. It is recommended to
end this in <code>.png</code>, <code>.svg</code> or <code>.eps</code>, but <strong>RRDtool</strong> does not enforce this.</p>
<p><em>filename</em> can be '<code>-</code>' to send the image to <code>stdout</code>. In
this case, no other output is generated.</p>
-</dd>
-<dt><strong><a name="item_time_range">Time range</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="time_range">Time range</a></h2>
<p>[<strong>-s</strong>|<strong>--start</strong> <em>time</em>]
[<strong>-e</strong>|<strong>--end</strong> <em>time</em>]
[<strong>-S</strong>|<strong>--step</strong> <em>seconds</em>]</p>
@@ -117,18 +130,28 @@ resolution. With the <strong>step</strong> option you can alter this behaviour.
If you want <strong>rrdtool graph</strong> to get data at a one-hour resolution
from the <strong>RRD</strong>, set <strong>step</strong> to 3'600. Note: a step smaller than
one pixel will silently be ignored.</p>
-</dd>
-<dt><strong><a name="item_labels">Labels</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="labels">Labels</a></h2>
<p>[<strong>-t</strong>|<strong>--title</strong> <em>string</em>]
[<strong>-v</strong>|<strong>--vertical-label</strong> <em>string</em>]</p>
<p>A horizontal string at the top of the graph and/or a vertically
placed string at the left hand side of the graph.</p>
-</dd>
-<dt><strong><a name="item_size">Size</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="right_axis">Right Axis</a></h2>
+<p>[<strong>--right-axis</strong> <em>scale</em><strong>:</strong><em>shift</em>]
+[<strong>--right-axis-label</strong> <em>label</em>]</p>
+<p>A second axis will be drawn to the right of the graph. It is tied to the
+left axis via the scale and shift parameters. You can also define a label
+for the right axis.</p>
+<p>[<strong>--right-axis-format</strong> <em>format-string</em>]</p>
+<p>By default the format of the axis lables gets determined automatically. If
+you want todo this your self, use this option with the same %lf arguments
+you know from the PRING and GPRINT commands.</p>
+<p>
+</p>
+<h2><a name="size">Size</a></h2>
<p>[<strong>-w</strong>|<strong>--width</strong> <em>pixels</em>]
[<strong>-h</strong>|<strong>--height</strong> <em>pixels</em>]
[<strong>-j</strong>|<strong>--only-graph</strong>]
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.</p>
-</dd>
-<dt><strong><a name="item_limits">Limits</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="limits">Limits</a></h2>
<p>[<strong>-u</strong>|<strong>--upper-limit</strong> <em>value</em>]
[<strong>-l</strong>|<strong>--lower-limit</strong> <em>value</em>]
[<strong>-r</strong>|<strong>--rigid</strong>]</p>
<p>[<strong>-N</strong>|<strong>--no-gridfit</strong>]</p>
<p>In order to avoid anti-aliasing blurring effects rrdtool snaps
points to device resolution pixels, this results in a crisper
-aperance. If this is not to your liking, you can use this switch
+appearance. If this is not to your liking, you can use this switch
to turn this behaviour off.</p>
<p>Gridfitting is turned off for PDF, EPS, SVG output by default.</p>
-</dd>
-<dt><strong><a name="item_grid">Grid</a></strong></dt>
-
+<p>
+</p>
+<h2><a name="grid">Grid</a></h2>
<dl>
-<dt><strong><a name="item_x_2daxis">X-Axis</a></strong></dt>
+<dt><strong><a name="x_axis" class="item">X-Axis</a></strong></dt>
<dd>
<p>[<strong>-x</strong>|<strong>--x-grid</strong> <em>GTM</em><strong>:</strong><em>GST</em><strong>:</strong><em>MTM</em><strong>:</strong><em>MST</em><strong>:</strong><em>LTM</em><strong>:</strong><em>LST</em><strong>:</strong><em>LPR</em><strong>:</strong><em>LFM</em>]</p>
each day. The labels are placed exactly between two major grid lines
as they specify the complete day and not just midnight.</p>
</dd>
-<dt><strong><a name="item_y_2daxis">Y-Axis</a></strong></dt>
+<dt><strong><a name="y_axis" class="item">Y-Axis</a></strong></dt>
<dd>
<p>[<strong>-y</strong>|<strong>--y-grid</strong> <em>grid step</em><strong>:</strong><em>label factor</em>]</p>
placed every <em>label factor</em> lines. You can specify <code>-y none</code> to
suppress the grid and labels altogether. The default for this option is
to automatically select sensible values.</p>
-<p>If you have set --y-grid to 'none' not only the labels get supressed, also
+<p>If you have set --y-grid to 'none' not only the labels get suppressed, also
the space reserved for the labels is removed. You can still add space
manually if you use the --units-length command to explicitly reserve space.</p>
<p>[<strong>-Y</strong>|<strong>--alt-y-grid</strong>]</p>
Note that for linear graphs, SI notation is used by default.</p>
</dd>
</dl>
-</dd>
-<dt><strong><a name="item_miscellaneous">Miscellaneous</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="miscellaneous">Miscellaneous</a></h2>
<p>[<strong>-z</strong>|<strong>--lazy</strong>]</p>
-<p>Only generate the graph if the current graph is out of date or not
-existent.</p>
+<p>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
+PRINT and graphv will be complete regardless. Note that the behaviour 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
+graph when it is already there and up to date, and also that it will output
+the size of the graph.</p>
<p>[<strong>-f</strong>|<strong>--imginfo</strong> <em>printfstr</em>]</p>
<p>After the image has been created, the graph function uses printf
together with this format string to create output similar to the PRINT
the actual graph, <code>SHADEA</code> for the left and top border, <code>SHADEB</code> for the
right and bottom border, <code>GRID</code>, <code>MGRID</code> for the major grid, <code>FONT</code> for
the color of the font, <code>AXIS</code> for the axis of the graph, <code>FRAME</code> for the
-line around the color spots and finally <code>ARROW</code> for the arrow head pointing
+line around the color spots, and finally <code>ARROW</code> for the arrow head pointing
up and forward. Each color is composed out of three hexadecimal numbers
specifying its rgb color component (00 is off, FF is maximum) of red, green
and blue. Optionally you may add another hexadecimal number specifying the
<p>[<strong>--zoom</strong> <em>factor</em>]</p>
<p>Zoom the graphics by the given amount. The factor must be > 0</p>
<p>[<strong>-n</strong>|<strong>--font</strong> <em>FONTTAG</em><strong>:</strong><em>size</em><strong>:</strong>[<em>font</em>]]</p>
-<p>This lets you customize which font to use for the various text
-elements on the RRD graphs. <code>DEFAULT</code> sets the default value for all
-elements, <code>TITLE</code> for the title, <code>AXIS</code> for the axis labels, <code>UNIT</code>
-for the vertical unit label, <code>LEGEND</code> for the graph legend.</p>
+<p>This lets you customize which font to use for the various text elements on
+the RRD graphs. <code>DEFAULT</code> sets the default value for all elements, <code>TITLE</code>
+for the title, <code>AXIS</code> for the axis labels, <code>UNIT</code> for the vertical unit
+label, <code>LEGEND</code> for the graph legend, <code>WATERMARK</code> for the watermark on the
+edge of the graph.</p>
<p>Use Times for the title: <code>--font TITLE:13:Times</code></p>
-<p>If you do not give a font string you can modify just the sice of the default font:
+<p>If you do not give a font string you can modify just the size of the default font:
<code>--font TITLE:13:</code>.</p>
<p>If you specify the size 0 then you can modify just the font without touching
-the size. This is especially usefull for altering the default font without
+the size. This is especially useful for altering the default font without
resetting the default fontsizes: <code>--font DEFAULT:0:Courier</code>.</p>
<p>RRDtool comes with a preset default font. You can set the environment
variable <code>RRD_DEFAULT_FONT</code> if you want to change this.</p>
<p>RRDtool uses Pango for its font handling. This means you can to use
the full Pango syntax when selecting your font:</p>
-<p>The font name has the form ``[<em>FAMILY-LIST</em>] [<em>STYLE-OPTIONS</em>] [<em>SIZE</em>]'',
+<p>The font name has the form "[<em>FAMILY-LIST</em>] [<em>STYLE-OPTIONS</em>] [<em>SIZE</em>]",
where <em>FAMILY-LIST</em> is a comma separated list of families optionally
terminated by a comma, <em>STYLE_OPTIONS</em> is a whitespace separated list of
words where each WORD describes one of style, variant, weight, stretch, or
gravity, and <em>SIZE</em> is a decimal number (size in points) or optionally
-followed by the unit modifier ``px'' for absolute size. Any one of the options
+followed by the unit modifier "px" for absolute size. Any one of the options
may be absent.</p>
<p>[<strong>-R</strong>|<strong>--font-render-mode</strong> {<strong>normal</strong>,<strong>light</strong>,<strong>mono</strong>}]</p>
<p>There are 3 font render modes:</p>
<p>[<strong>-P</strong>|<strong>--pango-markup</strong>]</p>
<p>All text in rrdtool is rendered using Pango. With the <strong>--pango-markup</strong> option, all
text will be processed by pango markup. This allows to embed some simple html
-like markup tags using
-</p>
+like markup tags using</p>
<pre>
-
<span key="value">text</span></pre>
<p>Apart from the verbose syntax, there are also the following short tags available.</p>
<pre>
sup Superscript
small Makes font relatively smaller, equivalent to <span size="smaller">
tt Monospace font
- u Underline
-
-More details on L<<a href="http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html>">http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html></a>;.</pre>
+ u Underline</pre>
+<p>More details on <a href="http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html">http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html</a>.</p>
<p>[<strong>-G</strong>|<strong>--graph-render-mode</strong> {<strong>normal</strong>,<strong>mono</strong>}]</p>
<p>There are 2 render modes:</p>
<p><strong>normal</strong>: Graphs are fully Antialiased (default)</p>
should be set to 1024 so that one Kb is 1024 byte. For traffic
measurement, 1 kb/s is 1000 b/s.</p>
<p>[<strong>-W</strong>|<strong>--watermark</strong> <em>string</em>]</p>
-<p>Adds the given string as a watermark, horizontally centred, at the bottom
+<p>Adds the given string as a watermark, horizontally centered, at the bottom
of the graph.</p>
-</dd>
-<dt><strong><a name="item_data_and_variables">Data and variables</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="data_and_variables">Data and variables</a></h2>
<p><strong>DEF:</strong><em>vname</em><strong>=</strong><em>rrdfile</em><strong>:</strong><em>ds-name</em><strong>:</strong><em>CF</em>[<strong>:step=</strong><em>step</em>][<strong>:start=</strong><em>time</em>][<strong>:end=</strong><em>time</em>]</p>
<p><strong>CDEF:</strong><em>vname</em><strong>=</strong><em>RPN expression</em></p>
<p><strong>VDEF:</strong><em>vname</em><strong>=</strong><em>RPN expression</em></p>
<p>You need at least one <strong>DEF</strong> statement to generate anything. The
other statements are useful but optional.
See <a href="././rrdgraph_data.html">the rrdgraph_data manpage</a> and <a href="././rrdgraph_rpn.html">the rrdgraph_rpn manpage</a> for the exact format.</p>
-</dd>
-<dt><strong><a name="item_graph_and_print_elements">Graph and print elements</a></strong></dt>
-
-<dd>
+<p>NOTE: <strong>Graph and print elements</strong></p>
<p>You need at least one graph element to generate an image and/or
at least one print statement to generate a report.
See <a href="././rrdgraph_graph.html">the rrdgraph_graph manpage</a> for the exact format.</p>
-</dd>
-</dl>
<p>
</p>
<h2><a name="graphv">graphv</a></h2>
<p>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
+in key=value format. When used from the Perl and Ruby bindings a hash
pointer will be returned from the call.</p>
<p>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
graph_top = 22
graph_width = 400
graph_height = 100
+ graph_start = 1232908800
+ graph_end = 1232914200
image_width = 481
image_height = 154
value_min = 0.0000000000e+00
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Program by Tobias Oetiker <<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>></p>
-<p>This manual page by Alex van den Bogaerdt <<a href="mailto:alex@ergens.op.het.net">alex@ergens.op.het.net</a>>
-
-</p>
+<p>This manual page by Alex van den Bogaerdt <<a href="mailto:alex@vandenbogaerdt.nl">alex@vandenbogaerdt.nl</a>>
+with corrections and/or additions by several people</p>
</body>