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