RRDGRAPH(1)                  rrdtool                  RRDGRAPH(1)



NNAAMMEE
       rrdgraph - About drawing pretty graphs with rrdtool

SSYYNNOOPPSSIISS
       rrrrddttooooll ggrraapphh _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 ...]
       [_d_a_t_a _c_a_l_c_u_l_a_t_i_o_n ...]  [_v_a_r_i_a_b_l_e _d_e_f_i_n_i_t_i_o_n ...]  [_g_r_a_p_h
       _e_l_e_m_e_n_t ...]  [_p_r_i_n_t _e_l_e_m_e_n_t ...]

DDEESSCCRRIIPPTTIIOONN
       The ggrraapphh function of RRRRDDttooooll is used to present the data
       from an RRRRDD to a human viewer.  Its main purpose is to
       create a nice graphical representation but it can also
       generate a numerical report.

OOVVEERRVVIIEEWW
       rrrrddttooooll ggrraapphh needs data to work with, use one or more
       ddaattaa ddeeffiinniittiioonn statements to collect this data.  You are
       not limited to one database, it's perfectly legal to col-
       lect data from two or more databases (one per statement
       though).

       If you want to display averages, maxima, percentiles
       etcetera it is best to collect them now using the vvaarriiaabbllee
       ddeeffiinniittiioonn statement.  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RRRAA is then ccoonnssoolliiddaatteedd so that
       there is exactly one datapoint per pixel in the graph. If
       you do not take care yourself, RRRRDDttooooll will expand the
       range slightly if necessary (in that case the first and/or
       last pixel may very well become unknown!).

       Sometimes data is not exactly as you would like to display
       it. For instance, you might be collecting bbyytteess per second
       but want to display bbiittss per second. This is where the
       ddaattaa ccaallccuullaattiioonn command is designed for.  After ccoonnssoollii--
       ddaattiinngg the data, a copy is made and this copy is modified
       using a rather flexible RRPPNN command set.

       When you are done fetching and processing the data, it is
       time to graph it (or print it).  This ends the rrrrddttooooll
       ggrraapphh sequence.

OOPPTTIIOONNSS
       filename
           The name and path of the graph to generate. It is rec-
           ommended to end this in ".png", ".svg" or ".eps" but
           RRRRDDttooooll does not enforce this.

           _f_i_l_e_n_a_m_e can be '"-"' to send the image to "stdout".
           In that case, no other output is generated.

       Time range
           [--ss|----ssttaarrtt _t_i_m_e] [--ee|----eenndd _t_i_m_e] [--SS|----sstteepp _s_e_c_o_n_d_s]

           The start and end of what you would like to display,
           and which RRRRAA the data should come from.  Defaults
           are: 1 day ago until now, with the best possible reso-
           lution. SSttaarrtt and eenndd can be specified in several for-
           mats, see AT-STYLE TIME SPECIFICATION and rrd-
           graph_examples.  By default, rrrrddttooooll ggrraapphh calculates
           the width of one pixel in the time domain and tries to
           get data from an RRRRAA with that resolution.  With the
           sstteepp option you can alter this behaviour.  If you want
           rrrrddttooooll ggrraapphh to get data at a one-hour resolution
           from the RRRRDD, set sstteepp to 3600.  Note: a step smaller
           than one pixel will silently be ignored.

       Labels
           [--tt|----ttiittllee _s_t_r_i_n_g] [--vv|----vveerrttiiccaall--llaabbeell _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
           [--ww|----wwiiddtthh _p_i_x_e_l_s] [--hh|----hheeiigghhtt _p_i_x_e_l_s]
           [--jj|----oonnllyy--ggrraapphh]

           The width and height of the ccaannvvaass (the part of the
           graph with the actual lines and such). Defaults are
           400 pixels by 100 pixels.

           If you specify the ----oonnllyy--ggrraapphh option and set the
           height < 32 pixels you will get a tiny graph image to
           use as an icon in a potential overview. All labeling
           will be stripped off the graph.

       Limits
           [--uu|----uuppppeerr--lliimmiitt _v_a_l_u_e] [--ll|----lloowweerr--lliimmiitt _v_a_l_u_e]
           [--rr|----rriiggiidd]

           By default the graph will be autoscaling so that it
           displays the portion of the y-axis that is actually
           used. You can change this behaviour by setting the
           limits.  The displayed y-axis will show at least from
           lloowweerr--lliimmiitt to uuppppeerr--lliimmiitt.  Autoscaling will still
           permit those boundaries to be stretched unless the
           rriiggiidd option is set.

           [--AA|----aalltt--aauuttoossccaallee]

           Sometimes the default algorithm for selecting the
           y-axis scale is not performing very well.  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 calcu-
           lates the minimum and maximum y-axis from the actual
           minimum and maximum values. Our example would display
           slightly less than "260-0.001" to slightly more than
           "260+0.001" (Contributed by Sasha Mikheev).

           [--MM|----aalltt--aauuttoossccaallee--mmaaxx]

           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.

           [--NN|----nnoo--ggrriiddffiitt]

           To avoid anti-aliasing effects gridlines are placed on
           integer pixel values. This is by default done by
           extending the scale so gridlines happens to be spaced
           using an integer number of pixels, and starts on inte-
           ger pixel value.  This might extend the scale too much
           for some logarithmic scales and for linear scales
           where ----aalltt--aauuttoossccaallee is needed.  Using ----nnoo--ggrriiddffiitt
           disables modification of the scale.

       Grid
           X-Axis
               [--xx|----xx--ggrriidd _G_T_M::_G_S_T::_M_T_M::_M_S_T::_L_T_M::_L_S_T::_L_P_R::_L_F_M]

               [--xx|----xx--ggrriidd nnoonnee]

               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 skip
               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 need to 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 in this interval (use-
               ful 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:0:%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 spec-
               ify the complete day and not just midnight.

           Y-Axis
               [--yy|----yy--ggrriidd _g_r_i_d _s_t_e_p::_l_a_b_e_l _f_a_c_t_o_r]

               [--yy|----yy--ggrriidd nnoonnee]

               Y-axis grid lines appear at each _g_r_i_d _s_t_e_p inter-
               val.  Labels are placed every _l_a_b_e_l _f_a_c_t_o_r lines.
               You can specify "-y none" to skip the grid and
               labels altogether.  The default for this option is
               to automatically select sensible values.

               [--YY|----aalltt--yy--ggrriidd]

               Place Y grid dynamically based on graph Y range.
               Algorithm ensures that you always have grid, that
               there are enough but not too many grid lines and
               the grid is metric. That is grid lines are placed
               every 1, 2, 5 or 10 units.  (contributed by Sasha
               Mikheev)

               [--oo|----llooggaarriitthhmmiicc]

               Logarithmic y-axis scaling.

               [--XX|----uunniittss--eexxppoonneenntt _v_a_l_u_e]

               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 inclusive.  It
               is the exponent on the units you which 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
               ----aalltt--yy--ggrriidd mode.

               [--LL|----uunniittss--lleennggtthh _v_a_l_u_e]

               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.

       Miscellaneous
           [--zz|----llaazzyy]

           Only generate the graph, if the current graph is out
           of date or not existent.

           [--ff|----iimmggiinnffoo _p_r_i_n_t_f_s_t_r]

           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 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 IIMMGG tag suitable
           for including the graph into a web page, the command
           line would look like this:

            --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'

           [--cc|----ccoolloorr _C_O_L_O_R_T_A_G#_r_r_g_g_b_b[_a_a]]

           Override the default colors for the standard elements
           of the graph. The _C_O_L_O_R_T_A_G is one of "BACK" back-
           ground, "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 and finaly "ARROW"
           for the arrow head pointing to the future. Each color
           is composed out of three hexadecimal numbers specify-
           ing its 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.

           A green arrow is made by: "--color ARROW:00FF00"

           [----zzoooomm _f_a_c_t_o_r]

           Zoom the graphics by the given amount ... The factor
           must be > 0

           [--nn|----ffoonntt _F_O_N_T_T_A_G::_s_i_z_e::_f_o_n_t]

           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", "AXIS" for the
           axis labels, "UNIT" for the vertical unit label, "LEG-
           END" for the graph legend.

           Use Times for the title: "--font
           TITLE:13:/usr/lib/fonts/times.ttf"

           RRDtool comes with a preset default font. You can set
           the environment variable "RRD_DEFAULT_FONT" if you
           want to change this.

           Truetype fonts are only supported for PNG output. See
           below.

           [--aa|----iimmggffoorrmmaatt PPNNGG|SSVVGG|EEPPSS|PPDDFF]

           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, Sym-
           bol, Times-Bold, Times-BoldItalic, Times-Italic,
           Times-Roman, ZapfDingbats

           [--ii|----iinntteerrllaacceedd]

           If images are interlaced they become visible on
           browsers more quickly.

           [--gg|----nnoo--lleeggeenndd]

           Suppress generation of legend; only render the graph.

           [--FF|----ffoorrccee--rruulleess--lleeggeenndd]

           Force the generation of HRULE and VRULE legend even if
           those HRULE or VRULE will not be drawn because out of
           graph boundaries (mimics behaviour of pre 1.0.42 ver-
           sions).

           [--TT|----ttaabbwwiiddtthh _v_a_l_u_e]

           By default the tab-width is 40 pixels, use this option
           to change it.

           [--bb|----bbaassee _v_a_l_u_e]

           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.

       Data and variables
           DDEEFF::_v_n_a_m_e==_r_r_d_f_i_l_e::_d_s_-
           _n_a_m_e::_C_F[::sstteepp==_s_t_e_p][::ssttaarrtt==_t_i_m_e][::eenndd==_t_i_m_e]

           CCDDEEFF::_v_n_a_m_e==_R_P_N _e_x_p_r_e_s_s_i_o_n

           VVDDEEFF::_v_n_a_m_e==_R_P_N _e_x_p_r_e_s_s_i_o_n

           You need at least one DDEEFF statement to generate any-
           thing. The other statements are useful but optional.
           See rrdgraph_data and rrdgraph_rpn for exact format.

       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 exact format.

SSEEEE AALLSSOO
       rrdgraph gives an overview of how rrrrddttooooll ggrraapphh works.
       rrdgraph_data describes DDEEFF,CCDDEEFF and VVDDEEFF in detail, rrd-
       graph_rpn describes the RRPPNN language used in the ??DDEEFF
       statements, rrdgraph_graph page describes all of the graph
       and print functions.

       Make sure to read rrdgraph_examples for tips&tricks.

AAUUTTHHOORR
       Program by Tobias Oetiker <oetiker@ee.ethz.ch>

       This manual page by Alex van den Bogaerdt
       <alex@ergens.op.het.net>



1.2.0                       2005-04-25                RRDGRAPH(1)
