1 RRDGRAPH_GRAPH(1) rrdtool RRDGRAPH_GRAPH(1)
6 rrdgraph_graph - rrdtool graph command reference
16 _\be_\bn_\bd][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\bs_\be_\bt]]
19 _\be_\bn_\bd][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\bs_\be_\bt]]
21 L\bLI\bIN\bNE\bE[_\bw_\bi_\bd_\bt_\bh]:\b:_\bv_\ba_\bl_\bu_\be[#\b#_\bc_\bo_\bl_\bo_\br][:\b:[_\bl_\be_\bg_\b-
22 _\be_\bn_\bd][:\b:S\bST\bTA\bAC\bCK\bK]][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\b-
25 A\bAR\bRE\bEA\bA:\b:_\bv_\ba_\bl_\bu_\be[#\b#_\bc_\bo_\bl_\bo_\br][:\b:[_\bl_\be_\bg_\be_\bn_\bd][:\b:S\bST\bTA\bAC\bCK\bK]]
27 T\bTI\bIC\bCK\bK:\b:_\bv_\bn_\ba_\bm_\be#\b#_\br_\br_\bg_\bg_\bb_\bb[_\ba_\ba][:\b:_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn[:\b:_\bl_\be_\bg_\be_\bn_\bd]]
31 T\bTE\bEX\bXT\bTA\bAL\bLI\bIG\bGN\bN:\b:{l\ble\bef\bft\bt|r\bri\big\bgh\bht\bt|j\bju\bus\bst\bti\bif\bfi\bie\bed\bd|c\bce\ben\bnt\bte\ber\br}
33 P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
35 G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
37 S\bST\bTA\bAC\bCK\bK:\b:_\bv_\bn_\ba_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\be_\bn_\bd] (deprecated)
40 These instructions allow you to generate your image or report. If you
41 don't use any graph elements, no graph is generated. Similarly, no
42 report is generated if you don't use print options.
45 P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bf_\bo_\br_\bm_\ba_\bt[:\b:s\bst\btr\brf\bft\bti\bim\bme\be]
46 Depending on the context, either the value component or the time
51 percent character introduces a formatter string. This string can
52 be:
54 For printing values:
59 prints numbers like 1.2346e+04. The optional integers # denote
60 field width and decimal precision.
63 prints numbers like 12345.6789, with optional field width and
64 precision.
66 %\b%s\bs place this after %\b%l\ble\be, %\b%l\blf\bf or %\b%l\blg\bg. This will be replaced by the
67 appropriate SI magnitude unit and the value will be scaled
68 accordingly (123456 -> 123.456 k).
71 magnitude unit. If there is no such unit yet, it tries to
73 case the magnitude unit stays undefined. Thus, formatter
75 except for zero values.
77 If you PRINT a VDEF value, you can also print the time associated
79 rrdtool uses the strftime function of your OSs clibrary. This means
80 that the conversion specifier may vary. Check the manual page if
81 you are uncertain. The following is a list of conversion specifiers
82 usually supported across the board.
93 locale.
98 23).
101 12).
110 corresponding strings for the current locale. Noon is treated
111 as `pm' and midnight as `am'. Note that in many locales and
112 `pm' notation is unsupported and in such cases %p will return
113 an empty string.
118 range 00 to 53, starting with the first Sunday as the first day
119 of week 01. See also %V and %W.
122 number, range 01 to 53, where week 1 is the first week that
123 has at least 4 days in the current year, and with Monday as the
124 first day of the week. See also %U and %W.
127 See also %u.
130 00 to 53, starting with the first Monday as the first day
131 of week 01.
134 out the time.
137 out the date.
140 99).
149 _\bD_\be_\bp_\br_\be_\bc_\ba_\bt_\be_\bd_\b. _\bU_\bs_\be _\bt_\bh_\be _\bn_\be_\bw _\bf_\bo_\br_\bm _\bo_\bf _\bt_\bh_\bi_\bs _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bi_\bn _\bn_\be_\bw _\bs_\bc_\br_\bi_\bp_\bt_\bs_\b. The
154 This is the same as "PRINT", but printed inside the graph.
157 _\bD_\be_\bp_\br_\be_\bc_\ba_\bt_\be_\bd_\b. _\bU_\bs_\be _\bt_\bh_\be _\bn_\be_\bw _\bf_\bo_\br_\bm _\bo_\bf _\bt_\bh_\bi_\bs _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bi_\bn _\bn_\be_\bw _\bs_\bc_\br_\bi_\bp_\bt_\bs_\b. This
158 is the same as "PRINT", but printed inside the graph.
161 Text is printed literally in the legend section of the graph. Note
162 that in RRDtool 1.2 you have to escape colons in COMMENT text in
167 _\be_\bn_\bd][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\bs_\be_\bt]]
169 hexadecimal numbers specifying the rgb color components (00 is off,
170 FF is maximum) red, green and blue followed by an optional alpha.
171 Optionally, a legend box and string is printed in the legend sec-
173 error to use _\bv_\bn_\ba_\bm_\bes from D\bDE\bEF\bF or C\bCD\bDE\bEF\bF here. Dashed lines can be
177 _\be_\bn_\bd][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\bs_\be_\bt]]
179 that will have no effect on the scale of the graph. If a HRULE is
180 outside the graphing area it will just not be visible.
182 L\bLI\bIN\bNE\bE[_\bw_\bi_\bd_\bt_\bh]:\b:_\bv_\ba_\bl_\bu_\be[#\b#_\bc_\bo_\bl_\bo_\br][:\b:[_\bl_\be_\bg_\b-
183 _\be_\bn_\bd][:\b:S\bST\bTA\bAC\bCK\bK]][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\b-
186 floating point number. If the color is not specified, the drawing
187 is done 'invisibly'. This is useful when stacking something else on
188 top of this line. Also optional is the legend box and string which
190 be generated by D\bDE\bEF\bF, V\bVD\bDE\bEF\bF, and C\bCD\bDE\bEF\bF. If the optional S\bST\bTA\bAC\bCK\bK modi-
191 fier is used, this line is stacked on top of the previous element
195 options a symmetric dashed line with a segment length of 5 pixels
197 parameter is followed by either one value or an even number (1, 2,
198 4, 6, ...) of positive values. Each value provides the length of
199 alternate _\bo_\bn_\b__\bs and _\bo_\bf_\bf_\b__\bs portions of the stroke. The d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt
201 begins.
203 When you do not specify a color, you cannot specify a legend.
204 Should you want to use STACK, use the "LINEx:<value>::STACK" form.
206 A\bAR\bRE\bEA\bA:\b:_\bv_\ba_\bl_\bu_\be[#\b#_\bc_\bo_\bl_\bo_\br][:\b:[_\bl_\be_\bg_\be_\bn_\bd][:\b:S\bST\bTA\bAC\bCK\bK]]
208 filled.
210 T\bTI\bIC\bCK\bK:\b:_\bv_\bn_\ba_\bm_\be#\b#_\br_\br_\bg_\bg_\bb_\bb[_\ba_\ba][:\b:_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn[:\b:_\bl_\be_\bg_\be_\bn_\bd]]
213 length of the tick mark as a fraction of the y-axis; the default
214 value is 0.1 (10% of the axis). Note that the color specification
215 is not optional. The TICK marks normaly start at the lower edge of
216 the graphing area. If the fraction is negative they start at the
217 upper border of the graphing area.
221 the specified offset. For instance, you can specify an offset of
222 ( 7*24*60*60 = ) 604'800 seconds to "look back" one week. Make sure
223 to tell the viewer of your graph you did this ... As with the
224 other graphing elements, you can specify a number or a variable
225 here.
227 T\bTE\bEX\bXT\bTA\bAL\bLI\bIG\bGN\bN:\b:{l\ble\bef\bft\bt|r\bri\big\bgh\bht\bt|j\bju\bus\bst\bti\bif\bfi\bie\bed\bd|c\bce\ben\bnt\bte\ber\br}
228 Labels are placed below the graph. When they overflow to the left,
229 they wrap to the next line. By default, lines are justified left
231 This is a command and not an option, so that you can change the
232 default several times in your argument list.
234 S\bST\bTA\bAC\bCK\bK:\b:_\bv_\bn_\ba_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\be_\bn_\bd]
235 _\bD_\be_\bp_\br_\be_\bc_\ba_\bt_\be_\bd_\b. _\bU_\bs_\be _\bt_\bh_\be _\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK _\bm_\bo_\bd_\bi_\bf_\bi_\be_\br_\bs _\bo_\bn _\bt_\bh_\be _\bo_\bt_\bh_\be_\br _\bc_\bo_\bm_\bm_\ba_\bn_\bd_\bs_\b.
239 When stacking, an element is not placed above the X-axis but rather on
240 top of the previous element. There must be something to stack upon.
245 You don't know where to begin (the unknown value) and therefore do not
246 know where to end.
248 If you want to make sure you will be displaying a certain variable,
249 make sure never to stack upon the unknown value. Use a CDEF instruc-
256 enter a ':' as part of a legend, the colon must be escaped with a back-
257 slash '\:'. Beware that many environments process backslashes them-
258 selves, so it may be necessary to write two backslashes in order to one
259 being passed onto rrd_graph.
263 The text printed below the actual graph can be formatted by appending
264 special escape characters at the end of a text. When ever such a char-
265 acter occurs, all pending text is pushed onto the graph according to
266 the character specified.
270 showing how to use centered formatting.
273 of rrdtool lead to this behaviour and a number of people has been using
274 it.
276 Normally there are two space characters inserted between every two
277 items printed into the graph. The space following a string can be sup-
279 any space inside the string if it is at the very end of the string.
282 GPRINT:a:MAX:%lf%s\g
285 space before placing the next row of legends.
287 If you are using the proportional font in your graph, you can use tab
289 tabs inserted are relative to the start of the current legend element!
291 Since RRDtool 1.3 is using Pango for rending text, you can use Pango
293 tions.:
295 A simple example of a marked-up string might be:
297 <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
299 The complete list of attributes for the span tag (taken from the pango
300 documentation):
303 A font description string, such as "Sans Italic 12"; note that any
304 other span attributes will override this description. So if you
305 have "Sans Italic" and also a style="normal" attribute, you will
306 get Sans normal, not italic.
309 A font family name
312 Synonym for font_family
315 Font size in 1024ths of a point, or one of the absolute sizes
316 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large',
317 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If
318 you want to specify a absolute size, it's usually easier to take
319 advantage of the ability to specify a partial font description
320 using 'font_desc'; you can use font_desc='12.5' rather than
321 size='12800'.
324 One of 'normal', 'oblique', 'italic'
327 One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold',
328 'heavy', or a numeric weight
331 'normal' or 'smallcaps'
334 One of 'ultracondensed', 'extracondensed', 'condensed', 'semicon-
335 densed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded',
336 'ultraexpanded'
339 An RGB color specification such as '#00FF00' or a color name such
340 as 'red'
343 An RGB color specification such as '#00FF00' or a color name such
344 as 'red'
347 One of 'none', 'single', 'double', 'low', 'error'
350 The color of underlines; an RGB color specification such as
351 '#00FF00' or a color name such as 'red'
354 Vertical displacement, in 10000ths of an em. Can be negative for
355 subscript, positive for superscript.
358 'true' or 'false' whether to strike through the text
361 The color of strikethrough lines; an RGB color specification such
362 as '#00FF00' or a color name such as 'red'
365 'true' or 'false' whether to enable fallback. If disabled, then
366 characters will only be used from the closest matching font on the
367 system. No fallback will be done to other fonts on the system that
368 might contain the characters in the text. Fallback is enabled by
369 default. Most applications should not disable fallback.
372 A language code, indicating the text language
375 Inter-letter spacing in 1024ths of a point.
378 One of 'south', 'east', 'north', 'west', 'auto'.
381 One of 'natural', 'strong', 'line'.
383 To save you some typing, there are also some shortcuts:
385 b\bb Bold
389 i\bi Italic
391 s\bs Strikethrough
398 Makes font relatively smaller, equivalent to <span size="smaller">
402 u\bu Underline
405 rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
406 describes D\bDE\bEF\bF,C\bCD\bDE\bEF\bF and V\bVD\bDE\bEF\bF in detail. rrdgraph_rpn describes the R\bRP\bPN\bN
408 all of the graph and print functions.
410 Make sure to read rrdgraph_examples for tips&tricks.
413 Program by Tobias Oetiker <tobi@oetiker.ch>
415 This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
419 1.3rc4 2008-03-15 RRDGRAPH_GRAPH(1)