X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdinfo.1;h=1a98912e531248765669cac7761726b306776326;hb=d9822df7ed5e8122cf3a62e4e99678e94007f504;hp=109bee9a5ab3b94dcb7d44550dad07fdc06b9521;hpb=0b658ef9d0f5dd5c84288bd1307843d8f8f7060b;p=pkg-rrdtool.git

diff --git a/doc/rrdinfo.1 b/doc/rrdinfo.1
index 109bee9..1a98912 100644
--- a/doc/rrdinfo.1
+++ b/doc/rrdinfo.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,12 +124,17 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDINFO 1"
-.TH RRDINFO 1 "2008-03-15" "1.3rc6" "rrdtool"
+.TH RRDINFO 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"
 rrdinfo \- extract header information from an RRD
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-\&\fBrrdtool\fR \fBinfo\fR \fIfilename.rrd\fR
+\&\fBrrdtool\fR \fBinfo\fR \fIfilename\fR
+[\fB\-\-daemon\fR\ \fIaddress\fR]
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 The \fBinfo\fR function prints the header information from an \s-1RRD\s0 in
@@ -142,6 +142,19 @@ a parsing friendly format.
 .PP
 Check rrdcreate if you are uncertain about the meaning of the
 individual keys.
+.IP "\fIfilename\fR" 8
+.IX Item "filename"
+The name of the \fB\s-1RRD\s0\fR you want to examine.
+.IP "\fB\-\-daemon\fR \fIaddress\fR" 8
+.IX Item "--daemon address"
+Address of the rrdcached daemon. If specified, a \f(CW\*(C`flush\*(C'\fR command is sent
+to the server before reading the \s-1RRD\s0 files. This allows \fBrrdtool\fR to return
+fresh data even if the daemon is configured to cache values for a long time.
+For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual.
+.Sp
+.Vb 1
+\& rrdtool info \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+.Ve
 .SH "EXAMPLE"
 .IX Header "EXAMPLE"
 This is the output generated by running \fBinfo\fR on a simple \s-1RRD\s0 which
@@ -151,11 +164,12 @@ stands for \fI*UNKNOWN*\fR data. In the example it means that this \s-1RRD\s0
 has neither minimum nor maximum values defined for either of its
 data sources.
 .PP
-.Vb 24
+.Vb 10
 \& filename = "random.rrd"
 \& rrd_version = "0001"
 \& step = 300
 \& last_update = 955892996
+\& header_size = 2872
 \& ds[a].type = "GAUGE"
 \& ds[a].minimal_heartbeat = 600
 \& ds[a].min = NaN
@@ -177,9 +191,15 @@ data sources.
 \& rra[0].cdp_prep[1].value = nan
 \& rra[0].cdp_prep[1].unknown_datapoints = 0
 .Ve
-.IP "\fIfilename.rrd\fR" 8
-.IX Item "filename.rrd"
-The name of the \fB\s-1RRD\s0\fR you want to examine.
+.SH "ENVIRONMENT VARIABLES"
+.IX Header "ENVIRONMENT VARIABLES"
+The following environment variables may be used to change the behavior of
+\&\f(CW\*(C`rrdtool\ info\*(C'\fR:
+.IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4
+.IX Item "RRDCACHED_ADDRESS"
+If this environment variable is set it will have the same effect as specifying
+the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command
+line argument takes precedence.
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Tobias Oetiker <tobi@oetiker.ch>