


     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



     NNNNAAAAMMMMEEEE
          rrdgraph - Round Robin Database tool grapher functions

     SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
          rrrrrrrrddddttttoooooooollll ggggrrrraaaapppphhh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DDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
          The ggggrrrraaaapppphhhh function of RRRRRRRRDDDDttttoooooooollll is used to present the data
          from an RRRRRRRRDDDD to a human viewer.  Its main purpose is to
          create a nice graphical representation, but it can also
          generate a numerical report.

     OOOOVVVVEEEERRRRVVVVIIIIEEEEWWWW
          rrrrrrrrddddttttoooooooollll ggggrrrraaaapppphhhh needs data to work with, so you must use one
          or more ddddaaaattttaaaa ddddeeeeffffiiiinnnniiiittttiiiioooonnnn statements to collect this data.
          You are not limited to one database, it's perfectly legal to
          collect 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vvvaaaarrrriiiiaaaabbbblllleeee
          ddddeeeeffffiiiinnnniiiittttiiiioooonnn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RRRRRRRAAAA is then ccccoooonnnnssssoooolllliiiiddddaaaatttteeeedddd so that
          there is exactly one datapoint per pixel in the graph. If
          you do not take care yourself, RRRRRRRRDDDDttttoooooooollll will expand the range
          slightly if necessary. Note, in that case the first and/or
          last pixel may very well become unknown!

          Sometimes data is not exactly in the format you would like
          to display it. For instance, you might be collecting bbbbyyyytttteeeessss
          per second, but want to display bbbbiiiittttssss per second. This is
          what the ddddaaaattttaaaa ccccaaaallllccccuuuullllaaaattttiiiioooonnnn command is designed for. After
          ccccoooonnnnssssoooolllliiiiddddaaaattttiiiinnnngggg the data, a copy is made and this copy is
          modified using a rather powerful RRRRPPPPNNN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rrrrrrrddddttttoooooooollll ggggrrrraaaapppphhhh
          sequence.

     OOOOPPPPTTTTIIIIOOOONNNNSSSS
          filename
              The name and path of the graph to generate. It is
              recommended to end this in ".png", ".svg" or ".eps", but
              RRRRRRRRDDDDttttoooooooollll 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.



     Page 1                                          (printed 6/13/06)






     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



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

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

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

              The width and height of the ccccaaaannnnvvvvaaaassss (the part of the
              graph with the actual data and such). This defaults to
              400 pixels by 100 pixels.

              If you specify the --------oooonnnnllllyyyy----ggggrrrraaaapppphhhh 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.

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

              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
              lllloooowwwweeeerrrr----lllliiiimmmmiiiitttt to uuuuppppppppeeeerrrr----lllliiiimmmmiiiitttt. Autoscaling will still
              permit those boundaries to be stretched unless the rrrriiiiggggiiiidddd
              option is set.

              [----AAAA|--------aaaalllltttt----aaaauuuuttttoooossssccccaaaalllleeee]

              Sometimes the default algorithm for selecting the y-axis



     Page 2                                          (printed 6/13/06)






     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



              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).

              [----MMMM|--------aaaalllltttt----aaaauuuuttttoooossssccccaaaalllleeee----mmmmaaaaxxx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N|--------nnnnoooo----ggggrrrriiiiddddffffiiiitttt]

              In order to avoid anti-aliasing effects gridlines are
              placed on integer pixel values. This is by default done
              by extending the scale so that gridlines happens to be
              spaced using an integer number of pixels and also start
              on an integer pixel value.  This might extend the scale
              too much for some logarithmic scales and for linear
              scales where --------aaaalllltttt----aaaauuuuttttoooossssccccaaaalllleeee is needed.  Using
              --------nnnnoooo----ggggrrrriiiiddddffffiiiitttt disables modification of the scale.

          Grid
              X-Axis
                  [----xxxx|--------xxxx----ggggrrrriiiiddd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|--------xxxx----ggggrrrriiiidddd nnnnoooonnnneee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 suppress
                  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



     Page 3                                          (printed 6/13/06)






     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



                  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: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 specify
                  the complete day and not just midnight.

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

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

                  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.

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

                  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).

                  [----oooo|--------llllooooggggaaaarrrriiiitttthhhhmmmmiiiicccc]

                  Logarithmic y-axis scaling.

                  [----XXXX|--------uuuunnnniiiittttssss----eeeexxxxppppoooonnnneeeennnnttt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



     Page 4                                          (printed 6/13/06)






     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



                  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
                  --------aaaalllltttt----yyyy----ggggrrrriiiidddd mode.

                  [----LLLL|--------uuuunnnniiiittttssss----lllleeeennnnggggtttthhh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.

                  [--------uuuunnnniiiittttssss====ssssiiii]

                  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.

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

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

              [----ffff|--------iiiimmmmggggiiiinnnnffffooo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 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 IIIIMMMMGGG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c|--------ccccoooolllloooorrr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



     Page 5                                          (printed 6/13/06)






     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



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

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

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

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

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

              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
              vertical unit label, "LEGEND" for the graph legend.

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

              If you do not give a font string you can modify just the
              sice of the default font:  "--font TITLE:13:".

              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:/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.

              [----RRRR|--------ffffoooonnnntttt----rrrreeeennnnddddeeeerrrr----mmmmooooddddeeee {_n_o_r_m_a_l,_l_i_g_h_t,_m_o_n_o}]

              This lets you customize the strength of the font
              smoothing, or disable it entirely using _m_o_n_o. By



     Page 6                                          (printed 6/13/06)






     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



              default, _n_o_r_m_a_l font smoothing is used.

              [----BBBB|--------ffffoooonnnntttt----ssssmmmmooooooootttthhhhiiiinnnngggg----tttthhhhrrrreeeesssshhhhoooolllldddd _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.

              [----EEEE|--------ssssllllooooppppeeee----mmmmooooddddeeee]

              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.

              [----aaaa|--------iiiimmmmggggffffoooorrrrmmmmaaaatttt PPPPNNNNGGGG|SSSSVVVVGGGG|EEEEPPPPSSSS|PPPPDDDDFFF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,
              Helvetica-BoldOblique, Helvetica-Oblique, Helvetica,
              Symbol, Times-Bold, Times-BoldItalic, Times-Italic,
              Times-Roman, and ZapfDingbats.

              [----iiii|--------iiiinnnntttteeeerrrrllllaaaacccceeeedddd]

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

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

              Suppress generation of the legend; only render the
              graph.

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

              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).

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

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

              [----bbbb|--------bbbbaaaasssseee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.



     Page 7                                          (printed 6/13/06)






     RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))            1111....2222....11113333 ((((2222000000006666----00005555----00004444))))            RRRRRRRRDDDDGGGGRRRRAAAAPPPPHHHH((((1111))))



              [----WWWW|--------wwwwaaaatttteeeerrrrmmmmaaaarrrrkkkk _s_t_r_i_n_g]

              Adds the given string as a watermark, horizontally
              centred, at the bottom of the graph.

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

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

              VVVVDDDDEEEEFFF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DDDEEEEFFFF statement to generate
              anything. The other statements are useful but optional.
              See rrdgraph_data and rrdgraph_rpn for the 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 the exact format.

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

          Make sure to read rrdgraph_examples for tips&tricks.

     AAAAUUUUTTTTHHHHOOOORRRR
          Program by Tobias Oetiker <tobi@oetiker.ch>

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



















     Page 8                                          (printed 6/13/06)



