![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph_graph.txt b/doc/rrdgraph_graph.txt
index 993771be64f94471d00dd95d8cf906bbf71abb7c..1d9481728a7c5334c0f235516ae9f93cbb188df3 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_\b-
- _\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]]
+ 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_\b-
- _\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][:\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_\b-
- _\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-
- _\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]][:\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]]
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]
- Depending on the context, either the value component or the time compo-
- nent 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:
field width and decimal precision.
%\b%#\b#.\b.#\b#l\blf\bf
- prints numbers like 12345.6789, with optional field width and pre-
- cision.
+ 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).
+ 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 magni-
- tude 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 magni-
- tude 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 values.
+ %\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
+ 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 C library. This means that the
- conversion specifier may vary. Check the manual page if you are uncer-
- tain. The following is a list of conversion specifiers usually sup-
- ported across the board.
+ 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%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 cor-
- responding 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%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 seconds since the epoch (1.1.1970) (libc dependant non stan-
- dard!)
+ %\b%S\bS The seconds since the epoch (1.1.1970) (libc dependant non
+ standard!)
%\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 num-
- ber, 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%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.
_\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
-
+ 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
This is the same as "PRINT", but printed inside the graph.
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'.
- _\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-
- _\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]
+ _\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 hex-
- adecimal 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.
+ 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_\b-
- _\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]
+ _\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_\b-
- _\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-
- _\bs_\be_\bt_\b]_\b]
+ _\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
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
@@ -284,10 +274,11 @@ 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
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
@@ -299,8 +290,8 @@ 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
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 instruc-
- tions.:
+ 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:
@@ -341,9 +332,9 @@ 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
'normal' or 'smallcaps'
s\bst\btr\bre\bet\btc\bch\bh
- One of 'ultracondensed', 'extracondensed', 'condensed', 'semicon-
- densed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded',
- 'ultraexpanded'
+ 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
-1.3.99909060808 2009-02-21 RRDGRAPH_GRAPH(1)
+1.3.999 2009-05-10 RRDGRAPH_GRAPH(1)