Code

Imported upstream version 1.3.0.
[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="#size">Size</a></li>
30                 <li><a href="#limits">Limits</a></li>
31                 <li><a href="#grid">Grid</a></li>
32                 <li><a href="#miscellaneous">Miscellaneous</a></li>
33                 <li><a href="#data_and_variables">Data and variables</a></li>
34                 <li><a href="#graph_and_print_elements">Graph and print elements</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="size">Size</a></h2>
137 <p>[<strong>-w</strong>|<strong>--width</strong> <em>pixels</em>]
138 [<strong>-h</strong>|<strong>--height</strong> <em>pixels</em>]
139 [<strong>-j</strong>|<strong>--only-graph</strong>]
140 [<strong>-D</strong>|<strong>--full-size-mode</strong>]</p>
141 <p>By default, the width and height of the <strong>canvas</strong> (the part with
142 the actual data and such). This defaults to 400 pixels by 100 pixels.</p>
143 <p>If you specify the <strong>--full-size-mode</strong> option, the width and height
144 specify the final dimensions of the output image and the canvas
145 is automatically resized to fit.</p>
146 <p>If you specify the <strong>--only-graph</strong> option and set the height &lt; 32
147 pixels you will get a tiny graph image (thumbnail) to use as an icon
148 for use in an overview, for example. All labeling will be stripped off
149 the graph.</p>
150 <p>
151 </p>
152 <h2><a name="limits">Limits</a></h2>
153 <p>[<strong>-u</strong>|<strong>--upper-limit</strong> <em>value</em>]
154 [<strong>-l</strong>|<strong>--lower-limit</strong> <em>value</em>]
155 [<strong>-r</strong>|<strong>--rigid</strong>]</p>
156 <p>By default the graph will be autoscaling so that it will adjust the
157 y-axis to the range of the data. You can change this behaviour by
158 explicitly setting the limits. The displayed y-axis will then range at
159 least from <strong>lower-limit</strong> to <strong>upper-limit</strong>. Autoscaling will still
160 permit those boundaries to be stretched unless the <strong>rigid</strong> option is
161 set.</p>
162 <p>[<strong>-A</strong>|<strong>--alt-autoscale</strong>]</p>
163 <p>Sometimes the default algorithm for selecting the y-axis scale is not
164 satisfactory. Normally the scale is selected from a predefined
165 set of ranges and this fails miserably when you need to graph something
166 like <code>260 + 0.001 * sin(x)</code>. This option calculates the minimum and
167 maximum y-axis from the actual minimum and maximum data values. Our example
168 would display slightly less than <code>260-0.001</code> to slightly more than
169 <code>260+0.001</code> (this feature was contributed by Sasha Mikheev).</p>
170 <p>[<strong>-J</strong>|<strong>--alt-autoscale-min</strong>]</p>
171 <p>Where <code>--alt-autoscale</code> will modify both the absolute maximum AND minimum
172 values, this option will only affect the minimum value. The maximum
173 value, if not defined on the command line, will be 0. This option can
174 be useful when graphing router traffic when the WAN line uses compression,
175 and thus the throughput may be higher than the WAN line speed.</p>
176 <p>[<strong>-M</strong>|<strong>--alt-autoscale-max</strong>]</p>
177 <p>Where <code>--alt-autoscale</code> will modify both the absolute maximum AND minimum
178 values, this option will only affect the maximum value. The minimum
179 value, if not defined on the command line, will be 0. This option can
180 be useful when graphing router traffic when the WAN line uses compression,
181 and thus the throughput may be higher than the WAN line speed.</p>
182 <p>[<strong>-N</strong>|<strong>--no-gridfit</strong>]</p>
183 <p>In order to avoid anti-aliasing blurring effects rrdtool snaps
184 points to device resolution pixels, this results in a crisper
185 aperance. If this is not to your liking, you can use this switch
186 to turn this behaviour off.</p>
187 <p>Gridfitting is turned off for PDF, EPS, SVG output by default.</p>
188 <p>
189 </p>
190 <h2><a name="grid">Grid</a></h2>
191 <dl>
192 <dt><strong><a name="item_x_2daxis">X-Axis</a></strong></dt>
194 <dd>
195 <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>
196 <p>[<strong>-x</strong>|<strong>--x-grid</strong> <strong>none</strong>]</p>
197 <p>The x-axis label is quite complex to configure. If you don't have
198 very special needs it is probably best to rely on the autoconfiguration
199 to get this right. You can specify the string <code>none</code> to suppress the grid
200 and labels altogether.</p>
201 <p>The grid is defined by specifying a certain amount of time in the <em>?TM</em>
202 positions. You can choose from <code>SECOND</code>, <code>MINUTE</code>, <code>HOUR</code>, <code>DAY</code>,
203 <code>WEEK</code>, <code>MONTH</code> or <code>YEAR</code>. Then you define how many of these should
204 pass between each line or label.  This pair (<em>?TM:?ST</em>) needs to be
205 specified for the base grid (<em>G??</em>), the major grid (<em>M??</em>) and the
206 labels (<em>L??</em>). For the labels you also must define a precision
207 in <em>LPR</em> and a <em>strftime</em> format string in <em>LFM</em>.  <em>LPR</em> defines
208 where each label will be placed. If it is zero, the label will be
209 placed right under the corresponding line (useful for hours, dates
210 etcetera).  If you specify a number of seconds here the label is
211 centered on this interval (useful for Monday, January etcetera).</p>
212 <pre>
213  --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X</pre>
214 <p>This places grid lines every 10 minutes, major grid lines every hour,
215 and labels every 4 hours. The labels are placed under the major grid
216 lines as they specify exactly that time.</p>
217 <pre>
218  --x-grid HOUR:8:DAY:1:DAY:1:86400:%A</pre>
219 <p>This places grid lines every 8 hours, major grid lines and labels
220 each day. The labels are placed exactly between two major grid lines
221 as they specify the complete day and not just midnight.</p>
222 </dd>
223 <dt><strong><a name="item_y_2daxis">Y-Axis</a></strong></dt>
225 <dd>
226 <p>[<strong>-y</strong>|<strong>--y-grid</strong> <em>grid step</em><strong>:</strong><em>label factor</em>]</p>
227 <p>[<strong>-y</strong>|<strong>--y-grid</strong> <strong>none</strong>]</p>
228 <p>Y-axis grid lines appear at each <em>grid step</em> interval.  Labels are
229 placed every <em>label factor</em> lines.  You can specify <code>-y none</code> to
230 suppress the grid and labels altogether.  The default for this option is
231 to automatically select sensible values.</p>
232 <p>If you have set --y-grid to 'none' not only the labels get supressed, also
233 the space reserved for the labels is removed. You can still add space
234 manually if you use the --units-length command to explicitly reserve space.</p>
235 <p>[<strong>-Y</strong>|<strong>--alt-y-grid</strong>]</p>
236 <p>Place the Y grid dynamically based on the graph's Y range. The algorithm
237 ensures that you always have a grid, that there are enough but not too many
238 grid lines, and that the grid is metric. That is the grid lines are placed
239 every 1, 2, 5 or 10 units. This parameter will also ensure that you get
240 enough decimals displayed even if your graph goes from 69.998 to 70.001. 
241 (contributed by Sasha Mikheev).</p>
242 <p>[<strong>-o</strong>|<strong>--logarithmic</strong>]</p>
243 <p>Logarithmic y-axis scaling.</p>
244 <p>[<strong>-X</strong>|<strong>--units-exponent</strong> <em>value</em>]</p>
245 <p>This sets the 10**exponent scaling of the y-axis values. Normally,
246 values will be scaled to the appropriate units (k, M, etc.).  However,
247 you may wish to display units always in k (Kilo, 10e3) even if the data
248 is in the M (Mega, 10e6) range, for instance. Value should be an
249 integer which is a multiple of 3 between -18 and 18 inclusively.  It is
250 the exponent on the units you wish to use. For example, use 3 to
251 display the y-axis values in k (Kilo, 10e3, thousands), use -6 to
252 display the y-axis values in u (Micro, 10e-6, millionths).  Use a value
253 of 0 to prevent any scaling of the y-axis values.</p>
254 <p>This option is very effective at confusing the heck out of the default
255 rrdtool autoscaler and grid painter. If rrdtool detects that it is not
256 successful in labeling the graph under the given circumstances, it will switch
257 to the more robust <strong>--alt-y-grid</strong> mode.</p>
258 <p>[<strong>-L</strong>|<strong>--units-length</strong> <em>value</em>]</p>
259 <p>How many digits should rrdtool assume the y-axis labels to be? You
260 may have to use this option to make enough space once you start
261 fideling with the y-axis labeling.</p>
262 <p>[<strong>--units=si</strong>]</p>
263 <p>With this option y-axis values on logarithmic graphs will be scaled to 
264 the appropriate units (k, M, etc.) instead of using exponential notation.
265 Note that for linear graphs, SI notation is used by default.</p>
266 </dd>
267 </dl>
268 <p>
269 </p>
270 <h2><a name="miscellaneous">Miscellaneous</a></h2>
271 <p>[<strong>-z</strong>|<strong>--lazy</strong>]</p>
272 <p>Only generate the graph if the current graph is out of date or not
273 existent.</p>
274 <p>[<strong>-f</strong>|<strong>--imginfo</strong> <em>printfstr</em>]</p>
275 <p>After the image has been created, the graph function uses printf
276 together with this format string to create output similar to the PRINT
277 function, only that the printf function is supplied with the parameters
278 <em>filename</em>, <em>xsize</em> and <em>ysize</em>. In order to generate an <strong>IMG</strong> tag
279 suitable for including the graph into a web page, the command line
280 would look like this:</p>
281 <pre>
282  --imginfo '&lt;IMG SRC=&quot;/img/%s&quot; WIDTH=&quot;%lu&quot; HEIGHT=&quot;%lu&quot; ALT=&quot;Demo&quot;&gt;'</pre>
283 <p>[<strong>-c</strong>|<strong>--color</strong> <em>COLORTAG</em>#<em>rrggbb</em>[<em>aa</em>]]</p>
284 <p>Override the default colors for the standard elements of the graph. The
285 <em>COLORTAG</em> is one of <code>BACK</code> background, <code>CANVAS</code> for the background of
286 the actual graph, <code>SHADEA</code> for the left and top border, <code>SHADEB</code> for the
287 right and bottom border, <code>GRID</code>, <code>MGRID</code> for the major grid, <code>FONT</code> for
288 the color of the font, <code>AXIS</code> for the axis of the graph, <code>FRAME</code> for the
289 line around the color spots and finally <code>ARROW</code> for the arrow head pointing
290 up and forward. Each color is composed out of three hexadecimal numbers
291 specifying its rgb color component (00 is off, FF is maximum) of red, green
292 and blue. Optionally you may add another hexadecimal number specifying the
293 transparency (FF is solid). You may set this option several times to alter
294 multiple defaults.</p>
295 <p>A green arrow is made by: <code>--color ARROW#00FF00</code></p>
296 <p>[<strong>--zoom</strong> <em>factor</em>]</p>
297 <p>Zoom the graphics by the given amount. The factor must be &gt; 0</p>
298 <p>[<strong>-n</strong>|<strong>--font</strong> <em>FONTTAG</em><strong>:</strong><em>size</em><strong>:</strong>[<em>font</em>]]</p>
299 <p>This lets you customize which font to use for the various text
300 elements on the RRD graphs. <code>DEFAULT</code> sets the default value for all
301 elements, <code>TITLE</code> for the title, <code>AXIS</code> for the axis labels, <code>UNIT</code>
302 for the vertical unit label, <code>LEGEND</code> for the graph legend.</p>
303 <p>Use Times for the title: <code>--font TITLE:13:Times</code></p>
304 <p>If you do not give a font string you can modify just the sice of the default font:
305 <code>--font TITLE:13:</code>.</p>
306 <p>If you specify the size 0 then you can modify just the font without touching
307 the size. This is especially usefull for altering the default font without
308 resetting the default fontsizes: <code>--font DEFAULT:0:Courier</code>.</p>
309 <p>RRDtool comes with a preset default font. You can set the environment
310 variable <code>RRD_DEFAULT_FONT</code> if you want to change this.</p>
311 <p>RRDtool uses Pango for its font handling. This means you can to use
312 the full Pango syntax when selecting your font:</p>
313 <p>The font name has the form ``[<em>FAMILY-LIST</em>] [<em>STYLE-OPTIONS</em>] [<em>SIZE</em>]'',
314 where <em>FAMILY-LIST</em> is a comma separated list of families optionally
315 terminated by a comma, <em>STYLE_OPTIONS</em> is a whitespace separated list of
316 words where each WORD describes one of style, variant, weight, stretch, or
317 gravity, and <em>SIZE</em> is a decimal number (size in points) or optionally
318 followed by the unit modifier ``px'' for absolute size. Any one of the options
319 may be absent.</p>
320 <p>[<strong>-R</strong>|<strong>--font-render-mode</strong> {<strong>normal</strong>,<strong>light</strong>,<strong>mono</strong>}]</p>
321 <p>There are 3 font render modes:</p>
322 <p><strong>normal</strong>: Full Hinting and Antialiasing (default)</p>
323 <p><strong>light</strong>: Slight Hinting and Antialiasing</p>
324 <p><strong>mono</strong>: Full Hinting and NO Antialiasing</p>
325 <p>[<strong>-B</strong>|<strong>--font-smoothing-threshold</strong> <em>size</em>]</p>
326 <p>(this gets ignored in 1.3 for now!)</p>
327 <p>This specifies the largest font size which will be rendered
328 bitmapped, that is, without any font smoothing. By default,
329 no text is rendered bitmapped.</p>
330 <p>[<strong>-P</strong>|<strong>--pango-markup</strong>]</p>
331 <p>All text in rrdtool is rendered using Pango. With the <strong>--pango-markup</strong> option, all
332 text will be processed by pango markup. This allows to embed some simple html
333 like markup tags using 
334 </p>
335 <pre>
337  &lt;span key=&quot;value&quot;&gt;text&lt;/span&gt;</pre>
338 <p>Apart from the verbose syntax, there are also the following short tags available.</p>
339 <pre>
340  b     Bold
341  big   Makes font relatively larger, equivalent to &lt;span size=&quot;larger&quot;&gt;
342  i     Italic
343  s     Strikethrough
344  sub   Subscript
345  sup   Superscript
346  small Makes font relatively smaller, equivalent to &lt;span size=&quot;smaller&quot;&gt;
347  tt    Monospace font
348  u     Underline 
349  
350 More details on L&lt;<a href="http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html&gt">http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html&gt</a>;.</pre>
351 <p>[<strong>-G</strong>|<strong>--graph-render-mode</strong> {<strong>normal</strong>,<strong>mono</strong>}]</p>
352 <p>There are 2 render modes:</p>
353 <p><strong>normal</strong>: Graphs are fully Antialiased (default)</p>
354 <p><strong>mono</strong>: No Antialiasing</p>
355 <p>[<strong>-E</strong>|<strong>--slope-mode</strong>]</p>
356 <p>RRDtool graphs are composed of stair case curves by default. This is in line with
357 the way RRDtool calculates its data. Some people favor a more 'organic' look
358 for their graphs even though it is not all that true.</p>
359 <p>[<strong>-a</strong>|<strong>--imgformat</strong> <strong>PNG</strong>|<strong>SVG</strong>|<strong>EPS</strong>|<strong>PDF</strong>]</p>
360 <p>Image format for the generated graph. For the vector formats you can
361 choose among the standard Postscript fonts Courier-Bold,
362 Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold,
363 Helvetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
364 Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.</p>
365 <p>[<strong>-i</strong>|<strong>--interlaced</strong>]</p>
366 <p>(this gets ignored in 1.3 for now!)</p>
367 <p>If images are interlaced they become visible on browsers more quickly.</p>
368 <p>[<strong>-g</strong>|<strong>--no-legend</strong>]</p>
369 <p>Suppress generation of the legend; only render the graph.</p>
370 <p>[<strong>-F</strong>|<strong>--force-rules-legend</strong>]</p>
371 <p>Force the generation of HRULE and VRULE legends even if those HRULE or
372 VRULE will not be drawn because out of graph boundaries (mimics
373 behaviour of pre 1.0.42 versions).</p>
374 <p>[<strong>-T</strong>|<strong>--tabwidth</strong> <em>value</em>]</p>
375 <p>By default the tab-width is 40 pixels, use this option to change it.</p>
376 <p>[<strong>-b</strong>|<strong>--base</strong> <em>value</em>]</p>
377 <p>If you are graphing memory (and NOT network traffic) this switch
378 should be set to 1024 so that one Kb is 1024 byte. For traffic
379 measurement, 1 kb/s is 1000 b/s.</p>
380 <p>[<strong>-W</strong>|<strong>--watermark</strong> <em>string</em>]</p>
381 <p>Adds the given string as a watermark, horizontally centred, at the bottom 
382 of the graph.</p>
383 <p>
384 </p>
385 <h2><a name="data_and_variables">Data and variables</a></h2>
386 <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>
387 <p><strong>CDEF:</strong><em>vname</em><strong>=</strong><em>RPN expression</em></p>
388 <p><strong>VDEF:</strong><em>vname</em><strong>=</strong><em>RPN expression</em></p>
389 <p>You need at least one <strong>DEF</strong> statement to generate anything. The
390 other statements are useful but optional.
391 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>
392 <p>
393 </p>
394 <h2><a name="graph_and_print_elements">Graph and print elements</a></h2>
395 <p>You need at least one graph element to generate an image and/or
396 at least one print statement to generate a report.
397 See <a href="././rrdgraph_graph.html">the rrdgraph_graph manpage</a> for the exact format.</p>
398 <p>
399 </p>
400 <h2><a name="graphv">graphv</a></h2>
401 <p>Calling rrdtool with the graphv option will return information in the
402 rrdtool info format. On the command line this means that all output will be
403 in key=value format. When used from the perl and ruby bindings a hash
404 pointer will be returned from the call.</p>
405 <p>When the filename '-' is given, the contents of the graph itself will also
406 be returned through this interface (hash key 'image'). On the command line
407 the output will look like this:</p>
408 <pre>
409  print[0] = &quot;0.020833&quot;
410  print[1] = &quot;0.0440833&quot;
411  graph_left = 51
412  graph_top = 22
413  graph_width = 400
414  graph_height = 100
415  image_width = 481
416  image_height = 154
417  value_min = 0.0000000000e+00
418  value_max = 4.0000000000e-02
419  image = BLOB_SIZE:8196
420  [... 8196 bytes of image data ...]</pre>
421 <p>There is more information returned than in the standard interface.
422 Especially the 'graph_*' keys are new. They help applications that want to
423 know what is where on the graph.</p>
424 <p>
425 </p>
426 <hr />
427 <h1><a name="see_also">SEE ALSO</a></h1>
428 <p><a href="././rrdgraph.html">the rrdgraph manpage</a> gives an overview of how <strong>rrdtool graph</strong> works.
429 <a href="././rrdgraph_data.html">the rrdgraph_data manpage</a> describes <strong>DEF</strong>,<strong>CDEF</strong> and <strong>VDEF</strong> in detail.
430 <a href="././rrdgraph_rpn.html">the rrdgraph_rpn manpage</a> describes the <strong>RPN</strong> language used in the <strong>?DEF</strong> statements.
431 <a href="././rrdgraph_graph.html">the rrdgraph_graph manpage</a> page describes all of the graph and print functions.</p>
432 <p>Make sure to read <a href="././rrdgraph_examples.html">the rrdgraph_examples manpage</a> for tips&amp;tricks.</p>
433 <p>
434 </p>
435 <hr />
436 <h1><a name="author">AUTHOR</a></h1>
437 <p>Program by Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
438 <p>This manual page by Alex van den Bogaerdt &lt;<a href="mailto:alex@ergens.op.het.net">alex@ergens.op.het.net</a>&gt;
440 </p>
442 </body>
444 </html>