1 RRDGRAPH_GRAPH(1) rrdtool RRDGRAPH_GRAPH(1)
6 rrdgraph_graph - rrdtool graph command reference
15 V\bVR\bRU\bUL\bLE\bE:\b:_\bt_\bi_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\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]]
17 H\bHR\bRU\bUL\bLE\bE:\b:_\bv_\ba_\bl_\bu_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\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 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_\be_\bn_\bd][:\b:S\bST\bTA\bAC\bCK\bK][:\b:s\bsk\bki\bip\bps\bsc\bca\bal\ble\be][:\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 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][:\b:s\bsk\bki\bip\bps\bsc\bca\bal\ble\be]]
23 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]]
27 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}
29 P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
31 G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
33 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)
36 These instructions allow you to generate your image or report. If you
37 don't use any graph elements, no graph is generated. Similarly, no
38 report is generated if you don't use print options.
41 _\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt_\b[_\b:\b:_\bs\bs_\bt\bt_\br\br_\bf\bf_\bt\bt_\bi\bi_\bm\bm_\be\be_\b]
43 Depending on the context, either the value component or the time
44 component of a V\bVD\bDE\bEF\bF is printed using _\bf_\bo_\br_\bm_\ba_\bt. It is an error to specify
48 character introduces a formatter string. This string can be:
50 For printing values:
55 prints numbers like 1.2346e+04. The optional integers # denote
56 field width and decimal precision.
59 prints numbers like 12345.6789, with optional field width and
60 precision.
62 %\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
63 appropriate SI magnitude unit and the value will be scaled
64 accordingly (123456 -> 123.456 k).
67 magnitude unit. If there is no such unit yet, it tries to define
71 values.
73 If you PRINT a VDEF value, you can also print the time associated with
75 uses the strftime function of your OSs C library. This means that the
76 conversion specifier may vary. Check the manual page if you are
77 uncertain. The following is a list of conversion specifiers usually
78 supported across the board.
93 23).
96 12).
105 corresponding strings for the current locale. Noon is treated as
106 `pm' and midnight as `am'. Note that in many locales and `pm'
107 notation is unsupported and in such cases %p will return an empty
108 string.
113 standard!)
116 00 to 53, starting with the first Sunday as the first day of week
117 01. See also %V and %W.
120 number, range 01 to 53, where week 1 is the first week that has
121 at least 4 days in the current year, and with Monday as the first
122 day of the week. See also %U and %W.
125 See also %u.
128 to 53, starting with the first Monday as the first day of week
129 01.
132 the time.
135 the date.
145 _\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bC_\bF_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt
147 _\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 first
151 _\bG\bG_\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt
153 This is the same as "PRINT", but printed inside the graph.
155 _\bG\bG_\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bC_\bF_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt
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 is
158 the same as "PRINT", but printed inside the graph.
162 Text is printed literally in the legend section of the graph. Note that
163 in RRDtool 1.2 you have to escape colons in COMMENT text in the same
166 _\bV\bV_\bR\bR_\bU\bU_\bL\bL_\bE\bE_\b:\b:_\bt_\bi_\bm_\be_\b#\b#_\bc_\bo_\bl_\bo_\br_\b[_\b:\b:_\bl_\be_\bg_\be_\bn_\bd_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\be\be_\bs\bs_\b[_\b=\b=_\bo_\bn_\b__\bs_\b[_\b,_\bo_\bf_\bf_\b__\bs_\b[_\b,_\bo_\bn_\b__\bs_\b,_\bo_\bf_\bf_\b__\bs_\b]_\b._\b._\b._\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\b-\b-_\bo\bo_\bf\bf_\bf\bf_\bs\bs_\be\be_\bt\bt_\b=\b=_\bo_\bf_\bf_\bs_\be_\bt_\b]_\b]
169 hexadecimal numbers specifying the rgb color components (00 is off, FF
170 is maximum) red, green and blue followed by an optional alpha.
171 Optionally, a legend box and string is printed in the legend section.
173 _\bv_\bn_\ba_\bm_\bes from D\bDE\bEF\bF or C\bCD\bDE\bEF\bF here. Dashed lines can be drawn using the
176 _\bH\bH_\bR\bR_\bU\bU_\bL\bL_\bE\bE_\b:\b:_\bv_\ba_\bl_\bu_\be_\b#\b#_\bc_\bo_\bl_\bo_\br_\b[_\b:\b:_\bl_\be_\bg_\be_\bn_\bd_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\be\be_\bs\bs_\b[_\b=\b=_\bo_\bn_\b__\bs_\b[_\b,_\bo_\bf_\bf_\b__\bs_\b[_\b,_\bo_\bn_\b__\bs_\b,_\bo_\bf_\bf_\b__\bs_\b]_\b._\b._\b._\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\b-\b-_\bo\bo_\bf\bf_\bf\bf_\bs\bs_\be\be_\bt\bt_\b=\b=_\bo_\bf_\bf_\bs_\be_\bt_\b]_\b]
179 will have no effect on the scale of the graph. If a HRULE is outside
180 the graphing area it will just not be visible.
182 _\bL\bL_\bI\bI_\bN\bN_\bE\bE_\b[_\bw_\bi_\bd_\bt_\bh_\b]_\b:\b:_\bv_\ba_\bl_\bu_\be_\b[_\b#\b#_\bc_\bo_\bl_\bo_\br_\b]_\b[_\b:\b:_\b[_\bl_\be_\bg_\be_\bn_\bd_\b]_\b[_\b:\b:_\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK_\b]_\b[_\b:\b:_\bs\bs_\bk\bk_\bi\bi_\bp\bp_\bs\bs_\bc\bc_\ba\ba_\bl\bl_\be\be_\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\be\be_\bs\bs_\b[_\b=\b=_\bo_\bn_\b__\bs_\b[_\b,_\bo_\bf_\bf_\b__\bs_\b[_\b,_\bo_\bn_\b__\bs_\b,_\bo_\bf_\bf_\b__\bs_\b]_\b._\b._\b._\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\b-\b-_\bo\bo_\bf\bf_\bf\bf_\bs\bs_\be\be_\bt\bt_\b=\b=_\bo_\bf_\bf_\bs_\be_\bt_\b]_\b]
185 floating point number. If the color is not specified, the drawing is
186 done 'invisibly'. This is useful when stacking something else on top of
187 this line. Also optional is the legend box and string which will be
189 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 modifier is used, this
194 is visible in the chart. The scaling of the chart will be modified
199 options a symmetric dashed line with a segment length of 5 pixels will
201 followed by either one value or an even number (1, 2, 4, 6, ...) of
203 _\bo_\bf_\bf_\b__\bs portions of the stroke. The d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt parameter specifies an
206 When you do not specify a color, you cannot specify a legend. Should
209 _\bA\bA_\bR\bR_\bE\bE_\bA\bA_\b:\b:_\bv_\ba_\bl_\bu_\be_\b[_\b#\b#_\bc_\bo_\bl_\bo_\br_\b]_\b[_\b:\b:_\b[_\bl_\be_\bg_\be_\bn_\bd_\b]_\b[_\b:\b:_\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK_\b]_\b[_\b:\b:_\bs\bs_\bk\bk_\bi\bi_\bp\bp_\bs\bs_\bc\bc_\ba\ba_\bl\bl_\be\be_\b]_\b]
212 filled.
214 _\bT\bT_\bI\bI_\bC\bC_\bK\bK_\b:\b:_\bv_\bn_\ba_\bm_\be_\b#\b#_\br_\br_\bg_\bg_\bb_\bb_\b[_\ba_\ba_\b]_\b[_\b:\b:_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b[_\b:\b:_\bl_\be_\bg_\be_\bn_\bd_\b]_\b]
218 the tick mark as a fraction of the y-axis; the default value is 0.1
219 (10% of the axis). Note that the color specification is not optional.
220 The TICK marks normally start at the lower edge of the graphing area.
221 If the fraction is negative they start at the upper border of the
222 graphing area.
227 specified offset. For instance, you can specify an offset of
228 ( 7*24*60*60 = ) 604'800 seconds to "look back" one week. Make sure to
229 tell the viewer of your graph you did this ... As with the other
230 graphing elements, you can specify a number or a variable here.
232 _\bT\bT_\bE\bE_\bX\bX_\bT\bT_\bA\bA_\bL\bL_\bI\bI_\bG\bG_\bN\bN_\b:\b:_\b{_\bl\bl_\be\be_\bf\bf_\bt\bt_\b|_\br\br_\bi\bi_\bg\bg_\bh\bh_\bt\bt_\b|_\bj\bj_\bu\bu_\bs\bs_\bt\bt_\bi\bi_\bf\bf_\bi\bi_\be\be_\bd\bd_\b|_\bc\bc_\be\be_\bn\bn_\bt\bt_\be\be_\br\br_\b}
234 Labels are placed below the graph. When they overflow to the left, they
235 wrap to the next line. By default, lines are justified left and right.
236 The T\bTE\bEX\bXT\bTA\bAL\bLI\bIG\bGN\bN function lets you change this default. This is a command
237 and not an option, so that you can change the default several times in
238 your argument list.
240 _\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK_\b:\b:_\bv_\bn_\ba_\bm_\be_\b#\b#_\bc_\bo_\bl_\bo_\br_\b[_\b:\b:_\bl_\be_\bg_\be_\bn_\bd_\b]
242 _\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 _\bi_\bn_\bs_\bt_\be_\ba_\bd_\b!
246 When stacking, an element is not placed above the X-axis but rather on
247 top of the previous element. There must be something to stack upon.
252 You don't know where to begin (the unknown value) and therefore do not
253 know where to end.
255 If you want to make sure you will be displaying a certain variable,
256 make sure never to stack upon the unknown value. Use a CDEF
262 enter a ':' as part of a legend, the colon must be escaped with a
263 backslash '\:'. Beware that many environments process backslashes
264 themselves, so it may be necessary to write two backslashes in order to
265 one being passed onto rrd_graph.
268 The text printed below the actual graph can be formatted by appending
269 special escape characters at the end of a text. When ever such a
270 character occurs, all pending text is pushed onto the graph according
271 to the character specified.
275 showing how to use centered formatting.
278 of RRDtool lead to this behavior and a number of people has been using
279 it.
281 Normally there are two space characters inserted between every two
282 items printed into the graph. The space following a string can be
284 ignores any space inside the string if it is at the very end of the
286 strings.
288 GPRINT:a:MAX:%lf%s\g
291 space before placing the next row of legends.
293 If you want to have left and right aligned legends on the same line use
296 COMMENT:left\l
297 COMMENT:\u
298 COMMENT:right\r
300 There is also a 'nop' control for situations where you want a string to
303 COMMENT:OS\2\.
305 When using a proportional font in your graph, the tab characters or the
307 are relative to the start of the current legend element!
309 Since RRDtool 1.3 is using Pango for rending text, you can use Pango
311 instructions.:
313 A simple example of a marked-up string might be:
315 <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
317 The complete list of attributes for the span tag (taken from the pango
318 documentation):
321 A font description string, such as "Sans Italic 12"; note that any
322 other span attributes will override this description. So if you
323 have "Sans Italic" and also a style="normal" attribute, you will
324 get Sans normal, not italic.
327 A font family name
330 Synonym for font_family
333 Font size in 1024ths of a point, or one of the absolute sizes
334 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large',
335 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If
336 you want to specify a absolute size, it's usually easier to take
337 advantage of the ability to specify a partial font description
338 using 'font_desc'; you can use font_desc='12.5' rather than
339 size='12800'.
342 One of 'normal', 'oblique', 'italic'
345 One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold',
346 'heavy', or a numeric weight
349 'normal' or 'smallcaps'
352 One of 'ultracondensed', 'extracondensed', 'condensed',
353 'semicondensed', 'normal', 'semiexpanded', 'expanded',
354 'extraexpanded', 'ultraexpanded'
357 An RGB color specification such as '#00FF00' or a color name such
358 as 'red'
361 An RGB color specification such as '#00FF00' or a color name such
362 as 'red'
365 One of 'none', 'single', 'double', 'low', 'error'
368 The color of underlines; an RGB color specification such as
369 '#00FF00' or a color name such as 'red'
372 Vertical displacement, in 10000ths of an em. Can be negative for
373 subscript, positive for superscript.
376 'true' or 'false' whether to strike through the text
379 The color of crossed out lines; an RGB color specification such as
380 '#00FF00' or a color name such as 'red'
383 'true' or 'false' whether to enable fallback. If disabled, then
384 characters will only be used from the closest matching font on the
385 system. No fallback will be done to other fonts on the system that
386 might contain the characters in the text. Fallback is enabled by
387 default. Most applications should not disable fallback.
390 A language code, indicating the text language
393 Inter-letter spacing in 1024ths of a point.
396 One of 'south', 'east', 'north', 'west', 'auto'.
399 One of 'natural', 'strong', 'line'.
401 To save you some typing, there are also some shortcuts:
403 b\bb Bold
407 i\bi Italic
409 s\bs Strike through
416 Makes font relatively smaller, equivalent to <span size="smaller">
420 u\bu Underline
423 rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
424 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
426 all of the graph and print functions.
428 Make sure to read rrdgraph_examples for tips&tricks.
431 Program by Tobias Oetiker <tobi@oetiker.ch>
433 This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl> with
434 corrections and/or additions by several people
438 1.4.8 2013-05-23 RRDGRAPH_GRAPH(1)