X-Git-Url: https://git.tokkee.org/?p=pkg-rrdtool.git;a=blobdiff_plain;f=doc%2Frrdtool.1;h=3fe94f609035d1b653a79ebdd07cc0f5b9debb20;hp=e336c2ffa74c6c56b157c98b8a3207ab6f94d4f8;hb=645054bac6187b0e83fd4125fd59e4feda216b64;hpb=ffa00ac697dccce18dca8880ca7a14066521ac5c diff --git a/doc/rrdtool.1 b/doc/rrdtool.1 index e336c2f..3fe94f6 100644 --- a/doc/rrdtool.1 +++ b/doc/rrdtool.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.08) .\" .\" 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 @@ -25,11 +17,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -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 "RRDTOOL 1" -.TH RRDTOOL 1 "2009-05-26" "1.3.99909060808" "rrdtool" +.TH RRDTOOL 1 "2009-06-09" "1.3.999" "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" rrdtool \- Round Robin Database Tool .SH "SYNOPSIS" @@ -137,7 +136,7 @@ rrdtool \- Round Robin Database Tool \&\fBrrdtool\fR \fB\-\fR [workdir]| \fIfunction\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" -.Sh "\s-1OVERVIEW\s0" +.SS "\s-1OVERVIEW\s0" .IX Subsection "OVERVIEW" It is pretty easy to gather status information from all sorts of things, ranging from the temperature in your office to the number of @@ -156,7 +155,7 @@ detailed description of how to use the individual functions of .PP For an introduction to the usage of RRDtool make sure you consult the rrdtutorial. -.Sh "\s-1FUNCTIONS\s0" +.SS "\s-1FUNCTIONS\s0" .IX Subsection "FUNCTIONS" While the man pages talk of command line switches you have to set in order to make \fBRRDtool\fR work it is important to note that @@ -213,7 +212,7 @@ Flush the values for a specific \s-1RRD\s0 file from memory. Check rrdflushcache .IX Item "rrdcgi" This is a standalone tool for producing \s-1RRD\s0 graphs on the fly. Check rrdcgi. -.Sh "\s-1HOW\s0 \s-1DOES\s0 \s-1RRDTOOL\s0 \s-1WORK\s0?" +.SS "\s-1HOW\s0 \s-1DOES\s0 \s-1RRDTOOL\s0 \s-1WORK\s0?" .IX Subsection "HOW DOES RRDTOOL WORK?" .IP "Data Acquisition" 8 .IX Item "Data Acquisition" @@ -297,12 +296,12 @@ by Jake Brutlag \&\fBRRDtool\fR provides the building blocks for near real-time aberrant behavior detection. These components include: .RS 8 -.IP "*" 4 +.IP "\(bu" 4 An algorithm for predicting the value of a time series one time step into the future. -.IP "*" 4 +.IP "\(bu" 4 A measure of deviation between predicted and observed values. -.IP "*" 4 +.IP "\(bu" 4 A mechanism to decide if and when an observed value or sequence of observed values is \fItoo deviant\fR from the predicted value(s). .RE @@ -347,7 +346,7 @@ initiate real-time alerts. .Sp For a detailed description on how to set this up, see rrdcreate. .RE -.Sh "\s-1REMOTE\s0 \s-1CONTROL\s0" +.SS "\s-1REMOTE\s0 \s-1CONTROL\s0" .IX Subsection "REMOTE CONTROL" When you start \fBRRDtool\fR with the command line option '\fB\-\fR' it waits for input via standard input (\s-1STDIN\s0). With this feature you can @@ -370,9 +369,9 @@ unless something really serious happens. If a \fBworkdir\fR is specified and the \s-1UID\s0 is 0, RRDtool will do a chroot to that workdir. If the \s-1UID\s0 is not 0, RRDtool only changes the current directory to \&\fBworkdir\fR. -.Sh "\s-1RRD\s0 Server" +.SS "\s-1RRD\s0 Server" .IX Subsection "RRD Server" -If you want to create a RRD\-Server, you must choose a \s-1TCP/IP\s0 Service +If you want to create a RRD-Server, you must choose a \s-1TCP/IP\s0 Service number and add them to \fI/etc/services\fR like this: .PP .Vb 1