X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.txt;h=52bf57f05df65fa0e2f381d5e6a65812106c1830;hb=d9822df7ed5e8122cf3a62e4e99678e94007f504;hp=2d5cd1e857ec65fac7065876ccdfef17ffeb2b4c;hpb=034c985d61f53f91dac1c2f5facffa51b145a536;p=pkg-rrdtool.git diff --git a/doc/rrdgraph_graph.txt b/doc/rrdgraph_graph.txt index 2d5cd1e..52bf57f 100644 --- a/doc/rrdgraph_graph.txt +++ b/doc/rrdgraph_graph.txt @@ -12,17 +12,13 @@ SSYYNNOOPPSSIISS CCOOMMMMEENNTT::_t_e_x_t - VVRRUULLEE::_t_i_m_e##_c_o_l_o_r[::_l_e_g_- - _e_n_d][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_s_e_t]] + VVRRUULLEE::_t_i_m_e##_c_o_l_o_r[::_l_e_g_e_n_d][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_s_e_t]] - HHRRUULLEE::_v_a_l_u_e##_c_o_l_o_r[::_l_e_g_- - _e_n_d][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_s_e_t]] + HHRRUULLEE::_v_a_l_u_e##_c_o_l_o_r[::_l_e_g_e_n_d][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_s_e_t]] - LLIINNEE[_w_i_d_t_h]::_v_a_l_u_e[##_c_o_l_o_r][::[_l_e_g_- - _e_n_d][::SSTTAACCKK]][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_- - _s_e_t]] + LLIINNEE[_w_i_d_t_h]::_v_a_l_u_e[##_c_o_l_o_r][::[_l_e_g_e_n_d][::SSTTAACCKK][::sskkiippssccaallee][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_s_e_t]] - AARREEAA::_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][::sskkiippssccaallee]] 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]] @@ -41,198 +37,209 @@ DDEESSCCRRIIPPTTIIOONN 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. + PPRRIINNTT + _PP_RR_II_NN_TT_::_v_n_a_m_e_::_f_o_r_m_a_t_[_::_ss_tt_rr_ff_tt_ii_mm_ee_] - 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: + 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. - For printing values: + 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: - %%%% just prints a literal '%' character + For printing values: - %%##..##llee - prints numbers like 1.2346e+04. The optional integers # denote - field width and decimal precision. + %%%% just prints a literal '%' character - %%##..##llff - prints numbers like 12345.6789, with optional field width and - precision. + %%##..##llee + prints numbers like 1.2346e+04. The optional integers # denote + field width and decimal 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 - accordingly (123456 -> 123.456 k). + %%##..##llff + prints numbers like 12345.6789, with optional field width and + precision. - %%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 values. + %%ss place this after %%llee, %%llff or %%llgg. This will be replaced by the + appropriate SI magnitude unit and the value will be scaled + accordingly (123456 -> 123.456 k). - 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. + %%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 + values. - %%aa The abbreviated weekday name according to the current locale. + 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 C library. 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 full weekday name according to the current locale. + %%aa The abbreviated weekday name according to the current locale. - %%bb The abbreviated month name according to the current locale. + %%AA The full weekday name according to the current locale. - %%BB The full month name according to the current locale. + %%bb The abbreviated month name according to the current locale. - %%cc The preferred date and time representation for the current - locale. + %%BB The full month name according to the current locale. - %%dd The day of the month as a decimal number (range 01 to 31). + %%cc The preferred date and time representation for the current locale. - %%HH The hour as a decimal number using a 24-hour clock (range 00 to - 23). + %%dd The day of the month as a decimal number (range 01 to 31). - %%II The hour as a decimal number using a 12-hour clock (range 01 to - 12). + %%HH The hour as a decimal number using a 24-hour clock (range 00 to + 23). - %%jj The day of the year as a decimal number (range 001 to 366). + %%II The hour as a decimal number using a 12-hour clock (range 01 to + 12). - %%mm The month as a decimal number (range 01 to 12). + %%jj The day of the year as a decimal number (range 001 to 366). - %%MM The minute as a decimal number (range 00 to 59). + %%mm The month as a decimal number (range 01 to 12). - %%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. + %%MM The minute as a decimal number (range 00 to 59). - %%SS The second as a decimal number (range 00 to 61). + %%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. - %%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. + %%ss The second as a decimal number (range 00 to 61). - %%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. + %%SS The seconds since the epoch (1.1.1970) (libc dependent non + standard!) - %%ww The day of the week as a decimal, range 0 to 6, Sunday being 0. - See also %u. + %%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. - %%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. + %%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. - %%xx The preferred date representation for the current locale with- - out the time. + %%ww The day of the week as a decimal, range 0 to 6, Sunday being 0. + See also %u. - %%XX The preferred time representation for the current locale with- - out the date. + %%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. - %%yy The year as a decimal number without a century (range 00 to - 99). + %%xx The preferred date representation for the current locale without + the time. - %%YY The year as a decimal number including the century. + %%XX The preferred time representation for the current locale without + the date. - %%ZZ The time zone or name or abbreviation. + %%yy The year as a decimal number without a century (range 00 to 99). - %%%% A literal `%' character. + %%YY The year as a decimal number including the century. - 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. + %%ZZ The time zone or name or abbreviation. -GGRRAAPPHH - GGPPRRIINNTT::_v_n_a_m_e::_f_o_r_m_a_t - This is the same as "PRINT", but printed inside the graph. + %%%% A literal `%' character. - 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. + _PP_RR_II_NN_TT_::_v_n_a_m_e_::_C_F_::_f_o_r_m_a_t - 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][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_s_e_t]] - 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. Dashed lines can be - drawn using the ddaasshheess modifier. See LLIINNEE for more details. - - HHRRUULLEE::_v_a_l_u_e##_c_o_l_o_r[::_l_e_g_- - _e_n_d][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_s_e_t]] - 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]][::ddaasshheess[==_o_n___s[,_o_f_f___s[,_o_n___s,_o_f_f___s]...]][::ddaasshh--ooffffsseett==_o_f_f_- - _s_e_t]] - 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. - - The ddaasshheess modifier enables dashed line style. Without any further - options a symmetric dashed line with a segment length of 5 pixels - will be drawn. The dash pattern can be changed if the ddaasshheess== - parameter is followed by either one value or an even number (1, 2, - 4, 6, ...) of positive values. Each value provides the length of - alternate _o_n___s and _o_f_f___s portions of the stroke. The ddaasshh--ooffffsseett - parameter specifies an _o_f_f_s_e_t into the pattern at which the stroke - begins. - - When you do not specify a color, you cannot specify a legend. - Should you want to use STACK, use the "LINEx:::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. + _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. - 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. + GGRRAAPPHH + _GG_PP_RR_II_NN_TT_::_v_n_a_m_e_::_f_o_r_m_a_t - 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. + This is the same as "PRINT", but printed inside the graph. - TTEEXXTTAALLIIGGNN::{lleefftt|rriigghhtt|jjuussttiiffiieedd|cceenntteerr} - Labels are placed below the graph. When they overflow to the left, - they wrap to the next line. By default, lines are justified left - and right. The TTEEXXTTAALLIIGGNN function lets you change this default. - This is a command and not an option, so that you can change the - default several times in your argument list. + _GG_PP_RR_II_NN_TT_::_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. + + _CC_OO_MM_MM_EE_NN_TT_::_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 ''\\::''. + + _VV_RR_UU_LL_EE_::_t_i_m_e_##_c_o_l_o_r_[_::_l_e_g_e_n_d_]_[_::_dd_aa_ss_hh_ee_ss_[_==_o_n___s_[_,_o_f_f___s_[_,_o_n___s_,_o_f_f___s_]_._._._]_]_[_::_dd_aa_ss_hh_--_oo_ff_ff_ss_ee_tt_==_o_f_f_s_e_t_]_] + + 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 section. + _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. Dashed lines can be drawn using the + ddaasshheess modifier. See LLIINNEE for more details. + + _HH_RR_UU_LL_EE_::_v_a_l_u_e_##_c_o_l_o_r_[_::_l_e_g_e_n_d_]_[_::_dd_aa_ss_hh_ee_ss_[_==_o_n___s_[_,_o_f_f___s_[_,_o_n___s_,_o_f_f___s_]_._._._]_]_[_::_dd_aa_ss_hh_--_oo_ff_ff_ss_ee_tt_==_o_f_f_s_e_t_]_] + + 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. + + _LL_II_NN_EE_[_w_i_d_t_h_]_::_v_a_l_u_e_[_##_c_o_l_o_r_]_[_::_[_l_e_g_e_n_d_]_[_::_SS_TT_AA_CC_KK_]_[_::_ss_kk_ii_pp_ss_cc_aa_ll_ee_]_]_[_::_dd_aa_ss_hh_ee_ss_[_==_o_n___s_[_,_o_f_f___s_[_,_o_n___s_,_o_f_f___s_]_._._._]_]_[_::_dd_aa_ss_hh_--_oo_ff_ff_ss_ee_tt_==_o_f_f_s_e_t_]_] + + 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 modifier is used, this + line is stacked on top of the previous element which can be a LLIINNEE or + an AARREEAA. + + Normally the graphing function makes sure that the entire LLIINNEE or AARREEAA + is visible in the chart. The scaling of the chart will be modified + accordingly if necessary. Any LLIINNEE or AARREEAA can be excluded from this + process by adding the option sskkiippssccaallee. + + The ddaasshheess modifier enables dashed line style. Without any further + options a symmetric dashed line with a segment length of 5 pixels will + be drawn. The dash pattern can be changed if the ddaasshheess== parameter is + followed by either one value or an even number (1, 2, 4, 6, ...) of + positive values. Each value provides the length of alternate _o_n___s and + _o_f_f___s portions of the stroke. The ddaasshh--ooffffsseett parameter specifies an + _o_f_f_s_e_t into the pattern at which the stroke begins. + + When you do not specify a color, you cannot specify a legend. Should + you want to use SSTTAACCKK, use the "LINEx:::STACK" form. - 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_. + _AA_RR_EE_AA_::_v_a_l_u_e_[_##_c_o_l_o_r_]_[_::_[_l_e_g_e_n_d_]_[_::_SS_TT_AA_CC_KK_]_[_::_ss_kk_ii_pp_ss_cc_aa_ll_ee_]_] + + See LLIINNEE, however the area between the x-axis and the line will be + filled. + + _TT_II_CC_KK_::_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 normally start at the lower edge of the graphing area. + If the fraction is negative they start at the upper border of the + graphing area. + + _SS_HH_II_FF_TT_::_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. + + _TT_EE_XX_TT_AA_LL_II_GG_NN_::_{_ll_ee_ff_tt_|_rr_ii_gg_hh_tt_|_jj_uu_ss_tt_ii_ff_ii_ee_dd_|_cc_ee_nn_tt_ee_rr_} + + Labels are placed below the graph. When they overflow to the left, they + wrap to the next line. By default, lines are justified left and right. + The TTEEXXTTAALLIIGGNN function lets you change this default. This is a command + and not an option, so that you can change the default several times in + your argument list. + + _SS_TT_AA_CC_KK_::_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 _i_n_s_t_e_a_d_! SSoommee nnootteess oonn ssttaacckkiinngg @@ -246,51 +253,62 @@ GGRRAAPPHH 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. + make sure never to stack upon the unknown value. Use a CDEF + instruction with IIFF and UUNN to do so. NNOOTTEESS oonn lleeggeenndd aarrgguummeennttss - EEssccaappiinngg tthhee ccoolloonn - + 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 + 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. + 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. + 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: \\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 + of RRDtool lead to this behavior 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. + items printed into the graph. The space following a string can be + suppressed 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! + If you want to have left and right aligned legends on the same line use + COMMENT:\\uu to go one line back like this: + + COMMENT:left\l + COMMENT:\u + COMMENT:right\r + + There is also a 'nop' control for situations where you want a string to + actually end in a backslash character sequence \\.. + + COMMENT:OS\2\. + + When using a proportional font in your graph, the tab characters or the + sequence \\tt will line-up legend elements. Note that the tabs inserted + are relative to the start of the current legend element! Since RRDtool 1.3 is using Pango for rending text, you can use Pango - markup. Pango uses the xml ssppaann tags for inline formatting instruc- - tions.: + markup. Pango uses the xml ssppaann tags for inline formatting + instructions.: A simple example of a marked-up string might be: @@ -331,9 +349,9 @@ NNOOTTEESS oonn lleeggeenndd aarrgguummeennttss 'normal' or 'smallcaps' ssttrreettcchh - One of 'ultracondensed', 'extracondensed', 'condensed', 'semicon- - densed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', - 'ultraexpanded' + One of 'ultracondensed', 'extracondensed', 'condensed', + 'semicondensed', 'normal', 'semiexpanded', 'expanded', + 'extraexpanded', 'ultraexpanded' ffoorreeggrroouunndd An RGB color specification such as '#00FF00' or a color name such @@ -358,8 +376,8 @@ NNOOTTEESS oonn lleeggeenndd aarrgguummeennttss 'true' or 'false' whether to strike through the text ssttrriikkeetthhrroouugghh__ccoolloorr - The color of strikethrough lines; an RGB color specification such - as '#00FF00' or a color name such as 'red' + The color of crossed out lines; an RGB color specification such as + '#00FF00' or a color name such as 'red' ffaallllbbaacckk 'true' or 'false' whether to enable fallback. If disabled, then @@ -388,7 +406,7 @@ NNOOTTEESS oonn lleeggeenndd aarrgguummeennttss ii Italic - ss Strikethrough + ss Strike through ssuubb Subscript @@ -412,8 +430,9 @@ SSEEEE AALLSSOO AAUUTTHHOORR Program by Tobias Oetiker - This manual page by Alex van den Bogaerdt + This manual page by Alex van den Bogaerdt with + corrections and/or additions by several people -1.3rc4 2008-03-15 RRDGRAPH_GRAPH(1) +1.4.8 2013-05-23 RRDGRAPH_GRAPH(1)