X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdcreate.1;h=4519333f384ce818ec409f586a6dcf03d1207319;hb=d9822df7ed5e8122cf3a62e4e99678e94007f504;hp=6e20b3c25c0caf1b0d59d769feb1794b188f5ebc;hpb=333ab21495916a8d1c4a2861ef3fe86763fde684;p=pkg-rrdtool.git diff --git a/doc/rrdcreate.1 b/doc/rrdcreate.1 index 6e20b3c..4519333 100644 --- a/doc/rrdcreate.1 +++ b/doc/rrdcreate.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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 "RRDCREATE 1" -.TH RRDCREATE 1 "2008-06-11" "1.3.7" "rrdtool" +.TH RRDCREATE 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 +.nh .SH "NAME" rrdcreate \- Set up a new Round Robin Database .SH "SYNOPSIS" @@ -137,6 +136,7 @@ rrdcreate \- Set up a new Round Robin Database \&\fBrrdtool\fR \fBcreate\fR \fIfilename\fR [\fB\-\-start\fR|\fB\-b\fR\ \fIstart\ time\fR] [\fB\-\-step\fR|\fB\-s\fR\ \fIstep\fR] +[\fB\-\-no\-overwrite\fR] [\fB\s-1DS:\s0\fR\fIds-name\fR\fB:\fR\fI\s-1DST\s0\fR\fB:\fR\fIdst\ arguments\fR] [\fB\s-1RRA:\s0\fR\fI\s-1CF\s0\fR\fB:\fR\fIcf\ arguments\fR] .SH "DESCRIPTION" @@ -144,12 +144,12 @@ rrdcreate \- Set up a new Round Robin Database The create function of RRDtool lets you set up new Round Robin Database (\fB\s-1RRD\s0\fR) files. The file is created at its final, full size and filled with \fI*UNKNOWN*\fR data. -.Sh "\fIfilename\fP" +.SS "\fIfilename\fP" .IX Subsection "filename" The name of the \fB\s-1RRD\s0\fR you want to create. \fB\s-1RRD\s0\fR files should end with the extension \fI.rrd\fR. However, \fBRRDtool\fR will accept any filename. -.Sh "\fB\-\-start\fP|\fB\-b\fP \fIstart time\fP (default: now \- 10s)" +.SS "\fB\-\-start\fP|\fB\-b\fP \fIstart time\fP (default: now \- 10s)" .IX Subsection "--start|-b start time (default: now - 10s)" Specifies the time in seconds since 1970\-01\-01 \s-1UTC\s0 when the first value should be added to the \fB\s-1RRD\s0\fR. \fBRRDtool\fR will not accept @@ -157,11 +157,14 @@ any data timed before or at the time specified. .PP See also AT-STYLE \s-1TIME\s0 \s-1SPECIFICATION\s0 section in the \&\fIrrdfetch\fR documentation for other ways to specify time. -.Sh "\fB\-\-step\fP|\fB\-s\fP \fIstep\fP (default: 300 seconds)" +.SS "\fB\-\-step\fP|\fB\-s\fP \fIstep\fP (default: 300 seconds)" .IX Subsection "--step|-s step (default: 300 seconds)" Specifies the base interval in seconds with which data will be fed into the \fB\s-1RRD\s0\fR. -.Sh "\fB\s-1DS:\s0\fP\fIds-name\fP\fB:\fP\fI\s-1DST\s0\fP\fB:\fP\fIdst arguments\fP" +.SS "\fB\-\-no\-overwrite\fP" +.IX Subsection "--no-overwrite" +Do not clobber an existing file of the same name. +.SS "\fB\s-1DS:\s0\fP\fIds-name\fP\fB:\fP\fI\s-1DST\s0\fP\fB:\fP\fIdst arguments\fP" .IX Subsection "DS:ds-name:DST:dst arguments" A single \fB\s-1RRD\s0\fR can accept input from several data sources (\fB\s-1DS\s0\fR), for example incoming and outgoing traffic on a specific communication @@ -248,7 +251,7 @@ between two updates of this data source before the value of the data source is assumed to be \fI*UNKNOWN*\fR. .PP \&\fImin\fR and \fImax\fR define the expected range values for data supplied by a -data source. If \fImin\fR and/or \fImax\fR any value outside the defined range +data source. If \fImin\fR and/or \fImax\fR are specified any value outside the defined range will be regarded as \fI*UNKNOWN*\fR. If you do not know or care about min and max, set them to U for unknown. Note that min and max always refer to the processed values of the \s-1DS\s0. For a traffic\-\fB\s-1COUNTER\s0\fR type \s-1DS\s0 this would be @@ -268,7 +271,7 @@ the \s-1RPN\s0 expression, the \s-1COMPUTE\s0 data source may only refer to the names of data source listed previously in the create command. This is similar to the restriction that \fB\s-1CDEF\s0\fRs must refer only to \fB\s-1DEF\s0\fRs and \fB\s-1CDEF\s0\fRs previously defined in the same graph command. -.Sh "\fB\s-1RRA:\s0\fP\fI\s-1CF\s0\fP\fB:\fP\fIcf arguments\fP" +.SS "\fB\s-1RRA:\s0\fP\fI\s-1CF\s0\fP\fB:\fP\fIcf arguments\fP" .IX Subsection "RRA:CF:cf arguments" The purpose of an \fB\s-1RRD\s0\fR is to store data in the round robin archives (\fB\s-1RRA\s0\fR). An archive consists of a number of data values or statistics for @@ -281,7 +284,7 @@ data point\fR. The data is also processed with the consolidation function (\fI\s-1CF\s0\fR) of the archive. There are several consolidation functions that consolidate primary data points via an aggregate function: \fB\s-1AVERAGE\s0\fR, -\&\fB\s-1MIN\s0\fR, \fB\s-1MAX\s0\fR, \fB\s-1LAST\s0\fR. +\&\fB\s-1MIN\s0\fR, \fB\s-1MAX\s0\fR, \fB\s-1LAST\s0\fR. .IP "\s-1AVERAGE\s0" 4 .IX Item "AVERAGE" the average of the data points is stored. @@ -481,7 +484,7 @@ an average rate for that \s-1PDP\s0. If the total \*(L"unknown\*(R" time account more than \fBhalf\fR the \*(L"step\*(R", the entire \s-1PDP\s0 is marked as \*(L"unknown\*(R". This means that a mixture of known and \*(L"unknown\*(R" sample times in a single \s-1PDP\s0 \*(L"step\*(R" may or may not add up to enough \*(L"known\*(R" -time to warrent for a known \s-1PDP\s0. +time to warrant a known \s-1PDP\s0. .PP The \*(L"heartbeat\*(R" can be short (unusual) or long (typical) relative to the \*(L"step\*(R" interval between PDPs. A short \*(L"heartbeat\*(R" means you @@ -493,10 +496,10 @@ sample. An extreme example of this might be a \*(L"step\*(R" of 5 minutes and a result in all the PDPs for that entire day period being set to the same average rate. \fI\-\- Don Baarda \fR .PP -.Vb 35 +.Vb 10 \& time| \& axis| -\& begin__|00| +\& begin_\|_|00| \& |01| \& u|02|\-\-\-\-* sample1, restart "hb"\-timer \& u|03| / @@ -524,7 +527,7 @@ same average rate. \fI\-\- Don Baarda \fR \& |25| / \& |26| / \& |27|\-\-\-\-* sample7, restart "hb" -\& step2__|28| / +\& step2_\|_|28| / \& |22| / \& |23|\-\-\-\-* sample8, restart "hb", create "pdp" for step1, create "cdp" \& |24| / @@ -545,7 +548,7 @@ together with the time. .IP "Mail Messages" 4 .IX Item "Mail Messages" Assume you have a method to count the number of messages transported by -your mailserver in a certain amount of time, giving you data like '5 +your mail server in a certain amount of time, giving you data like '5 messages in the last 65 seconds'. If you look at the count of 5 like an \&\fB\s-1ABSOLUTE\s0\fR data type you can simply update the \s-1RRD\s0 with the number 5 and the end time of your monitoring period. RRDtool will then record the number of @@ -564,7 +567,7 @@ plots continuous data, and as such is not appropriate for plotting absolute amounts as for example \*(L"total bytes\*(R" sent and received in a router. What you probably want is plot rates that you can scale to bytes/hour, for example, or plot absolute amounts with another tool -that draws bar\-plots, where the delta-time is clear on the plot for +that draws bar-plots, where the delta-time is clear on the plot for each point (such that when you read the graph you see for example \s-1GB\s0 on the y axis, days on the x axis and one bar for each day). .SH "EXAMPLE"