![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph_graph.txt b/doc/rrdgraph_graph.txt
index 1ec716906c5d929e12665cd6144f991881c8770e..52bf57f05df65fa0e2f381d5e6a65812106c1830 100644 (file)
--- a/doc/rrdgraph_graph.txt
+++ b/doc/rrdgraph_graph.txt
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]][:\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][:\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]]
- 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]]
+ 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]]
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]]
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
+ 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
%\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
+ %\b%S\bS The seconds since the epoch (1.1.1970) (libc dependent non
standard!)
%\b%U\bU The week number of the current year as a decimal number, range
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]
+ _\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]
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
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.
+ Normally the graphing function makes sure that the entire L\bLI\bIN\bNE\bE or A\bAR\bRE\bEA\bA
+ is visible in the chart. The scaling of the chart will be modified
+ accordingly if necessary. Any L\bLI\bIN\bNE\bE or A\bAR\bRE\bEA\bA can be excluded from this
+ process by adding the option s\bsk\bki\bip\bps\bsc\bca\bal\ble\be.
+
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
_\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.
+ you want to use S\bST\bTA\bAC\bCK\bK, use the "LINEx:<value>::STACK" form.
- _\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]
+ _\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]
See L\bLI\bIN\bNE\bE, however the area between the x-axis and the line will be
filled.
@@ -270,7 +275,7 @@ 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
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 behavior 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
@@ -285,9 +290,21 @@ 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
A special case is COMMENT:\\b\s\bs which inserts some additional vertical
space before placing the next row of legends.
- If you are using the proportional font in your graph, you can use tab
- 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!
+ If you want to have left and right aligned legends on the same line use
+ COMMENT:\\b\u\bu to go one line back like this:
+
+ COMMENT:left\l
+ COMMENT:\u
+ COMMENT:right\r
+
+ There is also a 'nop' control for situations where you want a string to
+ actually end in a backslash character sequence \\b\.\b.
+
+ COMMENT:OS\2\.
+
+ When using a proportional font in your graph, the tab characters or the
+ sequence \\b\t\bt will 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
@@ -359,8 +376,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
'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'
+ The color of crossed out 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
@@ -389,7 +406,7 @@ 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
i\bi Italic
- s\bs Strikethrough
+ s\bs Strike through
s\bsu\bub\bb Subscript
-1.3.8 2009-02-21 RRDGRAPH_GRAPH(1)
+1.4.8 2013-05-23 RRDGRAPH_GRAPH(1)