doc/rrdgraph_graph.txt

   1 RRDGRAPH_GRAPH(1)                   rrdtool                  RRDGRAPH_GRAPH(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        rrdgraph_graph - rrdtool graph command reference
   7
   8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   9        P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bf_\bo_\br_\bm_\ba_\bt
  10
  11        G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bf_\bo_\br_\bm_\ba_\bt
  12
  13        C\bCO\bOM\bMM\bME\bEN\bNT\bT:\b:_\bt_\be_\bx_\bt
  14
  15        V\bVR\bRU\bUL\bLE\bE:\b:_\bt_\bi_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\b-
  16        _\be_\bn_\bd][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\bs_\be_\bt]]
  17
  18        H\bHR\bRU\bUL\bLE\bE:\b:_\bv_\ba_\bl_\bu_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\b-
  19        _\be_\bn_\bd][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\bs_\be_\bt]]
  20
  21        L\bLI\bIN\bNE\bE[_\bw_\bi_\bd_\bt_\bh]:\b:_\bv_\ba_\bl_\bu_\be[#\b#_\bc_\bo_\bl_\bo_\br][:\b:[_\bl_\be_\bg_\b-
  22        _\be_\bn_\bd][:\b:S\bST\bTA\bAC\bCK\bK]][:\b:d\bda\bas\bsh\bhe\bes\bs[=\b=_\bo_\bn_\b__\bs[,_\bo_\bf_\bf_\b__\bs[,_\bo_\bn_\b__\bs,_\bo_\bf_\bf_\b__\bs]...]][:\b:d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt=\b=_\bo_\bf_\bf_\b-
  23        _\bs_\be_\bt]]
  24
  25        A\bAR\bRE\bEA\bA:\b:_\bv_\ba_\bl_\bu_\be[#\b#_\bc_\bo_\bl_\bo_\br][:\b:[_\bl_\be_\bg_\be_\bn_\bd][:\b:S\bST\bTA\bAC\bCK\bK]]
  26
  27        T\bTI\bIC\bCK\bK:\b:_\bv_\bn_\ba_\bm_\be#\b#_\br_\br_\bg_\bg_\bb_\bb[_\ba_\ba][:\b:_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn[:\b:_\bl_\be_\bg_\be_\bn_\bd]]
  28
  29        S\bSH\bHI\bIF\bFT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bo_\bf_\bf_\bs_\be_\bt
  30
  31        T\bTE\bEX\bXT\bTA\bAL\bLI\bIG\bGN\bN:\b:{l\ble\bef\bft\bt|r\bri\big\bgh\bht\bt|j\bju\bus\bst\bti\bif\bfi\bie\bed\bd|c\bce\ben\bnt\bte\ber\br}
  32
  33        P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
  34
  35        G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
  36
  37        S\bST\bTA\bAC\bCK\bK:\b:_\bv_\bn_\ba_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\be_\bn_\bd] (deprecated)
  38
  39 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  40        These instructions allow you to generate your image or report.  If you
  41        don't use any graph elements, no graph is generated.  Similarly, no
  42        report is generated if you don't use print options.
  43
  44        P\bPR\bRI\bIN\bNT\bT
  45
  46        _\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt_\b[_\b:\b:_\bs\bs_\bt\bt_\br\br_\bf\bf_\bt\bt_\bi\bi_\bm\bm_\be\be_\b]
  47
  48        Depending on the context, either the value component or the time compo-
  49        nent of a V\bVD\bDE\bEF\bF is printed using _\bf_\bo_\br_\bm_\ba_\bt. It is an error to specify a
  50        _\bv_\bn_\ba_\bm_\be generated by a D\bDE\bEF\bF or C\bCD\bDE\bEF\bF.
  51
  52        Any text in _\bf_\bo_\br_\bm_\ba_\bt is printed literally with one exception: The percent
  53        character introduces a formatter string. This string can be:
  54
  55        For printing values:
  56
  57        %\b%%\b%  just prints a literal '%' character
  58
  59        %\b%#\b#.\b.#\b#l\ble\be
  60            prints numbers like 1.2346e+04. The optional integers # denote
  61            field width and decimal precision.
  62
  63        %\b%#\b#.\b.#\b#l\blf\bf
  64            prints numbers like 12345.6789, with optional field width and pre-
  65            cision.
  66
  67        %\b%s\bs  place this after %\b%l\ble\be, %\b%l\blf\bf or %\b%l\blg\bg. This will be replaced by the
  68            appropriate SI magnitude unit and the value will be scaled accord-
  69            ingly (123456 -> 123.456 k).
  70
  71        %\b%S\bS  is similar to %\b%s\bs. It does, however, use a previously defined magni-
  72            tude unit. If there is no such unit yet, it tries to define one
  73            (just like %\b%s\bs) unless the value is zero, in which case the magni-
  74            tude unit stays undefined. Thus, formatter strings using %\b%S\bS and no
  75            %\b%s\bs will all use the same magnitude unit except for zero values.
  76
  77        If you PRINT a VDEF value, you can also print the time associated with
  78        it by appending the string :\b:s\bst\btr\brf\bft\bti\bim\bme\be to the format. Note that rrdtool
  79        uses the strftime function of your OSs C library. This means that the
  80        conversion specifier may vary. Check the manual page if you are uncer-
  81        tain. The following is a list of conversion specifiers usually sup-
  82        ported across the board.
  83
  84        %\b%a\ba  The abbreviated weekday name according to the current locale.
  85
  86        %\b%A\bA  The full weekday name according to the current locale.
  87
  88        %\b%b\bb  The abbreviated month name according to the current locale.
  89
  90        %\b%B\bB  The full month name according to the current locale.
  91
  92        %\b%c\bc  The preferred date and time representation for the current locale.
  93
  94        %\b%d\bd  The day of the month as a decimal number (range 01 to 31).
  95
  96        %\b%H\bH  The hour as a decimal number using a 24-hour clock (range 00 to
  97            23).
  98
  99        %\b%I\bI  The hour as a decimal number using a 12-hour clock (range 01 to
 100            12).
 101
 102        %\b%j\bj  The day of the year as a decimal number (range 001 to 366).
 103
 104        %\b%m\bm  The month as a decimal number (range 01 to 12).
 105
 106        %\b%M\bM  The minute as a decimal number (range 00 to 59).
 107
 108        %\b%p\bp  Either `AM' or `PM' according to the given time value, or the cor-
 109            responding strings for the current locale.  Noon is treated as `pm'
 110            and midnight as `am'.  Note that in many locales and `pm' notation
 111            is unsupported and in such cases %p will return an empty string.
 112
 113        %\b%s\bs  The second as a decimal number (range 00 to 61).
 114
 115        %\b%S\bS  The seconds since the epoch (1.1.1970) (libc dependant non stan-
 116            dard!)
 117
 118        %\b%U\bU  The  week  number  of  the current year as a decimal number, range
 119            00 to 53, starting with the first Sunday as the first day of week
 120            01. See also %V and %W.
 121
 122        %\b%V\bV  The ISO 8601:1988 week number of the current year as a decimal num-
 123            ber, range 01 to  53,  where week  1 is the first week that has at
 124            least 4 days in the current year, and with Monday as the first day
 125            of the week. See also %U and %W.
 126
 127        %\b%w\bw  The day of the week as a decimal, range 0 to 6, Sunday being 0.
 128            See also %u.
 129
 130        %\b%W\bW  The week number of the current year as a decimal number, range 00
 131            to  53,  starting  with  the first Monday as the first day of week
 132            01.
 133
 134        %\b%x\bx  The preferred date representation for the current locale without
 135            the time.
 136
 137        %\b%X\bX  The preferred time representation for the current locale without
 138            the date.
 139
 140        %\b%y\by  The year as a decimal number without a century (range 00 to 99).
 141
 142        %\b%Y\bY  The year as a decimal number including the century.
 143
 144        %\b%Z\bZ  The time zone or name or abbreviation.
 145
 146        %\b%%\b%  A literal `%' character.
 147
 148        _\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bC_\bF_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt
 149
 150        _\bD_\be_\bp_\br_\be_\bc_\ba_\bt_\be_\bd_\b. _\bU_\bs_\be _\bt_\bh_\be _\bn_\be_\bw _\bf_\bo_\br_\bm _\bo_\bf _\bt_\bh_\bi_\bs _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bi_\bn _\bn_\be_\bw _\bs_\bc_\br_\bi_\bp_\bt_\bs_\b.  The first
 151        form of this command is to be used with C\bCD\bDE\bEF\bF _\bv_\bn_\ba_\bm_\bes.
 152
 153        G\bGR\bRA\bAP\bPH\bH
 154
 155        _\bG\bG_\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt
 156
 157        This is the same as "PRINT", but printed inside the graph.
 158
 159        _\bG\bG_\bP\bP_\bR\bR_\bI\bI_\bN\bN_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bC_\bF_\b:\b:_\bf_\bo_\br_\bm_\ba_\bt
 160
 161        _\bD_\be_\bp_\br_\be_\bc_\ba_\bt_\be_\bd_\b. _\bU_\bs_\be _\bt_\bh_\be _\bn_\be_\bw _\bf_\bo_\br_\bm _\bo_\bf _\bt_\bh_\bi_\bs _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bi_\bn _\bn_\be_\bw _\bs_\bc_\br_\bi_\bp_\bt_\bs_\b.  This is
 162        the same as "PRINT", but printed inside the graph.
 163
 164        _\bC\bC_\bO\bO_\bM\bM_\bM\bM_\bE\bE_\bN\bN_\bT\bT_\b:\b:_\bt_\be_\bx_\bt
 165
 166        Text is printed literally in the legend section of the graph. Note that
 167        in RRDtool 1.2 you have to escape colons in COMMENT text in the same
 168        way you have to escape them in *\b*P\bPR\bRI\bIN\bNT\bT commands by writing '\b'\\b\:\b:'\b'.
 169
 170        _\bV\bV_\bR\bR_\bU\bU_\bL\bL_\bE\bE_\b:\b:_\bt_\bi_\bm_\be_\b#\b#_\bc_\bo_\bl_\bo_\br_\b[_\b:\b:_\bl_\be_\bg_\b-
 171        _\be_\bn_\bd_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\be\be_\bs\bs_\b[_\b=\b=_\bo_\bn_\b__\bs_\b[_\b,_\bo_\bf_\bf_\b__\bs_\b[_\b,_\bo_\bn_\b__\bs_\b,_\bo_\bf_\bf_\b__\bs_\b]_\b._\b._\b._\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\b-\b-_\bo\bo_\bf\bf_\bf\bf_\bs\bs_\be\be_\bt\bt_\b=\b=_\bo_\bf_\bf_\bs_\be_\bt_\b]_\b]
 172
 173        Draw a vertical line at _\bt_\bi_\bm_\be.  Its color is composed from three hex-
 174        adecimal numbers specifying the rgb color components (00 is off, FF is
 175        maximum) red, green and blue followed by an optional alpha. Optionally,
 176        a legend box and string is printed in the legend section. _\bt_\bi_\bm_\be may be a
 177        number or a variable from a V\bVD\bDE\bEF\bF. It is an error to use _\bv_\bn_\ba_\bm_\bes from D\bDE\bEF\bF
 178        or C\bCD\bDE\bEF\bF here.  Dashed lines can be drawn using the d\bda\bas\bsh\bhe\bes\bs modifier. See
 179        L\bLI\bIN\bNE\bE for more details.
 180
 181        _\bH\bH_\bR\bR_\bU\bU_\bL\bL_\bE\bE_\b:\b:_\bv_\ba_\bl_\bu_\be_\b#\b#_\bc_\bo_\bl_\bo_\br_\b[_\b:\b:_\bl_\be_\bg_\b-
 182        _\be_\bn_\bd_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\be\be_\bs\bs_\b[_\b=\b=_\bo_\bn_\b__\bs_\b[_\b,_\bo_\bf_\bf_\b__\bs_\b[_\b,_\bo_\bn_\b__\bs_\b,_\bo_\bf_\bf_\b__\bs_\b]_\b._\b._\b._\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\b-\b-_\bo\bo_\bf\bf_\bf\bf_\bs\bs_\be\be_\bt\bt_\b=\b=_\bo_\bf_\bf_\bs_\be_\bt_\b]_\b]
 183
 184        Draw a horizontal line at _\bv_\ba_\bl_\bu_\be.  HRULE acts much like LINE except that
 185        will have no effect on the scale of the graph. If a HRULE is outside
 186        the graphing area it will just not be visible.
 187
 188        _\bL\bL_\bI\bI_\bN\bN_\bE\bE_\b[_\bw_\bi_\bd_\bt_\bh_\b]_\b:\b:_\bv_\ba_\bl_\bu_\be_\b[_\b#\b#_\bc_\bo_\bl_\bo_\br_\b]_\b[_\b:\b:_\b[_\bl_\be_\bg_\b-
 189        _\be_\bn_\bd_\b]_\b[_\b:\b:_\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK_\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\be\be_\bs\bs_\b[_\b=\b=_\bo_\bn_\b__\bs_\b[_\b,_\bo_\bf_\bf_\b__\bs_\b[_\b,_\bo_\bn_\b__\bs_\b,_\bo_\bf_\bf_\b__\bs_\b]_\b._\b._\b._\b]_\b]_\b[_\b:\b:_\bd\bd_\ba\ba_\bs\bs_\bh\bh_\b-\b-_\bo\bo_\bf\bf_\bf\bf_\bs\bs_\be\be_\bt\bt_\b=\b=_\bo_\bf_\bf_\b-
 190        _\bs_\be_\bt_\b]_\b]
 191
 192        Draw a line of the specified width onto the graph. _\bw_\bi_\bd_\bt_\bh can be a
 193        floating point number. If the color is not specified, the drawing is
 194        done 'invisibly'. This is useful when stacking something else on top of
 195        this line. Also optional is the legend box and string which will be
 196        printed in the legend section if specified. The v\bva\bal\blu\bue\be can be generated
 197        by D\bDE\bEF\bF, V\bVD\bDE\bEF\bF, and C\bCD\bDE\bEF\bF.  If the optional S\bST\bTA\bAC\bCK\bK modifier is used, this
 198        line is stacked on top of the previous element which can be a L\bLI\bIN\bNE\bE or
 199        an A\bAR\bRE\bEA\bA.
 200
 201        The d\bda\bas\bsh\bhe\bes\bs modifier enables dashed line style. Without any further
 202        options a symmetric dashed line with a segment length of 5 pixels will
 203        be drawn. The dash pattern can be changed if the d\bda\bas\bsh\bhe\bes\bs=\b= parameter is
 204        followed by either one value or an even number (1, 2, 4, 6, ...) of
 205        positive values. Each value provides the length of alternate _\bo_\bn_\b__\bs and
 206        _\bo_\bf_\bf_\b__\bs portions of the stroke. The d\bda\bas\bsh\bh-\b-o\bof\bff\bfs\bse\bet\bt parameter specifies an
 207        _\bo_\bf_\bf_\bs_\be_\bt into the pattern at which the stroke begins.
 208
 209        When you do not specify a color, you cannot specify a legend.  Should
 210        you want to use STACK, use the "LINEx:<value>::STACK" form.
 211
 212        _\bA\bA_\bR\bR_\bE\bE_\bA\bA_\b:\b:_\bv_\ba_\bl_\bu_\be_\b[_\b#\b#_\bc_\bo_\bl_\bo_\br_\b]_\b[_\b:\b:_\b[_\bl_\be_\bg_\be_\bn_\bd_\b]_\b[_\b:\b:_\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK_\b]_\b]
 213
 214        See L\bLI\bIN\bNE\bE, however the area between the x-axis and the line will be
 215        filled.
 216
 217        _\bT\bT_\bI\bI_\bC\bC_\bK\bK_\b:\b:_\bv_\bn_\ba_\bm_\be_\b#\b#_\br_\br_\bg_\bg_\bb_\bb_\b[_\ba_\ba_\b]_\b[_\b:\b:_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b[_\b:\b:_\bl_\be_\bg_\be_\bn_\bd_\b]_\b]
 218
 219        Plot a tick mark (a vertical line) for each value of _\bv_\bn_\ba_\bm_\be that is non-
 220        zero and not *UNKNOWN*. The _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn argument specifies the length of
 221        the tick mark as a fraction of the y-axis; the default value is 0.1
 222        (10% of the axis). Note that the color specification is not optional.
 223        The TICK marks normally start at the lower edge of the graphing area.
 224        If the fraction is negative they start at the upper border of the
 225        graphing area.
 226
 227        _\bS\bS_\bH\bH_\bI\bI_\bF\bF_\bT\bT_\b:\b:_\bv_\bn_\ba_\bm_\be_\b:\b:_\bo_\bf_\bf_\bs_\be_\bt
 228
 229        Using this command R\bRR\bRD\bDt\bto\boo\bol\bl will graph the following elements with the
 230        specified offset.  For instance, you can specify an offset of
 231        ( 7*24*60*60 = ) 604'800 seconds to "look back" one week. Make sure to
 232        tell the viewer of your graph you did this ...  As with the other
 233        graphing elements, you can specify a number or a variable here.
 234
 235        _\bT\bT_\bE\bE_\bX\bX_\bT\bT_\bA\bA_\bL\bL_\bI\bI_\bG\bG_\bN\bN_\b:\b:_\b{_\bl\bl_\be\be_\bf\bf_\bt\bt_\b|_\br\br_\bi\bi_\bg\bg_\bh\bh_\bt\bt_\b|_\bj\bj_\bu\bu_\bs\bs_\bt\bt_\bi\bi_\bf\bf_\bi\bi_\be\be_\bd\bd_\b|_\bc\bc_\be\be_\bn\bn_\bt\bt_\be\be_\br\br_\b}
 236
 237        Labels are placed below the graph. When they overflow to the left, they
 238        wrap to the next line. By default, lines are justified left and right.
 239        The T\bTE\bEX\bXT\bTA\bAL\bLI\bIG\bGN\bN function lets you change this default. This is a command
 240        and not an option, so that you can change the default several times in
 241        your argument list.
 242
 243        _\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK_\b:\b:_\bv_\bn_\ba_\bm_\be_\b#\b#_\bc_\bo_\bl_\bo_\br_\b[_\b:\b:_\bl_\be_\bg_\be_\bn_\bd_\b]
 244
 245        _\bD_\be_\bp_\br_\be_\bc_\ba_\bt_\be_\bd_\b.  _\bU_\bs_\be _\bt_\bh_\be _\bS\bS_\bT\bT_\bA\bA_\bC\bC_\bK\bK _\bm_\bo_\bd_\bi_\bf_\bi_\be_\br_\bs _\bo_\bn _\bt_\bh_\be _\bo_\bt_\bh_\be_\br _\bc_\bo_\bm_\bm_\ba_\bn_\bd_\bs _\bi_\bn_\bs_\bt_\be_\ba_\bd_\b!
 246
 247        S\bSo\bom\bme\be n\bno\bot\bte\bes\bs o\bon\bn s\bst\bta\bac\bck\bki\bin\bng\bg
 248
 249        When stacking, an element is not placed above the X-axis but rather on
 250        top of the previous element.  There must be something to stack upon.
 251
 252        You can use an i\bin\bnv\bvi\bis\bsi\bib\bbl\ble\be LINE or AREA to stacked upon.
 253
 254        An u\bun\bnk\bkn\bno\bow\bwn\bn value makes the entire stack unknown from that moment on.
 255        You don't know where to begin (the unknown value) and therefore do not
 256        know where to end.
 257
 258        If you want to make sure you will be displaying a certain variable,
 259        make sure never to stack upon the unknown value.  Use a CDEF instruc-
 260        tion with I\bIF\bF and U\bUN\bN to do so.
 261
 262 N\bNO\bOT\bTE\bES\bS o\bon\bn l\ble\beg\bge\ben\bnd\bd a\bar\brg\bgu\bum\bme\ben\bnt\bts\bs
 263        E\bEs\bsc\bca\bap\bpi\bin\bng\bg t\bth\bhe\be c\bco\bol\blo\bon\bn
 264
 265        A colon ':' in a _\bl_\be_\bg_\be_\bn_\bd argument will mark the end of the legend. To
 266        enter a ':' as part of a legend, the colon must be escaped with a back-
 267        slash '\:'.  Beware that many environments process backslashes them-
 268        selves, so it may be necessary to write two backslashes in order to one
 269        being passed onto rrd_graph.
 270
 271        S\bSt\btr\bri\bin\bng\bg F\bFo\bor\brm\bma\bat\btt\bti\bin\bng\bg
 272
 273        The text printed below the actual graph can be formatted by appending
 274        special escape characters at the end of a text. When ever such a char-
 275        acter occurs, all pending text is pushed onto the graph according to
 276        the character specified.
 277
 278        Valid markers are: \\b\j\bj for justified, \\b\l\bl for left aligned, \\b\r\br for right
 279        aligned, and \\b\c\bc for centered. In the next section there is an example
 280        showing how to use centered formatting.
 281
 282        \\b\n\bn is a valid alias for \\b\l\bl since incomplete parsing in earlier versions
 283        of rrdtool lead to this behavior and a number of people has been using
 284        it.
 285
 286        Normally there are two space characters inserted between every two
 287        items printed into the graph. The space following a string can be sup-
 288        pressed by putting a \\b\g\bg at the end of the string. The \\b\g\bg also ignores
 289        any space inside the string if it is at the very end of the string.
 290        This can be used in connection with %\b%s\bs to suppress empty unit strings.
 291
 292         GPRINT:a:MAX:%lf%s\g
 293
 294        A special case is COMMENT:\\b\s\bs which inserts some additional vertical
 295        space before placing the next row of legends.
 296
 297        If you are using the proportional font in your graph, you can use tab
 298        characters or the sequence \\b\t\bt to line-up legend elements. Note that the
 299        tabs inserted are relative to the start of the current legend element!
 300
 301        Since RRDtool 1.3 is using Pango for rending text, you can use Pango
 302        markup.  Pango uses the xml s\bsp\bpa\ban\bn tags for inline formatting instruc-
 303        tions.:
 304
 305        A simple example of a marked-up string might be:
 306
 307         <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
 308
 309        The complete list of attributes for the span tag (taken from the pango
 310        documentation):
 311
 312        f\bfo\bon\bnt\bt_\b_d\bde\bes\bsc\bc
 313            A font description string, such as "Sans Italic 12"; note that any
 314            other span attributes will override this description. So if you
 315            have "Sans Italic" and also a style="normal" attribute, you will
 316            get Sans normal, not italic.
 317
 318        f\bfo\bon\bnt\bt_\b_f\bfa\bam\bmi\bil\bly\by
 319            A font family name
 320
 321        f\bfa\bac\bce\be
 322            Synonym for font_family
 323
 324        s\bsi\biz\bze\be
 325            Font size in 1024ths of a point, or one of the absolute sizes
 326            'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large',
 327            'xx-large', or one of the relative sizes 'smaller' or 'larger'. If
 328            you want to specify a absolute size, it's usually easier to take
 329            advantage of the ability to specify a partial font description
 330            using 'font_desc'; you can use font_desc='12.5' rather than
 331            size='12800'.
 332
 333        s\bst\bty\byl\ble\be
 334            One of 'normal', 'oblique', 'italic'
 335
 336        w\bwe\bei\big\bgh\bht\bt
 337            One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold',
 338            'heavy', or a numeric weight
 339
 340        v\bva\bar\bri\bia\ban\bnt\bt
 341            'normal' or 'smallcaps'
 342
 343        s\bst\btr\bre\bet\btc\bch\bh
 344            One of 'ultracondensed', 'extracondensed', 'condensed', 'semicon-
 345            densed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded',
 346            'ultraexpanded'
 347
 348        f\bfo\bor\bre\beg\bgr\bro\bou\bun\bnd\bd
 349            An RGB color specification such as '#00FF00' or a color name such
 350            as 'red'
 351
 352        b\bba\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd
 353            An RGB color specification such as '#00FF00' or a color name such
 354            as 'red'
 355
 356        u\bun\bnd\bde\ber\brl\bli\bin\bne\be
 357            One of 'none', 'single', 'double', 'low', 'error'
 358
 359        u\bun\bnd\bde\ber\brl\bli\bin\bne\be_\b_c\bco\bol\blo\bor\br
 360            The color of underlines; an RGB color specification such as
 361            '#00FF00' or a color name such as 'red'
 362
 363        r\bri\bis\bse\be
 364            Vertical displacement, in 10000ths of an em. Can be negative for
 365            subscript, positive for superscript.
 366
 367        s\bst\btr\bri\bik\bke\bet\bth\bhr\bro\bou\bug\bgh\bh
 368            'true' or 'false' whether to strike through the text
 369
 370        s\bst\btr\bri\bik\bke\bet\bth\bhr\bro\bou\bug\bgh\bh_\b_c\bco\bol\blo\bor\br
 371            The color of strikethrough lines; an RGB color specification such
 372            as '#00FF00' or a color name such as 'red'
 373
 374        f\bfa\bal\bll\blb\bba\bac\bck\bk
 375            'true' or 'false' whether to enable fallback. If disabled, then
 376            characters will only be used from the closest matching font on the
 377            system. No fallback will be done to other fonts on the system that
 378            might contain the characters in the text. Fallback is enabled by
 379            default. Most applications should not disable fallback.
 380
 381        l\bla\ban\bng\bg
 382            A language code, indicating the text language
 383
 384        l\ble\bet\btt\bte\ber\br_\b_s\bsp\bpa\bac\bci\bin\bng\bg
 385            Inter-letter spacing in 1024ths of a point.
 386
 387        g\bgr\bra\bav\bvi\bit\bty\by
 388            One of 'south', 'east', 'north', 'west', 'auto'.
 389
 390        g\bgr\bra\bav\bvi\bit\bty\by_\b_h\bhi\bin\bnt\bt
 391            One of 'natural', 'strong', 'line'.
 392
 393        To save you some typing, there are also some shortcuts:
 394
 395        b\bb   Bold
 396
 397        b\bbi\big\bg Makes font relatively larger, equivalent to <span size="larger">
 398
 399        i\bi   Italic
 400
 401        s\bs   Strikethrough
 402
 403        s\bsu\bub\bb Subscript
 404
 405        s\bsu\bup\bp Superscript
 406
 407        s\bsm\bma\bal\bll\bl
 408            Makes font relatively smaller, equivalent to <span size="smaller">
 409
 410        t\btt\bt  Monospace font
 411
 412        u\bu   Underline
 413
 414 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 415        rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works.  rrdgraph_data
 416        describes D\bDE\bEF\bF,C\bCD\bDE\bEF\bF and V\bVD\bDE\bEF\bF in detail.  rrdgraph_rpn describes the R\bRP\bPN\bN
 417        language used in the ?\b?D\bDE\bEF\bF statements.  rrdgraph_graph page describes
 418        all of the graph and print functions.
 419
 420        Make sure to read rrdgraph_examples for tips&tricks.
 421
 422 A\bAU\bUT\bTH\bHO\bOR\bR
 423        Program by Tobias Oetiker <tobi@oetiker.ch>
 424
 425        This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl> with
 426        corrections and/or additions by several people
 427
 428
 429
 430 1.3.99909060808                   2009-02-21                 RRDGRAPH_GRAPH(1)