X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.pod;h=693b1edd9ff6cc34285c25c90b6d73f6993a026a;hb=3790ee46225952fe7410343ecc4b9702cf70e421;hp=7f2a36b67e3702e176dcc0787952d739e3d13780;hpb=35354e059a77479a7a135c1e4fc71c76523fd7c4;p=rrdtool.git diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod index 7f2a36b..693b1ed 100644 --- a/doc/rrdgraph_graph.pod +++ b/doc/rrdgraph_graph.pod @@ -85,7 +85,7 @@ will all use the same magnitude unit except for zero values. =back If you PRINT a VDEF value, you can also print the time associated with it by appending the string -B<:strftime> to the format. Note that rrdtool uses the strftime function of your OSs clibrary. This means that +B<:strftime> 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 supported across the board. @@ -142,10 +142,14 @@ strings for the current locale. Noon is treated as `pm' and midnight as `am'. Note that in many locales and `pm' notation is unsupported and in such cases %p will return an empty string. -=item B<%S> +=item B<%s> The second as a decimal number (range 00 to 61). +=item B<%S> + +The seconds since the epoch (1.1.1970) (libc dependent non standard!) + =item B<%U> The week number of the current year as a decimal number, range 00 to 53, starting with the @@ -258,12 +262,20 @@ you want to use STACK, use the "LINEx:::STACK" form. See B, however the area between the x-axis and the line will be filled. +=head3 BB<:>I[B<#>I[B<#>IB<:>I][B<:>[I][B<:STACK>]] + +Similar to B, except the area between the line and the x-axis will contain a gradient from color1 to color2. + +The I parameter can create three different behaviors. If I > 0, then the gradient is a fixed height, starting at the line going down. If I < 0, then the gradient starts at fixed height above the x-axis, going down to the x-axis. If I == 0, then the gradient goes from the line to x-axis. + +If not present, I defaults to #00000000 and I defaults to 50. + =head3 BB<:>IB<#>I[I][B<:>I[B<:>I]] Plot a tick mark (a vertical line) for each value of I that is non-zero and not *UNKNOWN*. The I argument specifies the length of the tick mark as a fraction of the y-axis; the default value is 0.1 (10% of -the axis). Note that the color specification is not optional. The TICK marks normaly +the axis). Note that the color specification is not optional. The TICK marks normally start at the lower edge of the graphing area. If the fraction is negative they start at the upper border of the graphing area. @@ -286,7 +298,7 @@ argument list. =cut -# This section describes the curruently defunct +# This section describes the currently defunct # PieChart code. # # =item BB<:>IB<#>I[I][B<:>I] @@ -308,9 +320,7 @@ argument list. =head3 BB<:>IB<#>I[B<:>I] -I modifiers on the other commands.> - -=back +I modifiers on the other commands instead!> B @@ -350,7 +360,7 @@ right aligned, and B<\c> for centered. In the next section there is an example showing how to use centered formatting. B<\n> is a valid alias for B<\l> since incomplete parsing in earlier -versions of rrdtool lead to this behaviour and a number of people has been using it. +versions 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 items printed into the graph. The space following a string can be suppressed by @@ -363,8 +373,15 @@ in connection with B<%s> to suppress empty unit strings. A special case is COMMENT:B<\s> 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> to line-up legend elements. Note that +If you want to have left and right aligned legends on the same line use COMMENT:B<\u> +to go one line back like this: + + COMMENT:left\l + COMMENT:\u + COMMENT:right\r + +When using a proportional font in your graph, the tab +characters or the sequence B<\t> will line-up legend elements. Note that the tabs inserted are relative to the start of the current legend element! @@ -437,7 +454,7 @@ Vertical displacement, in 10000ths of an em. Can be negative for subscript, posi =item B -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' =item B @@ -479,7 +496,7 @@ Italic =item B -Strikethrough +Strike through =item B @@ -516,4 +533,5 @@ Make sure to read L for tipsEtricks. Program by Tobias Oetiker Etobi@oetiker.chE -This manual page by Alex van den Bogaerdt Ealex@ergens.op.het.netE +This manual page by Alex van den Bogaerdt Ealex@vandenbogaerdt.nlE +with corrections and/or additions by several people