RRDGRAPH_GRAPH(1)                   rrdtool                  RRDGRAPH_GRAPH(1)



NNAAMMEE
       rrdgraph_graph - rrdtool graph command reference

SSYYNNOOPPSSIISS
       PPRRIINNTT::_v_n_a_m_e::_f_o_r_m_a_t

       GGPPRRIINNTT::_v_n_a_m_e::_f_o_r_m_a_t

       CCOOMMMMEENNTT::_t_e_x_t

       VVRRUULLEE::_t_i_m_e##_c_o_l_o_r[::_l_e_g_e_n_d]

       HHRRUULLEE::_v_a_l_u_e##_c_o_l_o_r[::_l_e_g_e_n_d]

       LLIINNEE[_w_i_d_t_h]::_v_a_l_u_e[##_c_o_l_o_r][::[_l_e_g_e_n_d][::SSTTAACCKK]]

       AARREEAA::_v_a_l_u_e[##_c_o_l_o_r][::[_l_e_g_e_n_d][::SSTTAACCKK]]

       TTIICCKK::_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]]

       SSHHIIFFTT::_v_n_a_m_e::_o_f_f_s_e_t

       PPRRIINNTT::_v_n_a_m_e::_C_F::_f_o_r_m_a_t (deprecated)

       GGPPRRIINNTT::_v_n_a_m_e::_C_F::_f_o_r_m_a_t (deprecated)

       SSTTAACCKK::_v_n_a_m_e##_c_o_l_o_r[::_l_e_g_e_n_d] (deprecated)

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

       PPRRIINNTT


       PPRRIINNTT::_v_n_a_m_e::_f_o_r_m_a_t[::ssttrrffttiimmee]
           Depending on the context, either the value component or the time
           component of a VVDDEEFF is printed using _f_o_r_m_a_t. It is an error to
           specify a _v_n_a_m_e generated by a DDEEFF or CCDDEEFF.

           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:

           %%%% - just prints a literal '%' character

           %%##..##llee - prints numbers like 1.2346e+04. The optional integers #
           denote field width and decimal precision.

           %%##..##llff - prints numbers like 12345.6789, with optional field width
           and precision.

           %%ss - place this after %%llee, %%llff or %%llgg. This will be replaced by the
           appropriate SI magnitude unit and the value will be scaled accord-
           ingly (123456 -> 123.456 k).

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

           If you PRINT a VDEF value, you can also print the time associated
           with it by appending the string ::ssttrrffttiimmee to the format. Note that
           rrdtool uses the strftime function of your OSs clibrary. This means
           that the conversion specifier may vary. Check the manual page if
           you are uncertain. The following is a list of conversion specifiers
           usually supported across the board.

           %%aa - The abbreviated weekday name according to the current locale.

           %%AA - The full weekday name according to the current locale.

           %%bb - The abbreviated month name according to the current locale.

           %%BB - The full month name according to the current locale.

           %%cc - The preferred date and time representation for the current
           locale.

           %%dd - The day of the month as a decimal number (range 01 to 31).

           %%HH - The hour as a decimal number using a 24-hour clock (range 00
           to 23).

           %%II - The hour as a decimal number using a 12-hour clock (range 01
           to 12).

           %%jj - The day of the year as a decimal number (range 001 to 366).

           %%mm - The month as a decimal number (range 01 to 12).

           %%MM - The minute as a decimal number (range 00 to 59).

           %%pp - Either `AM' or `PM' according to the given time value, or the
           corresponding strings for the current locale.  Noon is treated as
           `pm' and midnight as `am'.  Note that in many locales and `pm'
           notation is unsupported and in such cases %p will return an empty
           string.

           %%SS - The second as a decimal number (range 00 to 61).

           %%UU - The  week  number  of  the current year as a decimal number,
           range 00 to 53, starting with the first Sunday as the first day of
           week 01. See also %V and %W.

           %%VV - The ISO 8601:1988 week number of the current year as a decimal
           number, range 01 to  53,  where week  1 is the first week that has
           at least 4 days in the current year, and with Monday as the first
           day of the week. See also %U and %W.

           %%ww - The day of the week as a decimal, range 0 to 6, Sunday being
           0.  See also %u.

           %%WW - The week number of the current year as a decimal number, range
           00 to  53,  starting  with  the first Monday as the first day of
           week 01.

           %%xx - The preferred date representation for the current locale with-
           out the time.

           %%XX - The preferred time representation for the current locale with-
           out the date.

           %%yy - The year as a decimal number without a century (range 00 to
           99).

           %%YY - The year as a decimal number including the century.

           %%ZZ - The time zone or name or abbreviation.

           %%%% - A literal `%' character.

       PPRRIINNTT::_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 CCDDEEFF _v_n_a_m_es.

       GGRRAAPPHH


       GGPPRRIINNTT::_v_n_a_m_e::_f_o_r_m_a_t
           This is the same as "PRINT", but printed inside the graph.

       GGPPRRIINNTT::_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.

       CCOOMMMMEENNTT::_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 **PPRRIINNTT commands by writing
           ''\\::''.

       VVRRUULLEE::_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 followed by an optional alpha.
           Optionally, a legend box and string is printed in the legend sec-
           tion. _t_i_m_e may be a number or a variable from a VVDDEEFF. It is an
           error to use _v_n_a_m_es from DDEEFF or CCDDEEFF here.

       HHRRUULLEE::_v_a_l_u_e##_c_o_l_o_r [ :_l_e_g_e_n_d ]
           Draw a horizontal line at _v_a_l_u_e.  HRULE acts much like LINE except
           that will have no effect on the scale of the graph. If a HRULE is
           outside the graphing area it will just not be visible.

       LLIINNEE[_w_i_d_t_h]::_v_a_l_u_e[##_c_o_l_o_r][::[_l_e_g_e_n_d][::SSTTAACCKK]]
           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 vvaalluuee can
           be generated by DDEEFF, VVDDEEFF, and CCDDEEFF.  If the optional SSTTAACCKK modi-
           fier is used, this line is stacked on top of the previous element
           which can be a LLIINNEE or an AARREEAA.

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

       AARREEAA::_v_a_l_u_e[##_c_o_l_o_r][::[_l_e_g_e_n_d][::SSTTAACCKK]]
           See LLIINNEE, however the area between the x-axis and the line will be
           filled.

       TTIICCKK::_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 of
           the graphing area. If the fraction is negative they start at the
           upper border of the graphing area.

       SSHHIIFFTT::_v_n_a_m_e::_o_f_f_s_e_t
           Using this command RRRRDDttooooll 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.

       SSTTAACCKK::_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 _SS_TT_AA_CC_KK _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_.

       SSoommee nnootteess oonn ssttaacckkiinngg

       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 iinnvviissiibbllee LINE or AREA to stacked upon.

       An uunnkknnoowwnn 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 instruc-
       tion with IIFF and UUNN to do so.

NNOOTTEESS oonn lleeggeenndd aarrgguummeennttss
       EEssccaappiinngg tthhee ccoolloonn

       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 back-
       slash '\:'.  Beware that many environments process backslashes them-
       selves, so it may be necessary to write two backslashes in order to one
       being passed onto rrd_graph.

       SSttrriinngg FFoorrmmaattttiinngg

       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 char-
       acter occurs, all pending text is pushed onto the graph according to
       the character specified.

       Valid markers are: \\jj for justified, \\ll for left aligned, \\rr for right
       aligned, and \\cc for centered. In the next section there is an example
       showing how to use centered formatting.

       \\nn is a valid alias for \\ll since incomplete parsing in earlier versions
       of rrdtool lead to this behaviour and a number of people has been using
       it.

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

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

       A special case is COMMENT:\\ss 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 \\tt to line-up legend elements. Note that the
       tabs inserted are relative to the start of the current legend element!

SSEEEE AALLSSOO
       rrdgraph gives an overview of how rrrrddttooooll ggrraapphh works.  rrdgraph_data
       describes DDEEFF,CCDDEEFF and VVDDEEFF in detail.  rrdgraph_rpn describes the RRPPNN
       language used in the ??DDEEFF statements.  rrdgraph_graph page describes
       all of the graph and print functions.

       Make sure to read rrdgraph_examples for tips&tricks.

AAUUTTHHOORR
       Program by Tobias Oetiker <tobi@oetiker.ch>

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



1.2.30                            2009-01-19                 RRDGRAPH_GRAPH(1)
