X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph_graph.src;h=907ff18833f337083b3c133f06a83b7b877d2478;hp=d9b2d9c46b633d1b34661c3522ec65ed4ca4d944;hb=d0d6b0412fb31c422cbb1b6be4f12df991a1da54;hpb=23d1c29c5b06a786817613f266e04887af4945c4 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