diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod
index f40877cbae03d70ddd22b756f3f0054cf6697c07..fed1d438278989f394213268ee56591b8202944d 100644 (file)
--- a/doc/rrdgraph_graph.pod
+++ b/doc/rrdgraph_graph.pod
If you don't use any graph elements, no graph is generated.
Similarly, no report is generated if you don't use print options.
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
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
For printing values:
For printing values:
-=over 4
+=over
=item B<%%>
=item B<%%>
=back
If you PRINT a VDEF value, you can also print the time associated with it by appending the string
=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.
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>
=item B<%a>
`am'. Note that in many locales and `pm' notation is unsupported and in
such cases %p will return an empty string.
`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).
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
=item B<%U>
The week number of the current year as a decimal number, range 00 to 53, starting with the
=back
=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.
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.
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.
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<'\:'>.
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>][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
+=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
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
Dashed lines can be drawn using the B<dashes> modifier. See B<LINE> for more
details.
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>[B<:>I<legend>][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
+=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 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.
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>]][B<:dashes>[B<=>I<on_s>[,I<off_s>[,I<on_s>,I<off_s>]...]][B<:dash-offset=>I<offset>]]
+=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
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
When you do not specify a color, you cannot specify a legend. Should
you want to use STACK, use the "LINEx:<value>::STACK" form.
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.
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
the tick mark as a fraction of the y-axis; the default value is 0.1 (10% of
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
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.
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
Using this command B<RRDtool> will graph the following elements
with the specified offset. For instance, you can specify an
As with the other graphing elements, you can specify a number or
a variable here.
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
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
=cut
=cut
-# This section describes the curruently defunct
+# This section describes the currently defunct
# PieChart code.
#
# =item B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
# PieChart code.
#
# =item B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
=pod
=pod
-=item B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
-
-I<Deprecated. Use the B<STACK> modifiers on the other commands.>
+=head3 B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
-=back
+I<Deprecated. Use the B<STACK> modifiers on the other commands instead!>
B<Some notes on stacking>
B<Some notes on stacking>
example showing how to use centered formatting.
B<\n> is a valid alias for B<\l> since incomplete parsing in earlier
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
Normally there are two space characters inserted between every two items
printed into the graph. The space following a string can be suppressed by
Program by Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
Program by Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
-This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
+This manual page by Alex van den Bogaerdt E<lt>alex@vandenbogaerdt.nlE<gt>
+with corrections and/or additions by several people