![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph_graph.1 b/doc/rrdgraph_graph.1
index 9507bbe4dd6800a4bf1bb78f078ee4b90a43f4ce..86301b2d07e03df2608479dc02ac0b0f95862236 100644 (file)
--- a/doc/rrdgraph_graph.1
+++ b/doc/rrdgraph_graph.1
-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.\" ========================================================================
.\"
.IX Title "RRDGRAPH_GRAPH 1"
-.TH RRDGRAPH_GRAPH 1 "2009-02-21" "1.3.8" "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
.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
@@ -204,7 +204,7 @@ unit stays undefined. Thus, formatter strings using \fB\f(CB%S\fB\fR and no \fB\
will all use the same magnitude unit except for zero values.
.PP
If you \s-1PRINT\s0 a \s-1VDEF\s0 value, you can also print the time associated with it by appending the string
-\&\fB:strftime\fR to the format. Note that rrdtool uses the strftime function of your OSs C library. This means that
+\&\fB:strftime\fR 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.
.ie n .IP "\fB\fB%a\fB\fR" 4
.ie n .IP "\fB\fB%S\fB\fR" 4
.el .IP "\fB\f(CB%S\fB\fR" 4
.IX Item "%S"
-The seconds since the epoch (1.1.1970) (libc dependant non standard!)
+The seconds since the epoch (1.1.1970) (libc dependent non standard!)
.ie n .IP "\fB\fB%U\fB\fR" 4
.el .IP "\fB\f(CB%U\fB\fR" 4
.IX Item "%U"
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.
example showing how to use centered formatting.
.PP
\&\fB\en\fR is a valid alias for \fB\el\fR since incomplete parsing in earlier
-versions of rrdtool lead to this behavior 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.
.PP
Normally there are two space characters inserted between every two items
printed into the graph. The space following a string can be suppressed by
A special case is \s-1COMMENT:\s0\fB\es\fR which inserts some additional vertical space
before placing the next row of legends.
.PP
-If you are using the proportional font in your graph, you can use tab
-characters or the sequence \fB\et\fR to line-up legend elements. Note that
+If you want to have left and right aligned legends on the same line use \s-1COMMENT:\s0\fB\eu\fR
+to go one line back like this:
+.PP
+.Vb 3
+\& COMMENT:left\el
+\& COMMENT:\eu
+\& COMMENT:right\er
+.Ve
+.PP
+There is also a 'nop' control for situations where you want a string to
+actually end in a backslash character sequence \fB\e.\fR
+.PP
+.Vb 1
+\& COMMENT:OS\e2\e.
+.Ve
+.PP
+When using a proportional font in your graph, the tab
+characters or the sequence \fB\et\fR will line-up legend elements. Note that
the tabs inserted are relative to the start of the current legend
element!
.PP
@@ -526,7 +547,7 @@ Vertical displacement, in 10000ths of an em. Can be negative for subscript, posi
\&'true' or 'false' whether to strike through the text
.IP "\fBstrikethrough_color\fR" 4
.IX Item "strikethrough_color"
-The color of strikethrough lines; an \s-1RGB\s0 color specification such as '#00FF00' or a color name such as 'red'
+The color of crossed out lines; an \s-1RGB\s0 color specification such as '#00FF00' or a color name such as 'red'
.IP "\fBfallback\fR" 4
.IX Item "fallback"
\&'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.
Italic
.IP "\fBs\fR" 4
.IX Item "s"
-Strikethrough
+Strike through
.IP "\fBsub\fR" 4
.IX Item "sub"
Subscript