Code

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