From d0d6b0412fb31c422cbb1b6be4f12df991a1da54 Mon Sep 17 00:00:00 2001 From: oetiker Date: Sun, 20 Mar 2005 20:59:31 +0000 Subject: [PATCH] document tabbing support by adding in the textformatting notes document --tabwidth argument document AXIS color git-svn-id: svn://svn.oetiker.ch/rrdtool/trunk/program@325 a5681a0c-68f1-0310-ab6d-d61299d08faa --- doc/rrdgraph.src | 23 ++++++++++++++--------- doc/rrdgraph_graph.src | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 9 deletions(-) diff --git a/doc/rrdgraph.src b/doc/rrdgraph.src index df7a836..b829a7b 100644 --- a/doc/rrdgraph.src +++ b/doc/rrdgraph.src @@ -291,15 +291,16 @@ would look like this: B<[-c|--color I#I[I]]> -Override the default colors for the standard elements of the graph. -The I is one of C ground, C, C for the -left and top border, C for the right and bottom border, C, -C for the major grid, C, C and axis, C. -Each color is composed out of three hexadecimal numbers specifying -its color component (00 is off, FF is maximum) of red, green and blue. -Optionally you may add another hexadecimal number specifying the -transparency (FF is solid). -You may set this option several times to alter multiple defaults. +Override the default colors for the standard elements of the graph. The +I is one of C background, C for the background of +the actual graph, C for the left and top border, C for the +right and bottom border, C, C for the major grid, C for +the color of the font, C for the axis of the graph and finaly C +for the arrow head pointing to the future. Each color is composed out of +three hexadecimal numbers specifying its color component (00 is off, FF is +maximum) of red, green and blue. Optionally you may add another hexadecimal +number specifying the transparency (FF is solid). You may set this option +several times to alter multiple defaults. A green arrow is made by: C<--color ARROW:00FF00> @@ -332,6 +333,10 @@ B<[-F|--force-rules-legend]> Force the generation of HRULE and VRULE legend even if those HRULE or VRULE will not be drawn because out of graph boundaries (mimics behaviour of pre 1.0.42 versions). +B<[-T|--tabwidth EvalueE]> + +By default the tab-width is 40 pixels, use this option to change it. + B<[-b|--base EvalueE]> If you are graphing memory (and NOT network traffic) this switch diff --git a/doc/rrdgraph_graph.src b/doc/rrdgraph_graph.src index d9b2d9c..907ff18 100644 --- a/doc/rrdgraph_graph.src +++ b/doc/rrdgraph_graph.src @@ -262,4 +262,39 @@ a variable here. =back +=head1 NOTES on legend arguments + +=head2 Escaping the colon + +In a ':' in a I argument will mark the end of the legend. To +enter a ':' into a legend, the colon must be escaped with a backslash '\:'. +Beware, that many environments look for backslashes themselves, so it may +be necessary to write two backslashes so that one is passed onto rrd_graph. + +=head2 String Formatting + +The text printed below the actual graph can be formated by appending special +escaped 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> for justified, B<\l> for left aligned, B<\r> for +right aligned and B<\c> for centered. In the next section there is an +example showing how to use centered formating. + +Normally there are two space characters inserted between every two items +printed into the graph. The space following a string can be suppressed by +putting a B<\g> at the end of the string. The B<\g> 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> to suppress empty unit strings. + + GPRINT:a:MAX:%lf%s\g + +A special case is COMMENT:B<\s> this 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> to lin-up legend elements. Note that the tabs inserted are +relative to the start of the current legend element! + =include see_also -- 2.11.0