.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'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 >0, we'll generate index entries on stderr for
.\" 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RRDINFO 1"
.TH RRDINFO 1 2024-01-10 1.7.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
rrdinfo \- extract header information from an RRD
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBrrdtool\fR \fBinfo\fR \fIfilename\fR
[\fB\-\-daemon\fR|\fB\-d\fR\ \fIaddress\fR\ [\fB\-\-noflush\fR|\fB\-F\fR]]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBinfo\fR function prints the header information from an RRD in
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 \fBRRD\fR you want to examine.
.IP "\fB\-\-daemon\fR|\fB\-d\fR \fIaddress\fR" 8
.IX Item "--daemon|-d address"
Address of the rrdcached daemon. If specified, a \f(CW\*(C`flush\*(C'\fR command is sent
to the server before reading the RRD 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
.IP \fB\-\-noflush\fR|\fB\-F\fR 8
.IX Item "--noflush|-F"
Omit the \f(CW\*(C`flush\*(C'\fR command usually sent to the daemon prior to retrieving the
data.  If all you are interested in is the RRD structure, and not the last update
time or current values, then this will improve efficiency.
.SH EXAMPLE
.IX Header "EXAMPLE"
This is the output generated by running \fBinfo\fR on a simple RRD which
contains two data sources and one RRA. Note that the number after the
\&\fIlast_update\fR keyword is in seconds since 1970. The string \fBNaN\fR
stands for \fI*UNKNOWN*\fR data. In the example it means that this RRD
has neither minimum nor maximum values defined for either of its
data sources.
.PP
.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
\& ds[a].max = NaN
\& ds[a].last_ds = "UNKN"
\& ds[a].value = 2.1824421548e+04
\& ds[a].unknown_sec = 0
\& ds[b].type = "GAUGE"
\& ds[b].minimal_heartbeat = 600
\& ds[b].min = NaN
\& ds[b].max = NaN
\& ds[b].last_ds = "UNKN"
\& ds[b].value = 3.9620838224e+03
\& ds[b].unknown_sec = 0
\& rra[0].cf = "AVERAGE"
\& rra[0].pdp_per_row = 1
\& rra[0].cdp_prep[0].value = nan
\& rra[0].cdp_prep[0].unknown_datapoints = 0
\& rra[0].cdp_prep[1].value = nan
\& rra[0].cdp_prep[1].unknown_datapoints = 0
.Ve
.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 \fBRRDCACHED_ADDRESS\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>