![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt
index 641c1fd28ab166ea77b7c4586e2d42084bf6d94f..3adf75aecbd1e72cf21198cda9202bdd7c4abba0 100644 (file)
--- a/doc/rrdgraph.txt
+++ b/doc/rrdgraph.txt
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 per-
- forms 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.
-
- filename
- 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.
-
- Time range
- [-\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 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.
-
- 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]
-
- A horizontal string at the top of the graph and/or a vertically
- placed string at the left hand side of the graph.
-
- Size
- [-\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
- 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 pix-
- els 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.
-
- Limits
- [-\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
- 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-A\bA|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be]
-
- Sometimes the default algorithm for selecting the y-axis scale is
- not satisfactory. Normally the scale is selected from a predefined
- set of ranges and this fails miserably when you need to graph some-
- thing like "260 + 0.001 * sin(x)". This option calculates the mini-
- mum and maximum y-axis from the actual minimum and maximum data
- values. Our example would display slightly less than "260-0.001" to
- slightly more than "260+0.001" (this feature was contributed by
- Sasha Mikheev).
- [-\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]
+ 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
+
+ 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
+
+ [-\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
+
+ [-\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
+
+ [-\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-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
+
+ [-\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]
- 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
- 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.
+ 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
+ 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-N\bN|-\b--\b-n\bno\bo-\b-g\bgr\bri\bid\bdf\bfi\bit\bt]
+ [-\b-A\bA|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be]
- In order to avoid anti-aliasing blurring effects rrdtool snaps
- points to device resolution pixels, this results in a crisper aper-
- ance. If this is not to your liking, you can use this switch to
- turn this behaviour off.
+ Sometimes the default algorithm for selecting the y-axis scale is not
+ satisfactory. Normally the scale is selected from a predefined set of
+ ranges and this fails miserably when you need to graph something like
+ "260 + 0.001 * sin(x)". This option calculates the minimum and maximum
+ y-axis from the actual minimum and maximum data values. Our example
+ would display slightly less than "260-0.001" to slightly more than
+ "260+0.001" (this feature was contributed by Sasha Mikheev).
- Gridfitting is turned off for PDF, EPS, SVG output by default.
-
- 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]
+ [-\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]
- [-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
+ 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.
- 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.
+ [-\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]
- 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).
-
- --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.
-
- --x-grid HOUR:8:DAY:1:DAY:1:86400:%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.
+ 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.
- 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]
+ [-\b-N\bN|-\b--\b-n\bno\bo-\b-g\bgr\bri\bid\bdf\bfi\bit\bt]
- [-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
+ In order to avoid anti-aliasing blurring effects rrdtool snaps points
+ to device resolution pixels, this results in a crisper aperance. If
+ this is not to your liking, you can use this switch to turn this
+ behaviour off.
- 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.
+ Gridfitting is turned off for PDF, EPS, SVG output by default.
+
+ G\bGr\bri\bid\bd
+
+
+ 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]
+
+ [-\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 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 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
+
+ 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:86400:%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.
+
+ 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]
+
+ [-\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 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.
+
+ [-\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 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 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).
+ [-\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.). 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.
- Logarithmic y-axis scaling.
+ 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-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. 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.
+ 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.
- 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.
+ M\bMi\bis\bsc\bce\bel\bll\bla\ban\bne\beo\bou\bus\bs
- [-\b--\b-u\bun\bni\bit\bts\bs=\b=s\bsi\bi]
+ [-\b-z\bz|-\b--\b-l\bla\baz\bzy\by]
- 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.
+ Only generate the graph if the current graph is out of date or not
+ existent.
- Miscellaneous
- [-\b-z\bz|-\b--\b-l\bla\baz\bzy\by]
+ [-\b-f\bf|-\b--\b-i\bim\bmg\bgi\bin\bnf\bfo\bo _\bp_\br_\bi_\bn_\bt_\bf_\bs_\bt_\br]
- Only generate the graph if the current graph is out of date or not
- existent.
+ After the image has been created, the graph function uses printf
+ together with this format string to create output similar to the PRINT
+ function, only that 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. In order to generate an I\bIM\bMG\bG tag suitable for
+ including the graph into a web page, the command line would look like
+ this:
- [-\b-f\bf|-\b--\b-i\bim\bmg\bgi\bin\bnf\bfo\bo _\bp_\br_\bi_\bn_\bt_\bf_\bs_\bt_\br]
+ --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
- After the image has been created, the graph function uses printf
- together with this format string to create output similar to the
- PRINT function, only that 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. In order to generate an I\bIM\bMG\bG
- tag suitable for including the graph into a web page, the command
- line would look like this:
+ [-\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]]
- --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
+ Override the default colors for the standard elements of the graph. The
+ _\bC_\bO_\bL_\bO_\bR_\bT_\bA_\bG is one of "BACK" background, "CANVAS" for the background of
+ 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.
- [-\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]]
+ A green arrow is made by: "--color ARROW#00FF00"
- Override the default colors for the standard elements of the graph.
- The _\bC_\bO_\bL_\bO_\bR_\bT_\bA_\bG is one of "BACK" background, "CANVAS" for the back-
- ground of 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 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.
+ [-\b--\b-z\bzo\boo\bom\bm _\bf_\ba_\bc_\bt_\bo_\br]
- A green arrow is made by: "--color ARROW#00FF00"
+ Zoom the graphics by the given amount. The factor must be > 0
- [-\b--\b-z\bzo\boo\bom\bm _\bf_\ba_\bc_\bt_\bo_\br]
+ [-\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]]
- 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.
- [-\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]]
+ Use Times for the title: "--font TITLE:13:Times"
- This lets you customize which font to use for the various text ele-
- ments on the RRD graphs. "DEFAULT" sets the default value for all
- elements, "TITLE" for the title, "AXIS" for the axis labels, "UNIT"
- for the vertical unit label, "LEGEND" for the graph legend.
+ If you do not give a font string you can modify just the sice of the
+ default font: "--font TITLE:13:".
- Use Times for the title: "--font TITLE:13:Times"
+ 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
+ font without resetting the default fontsizes: "--font
+ DEFAULT:0:Courier".
- If you do not give a font string you can modify just the sice of
- the default font: "--font TITLE:13:".
+ RRDtool comes with a preset default font. You can set the environment
+ variable "RRD_DEFAULT_FONT" if you want to change this.
- 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 font without resetting the default fontsizes: "--font
- DEFAULT:0:Courier".
+ RRDtool uses Pango for its font handling. This means you can to use the
+ full Pango syntax when selecting your font:
- RRDtool comes with a preset default font. You can set the environ-
- ment variable "RRD_DEFAULT_FONT" if you want to change this.
+ 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
+ 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
+ options may be absent.
- RRDtool uses Pango for its font handling. This means you can to use
- the full Pango syntax when selecting your font:
+ [-\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}]
- 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
- 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 options may be absent.
+ There are 3 font render modes:
- [-\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}]
+ n\bno\bor\brm\bma\bal\bl: Full Hinting and Antialiasing (default)
- There are 3 font render modes:
+ l\bli\big\bgh\bht\bt: Slight Hinting and Antialiasing
- n\bno\bor\brm\bma\bal\bl: Full Hinting and Antialiasing (default)
+ m\bmo\bon\bno\bo: Full Hinting and NO Antialiasing
- l\bli\big\bgh\bht\bt: Slight Hinting and Antialiasing
+ [-\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]
- m\bmo\bon\bno\bo: Full Hinting and NO Antialiasing
+ (this gets ignored in 1.3 for now!)
- [-\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]
+ This specifies the largest font size which will be rendered bitmapped,
+ that is, without any font smoothing. By default, no text is rendered
+ bitmapped.
- (this gets ignored in 1.3 for now!)
+ [-\b-P\bP|-\b--\b-p\bpa\ban\bng\bgo\bo-\b-m\bma\bar\brk\bku\bup\bp]
- This specifies the largest font size which will be rendered
- bitmapped, that is, without any font smoothing. By default, no text
- is rendered bitmapped.
+ 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
- [-\b-P\bP|-\b--\b-p\bpa\ban\bng\bgo\bo-\b-m\bma\bar\brk\bku\bup\bp]
+ <span key="value">text</span>
- 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
+ Apart from the verbose syntax, there are also the following short tags
+ available.
- <span key="value">text</span>
+ b Bold
+ big Makes font relatively larger, equivalent to <span size="larger">
+ i Italic
+ s Strikethrough
+ sub Subscript
+ sup Superscript
+ small Makes font relatively smaller, equivalent to <span size="smaller">
+ tt Monospace font
+ u Underline
- Apart from the verbose syntax, there are also the following short
- tags available.
+ More details on <http://developer.gnome.org/doc/API/2.0/pango/Pango-
+ MarkupFormat.html>.
- b Bold
- big Makes font relatively larger, equivalent to <span size="larger">
- i Italic
- s Strikethrough
- sub Subscript
- sup Superscript
- small Makes font relatively smaller, equivalent to <span size="smaller">
- tt Monospace font
- u Underline
+ [-\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}]
- More details on <http://developer.gnome.org/doc/API/2.0/pango/Pan-
- goMarkupFormat.html>.
+ There are 2 render modes:
- [-\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}]
+ n\bno\bor\brm\bma\bal\bl: Graphs are fully Antialiased (default)
- There are 2 render modes:
+ m\bmo\bon\bno\bo: No Antialiasing
- n\bno\bor\brm\bma\bal\bl: Graphs are fully Antialiased (default)
+ [-\b-E\bE|-\b--\b-s\bsl\blo\bop\bpe\be-\b-m\bmo\bod\bde\be]
- m\bmo\bon\bno\bo: No Antialiasing
+ RRDtool graphs are composed of stair case curves by default. This is in
+ line with the way RRDtool calculates its data. Some people favor a more
+ 'organic' look for their graphs even though it is not all that true.
- [-\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]
- RRDtool graphs are composed of stair case curves by default. This
- is in line with the way RRDtool calculates its data. Some people
- favor a more 'organic' look for their graphs even though it is not
- all that true.
+ 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.
- [-\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]
+ [-\b-i\bi|-\b--\b-i\bin\bnt\bte\ber\brl\bla\bac\bce\bed\bd]
- 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 ZapfD-
- ingbats.
+ (this gets ignored in 1.3 for now!)
- [-\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.
- (this gets ignored in 1.3 for now!)
+ [-\b-g\bg|-\b--\b-n\bno\bo-\b-l\ble\beg\bge\ben\bnd\bd]
- If images are interlaced they become visible on browsers more
- quickly.
+ Suppress generation of the legend; only render the graph.
- [-\b-g\bg|-\b--\b-n\bno\bo-\b-l\ble\beg\bge\ben\bnd\bd]
+ [-\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]
- Suppress generation of the legend; only render the graph.
+ 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-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]
+ [-\b-T\bT|-\b--\b-t\bta\bab\bbw\bwi\bid\bdt\bth\bh _\bv_\ba_\bl_\bu_\be]
- 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).
+ By default the tab-width is 40 pixels, use this option to change it.
- [-\b-T\bT|-\b--\b-t\bta\bab\bbw\bwi\bid\bdt\bth\bh _\bv_\ba_\bl_\bu_\be]
+ [-\b-b\bb|-\b--\b-b\bba\bas\bse\be _\bv_\ba_\bl_\bu_\be]
- By default the tab-width is 40 pixels, use this option to change
- it.
+ If you are graphing memory (and NOT network traffic) this switch should
+ be set to 1024 so that one Kb is 1024 byte. For traffic measurement, 1
+ kb/s is 1000 b/s.
- [-\b-b\bb|-\b--\b-b\bba\bas\bse\be _\bv_\ba_\bl_\bu_\be]
+ [-\b-W\bW|-\b--\b-w\bwa\bat\bte\ber\brm\bma\bar\brk\bk _\bs_\bt_\br_\bi_\bn_\bg]
- If you are graphing memory (and NOT network traffic) this switch
- should be set to 1024 so that one Kb is 1024 byte. For traffic mea-
- surement, 1 kb/s is 1000 b/s.
+ Adds the given string as a watermark, horizontally centred, at the bot-
+ tom of the graph.
- [-\b-W\bW|-\b--\b-w\bwa\bat\bte\ber\brm\bma\bar\brk\bk _\bs_\bt_\br_\bi_\bn_\bg]
+ 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 centred, at the
- bottom of the graph.
+ 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]
- Data and variables
- 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
- 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
- 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 statement to generate anything. The other
- statements are useful but optional. See rrdgraph_data and rrd-
- graph_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
- Graph and print elements
- 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.
+ 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
-1.3rc9 2008-06-05 RRDGRAPH(1)
+1.3.0 2008-06-11 RRDGRAPH(1)