X-Git-Url: https://git.tokkee.org/?p=pkg-rrdtool.git;a=blobdiff_plain;f=doc%2Frrdfetch.1;h=c555c132d9c173db373fe1b9a3042d2a6341cc47;hp=96e21af5dae018dc863372c9aa37310142e6ec33;hb=645054bac6187b0e83fd4125fd59e4feda216b64;hpb=ffa00ac697dccce18dca8880ca7a14066521ac5c diff --git a/doc/rrdfetch.1 b/doc/rrdfetch.1 index 96e21af..c555c13 100644 --- a/doc/rrdfetch.1 +++ b/doc/rrdfetch.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 "RRDFETCH 1" -.TH RRDFETCH 1 "2008-09-25" "1.3.99909060808" "rrdtool" +.TH RRDFETCH 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" rrdfetch \- Fetch data from an RRD. .SH "SYNOPSIS" @@ -180,7 +179,7 @@ For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual .Vb 1 \& rrdtool fetch \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd AVERAGE .Ve -.Sh "\s-1RESOLUTION\s0 \s-1INTERVAL\s0" +.SS "\s-1RESOLUTION\s0 \s-1INTERVAL\s0" .IX Subsection "RESOLUTION INTERVAL" In order to get RRDtool to fetch anything other than the finest resolution \s-1RRA\s0 \&\fBboth\fR the start and end time must be specified on boundaries that are @@ -238,19 +237,19 @@ Using the bash shell, this could look be: Or in Perl: .PP .Vb 3 -\& perl \-e '$ctime = time; $rrdres = 900; \e +\& perl \-e \*(Aq$ctime = time; $rrdres = 900; \e \& system "rrdtool fetch subdata.rrd AVERAGE \e -\& \-r $rrdres \-e @{[int($ctime/$rrdres)*$rrdres]} \-s e\-1h"' +\& \-r $rrdres \-e @{[int($ctime/$rrdres)*$rrdres]} \-s e\-1h"\*(Aq .Ve -.Sh "AT-STYLE \s-1TIME\s0 \s-1SPECIFICATION\s0" +.SS "AT-STYLE \s-1TIME\s0 \s-1SPECIFICATION\s0" .IX Subsection "AT-STYLE TIME SPECIFICATION" Apart from the traditional \fISeconds since epoch\fR, RRDtool does also understand at-style time specification. The specification is called -\&\*(L"at\-style\*(R" after the Unix command \fIat\fR\|(1) that has moderately complex +\&\*(L"at-style\*(R" after the Unix command \fIat\fR\|(1) that has moderately complex ways to specify time to run your job at a certain date and time. The at-style specification consists of two parts: the \fB\s-1TIME\s0 \s-1REFERENCE\s0\fR specification and the \fB\s-1TIME\s0 \s-1OFFSET\s0\fR specification. -.Sh "\s-1TIME\s0 \s-1REFERENCE\s0 \s-1SPECIFICATION\s0" +.SS "\s-1TIME\s0 \s-1REFERENCE\s0 \s-1SPECIFICATION\s0" .IX Subsection "TIME REFERENCE SPECIFICATION" The time reference specification is used, well, to establish a reference moment in time (to which the time offset is then applied to). When present, @@ -286,7 +285,7 @@ categories (\fBrrdfetch\fR, rrdgraph). Month and day of the week names can be used in their naturally abbreviated form (e.g., Dec for December, Sun for Sunday, etc.). The words \fBnow\fR, \fBstart\fR, \fBend\fR can be abbreviated as \fBn\fR, \fBs\fR, \fBe\fR. -.Sh "\s-1TIME\s0 \s-1OFFSET\s0 \s-1SPECIFICATION\s0" +.SS "\s-1TIME\s0 \s-1OFFSET\s0 \s-1SPECIFICATION\s0" .IX Subsection "TIME OFFSET SPECIFICATION" The time offset specification is used to add/subtract certain time intervals to/from the time reference moment. It consists of a \fIsign\fR @@ -326,29 +325,27 @@ equals 47 hours; on the other hand, '8:00\ Mar\ 27\ 1999\ +48\ hours' = \&\fI\s-1NOTE4\s0\fR: The single-letter abbreviation for both \fBmonths\fR and \fBminutes\fR is \fBm\fR. To disambiguate them, the parser tries to read your mind\ :) by applying the following two heuristics: -.IP "1" 3 -.IX Item "1" +.IP "1." 3 If \fBm\fR is used in context of (i.e. right after the) years, months, weeks, or days it is assumed to mean \fBmonths\fR, while in the context of hours, minutes, and seconds it means minutes. (e.g., in \-1y6m or +3w1m \fBm\fR is interpreted as \fBmonths\fR, while in \&\-3h20m or +5s2m \fBm\fR the parser decides for \fBminutes\fR). -.IP "2" 3 -.IX Item "2" +.IP "2." 3 Out of context (i.e. right after the \fB+\fR or \fB\-\fR sign) the meaning of \fBm\fR is guessed from the number it directly follows. Currently, if the number's absolute value is below 25 it is assumed that \fBm\fR means \fBmonths\fR, otherwise it is treated as \fBminutes\fR. (e.g., \-25m == \-25 minutes, while +24m == +24 months) .PP -\&\fIFinal \s-1NOTES\s0\fR: Time specification is case\-insensitive. +\&\fIFinal \s-1NOTES\s0\fR: Time specification is case-insensitive. Whitespace can be inserted freely or omitted altogether. There are, however, cases when whitespace is required (e.g., 'midnight\ Thu'). In this case you should either quote the whole phrase to prevent it from being taken apart by your shell or use \&'_' (underscore) or ',' (comma) which also count as whitespace (e.g., midnight_Thu or midnight,Thu). -.Sh "\s-1TIME\s0 \s-1SPECIFICATION\s0 \s-1EXAMPLES\s0" +.SS "\s-1TIME\s0 \s-1SPECIFICATION\s0 \s-1EXAMPLES\s0" .IX Subsection "TIME SPECIFICATION EXAMPLES" \&\fIOct 12\fR \*(-- October 12 this year .PP