![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 089851538e576f408918560b1b05291df38a1a47..f3f1a50a0f3d0a7d3cdbb3396858e31f244af7f9 100644 (file)
--- a/doc/rrdgraph_graph.html
+++ b/doc/rrdgraph_graph.html
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
- <li><a href="#print">PRINT</a></li>
- <li><a href="#graph">GRAPH</a></li>
+ <ul>
+
+ <li><a href="#print">PRINT</a></li>
+ <ul>
+
+ <li><a href="#print_vname_format__strftime_"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>format</em>[<strong>:strftime</strong>]</a></li>
+ <li><a href="#print_vname_cf_format"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></li>
+ </ul>
+
+ <li><a href="#graph">GRAPH</a></li>
+ <ul>
+
+ <li><a href="#gprint_vname_format"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>format</em></a></li>
+ <li><a href="#gprint_vname_cf_format"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></li>
+ <li><a href="#comment_text"><strong>COMMENT</strong><strong>:</strong><em>text</em></a></li>
+ <li><a href="#vrule_time_color__legend___dashes__on_s__off_s__on_s_off_s________dashoffset_offset__"><strong>VRULE</strong><strong>:</strong><em>time</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></li>
+ <li><a href="#hrule_value_color__legend___dashes__on_s__off_s__on_s_off_s________dashoffset_offset__"><strong>HRULE</strong><strong>:</strong><em>value</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></li>
+ <li><a href="#line_width__value__color____legend___stack____dashes__on_s__off_s__on_s_off_s________dashoffset_offset__"><strong>LINE</strong>[<em>width</em>]<strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></li>
+ <li><a href="#area_value__color____legend___stack__"><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]]</a></li>
+ <li><a href="#tick_vname_rrggbb_aa___fraction__legend__"><strong>TICK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>rrggbb</em>[<em>aa</em>][<strong>:</strong><em>fraction</em>[<strong>:</strong><em>legend</em>]]</a></li>
+ <li><a href="#shift_vname_offset"><strong>SHIFT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>offset</em></a></li>
+ <li><a href="#textalign__left_right_justified_center_"><strong>TEXTALIGN</strong><strong>:</strong>{<strong>left</strong>|<strong>right</strong>|<strong>justified</strong>|<strong>center</strong>}</a></li>
+ <li><a href="#stack_vname_color__legend_"><strong>STACK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>]</a></li>
+ </ul>
+
+ </ul>
+
<li><a href="#notes_on_legend_arguments">NOTES on legend arguments</a></li>
<ul>
Similarly, no report is generated if you don't use print options.</p>
<p>
</p>
-<hr />
-<h1><a name="print">PRINT</a></h1>
-<dl>
-<dt><strong><a name="item_print_3avname_3aformat_5b_3astrftime_5d"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>format</em>[<strong>:strftime</strong>]</a></strong></dt>
-
-<dd>
+<h2><a name="print">PRINT</a></h2>
+<p>
+</p>
+<h3><a name="print_vname_format__strftime_"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>format</em>[<strong>:strftime</strong>]</a></h3>
<p>Depending on the context, either the value component or the time
component of a <strong>VDEF</strong> is printed using <em>format</em>. It is an error
to specify a <em>vname</em> generated by a <strong>DEF</strong> or <strong>CDEF</strong>.</p>
<p>A literal `%' character.</p>
</dd>
</dl>
-</dd>
-<dt><strong><a name="item_print_3avname_3acf_3aformat"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="print_vname_cf_format"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></h3>
<p><em>Deprecated. Use the new form of this command in new scripts.</em>
The first form of this command is to be used with <strong>CDEF</strong> <em>vname</em>s.</p>
-</dd>
-</dl>
<p>
</p>
-<hr />
-<h1><a name="graph">GRAPH</a></h1>
-<dl>
-<dt><strong><a name="item_gprint_3avname_3aformat"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>format</em></a></strong></dt>
-
-<dd>
+<h2><a name="graph">GRAPH</a></h2>
+<p>
+</p>
+<h3><a name="gprint_vname_format"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>format</em></a></h3>
<p>This is the same as <code>PRINT</code>, but printed inside the graph.</p>
-</dd>
-<dt><strong><a name="item_gprint_3avname_3acf_3aformat"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="gprint_vname_cf_format"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></h3>
<p><em>Deprecated. Use the new form of this command in new scripts.</em>
This is the same as <code>PRINT</code>, but printed inside the graph.</p>
-</dd>
-<dt><strong><a name="item_comment_3atext"><strong>COMMENT</strong><strong>:</strong><em>text</em></a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="comment_text"><strong>COMMENT</strong><strong>:</strong><em>text</em></a></h3>
<p>Text is printed literally in the legend section of the graph. Note that in
RRDtool 1.2 you have to escape colons in COMMENT text in the same way you
have to escape them in <strong>*PRINT</strong> commands by writing <strong>'\:'</strong>.</p>
-</dd>
-<dt><strong><a name="item_vrule_3atime_23color_5b_3alegend_5d_5b_3adashes_5b"><strong>VRULE</strong><strong>:</strong><em>time</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="vrule_time_color__legend___dashes__on_s__off_s__on_s_off_s________dashoffset_offset__"><strong>VRULE</strong><strong>:</strong><em>time</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></h3>
<p>Draw a vertical line at <em>time</em>. Its color is composed from three
hexadecimal numbers specifying the rgb color components (00 is off, FF is
maximum) red, green and blue followed by an optional alpha. Optionally, a legend box and string is
from a <strong>VDEF</strong>. It is an error to use <em>vname</em>s from <strong>DEF</strong> or <strong>CDEF</strong> here.
Dashed lines can be drawn using the <strong>dashes</strong> modifier. See <strong>LINE</strong> for more
details.</p>
-</dd>
-<dt><strong><a name="item_hrule_3avalue_23color_5b_3alegend_5d_5b_3adashes_5"><strong>HRULE</strong><strong>:</strong><em>value</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="hrule_value_color__legend___dashes__on_s__off_s__on_s_off_s________dashoffset_offset__"><strong>HRULE</strong><strong>:</strong><em>value</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></h3>
<p>Draw a horizontal line at <em>value</em>. HRULE acts much like LINE except that
will have no effect on the scale of the graph. If a HRULE is outside the
graphing area it will just not be visible.</p>
-</dd>
-<dt><strong><a name="item_line_5bwidth_5d_3avalue_5b_23color_5d_5b_3a_5blege"><strong>LINE</strong>[<em>width</em>]<strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="line_width__value__color____legend___stack____dashes__on_s__off_s__on_s_off_s________dashoffset_offset__"><strong>LINE</strong>[<em>width</em>]<strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></h3>
<p>Draw a line of the specified width onto the graph. <em>width</em> can be a
floating point number. If the color is not specified, the drawing is done
'invisibly'. This is useful when stacking something else on top of this
@@ -309,48 +322,41 @@ stroke. The <strong>dash-offset</strong> parameter specifies an <em>offset</em>
at which the stroke begins.</p>
<p>When you do not specify a color, you cannot specify a legend. Should
you want to use STACK, use the ``LINEx:<value>::STACK'' form.</p>
-</dd>
-<dt><strong><a name="item_area_3avalue_5b_23color_5d_5b_3a_5blegend_5d_5b_3a"><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]]</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="area_value__color____legend___stack__"><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]]</a></h3>
<p>See <strong>LINE</strong>, however the area between the x-axis and the line will
be filled.</p>
-</dd>
-<dt><strong><a name="item_tick_3avname_23rrggbb_5baa_5d_5b_3afraction_5b_3al"><strong>TICK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>rrggbb</em>[<em>aa</em>][<strong>:</strong><em>fraction</em>[<strong>:</strong><em>legend</em>]]</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="tick_vname_rrggbb_aa___fraction__legend__"><strong>TICK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>rrggbb</em>[<em>aa</em>][<strong>:</strong><em>fraction</em>[<strong>:</strong><em>legend</em>]]</a></h3>
<p>Plot a tick mark (a vertical line) for each value of <em>vname</em> that is
non-zero and not *UNKNOWN*. The <em>fraction</em> argument specifies the length of
the tick mark as a fraction of the y-axis; the default value is 0.1 (10% of
the axis). Note that the color specification is not optional. The TICK marks normaly
start at the lower edge of the graphing area. If the fraction is negative they start
at the upper border of the graphing area.</p>
-</dd>
-<dt><strong><a name="item_shift_3avname_3aoffset"><strong>SHIFT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>offset</em></a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="shift_vname_offset"><strong>SHIFT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>offset</em></a></h3>
<p>Using this command <strong>RRDtool</strong> will graph the following elements
with the specified offset. For instance, you can specify an
offset of ( 7*24*60*60 = ) 604'800 seconds to ``look back'' one
week. Make sure to tell the viewer of your graph you did this ...
As with the other graphing elements, you can specify a number or
a variable here.</p>
-</dd>
-<dt><strong><a name="item_textalign_3a_7bleft_7cright_7cjustified_7ccenter_7"><strong>TEXTALIGN</strong><strong>:</strong>{<strong>left</strong>|<strong>right</strong>|<strong>justified</strong>|<strong>center</strong>}</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="textalign__left_right_justified_center_"><strong>TEXTALIGN</strong><strong>:</strong>{<strong>left</strong>|<strong>right</strong>|<strong>justified</strong>|<strong>center</strong>}</a></h3>
<p>Labels are placed below the graph. When they overflow to the left, they wrap
to the next line. By default, lines are justified left and right. The
<strong>TEXTALIGN</strong> function lets you change this default. This is a command and
not an option, so that you can change the default several times in your
argument list.</p>
-</dd>
-<dt><strong><a name="item_stack_3avname_23color_5b_3alegend_5d"><strong>STACK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>]</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="stack_vname_color__legend_"><strong>STACK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>]</a></h3>
<p><em>Deprecated. Use the <strong>STACK</strong> modifiers on the other commands.</em></p>
-</dd>
-</dl>
<p><strong>Some notes on stacking</strong></p>
<p>When stacking, an element is not placed above the X-axis but rather
on top of the previous element. There must be something to stack