1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "RRDGRAPH 1"
132 .TH RRDGRAPH 1 "2005-06-17" "1.2.10" "rrdtool"
134 rrdgraph \- Round Robin Database tool grapher functions
136 .IX Header "SYNOPSIS"
137 \&\fBrrdtool graph\fR \fIfilename\fR
139 [\fIdata definition\fR ...]
140 [\fIdata calculation\fR ...]
141 [\fIvariable definition\fR ...]
142 [\fIgraph element\fR ...]
143 [\fIprint element\fR ...]
145 .IX Header "DESCRIPTION"
146 The \fBgraph\fR function of \fBRRDtool\fR is used to present the
147 data from an \fB\s-1RRD\s0\fR to a human viewer. Its main purpose is to
148 create a nice graphical representation, but it can also generate
151 .IX Header "OVERVIEW"
152 \&\fBrrdtool graph\fR needs data to work with, so you must use one or more
153 \&\fBdata definition\fR statements to collect this
154 data. You are not limited to one database, it's perfectly legal to
155 collect data from two or more databases (one per statement, though).
157 If you want to display averages, maxima, percentiles, etcetera
158 it is best to collect them now using the
159 \&\fBvariable definition\fR statement.
160 Currently this makes no difference, but in a future version
161 of rrdtool you may want to collect these values before consolidation.
163 The data fetched from the \fB\s-1RRA\s0\fR is then \fBconsolidated\fR so that
164 there is exactly one datapoint per pixel in the graph. If you do
165 not take care yourself, \fBRRDtool\fR will expand the range slightly
166 if necessary. Note, in that case the first and/or last pixel may very
169 Sometimes data is not exactly in the format you would like to display
170 it. For instance, you might be collecting \fBbytes\fR per second, but
171 want to display \fBbits\fR per second. This is what the \fBdata calculation\fR command is designed for. After
172 \&\fBconsolidating\fR the data, a copy is made and this copy is modified
173 using a rather powerful \fB\s-1RPN\s0\fR command set.
175 When you are done fetching and processing the data, it is time to
176 graph it (or print it). This ends the \fBrrdtool graph\fR sequence.
181 The name and path of the graph to generate. It is recommended to
182 end this in \f(CW\*(C`.png\*(C'\fR, \f(CW\*(C`.svg\*(C'\fR or \f(CW\*(C`.eps\*(C'\fR, but \fBRRDtool\fR does not enforce this.
184 \&\fIfilename\fR can be '\f(CW\*(C`\-\*(C'\fR' to send the image to \f(CW\*(C`stdout\*(C'\fR. In
185 this case, no other output is generated.
187 .IX Item "Time range"
188 [\fB\-s\fR|\fB\-\-start\fR \fItime\fR]
189 [\fB\-e\fR|\fB\-\-end\fR \fItime\fR]
190 [\fB\-S\fR|\fB\-\-step\fR \fIseconds\fR]
192 The start and end of the time series you would like to display, and which
193 \&\fB\s-1RRA\s0\fR the data should come from. Defaults are: 1 day ago until
194 now, with the best possible resolution. \fBStart\fR and \fBend\fR can
195 be specified in several formats, see
196 AT-STYLE \s-1TIME\s0 \s-1SPECIFICATION\s0 and rrdgraph_examples.
197 By default, \fBrrdtool graph\fR calculates the width of one pixel in
198 the time domain and tries to get data from an \fB\s-1RRA\s0\fR with that
199 resolution. With the \fBstep\fR option you can alter this behaviour.
200 If you want \fBrrdtool graph\fR to get data at a one-hour resolution
201 from the \fB\s-1RRD\s0\fR, set \fBstep\fR to 3'600. Note: a step smaller than
202 one pixel will silently be ignored.
205 [\fB\-t\fR|\fB\-\-title\fR \fIstring\fR]
206 [\fB\-v\fR|\fB\-\-vertical\-label\fR \fIstring\fR]
208 A horizontal string at the top of the graph and/or a vertically
209 placed string at the left hand side of the graph.
212 [\fB\-w\fR|\fB\-\-width\fR \fIpixels\fR]
213 [\fB\-h\fR|\fB\-\-height\fR \fIpixels\fR]
214 [\fB\-j\fR|\fB\-\-only\-graph\fR]
216 The width and height of the \fBcanvas\fR (the part of the graph with
217 the actual data and such). This defaults to 400 pixels by 100 pixels.
219 If you specify the \fB\-\-only\-graph\fR option and set the height < 32
220 pixels you will get a tiny graph image (thumbnail) to use as an icon
221 for use in an overview, for example. All labeling will be stripped off
225 [\fB\-u\fR|\fB\-\-upper\-limit\fR \fIvalue\fR]
226 [\fB\-l\fR|\fB\-\-lower\-limit\fR \fIvalue\fR]
227 [\fB\-r\fR|\fB\-\-rigid\fR]
229 By default the graph will be autoscaling so that it will adjust the
230 y\-axis to the range of the data. You can change this behaviour by
231 explicitly setting the limits. The displayed y\-axis will then range at
232 least from \fBlower-limit\fR to \fBupper-limit\fR. Autoscaling will still
233 permit those boundaries to be stretched unless the \fBrigid\fR option is
236 [\fB\-A\fR|\fB\-\-alt\-autoscale\fR]
238 Sometimes the default algorithm for selecting the y\-axis scale is not
239 satisfactory. Normally the scale is selected from a predefined
240 set of ranges and this fails miserably when you need to graph something
241 like \f(CW\*(C`260 + 0.001 * sin(x)\*(C'\fR. This option calculates the minimum and
242 maximum y\-axis from the actual minimum and maximum data values. Our example
243 would display slightly less than \f(CW\*(C`260\-0.001\*(C'\fR to slightly more than
244 \&\f(CW\*(C`260+0.001\*(C'\fR (this feature was contributed by Sasha Mikheev).
246 [\fB\-M\fR|\fB\-\-alt\-autoscale\-max\fR]
248 Where \f(CW\*(C`\-\-alt\-autoscale\*(C'\fR will modify both the absolute maximum \s-1AND\s0 minimum
249 values, this option will only affect the maximum value. The minimum
250 value, if not defined on the command line, will be 0. This option can
251 be useful when graphing router traffic when the \s-1WAN\s0 line uses compression,
252 and thus the throughput may be higher than the \s-1WAN\s0 line speed.
254 [\fB\-N\fR|\fB\-\-no\-gridfit\fR]
256 In order to avoid anti-aliasing effects gridlines are placed on
257 integer pixel values. This is by default done by extending
258 the scale so that gridlines happens to be spaced using an
259 integer number of pixels and also start on an integer pixel value.
260 This might extend the scale too much for some logarithmic scales
261 and for linear scales where \fB\-\-alt\-autoscale\fR is needed.
262 Using \fB\-\-no\-gridfit\fR disables modification of the scale.
270 [\fB\-x\fR|\fB\-\-x\-grid\fR \fI\s-1GTM\s0\fR\fB:\fR\fI\s-1GST\s0\fR\fB:\fR\fI\s-1MTM\s0\fR\fB:\fR\fI\s-1MST\s0\fR\fB:\fR\fI\s-1LTM\s0\fR\fB:\fR\fI\s-1LST\s0\fR\fB:\fR\fI\s-1LPR\s0\fR\fB:\fR\fI\s-1LFM\s0\fR]
272 [\fB\-x\fR|\fB\-\-x\-grid\fR \fBnone\fR]
274 The x\-axis label is quite complex to configure. If you don't have
275 very special needs it is probably best to rely on the autoconfiguration
276 to get this right. You can specify the string \f(CW\*(C`none\*(C'\fR to suppress the grid
277 and labels altogether.
279 The grid is defined by specifying a certain amount of time in the \fI?TM\fR
280 positions. You can choose from \f(CW\*(C`SECOND\*(C'\fR, \f(CW\*(C`MINUTE\*(C'\fR, \f(CW\*(C`HOUR\*(C'\fR, \f(CW\*(C`DAY\*(C'\fR,
281 \&\f(CW\*(C`WEEK\*(C'\fR, \f(CW\*(C`MONTH\*(C'\fR or \f(CW\*(C`YEAR\*(C'\fR. Then you define how many of these should
282 pass between each line or label. This pair (\fI?TM:?ST\fR) needs to be
283 specified for the base grid (\fIG??\fR), the major grid (\fIM??\fR) and the
284 labels (\fIL??\fR). For the labels you also must define a precision
285 in \fI\s-1LPR\s0\fR and a \fIstrftime\fR format string in \fI\s-1LFM\s0\fR. \fI\s-1LPR\s0\fR defines
286 where each label will be placed. If it is zero, the label will be
287 placed right under the corresponding line (useful for hours, dates
288 etcetera). If you specify a number of seconds here the label is
289 centered on this interval (useful for Monday, January etcetera).
292 \& --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
295 This places grid lines every 10 minutes, major grid lines every hour,
296 and labels every 4 hours. The labels are placed under the major grid
297 lines as they specify exactly that time.
300 \& --x-grid HOUR:8:DAY:1:DAY:1:0:%A
303 This places grid lines every 8 hours, major grid lines and labels
304 each day. The labels are placed exactly between two major grid lines
305 as they specify the complete day and not just midnight.
308 [\fB\-y\fR|\fB\-\-y\-grid\fR \fIgrid step\fR\fB:\fR\fIlabel factor\fR]
310 [\fB\-y\fR|\fB\-\-y\-grid\fR \fBnone\fR]
312 Y\-axis grid lines appear at each \fIgrid step\fR interval. Labels are
313 placed every \fIlabel factor\fR lines. You can specify \f(CW\*(C`\-y none\*(C'\fR to
314 suppress the grid and labels altogether. The default for this option is
315 to automatically select sensible values.
317 [\fB\-Y\fR|\fB\-\-alt\-y\-grid\fR]
319 Place the Y grid dynamically based on the graph's Y range. The algorithm
320 ensures that you always have a grid, that there are enough but not too many
321 grid lines, and that the grid is metric. That is the grid lines are placed
322 every 1, 2, 5 or 10 units. This parameter will also ensure that you get
323 enough decimals displayed even if your graph goes from 69.998 to 70.001.
324 (contributed by Sasha Mikheev).
326 [\fB\-o\fR|\fB\-\-logarithmic\fR]
328 Logarithmic y\-axis scaling.
330 [\fB\-X\fR|\fB\-\-units\-exponent\fR \fIvalue\fR]
332 This sets the 10**exponent scaling of the y\-axis values. Normally,
333 values will be scaled to the appropriate units (k, M, etc.). However,
334 you may wish to display units always in k (Kilo, 10e3) even if the data
335 is in the M (Mega, 10e6) range, for instance. Value should be an
336 integer which is a multiple of 3 between \-18 and 18 inclusively. It is
337 the exponent on the units you wish to use. For example, use 3 to
338 display the y\-axis values in k (Kilo, 10e3, thousands), use \-6 to
339 display the y\-axis values in u (Micro, 10e\-6, millionths). Use a value
340 of 0 to prevent any scaling of the y\-axis values.
342 This option is very effective at confusing the heck out of the default
343 rrdtool autoscaler and grid painter. If rrdtool detects that it is not
344 successful in labeling the graph under the given circumstances, it will switch
345 to the more robust \fB\-\-alt\-y\-grid\fR mode.
347 [\fB\-L\fR|\fB\-\-units\-length\fR \fIvalue\fR]
349 How many digits should rrdtool assume the y\-axis labels to be? You
350 may have to use this option to make enough space once you start
351 fideling with the y\-axis labeling.
355 .IP "Miscellaneous" 4
356 .IX Item "Miscellaneous"
357 [\fB\-z\fR|\fB\-\-lazy\fR]
359 Only generate the graph if the current graph is out of date or not
362 [\fB\-f\fR|\fB\-\-imginfo\fR \fIprintfstr\fR]
364 After the image has been created, the graph function uses printf
365 together with this format string to create output similar to the \s-1PRINT\s0
366 function, only that the printf function is supplied with the parameters
367 \&\fIfilename\fR, \fIxsize\fR and \fIysize\fR. In order to generate an \fB\s-1IMG\s0\fR tag
368 suitable for including the graph into a web page, the command line
369 would look like this:
372 \& --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
375 [\fB\-c\fR|\fB\-\-color\fR \fI\s-1COLORTAG\s0\fR#\fIrrggbb\fR[\fIaa\fR]]
377 Override the default colors for the standard elements of the graph. The
378 \&\fI\s-1COLORTAG\s0\fR is one of \f(CW\*(C`BACK\*(C'\fR background, \f(CW\*(C`CANVAS\*(C'\fR for the background of
379 the actual graph, \f(CW\*(C`SHADEA\*(C'\fR for the left and top border, \f(CW\*(C`SHADEB\*(C'\fR for the
380 right and bottom border, \f(CW\*(C`GRID\*(C'\fR, \f(CW\*(C`MGRID\*(C'\fR for the major grid, \f(CW\*(C`FONT\*(C'\fR for
381 the color of the font, \f(CW\*(C`AXIS\*(C'\fR for the axis of the graph, \f(CW\*(C`FRAME\*(C'\fR for the
382 line around the color spots and finally \f(CW\*(C`ARROW\*(C'\fR for the arrow head pointing
383 up and forward. Each color is composed out of three hexadecimal numbers
384 specifying its rgb color component (00 is off, \s-1FF\s0 is maximum) of red, green
385 and blue. Optionally you may add another hexadecimal number specifying the
386 transparency (\s-1FF\s0 is solid). You may set this option several times to alter
389 A green arrow is made by: \f(CW\*(C`\-\-color ARROW:00FF00\*(C'\fR
391 [\fB\-\-zoom\fR \fIfactor\fR]
393 Zoom the graphics by the given amount. The factor must be > 0
395 [\fB\-n\fR|\fB\-\-font\fR \fI\s-1FONTTAG\s0\fR\fB:\fR\fIsize\fR\fB:\fR[\fIfont\fR]]
397 This lets you customize which font to use for the various text
398 elements on the \s-1RRD\s0 graphs. \f(CW\*(C`DEFAULT\*(C'\fR sets the default value for all
399 elements, \f(CW\*(C`TITLE\*(C'\fR for the title, \f(CW\*(C`AXIS\*(C'\fR for the axis labels, \f(CW\*(C`UNIT\*(C'\fR
400 for the vertical unit label, \f(CW\*(C`LEGEND\*(C'\fR for the graph legend.
402 Use Times for the title: \f(CW\*(C`\-\-font TITLE:13:/usr/lib/fonts/times.ttf\*(C'\fR
404 If you do not give a font string you can modify just the sice of the default font:
405 \&\f(CW\*(C`\-\-font TITLE:13:\*(C'\fR.
407 If you specify the size 0 then you can modify just the font without touching
408 the size. This is especially usefull for altering the default font without
409 resetting the default fontsizes: \f(CW\*(C`\-\-font DEFAULT:0:/usr/lib/fonts/times.ttf\*(C'\fR.
411 RRDtool comes with a preset default font. You can set the environment
412 variable \f(CW\*(C`RRD_DEFAULT_FONT\*(C'\fR if you want to change this.
414 Truetype fonts are only supported for \s-1PNG\s0 output. See below.
416 [\fB\-R\fR|\fB\-\-font\-render\-mode\fR {\fInormal\fR,\fIlight\fR,\fImono\fR}]
418 This lets you customize the strength of the font smoothing,
419 or disable it entirely using \fImono\fR. By default, \fInormal\fR
420 font smoothing is used.
422 [\fB\-B\fR|\fB\-\-font\-smoothing\-threshold\fR \fIsize\fR]
424 This specifies the largest font size which will be rendered
425 bitmapped, that is, without any font smoothing. By default,
426 no text is rendered bitmapped.
428 [\fB\-E\fR|\fB\-\-slope\-mode\fR]
430 RRDtool graphs are composed of stair case curves by default. This is in line with
431 the way RRDtool calculates its data. Some people favor a more 'organic' look
432 for their graphs even though it is not all that true.
434 [\fB\-a\fR|\fB\-\-imgformat\fR \fB\s-1PNG\s0\fR|\fB\s-1SVG\s0\fR|\fB\s-1EPS\s0\fR|\fB\s-1PDF\s0\fR]
436 Image format for the generated graph. For the vector formats you can
437 choose among the standard Postscript fonts Courier\-Bold,
438 Courier\-BoldOblique, Courier\-Oblique, Courier, Helvetica\-Bold,
439 Helvetica\-BoldOblique, Helvetica\-Oblique, Helvetica, Symbol,
440 Times\-Bold, Times\-BoldItalic, Times\-Italic, Times\-Roman, and ZapfDingbats.
442 [\fB\-i\fR|\fB\-\-interlaced\fR]
444 If images are interlaced they become visible on browsers more quickly.
446 [\fB\-g\fR|\fB\-\-no\-legend\fR]
448 Suppress generation of the legend; only render the graph.
450 [\fB\-F\fR|\fB\-\-force\-rules\-legend\fR]
452 Force the generation of \s-1HRULE\s0 and \s-1VRULE\s0 legends even if those \s-1HRULE\s0 or
453 \&\s-1VRULE\s0 will not be drawn because out of graph boundaries (mimics
454 behaviour of pre 1.0.42 versions).
456 [\fB\-T\fR|\fB\-\-tabwidth\fR \fIvalue\fR]
458 By default the tab-width is 40 pixels, use this option to change it.
460 [\fB\-b\fR|\fB\-\-base\fR \fIvalue\fR]
462 If you are graphing memory (and \s-1NOT\s0 network traffic) this switch
463 should be set to 1024 so that one Kb is 1024 byte. For traffic
464 measurement, 1 kb/s is 1000 b/s.
465 .IP "Data and variables" 4
466 .IX Item "Data and variables"
467 \&\fB\s-1DEF:\s0\fR\fIvname\fR\fB=\fR\fIrrdfile\fR\fB:\fR\fIds-name\fR\fB:\fR\fI\s-1CF\s0\fR[\fB:step=\fR\fIstep\fR][\fB:start=\fR\fItime\fR][\fB:end=\fR\fItime\fR]
469 \&\fB\s-1CDEF:\s0\fR\fIvname\fR\fB=\fR\fI\s-1RPN\s0 expression\fR
471 \&\fB\s-1VDEF:\s0\fR\fIvname\fR\fB=\fR\fI\s-1RPN\s0 expression\fR
473 You need at least one \fB\s-1DEF\s0\fR statement to generate anything. The
474 other statements are useful but optional.
475 See rrdgraph_data and rrdgraph_rpn for the exact format.
476 .IP "Graph and print elements" 4
477 .IX Item "Graph and print elements"
478 You need at least one graph element to generate an image and/or
479 at least one print statement to generate a report.
480 See rrdgraph_graph for the exact format.
482 .IX Header "SEE ALSO"
483 rrdgraph gives an overview of how \fBrrdtool graph\fR works.
484 rrdgraph_data describes \fB\s-1DEF\s0\fR,\fB\s-1CDEF\s0\fR and \fB\s-1VDEF\s0\fR in detail.
485 rrdgraph_rpn describes the \fB\s-1RPN\s0\fR language used in the \fB?DEF\fR statements.
486 rrdgraph_graph page describes all of the graph and print functions.
488 Make sure to read rrdgraph_examples for tips&tricks.
491 Program by Tobias Oetiker <oetiker@ee.ethz.ch>
493 This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
OSDN Git Service
