=include name
-=head1 SYNOPSYS
+=head1 SYNOPSIS
=over 4
-=item B<to be depriciated commands>
+=item B<to be deprecated commands>
=over 4
=item B<PRINT> : I<vname> : I<CF> : I<format>
-I<Depriciated. Use the new form of this command in new scripts.>
+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> : I<format>
=item *
-B<%#.#lg> prints like 12345.6789, with optional field width and number of
-significant digits
-
-=item *
-
B<%s> 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 *
-B<%U, %W> week number of the current year with either the first sunday or
-the first monday determining the first week
+B<%U, %W> week number of the current year with either the first Sunday or
+the first Monday determining the first week
=item *
=item B<GPRINT> : I<vname> : I<CF> : I<format>
-I<Depriciated. Use the new form of this command in new scripts.>
+I<Deprecated. Use the new form of this command in new scripts.>
This is the same as C<PRINT> but now it is printed inside the graph.
=item B<GPRINT> : I<vname> : I<format>
=item B<STACK> : I<vname> # I<color> [ :I<legend> ]
-I<Depriciated. Use the B<STACK> modifiers on the other commands.>
+I<Deprecated. Use the B<STACK> modifiers on the other commands.>
I<Note: the comments on stacking are still valid...>
Repeats the last B<LINEx> or B<AREA> however it doesn't start at the
x-axis but rather on top of the previous element. This implies that
week. Make sure to notify the viewer you did so...
The offset will be valid until the next B<SHIFT> command, which
can have an offset of zero to restore normal graphing.
-As with the other grapher elements, you can specify a number or
+As with the other graphing elements, you can specify a number or
a variable here.
=back
+=head1 NOTES on legend arguments
+
+=head2 Escaping the colon
+
+In a ':' in a I<legend> argument will mark the end of the legend. To
+enter a ':' into a legend, the colon must be escaped with a backslash '\:'.
+Beware, that many environments look for backslashes themselves, so it may
+be necessary to write two backslashes so that one is passed onto rrd_graph.
+
+=head2 String Formatting
+
+The text printed below the actual graph can be formated by appending special
+escaped characters at the end of a text. When ever such a character occurs,
+all pending text is pushed onto the graph according to the character
+specified.
+
+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 formating.
+
+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
+inside the string if it is at the very end of the string. This can be used
+in connection with B<%s> to suppress empty unit strings.
+
+ GPRINT:a:MAX:%lf%s\g
+
+A special case is COMMENT:B<\s> this 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 lin-up legend elements. Note that the tabs inserted are
+relative to the start of the current legend element!
+
=include see_also
projects / rrdtool.git / blobdiff