X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.pod;h=1de245b8a4cfdf287e011fbd383e2d24b5136215;hb=43d79b11a51ae02b7b0995945cb351799e932d66;hp=7f2a36b67e3702e176dcc0787952d739e3d13780;hpb=3a03e55068747637db4480d4f3a8ab8ef26c50b1;p=pkg-rrdtool.git

diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod
index 7f2a36b..1de245b 100644
--- a/doc/rrdgraph_graph.pod
+++ b/doc/rrdgraph_graph.pod
@@ -16,9 +16,9 @@ B<VRULE>B<:>I<time>B<#>I<color>[B<:>I<legend>][B<:dashes>[B<=>I<on_s>[,I<off_s>[
 
 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<: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<:skipscale>][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>]]
+B<AREA>B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>][B<:skipscale>]]
 
 B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
 
@@ -85,7 +85,7 @@ will all use the same magnitude unit except for zero values.
 =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. 
 
@@ -142,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 dependent non standard!)
+
 =item B<%U>
 
 The  week  number  of  the current year as a decimal number, range 00 to 53, starting with the
@@ -231,7 +235,7 @@ 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.
 
-=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>]]
+=head3 B<LINE>[I<width>]B<:>I<value>[B<#>I<color>][B<:>[I<legend>][B<:STACK>][B<:skipscale>]][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
@@ -242,6 +246,11 @@ 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>.
 
+Normally the graphing function makes sure that the entire B<LINE> or B<AREA>
+is visible in the chart. The scaling of the chart will be modified
+accordingly if necessary. Any B<LINE> or B<AREA> can be excluded from this
+process by adding the option B<skipscale>.
+
 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
@@ -251,9 +260,10 @@ 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.
+you want to use B<STACK>, use the "LINEx:<value>::STACK" form.
+
 
-=head3 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>][B<:skipscale>]]
 
 See B<LINE>, however the area between the x-axis and the line will
 be filled.
@@ -263,7 +273,7 @@ be filled.
 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.
 
@@ -286,7 +296,7 @@ argument list.
 
 =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>]
@@ -308,9 +318,7 @@ argument list.
 
 =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>
 
@@ -350,7 +358,7 @@ 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.
+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
@@ -363,8 +371,20 @@ in connection with B<%s> to suppress empty unit strings.
 A special case is COMMENT:B<\s> which 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 line-up legend elements. Note that
+If you want to have left and right aligned legends on the same line use COMMENT:B<\u>
+to go one line back like this:
+
+ COMMENT:left\l
+ COMMENT:\u
+ COMMENT:right\r
+
+There is also a 'nop' control for situations where you want a string to
+actually end in a backslash character sequence B<\.>
+
+ COMMENT:OS\2\.
+
+When using a proportional font in your graph, the tab
+characters or the sequence B<\t> will line-up legend elements. Note that
 the tabs inserted are relative to the start of the current legend
 element!
 
@@ -437,7 +457,7 @@ Vertical displacement, in 10000ths of an em. Can be negative for subscript, posi
 
 =item B<strikethrough_color>
 
-The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'
+The color of crossed out lines; an RGB color specification such as '#00FF00' or a color name such as 'red'
 
 =item B<fallback>
 
@@ -479,7 +499,7 @@ Italic
 
 =item B<s>
 
-Strikethrough
+Strike through
 
 =item B<sub>
 
@@ -516,4 +536,5 @@ Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
 
 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