Code

Imported upstream version 1.4.8
[pkg-rrdtool.git] / doc / rrdgraph_graph.txt
index f89f42683a041e970fa1d825e304528b8fd198d1..52bf57f05df65fa0e2f381d5e6a65812106c1830 100644 (file)
@@ -16,9 +16,9 @@ S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
 
        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]]
 
@@ -179,7 +179,7 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        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
@@ -190,6 +190,11 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        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
@@ -199,9 +204,9 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        _\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.
@@ -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
@@ -418,4 +435,4 @@ A\bAU\bUT\bTH\bHO\bOR\bR
 
 
 
-1.4.2                             2009-10-14                 RRDGRAPH_GRAPH(1)
+1.4.8                             2013-05-23                 RRDGRAPH_GRAPH(1)