![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph_graph.txt b/doc/rrdgraph_graph.txt
index f024a06ba14c6d7dd53135f460d6b214938ee1fb..03050eade4f0c79c8da4b64471d48f9e35ee38b2 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_\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]
+ 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]]
- 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_\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]]
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)
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 ]
+ 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]]
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.
+ 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.
- H\bHR\bRU\bUL\bLE\bE:\b:_\bv_\ba_\bl_\bu_\be#\b#_\bc_\bo_\bl_\bo_\br [ :_\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_\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]]
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]]
+ 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]]
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
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.
+ 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.
other graphing elements, you can specify a number or a variable
here.
+ 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}
+ 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.
+
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.
@@ -261,6 +288,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 instruc-
+ tions.:
+
+ 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', 'semicon-
+ densed', '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
-1.2.26 2007-11-20 RRDGRAPH_GRAPH(1)
+1.3rc6 2008-03-15 RRDGRAPH_GRAPH(1)