X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=program%2Fdoc%2Frrdgraph_graph.src;h=4d4a5574ac4a9183236d18ddae0a7aba158408d5;hb=c41683942a5dcc3c7e6c4d9d9d5284d2bb7d3fee;hp=5b3bfd61628bfd19c0601c6041b5b5253f9226b1;hpb=6514532cb5f49cf72fb33b2d0e55b14e860b1e8c;p=rrdtool-all.git

diff --git a/program/doc/rrdgraph_graph.src b/program/doc/rrdgraph_graph.src
index 5b3bfd61..4d4a5574 100644
--- a/program/doc/rrdgraph_graph.src
+++ b/program/doc/rrdgraph_graph.src
@@ -1,6 +1,6 @@
 =include name
 
-=head1 SYNOPSYS
+=head1 SYNOPSIS
 
 =over 4
 
@@ -34,15 +34,13 @@
 
 =item B<AREA> C<:> I<vname> C<#> I<color> [ C<:> I<legend> ] [ C<:> C<STACK> ]
 
-=item B<PART> : I<vname> B<#> I<rrggbbaa> [ B<:> I<legend> ]
+=cut
 
-=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
-
-=back
+# =item B<PART> : I<vname> B<#> I<rrggbbaa> [ B<:> I<legend> ]
 
-=item B<to be implemented commands>
+=pod
 
-=over 8
+=item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
 
 =item B<SHIFT> : I<vname> , I<offset>
 
@@ -94,11 +92,6 @@ B<%#.#lf> prints like 12345.6789, with optional field width and precision
 
 =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)
@@ -151,8 +144,8 @@ B<%c, %x, %X> date+time, date, time
 
 =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 *
 
@@ -227,18 +220,22 @@ graph this stacked variable anyway you need to make sure that the
 B<LINEx> or B<AREA> it gets stacked on is not unknown. Use a CDEF
 instruction with B<IF> and B<UN> to do so.
 
-=item B<PART> : I<vname> B<#> I<rrggbbaa> [ B<:> I<legend> ]
+=cut
 
-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>.
+#=item B<PART> : I<vname> B<#> I<rrggbbaa> [ 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.
 
-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
 
 =item B<TICK> : I<vname> B<#> I<rrggbbaa> [ : I<fraction> [ : I<legend> ] ]
 
@@ -248,13 +245,7 @@ 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.
 
-=back
-
-B<THE NEXT COMMAND IS NOT YET IMPLEMENTED>
-
-=over 4
-
-=item B<SHIFT> : I<vname> , I<offset>
+=item B<SHIFT> : I<vname> : I<offset>
 
 Using this command B<RRDtool> will graph the following elements
 with the specified offset.  For instance, you can specify an
@@ -262,9 +253,44 @@ offset of S<( 7*24*60*60 = ) 604800 seconds> to "look back" one
 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