![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt
index 6bb25bc92343feb5e3251312887bd6c0fa1ef545..8c7717da9689d68f1e8177b692c585770454eb9c 100644 (file)
--- a/doc/rrdgraph.txt
+++ b/doc/rrdgraph.txt
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
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
- to a human viewer. Its main purpose is to create a nice graphical rep-
- resentation, but it can also generate a numerical report.
+ to a human viewer. Its main purpose is to create a nice graphical
+ representation, but it can also generate a numerical report.
O\bOV\bVE\bER\bRV\bVI\bIE\bEW\bW
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
databases (one per statement, though).
If you want to display averages, maxima, percentiles, etcetera it is
- 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-
- rently this makes no difference, but in a future version of rrdtool you
- may want to collect these values before consolidation.
+ 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.
+ Currently this makes no difference, but in a future version of rrdtool
+ you may want to collect these values before consolidation.
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
exactly one datapoint per pixel in the graph. If you do not take care
more information.
O\bOP\bPT\bTI\bIO\bON\bNS\bS
- _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
-
+ _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
The name and path of the graph to generate. It is recommended to end
this in ".png", ".svg" or ".eps", but R\bRR\bRD\bDt\bto\boo\bol\bl does not enforce this.
_\bf_\bi_\bl_\be_\bn_\ba_\bm_\be can be '"-"' to send the image to "stdout". In this case, no
other output is generated.
- T\bTi\bim\bme\be r\bra\ban\bng\bge\be
-
+ T\bTi\bim\bme\be r\bra\ban\bng\bge\be
[-\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]
The start and end of the time series you would like to display, and
which R\bRR\bRA\bA the data should come from. Defaults are: 1 day ago until
now, with the best possible resolution. S\bSt\bta\bar\brt\bt and e\ben\bnd\bd can be specified
- in several formats, see AT-STYLE TIME SPECIFICATION and rrdgraph_exam-
- ples. By default, r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh calculates the width of one pixel in
- the time domain and tries to get data from an R\bRR\bRA\bA with that resolution.
- With the s\bst\bte\bep\bp option you can alter this behaviour. If you want r\brr\brd\bdt\bto\boo\bol\bl
- 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
- 3'600. Note: a step smaller than one pixel will silently be ignored.
-
- L\bLa\bab\bbe\bel\bls\bs
-
+ in several formats, see AT-STYLE TIME SPECIFICATION and
+ rrdgraph_examples. By default, r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh calculates the width of
+ one pixel in the time domain and tries to get data from an R\bRR\bRA\bA with
+ that resolution. With the s\bst\bte\bep\bp option you can alter this behaviour.
+ If you want r\brr\brd\bdt\bto\boo\bol\bl 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 3'600. Note: a step smaller than one pixel will
+ silently be ignored.
+
+ L\bLa\bab\bbe\bel\bls\bs
[-\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]
A horizontal string at the top of the graph and/or a vertically placed
string at the left hand side of the graph.
- S\bSi\biz\bze\be
-
+ S\bSi\biz\bze\be
[-\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]
[-\b-D\bD|-\b--\b-f\bfu\bul\bll\bl-\b-s\bsi\biz\bze\be-\b-m\bmo\bod\bde\be]
By default, the width and height of the c\bca\ban\bnv\bva\bas\bs (the part with the
actual data and such). This defaults to 400 pixels by 100 pixels.
- 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 spec-
- ify the final dimensions of the output image and the canvas is automat-
- ically resized to fit.
+ 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 final dimensions of the output image and the canvas is
+ automatically resized to fit.
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 get a tiny graph image (thumbnail) to use as an icon for use
in an overview, for example. All labeling will be stripped off the
graph.
- L\bLi\bim\bmi\bit\bts\bs
-
+ L\bLi\bim\bmi\bit\bts\bs
[-\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]
By default the graph will be autoscaling so that it will adjust the
[-\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]
- Where "--alt-autoscale" will modify both the absolute maximum AND mini-
- mum values, this option will only affect the minimum value. The maximum
- value, if not defined on the command line, will be 0. This option can
- be useful when graphing router traffic when the WAN line uses compres-
- sion, and thus the throughput may be higher than the WAN line speed.
+ Where "--alt-autoscale" will modify both the absolute maximum AND
+ minimum values, this option will only affect the minimum value. The
+ maximum value, if not defined on the command line, will be 0. This
+ option can be useful when graphing router traffic when the WAN line
+ uses compression, and thus the throughput may be higher than the WAN
+ line speed.
[-\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]
- Where "--alt-autoscale" will modify both the absolute maximum AND mini-
- mum values, this option will only affect the maximum value. The minimum
- value, if not defined on the command line, will be 0. This option can
- be useful when graphing router traffic when the WAN line uses compres-
- sion, and thus the throughput may be higher than the WAN line speed.
+ Where "--alt-autoscale" will modify both the absolute maximum AND
+ minimum values, this option will only affect the maximum value. The
+ minimum value, if not defined on the command line, will be 0. This
+ option can be useful when graphing router traffic when the WAN line
+ uses compression, and thus the throughput may be higher than the WAN
+ line speed.
[-\b-N\bN|-\b--\b-n\bno\bo-\b-g\bgr\bri\bid\bdf\bfi\bit\bt]
Gridfitting is turned off for PDF, EPS, SVG output by default.
- X\bX-\b-A\bAx\bxi\bis\bs
-
+ X\bX-\b-A\bAx\bxi\bis\bs
[-\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]
[-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
The grid is defined by specifying a certain amount of time in the _\b?_\bT_\bM
positions. You can choose from "SECOND", "MINUTE", "HOUR", "DAY",
"WEEK", "MONTH" or "YEAR". Then you define how many of these should
- pass between each line or label. This pair (_\b?_\bT_\bM_\b:_\b?_\bS_\bT) needs to be spec-
- ified for the base grid (_\bG_\b?_\b?), the major grid (_\bM_\b?_\b?) and the labels
+ pass between each line or label. This pair (_\b?_\bT_\bM_\b:_\b?_\bS_\bT) needs to be
+ specified for the base grid (_\bG_\b?_\b?), the major grid (_\bM_\b?_\b?) and the labels
(_\bL_\b?_\b?). For the labels you also must define a precision in _\bL_\bP_\bR and a
_\bs_\bt_\br_\bf_\bt_\bi_\bm_\be format string in _\bL_\bF_\bM. _\bL_\bP_\bR defines where each label will be
- placed. If it is zero, the label will be placed right under the corre-
- sponding line (useful for hours, dates etcetera). If you specify a
- number of seconds here the label is centered on this interval (useful
+ placed. If it is zero, the label will be placed right under the
+ corresponding line (useful for hours, dates etcetera). If you specify
+ a number of seconds here the label is centered on this interval (useful
for Monday, January etcetera).
--x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
day. The labels are placed exactly between two major grid lines as they
specify the complete day and not just midnight.
- Y\bY-\b-A\bAx\bxi\bis\bs
-
+ Y\bY-\b-A\bAx\bxi\bis\bs
[-\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]
[-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
Y-axis grid lines appear at each _\bg_\br_\bi_\bd _\bs_\bt_\be_\bp interval. Labels are placed
every _\bl_\ba_\bb_\be_\bl _\bf_\ba_\bc_\bt_\bo_\br lines. You can specify "-y none" to suppress the
- grid and labels altogether. The default for this option is to automat-
- ically select sensible values.
+ grid and labels altogether. The default for this option is to
+ automatically select sensible values.
If you have set --y-grid to 'none' not only the labels get suppressed,
also the space reserved for the labels is removed. You can still add
[-\b-Y\bY|-\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd]
- Place the Y grid dynamically based on the graph's Y range. The algo-
- rithm ensures that you always have a grid, that there are enough but
- not too many grid lines, and that the grid is metric. That is the grid
- lines are placed every 1, 2, 5 or 10 units. This parameter will also
- ensure that you get enough decimals displayed even if your graph goes
- from 69.998 to 70.001. (contributed by Sasha Mikheev).
+ Place the Y grid dynamically based on the graph's Y range. The
+ algorithm ensures that you always have a grid, that there are enough
+ but not too many grid lines, and that the grid is metric. That is the
+ grid lines are placed every 1, 2, 5 or 10 units. This parameter will
+ also ensure that you get enough decimals displayed even if your graph
+ goes from 69.998 to 70.001. (contributed by Sasha Mikheev).
[-\b-o\bo|-\b--\b-l\blo\bog\bga\bar\bri\bit\bth\bhm\bmi\bic\bc]
[-\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]
- This sets the 10**exponent scaling of the y-axis values. Normally, val-
- ues will be scaled to the appropriate units (k, M, etc.). However, you
- may wish to display units always in k (Kilo, 10e3) even if the data is
- in the M (Mega, 10e6) range, for instance. Value should be an integer
- which is a multiple of 3 between -18 and 18 inclusively. It is the
- exponent on the units you wish to use. For example, use 3 to display
- the y-axis values in k (Kilo, 10e3, thousands), use -6 to display the
- y-axis values in u (Micro, 10e-6, millionths). Use a value of 0 to
- prevent any scaling of the y-axis values.
+ This sets the 10**exponent scaling of the y-axis values. Normally,
+ values will be scaled to the appropriate units (k, M, etc.). However,
+ you may wish to display units always in k (Kilo, 10e3) even if the data
+ is in the M (Mega, 10e6) range, for instance. Value should be an
+ integer which is a multiple of 3 between -18 and 18 inclusively. It is
+ the exponent on the units you wish to use. For example, use 3 to
+ display the y-axis values in k (Kilo, 10e3, thousands), use -6 to
+ display the y-axis values in u (Micro, 10e-6, millionths). Use a value
+ of 0 to prevent any scaling of the y-axis values.
This option is very effective at confusing the heck out of the default
rrdtool autoscaler and grid painter. If rrdtool detects that it is not
[-\b--\b-u\bun\bni\bit\bts\bs=\b=s\bsi\bi]
With this option y-axis values on logarithmic graphs will be scaled to
- the appropriate units (k, M, etc.) instead of using exponential nota-
- tion. Note that for linear graphs, SI notation is used by default.
-
- R\bRi\big\bgh\bht\bt Y\bY A\bAx\bxi\bis\bs
+ the appropriate units (k, M, etc.) instead of using exponential
+ notation. Note that for linear graphs, SI notation is used by default.
+ R\bRi\big\bgh\bht\bt Y\bY A\bAx\bxi\bis\bs
[-\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]
A second axis will be drawn to the right of the graph. It is tied to
If you want todo this your self, use this option with the same %lf
arguments you know from the PRING and GPRINT commands.
- L\bLe\beg\bge\ben\bnd\bd
-
+ L\bLe\beg\bge\ben\bnd\bd
[-\b-g\bg|-\b--\b-n\bno\bo-\b-l\ble\beg\bge\ben\bnd\bd]
Suppress generation of the legend; only render the graph.
[-\b--\b-l\ble\beg\bge\ben\bnd\bd-\b-d\bdi\bir\bre\bec\bct\bti\bio\bon\bn=(topdown|bottomup)]
- Place the legend items in the given vertical order. The default is top-
- down. Using bottomup the legend items appear in the same vertical
+ Place the legend items in the given vertical order. The default is
+ topdown. Using bottomup the legend items appear in the same vertical
order as a stack of lines or areas.
- M\bMi\bis\bsc\bce\bel\bll\bla\ban\bne\beo\bou\bus\bs
-
+ M\bMi\bis\bsc\bce\bel\bll\bla\ban\bne\beo\bou\bus\bs
[-\b-z\bz|-\b--\b-l\bla\baz\bzy\by]
Only generate the graph if the current graph is out of date or not
the right and bottom border, "GRID", "MGRID" for the major grid, "FONT"
for the color of the font, "AXIS" for the axis of the graph, "FRAME"
for the line around the color spots, and finally "ARROW" for the arrow
- head pointing up and forward. Each color is composed out of three hex-
- adecimal numbers specifying its rgb color component (00 is off, FF is
- maximum) of red, green and blue. Optionally you may add another hex-
- adecimal number specifying the transparency (FF is solid). You may set
- this option several times to alter multiple defaults.
+ head pointing up and forward. Each color is composed out of three
+ hexadecimal numbers specifying its rgb color component (00 is off, FF
+ is maximum) of red, green and blue. Optionally you may add another
+ hexadecimal number specifying the transparency (FF is solid). You may
+ set this option several times to alter multiple defaults.
A green arrow is made by: "--color ARROW#00FF00"
+ [-\b--\b-b\bbo\bor\brd\bde\ber\br _\bw_\bi_\bd_\bt_\bh]]
+
+ Width in pixels for the 3d border drawn around the image. Default 2, 0
+ disables the border. See "SHADEA" and "SHADEB" above for setting the
+ border color.
+
[-\b--\b-z\bzo\boo\bom\bm _\bf_\ba_\bc_\bt_\bo_\br]
Zoom the graphics by the given amount. The factor must be > 0
This lets you customize which font to use for the various text elements
on the RRD graphs. "DEFAULT" sets the default value for all elements,
- "TITLE" for the title, "AXIS" for the axis labels, "UNIT" for the ver-
- tical unit label, "LEGEND" for the graph legend, "WATERMARK" for the
+ "TITLE" for the title, "AXIS" for the axis labels, "UNIT" for the
+ vertical unit label, "LEGEND" for the graph legend, "WATERMARK" for the
watermark on the edge of the graph.
Use Times for the title: "--font TITLE:13:Times"
+ Note that you need to quote the argument to -\b--\b-f\bfo\bon\bnt\bt if the font-name
+ contains whitespace: --font "TITLE:13:Some Font"
+
If you do not give a font string you can modify just the size of the
default font: "--font TITLE:13:".
full Pango syntax when selecting your font:
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_\bI_\bL_\bY_\b-_\bL_\bI_\bS_\bT is a comma separated list of families optionally ter-
- minated by a comma, _\bS_\bT_\bY_\bL_\bE_\b__\bO_\bP_\bT_\bI_\bO_\bN_\bS is a whitespace separated list of
+ where _\bF_\bA_\bM_\bI_\bL_\bY_\b-_\bL_\bI_\bS_\bT is a comma separated list of families optionally
+ terminated by a comma, _\bS_\bT_\bY_\bL_\bE_\b__\bO_\bP_\bT_\bI_\bO_\bN_\bS is a whitespace separated list of
words where each WORD describes one of style, variant, weight, stretch,
or gravity, and _\bS_\bI_\bZ_\bE is a decimal number (size in points) or optionally
followed by the unit modifier "px" for absolute size. Any one of the
tt Monospace font
u Underline
- More details on <http://developer.gnome.org/doc/API/2.0/pango/Pango-
- MarkupFormat.html>.
+ More details on
+ <http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html>.
[-\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}]
[-\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]
Image format for the generated graph. For the vector formats you can
- choose among the standard Postscript fonts Courier-Bold,
- Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold, Hel-
- vetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol, Times-Bold,
- Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
+ choose among the standard Postscript fonts Courier-Bold, Courier-
+ BoldOblique, Courier-Oblique, Courier, Helvetica-Bold, Helvetica-
+ BoldOblique, Helvetica-Oblique, Helvetica, Symbol, Times-Bold, Times-
+ BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
[-\b-i\bi|-\b--\b-i\bin\bnt\bte\ber\brl\bla\bac\bce\bed\bd]
Adds the given string as a watermark, horizontally centered, at the
bottom of the graph.
- D\bDa\bat\bta\ba a\ban\bnd\bd v\bva\bar\bri\bia\bab\bbl\ble\bes\bs
-
+ D\bDa\bat\bta\ba a\ban\bnd\bd v\bva\bar\bri\bia\bab\bbl\ble\bes\bs
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]
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
least one print statement to generate a report. See rrdgraph_graph for
the exact format.
- g\bgr\bra\bap\bph\bhv\bv
-
+ g\bgr\bra\bap\bph\bhv\bv
Calling rrdtool with the graphv option will return information in the
rrdtool info format. On the command line this means that all output
will be in key=value format. When used from the Perl and Ruby bindings
a hash pointer will be returned from the call.
When the filename '-' is given, the contents of the graph itself will
- also be returned through this interface (hash key 'image'). On the com-
- mand line the output will look like this:
+ also be returned through this interface (hash key 'image'). On the
+ command line the output will look like this:
print[0] = "0.020833"
print[1] = "0.0440833"
-1.3.99909060808 2009-05-21 RRDGRAPH(1)
+1.3.999 2009-09-24 RRDGRAPH(1)