Imported upstream version 1.4.8

[pkg-rrdtool.git] / doc / rrdgraph_graph.1

diff --git a/doc/rrdgraph_graph.1 b/doc/rrdgraph_graph.1
index e41dbff25c36cf7f6f69f0514d7d1a31358f3d37..86301b2d07e03df2608479dc02ac0b0f95862236 100644 (file)
--- a/doc/rrdgraph_graph.1
+++ b/doc/rrdgraph_graph.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDGRAPH_GRAPH 1"
-.TH RRDGRAPH_GRAPH 1 "2012-01-20" "1.4.7" "rrdtool"
+.TH RRDGRAPH_GRAPH 1 "2013-05-23" "1.4.8" "rrdtool"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -143,9 +143,9 @@ rrdgraph_graph \- rrdtool graph command reference
 .PP
 \&\fB\s-1HRULE\s0\fR\fB:\fR\fIvalue\fR\fB#\fR\fIcolor\fR[\fB:\fR\fIlegend\fR][\fB:dashes\fR[\fB=\fR\fIon_s\fR[,\fIoff_s\fR[,\fIon_s\fR,\fIoff_s\fR]...]][\fB:dash\-offset=\fR\fIoffset\fR]]
 .PP
-\&\fB\s-1LINE\s0\fR[\fIwidth\fR]\fB:\fR\fIvalue\fR[\fB#\fR\fIcolor\fR][\fB:\fR[\fIlegend\fR][\fB:STACK\fR]][\fB:dashes\fR[\fB=\fR\fIon_s\fR[,\fIoff_s\fR[,\fIon_s\fR,\fIoff_s\fR]...]][\fB:dash\-offset=\fR\fIoffset\fR]]
+\&\fB\s-1LINE\s0\fR[\fIwidth\fR]\fB:\fR\fIvalue\fR[\fB#\fR\fIcolor\fR][\fB:\fR[\fIlegend\fR][\fB:STACK\fR][\fB:skipscale\fR][\fB:dashes\fR[\fB=\fR\fIon_s\fR[,\fIoff_s\fR[,\fIon_s\fR,\fIoff_s\fR]...]][\fB:dash\-offset=\fR\fIoffset\fR]]
 .PP
-\&\fB\s-1AREA\s0\fR\fB:\fR\fIvalue\fR[\fB#\fR\fIcolor\fR][\fB:\fR[\fIlegend\fR][\fB:STACK\fR]]
+\&\fB\s-1AREA\s0\fR\fB:\fR\fIvalue\fR[\fB#\fR\fIcolor\fR][\fB:\fR[\fIlegend\fR][\fB:STACK\fR][\fB:skipscale\fR]]
 .PP
 \&\fB\s-1TICK\s0\fR\fB:\fR\fIvname\fR\fB#\fR\fIrrggbb\fR[\fIaa\fR][\fB:\fR\fIfraction\fR[\fB:\fR\fIlegend\fR]]
 .PP
@@ -353,8 +353,8 @@ Draw a horizontal line at \fIvalue\fR.  \s-1HRULE\s0 acts much like \s-1LINE\s0
 will have no effect on the scale of the graph. If a \s-1HRULE\s0 is outside the
 graphing area it will just not be visible.
 .PP
-\fI\f(BI\s-1LINE\s0\fI[\fIwidth\fI]\f(BI:\fI\fIvalue\fI[\f(BI#\fI\fIcolor\fI][\f(BI:\fI[\fIlegend\fI][\f(BI:STACK\fI]][\f(BI:dashes\fI[\f(BI=\fI\fIon_s\fI[,\fIoff_s\fI[,\fIon_s\fI,\fIoff_s\fI]...]][\f(BI:dash\-offset=\fI\fIoffset\fI]]\fR
-.IX Subsection "LINE[width]:value[#color][:[legend][:STACK]][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]]"
+\fI\f(BI\s-1LINE\s0\fI[\fIwidth\fI]\f(BI:\fI\fIvalue\fI[\f(BI#\fI\fIcolor\fI][\f(BI:\fI[\fIlegend\fI][\f(BI:STACK\fI][\f(BI:skipscale\fI]][\f(BI:dashes\fI[\f(BI=\fI\fIon_s\fI[,\fIoff_s\fI[,\fIon_s\fI,\fIoff_s\fI]...]][\f(BI:dash\-offset=\fI\fIoffset\fI]]\fR
+.IX Subsection "LINE[width]:value[#color][:[legend][:STACK][:skipscale]][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]]"
 .PP
 Draw a line of the specified width onto the graph. \fIwidth\fR can be a
 floating point number. If the color is not specified, the drawing is done
@@ -365,6 +365,11 @@ the legend section if specified. The \fBvalue\fR can be generated by \fB\s-1DEF\
 is stacked on top of the previous element which can be a \fB\s-1LINE\s0\fR or an
 \&\fB\s-1AREA\s0\fR.
 .PP
+Normally the graphing function makes sure that the entire \fB\s-1LINE\s0\fR or \fB\s-1AREA\s0\fR
+is visible in the chart. The scaling of the chart will be modified
+accordingly if necessary. Any \fB\s-1LINE\s0\fR or \fB\s-1AREA\s0\fR can be excluded from this
+process by adding the option \fBskipscale\fR.
+.PP
 The \fBdashes\fR 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 \fBdashes=\fR parameter is followed by either
@@ -374,10 +379,10 @@ stroke. The \fBdash-offset\fR parameter specifies an \fIoffset\fR into the patte
 at which the stroke begins.
 .PP
 When you do not specify a color, you cannot specify a legend.  Should
-you want to use \s-1STACK\s0, use the \*(L"LINEx:<value>::STACK\*(R" form.
+you want to use \fB\s-1STACK\s0\fR, use the \*(L"LINEx:<value>::STACK\*(R" form.
 .PP
-\fI\f(BI\s-1AREA\s0\fI\f(BI:\fI\fIvalue\fI[\f(BI#\fI\fIcolor\fI][\f(BI:\fI[\fIlegend\fI][\f(BI:STACK\fI]]\fR
-.IX Subsection "AREA:value[#color][:[legend][:STACK]]"
+\fI\f(BI\s-1AREA\s0\fI\f(BI:\fI\fIvalue\fI[\f(BI#\fI\fIcolor\fI][\f(BI:\fI[\fIlegend\fI][\f(BI:STACK\fI][\f(BI:skipscale\fI]]\fR
+.IX Subsection "AREA:value[#color][:[legend][:STACK][:skipscale]]"
 .PP
 See \fB\s-1LINE\s0\fR, however the area between the x\-axis and the line will
 be filled.