![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt
index 4c8686a42b70a01712f16e4adc6587921e98adc5..d1a493afee18104d552f14f657cfa8ec4fd8df53 100644 (file)
--- a/doc/rrdgraph.txt
+++ b/doc/rrdgraph.txt
it. For instance, you might be collecting b\bby\byt\bte\bes\bs per second, but want to
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
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
- copy is modified using a rather powerful R\bRP\bPN\bN command set.
+ copy is modified using a rather powerful rrdgraph_rpn command set.
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.
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 speci-
- fied in several formats, see AT-STYLE TIME SPECIFICATION and rrd-
- graph_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.
+ fied in several formats, see rrdfetch 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.
Labels
[-\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]
ear scales where -\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be is needed. Using -\b--\b-n\bno\bo-\b-g\bgr\bri\bid\bdf\bfi\bit\bt
disables modification of the scale.
- Grid
- 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]
+ X-Grid
+ [-\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]
+ [-\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
- autoconfiguration to get this right. You can specify the string
- "none" to suppress the grid and labels altogether.
+ 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.
- 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 corre-
- sponding line (useful for hours, dates etcetera). If you spec-
- ify a number of seconds here the label is centered on this
- interval (useful for Monday, January etcetera).
+ 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 MINUTE:10:HOUR:1:HOUR:4:0:%X
+ --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
- 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.
+ 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.
- --x-grid HOUR:8:DAY:1:DAY:1:0:%A
+ --x-grid HOUR:8:DAY:1:DAY:1:0:%A
- 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 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
- [-\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]
+ Y-Grid
+ [-\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]
+ [-\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 automatically select sensible values.
+ 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.
- 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.
+ 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-Y\bY|-\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd]
+ [-\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
- algorithm ensures that you always have a grid, that there are
- enough but not too many grid lines, and that the grid is met-
- ric. That is the grid lines are placed every 1, 2, 5 or 10
- units. This parameter will also ensure that you get enough dec-
- imals 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-o\bo|-\b--\b-l\blo\bog\bga\bar\bri\bit\bth\bhm\bmi\bic\bc]
- Logarithmic y-axis scaling.
+ Logarithmic y-axis scaling.
- [-\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-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. Nor-
- mally, 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 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.
- 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.
+ 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-L\bL|-\b--\b-u\bun\bni\bit\bts\bs-\b-l\ble\ben\bng\bgt\bth\bh _\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]
- 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.
+ 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.
- [-\b--\b-u\bun\bni\bit\bts\bs=\b=s\bsi\bi]
+ [-\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 notation. Note that for linear graphs, SI notation
- is used by default.
+ 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.
Miscellaneous
[-\b-z\bz|-\b--\b-l\bla\baz\bzy\by]
-1.2.26 2007-11-20 RRDGRAPH(1)
+1.2.27 2008-02-17 RRDGRAPH(1)