doc/rrdgraph_graph.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_graph</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 <p><a name="__index__"></a></p>
  13 <!-- INDEX BEGIN -->
  14 <!--
  15
  16 <ul>
  17
  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="#print">PRINT</a></li>
  22         <li><a href="#graph">GRAPH</a></li>
  23         <li><a href="#notes_on_legend_arguments">NOTES on legend arguments</a></li>
  24         <ul>
  25
  26                 <li><a href="#escaping_the_colon">Escaping the colon</a></li>
  27                 <li><a href="#string_formatting">String Formatting</a></li>
  28         </ul>
  29
  30         <li><a href="#see_also">SEE ALSO</a></li>
  31         <li><a href="#author">AUTHOR</a></li>
  32 </ul>
  33 -->
  34 <!-- INDEX END -->
  35
  36 <p>
  37 </p>
  38 <hr />
  39 <h1><a name="name">NAME</a></h1>
  40 <p>rrdgraph_graph - rrdtool graph command reference</p>
  41 <p>
  42 </p>
  43 <hr />
  44 <h1><a name="synopsis">SYNOPSIS</a></h1>
  45 <p><strong>PRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>format</em></p>
  46 <p><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>format</em></p>
  47 <p><strong>COMMENT</strong><strong>:</strong><em>text</em></p>
  48 <p><strong>VRULE</strong><strong>:</strong><em>time</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</p>
  49 <p><strong>HRULE</strong><strong>:</strong><em>value</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</p>
  50 <p><strong>LINE</strong>[<em>width</em>]<strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</p>
  51 <p><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]]</p>
  52 <p><strong>TICK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>rrggbb</em>[<em>aa</em>][<strong>:</strong><em>fraction</em>[<strong>:</strong><em>legend</em>]]</p>
  53 <p><strong>SHIFT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>offset</em></p>
  54 <p><strong>TEXTALIGN</strong><strong>:</strong>{<strong>left</strong>|<strong>right</strong>|<strong>justified</strong>|<strong>center</strong>}</p>
  55 <p><strong>PRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em> (deprecated)</p>
  56 <p><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em> (deprecated)</p>
  57 <p><strong>STACK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>] (deprecated)</p>
  58 <p>
  59 </p>
  60 <hr />
  61 <h1><a name="description">DESCRIPTION</a></h1>
  62 <p>These instructions allow you to generate your image or report.
  63 If you don't use any graph elements, no graph is generated.
  64 Similarly, no report is generated if you don't use print options.</p>
  65 <p>
  66 </p>
  67 <hr />
  68 <h1><a name="print">PRINT</a></h1>
  69 <dl>
  70 <dt><strong><a name="item_print_3avname_3aformat_5b_3astrftime_5d"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>format</em>[<strong>:strftime</strong>]</a></strong>
  71
  72 <dd>
  73 <p>Depending on the context, either the value component or the time
  74 component of a <strong>VDEF</strong> is printed using <em>format</em>. It is an error
  75 to specify a <em>vname</em> generated by a <strong>DEF</strong> or <strong>CDEF</strong>.</p>
  76 </dd>
  77 <dd>
  78 <p>Any text in <em>format</em> is printed literally with one exception:
  79 The percent character introduces a formatter string. This string
  80 can be:</p>
  81 </dd>
  82 <dd>
  83 <p>For printing values:</p>
  84 </dd>
  85 <dl>
  86 <dt><strong><a name="item___"><strong>%%</strong></a></strong>
  87
  88 <dd>
  89 <p>just prints a literal '%' character</p>
  90 </dd>
  91 </li>
  92 <dt><strong><a name="item_____le"><strong>%#.#le</strong></a></strong>
  93
  94 <dd>
  95 <p>prints numbers like 1.2346e+04. The optional integers # denote field
  96 width and decimal precision.</p>
  97 </dd>
  98 </li>
  99 <dt><strong><a name="item_____lf"><strong>%#.#lf</strong></a></strong>
 100
 101 <dd>
 102 <p>prints numbers like 12345.6789, with optional field width
 103 and precision.</p>
 104 </dd>
 105 </li>
 106 <dt><strong><a name="item__s"><strong>%s</strong></a></strong>
 107
 108 <dd>
 109 <p>place this after <strong>%le</strong>, <strong>%lf</strong> or <strong>%lg</strong>. This will be replaced by the
 110 appropriate SI magnitude unit and the value will be scaled
 111 accordingly (123456 -&gt; 123.456 k).</p>
 112 </dd>
 113 </li>
 114 <dt><strong><a name="item__s"><strong>%S</strong></a></strong>
 115
 116 <dd>
 117 <p>is similar to <strong>%s</strong>. It does, however, use a previously defined
 118 magnitude unit. If there is no such unit yet, it tries to define
 119 one (just like <strong>%s</strong>) unless the value is zero, in which case the magnitude
 120 unit stays undefined. Thus, formatter strings using <strong>%S</strong> and no <strong>%s</strong>
 121 will all use the same magnitude unit except for zero values.</p>
 122 </dd>
 123 </li>
 124 </dl>
 125 <p>If you PRINT a VDEF value, you can also print the time associated with it by appending the string
 126 <strong>:strftime</strong> to the format. Note that rrdtool uses the strftime function of your OSs clibrary. This means that
 127 the conversion specifier may vary. Check the manual page if you are uncertain. The following is a list of
 128 conversion specifiers usually supported across the board.</p>
 129 <dl>
 130 <dt><strong><a name="item__a"><strong>%a</strong></a></strong>
 131
 132 <dd>
 133 <p>The abbreviated weekday name according to the current locale.</p>
 134 </dd>
 135 </li>
 136 <dt><strong><a name="item__a"><strong>%A</strong></a></strong>
 137
 138 <dd>
 139 <p>The full weekday name according to the current locale.</p>
 140 </dd>
 141 </li>
 142 <dt><strong><a name="item__b"><strong>%b</strong></a></strong>
 143
 144 <dd>
 145 <p>The abbreviated month name according to the current locale.</p>
 146 </dd>
 147 </li>
 148 <dt><strong><a name="item__b"><strong>%B</strong></a></strong>
 149
 150 <dd>
 151 <p>The full month name according to the current locale.</p>
 152 </dd>
 153 </li>
 154 <dt><strong><a name="item__c"><strong>%c</strong></a></strong>
 155
 156 <dd>
 157 <p>The preferred date and time representation for the current locale.</p>
 158 </dd>
 159 </li>
 160 <dt><strong><a name="item__d"><strong>%d</strong></a></strong>
 161
 162 <dd>
 163 <p>The day of the month as a decimal number (range 01 to 31).</p>
 164 </dd>
 165 </li>
 166 <dt><strong><a name="item__h"><strong>%H</strong></a></strong>
 167
 168 <dd>
 169 <p>The hour as a decimal number using a 24-hour clock (range 00 to 23).</p>
 170 </dd>
 171 </li>
 172 <dt><strong><a name="item__i"><strong>%I</strong></a></strong>
 173
 174 <dd>
 175 <p>The hour as a decimal number using a 12-hour clock (range 01 to 12).</p>
 176 </dd>
 177 </li>
 178 <dt><strong><a name="item__j"><strong>%j</strong></a></strong>
 179
 180 <dd>
 181 <p>The day of the year as a decimal number (range 001 to 366).</p>
 182 </dd>
 183 </li>
 184 <dt><strong><a name="item__m"><strong>%m</strong></a></strong>
 185
 186 <dd>
 187 <p>The month as a decimal number (range 01 to 12).</p>
 188 </dd>
 189 </li>
 190 <dt><strong><a name="item__m"><strong>%M</strong></a></strong>
 191
 192 <dd>
 193 <p>The minute as a decimal number (range 00 to 59).</p>
 194 </dd>
 195 </li>
 196 <dt><strong><a name="item__p"><strong>%p</strong></a></strong>
 197
 198 <dd>
 199 <p>Either `AM' or `PM' according to the given time value, or the corresponding
 200 strings for the current locale.  Noon is treated as `pm' and midnight as
 201 `am'.  Note that in many locales and `pm' notation is unsupported and in
 202 such cases %p will return an empty string.</p>
 203 </dd>
 204 </li>
 205 <dt><strong><strong>%S</strong></strong>
 206
 207 <dd>
 208 <p>The second as a decimal number (range 00 to 61).</p>
 209 </dd>
 210 </li>
 211 <dt><strong><a name="item__u"><strong>%U</strong></a></strong>
 212
 213 <dd>
 214 <p>The  week  number  of  the current year as a decimal number, range 00 to 53, starting with the
 215 first Sunday as the first day of week 01. See also %V and %W.</p>
 216 </dd>
 217 </li>
 218 <dt><strong><a name="item__v"><strong>%V</strong></a></strong>
 219
 220 <dd>
 221 <p>The ISO 8601:1988 week number of the current year as a decimal number, range 01 to  53,  where
 222 week  1 is the first week that has at least 4 days in the current year, and with Monday as the
 223 first day of the week. See also %U and %W.</p>
 224 </dd>
 225 </li>
 226 <dt><strong><a name="item__w"><strong>%w</strong></a></strong>
 227
 228 <dd>
 229 <p>The day of the week as a decimal, range 0 to 6, Sunday being 0.  See also %u.</p>
 230 </dd>
 231 </li>
 232 <dt><strong><a name="item__w"><strong>%W</strong></a></strong>
 233
 234 <dd>
 235 <p>The week number of the current year as a decimal number, range 00 to  53,  starting  with  the
 236 first Monday as the first day of week 01.</p>
 237 </dd>
 238 </li>
 239 <dt><strong><a name="item__x"><strong>%x</strong></a></strong>
 240
 241 <dd>
 242 <p>The preferred date representation for the current locale without the time.</p>
 243 </dd>
 244 </li>
 245 <dt><strong><a name="item__x"><strong>%X</strong></a></strong>
 246
 247 <dd>
 248 <p>The preferred time representation for the current locale without the date.</p>
 249 </dd>
 250 </li>
 251 <dt><strong><a name="item__y"><strong>%y</strong></a></strong>
 252
 253 <dd>
 254 <p>The year as a decimal number without a century (range 00 to 99).</p>
 255 </dd>
 256 </li>
 257 <dt><strong><a name="item__y"><strong>%Y</strong></a></strong>
 258
 259 <dd>
 260 <p>The year as a decimal number including the century.</p>
 261 </dd>
 262 </li>
 263 <dt><strong><a name="item__z"><strong>%Z</strong></a></strong>
 264
 265 <dd>
 266 <p>The time zone or name or abbreviation.</p>
 267 </dd>
 268 </li>
 269 <dt><strong><strong>%%</strong></strong>
 270
 271 <dd>
 272 <p>A literal `%' character.</p>
 273 </dd>
 274 </li>
 275 </dl>
 276 <dt><strong><a name="item_print_3avname_3acf_3aformat"><strong>PRINT:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></strong>
 277
 278 <dd>
 279 <p><em>Deprecated. Use the new form of this command in new scripts.</em>
 280 The first form of this command is to be used with <strong>CDEF</strong> <em>vname</em>s.</p>
 281 </dd>
 282 </li>
 283 </dl>
 284 <p>
 285 </p>
 286 <hr />
 287 <h1><a name="graph">GRAPH</a></h1>
 288 <dl>
 289 <dt><strong><a name="item_gprint_3avname_3aformat"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>format</em></a></strong>
 290
 291 <dd>
 292 <p>This is the same as <code>PRINT</code>, but printed inside the graph.</p>
 293 </dd>
 294 </li>
 295 <dt><strong><a name="item_gprint_3avname_3acf_3aformat"><strong>GPRINT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>CF</em><strong>:</strong><em>format</em></a></strong>
 296
 297 <dd>
 298 <p><em>Deprecated. Use the new form of this command in new scripts.</em>
 299 This is the same as <code>PRINT</code>, but printed inside the graph.</p>
 300 </dd>
 301 </li>
 302 <dt><strong><a name="item_comment_3atext"><strong>COMMENT</strong><strong>:</strong><em>text</em></a></strong>
 303
 304 <dd>
 305 <p>Text is printed literally in the legend section of the graph. Note that in
 306 RRDtool 1.2 you have to escape colons in COMMENT text in the same way you
 307 have to escape them in <strong>*PRINT</strong> commands by writing <strong>'\:'</strong>.</p>
 308 </dd>
 309 </li>
 310 <dt><strong><a name="item_vrule_3atime_23color_5b_3alegend_5d_5b_3adashes_5b"><strong>VRULE</strong><strong>:</strong><em>time</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></strong>
 311
 312 <dd>
 313 <p>Draw a vertical line at <em>time</em>.  Its color is composed from three
 314 hexadecimal numbers specifying the rgb color components (00 is off, FF is
 315 maximum) red, green and blue followed by an optional alpha. Optionally, a legend box and string is
 316 printed in the legend section. <em>time</em> may be a number or a variable
 317 from a <strong>VDEF</strong>. It is an error to use <em>vname</em>s from <strong>DEF</strong> or <strong>CDEF</strong> here.
 318 Dashed lines can be drawn using the <strong>dashes</strong> modifier. See <strong>LINE</strong> for more
 319 details.</p>
 320 </dd>
 321 </li>
 322 <dt><strong><a name="item_hrule_3avalue_23color_5b_3alegend_5d_5b_3adashes_5"><strong>HRULE</strong><strong>:</strong><em>value</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></strong>
 323
 324 <dd>
 325 <p>Draw a horizontal line at <em>value</em>.  HRULE acts much like LINE except that
 326 will have no effect on the scale of the graph. If a HRULE is outside the
 327 graphing area it will just not be visible.</p>
 328 </dd>
 329 </li>
 330 <dt><strong><a name="item_line_5bwidth_5d_3avalue_5b_23color_5d_5b_3a_5blege"><strong>LINE</strong>[<em>width</em>]<strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]][<strong>:dashes</strong>[<strong>=</strong><em>on_s</em>[,<em>off_s</em>[,<em>on_s</em>,<em>off_s</em>]...]][<strong>:dash-offset=</strong><em>offset</em>]]</a></strong>
 331
 332 <dd>
 333 <p>Draw a line of the specified width onto the graph. <em>width</em> can be a
 334 floating point number. If the color is not specified, the drawing is done
 335 'invisibly'. This is useful when stacking something else on top of this
 336 line. Also optional is the legend box and string which will be printed in
 337 the legend section if specified. The <strong>value</strong> can be generated by <strong>DEF</strong>,
 338 <strong>VDEF</strong>, and <strong>CDEF</strong>.  If the optional <strong>STACK</strong> modifier is used, this line
 339 is stacked on top of the previous element which can be a <strong>LINE</strong> or an
 340 <strong>AREA</strong>.</p>
 341 </dd>
 342 <dd>
 343 <p>The <strong>dashes</strong> modifier enables dashed line style. Without any further options
 344 a symmetric dashed line with a segment length of 5 pixels will be drawn. The
 345 dash pattern can be changed if the <strong>dashes=</strong> parameter is followed by either
 346 one value or an even number (1, 2, 4, 6, ...) of positive values. Each value
 347 provides the length of alternate <em>on_s</em> and <em>off_s</em> portions of the
 348 stroke. The <strong>dash-offset</strong> parameter specifies an <em>offset</em> into the pattern
 349 at which the stroke begins.</p>
 350 </dd>
 351 <dd>
 352 <p>When you do not specify a color, you cannot specify a legend.  Should
 353 you want to use STACK, use the ``LINEx:&lt;value&gt;::STACK'' form.</p>
 354 </dd>
 355 </li>
 356 <dt><strong><a name="item_area_3avalue_5b_23color_5d_5b_3a_5blegend_5d_5b_3a"><strong>AREA</strong><strong>:</strong><em>value</em>[<strong>#</strong><em>color</em>][<strong>:</strong>[<em>legend</em>][<strong>:STACK</strong>]]</a></strong>
 357
 358 <dd>
 359 <p>See <strong>LINE</strong>, however the area between the x-axis and the line will
 360 be filled.</p>
 361 </dd>
 362 </li>
 363 <dt><strong><a name="item_tick_3avname_23rrggbb_5baa_5d_5b_3afraction_5b_3al"><strong>TICK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>rrggbb</em>[<em>aa</em>][<strong>:</strong><em>fraction</em>[<strong>:</strong><em>legend</em>]]</a></strong>
 364
 365 <dd>
 366 <p>Plot a tick mark (a vertical line) for each value of <em>vname</em> that is
 367 non-zero and not *UNKNOWN*. The <em>fraction</em> argument specifies the length of
 368 the tick mark as a fraction of the y-axis; the default value is 0.1 (10% of
 369 the axis). Note that the color specification is not optional. The TICK marks normaly
 370 start at the lower edge of the graphing area. If the fraction is negative they start
 371 at the upper border of the graphing area.</p>
 372 </dd>
 373 </li>
 374 <dt><strong><a name="item_shift_3avname_3aoffset"><strong>SHIFT</strong><strong>:</strong><em>vname</em><strong>:</strong><em>offset</em></a></strong>
 375
 376 <dd>
 377 <p>Using this command <strong>RRDtool</strong> will graph the following elements
 378 with the specified offset.  For instance, you can specify an
 379 offset of (&nbsp;7*24*60*60&nbsp;=&nbsp;)&nbsp;604'800&nbsp;seconds to ``look back'' one
 380 week. Make sure to tell the viewer of your graph you did this ...
 381 As with the other graphing elements, you can specify a number or
 382 a variable here.</p>
 383 </dd>
 384 </li>
 385 <dt><strong><a name="item_textalign_3a_7bleft_7cright_7cjustified_7ccenter_7"><strong>TEXTALIGN</strong><strong>:</strong>{<strong>left</strong>|<strong>right</strong>|<strong>justified</strong>|<strong>center</strong>}</a></strong>
 386
 387 <dd>
 388 <p>Labels are placed below the graph. When they overflow to the left, they wrap
 389 to the next line. By default, lines are justified left and right. The
 390 <strong>TEXTALIGN</strong> function lets you change this default. This is a command and
 391 not an option, so that you can change the default several times in your
 392 argument list.</p>
 393 </dd>
 394 </li>
 395 <dt><strong><a name="item_stack_3avname_23color_5b_3alegend_5d"><strong>STACK</strong><strong>:</strong><em>vname</em><strong>#</strong><em>color</em>[<strong>:</strong><em>legend</em>]</a></strong>
 396
 397 <dd>
 398 <p><em>Deprecated.  Use the <strong>STACK</strong> modifiers on the other commands.</em></p>
 399 </dd>
 400 </li>
 401 </dl>
 402 <p><strong>Some notes on stacking</strong></p>
 403 <p>When stacking, an element is not placed above the X-axis but rather
 404 on top of the previous element.  There must be something to stack
 405 upon.</p>
 406 <p>You can use an <strong>invisible</strong> LINE or AREA to stacked upon.</p>
 407 <p>An <strong>unknown</strong> value makes the entire stack unknown from that moment on.
 408 You don't know where to begin (the unknown value) and therefore do
 409 not know where to end.</p>
 410 <p>If you want to make sure you will be displaying a certain variable,
 411 make sure never to stack upon the unknown value.  Use a CDEF instruction
 412 with <strong>IF</strong> and <strong>UN</strong> to do so.</p>
 413 <p>
 414 </p>
 415 <hr />
 416 <h1><a name="notes_on_legend_arguments">NOTES on legend arguments</a></h1>
 417 <p>
 418 </p>
 419 <h2><a name="escaping_the_colon">Escaping the colon</a></h2>
 420 <p>A colon ':' in a <em>legend</em> argument will mark the end of the
 421 legend. To enter a ':' as part of a legend, the colon must be escaped
 422 with a backslash '\:'.  Beware that many environments process
 423 backslashes themselves, so it may be necessary to write two
 424 backslashes in order to one being passed onto rrd_graph.</p>
 425 <p>
 426 </p>
 427 <h2><a name="string_formatting">String Formatting</a></h2>
 428 <p>The text printed below the actual graph can be formatted by appending special
 429 escape characters at the end of a text. When ever such a character occurs,
 430 all pending text is pushed onto the graph according to the character
 431 specified.</p>
 432 <p>Valid markers are: <strong>\j</strong> for justified, <strong>\l</strong> for left aligned, <strong>\r</strong> for
 433 right aligned, and <strong>\c</strong> for centered. In the next section there is an
 434 example showing how to use centered formatting.</p>
 435 <p><strong>\n</strong> is a valid alias for <strong>\l</strong> since incomplete parsing in earlier
 436 versions of rrdtool lead to this behaviour and a number of people has been using it.</p>
 437 <p>Normally there are two space characters inserted between every two items
 438 printed into the graph. The space following a string can be suppressed by
 439 putting a <strong>\g</strong> at the end of the string. The <strong>\g</strong> also ignores any space
 440 inside the string if it is at the very end of the string. This can be used
 441 in connection with <strong>%s</strong> to suppress empty unit strings.</p>
 442 <pre>
 443  GPRINT:a:MAX:%lf%s\g</pre>
 444 <p>A special case is COMMENT:<strong>\s</strong> which inserts some additional vertical space
 445 before placing the next row of legends.</p>
 446 <p>If you are using the proportional font in your graph, you can use tab
 447 characters or the sequence <strong>\t</strong> to line-up legend elements. Note that
 448 the tabs inserted are relative to the start of the current legend
 449 element!</p>
 450 <p>Since RRDtool 1.3 is using Pango for rending text, you can use Pango markup.
 451 Pango uses the xml <strong>span</strong> tags for inline formatting instructions.:</p>
 452 <p>A simple example of a marked-up string might be:</p>
 453 <pre>
 454  &lt;span foreground=&quot;blue&quot; size=&quot;x-large&quot;&gt;Blue text&lt;/span&gt; is &lt;i&gt;cool&lt;/i&gt;!</pre>
 455 <p>The complete list of attributes for the span tag (taken from the pango documentation):</p>
 456 <dl>
 457 <dt><strong><a name="item_font_desc"><strong>font_desc</strong></a></strong>
 458
 459 <dd>
 460 <p>A font description string, such as ``Sans Italic 12''; note that any other span attributes will override this description. So if you have ``Sans Italic'' and also a style=``normal'' attribute, you will get Sans normal, not italic.</p>
 461 </dd>
 462 </li>
 463 <dt><strong><a name="item_font_family"><strong>font_family</strong></a></strong>
 464
 465 <dd>
 466 <p>A font family name</p>
 467 </dd>
 468 </li>
 469 <dt><strong><a name="item_face"><strong>face</strong></a></strong>
 470
 471 <dd>
 472 <p>Synonym for font_family</p>
 473 </dd>
 474 </li>
 475 <dt><strong><a name="item_size"><strong>size</strong></a></strong>
 476
 477 <dd>
 478 <p>Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If you want to specify a absolute size, it's usually easier to take advantage of the ability to specify a partial font description using 'font_desc'; you can use font_desc='12.5' rather than size='12800'.</p>
 479 </dd>
 480 </li>
 481 <dt><strong><a name="item_style"><strong>style</strong></a></strong>
 482
 483 <dd>
 484 <p>One of 'normal', 'oblique', 'italic'</p>
 485 </dd>
 486 </li>
 487 <dt><strong><a name="item_weight"><strong>weight</strong></a></strong>
 488
 489 <dd>
 490 <p>One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight</p>
 491 </dd>
 492 </li>
 493 <dt><strong><a name="item_variant"><strong>variant</strong></a></strong>
 494
 495 <dd>
 496 <p>'normal' or 'smallcaps'</p>
 497 </dd>
 498 </li>
 499 <dt><strong><a name="item_stretch"><strong>stretch</strong></a></strong>
 500
 501 <dd>
 502 <p>One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'</p>
 503 </dd>
 504 </li>
 505 <dt><strong><a name="item_foreground"><strong>foreground</strong></a></strong>
 506
 507 <dd>
 508 <p>An RGB color specification such as '#00FF00' or a color name such as 'red'</p>
 509 </dd>
 510 </li>
 511 <dt><strong><a name="item_background"><strong>background</strong></a></strong>
 512
 513 <dd>
 514 <p>An RGB color specification such as '#00FF00' or a color name such as 'red'</p>
 515 </dd>
 516 </li>
 517 <dt><strong><a name="item_underline"><strong>underline</strong></a></strong>
 518
 519 <dd>
 520 <p>One of 'none', 'single', 'double', 'low', 'error'</p>
 521 </dd>
 522 </li>
 523 <dt><strong><a name="item_underline_color"><strong>underline_color</strong></a></strong>
 524
 525 <dd>
 526 <p>The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'</p>
 527 </dd>
 528 </li>
 529 <dt><strong><a name="item_rise"><strong>rise</strong></a></strong>
 530
 531 <dd>
 532 <p>Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.</p>
 533 </dd>
 534 </li>
 535 <dt><strong><a name="item_strikethrough"><strong>strikethrough</strong></a></strong>
 536
 537 <dd>
 538 <p>'true' or 'false' whether to strike through the text</p>
 539 </dd>
 540 </li>
 541 <dt><strong><a name="item_strikethrough_color"><strong>strikethrough_color</strong></a></strong>
 542
 543 <dd>
 544 <p>The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'</p>
 545 </dd>
 546 </li>
 547 <dt><strong><a name="item_fallback"><strong>fallback</strong></a></strong>
 548
 549 <dd>
 550 <p>'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.</p>
 551 </dd>
 552 </li>
 553 <dt><strong><a name="item_lang"><strong>lang</strong></a></strong>
 554
 555 <dd>
 556 <p>A language code, indicating the text language</p>
 557 </dd>
 558 </li>
 559 <dt><strong><a name="item_letter_spacing"><strong>letter_spacing</strong></a></strong>
 560
 561 <dd>
 562 <p>Inter-letter spacing in 1024ths of a point.</p>
 563 </dd>
 564 </li>
 565 <dt><strong><a name="item_gravity"><strong>gravity</strong></a></strong>
 566
 567 <dd>
 568 <p>One of 'south', 'east', 'north', 'west', 'auto'.</p>
 569 </dd>
 570 </li>
 571 <dt><strong><a name="item_gravity_hint"><strong>gravity_hint</strong></a></strong>
 572
 573 <dd>
 574 <p>One of 'natural', 'strong', 'line'.</p>
 575 </dd>
 576 </li>
 577 </dl>
 578 <p>To save you some typing, there are also some shortcuts:</p>
 579 <dl>
 580 <dt><strong><a name="item_b"><strong>b</strong></a></strong>
 581
 582 <dd>
 583 <p>Bold</p>
 584 </dd>
 585 </li>
 586 <dt><strong><a name="item_big"><strong>big</strong></a></strong>
 587
 588 <dd>
 589 <p>Makes font relatively larger, equivalent to &lt;span size=``larger''&gt;</p>
 590 </dd>
 591 </li>
 592 <dt><strong><a name="item_i"><strong>i</strong></a></strong>
 593
 594 <dd>
 595 <p>Italic</p>
 596 </dd>
 597 </li>
 598 <dt><strong><a name="item_s"><strong>s</strong></a></strong>
 599
 600 <dd>
 601 <p>Strikethrough</p>
 602 </dd>
 603 </li>
 604 <dt><strong><a name="item_sub"><strong>sub</strong></a></strong>
 605
 606 <dd>
 607 <p>Subscript</p>
 608 </dd>
 609 </li>
 610 <dt><strong><a name="item_sup"><strong>sup</strong></a></strong>
 611
 612 <dd>
 613 <p>Superscript</p>
 614 </dd>
 615 </li>
 616 <dt><strong><a name="item_small"><strong>small</strong></a></strong>
 617
 618 <dd>
 619 <p>Makes font relatively smaller, equivalent to &lt;span size=``smaller''&gt;</p>
 620 </dd>
 621 </li>
 622 <dt><strong><a name="item_tt"><strong>tt</strong></a></strong>
 623
 624 <dd>
 625 <p>Monospace font</p>
 626 </dd>
 627 </li>
 628 <dt><strong><a name="item_u"><strong>u</strong></a></strong>
 629
 630 <dd>
 631 <p>Underline</p>
 632 </dd>
 633 </li>
 634 </dl>
 635 <p>
 636 </p>
 637 <hr />
 638 <h1><a name="see_also">SEE ALSO</a></h1>
 639 <p><a href="././rrdgraph.html">the rrdgraph manpage</a> gives an overview of how <strong>rrdtool graph</strong> works.
 640 <a href="././rrdgraph_data.html">the rrdgraph_data manpage</a> describes <strong>DEF</strong>,<strong>CDEF</strong> and <strong>VDEF</strong> in detail.
 641 <a href="././rrdgraph_rpn.html">the rrdgraph_rpn manpage</a> describes the <strong>RPN</strong> language used in the <strong>?DEF</strong> statements.
 642 <a href="././rrdgraph_graph.html">the rrdgraph_graph manpage</a> page describes all of the graph and print functions.</p>
 643 <p>Make sure to read <a href="././rrdgraph_examples.html">the rrdgraph_examples manpage</a> for tips&amp;tricks.</p>
 644 <p>
 645 </p>
 646 <hr />
 647 <h1><a name="author">AUTHOR</a></h1>
 648 <p>Program by Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 649 <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>
 650
 651 </body>
 652
 653 </html>