Code

Don't install egg-info into the dbg package.
[pkg-rrdtool.git] / doc / rrdgraph.html
1 <?xml version="1.0" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <title>rrdgraph</title>
6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
7 <link rev="made" href="mailto:root@localhost" />
8 </head>
10 <body style="background-color: white">
12 <p><a name="__index__"></a></p>
13 <!-- INDEX BEGIN -->
14 <!--
16 <ul>
18         <li><a href="#name">NAME</a></li>
19         <li><a href="#synopsis">SYNOPSIS</a></li>
20         <li><a href="#description">DESCRIPTION</a></li>
21         <li><a href="#overview">OVERVIEW</a></li>
22         <li><a href="#options">OPTIONS</a></li>
23         <ul>
25                 <li><a href="#graphv"><strong>graphv</strong></a></li>
26                 <li><a href="#filename"><em>filename</em></a></li>
27                 <li><a href="#time_range">Time range</a></li>
28                 <li><a href="#labels">Labels</a></li>
29                 <li><a href="#right_axis">Right Axis</a></li>
30                 <li><a href="#size">Size</a></li>
31                 <li><a href="#limits">Limits</a></li>
32                 <li><a href="#grid">Grid</a></li>
33                 <li><a href="#miscellaneous">Miscellaneous</a></li>
34                 <li><a href="#data_and_variables">Data and variables</a></li>
35                 <li><a href="#graphv">graphv</a></li>
36         </ul>
38         <li><a href="#see_also">SEE ALSO</a></li>
39         <li><a href="#author">AUTHOR</a></li>
40 </ul>
41 -->
42 <!-- INDEX END -->
44 <p>
45 </p>
46 <h1><a name="name">NAME</a></h1>
47 <p>rrdgraph - Round Robin Database tool grapher functions</p>
48 <p>
49 </p>
50 <hr />
51 <h1><a name="synopsis">SYNOPSIS</a></h1>
52 <p><strong>rrdtool graph|graphv</strong> <em>filename</em>
53 [<em><a href="././rrdgraph.html#options">option</a></em> ...]
54 [<em><a href="././rrdgraph_data.html#def">data definition</a></em> ...]
55 [<em><a href="././rrdgraph_data.html#cdef">data calculation</a></em> ...]
56 [<em><a href="././rrdgraph_data.html#vdef">variable definition</a></em> ...]
57 [<em><a href="././rrdgraph_graph.html#graph">graph element</a></em> ...]
58 [<em><a href="././rrdgraph_graph.html#print">print element</a></em> ...]</p>
59 <p>
60 </p>
61 <hr />
62 <h1><a name="description">DESCRIPTION</a></h1>
63 <p>The <strong>graph</strong> function of <strong>RRDtool</strong> is used to present the
64 data from an <strong>RRD</strong> to a human viewer.  Its main purpose is to
65 create a nice graphical representation, but it can also generate
66 a numerical report.</p>
67 <p>
68 </p>
69 <hr />
70 <h1><a name="overview">OVERVIEW</a></h1>
71 <p><strong>rrdtool graph</strong> needs data to work with, so you must use one or more
72 <strong><a href="././rrdgraph_data.html#def">data definition</a></strong> statements to collect this
73 data.  You are not limited to one database, it's perfectly legal to
74 collect data from two or more databases (one per statement, though).</p>
75 <p>If you want to display averages, maxima, percentiles, etcetera
76 it is best to collect them now using the
77 <strong><a href="././rrdgraph_data.html#vdef">variable definition</a></strong> statement.
78 Currently this makes no difference, but in a future version
79 of rrdtool you may want to collect these values before consolidation.</p>
80 <p>The data fetched from the <strong>RRA</strong> is then <strong>consolidated</strong> so that
81 there is exactly one datapoint per pixel in the graph. If you do
82 not take care yourself, <strong>RRDtool</strong> will expand the range slightly
83 if necessary. Note, in that case the first and/or last pixel may very
84 well become unknown!</p>
85 <p>Sometimes data is not exactly in the format you would like to display
86 it. For instance, you might be collecting <strong>bytes</strong> per second, but
87 want to display <strong>bits</strong> per second. This is what the <strong><a href="././rrdgraph_data.html#cdef">data calculation</a></strong> command is designed for. After
88 <strong>consolidating</strong> the data, a copy is made and this copy is modified
89 using a rather powerful <strong><a href="././rrdgraph_rpn.html">RPN</a></strong> command set.</p>
90 <p>When you are done fetching and processing the data, it is time to
91 graph it (or print it).  This ends the <strong>rrdtool graph</strong> sequence.</p>
92 <p>
93 </p>
94 <hr />
95 <h1><a name="options">OPTIONS</a></h1>
96 <p>
97 </p>
98 <h2><a name="graphv"><strong>graphv</strong></a></h2>
99 <p>This alternate version of <strong>graph</strong> takes the same arguments and performs the
100 same function. The <em>v</em> stands for <em>verbose</em>, which describes the output
101 returned. <strong>graphv</strong> will return a lot of information about the graph using
102 the same format as rrdtool info (key = value). See the bottom of the document for more information.</p>
103 <p>
104 </p>
105 <h2><a name="filename"><em>filename</em></a></h2>
106 <p>The name and path of the graph to generate. It is recommended to
107 end this in <code>.png</code>, <code>.svg</code> or <code>.eps</code>, but <strong>RRDtool</strong> does not enforce this.</p>
108 <p><em>filename</em> can be '<code>-</code>' to send the image to <code>stdout</code>. In
109 this case, no other output is generated.</p>
110 <p>
111 </p>
112 <h2><a name="time_range">Time range</a></h2>
113 <p>[<strong>-s</strong>|<strong>--start</strong> <em>time</em>]
114 [<strong>-e</strong>|<strong>--end</strong> <em>time</em>]
115 [<strong>-S</strong>|<strong>--step</strong> <em>seconds</em>]</p>
116 <p>The start and end of the time series you would like to display, and which
117 <strong>RRA</strong> the data should come from.  Defaults are: 1 day ago until
118 now, with the best possible resolution. <strong>Start</strong> and <strong>end</strong> can
119 be specified in several formats, see
120 <a href="././rrdfetch.html">AT-STYLE TIME SPECIFICATION</a> and <a href="././rrdgraph_examples.html">the rrdgraph_examples manpage</a>.
121 By default, <strong>rrdtool graph</strong> calculates the width of one pixel in
122 the time domain and tries to get data from an <strong>RRA</strong> with that
123 resolution.  With the <strong>step</strong> option you can alter this behaviour.
124 If you want <strong>rrdtool graph</strong> to get data at a one-hour resolution
125 from the <strong>RRD</strong>, set <strong>step</strong> to 3'600. Note: a step smaller than
126 one pixel will silently be ignored.</p>
127 <p>
128 </p>
129 <h2><a name="labels">Labels</a></h2>
130 <p>[<strong>-t</strong>|<strong>--title</strong> <em>string</em>]
131 [<strong>-v</strong>|<strong>--vertical-label</strong> <em>string</em>]</p>
132 <p>A horizontal string at the top of the graph and/or a vertically
133 placed string at the left hand side of the graph.</p>
134 <p>
135 </p>
136 <h2><a name="right_axis">Right Axis</a></h2>
137 <p>[<strong>--right-axis</strong> <em>scale</em><strong>:</strong><em>shift</em>]
138 [<strong>--right-axis-label</strong> <em>label</em>]</p>
139 <p>A second axis will be drawn to the right of the graph. It is tied to the
140 left axis via the scale and shift parameters. You can also define a label
141 for the right axis.</p>
142 <p>[<strong>--right-axis-format</strong> <em>format-string</em>]</p>
143 <p>By default the format of the axis lables gets determined automatically. If
144 you want todo this your self, use this option with the same %lf arguments
145 you know from the PRING and GPRINT commands.</p>
146 <p>
147 </p>
148 <h2><a name="size">Size</a></h2>
149 <p>[<strong>-w</strong>|<strong>--width</strong> <em>pixels</em>]
150 [<strong>-h</strong>|<strong>--height</strong> <em>pixels</em>]
151 [<strong>-j</strong>|<strong>--only-graph</strong>]
152 [<strong>-D</strong>|<strong>--full-size-mode</strong>]</p>
153 <p>By default, the width and height of the <strong>canvas</strong> (the part with
154 the actual data and such). This defaults to 400 pixels by 100 pixels.</p>
155 <p>If you specify the <strong>--full-size-mode</strong> option, the width and height
156 specify the final dimensions of the output image and the canvas
157 is automatically resized to fit.</p>
158 <p>If you specify the <strong>--only-graph</strong> option and set the height &lt; 32
159 pixels you will get a tiny graph image (thumbnail) to use as an icon
160 for use in an overview, for example. All labeling will be stripped off
161 the graph.</p>
162 <p>
163 </p>
164 <h2><a name="limits">Limits</a></h2>
165 <p>[<strong>-u</strong>|<strong>--upper-limit</strong> <em>value</em>]
166 [<strong>-l</strong>|<strong>--lower-limit</strong> <em>value</em>]
167 [<strong>-r</strong>|<strong>--rigid</strong>]</p>
168 <p>By default the graph will be autoscaling so that it will adjust the
169 y-axis to the range of the data. You can change this behaviour by
170 explicitly setting the limits. The displayed y-axis will then range at
171 least from <strong>lower-limit</strong> to <strong>upper-limit</strong>. Autoscaling will still
172 permit those boundaries to be stretched unless the <strong>rigid</strong> option is
173 set.</p>
174 <p>[<strong>-A</strong>|<strong>--alt-autoscale</strong>]</p>
175 <p>Sometimes the default algorithm for selecting the y-axis scale is not
176 satisfactory. Normally the scale is selected from a predefined
177 set of ranges and this fails miserably when you need to graph something
178 like <code>260 + 0.001 * sin(x)</code>. This option calculates the minimum and
179 maximum y-axis from the actual minimum and maximum data values. Our example
180 would display slightly less than <code>260-0.001</code> to slightly more than
181 <code>260+0.001</code> (this feature was contributed by Sasha Mikheev).</p>
182 <p>[<strong>-J</strong>|<strong>--alt-autoscale-min</strong>]</p>
183 <p>Where <code>--alt-autoscale</code> will modify both the absolute maximum AND minimum
184 values, this option will only affect the minimum value. The maximum
185 value, if not defined on the command line, will be 0. This option can
186 be useful when graphing router traffic when the WAN line uses compression,
187 and thus the throughput may be higher than the WAN line speed.</p>
188 <p>[<strong>-M</strong>|<strong>--alt-autoscale-max</strong>]</p>
189 <p>Where <code>--alt-autoscale</code> will modify both the absolute maximum AND minimum
190 values, this option will only affect the maximum value. The minimum
191 value, if not defined on the command line, will be 0. This option can
192 be useful when graphing router traffic when the WAN line uses compression,
193 and thus the throughput may be higher than the WAN line speed.</p>
194 <p>[<strong>-N</strong>|<strong>--no-gridfit</strong>]</p>
195 <p>In order to avoid anti-aliasing blurring effects rrdtool snaps
196 points to device resolution pixels, this results in a crisper
197 appearance. If this is not to your liking, you can use this switch
198 to turn this behaviour off.</p>
199 <p>Gridfitting is turned off for PDF, EPS, SVG output by default.</p>
200 <p>
201 </p>
202 <h2><a name="grid">Grid</a></h2>
203 <dl>
204 <dt><strong><a name="item_x_2daxis">X-Axis</a></strong></dt>
206 <dd>
207 <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>
208 <p>[<strong>-x</strong>|<strong>--x-grid</strong> <strong>none</strong>]</p>
209 <p>The x-axis label is quite complex to configure. If you don't have
210 very special needs it is probably best to rely on the autoconfiguration
211 to get this right. You can specify the string <code>none</code> to suppress the grid
212 and labels altogether.</p>
213 <p>The grid is defined by specifying a certain amount of time in the <em>?TM</em>
214 positions. You can choose from <code>SECOND</code>, <code>MINUTE</code>, <code>HOUR</code>, <code>DAY</code>,
215 <code>WEEK</code>, <code>MONTH</code> or <code>YEAR</code>. Then you define how many of these should
216 pass between each line or label.  This pair (<em>?TM:?ST</em>) needs to be
217 specified for the base grid (<em>G??</em>), the major grid (<em>M??</em>) and the
218 labels (<em>L??</em>). For the labels you also must define a precision
219 in <em>LPR</em> and a <em>strftime</em> format string in <em>LFM</em>.  <em>LPR</em> defines
220 where each label will be placed. If it is zero, the label will be
221 placed right under the corresponding line (useful for hours, dates
222 etcetera).  If you specify a number of seconds here the label is
223 centered on this interval (useful for Monday, January etcetera).</p>
224 <pre>
225  --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X</pre>
226 <p>This places grid lines every 10 minutes, major grid lines every hour,
227 and labels every 4 hours. The labels are placed under the major grid
228 lines as they specify exactly that time.</p>
229 <pre>
230  --x-grid HOUR:8:DAY:1:DAY:1:86400:%A</pre>
231 <p>This places grid lines every 8 hours, major grid lines and labels
232 each day. The labels are placed exactly between two major grid lines
233 as they specify the complete day and not just midnight.</p>
234 </dd>
235 <dt><strong><a name="item_y_2daxis">Y-Axis</a></strong></dt>
237 <dd>
238 <p>[<strong>-y</strong>|<strong>--y-grid</strong> <em>grid step</em><strong>:</strong><em>label factor</em>]</p>
239 <p>[<strong>-y</strong>|<strong>--y-grid</strong> <strong>none</strong>]</p>
240 <p>Y-axis grid lines appear at each <em>grid step</em> interval.  Labels are
241 placed every <em>label factor</em> lines.  You can specify <code>-y none</code> to
242 suppress the grid and labels altogether.  The default for this option is
243 to automatically select sensible values.</p>
244 <p>If you have set --y-grid to 'none' not only the labels get suppressed, also
245 the space reserved for the labels is removed. You can still add space
246 manually if you use the --units-length command to explicitly reserve space.</p>
247 <p>[<strong>-Y</strong>|<strong>--alt-y-grid</strong>]</p>
248 <p>Place the Y grid dynamically based on the graph's Y range. The algorithm
249 ensures that you always have a grid, that there are enough but not too many
250 grid lines, and that the grid is metric. That is the grid lines are placed
251 every 1, 2, 5 or 10 units. This parameter will also ensure that you get
252 enough decimals displayed even if your graph goes from 69.998 to 70.001. 
253 (contributed by Sasha Mikheev).</p>
254 <p>[<strong>-o</strong>|<strong>--logarithmic</strong>]</p>
255 <p>Logarithmic y-axis scaling.</p>
256 <p>[<strong>-X</strong>|<strong>--units-exponent</strong> <em>value</em>]</p>
257 <p>This sets the 10**exponent scaling of the y-axis values. Normally,
258 values will be scaled to the appropriate units (k, M, etc.).  However,
259 you may wish to display units always in k (Kilo, 10e3) even if the data
260 is in the M (Mega, 10e6) range, for instance. Value should be an
261 integer which is a multiple of 3 between -18 and 18 inclusively.  It is
262 the exponent on the units you wish to use. For example, use 3 to
263 display the y-axis values in k (Kilo, 10e3, thousands), use -6 to
264 display the y-axis values in u (Micro, 10e-6, millionths).  Use a value
265 of 0 to prevent any scaling of the y-axis values.</p>
266 <p>This option is very effective at confusing the heck out of the default
267 rrdtool autoscaler and grid painter. If rrdtool detects that it is not
268 successful in labeling the graph under the given circumstances, it will switch
269 to the more robust <strong>--alt-y-grid</strong> mode.</p>
270 <p>[<strong>-L</strong>|<strong>--units-length</strong> <em>value</em>]</p>
271 <p>How many digits should rrdtool assume the y-axis labels to be? You
272 may have to use this option to make enough space once you start
273 fideling with the y-axis labeling.</p>
274 <p>[<strong>--units=si</strong>]</p>
275 <p>With this option y-axis values on logarithmic graphs will be scaled to 
276 the appropriate units (k, M, etc.) instead of using exponential notation.
277 Note that for linear graphs, SI notation is used by default.</p>
278 </dd>
279 </dl>
280 <p>
281 </p>
282 <h2><a name="miscellaneous">Miscellaneous</a></h2>
283 <p>[<strong>-z</strong>|<strong>--lazy</strong>]</p>
284 <p>Only generate the graph if the current graph is out of date or not existent.
285 Note, that all the calculations will happen regardless so that the output of
286 PRINT and graphv will be complete regardless. Note that the behaviour of
287 lazy in this regard has seen several changes over time. The only thing you
288 can realy rely on before rrdtool 1.3.7 is that lazy will not generate the
289 graph when it is already there and up to date, and also that it will output
290 the size of the graph.</p>
291 <p>[<strong>-f</strong>|<strong>--imginfo</strong> <em>printfstr</em>]</p>
292 <p>After the image has been created, the graph function uses printf
293 together with this format string to create output similar to the PRINT
294 function, only that the printf function is supplied with the parameters
295 <em>filename</em>, <em>xsize</em> and <em>ysize</em>. In order to generate an <strong>IMG</strong> tag
296 suitable for including the graph into a web page, the command line
297 would look like this:</p>
298 <pre>
299  --imginfo '&lt;IMG SRC=&quot;/img/%s&quot; WIDTH=&quot;%lu&quot; HEIGHT=&quot;%lu&quot; ALT=&quot;Demo&quot;&gt;'</pre>
300 <p>[<strong>-c</strong>|<strong>--color</strong> <em>COLORTAG</em>#<em>rrggbb</em>[<em>aa</em>]]</p>
301 <p>Override the default colors for the standard elements of the graph. The
302 <em>COLORTAG</em> is one of <code>BACK</code> background, <code>CANVAS</code> for the background of
303 the actual graph, <code>SHADEA</code> for the left and top border, <code>SHADEB</code> for the
304 right and bottom border, <code>GRID</code>, <code>MGRID</code> for the major grid, <code>FONT</code> for
305 the color of the font, <code>AXIS</code> for the axis of the graph, <code>FRAME</code> for the
306 line around the color spots, and finally <code>ARROW</code> for the arrow head pointing
307 up and forward. Each color is composed out of three hexadecimal numbers
308 specifying its rgb color component (00 is off, FF is maximum) of red, green
309 and blue. Optionally you may add another hexadecimal number specifying the
310 transparency (FF is solid). You may set this option several times to alter
311 multiple defaults.</p>
312 <p>A green arrow is made by: <code>--color ARROW#00FF00</code></p>
313 <p>[<strong>--zoom</strong> <em>factor</em>]</p>
314 <p>Zoom the graphics by the given amount. The factor must be &gt; 0</p>
315 <p>[<strong>-n</strong>|<strong>--font</strong> <em>FONTTAG</em><strong>:</strong><em>size</em><strong>:</strong>[<em>font</em>]]</p>
316 <p>This lets you customize which font to use for the various text elements on
317 the RRD graphs. <code>DEFAULT</code> sets the default value for all elements, <code>TITLE</code>
318 for the title, <code>AXIS</code> for the axis labels, <code>UNIT</code> for the vertical unit
319 label, <code>LEGEND</code> for the graph legend, <code>WATERMARK</code> for the watermark on the
320 edge of the graph.</p>
321 <p>Use Times for the title: <code>--font TITLE:13:Times</code></p>
322 <p>If you do not give a font string you can modify just the size of the default font:
323 <code>--font TITLE:13:</code>.</p>
324 <p>If you specify the size 0 then you can modify just the font without touching
325 the size. This is especially useful for altering the default font without
326 resetting the default fontsizes: <code>--font DEFAULT:0:Courier</code>.</p>
327 <p>RRDtool comes with a preset default font. You can set the environment
328 variable <code>RRD_DEFAULT_FONT</code> if you want to change this.</p>
329 <p>RRDtool uses Pango for its font handling. This means you can to use
330 the full Pango syntax when selecting your font:</p>
331 <p>The font name has the form ``[<em>FAMILY-LIST</em>] [<em>STYLE-OPTIONS</em>] [<em>SIZE</em>]'',
332 where <em>FAMILY-LIST</em> is a comma separated list of families optionally
333 terminated by a comma, <em>STYLE_OPTIONS</em> is a whitespace separated list of
334 words where each WORD describes one of style, variant, weight, stretch, or
335 gravity, and <em>SIZE</em> is a decimal number (size in points) or optionally
336 followed by the unit modifier ``px'' for absolute size. Any one of the options
337 may be absent.</p>
338 <p>[<strong>-R</strong>|<strong>--font-render-mode</strong> {<strong>normal</strong>,<strong>light</strong>,<strong>mono</strong>}]</p>
339 <p>There are 3 font render modes:</p>
340 <p><strong>normal</strong>: Full Hinting and Antialiasing (default)</p>
341 <p><strong>light</strong>: Slight Hinting and Antialiasing</p>
342 <p><strong>mono</strong>: Full Hinting and NO Antialiasing</p>
343 <p>[<strong>-B</strong>|<strong>--font-smoothing-threshold</strong> <em>size</em>]</p>
344 <p>(this gets ignored in 1.3 for now!)</p>
345 <p>This specifies the largest font size which will be rendered
346 bitmapped, that is, without any font smoothing. By default,
347 no text is rendered bitmapped.</p>
348 <p>[<strong>-P</strong>|<strong>--pango-markup</strong>]</p>
349 <p>All text in rrdtool is rendered using Pango. With the <strong>--pango-markup</strong> option, all
350 text will be processed by pango markup. This allows to embed some simple html
351 like markup tags using</p>
352 <pre>
353  &lt;span key=&quot;value&quot;&gt;text&lt;/span&gt;</pre>
354 <p>Apart from the verbose syntax, there are also the following short tags available.</p>
355 <pre>
356  b     Bold
357  big   Makes font relatively larger, equivalent to &lt;span size=&quot;larger&quot;&gt;
358  i     Italic
359  s     Strikethrough
360  sub   Subscript
361  sup   Superscript
362  small Makes font relatively smaller, equivalent to &lt;span size=&quot;smaller&quot;&gt;
363  tt    Monospace font
364  u     Underline</pre>
365 <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>
366 <p>[<strong>-G</strong>|<strong>--graph-render-mode</strong> {<strong>normal</strong>,<strong>mono</strong>}]</p>
367 <p>There are 2 render modes:</p>
368 <p><strong>normal</strong>: Graphs are fully Antialiased (default)</p>
369 <p><strong>mono</strong>: No Antialiasing</p>
370 <p>[<strong>-E</strong>|<strong>--slope-mode</strong>]</p>
371 <p>RRDtool graphs are composed of stair case curves by default. This is in line with
372 the way RRDtool calculates its data. Some people favor a more 'organic' look
373 for their graphs even though it is not all that true.</p>
374 <p>[<strong>-a</strong>|<strong>--imgformat</strong> <strong>PNG</strong>|<strong>SVG</strong>|<strong>EPS</strong>|<strong>PDF</strong>]</p>
375 <p>Image format for the generated graph. For the vector formats you can
376 choose among the standard Postscript fonts Courier-Bold,
377 Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold,
378 Helvetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
379 Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.</p>
380 <p>[<strong>-i</strong>|<strong>--interlaced</strong>]</p>
381 <p>(this gets ignored in 1.3 for now!)</p>
382 <p>If images are interlaced they become visible on browsers more quickly.</p>
383 <p>[<strong>-g</strong>|<strong>--no-legend</strong>]</p>
384 <p>Suppress generation of the legend; only render the graph.</p>
385 <p>[<strong>-F</strong>|<strong>--force-rules-legend</strong>]</p>
386 <p>Force the generation of HRULE and VRULE legends even if those HRULE or
387 VRULE will not be drawn because out of graph boundaries (mimics
388 behaviour of pre 1.0.42 versions).</p>
389 <p>[<strong>-T</strong>|<strong>--tabwidth</strong> <em>value</em>]</p>
390 <p>By default the tab-width is 40 pixels, use this option to change it.</p>
391 <p>[<strong>-b</strong>|<strong>--base</strong> <em>value</em>]</p>
392 <p>If you are graphing memory (and NOT network traffic) this switch
393 should be set to 1024 so that one Kb is 1024 byte. For traffic
394 measurement, 1 kb/s is 1000 b/s.</p>
395 <p>[<strong>-W</strong>|<strong>--watermark</strong> <em>string</em>]</p>
396 <p>Adds the given string as a watermark, horizontally centered, at the bottom 
397 of the graph.</p>
398 <p>
399 </p>
400 <h2><a name="data_and_variables">Data and variables</a></h2>
401 <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>
402 <p><strong>CDEF:</strong><em>vname</em><strong>=</strong><em>RPN expression</em></p>
403 <p><strong>VDEF:</strong><em>vname</em><strong>=</strong><em>RPN expression</em></p>
404 <p>You need at least one <strong>DEF</strong> statement to generate anything. The
405 other statements are useful but optional.
406 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>
407 <p>NOTE: <strong>Graph and print elements</strong></p>
408 <p>You need at least one graph element to generate an image and/or
409 at least one print statement to generate a report.
410 See <a href="././rrdgraph_graph.html">the rrdgraph_graph manpage</a> for the exact format.</p>
411 <p>
412 </p>
413 <h2><a name="graphv">graphv</a></h2>
414 <p>Calling rrdtool with the graphv option will return information in the
415 rrdtool info format. On the command line this means that all output will be
416 in key=value format. When used from the Perl and Ruby bindings a hash
417 pointer will be returned from the call.</p>
418 <p>When the filename '-' is given, the contents of the graph itself will also
419 be returned through this interface (hash key 'image'). On the command line
420 the output will look like this:</p>
421 <pre>
422  print[0] = &quot;0.020833&quot;
423  print[1] = &quot;0.0440833&quot;
424  graph_left = 51
425  graph_top = 22
426  graph_width = 400
427  graph_height = 100
428  graph_start = 1232908800
429  graph_end = 1232914200
430  image_width = 481
431  image_height = 154
432  value_min = 0.0000000000e+00
433  value_max = 4.0000000000e-02
434  image = BLOB_SIZE:8196
435  [... 8196 bytes of image data ...]</pre>
436 <p>There is more information returned than in the standard interface.
437 Especially the 'graph_*' keys are new. They help applications that want to
438 know what is where on the graph.</p>
439 <p>
440 </p>
441 <hr />
442 <h1><a name="see_also">SEE ALSO</a></h1>
443 <p><a href="././rrdgraph.html">the rrdgraph manpage</a> gives an overview of how <strong>rrdtool graph</strong> works.
444 <a href="././rrdgraph_data.html">the rrdgraph_data manpage</a> describes <strong>DEF</strong>,<strong>CDEF</strong> and <strong>VDEF</strong> in detail.
445 <a href="././rrdgraph_rpn.html">the rrdgraph_rpn manpage</a> describes the <strong>RPN</strong> language used in the <strong>?DEF</strong> statements.
446 <a href="././rrdgraph_graph.html">the rrdgraph_graph manpage</a> page describes all of the graph and print functions.</p>
447 <p>Make sure to read <a href="././rrdgraph_examples.html">the rrdgraph_examples manpage</a> for tips&amp;tricks.</p>
448 <p>
449 </p>
450 <hr />
451 <h1><a name="author">AUTHOR</a></h1>
452 <p>Program by Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
453 <p>This manual page by Alex van den Bogaerdt &lt;<a href="mailto:alex@vandenbogaerdt.nl">alex@vandenbogaerdt.nl</a>&gt;
454 with corrections and/or additions by several people</p>
456 </body>
458 </html>