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.
46 _\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]
48 Depending on the context, either the value component or the time compo-
49 nent of a V\bVD\bDE\bEF\bF is printed using _\bf_\bo_\br_\bm_\ba_\bt. It is an error to specify a
53 character introduces a formatter string. This string can be:
55 For printing values:
60 prints numbers like 1.2346e+04. The optional integers # denote
61 field width and decimal precision.
64 prints numbers like 12345.6789, with optional field width and pre-
65 cision.
67 %\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
68 appropriate SI magnitude unit and the value will be scaled accord-
69 ingly (123456 -> 123.456 k).
72 tude unit. If there is no such unit yet, it tries to define one
77 If you PRINT a VDEF value, you can also print the time associated with
79 uses the strftime function of your OSs clibrary. This means that the
80 conversion specifier may vary. Check the manual page if you are uncer-
81 tain. The following is a list of conversion specifiers usually sup-
82 ported across the board.
97 23).
100 12).
109 responding strings for the current locale. Noon is treated as `pm'
110 and midnight as `am'. Note that in many locales and `pm' notation
111 is unsupported and in such cases %p will return an empty string.
116 00 to 53, starting with the first Sunday as the first day of week
117 01. See also %V and %W.
120 ber, range 01 to 53, where week 1 is the first week that has at
121 least 4 days in the current year, and with Monday as the first day
122 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
152 _\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
154 This is the same as "PRINT", but printed inside the graph.
156 _\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
158 _\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
159 the same as "PRINT", but printed inside the graph.
163 Text is printed literally in the legend section of the graph. Note that
164 in RRDtool 1.2 you have to escape colons in COMMENT text in the same
167 _\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_\b-
168 _\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]
171 adecimal numbers specifying the rgb color components (00 is off, FF is
172 maximum) red, green and blue followed by an optional alpha. Optionally,
174 number or a variable from a V\bVD\bDE\bEF\bF. It is an error to use _\bv_\bn_\ba_\bm_\bes from D\bDE\bEF\bF
175 or C\bCD\bDE\bEF\bF here. Dashed lines can be drawn using the d\bda\bas\bsh\bhe\bes\bs modifier. See
178 _\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_\b-
179 _\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]
182 will have no effect on the scale of the graph. If a HRULE is outside
183 the graphing area it will just not be visible.
185 _\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_\b-
186 _\be_\bn_\bd_\b]_\b[_\b:\b:_\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK_\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_\b-
190 floating point number. If the color is not specified, the drawing is
191 done 'invisibly'. This is useful when stacking something else on top of
192 this line. Also optional is the legend box and string which will be
194 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
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
207 you want to use STACK, use the "LINEx:<value>::STACK" form.
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]
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 normaly start at the lower edge of the graphing area. If
221 the fraction is negative they start at the upper border of the graphing
222 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_\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 instruc-
263 enter a ':' as part of a legend, the colon must be escaped with a back-
264 slash '\:'. Beware that many environments process backslashes
265 themselves, so it may be necessary to write two backslashes in order to
266 one being passed onto rrd_graph.
270 The text printed below the actual graph can be formatted by appending
271 special escape characters at the end of a text. When ever such a char-
272 acter occurs, all pending text is pushed onto the graph according to
273 the character specified.
277 showing how to use centered formatting.
280 of rrdtool lead to this behaviour and a number of people has been using
281 it.
283 Normally there are two space characters inserted between every two
284 items printed into the graph. The space following a string can be sup-
286 any space inside the string if it is at the very end of the string.
289 GPRINT:a:MAX:%lf%s\g
292 space before placing the next row of legends.
294 If you are using the proportional font in your graph, you can use tab
296 tabs inserted are relative to the start of the current legend element!
298 Since RRDtool 1.3 is using Pango for rending text, you can use Pango
300 tions.:
302 A simple example of a marked-up string might be:
304 <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
306 The complete list of attributes for the span tag (taken from the pango
307 documentation):
310 A font description string, such as "Sans Italic 12"; note that any
311 other span attributes will override this description. So if you
312 have "Sans Italic" and also a style="normal" attribute, you will
313 get Sans normal, not italic.
316 A font family name
319 Synonym for font_family
322 Font size in 1024ths of a point, or one of the absolute sizes
323 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large',
324 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If
325 you want to specify a absolute size, it's usually easier to take
326 advantage of the ability to specify a partial font description
327 using 'font_desc'; you can use font_desc='12.5' rather than
328 size='12800'.
331 One of 'normal', 'oblique', 'italic'
334 One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold',
335 'heavy', or a numeric weight
338 'normal' or 'smallcaps'
341 One of 'ultracondensed', 'extracondensed', 'condensed', 'semicon-
342 densed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded',
343 'ultraexpanded'
346 An RGB color specification such as '#00FF00' or a color name such
347 as 'red'
350 An RGB color specification such as '#00FF00' or a color name such
351 as 'red'
354 One of 'none', 'single', 'double', 'low', 'error'
357 The color of underlines; an RGB color specification such as
358 '#00FF00' or a color name such as 'red'
361 Vertical displacement, in 10000ths of an em. Can be negative for
362 subscript, positive for superscript.
365 'true' or 'false' whether to strike through the text
368 The color of strikethrough lines; an RGB color specification such
369 as '#00FF00' or a color name such as 'red'
372 'true' or 'false' whether to enable fallback. If disabled, then
373 characters will only be used from the closest matching font on the
374 system. No fallback will be done to other fonts on the system that
375 might contain the characters in the text. Fallback is enabled by
376 default. Most applications should not disable fallback.
379 A language code, indicating the text language
382 Inter-letter spacing in 1024ths of a point.
385 One of 'south', 'east', 'north', 'west', 'auto'.
388 One of 'natural', 'strong', 'line'.
390 To save you some typing, there are also some shortcuts:
392 b\bb Bold
396 i\bi Italic
398 s\bs Strikethrough
405 Makes font relatively smaller, equivalent to <span size="smaller">
409 u\bu Underline
412 rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
413 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
415 all of the graph and print functions.
417 Make sure to read rrdgraph_examples for tips&tricks.
420 Program by Tobias Oetiker <tobi@oetiker.ch>
422 This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
426 1.3.0 2008-06-11 RRDGRAPH_GRAPH(1)