![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt
index dcecb50f3cc5fa2d07f8b449c7800fd2d1335889..8c7717da9689d68f1e8177b692c585770454eb9c 100644 (file)
--- a/doc/rrdgraph.txt
+++ b/doc/rrdgraph.txt
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.
+ 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.
A horizontal string at the top of the graph and/or a vertically placed
string at the left hand side of the graph.
- R\bRi\big\bgh\bht\bt 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
- the left axis via the scale and shift parameters. You can also define a
- label for the right axis.
-
- [-\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]
-
- By default the format of the axis lables gets determined automatically.
- If you want todo this your self, use this option with the same %lf
- arguments you know from the PRING and GPRINT commands.
-
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]
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]
+ 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]
+ [-\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 autoconfiguration to
+ get this right. You can specify the string "none" to suppress 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).
+ 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:86400:%A
+ --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.
+ 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\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]
+ [-\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 suppress 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
- 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.
+ 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-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 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-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. 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 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 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 fiddling
+ 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.
+
+ 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
+ the left axis via the scale and shift parameters. You can also define a
+ label for the right axis.
+
+ [-\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]
+
+ By default the format of the axis lables gets determined automatically.
+ 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
+ [-\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--\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]
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]
After the image has been created, the graph function uses printf
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
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:".
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.
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
-1.3.8 2009-04-07 RRDGRAPH(1)
+1.3.999 2009-09-24 RRDGRAPH(1)