


     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____G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____G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_graph - rrdtool graph command reference

     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
          PPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_f_o_r_m_a_t

          GGGGPPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_f_o_r_m_a_t

          CCCCOOOOMMMMMMMMEEEENNNNTTTT::::_t_e_x_t

          VVVVRRRRUUUULLLLEEEE::::_t_i_m_e####_c_o_l_o_r[::::_l_e_g_e_n_d]

          LLLLIIIINNNNEEEE[_w_i_d_t_h]::::_v_a_l_u_e[####_c_o_l_o_r][::::[_l_e_g_e_n_d][::::SSSSTTTTAAAACCCCKKKK]]

          AAAARRRREEEEAAAA::::_v_a_l_u_e[####_c_o_l_o_r][::::[_l_e_g_e_n_d][::::SSSSTTTTAAAACCCCKKKK]]

          TTTTIIIICCCCKKKK::::_v_n_a_m_e####_r_r_g_g_b_b[_a_a][::::_f_r_a_c_t_i_o_n[::::_l_e_g_e_n_d]]

          SSSSHHHHIIIIFFFFTTTT::::_v_n_a_m_e::::_o_f_f_s_e_t

          PPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_C_F::::_f_o_r_m_a_t (deprecated)

          GGGGPPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_C_F::::_f_o_r_m_a_t (deprecated)

          HHHHRRRRUUUULLLLEEEE::::_v_a_l_u_e####_c_o_l_o_r[::::_l_e_g_e_n_d] (deprecated)

          SSSSTTTTAAAACCCCKKKK::::_v_n_a_m_e####_c_o_l_o_r[::::_l_e_g_e_n_d] (deprecated)

     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
          These instructions allow you to generate your image or
          report.  If you don't use any graph elements, no graph is
          generated.  Similarly, no report is generated if you don't
          use print options.

     PPPPRRRRIIIINNNNTTTT
          PPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_f_o_r_m_a_t
              Depending on the context, either the value component or
              the time component of a VVVVDDDDEEEEFFFF is printed using _f_o_r_m_a_t. It
              is an error to specify a _v_n_a_m_e generated by a DDDDEEEEFFFF or
              CCCCDDDDEEEEFFFF.

              Any text in _f_o_r_m_a_t is printed literally with one
              exception:  The percent character introduces a formatter
              string. This string can be:

              For printing values:

              +o   %%%%%%%% just prints a literal '%' character

              +o   %%%%####....####lllleeee prints numbers like 1.2346e+04. The optional
                  integers # denote field width and decimal precision.




     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____G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____GGGGRRRRAAAAPPPPHHHH((((1111))))



              +o   %%%%####....####llllffff prints numbers like 12345.6789, with optional
                  field width and precision.

              +o   %%%%ssss place this after %%%%lllleeee, %%%%llllffff or %%%%llllgggg. This will be
                  replaced by the appropriate SI magnitude unit and
                  the value will be scaled accordingly (123456 ->
                  123.456 k).

              +o   %%%%SSSS is similar to %%%%ssss. It does, however, use a
                  previously defined magnitude unit. If there is no
                  such unit yet, it tries to define one (just like %%%%ssss)
                  unless the value is zero, in which case the
                  magnitude unit stays undefined. Thus, formatter
                  strings using %%%%SSSS and no %%%%ssss will all use the same
                  magnitude unit except for zero values.

              For printing times:

              +o   %%%%%%%% just prints a literal '%' character

              +o   %%%%aaaa,,,, %%%%AAAA print the abbreviated or full name of the day
                  of the week.

              +o   %%%%bbbb,,,, %%%%BBBB print the abbreviated or full name of the
                  month.

              +o   %%%%dddd,,,, %%%%mmmm,,,, %%%%yyyy,,,, %%%%HHHH,,,, %%%%MMMM,,,, %%%%SSSS print day, month, year, hour,
                  minute, and second in two-digit format.

              +o   %%%%YYYY prints the year in 4-digit format.

              +o   %%%%IIII,,,, %%%%pppp print the hour (01..12), 'am' or 'pm'.

              +o   %%%%jjjj,,,, %%%%wwww print day of the week (0..6), day of the year
                  (1..366)

              +o   %%%%cccc,,,, %%%%xxxx,,,, %%%%XXXX print date+time, date only, time only.

              +o   %%%%UUUU,,,, %%%%WWWW number of the week of the current year, with
                  either the first Sunday (%U) or the first Monday
                  (%W) determining the first week.

              +o   %%%%ZZZZ prints the time zone.

          PPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_C_F<:>_f_o_r_m_a_t
              _D_e_p_r_e_c_a_t_e_d. _U_s_e _t_h_e _n_e_w _f_o_r_m _o_f _t_h_i_s _c_o_m_m_a_n_d _i_n _n_e_w
              _s_c_r_i_p_t_s.  The first form of this command is to be used
              with CCCCDDDDEEEEFFFF _v_n_a_m_es.

     GGGGRRRRAAAAPPPPHHHH
          GGGGPPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_f_o_r_m_a_t
              This is the same as "PRINT", but printed inside the



     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____G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____GGGGRRRRAAAAPPPPHHHH((((1111))))



              graph.

          GGGGPPPPRRRRIIIINNNNTTTT::::_v_n_a_m_e::::_C_F::::_f_o_r_m_a_t
              _D_e_p_r_e_c_a_t_e_d. _U_s_e _t_h_e _n_e_w _f_o_r_m _o_f _t_h_i_s _c_o_m_m_a_n_d _i_n _n_e_w
              _s_c_r_i_p_t_s.  This is the same as "PRINT", but printed
              inside the graph.

          CCCCOOOOMMMMMMMMEEEENNNNTTTT::::_t_e_x_t
              Text is printed literally in the legend section of the
              graph. Note that in RRDtool 1.2 you have to escape
              colons in COMMENT text in the same way you have to
              escape them in ****PPPPRRRRIIIINNNNTTTT commands by writing ''''\\\\::::''''.

          HHHHRRRRUUUULLLLEEEE::::_v_a_l_u_e####_c_o_l_o_r [ :_l_e_g_e_n_d ]
              _D_e_p_r_e_c_a_t_e_d. _U_s_e _LLLL_IIII_NNNN_EEEE _i_n _n_e_w _s_c_r_i_p_t_s.

          VVVVRRRRUUUULLLLEEEE::::_t_i_m_e####_c_o_l_o_r [::::_l_e_g_e_n_d ]
              Draw a vertical line at _t_i_m_e.  Its color is composed
              from three hexadecimal numbers specifying the rgb color
              components (00 is off, FF is maximum) red, green and
              blue. Optionally, a legend box and string is printed in
              the legend section. _t_i_m_e may be a number or a variable
              from a VVVVDDDDEEEEFFFF. It is an error to use _v_n_a_m_es from DDDDEEEEFFFF or
              CCCCDDDDEEEEFFFF here.

          LLLLIIIINNNNEEEE[_w_i_d_t_h]::::_v_a_l_u_e[####_c_o_l_o_r][::::[_l_e_g_e_n_d][::::SSSSTTTTAAAACCCCKKKK]]
              Draw a line of the specified width onto the graph. _w_i_d_t_h
              can be a floating point number. If the color is not
              specified, the drawing is done 'invisibly'. This is
              useful when stacking something else on top of this line.
              Also optional is the legend box and string which will be
              printed in the legend section if specified. The vvvvaaaalllluuuueeee
              can be generated by DDDDEEEEFFFF, VVVVDDDDEEEEFFFF, and CCCCDDDDEEEEFFFF.  If the
              optional SSSSTTTTAAAACCCCKKKK modifier is used, this line is stacked on
              top of the previous element which can be a LLLLIIIINNNNEEEE or an
              AAAARRRREEEEAAAA.

              When you do not specify a color, you cannot specify a
              legend.  Should you want to use STACK, use the
              "LINEx:<value>::STACK" form.

          AAAARRRREEEEAAAA::::_v_a_l_u_e[####_c_o_l_o_r][::::[_l_e_g_e_n_d][::::SSSSTTTTAAAACCCCKKKK]]
              See LLLLIIIINNNNEEEE, however the area between the x-axis and the
              line will be filled.

          TTTTIIIICCCCKKKK::::_v_n_a_m_e####_r_r_g_g_b_b[_a_a][::::_f_r_a_c_t_i_o_n[::::_l_e_g_e_n_d]]
              Plot a tick mark (a vertical line) for each value of
              _v_n_a_m_e that is non-zero and not *UNKNOWN*. The _f_r_a_c_t_i_o_n
              argument specifies the length of the tick mark as a
              fraction of the y-axis; the default value is 0.1 (10% of
              the axis). Note that the color specification is not
              optional. The TICK marks normaly start at the lower edge



     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____G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____GGGGRRRRAAAAPPPPHHHH((((1111))))



              of the graphing area. If the fraction is negative they
              start at the upper border of the graphing area.

          SSSSHHHHIIIIFFFFTTTT::::_v_n_a_m_e::::_o_f_f_s_e_t
              Using this command RRRRRRRRDDDDttttoooooooollll will graph the following
              elements with the specified offset.  For instance, you
              can specify an offset of
              ( 7*24*60*60 = ) 604'800 seconds to "look back" one
              week. Make sure to tell the viewer of your graph you did
              this ...  As with the other graphing elements, you can
              specify a number or a variable here.

          SSSSTTTTAAAACCCCKKKK::::_v_n_a_m_e####_c_o_l_o_r[::::_l_e_g_e_n_d]
              _D_e_p_r_e_c_a_t_e_d.  _U_s_e _t_h_e _SSSS_TTTT_AAAA_CCCC_KKKK _m_o_d_i_f_i_e_r_s _o_n _t_h_e _o_t_h_e_r
              _c_o_m_m_a_n_d_s.

          SSSSoooommmmeeee nnnnooootttteeeessss oooonnnn ssssttttaaaacccckkkkiiiinnnngggg

          When stacking, an element is not placed above the X-axis but
          rather on top of the previous element.  There must be
          something to stack upon.

          You can use an iiiinnnnvvvviiiissssiiiibbbblllleeee LINE or AREA to stacked upon.

          An uuuunnnnkkkknnnnoooowwwwnnnn value makes the entire stack unknown from that
          moment on.  You don't know where to begin (the unknown
          value) and therefore do not know where to end.

          If you want to make sure you will be displaying a certain
          variable, make sure never to stack upon the unknown value.
          Use a CDEF instruction with IIIIFFFF and UUUUNNNN to do so.

     NNNNOOOOTTTTEEEESSSS oooonnnn lllleeeeggggeeeennnndddd aaaarrrrgggguuuummmmeeeennnnttttssss
          EEEEssssccccaaaappppiiiinnnngggg tttthhhheeee ccccoooolllloooonnnn

          A colon ':' in a _l_e_g_e_n_d argument will mark the end of the
          legend. To enter a ':' as part of a legend, the colon must
          be escaped with a backslash '\:'.  Beware that many
          environments process backslashes themselves, so it may be
          necessary to write two backslashes in order to one being
          passed onto rrd_graph.

          SSSSttttrrrriiiinnnngggg FFFFoooorrrrmmmmaaaattttttttiiiinnnngggg

          The text printed below the actual graph can be formatted by
          appending special escape characters at the end of a text.
          When ever such a character occurs, all pending text is
          pushed onto the graph according to the character specified.

          Valid markers are: \\\\jjjj for justified, \\\\llll for left aligned, \\\\rrrr
          for right aligned, and \\\\cccc for centered. In the next section
          there is an example showing how to use centered formatting.



     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____G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____GGGGRRRRAAAAPPPPHHHH((((1111))))



          Normally there are two space characters inserted between
          every two items printed into the graph. The space following
          a string can be suppressed by putting a \\\\gggg at the end of the
          string. The \\\\gggg also ignores any space inside the string if
          it is at the very end of the string. This can be used in
          connection with %%%%ssss to suppress empty unit strings.

           GPRINT:a:MAX:%lf%s\g

          A special case is COMMENT:\\\\ssss which inserts some additional
          vertical space before placing the next row of legends.

          If you are using the proportional font in your graph, you
          can use tab characters or the sequence \\\\tttt to line-up legend
          elements. Note that the tabs inserted are relative to the
          start of the current legend element!

     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 5                                          (printed 6/13/06)



