X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.pod;h=8aca6499b9836d8379cca92653efdaa3a624fc86;hb=5b7af8fabd296f8e24b91c5c33682681adb15d43;hp=4543d7453e44e08102745faa61d45212517afc0d;hpb=b6076fdcf6de8361144c0d49c0b61623b5b26342;p=rrdtool.git diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod index 4543d74..8aca649 100644 --- a/doc/rrdgraph_graph.pod +++ b/doc/rrdgraph_graph.pod @@ -24,19 +24,12 @@ BB<:>IB<#>I[I][B<:>I[B<:>I]] BB<:>IB<:>I -=cut - -# -#BB<:>IB<#>I[I][B<:>I] -# - -=pod +BB<:>{B|B|B|B
} BB<:>IB<:>IB<:>I (deprecated) BB<:>IB<:>IB<:>I (deprecated) - BB<:>IB<#>I[B<:>I] (deprecated) =head1 DESCRIPTION @@ -202,7 +195,7 @@ A literal `%' character. =back -=item BIB<:>I<:>I +=item BIB<:>IB<:>I I The first form of this command is to be used with B Is. @@ -238,7 +231,7 @@ from a B. It is an error to use Is from B or B here. =item BB<:>IB<#>I [ :I ] -Draw a horyzontal line at I. HRULE acts much like LINE except that +Draw a horizontal line at I. HRULE acts much like LINE except that will have no effect on the scale of the graph. If a HRULE is outside the graphing area it will just not be visible. @@ -279,6 +272,14 @@ week. Make sure to tell the viewer of your graph you did this ... As with the other graphing elements, you can specify a number or a variable here. +=item BB<:>{B|B|B|B
} + +Labels are placed below the graph. When they overflow to the left, they wrap +to the next line. By default, lines are justified left and right. The +B function lets you change this default. This is a command and +not an option, so that you can change the default several times in your +argument list. + =cut # This section describes the curruently defunct @@ -344,6 +345,9 @@ 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 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. + 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 @@ -360,6 +364,141 @@ characters or the sequence B<\t> to 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 B tags for inline formatting instructions.: + +A simple example of a marked-up string might be: + + Blue text is cool! + +The complete list of attributes for the span tag (taken from the pango documentation): + +=over + +=item B + +A font description string, such as "Sans Italic 12"; note that any other span attributes will override this description. So if you have "Sans Italic" and also a style="normal" attribute, you will get Sans normal, not italic. + +=item B + +A font family name + +=item B + +Synonym for font_family + +=item B + +Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If you want to specify a absolute size, it's usually easier to take advantage of the ability to specify a partial font description using 'font_desc'; you can use font_desc='12.5' rather than size='12800'. + +=item B