![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt
index 3adf75aecbd1e72cf21198cda9202bdd7c4abba0..d1ee10b9d8fa9bcf29df86e032d1ff0142b53bcf 100644 (file)
--- a/doc/rrdgraph.txt
+++ b/doc/rrdgraph.txt
N\bNA\bAM\bME\bE
- rrdgraph - Round Robin Database tool grapher functions
+ rrdgraph - Round Robin Database tool graphing functions
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
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 ...]
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
+ exactly one data point per pixel in the graph. If you do not take care
yourself, R\bRR\bRD\bDt\bto\boo\bol\bl will expand the range slightly if necessary. Note, in
that case the first and/or last pixel may very well become unknown!
When you are done fetching and processing the data, it is time to graph
it (or print it). This ends the r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh sequence.
-O\bOP\bPT\bTI\bIO\bON\bNS\bS
- g\bgr\bra\bap\bph\bhv\bv
-
- This alternate version of g\bgr\bra\bap\bph\bh takes the same arguments and performs
- the same function. The _\bv stands for _\bv_\be_\br_\bb_\bo_\bs_\be, which describes the output
- returned. g\bgr\bra\bap\bph\bhv\bv will return a lot of information about the graph using
- the same format as rrdtool info (key = value). See the bottom of the
- document for more information.
-
- _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+ Use g\bgr\bra\bap\bph\bhv\bv instead of g\bgr\bra\bap\bph\bh to get detailed information about the graph
+ geometry and data once it is drawn. See the bottom of the document for
+ more information.
+O\bOP\bPT\bTI\bIO\bON\bNS\bS
+ _\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 behavior. 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
- y-axis to the range of the data. You can change this behaviour by
+ y-axis to the range of the data. You can change this behavior by
explicitly setting the 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 u\bup\bpp\bpe\ber\br-\b-l\bli\bim\bmi\bit\bt. Autoscaling will still permit
those boundaries to be stretched unless the r\bri\big\bgi\bid\bd option is set.
[-\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]
- In order to avoid anti-aliasing blurring effects rrdtool snaps points
- to device resolution pixels, this results in a crisper aperance. If
+ In order to avoid anti-aliasing blurring effects RRDtool snaps points
+ to device resolution pixels, this results in a crisper appearance. If
this is not to your liking, you can use this switch to turn this
- behaviour off.
+ behavior off.
+
+ Grid-fitting is turned off for PDF, EPS, SVG output by default.
- Gridfitting is turned off for PDF, EPS, SVG output by default.
+ 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]
- G\bGr\bri\bid\bd
+ [-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
+ The x-axis label is quite complex to configure. If you don't have very
+ special needs it is probably best to rely on the auto configuration to
+ get this right. You can specify the string "none" to suppress the grid
+ and labels altogether.
- X-Axis
- [-\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]
+ 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
+ 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
+ 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).
- [-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
+ --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
- The x-axis label is quite complex to configure. If you don't have
- very special needs it is probably best to rely on the autoconfigu-
- ration to get this right. You can specify the string "none" to sup-
- press the grid and labels altogether.
+ This places grid lines every 10 minutes, major grid lines every hour,
+ and labels every 4 hours. The labels are placed under the major grid
+ lines as they specify exactly that time.
- 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 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 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 HOUR:8:DAY:1:DAY:1:86400:%A
- --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
+ This places grid lines every 8 hours, major grid lines and labels each
+ day. The labels are placed exactly between two major grid lines as they
+ specify the complete day and not just midnight.
- This places grid lines every 10 minutes, major grid lines every
- hour, and labels every 4 hours. The labels are placed under the
- major grid lines as they specify exactly that time.
+ 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]
- --x-grid HOUR:8:DAY:1:DAY:1:86400:%A
+ [-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
- This places grid lines every 8 hours, major grid lines and labels
- each day. The labels are placed exactly between two major grid
- lines as they specify the complete day and not just midnight.
+ 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
+ automatically select sensible values.
- Y-Axis
- [-\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]
+ 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
+ space manually if you use the --units-length command to explicitly
+ reserve space.
- [-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
+ [-\b-Y\bY|-\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd]
- 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 sup-
- press the grid and labels altogether. The default for this option
- is to automatically select sensible values.
+ 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).
- If you have set --y-grid to 'none' not only the labels get
- supressed, also the space reserved for the labels is removed. You
- can still add space manually if you use the --units-length command
- to explicitly reserve space.
+ [-\b-o\bo|-\b--\b-l\blo\bog\bga\bar\bri\bit\bth\bhm\bmi\bic\bc]
- [-\b-Y\bY|-\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd]
+ Logarithmic y-axis scaling.
- 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-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]
- [-\b-o\bo|-\b--\b-l\blo\bog\bga\bar\bri\bit\bth\bhm\bmi\bic\bc]
+ 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.
- Logarithmic y-axis scaling.
+ This option is very effective at confusing the heck out of the default
+ RRDtool autoscaling function and grid painter. If RRDtool detects that
+ it is not successful in labeling the graph under the given
+ circumstances, it will switch to the more robust -\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd mode.
- [-\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]
+ [-\b-L\bL|-\b--\b-u\bun\bni\bit\bts\bs-\b-l\ble\ben\bng\bgt\bth\bh _\bv_\ba_\bl_\bu_\be]
- This sets the 10**exponent scaling of the y-axis values. Normally,
- values will be scaled to the appropriate units (k, M, etc.). How-
- ever, 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, thou-
- sands), 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.
+ How many digits should RRDtool assume the y-axis labels to be? You may
+ have to use this option to make enough space once you start fiddling
+ with the y-axis labeling.
- 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 successful in labeling the graph under the given
- circumstances, it will switch to the more robust -\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd mode.
+ [-\b--\b-u\bun\bni\bit\bts\bs=\b=s\bsi\bi]
- [-\b-L\bL|-\b--\b-u\bun\bni\bit\bts\bs-\b-l\ble\ben\bng\bgt\bth\bh _\bv_\ba_\bl_\bu_\be]
+ With this option y-axis values on logarithmic graphs will be scaled to
+ the appropriate units (k, M, etc.) instead of using exponential
+ notation. Note that for linear graphs, SI notation is used by default.
- How many digits should rrdtool assume the y-axis labels to be? You
- may have to use this option to make enough space once you start
- fideling with the y-axis labeling.
+ 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]
- [-\b--\b-u\bun\bni\bit\bts\bs=\b=s\bsi\bi]
+ A second axis will be drawn to the right of the graph. It is tied to
+ the left axis via the scale and shift parameters. You can also define a
+ label for the right axis.
- With this option y-axis values on logarithmic graphs will be scaled
- to the appropriate units (k, M, etc.) instead of using exponential
- notation. Note that for linear graphs, SI notation is used by
- default.
+ [-\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]
- M\bMi\bis\bsc\bce\bel\bll\bla\ban\bne\beo\bou\bus\bs
+ By default the format of the axis labels gets determined automatically.
+ If you want to do this your self, use this option with the same %lf
+ arguments you know from the PRINT and GPRINT commands.
+ 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-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]
+
+ Force the generation of HRULE and VRULE legends even if those HRULE or
+ VRULE will not be drawn because out of graph boundaries (mimics
+ behavior of pre 1.0.42 versions).
+
+ [-\b--\b-l\ble\beg\bge\ben\bnd\bd-\b-p\bpo\bos\bsi\bit\bti\bio\bon\bn=(north|south|west|east)]
+
+ Place the legend at the given side of the graph. The default is south.
+ In west or east position it is necessary to add line breaks manually.
+
+ [-\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
+ 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
[-\b-z\bz|-\b--\b-l\bla\baz\bzy\by]
Only generate the graph if the current graph is out of date or not
- existent.
+ existent. Note, that all the calculations will happen regardless so
+ that the output of PRINT and graphv will be complete regardless. Note
+ that the behavior of lazy in this regard has seen several changes over
+ time. The only thing you can really rely on before RRDtool 1.3.7 is
+ that lazy will not generate the graph when it is already there and up
+ to date, and also that it will output the size of the graph.
+
+ [-\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs]
+
+ Address of the rrdcached daemon. If specified, a "flush" command is
+ sent to the server before reading the RRD files. This allows the graph
+ to contain fresh data even if the daemon is configured to cache values
+ for a long time. For a list of accepted formats, see the -\b-l\bl option in
+ the rrdcached manual.
+
+ rrdtool graph [...] --daemon unix:/var/run/rrdcached.sock [...]
[-\b-f\bf|-\b--\b-i\bim\bmg\bgi\bin\bnf\bfo\bo _\bp_\br_\bi_\bn_\bt_\bf_\bs_\bt_\br]
the actual graph, "SHADEA" for the left and top border, "SHADEB" for
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.
+ 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
+ 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-z\bzo\boo\bom\bm _\bf_\ba_\bc_\bt_\bo_\br]
+ [-\b--\b-g\bgr\bri\bid\bd-\b-d\bda\bas\bsh\bh _\bo_\bn:\b:_\bo_\bf_\bf]
+
+ by default the grid is drawn in a 1 on, 1 off pattern. With this option
+ you can set this yourself
+
+ --grid-dash 1:3 for a dot grid
+
+ --grid-dash 1:0 for uninterrupted grid lines
+
+ [-\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-d\bdy\byn\bna\bam\bmi\bic\bc-\b-l\bla\bab\bbe\bel\bls\bs]
+
+ Pick the shape of the color marker next to the label according to the
+ element drawn on the graph.
+
+ [-\b-m\bm|-\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.
+ "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"
- If you do not give a font string you can modify just the sice of the
+ 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:".
If you specify the size 0 then you can modify just the font without
- touching the size. This is especially usefull for altering the default
+ touching the size. This is especially useful for altering the default
font without resetting the default fontsizes: "--font
DEFAULT:0:Courier".
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
There are 3 font render modes:
- n\bno\bor\brm\bma\bal\bl: Full Hinting and Antialiasing (default)
+ n\bno\bor\brm\bma\bal\bl: Full Hinting and Anti-aliasing (default)
- l\bli\big\bgh\bht\bt: Slight Hinting and Antialiasing
+ l\bli\big\bgh\bht\bt: Slight Hinting and Anti-aliasing
- m\bmo\bon\bno\bo: Full Hinting and NO Antialiasing
+ m\bmo\bon\bno\bo: Full Hinting and NO Anti-aliasing
[-\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]
[-\b-P\bP|-\b--\b-p\bpa\ban\bng\bgo\bo-\b-m\bma\bar\brk\bku\bup\bp]
- 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
+ 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, all text will be processed by pango markup. This allows to
embed some simple html like markup tags using
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/pango/stable/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}]
There are 2 render modes:
- n\bno\bor\brm\bma\bal\bl: Graphs are fully Antialiased (default)
+ n\bno\bor\brm\bma\bal\bl: Graphs are fully Anti-aliased (default)
- m\bmo\bon\bno\bo: No Antialiasing
+ m\bmo\bon\bno\bo: No Anti-aliasing
[-\b-E\bE|-\b--\b-s\bsl\blo\bop\bpe\be-\b-m\bmo\bod\bde\be]
[-\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]
If images are interlaced they become visible on browsers more quickly.
- [-\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-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]
-
- Force the generation of HRULE and VRULE legends even if those HRULE or
- VRULE will not be drawn because out of graph boundaries (mimics
- behaviour of pre 1.0.42 versions).
-
[-\b-T\bT|-\b--\b-t\bta\bab\bbw\bwi\bid\bdt\bth\bh _\bv_\ba_\bl_\bu_\be]
By default the tab-width is 40 pixels, use this option to change it.
[-\b-W\bW|-\b--\b-w\bwa\bat\bte\ber\brm\bma\bar\brk\bk _\bs_\bt_\br_\bi_\bn_\bg]
- Adds the given string as a watermark, horizontally centred, at the bot-
- tom of the graph.
-
- D\bDa\bat\bta\ba a\ban\bnd\bd v\bva\bar\bri\bia\bab\bbl\ble\bes\bs
+ 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\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
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
- You need at least one D\bDE\bEF\bF statement to generate anything. The other
- statements are useful but optional. See rrdgraph_data and rrdgraph_rpn
- for the exact format.
+ You need at least one D\bDE\bEF\bF and one L\bLI\bIN\bNE\bE, A\bAR\bRE\bEA\bA, G\bGP\bPR\bRI\bIN\bNT\bT, P\bPR\bRI\bIN\bNT\bT statement
+ to generate anything useful.
+
+ See rrdgraph_data and rrdgraph_rpn for the exact format.
- 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
+ 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
You need at least one graph element to generate an image and/or at
least one print statement to generate a report. See rrdgraph_graph for
the exact format.
- 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
+ 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"
graph_top = 22
graph_width = 400
graph_height = 100
+ graph_start = 1232908800
+ graph_end = 1232914200
image_width = 481
image_height = 154
value_min = 0.0000000000e+00
Especially the 'graph_*' keys are new. They help applications that want
to know what is where on the graph.
+E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
+ The following environment variables may be used to change the behavior
+ of "rrdtool graph":
+
+ R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS
+ If this environment variable is set it will have the same effect as
+ specifying the "--daemon" option on the command line. If both are
+ present, the command line argument takes precedence.
+
S\bSE\bEE\bE A\bAL\bLS\bSO\bO
rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
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
A\bAU\bUT\bTH\bHO\bOR\bR
Program by Tobias Oetiker <tobi@oetiker.ch>
- This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
+ This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl> with
+ corrections and/or additions by several people
-1.3.0 2008-06-11 RRDGRAPH(1)
+1.4.8 2013-05-23 RRDGRAPH(1)