![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt
index 8c7717da9689d68f1e8177b692c585770454eb9c..380aeb3ee4d23b15c260ee4c892a38dad5d5a6f4 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 ...]
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.
- Currently this makes no difference, but in a future version of rrdtool
+ 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!
in several formats, see AT-STYLE TIME SPECIFICATION and
rrdgraph_examples. By default, r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh calculates the width of
one pixel in the time domain and tries to get data from an R\bRR\bRA\bA with
- that resolution. With the s\bst\bte\bep\bp option you can alter this behaviour.
- If you want r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh to get data at a one-hour resolution from the
+ 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.
[-\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-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
+ 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.
- Gridfitting is turned off for PDF, EPS, SVG output by default.
+ Grid-fitting 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]
[-\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
+ 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.
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.
+ 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-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
+ 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-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
+ 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 PRING and GPRINT commands.
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).
+ 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)]
Only generate the graph if the current graph is out of date or not
existent. Note, that all the calculations will happen regardless so
that the output of PRINT and graphv will be complete regardless. Note
- that the behaviour of lazy in this regard has seen several changes over
- time. The only thing you can realy 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.
+ 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]
A green arrow is made by: "--color ARROW#00FF00"
+ [-\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
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
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]
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
+ 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.
-1.3.999 2009-09-24 RRDGRAPH(1)
+1.4.2 2009-10-27 RRDGRAPH(1)