X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdgraph.txt;fp=doc%2Frrdgraph.txt;h=380aeb3ee4d23b15c260ee4c892a38dad5d5a6f4;hb=91b2f1022a195d008d818f283690ef63a00fd79c;hp=8c7717da9689d68f1e8177b692c585770454eb9c;hpb=fa3f1e567e9c848683aefaa1a1f5e68340c7a5f2;p=pkg-rrdtool.git diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt index 8c7717d..380aeb3 100644 --- a/doc/rrdgraph.txt +++ b/doc/rrdgraph.txt @@ -3,7 +3,7 @@ RRDGRAPH(1) rrdtool RRDGRAPH(1) NNAAMMEE - rrdgraph - Round Robin Database tool grapher functions + rrdgraph - Round Robin Database tool graphing functions SSYYNNOOPPSSIISS rrrrddttooooll ggrraapphh||ggrraapphhvv _f_i_l_e_n_a_m_e [_o_p_t_i_o_n ...] [_d_a_t_a _d_e_f_i_n_i_t_i_o_n ...] @@ -23,11 +23,11 @@ OOVVEERRVVIIEEWW If you want to display averages, maxima, percentiles, etcetera it is best to collect them now using the vvaarriiaabbllee ddeeffiinniittiioonn 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 RRRRAA is then ccoonnssoolliiddaatteedd 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, RRRRDDttooooll will expand the range slightly if necessary. Note, in that case the first and/or last pixel may very well become unknown! @@ -61,8 +61,8 @@ OOPPTTIIOONNSS in several formats, see AT-STYLE TIME SPECIFICATION and rrdgraph_examples. By default, rrrrddttooooll ggrraapphh calculates the width of one pixel in the time domain and tries to get data from an RRRRAA with - that resolution. With the sstteepp option you can alter this behaviour. - If you want rrrrddttooooll ggrraapphh to get data at a one-hour resolution from the + that resolution. With the sstteepp option you can alter this behavior. If + you want rrrrddttooooll ggrraapphh to get data at a one-hour resolution from the RRRRDD, set sstteepp to 3'600. Note: a step smaller than one pixel will silently be ignored. @@ -92,7 +92,7 @@ OOPPTTIIOONNSS [--uu|----uuppppeerr--lliimmiitt _v_a_l_u_e] [--ll|----lloowweerr--lliimmiitt _v_a_l_u_e] [--rr|----rriiggiidd] 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 lloowweerr--lliimmiitt to uuppppeerr--lliimmiitt. Autoscaling will still permit those boundaries to be stretched unless the rriiggiidd option is set. @@ -127,12 +127,12 @@ OOPPTTIIOONNSS [--NN|----nnoo--ggrriiddffiitt] - 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. XX--AAxxiiss [--xx|----xx--ggrriidd _G_T_M::_G_S_T::_M_T_M::_M_S_T::_L_T_M::_L_S_T::_L_P_R::_L_F_M] @@ -140,7 +140,7 @@ OOPPTTIIOONNSS [--xx|----xx--ggrriidd nnoonnee] 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. @@ -209,13 +209,13 @@ OOPPTTIIOONNSS 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 ----aalltt--yy--ggrriidd 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 ----aalltt--yy--ggrriidd mode. [--LL|----uunniittss--lleennggtthh _v_a_l_u_e] - 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. @@ -234,8 +234,8 @@ OOPPTTIIOONNSS [----rriigghhtt--aaxxiiss--ffoorrmmaatt _f_o_r_m_a_t_-_s_t_r_i_n_g] - 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. LLeeggeenndd @@ -247,7 +247,7 @@ OOPPTTIIOONNSS 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). [----lleeggeenndd--ppoossiittiioonn=(north|south|west|east)] @@ -266,10 +266,10 @@ OOPPTTIIOONNSS 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. [----ddaaeemmoonn _a_d_d_r_e_s_s] @@ -308,6 +308,15 @@ OOPPTTIIOONNSS A green arrow is made by: "--color ARROW#00FF00" + [----ggrriidd--ddaasshh _o_n::_o_f_f] + + 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 + [----bboorrddeerr _w_i_d_t_h]] Width in pixels for the 3d border drawn around the image. Default 2, 0 @@ -357,11 +366,11 @@ OOPPTTIIOONNSS There are 3 font render modes: - nnoorrmmaall: Full Hinting and Antialiasing (default) + nnoorrmmaall: Full Hinting and Anti-aliasing (default) - lliigghhtt: Slight Hinting and Antialiasing + lliigghhtt: Slight Hinting and Anti-aliasing - mmoonnoo: Full Hinting and NO Antialiasing + mmoonnoo: Full Hinting and NO Anti-aliasing [--BB|----ffoonntt--ssmmooootthhiinngg--tthhrreesshhoolldd _s_i_z_e] @@ -373,7 +382,7 @@ OOPPTTIIOONNSS [--PP|----ppaannggoo--mmaarrkkuupp] - All text in rrdtool is rendered using Pango. With the ----ppaannggoo--mmaarrkkuupp + All text in RRDtool is rendered using Pango. With the ----ppaannggoo--mmaarrkkuupp option, all text will be processed by pango markup. This allows to embed some simple html like markup tags using @@ -399,9 +408,9 @@ OOPPTTIIOONNSS There are 2 render modes: - nnoorrmmaall: Graphs are fully Antialiased (default) + nnoorrmmaall: Graphs are fully Anti-aliased (default) - mmoonnoo: No Antialiasing + mmoonnoo: No Anti-aliasing [--EE|----ssllooppee--mmooddee] @@ -456,8 +465,8 @@ OOPPTTIIOONNSS the exact format. ggrraapphhvv - 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. @@ -509,4 +518,4 @@ AAUUTTHHOORR -1.3.999 2009-09-24 RRDGRAPH(1) +1.4.2 2009-10-27 RRDGRAPH(1)