Code

Merge branch 'upstream' into experimental
[pkg-rrdtool.git] / doc / rrdgraph.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
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.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
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
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
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.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
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
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
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'
101 .\}
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 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "RRDGRAPH 1"
132 .TH RRDGRAPH 1 "2008-12-09" "1.3.5" "rrdtool"
133 .SH "NAME"
134 rrdgraph \- Round Robin Database tool grapher functions
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBrrdtool graph|graphv\fR \fIfilename\fR
138 [\fIoption\fR ...]
139 [\fIdata definition\fR ...]
140 [\fIdata calculation\fR ...]
141 [\fIvariable definition\fR ...]
142 [\fIgraph element\fR ...]
143 [\fIprint element\fR ...]
144 .SH "DESCRIPTION"
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
149 a numerical report.
150 .SH "OVERVIEW"
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).
156 .PP
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.
162 .PP
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
167 well become unknown!
168 .PP
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.
174 .PP
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.
177 .SH "OPTIONS"
178 .IX Header "OPTIONS"
179 .Sh "\fBgraphv\fP"
180 .IX Subsection "graphv"
181 This alternate version of \fBgraph\fR takes the same arguments and performs the
182 same function. The \fIv\fR stands for \fIverbose\fR, which describes the output
183 returned. \fBgraphv\fR will return a lot of information about the graph using
184 the same format as rrdtool info (key = value). See the bottom of the document for more information.
185 .Sh "\fIfilename\fP"
186 .IX Subsection "filename"
187 The name and path of the graph to generate. It is recommended to
188 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.
189 .PP
190 \&\fIfilename\fR can be '\f(CW\*(C`\-\*(C'\fR' to send the image to \f(CW\*(C`stdout\*(C'\fR. In
191 this case, no other output is generated.
192 .Sh "Time range"
193 .IX Subsection "Time range"
194 [\fB\-s\fR|\fB\-\-start\fR \fItime\fR]
195 [\fB\-e\fR|\fB\-\-end\fR \fItime\fR]
196 [\fB\-S\fR|\fB\-\-step\fR \fIseconds\fR]
197 .PP
198 The start and end of the time series you would like to display, and which
199 \&\fB\s-1RRA\s0\fR the data should come from.  Defaults are: 1 day ago until
200 now, with the best possible resolution. \fBStart\fR and \fBend\fR can
201 be specified in several formats, see
202 AT-STYLE \s-1TIME\s0 \s-1SPECIFICATION\s0 and rrdgraph_examples.
203 By default, \fBrrdtool graph\fR calculates the width of one pixel in
204 the time domain and tries to get data from an \fB\s-1RRA\s0\fR with that
205 resolution.  With the \fBstep\fR option you can alter this behaviour.
206 If you want \fBrrdtool graph\fR to get data at a one-hour resolution
207 from the \fB\s-1RRD\s0\fR, set \fBstep\fR to 3'600. Note: a step smaller than
208 one pixel will silently be ignored.
209 .Sh "Labels"
210 .IX Subsection "Labels"
211 [\fB\-t\fR|\fB\-\-title\fR \fIstring\fR]
212 [\fB\-v\fR|\fB\-\-vertical\-label\fR \fIstring\fR]
213 .PP
214 A horizontal string at the top of the graph and/or a vertically
215 placed string at the left hand side of the graph.
216 .RE
217 .IP "Right Axis"
218 .IX Item "Right Axis"
219 [\fB\-\-right\-axis\fR \fIscale\fR\fB:\fR\fIshift\fR]
220 [\fB\-\-right\-axis\-label\fR \fIlabel\fR]
221 .PP
222 A second axis will be drawn to the right of the graph. It is tied to the
223 left axis via the scale and shift parameters. You can also define a label
224 for the right axis.
225 .PP
226 [\fB\-\-right\-axis\-format\fR \fIformat-string\fR]
227 .PP
228 By default the format of the axis lables gets determined automatically. If
229 you want todo this your self, use this option with the same \f(CW%lf\fR arguments
230 you know from the \s-1PRING\s0 and \s-1GPRINT\s0 commands.
231 .Sh "Size"
232 .IX Subsection "Size"
233 [\fB\-w\fR|\fB\-\-width\fR \fIpixels\fR]
234 [\fB\-h\fR|\fB\-\-height\fR \fIpixels\fR]
235 [\fB\-j\fR|\fB\-\-only\-graph\fR]
236 [\fB\-D\fR|\fB\-\-full\-size\-mode\fR]
237 .PP
238 By default, the width and height of the \fBcanvas\fR (the part with
239 the actual data and such). This defaults to 400 pixels by 100 pixels.
240 .PP
241 If you specify the \fB\-\-full\-size\-mode\fR option, the width and height
242 specify the final dimensions of the output image and the canvas
243 is automatically resized to fit.
244 .PP
245 If you specify the \fB\-\-only\-graph\fR option and set the height < 32
246 pixels you will get a tiny graph image (thumbnail) to use as an icon
247 for use in an overview, for example. All labeling will be stripped off
248 the graph.
249 .Sh "Limits"
250 .IX Subsection "Limits"
251 [\fB\-u\fR|\fB\-\-upper\-limit\fR \fIvalue\fR]
252 [\fB\-l\fR|\fB\-\-lower\-limit\fR \fIvalue\fR]
253 [\fB\-r\fR|\fB\-\-rigid\fR]
254 .PP
255 By default the graph will be autoscaling so that it will adjust the
256 y\-axis to the range of the data. You can change this behaviour by
257 explicitly setting the limits. The displayed y\-axis will then range at
258 least from \fBlower-limit\fR to \fBupper-limit\fR. Autoscaling will still
259 permit those boundaries to be stretched unless the \fBrigid\fR option is
260 set.
261 .PP
262 [\fB\-A\fR|\fB\-\-alt\-autoscale\fR]
263 .PP
264 Sometimes the default algorithm for selecting the y\-axis scale is not
265 satisfactory. Normally the scale is selected from a predefined
266 set of ranges and this fails miserably when you need to graph something
267 like \f(CW\*(C`260 + 0.001 * sin(x)\*(C'\fR. This option calculates the minimum and
268 maximum y\-axis from the actual minimum and maximum data values. Our example
269 would display slightly less than \f(CW\*(C`260\-0.001\*(C'\fR to slightly more than
270 \&\f(CW\*(C`260+0.001\*(C'\fR (this feature was contributed by Sasha Mikheev).
271 .PP
272 [\fB\-J\fR|\fB\-\-alt\-autoscale\-min\fR]
273 .PP
274 Where \f(CW\*(C`\-\-alt\-autoscale\*(C'\fR will modify both the absolute maximum \s-1AND\s0 minimum
275 values, this option will only affect the minimum value. The maximum
276 value, if not defined on the command line, will be 0. This option can
277 be useful when graphing router traffic when the \s-1WAN\s0 line uses compression,
278 and thus the throughput may be higher than the \s-1WAN\s0 line speed.
279 .PP
280 [\fB\-M\fR|\fB\-\-alt\-autoscale\-max\fR]
281 .PP
282 Where \f(CW\*(C`\-\-alt\-autoscale\*(C'\fR will modify both the absolute maximum \s-1AND\s0 minimum
283 values, this option will only affect the maximum value. The minimum
284 value, if not defined on the command line, will be 0. This option can
285 be useful when graphing router traffic when the \s-1WAN\s0 line uses compression,
286 and thus the throughput may be higher than the \s-1WAN\s0 line speed.
287 .PP
288 [\fB\-N\fR|\fB\-\-no\-gridfit\fR]
289 .PP
290 In order to avoid anti-aliasing blurring effects rrdtool snaps
291 points to device resolution pixels, this results in a crisper
292 aperance. If this is not to your liking, you can use this switch
293 to turn this behaviour off.
294 .PP
295 Gridfitting is turned off for \s-1PDF\s0, \s-1EPS\s0, \s-1SVG\s0 output by default.
296 .Sh "Grid"
297 .IX Subsection "Grid"
298 .IP "X\-Axis" 4
299 .IX Item "X-Axis"
300 [\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]
301 .Sp
302 [\fB\-x\fR|\fB\-\-x\-grid\fR \fBnone\fR]
303 .Sp
304 The x\-axis label is quite complex to configure. If you don't have
305 very special needs it is probably best to rely on the autoconfiguration
306 to get this right. You can specify the string \f(CW\*(C`none\*(C'\fR to suppress the grid
307 and labels altogether.
308 .Sp
309 The grid is defined by specifying a certain amount of time in the \fI?TM\fR
310 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,
311 \&\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
312 pass between each line or label.  This pair (\fI?TM:?ST\fR) needs to be
313 specified for the base grid (\fIG??\fR), the major grid (\fIM??\fR) and the
314 labels (\fIL??\fR). For the labels you also must define a precision
315 in \fI\s-1LPR\s0\fR and a \fIstrftime\fR format string in \fI\s-1LFM\s0\fR.  \fI\s-1LPR\s0\fR defines
316 where each label will be placed. If it is zero, the label will be
317 placed right under the corresponding line (useful for hours, dates
318 etcetera).  If you specify a number of seconds here the label is
319 centered on this interval (useful for Monday, January etcetera).
320 .Sp
321 .Vb 1
322 \& \-\-x\-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
323 .Ve
324 .Sp
325 This places grid lines every 10 minutes, major grid lines every hour,
326 and labels every 4 hours. The labels are placed under the major grid
327 lines as they specify exactly that time.
328 .Sp
329 .Vb 1
330 \& \-\-x\-grid HOUR:8:DAY:1:DAY:1:86400:%A
331 .Ve
332 .Sp
333 This places grid lines every 8 hours, major grid lines and labels
334 each day. The labels are placed exactly between two major grid lines
335 as they specify the complete day and not just midnight.
336 .IP "Y\-Axis" 4
337 .IX Item "Y-Axis"
338 [\fB\-y\fR|\fB\-\-y\-grid\fR \fIgrid step\fR\fB:\fR\fIlabel factor\fR]
339 .Sp
340 [\fB\-y\fR|\fB\-\-y\-grid\fR \fBnone\fR]
341 .Sp
342 Y\-axis grid lines appear at each \fIgrid step\fR interval.  Labels are
343 placed every \fIlabel factor\fR lines.  You can specify \f(CW\*(C`\-y none\*(C'\fR to
344 suppress the grid and labels altogether.  The default for this option is
345 to automatically select sensible values.
346 .Sp
347 If you have set \-\-y\-grid to 'none' not only the labels get supressed, also
348 the space reserved for the labels is removed. You can still add space
349 manually if you use the \-\-units\-length command to explicitly reserve space.
350 .Sp
351 [\fB\-Y\fR|\fB\-\-alt\-y\-grid\fR]
352 .Sp
353 Place the Y grid dynamically based on the graph's Y range. The algorithm
354 ensures that you always have a grid, that there are enough but not too many
355 grid lines, and that the grid is metric. That is the grid lines are placed
356 every 1, 2, 5 or 10 units. This parameter will also ensure that you get
357 enough decimals displayed even if your graph goes from 69.998 to 70.001. 
358 (contributed by Sasha Mikheev).
359 .Sp
360 [\fB\-o\fR|\fB\-\-logarithmic\fR]
361 .Sp
362 Logarithmic y\-axis scaling.
363 .Sp
364 [\fB\-X\fR|\fB\-\-units\-exponent\fR \fIvalue\fR]
365 .Sp
366 This sets the 10**exponent scaling of the y\-axis values. Normally,
367 values will be scaled to the appropriate units (k, M, etc.).  However,
368 you may wish to display units always in k (Kilo, 10e3) even if the data
369 is in the M (Mega, 10e6) range, for instance. Value should be an
370 integer which is a multiple of 3 between \-18 and 18 inclusively.  It is
371 the exponent on the units you wish to use. For example, use 3 to
372 display the y\-axis values in k (Kilo, 10e3, thousands), use \-6 to
373 display the y\-axis values in u (Micro, 10e\-6, millionths).  Use a value
374 of 0 to prevent any scaling of the y\-axis values.
375 .Sp
376 This option is very effective at confusing the heck out of the default
377 rrdtool autoscaler and grid painter. If rrdtool detects that it is not
378 successful in labeling the graph under the given circumstances, it will switch
379 to the more robust \fB\-\-alt\-y\-grid\fR mode.
380 .Sp
381 [\fB\-L\fR|\fB\-\-units\-length\fR \fIvalue\fR]
382 .Sp
383 How many digits should rrdtool assume the y\-axis labels to be? You
384 may have to use this option to make enough space once you start
385 fideling with the y\-axis labeling.
386 .Sp
387 [\fB\-\-units=si\fR]
388 .Sp
389 With this option y\-axis values on logarithmic graphs will be scaled to 
390 the appropriate units (k, M, etc.) instead of using exponential notation.
391 Note that for linear graphs, \s-1SI\s0 notation is used by default.
392 .Sh "Miscellaneous"
393 .IX Subsection "Miscellaneous"
394 [\fB\-z\fR|\fB\-\-lazy\fR]
395 .PP
396 Only generate the graph if the current graph is out of date or not existent.
397 Note, that only the image size will be returned, if you run with lazy even
398 when using graphv and even when using \s-1PRINT\s0.
399 .PP
400 [\fB\-f\fR|\fB\-\-imginfo\fR \fIprintfstr\fR]
401 .PP
402 After the image has been created, the graph function uses printf
403 together with this format string to create output similar to the \s-1PRINT\s0
404 function, only that the printf function is supplied with the parameters
405 \&\fIfilename\fR, \fIxsize\fR and \fIysize\fR. In order to generate an \fB\s-1IMG\s0\fR tag
406 suitable for including the graph into a web page, the command line
407 would look like this:
408 .PP
409 .Vb 1
410 \& \-\-imginfo \(aq<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">\(aq
411 .Ve
412 .PP
413 [\fB\-c\fR|\fB\-\-color\fR \fI\s-1COLORTAG\s0\fR#\fIrrggbb\fR[\fIaa\fR]]
414 .PP
415 Override the default colors for the standard elements of the graph. The
416 \&\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
417 the actual graph, \f(CW\*(C`SHADEA\*(C'\fR for the left and top border, \f(CW\*(C`SHADEB\*(C'\fR for the
418 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
419 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
420 line around the color spots, and finally \f(CW\*(C`ARROW\*(C'\fR for the arrow head pointing
421 up and forward. Each color is composed out of three hexadecimal numbers
422 specifying its rgb color component (00 is off, \s-1FF\s0 is maximum) of red, green
423 and blue. Optionally you may add another hexadecimal number specifying the
424 transparency (\s-1FF\s0 is solid). You may set this option several times to alter
425 multiple defaults.
426 .PP
427 A green arrow is made by: \f(CW\*(C`\-\-color ARROW#00FF00\*(C'\fR
428 .PP
429 [\fB\-\-zoom\fR \fIfactor\fR]
430 .PP
431 Zoom the graphics by the given amount. The factor must be > 0
432 .PP
433 [\fB\-n\fR|\fB\-\-font\fR \fI\s-1FONTTAG\s0\fR\fB:\fR\fIsize\fR\fB:\fR[\fIfont\fR]]
434 .PP
435 This lets you customize which font to use for the various text elements on
436 the \s-1RRD\s0 graphs. \f(CW\*(C`DEFAULT\*(C'\fR sets the default value for all elements, \f(CW\*(C`TITLE\*(C'\fR
437 for the title, \f(CW\*(C`AXIS\*(C'\fR for the axis labels, \f(CW\*(C`UNIT\*(C'\fR for the vertical unit
438 label, \f(CW\*(C`LEGEND\*(C'\fR for the graph legend, \f(CW\*(C`WATERMARK\*(C'\fR for the watermark on the
439 edge of the graph.
440 .PP
441 Use Times for the title: \f(CW\*(C`\-\-font TITLE:13:Times\*(C'\fR
442 .PP
443 If you do not give a font string you can modify just the sice of the default font:
444 \&\f(CW\*(C`\-\-font TITLE:13:\*(C'\fR.
445 .PP
446 If you specify the size 0 then you can modify just the font without touching
447 the size. This is especially usefull for altering the default font without
448 resetting the default fontsizes: \f(CW\*(C`\-\-font DEFAULT:0:Courier\*(C'\fR.
449 .PP
450 RRDtool comes with a preset default font. You can set the environment
451 variable \f(CW\*(C`RRD_DEFAULT_FONT\*(C'\fR if you want to change this.
452 .PP
453 RRDtool uses Pango for its font handling. This means you can to use
454 the full Pango syntax when selecting your font:
455 .PP
456 The font name has the form "[\fIFAMILY-LIST\fR] [\fISTYLE-OPTIONS\fR] [\fI\s-1SIZE\s0\fR]",
457 where \fIFAMILY-LIST\fR is a comma separated list of families optionally
458 terminated by a comma, \fI\s-1STYLE_OPTIONS\s0\fR is a whitespace separated list of
459 words where each \s-1WORD\s0 describes one of style, variant, weight, stretch, or
460 gravity, and \fI\s-1SIZE\s0\fR is a decimal number (size in points) or optionally
461 followed by the unit modifier \*(L"px\*(R" for absolute size. Any one of the options
462 may be absent.
463 .PP
464 [\fB\-R\fR|\fB\-\-font\-render\-mode\fR {\fBnormal\fR,\fBlight\fR,\fBmono\fR}]
465 .PP
466 There are 3 font render modes:
467 .PP
468 \&\fBnormal\fR: Full Hinting and Antialiasing (default)
469 .PP
470 \&\fBlight\fR: Slight Hinting and Antialiasing
471 .PP
472 \&\fBmono\fR: Full Hinting and \s-1NO\s0 Antialiasing
473 .PP
474 [\fB\-B\fR|\fB\-\-font\-smoothing\-threshold\fR \fIsize\fR]
475 .PP
476 (this gets ignored in 1.3 for now!)
477 .PP
478 This specifies the largest font size which will be rendered
479 bitmapped, that is, without any font smoothing. By default,
480 no text is rendered bitmapped.
481 .PP
482 [\fB\-P\fR|\fB\-\-pango\-markup\fR]
483 .PP
484 All text in rrdtool is rendered using Pango. With the \fB\-\-pango\-markup\fR option, all
485 text will be processed by pango markup. This allows to embed some simple html
486 like markup tags using 
487 .PP
488 .Vb 1
489 \& <span key="value">text</span>
490 .Ve
491 .PP
492 Apart from the verbose syntax, there are also the following short tags available.
493 .PP
494 .Vb 9
495 \& b     Bold
496 \& big   Makes font relatively larger, equivalent to <span size="larger">
497 \& i     Italic
498 \& s     Strikethrough
499 \& sub   Subscript
500 \& sup   Superscript
501 \& small Makes font relatively smaller, equivalent to <span size="smaller">
502 \& tt    Monospace font
503 \& u     Underline
504 .Ve
505 .PP
506 More details on <http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html>.
507 .PP
508 [\fB\-G\fR|\fB\-\-graph\-render\-mode\fR {\fBnormal\fR,\fBmono\fR}]
509 .PP
510 There are 2 render modes:
511 .PP
512 \&\fBnormal\fR: Graphs are fully Antialiased (default)
513 .PP
514 \&\fBmono\fR: No Antialiasing
515 .PP
516 [\fB\-E\fR|\fB\-\-slope\-mode\fR]
517 .PP
518 RRDtool graphs are composed of stair case curves by default. This is in line with
519 the way RRDtool calculates its data. Some people favor a more 'organic' look
520 for their graphs even though it is not all that true.
521 .PP
522 [\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]
523 .PP
524 Image format for the generated graph. For the vector formats you can
525 choose among the standard Postscript fonts Courier\-Bold,
526 Courier\-BoldOblique, Courier\-Oblique, Courier, Helvetica\-Bold,
527 Helvetica\-BoldOblique, Helvetica\-Oblique, Helvetica, Symbol,
528 Times\-Bold, Times\-BoldItalic, Times\-Italic, Times\-Roman, and ZapfDingbats.
529 .PP
530 [\fB\-i\fR|\fB\-\-interlaced\fR]
531 .PP
532 (this gets ignored in 1.3 for now!)
533 .PP
534 If images are interlaced they become visible on browsers more quickly.
535 .PP
536 [\fB\-g\fR|\fB\-\-no\-legend\fR]
537 .PP
538 Suppress generation of the legend; only render the graph.
539 .PP
540 [\fB\-F\fR|\fB\-\-force\-rules\-legend\fR]
541 .PP
542 Force the generation of \s-1HRULE\s0 and \s-1VRULE\s0 legends even if those \s-1HRULE\s0 or
543 \&\s-1VRULE\s0 will not be drawn because out of graph boundaries (mimics
544 behaviour of pre 1.0.42 versions).
545 .PP
546 [\fB\-T\fR|\fB\-\-tabwidth\fR \fIvalue\fR]
547 .PP
548 By default the tab-width is 40 pixels, use this option to change it.
549 .PP
550 [\fB\-b\fR|\fB\-\-base\fR \fIvalue\fR]
551 .PP
552 If you are graphing memory (and \s-1NOT\s0 network traffic) this switch
553 should be set to 1024 so that one Kb is 1024 byte. For traffic
554 measurement, 1 kb/s is 1000 b/s.
555 .PP
556 [\fB\-W\fR|\fB\-\-watermark\fR \fIstring\fR]
557 .PP
558 Adds the given string as a watermark, horizontally centred, at the bottom 
559 of the graph.
560 .Sh "Data and variables"
561 .IX Subsection "Data and variables"
562 \&\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]
563 .PP
564 \&\fB\s-1CDEF:\s0\fR\fIvname\fR\fB=\fR\fI\s-1RPN\s0 expression\fR
565 .PP
566 \&\fB\s-1VDEF:\s0\fR\fIvname\fR\fB=\fR\fI\s-1RPN\s0 expression\fR
567 .PP
568 You need at least one \fB\s-1DEF\s0\fR statement to generate anything. The
569 other statements are useful but optional.
570 See rrdgraph_data and rrdgraph_rpn for the exact format.
571 .PP
572 \&\s-1NOTE:\s0 \fBGraph and print elements\fR
573 .PP
574 You need at least one graph element to generate an image and/or
575 at least one print statement to generate a report.
576 See rrdgraph_graph for the exact format.
577 .Sh "graphv"
578 .IX Subsection "graphv"
579 Calling rrdtool with the graphv option will return information in the
580 rrdtool info format. On the command line this means that all output will be
581 in key=value format. When used from the perl and ruby bindings a hash
582 pointer will be returned from the call.
583 .PP
584 When the filename '\-' is given, the contents of the graph itself will also
585 be returned through this interface (hash key 'image'). On the command line
586 the output will look like this:
587 .PP
588 .Vb 12
589 \& print[0] = "0.020833"
590 \& print[1] = "0.0440833"
591 \& graph_left = 51
592 \& graph_top = 22
593 \& graph_width = 400
594 \& graph_height = 100
595 \& image_width = 481
596 \& image_height = 154
597 \& value_min = 0.0000000000e+00
598 \& value_max = 4.0000000000e\-02
599 \& image = BLOB_SIZE:8196
600 \& [... 8196 bytes of image data ...]
601 .Ve
602 .PP
603 There is more information returned than in the standard interface.
604 Especially the 'graph_*' keys are new. They help applications that want to
605 know what is where on the graph.
606 .SH "SEE ALSO"
607 .IX Header "SEE ALSO"
608 rrdgraph gives an overview of how \fBrrdtool graph\fR works.
609 rrdgraph_data describes \fB\s-1DEF\s0\fR,\fB\s-1CDEF\s0\fR and \fB\s-1VDEF\s0\fR in detail.
610 rrdgraph_rpn describes the \fB\s-1RPN\s0\fR language used in the \fB?DEF\fR statements.
611 rrdgraph_graph page describes all of the graph and print functions.
612 .PP
613 Make sure to read rrdgraph_examples for tips&tricks.
614 .SH "AUTHOR"
615 .IX Header "AUTHOR"
616 Program by Tobias Oetiker <tobi@oetiker.ch>
617 .PP
618 This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>