![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.html b/doc/rrdgraph.html
index dbf4e1351e40829e5b3a53598c1575fc64c6122e..b3063d8d6afd14b98c917ad3a917338d61117780 100644 (file)
--- a/doc/rrdgraph.html
+++ b/doc/rrdgraph.html
-<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>rrdgraph</title>
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
-
-<!-- INDEX BEGIN -->
-<div name="index">
<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
<!--
<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="#xaxis">X-Axis</a></li>
+ <li><a href="#yaxis">Y-Axis</a></li>
+ <li><a href="#right_y_axis">Right Y Axis</a></li>
+ <li><a href="#legend">Legend</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="#environment_variables">ENVIRONMENT VARIABLES</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#author">AUTHOR</a></li>
</ul>
-
-->
-
-
-</div>
<!-- INDEX END -->
<p>
@@ -95,19 +89,15 @@ want to display <strong>bits</strong> per second. This is what the <strong><a hr
using a rather powerful <strong><a href="././rrdgraph_rpn.html">RPN</a></strong> command set.</p>
<p>When you are done fetching and processing the data, it is time to
graph it (or print it). This ends the <strong>rrdtool graph</strong> sequence.</p>
+<p>Use <strong>graphv</strong> instead of <strong>graph</strong> to get detailed information about the
+graph geometry and data once it is drawn. See the bottom of the document for
+more information.</p>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<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>
-<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>
placed string at the left hand side of the graph.</p>
<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>]
<p>Gridfitting is turned off for PDF, EPS, SVG output by default.</p>
<p>
</p>
-<h2><a name="grid">Grid</a></h2>
-<dl>
-<dt><strong><a name="x_axis" class="item">X-Axis</a></strong></dt>
-
-<dd>
+<h2><a name="xaxis">X-Axis</a></h2>
<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>
<p>[<strong>-x</strong>|<strong>--x-grid</strong> <strong>none</strong>]</p>
<p>The x-axis label is quite complex to configure. If you don't have
<p>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.</p>
-</dd>
-<dt><strong><a name="y_axis" class="item">Y-Axis</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h2><a name="yaxis">Y-Axis</a></h2>
<p>[<strong>-y</strong>|<strong>--y-grid</strong> <em>grid step</em><strong>:</strong><em>label factor</em>]</p>
<p>[<strong>-y</strong>|<strong>--y-grid</strong> <strong>none</strong>]</p>
<p>Y-axis grid lines appear at each <em>grid step</em> interval. Labels are
<p>[<strong>-L</strong>|<strong>--units-length</strong> <em>value</em>]</p>
<p>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
-fideling with the y-axis labeling.</p>
+fiddling with the y-axis labeling.</p>
<p>[<strong>--units=si</strong>]</p>
<p>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, SI notation is used by default.</p>
-</dd>
-</dl>
+<p>
+</p>
+<h2><a name="right_y_axis">Right Y 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="legend">Legend</a></h2>
+<p>[<strong>-g</strong>|<strong>--no-legend</strong>]</p>
+<p>Suppress generation of the legend; only render the graph.</p>
+<p>[<strong>-F</strong>|<strong>--force-rules-legend</strong>]</p>
+<p>Force the generation of HRULE and VRULE legends even if those HRULE or
+VRULE will not be drawn because out of graph boundaries (mimics
+behaviour of pre 1.0.42 versions).</p>
+<p>[<strong>--legend-position</strong>=(north|south|west|east)]</p>
+<p>Place the legend at the given side of the graph. The default is south.
+In west or east position it is necessary to add line breaks manually.</p>
+<p>[<strong>--legend-direction</strong>=(topdown|bottomup)]</p>
+<p>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.</p>
<p>
</p>
<h2><a name="miscellaneous">Miscellaneous</a></h2>
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>--daemon</strong> <em>address</em>]</p>
+<p>Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If specified, a <code>flush</code> command is sent
+to the server before reading the RRD files. This allows the graph to contain
+fresh data even if the daemon is configured to cache values for a long time.
+For a list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.</p>
+<pre>
+ rrdtool graph [...] --daemon unix:/var/run/rrdcached.sock [...]</pre>
<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
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>-i</strong>|<strong>--interlaced</strong>]</p>
<p>(this gets ignored in 1.3 for now!)</p>
<p>If images are interlaced they become visible on browsers more quickly.</p>
-<p>[<strong>-g</strong>|<strong>--no-legend</strong>]</p>
-<p>Suppress generation of the legend; only render the graph.</p>
-<p>[<strong>-F</strong>|<strong>--force-rules-legend</strong>]</p>
-<p>Force the generation of HRULE and VRULE legends even if those HRULE or
-VRULE will not be drawn because out of graph boundaries (mimics
-behaviour of pre 1.0.42 versions).</p>
<p>[<strong>-T</strong>|<strong>--tabwidth</strong> <em>value</em>]</p>
<p>By default the tab-width is 40 pixels, use this option to change it.</p>
<p>[<strong>-b</strong>|<strong>--base</strong> <em>value</em>]</p>
<p>
</p>
<hr />
+<h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
+<p>The following environment variables may be used to change the behavior of
+<code>rrdtoolgraph</code>:</p>
+<dl>
+<dt><strong><a name="item_rrdcached_address"><strong>RRDCACHED_ADDRESS</strong></a></strong><br />
+</dt>
+<dd>
+If this environment variable is set it will have the same effect as specifying
+the <code>--daemon</code> option on the command line. If both are present, the command
+line argument takes precedence.
+</dd>
+<p></p></dl>
+<p>
+</p>
+<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="././rrdgraph.html">the rrdgraph manpage</a> gives an overview of how <strong>rrdtool graph</strong> works.
<a href="././rrdgraph_data.html">the rrdgraph_data manpage</a> describes <strong>DEF</strong>,<strong>CDEF</strong> and <strong>VDEF</strong> in detail.