![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index b0d7bef1f752772de00536c07ae7d1b605efc7c5..efee2d85dd78836efe49755723b25bda5fe4f60e 100644 (file)
--- a/doc/rrdgraph_graph.html
+++ b/doc/rrdgraph_graph.html
<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________dash_offset_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________dash_offset_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________dash_offset_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="#line_width__value__color____legend___stack___skipscale____dashes__on_s__off_s__on_s_off_s________dash_offset_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>:skipscale</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___skipscale__"><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>][<strong>:skipscale</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>
<p><strong>COMMENT</strong><strong>:</strong><em>text</em></p>
<p><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>]]</p>
<p><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>]]</p>
-<p><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>]]</p>
-<p><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]]</p>
+<p><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>:skipscale</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>]]</p>
+<p><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>][<strong>:skipscale</strong>]]</p>
<p><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>]]</p>
<p><strong>SHIFT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>offset</em></p>
<p><strong>TEXTALIGN</strong><strong>:</strong>{<strong>left</strong>|<strong>right</strong>|<strong>justified</strong>|<strong>center</strong>}</p>
</dd>
</dl>
<p>If you PRINT a VDEF value, you can also print the time associated with it by appending the string
-<strong>:strftime</strong> to the format. Note that rrdtool uses the strftime function of your OSs C library. This means that
+<strong>:strftime</strong> to the format. Note that RRDtool uses the strftime function of your OSs C library. This means that
the conversion specifier may vary. Check the manual page if you are uncertain. The following is a list of
conversion specifiers usually supported across the board.</p>
<dl>
<dt><strong><strong>%S</strong></strong></dt>
<dd>
-<p>The seconds since the epoch (1.1.1970) (libc dependant non standard!)</p>
+<p>The seconds since the epoch (1.1.1970) (libc dependent non standard!)</p>
</dd>
<dt><strong><a name="_u" class="item"><strong>%U</strong></a></strong></dt>
graphing area it will just not be visible.</p>
<p>
</p>
-<h3><a name="line_width__value__color____legend___stack____dashes__on_s__off_s__on_s_off_s________dash_offset_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>
+<h3><a name="line_width__value__color____legend___stack___skipscale____dashes__on_s__off_s__on_s_off_s________dash_offset_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>:skipscale</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
@@ -324,6 +324,10 @@ the legend section if specified. The <strong>value</strong> can be generated by
<strong>VDEF</strong>, and <strong>CDEF</strong>. If the optional <strong>STACK</strong> modifier is used, this line
is stacked on top of the previous element which can be a <strong>LINE</strong> or an
<strong>AREA</strong>.</p>
+<p>Normally the graphing function makes sure that the entire <strong>LINE</strong> or <strong>AREA</strong>
+is visible in the chart. The scaling of the chart will be modified
+accordingly if necessary. Any <strong>LINE</strong> or <strong>AREA</strong> can be excluded from this
+process by adding the option <strong>skipscale</strong>.</p>
<p>The <strong>dashes</strong> modifier enables dashed line style. Without any further options
a symmetric dashed line with a segment length of 5 pixels will be drawn. The
dash pattern can be changed if the <strong>dashes=</strong> parameter is followed by either
@@ -332,10 +336,10 @@ provides the length of alternate <em>on_s</em> and <em>off_s</em> portions of th
stroke. The <strong>dash-offset</strong> parameter specifies an <em>offset</em> into the pattern
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>
+you want to use <strong>STACK</strong>, use the "LINEx:<value>::STACK" form.</p>
<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>
+<h3><a name="area_value__color____legend___stack___skipscale__"><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>][<strong>:skipscale</strong>]]</a></h3>
<p>See <strong>LINE</strong>, however the area between the x-axis and the line will
be filled.</p>
<p>
right aligned, and <strong>\c</strong> for centered. In the next section there is an
example showing how to use centered formatting.</p>
<p><strong>\n</strong> is a valid alias for <strong>\l</strong> since incomplete parsing in earlier
-versions of rrdtool lead to this behavior and a number of people has been using it.</p>
+versions of RRDtool lead to this behavior and a number of people has been using it.</p>
<p>Normally there are two space characters inserted between every two items
printed into the graph. The space following a string can be suppressed by
putting a <strong>\g</strong> at the end of the string. The <strong>\g</strong> also ignores any space
GPRINT:a:MAX:%lf%s\g</pre>
<p>A special case is COMMENT:<strong>\s</strong> which inserts some additional vertical space
before placing the next row of legends.</p>
-<p>If you are using the proportional font in your graph, you can use tab
-characters or the sequence <strong>\t</strong> to line-up legend elements. Note that
+<p>If you want to have left and right aligned legends on the same line use COMMENT:<strong>\u</strong>
+to go one line back like this:</p>
+<pre>
+ COMMENT:left\l
+ COMMENT:\u
+ COMMENT:right\r</pre>
+<p>There is also a 'nop' control for situations where you want a string to
+actually end in a backslash character sequence <strong>\.</strong></p>
+<pre>
+ COMMENT:OS\2\.</pre>
+<p>When using a proportional font in your graph, the tab
+characters or the sequence <strong>\t</strong> will line-up legend elements. Note that
the tabs inserted are relative to the start of the current legend
element!</p>
<p>Since RRDtool 1.3 is using Pango for rending text, you can use Pango markup.
@@ -496,7 +510,7 @@ Pango uses the xml <strong>span</strong> tags for inline formatting instructions
<dt><strong><a name="strikethrough_color" class="item"><strong>strikethrough_color</strong></a></strong></dt>
<dd>
-<p>The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'</p>
+<p>The color of crossed out lines; an RGB color specification such as '#00FF00' or a color name such as 'red'</p>
</dd>
<dt><strong><a name="fallback" class="item"><strong>fallback</strong></a></strong></dt>
@@ -544,7 +558,7 @@ Pango uses the xml <strong>span</strong> tags for inline formatting instructions
<dt><strong><a name="s" class="item"><strong>s</strong></a></strong></dt>
<dd>
-<p>Strikethrough</p>
+<p>Strike through</p>
</dd>
<dt><strong><a name="sub" class="item"><strong>sub</strong></a></strong></dt>