diff --git a/doc/rrdgraph_graph.txt b/doc/rrdgraph_graph.txt
index 268ec54abdcb3c2860850fb755ba44d7890fb7f1..1ec716906c5d929e12665cd6144f991881c8770e 100644 (file)
--- a/doc/rrdgraph_graph.txt
+++ b/doc/rrdgraph_graph.txt
C\bCO\bOM\bMM\bME\bEN\bNT\bT:\b:_\bt_\be_\bx_\bt
- V\bVR\bRU\bUL\bLE\bE:\b:_\bt_\bi_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br[:\b:_\bl_\be_\bg_\be_\bn_\bd]
+ 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]]
- 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]
+ 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]]
- 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]]
+ 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: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]]
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]]
S\bSH\bHI\bIF\bFT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bo_\bf_\bf_\bs_\be_\bt
+ 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}
+
P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt (deprecated)
don't use any graph elements, no graph is generated. Similarly, no
report is generated if you don't use print options.
- P\bPR\bRI\bIN\bNT\bT
-
+ P\bPR\bRI\bIN\bNT\bT
+ _\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]
- P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bf_\bo_\br_\bm_\ba_\bt[:\b:s\bst\btr\brf\bft\bti\bim\bme\be]
- Depending on the context, either the value component or the time
- component of a V\bVD\bDE\bEF\bF is printed using _\bf_\bo_\br_\bm_\ba_\bt. It is an error to
- specify a _\bv_\bn_\ba_\bm_\be generated by a D\bDE\bEF\bF or C\bCD\bDE\bEF\bF.
+ Depending on the context, either the value component or the time
+ component of a V\bVD\bDE\bEF\bF is printed using _\bf_\bo_\br_\bm_\ba_\bt. It is an error to specify
+ a _\bv_\bn_\ba_\bm_\be generated by a D\bDE\bEF\bF or C\bCD\bDE\bEF\bF.
- Any text in _\bf_\bo_\br_\bm_\ba_\bt is printed literally with one exception: The
- percent character introduces a formatter string. This string can
- be:
+ Any text in _\bf_\bo_\br_\bm_\ba_\bt is printed literally with one exception: The percent
+ character introduces a formatter string. This string can be:
- For printing values:
+ For printing values:
- %\b%%\b% - just prints a literal '%' character
+ %\b%%\b% just prints a literal '%' character
- %\b%#\b#.\b.#\b#l\ble\be - prints numbers like 1.2346e+04. The optional integers #
- denote field width and decimal precision.
+ %\b%#\b#.\b.#\b#l\ble\be
+ prints numbers like 1.2346e+04. The optional integers # denote
+ field width and decimal precision.
- %\b%#\b#.\b.#\b#l\blf\bf - prints numbers like 12345.6789, with optional field width
- and precision.
+ %\b%#\b#.\b.#\b#l\blf\bf
+ prints numbers like 12345.6789, with optional field width and
+ precision.
- %\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
- appropriate SI magnitude unit and the value will be scaled accord-
- ingly (123456 -> 123.456 k).
+ %\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
+ appropriate SI magnitude unit and the value will be scaled
+ accordingly (123456 -> 123.456 k).
- %\b%S\bS - is similar to %\b%s\bs. It does, however, use a previously defined
+ %\b%S\bS is similar to %\b%s\bs. It does, however, use a previously defined
magnitude unit. If there is no such unit yet, it tries to define
one (just like %\b%s\bs) unless the value is zero, in which case the
magnitude unit stays undefined. Thus, formatter strings using %\b%S\bS
- and no %\b%s\bs will all use the same magnitude unit except for zero val-
- ues.
+ and no %\b%s\bs will all use the same magnitude unit except for zero
+ values.
- If you PRINT a VDEF value, you can also print the time associated
- with it by appending the string :\b:s\bst\btr\brf\bft\bti\bim\bme\be 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.
+ If you PRINT a VDEF value, you can also print the time associated with
+ it by appending the string :\b:s\bst\btr\brf\bft\bti\bim\bme\be 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.
- %\b%a\ba - The abbreviated weekday name according to the current locale.
+ %\b%a\ba The abbreviated weekday name according to the current locale.
- %\b%A\bA - The full weekday name according to the current locale.
+ %\b%A\bA The full weekday name according to the current locale.
- %\b%b\bb - The abbreviated month name according to the current locale.
+ %\b%b\bb The abbreviated month name according to the current locale.
- %\b%B\bB - The full month name according to the current locale.
+ %\b%B\bB The full month name according to the current locale.
- %\b%c\bc - The preferred date and time representation for the current
- locale.
+ %\b%c\bc The preferred date and time representation for the current locale.
- %\b%d\bd - The day of the month as a decimal number (range 01 to 31).
+ %\b%d\bd The day of the month as a decimal number (range 01 to 31).
- %\b%H\bH - The hour as a decimal number using a 24-hour clock (range 00
- to 23).
+ %\b%H\bH The hour as a decimal number using a 24-hour clock (range 00 to
+ 23).
- %\b%I\bI - The hour as a decimal number using a 12-hour clock (range 01
- to 12).
+ %\b%I\bI The hour as a decimal number using a 12-hour clock (range 01 to
+ 12).
- %\b%j\bj - The day of the year as a decimal number (range 001 to 366).
+ %\b%j\bj The day of the year as a decimal number (range 001 to 366).
- %\b%m\bm - The month as a decimal number (range 01 to 12).
+ %\b%m\bm The month as a decimal number (range 01 to 12).
- %\b%M\bM - The minute as a decimal number (range 00 to 59).
+ %\b%M\bM The minute as a decimal number (range 00 to 59).
- %\b%p\bp - Either `AM' or `PM' according to the given time value, or the
+ %\b%p\bp 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.
- %\b%S\bS - The second as a decimal number (range 00 to 61).
+ %\b%s\bs The second as a decimal number (range 00 to 61).
- %\b%U\bU - 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.
+ %\b%S\bS The seconds since the epoch (1.1.1970) (libc dependant non
+ standard!)
- %\b%V\bV - The ISO 8601:1988 week number of the current year as a decimal
+ %\b%U\bU 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.
+
+ %\b%V\bV 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.
- %\b%w\bw - The day of the week as a decimal, range 0 to 6, Sunday being
- 0. See also %u.
+ %\b%w\bw The day of the week as a decimal, range 0 to 6, Sunday being 0.
+ See also %u.
- %\b%W\bW - 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.
+ %\b%W\bW 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.
- %\b%x\bx - The preferred date representation for the current locale with-
- out the time.
+ %\b%x\bx The preferred date representation for the current locale without
+ the time.
- %\b%X\bX - The preferred time representation for the current locale with-
- out the date.
+ %\b%X\bX The preferred time representation for the current locale without
+ the date.
- %\b%y\by - The year as a decimal number without a century (range 00 to
- 99).
+ %\b%y\by The year as a decimal number without a century (range 00 to 99).
- %\b%Y\bY - The year as a decimal number including the century.
+ %\b%Y\bY The year as a decimal number including the century.
- %\b%Z\bZ - The time zone or name or abbreviation.
+ %\b%Z\bZ The time zone or name or abbreviation.
- %\b%%\b% - A literal `%' character.
+ %\b%%\b% A literal `%' character.
- P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt
- _\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 form of this command is to be used with C\bCD\bDE\bEF\bF _\bv_\bn_\ba_\bm_\bes.
+ _\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
- G\bGR\bRA\bAP\bPH\bH
+ _\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
+ form of this command is to be used with C\bCD\bDE\bEF\bF _\bv_\bn_\ba_\bm_\bes.
+ G\bGR\bRA\bAP\bPH\bH
+ _\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
- G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bf_\bo_\br_\bm_\ba_\bt
- This is the same as "PRINT", but printed inside the graph.
+ This is the same as "PRINT", but printed inside the graph.
- G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt
- _\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 the same as "PRINT", but printed inside the graph.
+ _\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
- C\bCO\bOM\bMM\bME\bEN\bNT\bT:\b:_\bt_\be_\bx_\bt
- 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 *\b*P\bPR\bRI\bIN\bNT\bT commands by writing
- '\b'\\b\:\b:'\b'.
-
- V\bVR\bRU\bUL\bLE\bE:\b:_\bt_\bi_\bm_\be#\b#_\bc_\bo_\bl_\bo_\br [:\b:_\bl_\be_\bg_\be_\bn_\bd ]
- Draw a vertical line at _\bt_\bi_\bm_\be. 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. _\bt_\bi_\bm_\be may be a 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 or C\bCD\bDE\bEF\bF here.
-
- H\bHR\bRU\bUL\bLE\bE:\b:_\bv_\ba_\bl_\bu_\be#\b#_\bc_\bo_\bl_\bo_\br [ :_\bl_\be_\bg_\be_\bn_\bd ]
- Draw a horizontal line at _\bv_\ba_\bl_\bu_\be. 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.
-
- 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]]
- Draw a line of the specified width onto the graph. _\bw_\bi_\bd_\bt_\bh 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\bva\bal\blu\bue\be can
- be generated 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 modi-
- fier is used, this line is stacked on top of the previous element
- which can be a L\bLI\bIN\bNE\bE or an A\bAR\bRE\bEA\bA.
-
- When you do not specify a color, you cannot specify a legend.
- Should you want to use STACK, use the "LINEx:<value>::STACK" form.
+ _\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
+ the same as "PRINT", but printed inside the graph.
- 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]]
- See L\bLI\bIN\bNE\bE, however the area between the x-axis and the line will be
- filled.
+ _\bC\bC_\bO\bO_\bM\bM_\bM\bM_\bE\bE_\bN\bN_\bT\bT_\b:\b:_\bt_\be_\bx_\bt
- 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]]
- Plot a tick mark (a vertical line) for each value of _\bv_\bn_\ba_\bm_\be that is
- non-zero and not *UNKNOWN*. The _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn 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.
+ 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 *\b*P\bPR\bRI\bIN\bNT\bT commands by writing '\b'\\b\:\b:'\b'.
- S\bSH\bHI\bIF\bFT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bo_\bf_\bf_\bs_\be_\bt
- Using this command R\bRR\bRD\bDt\bto\boo\bol\bl 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.
+ _\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]
+
+ Draw a vertical line at _\bt_\bi_\bm_\be. 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.
+ _\bt_\bi_\bm_\be may be a 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 or C\bCD\bDE\bEF\bF here. Dashed lines can be drawn using the
+ d\bda\bas\bsh\bhe\bes\bs modifier. See L\bLI\bIN\bNE\bE for more details.
+
+ _\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]
+
+ Draw a horizontal line at _\bv_\ba_\bl_\bu_\be. 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.
+
+ _\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:\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]
+
+ Draw a line of the specified width onto the graph. _\bw_\bi_\bd_\bt_\bh 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\bva\bal\blu\bue\be can be generated
+ 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
+ line is stacked on top of the previous element which can be a L\bLI\bIN\bNE\bE or
+ an A\bAR\bRE\bEA\bA.
+
+ The d\bda\bas\bsh\bhe\bes\bs 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 d\bda\bas\bsh\bhe\bes\bs=\b= 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 _\bo_\bn_\b__\bs and
+ _\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
+ _\bo_\bf_\bf_\bs_\be_\bt 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:<value>::STACK" form.
- 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]
- _\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_\b.
+ _\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]
+
+ See L\bLI\bIN\bNE\bE, however the area between the x-axis and the line will be
+ filled.
+
+ _\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]
+
+ Plot a tick mark (a vertical line) for each value of _\bv_\bn_\ba_\bm_\be that is non-
+ zero and not *UNKNOWN*. The _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn 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.
+
+ _\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
+
+ Using this command R\bRR\bRD\bDt\bto\boo\bol\bl 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.
+
+ _\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}
+
+ 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 T\bTE\bEX\bXT\bTA\bAL\bLI\bIG\bGN\bN 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.
+
+ _\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]
+
+ _\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!
S\bSo\bom\bme\be n\bno\bot\bte\bes\bs o\bon\bn s\bst\bta\bac\bck\bki\bin\bng\bg
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 I\bIF\bF and U\bUN\bN to do so.
+ make sure never to stack upon the unknown value. Use a CDEF
+ instruction with I\bIF\bF and U\bUN\bN to do so.
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
- E\bEs\bsc\bca\bap\bpi\bin\bng\bg t\bth\bhe\be c\bco\bol\blo\bon\bn
-
+ E\bEs\bsc\bca\bap\bpi\bin\bng\bg t\bth\bhe\be c\bco\bol\blo\bon\bn
A colon ':' in a _\bl_\be_\bg_\be_\bn_\bd 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.
-
- S\bSt\btr\bri\bin\bng\bg F\bFo\bor\brm\bma\bat\btt\bti\bin\bng\bg
+ 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\bSt\btr\bri\bin\bng\bg F\bFo\bor\brm\bma\bat\btt\bti\bin\bng\bg
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: \\b\j\bj for justified, \\b\l\bl for left aligned, \\b\r\br for right
aligned, and \\b\c\bc for centered. In the next section there is an example
showing how to use centered formatting.
\\b\n\bn is a valid alias for \\b\l\bl 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 \\b\g\bg at the end of the string. The \\b\g\bg also ignores
- any space inside the string if it is at the very end of the string.
- This can be used in connection with %\b%s\bs to suppress empty unit strings.
+ items printed into the graph. The space following a string can be
+ suppressed by putting a \\b\g\bg at the end of the string. The \\b\g\bg also
+ ignores any space inside the string if it is at the very end of the
+ string. This can be used in connection with %\b%s\bs to suppress empty unit
+ strings.
GPRINT:a:MAX:%lf%s\g
@@ -263,6 +289,119 @@ 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
characters or the sequence \\b\t\bt to 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 s\bsp\bpa\ban\bn tags for inline formatting
+ instructions.:
+
+ A simple example of a marked-up string might be:
+
+ <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
+
+ The complete list of attributes for the span tag (taken from the pango
+ documentation):
+
+ f\bfo\bon\bnt\bt_\b_d\bde\bes\bsc\bc
+ A font description string, such as "Sans Italic 12"; note that any
+ other span attributes will override this description. So if you
+ have "Sans Italic" and also a style="normal" attribute, you will
+ get Sans normal, not italic.
+
+ f\bfo\bon\bnt\bt_\b_f\bfa\bam\bmi\bil\bly\by
+ A font family name
+
+ f\bfa\bac\bce\be
+ Synonym for font_family
+
+ s\bsi\biz\bze\be
+ Font size in 1024ths of a point, or one of the absolute sizes
+ 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large',
+ 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If
+ you want to specify a absolute size, it's usually easier to take
+ advantage of the ability to specify a partial font description
+ using 'font_desc'; you can use font_desc='12.5' rather than
+ size='12800'.
+
+ s\bst\bty\byl\ble\be
+ One of 'normal', 'oblique', 'italic'
+
+ w\bwe\bei\big\bgh\bht\bt
+ One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold',
+ 'heavy', or a numeric weight
+
+ v\bva\bar\bri\bia\ban\bnt\bt
+ 'normal' or 'smallcaps'
+
+ s\bst\btr\bre\bet\btc\bch\bh
+ One of 'ultracondensed', 'extracondensed', 'condensed',
+ 'semicondensed', 'normal', 'semiexpanded', 'expanded',
+ 'extraexpanded', 'ultraexpanded'
+
+ f\bfo\bor\bre\beg\bgr\bro\bou\bun\bnd\bd
+ An RGB color specification such as '#00FF00' or a color name such
+ as 'red'
+
+ b\bba\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd
+ An RGB color specification such as '#00FF00' or a color name such
+ as 'red'
+
+ u\bun\bnd\bde\ber\brl\bli\bin\bne\be
+ One of 'none', 'single', 'double', 'low', 'error'
+
+ u\bun\bnd\bde\ber\brl\bli\bin\bne\be_\b_c\bco\bol\blo\bor\br
+ The color of underlines; an RGB color specification such as
+ '#00FF00' or a color name such as 'red'
+
+ r\bri\bis\bse\be
+ Vertical displacement, in 10000ths of an em. Can be negative for
+ subscript, positive for superscript.
+
+ s\bst\btr\bri\bik\bke\bet\bth\bhr\bro\bou\bug\bgh\bh
+ 'true' or 'false' whether to strike through the text
+
+ s\bst\btr\bri\bik\bke\bet\bth\bhr\bro\bou\bug\bgh\bh_\b_c\bco\bol\blo\bor\br
+ The color of strikethrough lines; an RGB color specification such
+ as '#00FF00' or a color name such as 'red'
+
+ f\bfa\bal\bll\blb\bba\bac\bck\bk
+ 'true' or 'false' whether to enable fallback. If disabled, then
+ characters will only be used from the closest matching font on the
+ system. No fallback will be done to other fonts on the system that
+ might contain the characters in the text. Fallback is enabled by
+ default. Most applications should not disable fallback.
+
+ l\bla\ban\bng\bg
+ A language code, indicating the text language
+
+ l\ble\bet\btt\bte\ber\br_\b_s\bsp\bpa\bac\bci\bin\bng\bg
+ Inter-letter spacing in 1024ths of a point.
+
+ g\bgr\bra\bav\bvi\bit\bty\by
+ One of 'south', 'east', 'north', 'west', 'auto'.
+
+ g\bgr\bra\bav\bvi\bit\bty\by_\b_h\bhi\bin\bnt\bt
+ One of 'natural', 'strong', 'line'.
+
+ To save you some typing, there are also some shortcuts:
+
+ b\bb Bold
+
+ b\bbi\big\bg Makes font relatively larger, equivalent to <span size="larger">
+
+ i\bi Italic
+
+ s\bs Strikethrough
+
+ s\bsu\bub\bb Subscript
+
+ s\bsu\bup\bp Superscript
+
+ s\bsm\bma\bal\bll\bl
+ Makes font relatively smaller, equivalent to <span size="smaller">
+
+ t\btt\bt Monospace font
+
+ u\bu Underline
+
S\bSE\bEE\bE A\bAL\bLS\bSO\bO
rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
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
A\bAU\bUT\bTH\bHO\bOR\bR
Program by Tobias Oetiker <tobi@oetiker.ch>
- This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
+ This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl> with
+ corrections and/or additions by several people
-1.2.28 2008-07-23 RRDGRAPH_GRAPH(1)
+1.3.8 2009-02-21 RRDGRAPH_GRAPH(1)