-=head1 NAME
+=pod
+
+=head1 NAME
rrdgraph_graph - rrdtool graph command reference
B<COMMENT>B<:>I<text>
-B<VRULE>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
+B<VRULE>B<:>I<time>B<#>I<color>[B<:>I<legend>]
-B<LINE>I<width>B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
+B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>]
-B<AREA>B<:>I<vname>B<#>I<color>[B<:>I<legend>][B<:>B<STACK>]
+B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
+
+B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>]]
B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
B<SHIFT>B<:>I<vname>B<:>I<offset>
-=cut
-
-B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
-
-=pod
+B<TEXTALIGN>B<:>{B<left>|B<right>|B<justified>|B<center>}
B<PRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
-B<HRULE>B<:>I<value>B<#>I<color>[B<:>I<legend>] (deprecated)
-
B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>] (deprecated)
=head1 DESCRIPTION
=over 4
-=item B<PRINT:>I<vname>B<:>I<CF><:>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.
-
-=item B<PRINT:>I<vname>B<:>I<format>
+=item 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
=over 4
-=item *
+=item B<%%>
-B<%%> just prints a literal '%' character
+just prints a literal '%' character
-=item *
+=item B<%#.#le>
-B<%#.#le> prints numbers like 1.2346e+04. The optional integers # denote field
+prints numbers like 1.2346e+04. The optional integers # denote field
width and decimal precision.
-=item *
+=item B<%#.#lf>
-B<%#.#lf> prints numbers like 12345.6789, with optional field width
+prints numbers like 12345.6789, with optional field width
and precision.
-=item *
+=item B<%s>
-B<%s> place this after B<%le>, B<%lf> or B<%lg>. This will be replaced by the
+place this after B<%le>, B<%lf> or B<%lg>. This will be replaced by the
appropriate SI magnitude unit and the value will be scaled
accordingly (123456 -> 123.456 k).
-=item *
+=item B<%S>
-B<%S> is similar to B<%s>. It does, however, use a previously defined
+is similar to B<%s>. It does, however, use a previously defined
magnitude unit. If there is no such unit yet, it tries to define
one (just like B<%s>) unless the value is zero, in which case the magnitude
unit stays undefined. Thus, formatter strings using B<%S> and no B<%s>
=back
-For printing times:
+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
+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
-=item *
+=item B<%a>
+
+The abbreviated weekday name according to the current locale.
+
+=item B<%A>
+
+The full weekday name according to the current locale.
+
+=item B<%b>
+
+The abbreviated month name according to the current locale.
+
+=item B<%B>
+
+The full month name according to the current locale.
+
+=item B<%c>
+
+The preferred date and time representation for the current locale.
+
+=item B<%d>
+
+The day of the month as a decimal number (range 01 to 31).
+
+=item B<%H>
+
+The hour as a decimal number using a 24-hour clock (range 00 to 23).
+
+=item B<%I>
+
+The hour as a decimal number using a 12-hour clock (range 01 to 12).
+
+=item B<%j>
+
+The day of the year as a decimal number (range 001 to 366).
+
+=item B<%m>
-B<%%> just prints a literal '%' character
+The month as a decimal number (range 01 to 12).
-=item *
+=item B<%M>
-B<%a, %A> print the abbreviated or full name of the day of the week.
+The minute as a decimal number (range 00 to 59).
-=item *
+=item B<%p>
-B<%b, %B> print the abbreviated or full name of the month.
+Either `AM' or `PM' according to the given time value, or the corresponding
+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 *
+=item B<%S>
-B<%d, %m, %y, %H, %M, %S> print day, month, year, hour, minute, and
-second in two-digit format.
+The second as a decimal number (range 00 to 61).
-=item *
+=item B<%U>
-B<%Y> prints the year in 4-digit format.
+The week number of the current year as a decimal number, range 00 to 53, starting with the
+first Sunday as the first day of week 01. See also %V and %W.
-=item *
+=item B<%V>
-B<%I, %p> print the hour (01..12), 'am' or 'pm'.
+The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where
+week 1 is the first week that has at least 4 days in the current year, and with Monday as the
+first day of the week. See also %U and %W.
-=item *
+=item B<%w>
-B<%j, %w> print day of the week (0..6), day of the year (1..366)
+The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u.
-=item *
+=item B<%W>
-B<%c, %x, %X> print date+time, date only, time only.
+The week number of the current year as a decimal number, range 00 to 53, starting with the
+first Monday as the first day of week 01.
-=item *
+=item B<%x>
-B<%U, %W> number of the week of the current year, with either the
-first Sunday (%U) or the first Monday (%W) determining the first week.
+The preferred date representation for the current locale without the time.
-=item *
+=item B<%X>
-B<%Z> prints the time zone.
+The preferred time representation for the current locale without the date.
+
+=item B<%y>
+
+The year as a decimal number without a century (range 00 to 99).
+
+=item B<%Y>
+
+The year as a decimal number including the century.
+
+=item B<%Z>
+
+The time zone or name or abbreviation.
+
+=item B<%%>
+
+A literal `%' character.
=back
+=item 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
-=item B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format>
+=item B<GPRINT>B<:>I<vname>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<GPRINT>B<:>I<vname>B<:>I<format>
+=item 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>
-Text is printed literally in the legend section of the graph.
+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<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
-
-I<Deprecated. Use B<LINEx> in new scripts.>
-
-=item B<VRULE>B<:>I<vname>B<#>I<color> [B<:>I<legend> ]
+=item B<VRULE>B<:>I<time>B<#>I<color> [B<:>I<legend> ]
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. Optionally, a legend box and string 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.
-=item B<LINE>I<width>B<:>I<{vname or number}>B<#>I<color>[B<:>I<legend>]
-[ C<:STACK> ]
+=item B<HRULE>B<:>I<value>B<#>I<color> [ :I<legend> ]
+
+Draw a horyzontal 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>]]
-Draw a line of the specified width onto the graph. If the color
-is not specified, the drawing is done 'invisibly'. This is useful when
-stacking something else on top of this line. Also optional is the
-legend box and string which will be printed in the legend section
-if specified. The B<vname> can be generated by B<DEF>, 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<LINEx> or
-an B<AREA>
+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
+'invisibly'. This is useful when stacking something else on top of this
+line. Also optional is the legend box and string which will be printed in
+the legend section if specified. The B<value> can be generated by B<DEF>,
+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>.
-=item B<AREA>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>][B<:STACK>]
+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>]]
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>]]
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.
+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
+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>
As with the other graphing elements, you can specify a number or
a variable here.
-=cut
+=item B<TEXTALIGN>B<:>{B<left>|B<right>|B<justified>|B<center>}
-=item B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
+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<TEXTALIGN> 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.
-B<RRDtool> has now support for B<pie charts>. If you include the
-B<PART> command, the canvas is extended to make room for a chart.
-The size of the canvas is determined by the lesser of
-L<width and height|rrdgraph/item_Size>.
-
-Pie parts will be concatenated, the first one will start at the
-top and parts will be created clockwise. The size of the part
-is defined by the value part of the L<VDEF|rrdgraph_data/VDEF>
-function. It should return a number between 0 and 100, being a
-percentage. Providing wrong input will produce undefined results.
+=cut
-=for comment
-XXX Above: shouldn't this be caught and and error be generated? Fritz
+# This section describes the curruently defunct
+# PieChart code.
+#
+# =item B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
+#
+# B<RRDtool> has now support for B<pie charts>. If you include the
+# B<PART> command, the canvas is extended to make room for a chart.
+# The size of the canvas is determined by the lesser of
+# L<width and height|rrdgraph/item_Size>.
+#
+# Pie parts will be concatenated, the first one will start at the
+# top and parts will be created clockwise. The size of the part
+# is defined by the value part of the L<VDEF|rrdgraph_data/VDEF>
+# function. It should return a number between 0 and 100, being a
+# percentage. Providing wrong input will produce undefined results.
+#
+#
=pod
on top of the previous element. There must be something to stack
upon.
-You can use an B<invisible> LINEx or AREA to stacked upon.
+You can use an B<invisible> LINE or AREA to stacked upon.
An B<unknown> value makes the entire stack unknown from that moment on.
You don't know where to begin (the unknown value) and therefore do
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
=head1 AUTHOR
-Program by Tobias Oetiker E<lt>oetiker@ee.ethz.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>
projects / rrdtool.git / blobdiff