X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.pod;h=a932fa0637165f4c98e99ba577decc412483f423;hb=7da79af65016ae22b7d46abead4b2717ae722937;hp=c7ca4fa2b96983283249a50be04e1fa38d02e034;hpb=65878d5b2342b37186d9557f314e8a37dbc86de2;p=rrdtool.git

diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod
index c7ca4fa..a932fa0 100644
--- a/doc/rrdgraph_graph.pod
+++ b/doc/rrdgraph_graph.pod
@@ -12,11 +12,11 @@ B<GPRINT>B<:>I<vname>B<:>I<format>
 
 B<COMMENT>B<:>I<text>
 
-B<VRULE>B<:>I<time>B<#>I<color>[B<:>I<legend>]
+B<VRULE>B<:>I<time>B<#>I<color>[B<:>I<legend>][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
 
-B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>]
+B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
 
-B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
+B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
 
 B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
 
@@ -38,12 +38,9 @@ These instructions allow you to generate your image or report.
 If you don't use any graph elements, no graph is generated.
 Similarly, no report is generated if you don't use print options.
 
-=head1 PRINT
+=head2 PRINT
 
-=over 4
-
-
-=item B<PRINT:>I<vname>B<:>I<format>[B<:strftime>]
+=head3 B<PRINT:>I<vname>B<:>I<format>[B<:strftime>]
 
 Depending on the context, either the value component or the time
 component of a B<VDEF> is printed using I<format>. It is an error
@@ -55,7 +52,7 @@ can be:
 
 For printing values:
 
-=over 4
+=over
 
 =item B<%%>
 
@@ -92,7 +89,7 @@ B<:strftime> to the format. Note that rrdtool uses the strftime function of your
 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. 
 
-=over 4
+=over
 
 =item B<%a>
 
@@ -145,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 dependant non standard!)
+
 =item B<%U>
 
 The  week  number  of  the current year as a decimal number, range 00 to 53, starting with the
@@ -195,47 +196,46 @@ A literal `%' character.
 
 =back
 
-=item B<PRINT:>I<vname>B<:>I<CF>B<:>I<format>
+=head3 B<PRINT:>I<vname>B<:>I<CF>B<:>I<format>
 
 I<Deprecated. Use the new form of this command in new scripts.>
 The first form of this command is to be used with B<CDEF> I<vname>s.
 
-=back
-
-=head1 GRAPH
 
-=over 4
+=head2 GRAPH
 
-=item B<GPRINT>B<:>I<vname>B<:>I<format>
+=head3 B<GPRINT>B<:>I<vname>B<:>I<format>
 
 This is the same as C<PRINT>, but printed inside the graph.
 
-=item B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format>
+=head3 B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format>
 
 I<Deprecated. Use the new form of this command in new scripts.>
 This is the same as C<PRINT>, but printed inside the graph.
 
-=item B<COMMENT>B<:>I<text>
+=head3 B<COMMENT>B<:>I<text>
 
 Text is printed literally in the legend section of the graph. Note that in
 RRDtool 1.2 you have to escape colons in COMMENT text in the same way you
 have to escape them in B<*PRINT> commands by writing B<'\:'>.
 
-=item B<VRULE>B<:>I<time>B<#>I<color> [B<:>I<legend> ]
+=head3 B<VRULE>B<:>I<time>B<#>I<color>[B<:>I<legend>][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
 
 Draw a vertical line at I<time>.  Its color is composed from three
 hexadecimal numbers specifying the rgb color components (00 is off, FF is
 maximum) red, green and blue followed by an optional alpha. Optionally, a legend box and string is
 printed in the legend section. I<time> may be a number or a variable
 from a B<VDEF>. It is an error to use I<vname>s from B<DEF> or B<CDEF> here.
+Dashed lines can be drawn using the B<dashes> modifier. See B<LINE> for more
+details.
 
-=item B<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
+=head3 B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
 
-Draw a horyzontal line at I<value>.  HRULE acts much like LINE except that
+Draw a horizontal line at I<value>.  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.
 
-=item B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
+=head3 B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
 
 Draw a line of the specified width onto the graph. I<width> can be a
 floating point number. If the color is not specified, the drawing is done
@@ -246,15 +246,23 @@ B<VDEF>, and B<CDEF>.  If the optional B<STACK> modifier is used, this line
 is stacked on top of the previous element which can be a B<LINE> or an
 B<AREA>.
 
+The B<dashes> 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 B<dashes=> parameter is followed by either
+one value or an even number (1, 2, 4, 6, ...) of positive values. Each value
+provides the length of alternate I<on_s> and I<off_s> portions of the
+stroke. The B<dash-offset> parameter specifies an I<offset> 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.
 
-=item B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
+=head3 B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
 
 See B<LINE>, however the area between the x-axis and the line will
 be filled.
 
-=item B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
+=head3 B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
 
 Plot a tick mark (a vertical line) for each value of I<vname> that is
 non-zero and not *UNKNOWN*. The I<fraction> argument specifies the length of
@@ -263,7 +271,7 @@ the axis). Note that the color specification is not optional. The TICK marks nor
 start at the lower edge of the graphing area. If the fraction is negative they start
 at the upper border of the graphing area.
 
-=item B<SHIFT>B<:>I<vname>B<:>I<offset>
+=head3 B<SHIFT>B<:>I<vname>B<:>I<offset>
 
 Using this command B<RRDtool> will graph the following elements
 with the specified offset.  For instance, you can specify an
@@ -272,7 +280,7 @@ 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 B<TEXTALIGN>B<:>{B<left>|B<right>|B<justified>|B<center>}
+=head3 B<TEXTALIGN>B<:>{B<left>|B<right>|B<justified>|B<center>}
 
 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
@@ -302,11 +310,9 @@ argument list.
 
 =pod
 
-=item B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
+=head3 B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
 
-I<Deprecated.  Use the B<STACK> modifiers on the other commands.>
-
-=back
+I<Deprecated.  Use the B<STACK> modifiers on the other commands instead!>
 
 B<Some notes on stacking>
 
@@ -364,6 +370,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<span> tags for inline formatting instructions.:
+
+A simple example of a marked-up string might be: 
+
+ <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
+
+The complete list of attributes for the span tag (taken from the pango documentation):
+
+=over
+
+=item B<font_desc>
+
+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<font_family>
+
+A font family name
+
+=item B<face>
+
+Synonym for font_family
+
+=item B<size>
+
+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<style>
+
+One of 'normal', 'oblique', 'italic'
+
+=item B<weight>
+
+One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight
+
+=item B<variant>
+
+'normal' or 'smallcaps'
+
+=item B<stretch>
+
+One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'
+
+=item B<foreground>
+
+An RGB color specification such as '#00FF00' or a color name such as 'red'
+
+=item B<background>
+
+An RGB color specification such as '#00FF00' or a color name such as 'red'
+
+=item B<underline>
+
+One of 'none', 'single', 'double', 'low', 'error'
+
+=item B<underline_color>
+
+The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'
+
+=item B<rise>
+
+Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.
+
+=item B<strikethrough>
+
+'true' or 'false' whether to strike through the text
+
+=item B<strikethrough_color>
+
+The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'
+
+=item B<fallback>
+
+'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.
+
+=item B<lang>
+
+A language code, indicating the text language
+
+=item B<letter_spacing>
+
+Inter-letter spacing in 1024ths of a point.
+
+=item B<gravity>
+
+One of 'south', 'east', 'north', 'west', 'auto'.
+
+=item B<gravity_hint>
+
+One of 'natural', 'strong', 'line'.
+
+=back
+
+To save you some typing, there are also some shortcuts:
+
+=over
+
+=item B<b>
+
+Bold
+
+=item B<big>
+
+Makes font relatively larger, equivalent to <span size="larger">
+
+=item B<i>
+
+Italic
+
+=item B<s>
+
+Strikethrough
+
+=item B<sub>
+
+Subscript
+
+=item B<sup>
+
+Superscript
+
+=item B<small>
+
+Makes font relatively smaller, equivalent to <span size="smaller">
+
+=item B<tt>
+
+Monospace font
+
+=item B<u>
+
+Underline 
+
+=back
+
 =head1 SEE ALSO
 
 L<rrdgraph> gives an overview of how B<rrdtool graph> works.