Code

Imported upstream version 1.3.5.
[pkg-rrdtool.git] / doc / rrdgraph.txt
1 RRDGRAPH(1)                         rrdtool                        RRDGRAPH(1)
5 N\bNA\bAM\bME\bE
6        rrdgraph - Round Robin Database tool grapher functions
8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
9        r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh|\b|g\bgr\bra\bap\bph\bhv\bv _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [_\bo_\bp_\bt_\bi_\bo_\bn ...]  [_\bd_\ba_\bt_\ba _\bd_\be_\bf_\bi_\bn_\bi_\bt_\bi_\bo_\bn ...]
10        [_\bd_\ba_\bt_\ba _\bc_\ba_\bl_\bc_\bu_\bl_\ba_\bt_\bi_\bo_\bn ...]  [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be _\bd_\be_\bf_\bi_\bn_\bi_\bt_\bi_\bo_\bn ...]  [_\bg_\br_\ba_\bp_\bh _\be_\bl_\be_\bm_\be_\bn_\bt ...]
11        [_\bp_\br_\bi_\bn_\bt _\be_\bl_\be_\bm_\be_\bn_\bt ...]
13 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
14        The g\bgr\bra\bap\bph\bh function of R\bRR\bRD\bDt\bto\boo\bol\bl is used to present the data from an R\bRR\bRD\bD
15        to a human viewer.  Its main purpose is to create a nice graphical rep-
16        resentation, but it can also generate a numerical report.
18 O\bOV\bVE\bER\bRV\bVI\bIE\bEW\bW
19        r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh needs data to work with, so you must use one or more d\bda\bat\bta\ba
20        d\bde\bef\bfi\bin\bni\bit\bti\bio\bon\bn statements to collect this data.  You are not limited to one
21        database, it's perfectly legal to collect data from two or more
22        databases (one per statement, though).
24        If you want to display averages, maxima, percentiles, etcetera it is
25        best to collect them now using the v\bva\bar\bri\bia\bab\bbl\ble\be d\bde\bef\bfi\bin\bni\bit\bti\bio\bon\bn statement.  Cur-
26        rently this makes no difference, but in a future version of rrdtool you
27        may want to collect these values before consolidation.
29        The data fetched from the R\bRR\bRA\bA is then c\bco\bon\bns\bso\bol\bli\bid\bda\bat\bte\bed\bd so that there is
30        exactly one datapoint per pixel in the graph. If you do not take care
31        yourself, R\bRR\bRD\bDt\bto\boo\bol\bl will expand the range slightly if necessary. Note, in
32        that case the first and/or last pixel may very well become unknown!
34        Sometimes data is not exactly in the format you would like to display
35        it. For instance, you might be collecting b\bby\byt\bte\bes\bs per second, but want to
36        display b\bbi\bit\bts\bs per second. This is what the d\bda\bat\bta\ba c\bca\bal\blc\bcu\bul\bla\bat\bti\bio\bon\bn command is
37        designed for. After c\bco\bon\bns\bso\bol\bli\bid\bda\bat\bti\bin\bng\bg the data, a copy is made and this
38        copy is modified using a rather powerful R\bRP\bPN\bN command set.
40        When you are done fetching and processing the data, it is time to graph
41        it (or print it).  This ends the r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh sequence.
43 O\bOP\bPT\bTI\bIO\bON\bNS\bS
44        g\bgr\bra\bap\bph\bhv\bv
46        This alternate version of g\bgr\bra\bap\bph\bh takes the same arguments and performs
47        the same function. The _\bv stands for _\bv_\be_\br_\bb_\bo_\bs_\be, which describes the output
48        returned. g\bgr\bra\bap\bph\bhv\bv will return a lot of information about the graph using
49        the same format as rrdtool info (key = value). See the bottom of the
50        document for more information.
52        _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
54        The name and path of the graph to generate. It is recommended to end
55        this in ".png", ".svg" or ".eps", but R\bRR\bRD\bDt\bto\boo\bol\bl does not enforce this.
57        _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be can be '"-"' to send the image to "stdout". In this case, no
58        other output is generated.
60        T\bTi\bim\bme\be r\bra\ban\bng\bge\be
62        [-\b-s\bs|-\b--\b-s\bst\bta\bar\brt\bt _\bt_\bi_\bm_\be] [-\b-e\be|-\b--\b-e\ben\bnd\bd _\bt_\bi_\bm_\be] [-\b-S\bS|-\b--\b-s\bst\bte\bep\bp _\bs_\be_\bc_\bo_\bn_\bd_\bs]
64        The start and end of the time series you would like to display, and
65        which R\bRR\bRA\bA the data should come from.  Defaults are: 1 day ago until
66        now, with the best possible resolution. S\bSt\bta\bar\brt\bt and e\ben\bnd\bd can be specified
67        in several formats, see AT-STYLE TIME SPECIFICATION and rrdgraph_exam-
68        ples.  By default, r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh calculates the width of one pixel in
69        the time domain and tries to get data from an R\bRR\bRA\bA with that resolution.
70        With the s\bst\bte\bep\bp option you can alter this behaviour.  If you want r\brr\brd\bdt\bto\boo\bol\bl
71        g\bgr\bra\bap\bph\bh to get data at a one-hour resolution from the R\bRR\bRD\bD, set s\bst\bte\bep\bp to
72        3'600. Note: a step smaller than one pixel will silently be ignored.
74        L\bLa\bab\bbe\bel\bls\bs
76        [-\b-t\bt|-\b--\b-t\bti\bit\btl\ble\be _\bs_\bt_\br_\bi_\bn_\bg] [-\b-v\bv|-\b--\b-v\bve\ber\brt\bti\bic\bca\bal\bl-\b-l\bla\bab\bbe\bel\bl _\bs_\bt_\br_\bi_\bn_\bg]
78        A horizontal string at the top of the graph and/or a vertically placed
79        string at the left hand side of the graph.
81 Right Axis
82 [-\b--\b-r\bri\big\bgh\bht\bt-\b-a\bax\bxi\bis\bs _\bs_\bc_\ba_\bl_\be:\b:_\bs_\bh_\bi_\bf_\bt] [-\b--\b-r\bri\big\bgh\bht\bt-\b-a\bax\bxi\bis\bs-\b-l\bla\bab\bbe\bel\bl _\bl_\ba_\bb_\be_\bl]
84 A second axis will be drawn to the right of the graph. It is tied to the left
85 axis via the scale and shift parameters. You can also define a label for the
86 right axis.
88 [-\b--\b-r\bri\big\bgh\bht\bt-\b-a\bax\bxi\bis\bs-\b-f\bfo\bor\brm\bma\bat\bt _\bf_\bo_\br_\bm_\ba_\bt_\b-_\bs_\bt_\br_\bi_\bn_\bg]
90 By default the format of the axis lables gets determined automatically. If you
91 want todo this your self, use this option with the same %lf arguments you know
92 from the PRING and GPRINT commands.
94 S\bSi\biz\bze\be
96 [-\b-w\bw|-\b--\b-w\bwi\bid\bdt\bth\bh _\bp_\bi_\bx_\be_\bl_\bs] [-\b-h\bh|-\b--\b-h\bhe\bei\big\bgh\bht\bt _\bp_\bi_\bx_\be_\bl_\bs] [-\b-j\bj|-\b--\b-o\bon\bnl\bly\by-\b-g\bgr\bra\bap\bph\bh]
97 [-\b-D\bD|-\b--\b-f\bfu\bul\bll\bl-\b-s\bsi\biz\bze\be-\b-m\bmo\bod\bde\be]
99 By default, the width and height of the c\bca\ban\bnv\bva\bas\bs (the part with the actual data
100 and such). This defaults to 400 pixels by 100 pixels.
102 If you specify the -\b--\b-f\bfu\bul\bll\bl-\b-s\bsi\biz\bze\be-\b-m\bmo\bod\bde\be option, the width and height specify the
103 final dimensions of the output image and the canvas is automatically resized
104 to fit.
106 If you specify the -\b--\b-o\bon\bnl\bly\by-\b-g\bgr\bra\bap\bph\bh option and set the height < 32 pixels you will
107 get a tiny graph image (thumbnail) to use as an icon for use in an overview,
108 for example. All labeling will be stripped off the graph.
110 L\bLi\bim\bmi\bit\bts\bs
112 [-\b-u\bu|-\b--\b-u\bup\bpp\bpe\ber\br-\b-l\bli\bim\bmi\bit\bt _\bv_\ba_\bl_\bu_\be] [-\b-l\bl|-\b--\b-l\blo\bow\bwe\ber\br-\b-l\bli\bim\bmi\bit\bt _\bv_\ba_\bl_\bu_\be] [-\b-r\br|-\b--\b-r\bri\big\bgi\bid\bd]
114 By default the graph will be autoscaling so that it will adjust the y-axis to
115 the range of the data. You can change this behaviour by explicitly setting the
116 limits. The displayed y-axis will then range at least from l\blo\bow\bwe\ber\br-\b-l\bli\bim\bmi\bit\bt to
117 u\bup\bpp\bpe\ber\br-\b-l\bli\bim\bmi\bit\bt. Autoscaling will still permit those boundaries to be stretched
118 unless the r\bri\big\bgi\bid\bd option is set.
120 [-\b-A\bA|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be]
122 Sometimes the default algorithm for selecting the y-axis scale is not satis-
123 factory. Normally the scale is selected from a predefined set of ranges and
124 this fails miserably when you need to graph something like "260 + 0.001 *
125 sin(x)". This option calculates the minimum and maximum y-axis from the actual
126 minimum and maximum data values. Our example would display slightly less than
127 "260-0.001" to slightly more than "260+0.001" (this feature was contributed by
128 Sasha Mikheev).
130 [-\b-J\bJ|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be-\b-m\bmi\bin\bn]
132 Where "--alt-autoscale" will modify both the absolute maximum AND minimum
133 values, this option will only affect the minimum value. The maximum value, if
134 not defined on the command line, will be 0. This option can be useful when
135 graphing router traffic when the WAN line uses compression, and thus the
136 throughput may be higher than the WAN line speed.
138 [-\b-M\bM|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be-\b-m\bma\bax\bx]
140 Where "--alt-autoscale" will modify both the absolute maximum AND minimum val-
141 ues, this option will only affect the maximum value. The minimum value, if not
142 defined on the command line, will be 0. This option can be useful when graph-
143 ing router traffic when the WAN line uses compression, and thus the throughput
144 may be higher than the WAN line speed.
146 [-\b-N\bN|-\b--\b-n\bno\bo-\b-g\bgr\bri\bid\bdf\bfi\bit\bt]
148 In order to avoid anti-aliasing blurring effects rrdtool snaps points to
149 device resolution pixels, this results in a crisper aperance. If this is not
150 to your liking, you can use this switch to turn this behaviour off.
152 Gridfitting is turned off for PDF, EPS, SVG output by default.
154 G\bGr\bri\bid\bd
157 X-Axis
158     [-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd _\bG_\bT_\bM:\b:_\bG_\bS_\bT:\b:_\bM_\bT_\bM:\b:_\bM_\bS_\bT:\b:_\bL_\bT_\bM:\b:_\bL_\bS_\bT:\b:_\bL_\bP_\bR:\b:_\bL_\bF_\bM]
160     [-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
162     The x-axis label is quite complex to configure. If you don't have very
163     special needs it is probably best to rely on the autoconfiguration to get
164     this right. You can specify the string "none" to suppress the grid and
165     labels altogether.
167     The grid is defined by specifying a certain amount of time in the _\b?_\bT_\bM
168     positions. You can choose from "SECOND", "MINUTE", "HOUR", "DAY", "WEEK",
169     "MONTH" or "YEAR". Then you define how many of these should pass between
170     each line or label.  This pair (_\b?_\bT_\bM_\b:_\b?_\bS_\bT) needs to be specified for the
171     base grid (_\bG_\b?_\b?), the major grid (_\bM_\b?_\b?) and the labels (_\bL_\b?_\b?). For the labels
172     you also must define a precision in _\bL_\bP_\bR and a _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be format string in
173     _\bL_\bF_\bM.  _\bL_\bP_\bR defines where each label will be placed. If it is zero, the
174     label will be placed right under the corresponding line (useful for hours,
175     dates etcetera).  If you specify a number of seconds here the label is
176     centered on this interval (useful for Monday, January etcetera).
178      --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
180     This places grid lines every 10 minutes, major grid lines every hour, and
181     labels every 4 hours. The labels are placed under the major grid lines as
182     they specify exactly that time.
184      --x-grid HOUR:8:DAY:1:DAY:1:86400:%A
186     This places grid lines every 8 hours, major grid lines and labels each
187     day. The labels are placed exactly between two major grid lines as they
188     specify the complete day and not just midnight.
190 Y-Axis
191     [-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd _\bg_\br_\bi_\bd _\bs_\bt_\be_\bp:\b:_\bl_\ba_\bb_\be_\bl _\bf_\ba_\bc_\bt_\bo_\br]
193     [-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
195     Y-axis grid lines appear at each _\bg_\br_\bi_\bd _\bs_\bt_\be_\bp interval.  Labels are placed
196     every _\bl_\ba_\bb_\be_\bl _\bf_\ba_\bc_\bt_\bo_\br lines.  You can specify "-y none" to suppress the grid
197     and labels altogether.  The default for this option is to automatically
198     select sensible values.
200     If you have set --y-grid to 'none' not only the labels get supressed, also
201     the space reserved for the labels is removed. You can still add space man-
202     ually if you use the --units-length command to explicitly reserve space.
204     [-\b-Y\bY|-\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd]
206     Place the Y grid dynamically based on the graph's Y range. The algorithm
207     ensures that you always have a grid, that there are enough but not too
208     many grid lines, and that the grid is metric. That is the grid lines are
209     placed every 1, 2, 5 or 10 units. This parameter will also ensure that you
210     get enough decimals displayed even if your graph goes from 69.998 to
211     70.001.  (contributed by Sasha Mikheev).
213     [-\b-o\bo|-\b--\b-l\blo\bog\bga\bar\bri\bit\bth\bhm\bmi\bic\bc]
215     Logarithmic y-axis scaling.
217     [-\b-X\bX|-\b--\b-u\bun\bni\bit\bts\bs-\b-e\bex\bxp\bpo\bon\bne\ben\bnt\bt _\bv_\ba_\bl_\bu_\be]
219     This sets the 10**exponent scaling of the y-axis values. Normally, values
220     will be scaled to the appropriate units (k, M, etc.).  However, you may
221     wish to display units always in k (Kilo, 10e3) even if the data is in the
222     M (Mega, 10e6) range, for instance. Value should be an integer which is a
223     multiple of 3 between -18 and 18 inclusively.  It is the exponent on the
224     units you wish to use. For example, use 3 to display the y-axis values in
225     k (Kilo, 10e3, thousands), use -6 to display the y-axis values in u
226     (Micro, 10e-6, millionths).  Use a value of 0 to prevent any scaling of
227     the y-axis values.
229     This option is very effective at confusing the heck out of the default
230     rrdtool autoscaler and grid painter. If rrdtool detects that it is not
231     successful in labeling the graph under the given circumstances, it will
232     switch to the more robust -\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd mode.
234     [-\b-L\bL|-\b--\b-u\bun\bni\bit\bts\bs-\b-l\ble\ben\bng\bgt\bth\bh _\bv_\ba_\bl_\bu_\be]
236     How many digits should rrdtool assume the y-axis labels to be? You may
237     have to use this option to make enough space once you start fideling with
238     the y-axis labeling.
240     [-\b--\b-u\bun\bni\bit\bts\bs=\b=s\bsi\bi]
242     With this option y-axis values on logarithmic graphs will be scaled to the
243     appropriate units (k, M, etc.) instead of using exponential notation.
244     Note that for linear graphs, SI notation is used by default.
246 M\bMi\bis\bsc\bce\bel\bll\bla\ban\bne\beo\bou\bus\bs
248 [-\b-z\bz|-\b--\b-l\bla\baz\bzy\by]
250 Only generate the graph if the current graph is out of date or not existent.
251 Note, that only the image size will be returned, if you run with lazy even
252 when using graphv and even when using PRINT.
254 [-\b-f\bf|-\b--\b-i\bim\bmg\bgi\bin\bnf\bfo\bo _\bp_\br_\bi_\bn_\bt_\bf_\bs_\bt_\br]
256 After the image has been created, the graph function uses printf together with
257 this format string to create output similar to the PRINT function, only that
258 the printf function is supplied with the parameters _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be, _\bx_\bs_\bi_\bz_\be and _\by_\bs_\bi_\bz_\be.
259 In order to generate an I\bIM\bMG\bG tag suitable for including the graph into a web
260 page, the command line would look like this:
262  --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
264 [-\b-c\bc|-\b--\b-c\bco\bol\blo\bor\br _\bC_\bO_\bL_\bO_\bR_\bT_\bA_\bG#_\br_\br_\bg_\bg_\bb_\bb[_\ba_\ba]]
266 Override the default colors for the standard elements of the graph. The _\bC_\bO_\bL_\b-
267 _\bO_\bR_\bT_\bA_\bG is one of "BACK" background, "CANVAS" for the background of the actual
268 graph, "SHADEA" for the left and top border, "SHADEB" for the right and bottom
269 border, "GRID", "MGRID" for the major grid, "FONT" for the color of the font,
270 "AXIS" for the axis of the graph, "FRAME" for the line around the color spots,
271 and finally "ARROW" for the arrow head pointing up and forward. Each color is
272 composed out of three hexadecimal numbers specifying its rgb color component
273 (00 is off, FF is maximum) of red, green and blue. Optionally you may add
274 another hexadecimal number specifying the transparency (FF is solid). You may
275 set this option several times to alter multiple defaults.
277 A green arrow is made by: "--color ARROW#00FF00"
279 [-\b--\b-z\bzo\boo\bom\bm _\bf_\ba_\bc_\bt_\bo_\br]
281 Zoom the graphics by the given amount. The factor must be > 0
283 [-\b-n\bn|-\b--\b-f\bfo\bon\bnt\bt _\bF_\bO_\bN_\bT_\bT_\bA_\bG:\b:_\bs_\bi_\bz_\be:\b:[_\bf_\bo_\bn_\bt]]
285 This lets you customize which font to use for the various text elements on the
286 RRD graphs. "DEFAULT" sets the default value for all elements, "TITLE" for the
287 title, "AXIS" for the axis labels, "UNIT" for the vertical unit label, "LEG-
288 END" for the graph legend, "WATERMARK" for the watermark on the edge of the
289 graph.
291 Use Times for the title: "--font TITLE:13:Times"
293 If you do not give a font string you can modify just the sice of the default
294 font: "--font TITLE:13:".
296 If you specify the size 0 then you can modify just the font without touching
297 the size. This is especially usefull for altering the default font without
298 resetting the default fontsizes: "--font DEFAULT:0:Courier".
300 RRDtool comes with a preset default font. You can set the environment variable
301 "RRD_DEFAULT_FONT" if you want to change this.
303 RRDtool uses Pango for its font handling. This means you can to use the full
304 Pango syntax when selecting your font:
306 The font name has the form "[_\bF_\bA_\bM_\bI_\bL_\bY_\b-_\bL_\bI_\bS_\bT] [_\bS_\bT_\bY_\bL_\bE_\b-_\bO_\bP_\bT_\bI_\bO_\bN_\bS] [_\bS_\bI_\bZ_\bE]", where _\bF_\bA_\bM_\b-
307 _\bI_\bL_\bY_\b-_\bL_\bI_\bS_\bT is a comma separated list of families optionally terminated by a
308 comma, _\bS_\bT_\bY_\bL_\bE_\b__\bO_\bP_\bT_\bI_\bO_\bN_\bS is a whitespace separated list of words where each WORD
309 describes one of style, variant, weight, stretch, or gravity, and _\bS_\bI_\bZ_\bE is a
310 decimal number (size in points) or optionally followed by the unit modifier
311 "px" for absolute size. Any one of the options may be absent.
313 [-\b-R\bR|-\b--\b-f\bfo\bon\bnt\bt-\b-r\bre\ben\bnd\bde\ber\br-\b-m\bmo\bod\bde\be {n\bno\bor\brm\bma\bal\bl,l\bli\big\bgh\bht\bt,m\bmo\bon\bno\bo}]
315 There are 3 font render modes:
317 n\bno\bor\brm\bma\bal\bl: Full Hinting and Antialiasing (default)
319 l\bli\big\bgh\bht\bt: Slight Hinting and Antialiasing
321 m\bmo\bon\bno\bo: Full Hinting and NO Antialiasing
323 [-\b-B\bB|-\b--\b-f\bfo\bon\bnt\bt-\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-t\bth\bhr\bre\bes\bsh\bho\bol\bld\bd _\bs_\bi_\bz_\be]
325 (this gets ignored in 1.3 for now!)
327 This specifies the largest font size which will be rendered bitmapped, that
328 is, without any font smoothing. By default, no text is rendered bitmapped.
330 [-\b-P\bP|-\b--\b-p\bpa\ban\bng\bgo\bo-\b-m\bma\bar\brk\bku\bup\bp]
332 All text in rrdtool is rendered using Pango. With the -\b--\b-p\bpa\ban\bng\bgo\bo-\b-m\bma\bar\brk\bku\bup\bp option,
333 all text will be processed by pango markup. This allows to embed some simple
334 html like markup tags using
336  <span key="value">text</span>
338 Apart from the verbose syntax, there are also the following short tags avail-
339 able.
341  b     Bold
342  big   Makes font relatively larger, equivalent to <span size="larger">
343  i     Italic
344  s     Strikethrough
345  sub   Subscript
346  sup   Superscript
347  small Makes font relatively smaller, equivalent to <span size="smaller">
348  tt    Monospace font
349  u     Underline
351 More details on <http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFor-
352 mat.html>.
354 [-\b-G\bG|-\b--\b-g\bgr\bra\bap\bph\bh-\b-r\bre\ben\bnd\bde\ber\br-\b-m\bmo\bod\bde\be {n\bno\bor\brm\bma\bal\bl,m\bmo\bon\bno\bo}]
356 There are 2 render modes:
358 n\bno\bor\brm\bma\bal\bl: Graphs are fully Antialiased (default)
360 m\bmo\bon\bno\bo: No Antialiasing
362 [-\b-E\bE|-\b--\b-s\bsl\blo\bop\bpe\be-\b-m\bmo\bod\bde\be]
364 RRDtool graphs are composed of stair case curves by default. This is in line
365 with the way RRDtool calculates its data. Some people favor a more 'organic'
366 look for their graphs even though it is not all that true.
368 [-\b-a\ba|-\b--\b-i\bim\bmg\bgf\bfo\bor\brm\bma\bat\bt P\bPN\bNG\bG|S\bSV\bVG\bG|E\bEP\bPS\bS|P\bPD\bDF\bF]
370 Image format for the generated graph. For the vector formats you can choose
371 among the standard Postscript fonts Courier-Bold, Courier-BoldOblique,
372 Courier-Oblique, Courier, Helvetica-Bold, Helvetica-BoldOblique, Hel-
373 vetica-Oblique, Helvetica, Symbol, Times-Bold, Times-BoldItalic, Times-Italic,
374 Times-Roman, and ZapfDingbats.
376 [-\b-i\bi|-\b--\b-i\bin\bnt\bte\ber\brl\bla\bac\bce\bed\bd]
378 (this gets ignored in 1.3 for now!)
380 If images are interlaced they become visible on browsers more quickly.
382 [-\b-g\bg|-\b--\b-n\bno\bo-\b-l\ble\beg\bge\ben\bnd\bd]
384 Suppress generation of the legend; only render the graph.
386 [-\b-F\bF|-\b--\b-f\bfo\bor\brc\bce\be-\b-r\bru\bul\ble\bes\bs-\b-l\ble\beg\bge\ben\bnd\bd]
388 Force the generation of HRULE and VRULE legends even if those HRULE or VRULE
389 will not be drawn because out of graph boundaries (mimics behaviour of pre
390 1.0.42 versions).
392 [-\b-T\bT|-\b--\b-t\bta\bab\bbw\bwi\bid\bdt\bth\bh _\bv_\ba_\bl_\bu_\be]
394 By default the tab-width is 40 pixels, use this option to change it.
396 [-\b-b\bb|-\b--\b-b\bba\bas\bse\be _\bv_\ba_\bl_\bu_\be]
398 If you are graphing memory (and NOT network traffic) this switch should be set
399 to 1024 so that one Kb is 1024 byte. For traffic measurement, 1 kb/s is 1000
400 b/s.
402 [-\b-W\bW|-\b--\b-w\bwa\bat\bte\ber\brm\bma\bar\brk\bk _\bs_\bt_\br_\bi_\bn_\bg]
404 Adds the given string as a watermark, horizontally centred, at the bottom of
405 the graph.
407 D\bDa\bat\bta\ba a\ban\bnd\bd v\bva\bar\bri\bia\bab\bbl\ble\bes\bs
409 D\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\br_\br_\bd_\bf_\bi_\bl_\be:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bC_\bF[:\b:s\bst\bte\bep\bp=\b=_\bs_\bt_\be_\bp][:\b:s\bst\bta\bar\brt\bt=\b=_\bt_\bi_\bm_\be][:\b:e\ben\bnd\bd=\b=_\bt_\bi_\bm_\be]
411 C\bCD\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
413 V\bVD\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
415 You need at least one D\bDE\bEF\bF statement to generate anything. The other statements
416 are useful but optional.  See rrdgraph_data and rrdgraph_rpn for the exact
417 format.
419 NOTE: G\bGr\bra\bap\bph\bh a\ban\bnd\bd p\bpr\bri\bin\bnt\bt e\bel\ble\bem\bme\ben\bnt\bts\bs
421 You need at least one graph element to generate an image and/or at least one
422 print statement to generate a report.  See rrdgraph_graph for the exact for-
423 mat.
425 g\bgr\bra\bap\bph\bhv\bv
427 Calling rrdtool with the graphv option will return information in the rrdtool
428 info format. On the command line this means that all output will be in
429 key=value format. When used from the perl and ruby bindings a hash pointer
430 will be returned from the call.
432 When the filename '-' is given, the contents of the graph itself will also be
433 returned through this interface (hash key 'image'). On the command line the
434 output will look like this:
436  print[0] = "0.020833"
437  print[1] = "0.0440833"
438  graph_left = 51
439  graph_top = 22
440  graph_width = 400
441  graph_height = 100
442  image_width = 481
443  image_height = 154
444  value_min = 0.0000000000e+00
445  value_max = 4.0000000000e-02
446  image = BLOB_SIZE:8196
447  [... 8196 bytes of image data ...]
449 There is more information returned than in the standard interface.  Especially
450 the 'graph_*' keys are new. They help applications that want to know what is
451 where on the graph.
453 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
454        rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works.  rrdgraph_data
455        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
456        language used in the ?\b?D\bDE\bEF\bF statements.  rrdgraph_graph page describes
457        all of the graph and print functions.
459        Make sure to read rrdgraph_examples for tips&tricks.
461 A\bAU\bUT\bTH\bHO\bOR\bR
462        Program by Tobias Oetiker <tobi@oetiker.ch>
464        This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
468 1.3.5                             2008-12-09                       RRDGRAPH(1)