1 RRDGRAPH_GRAPH(1) rrdtool RRDGRAPH_GRAPH(1)
6 rrdgraph_graph - rrdtool graph command reference
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]
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]]
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]]
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 P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
29 G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
31 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)
34 These instructions allow you to generate your image or report. If you
35 don't use any graph elements, no graph is generated. Similarly, no
36 report is generated if you don't use print options.
39 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]
40 Depending on the context, either the value component or the time
45 percent character introduces a formatter string. This string can
46 be:
48 For printing values:
53 prints numbers like 1.2346e+04. The optional integers # denote
54 field width and decimal precision.
57 prints numbers like 12345.6789, with optional field width and
58 precision.
60 %\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
61 appropriate SI magnitude unit and the value will be scaled
62 accordingly (123456 -> 123.456 k).
65 magnitude unit. If there is no such unit yet, it tries to
67 case the magnitude unit stays undefined. Thus, formatter
69 except for zero values.
71 If you PRINT a VDEF value, you can also print the time associated
73 rrdtool uses the strftime function of your OSs clibrary. This means
74 that the conversion specifier may vary. Check the manual page if
75 you are uncertain. The following is a list of conversion specifiers
76 usually supported across the board.
87 locale.
92 23).
95 12).
104 corresponding strings for the current locale. Noon is treated
105 as `pm' and midnight as `am'. Note that in many locales and
106 `pm' notation is unsupported and in such cases %p will return
107 an empty string.
112 range 00 to 53, starting with the first Sunday as the first day
113 of week 01. See also %V and %W.
116 number, range 01 to 53, where week 1 is the first week that
117 has at least 4 days in the current year, and with Monday as the
118 first day of the week. See also %U and %W.
121 See also %u.
124 00 to 53, starting with the first Monday as the first day
125 of week 01.
128 out the time.
131 out the date.
134 99).
143 _\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
148 This is the same as "PRINT", but printed inside the graph.
151 _\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
152 is the same as "PRINT", but printed inside the graph.
155 Text is printed literally in the legend section of the graph. Note
156 that in RRDtool 1.2 you have to escape colons in COMMENT text in
160 V\bVR\bRU\bUL\bLE\bE:\b:_\bt_\bi_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br [:\b:_\bl_\be_\bg_\be_\bn_\bd ]
162 hexadecimal numbers specifying the rgb color components (00 is off,
163 FF is maximum) red, green and blue followed by an optional alpha.
164 Optionally, a legend box and string is printed in the legend sec-
168 H\bHR\bRU\bUL\bLE\bE:\b:_\bv_\ba_\bl_\bu_\be#\b#_\bc_\bo_\bl_\bo_\br [ :_\bl_\be_\bg_\be_\bn_\bd ]
170 that will have no effect on the scale of the graph. If a HRULE is
171 outside the graphing area it will just not be visible.
173 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]]
175 floating point number. If the color is not specified, the drawing
176 is done 'invisibly'. This is useful when stacking something else on
177 top of this line. Also optional is the legend box and string which
179 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-
180 fier is used, this line is stacked on top of the previous element
183 When you do not specify a color, you cannot specify a legend.
184 Should you want to use STACK, use the "LINEx:<value>::STACK" form.
186 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]]
188 filled.
190 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]]
193 length of the tick mark as a fraction of the y-axis; the default
194 value is 0.1 (10% of the axis). Note that the color specification
195 is not optional. The TICK marks normaly start at the lower edge of
196 the graphing area. If the fraction is negative they start at the
197 upper border of the graphing area.
201 the specified offset. For instance, you can specify an offset of
202 ( 7*24*60*60 = ) 604'800 seconds to "look back" one week. Make sure
203 to tell the viewer of your graph you did this ... As with the
204 other graphing elements, you can specify a number or a variable
205 here.
207 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]
208 _\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.
212 When stacking, an element is not placed above the X-axis but rather on
213 top of the previous element. There must be something to stack upon.
218 You don't know where to begin (the unknown value) and therefore do not
219 know where to end.
221 If you want to make sure you will be displaying a certain variable,
222 make sure never to stack upon the unknown value. Use a CDEF instruc-
229 enter a ':' as part of a legend, the colon must be escaped with a back-
230 slash '\:'. Beware that many environments process backslashes them-
231 selves, so it may be necessary to write two backslashes in order to one
232 being passed onto rrd_graph.
236 The text printed below the actual graph can be formatted by appending
237 special escape characters at the end of a text. When ever such a char-
238 acter occurs, all pending text is pushed onto the graph according to
239 the character specified.
243 showing how to use centered formatting.
246 of rrdtool lead to this behaviour and a number of people has been using
247 it.
249 Normally there are two space characters inserted between every two
250 items printed into the graph. The space following a string can be sup-
252 any space inside the string if it is at the very end of the string.
255 GPRINT:a:MAX:%lf%s\g
258 space before placing the next row of legends.
260 If you are using the proportional font in your graph, you can use tab
262 tabs inserted are relative to the start of the current legend element!
265 rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
266 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
268 all of the graph and print functions.
270 Make sure to read rrdgraph_examples for tips&tricks.
273 Program by Tobias Oetiker <tobi@oetiker.ch>
275 This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
279 1.2.26 2007-11-20 RRDGRAPH_GRAPH(1)