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