X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdgraph.txt;fp=doc%2Frrdgraph.txt;h=3adf75aecbd1e72cf21198cda9202bdd7c4abba0;hb=3a03e55068747637db4480d4f3a8ab8ef26c50b1;hp=641c1fd28ab166ea77b7c4586e2d42084bf6d94f;hpb=8892808f3a79ec485e273390213ef3f16792eb54;p=pkg-rrdtool.git
diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt
index 641c1fd..3adf75a 100644
--- a/doc/rrdgraph.txt
+++ b/doc/rrdgraph.txt
@@ -42,385 +42,382 @@ OOVVEERRVVIIEEWW
OOPPTTIIOONNSS
ggrraapphhvv
- This alternate version of ggrraapphh takes the same arguments and per-
- forms the same function. The _v stands for _v_e_r_b_o_s_e, which describes
- the output returned. ggrraapphhvv 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 RRRRDDttooooll does not enforce
- this.
-
- _f_i_l_e_n_a_m_e can be '"-"' to send the image to "stdout". In this case,
- no other output is generated.
-
- Time range
- [--ss|----ssttaarrtt _t_i_m_e] [--ee|----eenndd _t_i_m_e] [--SS|----sstteepp _s_e_c_o_n_d_s]
-
- The start and end of the time series you would like to display, and
- which RRRRAA the data should come from. Defaults are: 1 day ago until
- now, with the best possible resolution. SSttaarrtt and eenndd can be speci-
- fied in several formats, see AT-STYLE TIME SPECIFICATION and rrd-
- graph_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 RRRRDD, set sstteepp to 3'600. Note: a step smaller
- than one pixel will silently be ignored.
-
- Labels
- [--tt|----ttiittllee _s_t_r_i_n_g] [--vv|----vveerrttiiccaall--llaabbeell _s_t_r_i_n_g]
-
- A horizontal string at the top of the graph and/or a vertically
- placed string at the left hand side of the graph.
-
- Size
- [--ww|----wwiiddtthh _p_i_x_e_l_s] [--hh|----hheeiigghhtt _p_i_x_e_l_s] [--jj|----oonnllyy--ggrraapphh]
- [--DD|----ffuullll--ssiizzee--mmooddee]
-
- By default, the width and height of the ccaannvvaass (the part with the
- actual data and such). This defaults to 400 pixels by 100 pixels.
-
- If you specify the ----ffuullll--ssiizzee--mmooddee 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 ----oonnllyy--ggrraapphh 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
- [--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
- 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.
-
- [--AA|----aalltt--aauuttoossccaallee]
-
- 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).
- [--JJ|----aalltt--aauuttoossccaallee--mmiinn]
+ This alternate version of ggrraapphh takes the same arguments and performs
+ the same function. The _v stands for _v_e_r_b_o_s_e, which describes the output
+ returned. ggrraapphhvv 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.
+
+ _f_i_l_e_n_a_m_e
+
+ The name and path of the graph to generate. It is recommended to end
+ this in ".png", ".svg" or ".eps", but RRRRDDttooooll does not enforce this.
+
+ _f_i_l_e_n_a_m_e can be '"-"' to send the image to "stdout". In this case, no
+ other output is generated.
+
+ TTiimmee rraannggee
+
+ [--ss|----ssttaarrtt _t_i_m_e] [--ee|----eenndd _t_i_m_e] [--SS|----sstteepp _s_e_c_o_n_d_s]
+
+ The start and end of the time series you would like to display, and
+ which RRRRAA the data should come from. Defaults are: 1 day ago until
+ now, with the best possible resolution. SSttaarrtt and eenndd can be specified
+ in several formats, see AT-STYLE TIME SPECIFICATION and rrdgraph_exam-
+ ples. 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 RRRRDD, set sstteepp to
+ 3'600. Note: a step smaller than one pixel will silently be ignored.
+
+ LLaabbeellss
+
+ [--tt|----ttiittllee _s_t_r_i_n_g] [--vv|----vveerrttiiccaall--llaabbeell _s_t_r_i_n_g]
+
+ A horizontal string at the top of the graph and/or a vertically placed
+ string at the left hand side of the graph.
+
+ SSiizzee
+
+ [--ww|----wwiiddtthh _p_i_x_e_l_s] [--hh|----hheeiigghhtt _p_i_x_e_l_s] [--jj|----oonnllyy--ggrraapphh]
+ [--DD|----ffuullll--ssiizzee--mmooddee]
+
+ By default, the width and height of the ccaannvvaass (the part with the
+ actual data and such). This defaults to 400 pixels by 100 pixels.
+
+ If you specify the ----ffuullll--ssiizzee--mmooddee 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 ----oonnllyy--ggrraapphh 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.
+
+ LLiimmiittss
+
+ [--uu|----uuppppeerr--lliimmiitt _v_a_l_u_e] [--ll|----lloowweerr--lliimmiitt _v_a_l_u_e] [--rr|----rriiggiidd]
- 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.
-
- [--MM|----aalltt--aauuttoossccaallee--mmaaxx]
-
- 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 lloowweerr--lliimmiitt to uuppppeerr--lliimmiitt. Autoscaling will still permit
+ those boundaries to be stretched unless the rriiggiidd option is set.
- [--NN|----nnoo--ggrriiddffiitt]
+ [--AA|----aalltt--aauuttoossccaallee]
- 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
- [--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]
+ [--JJ|----aalltt--aauuttoossccaallee--mmiinn]
- [--xx|----xx--ggrriidd nnoonnee]
+ 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.
+ [--MM|----aalltt--aauuttoossccaallee--mmaaxx]
- The grid is defined by specifying a certain amount of time in
- the _?_T_M 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 (_?_T_M_:_?_S_T) needs to be specified for the base grid (_G_?_?),
- the major grid (_M_?_?) and the labels (_L_?_?). For the labels you
- also must define a precision in _L_P_R and a _s_t_r_f_t_i_m_e format
- string in _L_F_M. _L_P_R 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
- [--yy|----yy--ggrriidd _g_r_i_d _s_t_e_p::_l_a_b_e_l _f_a_c_t_o_r]
+ [--NN|----nnoo--ggrriiddffiitt]
- [--yy|----yy--ggrriidd nnoonnee]
+ 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 _g_r_i_d _s_t_e_p interval. Labels
- are placed every _l_a_b_e_l _f_a_c_t_o_r 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.
+
+ GGrriidd
+
+
+ X-Axis
+ [--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]
+
+ [--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 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
+ _?_T_M 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 (_?_T_M_:_?_S_T) needs
+ to be specified for the base grid (_G_?_?), the major grid (_M_?_?) and
+ the labels (_L_?_?). For the labels you also must define a precision
+ in _L_P_R and a _s_t_r_f_t_i_m_e format string in _L_F_M. _L_P_R 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
+ [--yy|----yy--ggrriidd _g_r_i_d _s_t_e_p::_l_a_b_e_l _f_a_c_t_o_r]
+
+ [--yy|----yy--ggrriidd nnoonnee]
+
+ Y-axis grid lines appear at each _g_r_i_d _s_t_e_p interval. Labels are
+ placed every _l_a_b_e_l _f_a_c_t_o_r 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.
+
+ [--YY|----aalltt--yy--ggrriidd]
+
+ 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.
+ [--oo|----llooggaarriitthhmmiicc]
- [--YY|----aalltt--yy--ggrriidd]
+ 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).
+ [--XX|----uunniittss--eexxppoonneenntt _v_a_l_u_e]
- [--oo|----llooggaarriitthhmmiicc]
+ 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 ----aalltt--yy--ggrriidd mode.
- [--XX|----uunniittss--eexxppoonneenntt _v_a_l_u_e]
+ [--LL|----uunniittss--lleennggtthh _v_a_l_u_e]
- 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 ----aalltt--yy--ggrriidd
- mode.
+ [----uunniittss==ssii]
- [--LL|----uunniittss--lleennggtthh _v_a_l_u_e]
+ 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.
+ MMiisscceellllaanneeoouuss
- [----uunniittss==ssii]
+ [--zz|----llaazzyy]
- 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
- [--zz|----llaazzyy]
+ [--ff|----iimmggiinnffoo _p_r_i_n_t_f_s_t_r]
- 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
+ _f_i_l_e_n_a_m_e, _x_s_i_z_e and _y_s_i_z_e. In order to generate an IIMMGG tag suitable for
+ including the graph into a web page, the command line would look like
+ this:
- [--ff|----iimmggiinnffoo _p_r_i_n_t_f_s_t_r]
+ --imginfo ''
- 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 _f_i_l_e_n_a_m_e, _x_s_i_z_e and _y_s_i_z_e. In order to generate an IIMMGG
- tag suitable for including the graph into a web page, the command
- line would look like this:
+ [--cc|----ccoolloorr _C_O_L_O_R_T_A_G#_r_r_g_g_b_b[_a_a]]
- --imginfo ''
+ Override the default colors for the standard elements of the graph. The
+ _C_O_L_O_R_T_A_G 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.
- [--cc|----ccoolloorr _C_O_L_O_R_T_A_G#_r_r_g_g_b_b[_a_a]]
+ A green arrow is made by: "--color ARROW#00FF00"
- Override the default colors for the standard elements of the graph.
- The _C_O_L_O_R_T_A_G 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.
+ [----zzoooomm _f_a_c_t_o_r]
- A green arrow is made by: "--color ARROW#00FF00"
+ Zoom the graphics by the given amount. The factor must be > 0
- [----zzoooomm _f_a_c_t_o_r]
+ [--nn|----ffoonntt _F_O_N_T_T_A_G::_s_i_z_e::[_f_o_n_t]]
- 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.
- [--nn|----ffoonntt _F_O_N_T_T_A_G::_s_i_z_e::[_f_o_n_t]]
+ 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 "[_F_A_M_I_L_Y_-_L_I_S_T] [_S_T_Y_L_E_-_O_P_T_I_O_N_S] [_S_I_Z_E]",
+ where _F_A_M_I_L_Y_-_L_I_S_T is a comma separated list of families optionally ter-
+ minated by a comma, _S_T_Y_L_E___O_P_T_I_O_N_S is a whitespace separated list of
+ words where each WORD describes one of style, variant, weight, stretch,
+ or gravity, and _S_I_Z_E 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:
+ [--RR|----ffoonntt--rreennddeerr--mmooddee {nnoorrmmaall,lliigghhtt,mmoonnoo}]
- The font name has the form "[_F_A_M_I_L_Y_-_L_I_S_T] [_S_T_Y_L_E_-_O_P_T_I_O_N_S] [_S_I_Z_E]",
- where _F_A_M_I_L_Y_-_L_I_S_T is a comma separated list of families optionally
- terminated by a comma, _S_T_Y_L_E___O_P_T_I_O_N_S is a whitespace separated list
- of words where each WORD describes one of style, variant, weight,
- stretch, or gravity, and _S_I_Z_E 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:
- [--RR|----ffoonntt--rreennddeerr--mmooddee {nnoorrmmaall,lliigghhtt,mmoonnoo}]
+ nnoorrmmaall: Full Hinting and Antialiasing (default)
- There are 3 font render modes:
+ lliigghhtt: Slight Hinting and Antialiasing
- nnoorrmmaall: Full Hinting and Antialiasing (default)
+ mmoonnoo: Full Hinting and NO Antialiasing
- lliigghhtt: Slight Hinting and Antialiasing
+ [--BB|----ffoonntt--ssmmooootthhiinngg--tthhrreesshhoolldd _s_i_z_e]
- mmoonnoo: Full Hinting and NO Antialiasing
+ (this gets ignored in 1.3 for now!)
- [--BB|----ffoonntt--ssmmooootthhiinngg--tthhrreesshhoolldd _s_i_z_e]
+ 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!)
+ [--PP|----ppaannggoo--mmaarrkkuupp]
- 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 ----ppaannggoo--mmaarrkkuupp
+ option, all text will be processed by pango markup. This allows to
+ embed some simple html like markup tags using
- [--PP|----ppaannggoo--mmaarrkkuupp]
+ text
- 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
+ Apart from the verbose syntax, there are also the following short tags
+ available.
- text
+ b Bold
+ big Makes font relatively larger, equivalent to
+ i Italic
+ s Strikethrough
+ sub Subscript
+ sup Superscript
+ small Makes font relatively smaller, equivalent to
+ tt Monospace font
+ u Underline
- Apart from the verbose syntax, there are also the following short
- tags available.
+ More details on .
- b Bold
- big Makes font relatively larger, equivalent to
- i Italic
- s Strikethrough
- sub Subscript
- sup Superscript
- small Makes font relatively smaller, equivalent to
- tt Monospace font
- u Underline
+ [--GG|----ggrraapphh--rreennddeerr--mmooddee {nnoorrmmaall,mmoonnoo}]
- More details on .
+ There are 2 render modes:
- [--GG|----ggrraapphh--rreennddeerr--mmooddee {nnoorrmmaall,mmoonnoo}]
+ nnoorrmmaall: Graphs are fully Antialiased (default)
- There are 2 render modes:
+ mmoonnoo: No Antialiasing
- nnoorrmmaall: Graphs are fully Antialiased (default)
+ [--EE|----ssllooppee--mmooddee]
- mmoonnoo: 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.
- [--EE|----ssllooppee--mmooddee]
+ [--aa|----iimmggffoorrmmaatt PPNNGG|SSVVGG|EEPPSS|PPDDFF]
- 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.
- [--aa|----iimmggffoorrmmaatt PPNNGG|SSVVGG|EEPPSS|PPDDFF]
+ [--ii|----iinntteerrllaacceedd]
- 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!)
- [--ii|----iinntteerrllaacceedd]
+ If images are interlaced they become visible on browsers more quickly.
- (this gets ignored in 1.3 for now!)
+ [--gg|----nnoo--lleeggeenndd]
- If images are interlaced they become visible on browsers more
- quickly.
+ Suppress generation of the legend; only render the graph.
- [--gg|----nnoo--lleeggeenndd]
+ [--FF|----ffoorrccee--rruulleess--lleeggeenndd]
- 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).
- [--FF|----ffoorrccee--rruulleess--lleeggeenndd]
+ [--TT|----ttaabbwwiiddtthh _v_a_l_u_e]
- 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.
- [--TT|----ttaabbwwiiddtthh _v_a_l_u_e]
+ [--bb|----bbaassee _v_a_l_u_e]
- 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.
- [--bb|----bbaassee _v_a_l_u_e]
+ [--WW|----wwaatteerrmmaarrkk _s_t_r_i_n_g]
- 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.
- [--WW|----wwaatteerrmmaarrkk _s_t_r_i_n_g]
+ DDaattaa aanndd vvaarriiaabblleess
- Adds the given string as a watermark, horizontally centred, at the
- bottom of the graph.
+ DDEEFF::_v_n_a_m_e==_r_r_d_f_i_l_e::_d_s_-_n_a_m_e::_C_F[::sstteepp==_s_t_e_p][::ssttaarrtt==_t_i_m_e][::eenndd==_t_i_m_e]
- Data and variables
- DDEEFF::_v_n_a_m_e==_r_r_d_f_i_l_e::_d_s_-_n_a_m_e::_C_F[::sstteepp==_s_t_e_p][::ssttaarrtt==_t_i_m_e][::eenndd==_t_i_m_e]
+ CCDDEEFF::_v_n_a_m_e==_R_P_N _e_x_p_r_e_s_s_i_o_n
- CCDDEEFF::_v_n_a_m_e==_R_P_N _e_x_p_r_e_s_s_i_o_n
+ VVDDEEFF::_v_n_a_m_e==_R_P_N _e_x_p_r_e_s_s_i_o_n
- VVDDEEFF::_v_n_a_m_e==_R_P_N _e_x_p_r_e_s_s_i_o_n
+ You need at least one DDEEFF 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 DDEEFF statement to generate anything. The other
- statements are useful but optional. See rrdgraph_data and rrd-
- graph_rpn for the exact format.
+ GGrraapphh aanndd pprriinntt eelleemmeennttss
- 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.
ggrraapphhvv
@@ -465,4 +462,4 @@ AAUUTTHHOORR
-1.3rc9 2008-06-05 RRDGRAPH(1)
+1.3.0 2008-06-11 RRDGRAPH(1)