X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdgraph_examples.1;h=98e6f22813e421d51a4fd3443a605314852a5637;hb=c397a78525a287fbb64551ebd8834d1c2407e01d;hp=52a3249d28f43b125d2e4f1e9374970c1c680103;hpb=07320f320eac039c03ca18bfb5eeea5803701dfe;p=pkg-rrdtool.git diff --git a/doc/rrdgraph_examples.1 b/doc/rrdgraph_examples.1 index 52a3249..98e6f22 100644 --- a/doc/rrdgraph_examples.1 +++ b/doc/rrdgraph_examples.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -48,22 +40,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +124,11 @@ .\" ======================================================================== .\" .IX Title "RRDGRAPH_EXAMPLES 1" -.TH RRDGRAPH_EXAMPLES 1 "2008-03-25" "1.3.0" "rrdtool" +.TH RRDGRAPH_EXAMPLES 1 "2009-02-21" "1.4.2" "rrdtool" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" rrdgraph_examples \- Examples for rrdtool graph .SH "SYNOPSIS" @@ -144,7 +143,7 @@ by using detailed examples. They are not always cut-and-paste ready because comments are intermixed with the examples. .SH "EXAMPLES" .IX Header "EXAMPLES" -.Sh "Data with multiple resolutions" +.SS "Data with multiple resolutions" .IX Subsection "Data with multiple resolutions" .Vb 7 \& \-\-end now \-\-start end\-120000s \-\-width 400 @@ -155,7 +154,7 @@ ready because comments are intermixed with the examples. \& LINE1:ds0b#00CCFF:"resolution 1800 seconds per interval\el" \& LINE1:ds0c#FF00FF:"resolution 7200 seconds per interval\el" .Ve -.Sh "Nicely formatted legend section" +.SS "Nicely formatted legend section" .IX Subsection "Nicely formatted legend section" .Vb 10 \& DEF:ds0=/home/rrdtool/data/router1.rrd:ds0:AVERAGE @@ -189,9 +188,7 @@ Note: the column titles have to be as wide as the columns \& COMMENT:"Maximum " \& COMMENT:"Average " \& COMMENT:"Minimum " -.Ve -.PP -.Vb 11 +\& \& COMMENT:"95th percentile\el" \& AREA:ds0bits#00C000:"Inbound " \& GPRINT:ds0max:"%6.2lf %Sbps" @@ -204,7 +201,7 @@ Note: the column titles have to be as wide as the columns \& GPRINT:ds1min:"%6.2lf %Sbps" \& GPRINT:ds1pct:"%6.2lf %Sbps\el" .Ve -.Sh "Offsetting a line on the y\-axis" +.SS "Offsetting a line on the y\-axis" .IX Subsection "Offsetting a line on the y-axis" Depending on your needs you can do this in two ways: .IP "\(bu" 4 @@ -238,7 +235,7 @@ Note: the second line gets stacked on top of the first one .Vb 1 \& LINE1:data#FF0000:"Data with offset":STACK .Ve -.Sh "Drawing dashed lines" +.SS "Drawing dashed lines" .IX Subsection "Drawing dashed lines" Also works for \s-1HRULE\s0 and \s-1VRULE\s0 .IP "\(bu" 4 @@ -247,7 +244,7 @@ default style: \- \- \- \- \- .IP "\(bu" 4 more fancy style with offset: \- \- \-\-\- \- \-\-\- \- LINE1:data#FF0000:\*(L"another dashed line\*(R":dashes=15,5,5,10:dash\-offset=10 -.Sh "Time ranges" +.SS "Time ranges" .IX Subsection "Time ranges" .Vb 6 \& Last four weeks: \-\-start end\-4w \-\-end 00:00 @@ -257,7 +254,7 @@ more fancy style with offset: \- \- \-\-\- \- \-\-\- \- \& Last 24 hours: \& Yesterday: \-\-end 00:00 .Ve -.Sh "Viewing the current and previous week together" +.SS "Viewing the current and previous week together" .IX Subsection "Viewing the current and previous week together" .Vb 3 \& \-\-end now \-\-start end\-1w @@ -273,13 +270,13 @@ Shift the data forward by one week (604800 seconds) \& AREA:lastweek#0000FF:Last\e week \& LINE1:thisweek#FF0000:This\e week .Ve -.Sh "Aberrant Behaviour Detection" +.SS "Aberrant Behaviour Detection" .IX Subsection "Aberrant Behaviour Detection" If the specialized function \fBRRAs\fR exist for aberrant behavior detection, they can be used to generate the graph of a time series with confidence bands and failures. .PP -.Vb 14 +.Vb 10 \& rrdtool graph example.png \e \& DEF:obs=monitor.rrd:ifOutOctets:AVERAGE \e \& DEF:pred=monitor.rrd:ifOutOctets:HWPREDICT \e @@ -336,10 +333,9 @@ rrdgraph gives an overview of how \fBrrdtool graph\fR works. rrdgraph_data describes \fB\s-1DEF\s0\fR,\fB\s-1CDEF\s0\fR and \fB\s-1VDEF\s0\fR in detail. rrdgraph_rpn describes the \fB\s-1RPN\s0\fR language used in the \fBxDEF\fR statements. rrdgraph_graph page describes all the graph and print functions. -.PP -Make sure to read rrdgraph_examples for tips&tricks. .SH "AUTHOR" .IX Header "AUTHOR" Program by Tobias Oetiker .PP -This manual page by Alex van den Bogaerdt +This manual page by Alex van den Bogaerdt +with corrections and/or additions by several people