.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "RRDRUBY 1"
.TH RRDRUBY 1 2026-08-08 1.11.0 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
rrdruby \- About the RRD Ruby bindings
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 7
\& require "RRD"
\& RRD.create(
\&    rrd,
\&    "\-\-step", "300",
\&    "DS:a:GAUGE:600:U:U",
\&    "DS:b:GAUGE:600:U:U",
\&    "RRA:AVERAGE:0.5:1:300")
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBrrdtool\fR functions are directly callable via the Ruby programming
language. This wrapper implementation has been written from the scratch
(without  SWIG)
.PP
The API simply expects string parameters to the functions.  Please refer
to the other \fBrrdtool\fR documentation for functions and valid arguments.
.SH EXAMPLE
.IX Header "EXAMPLE"
.Vb 2
\& $: << \*(Aq/path/to/rrdtool/lib/ruby/1.8/i386\-linux\*(Aq
\& require "RRD"
\&
\& name = "test"
\& rrd = "#{name}.rrd"
\& start = Time.now.to_i
\&
\& RRD.create(
\&    rrd,
\&    "\-\-start", "#{start \- 1}",
\&    "\-\-step", "300",
\&        "DS:a:GAUGE:600:U:U",
\&    "DS:b:GAUGE:600:U:U",
\&    "RRA:AVERAGE:0.5:1:300")
\& puts
\&
\& puts "updating #{rrd}"
\& start.to_i.step(start.to_i + 300 * 300, 300) { |i|
\&    RRD.update(rrd, "#{i}:#{rand(100)}:#{Math.sin(i / 800) * 50 + 50}")
\& }
\& puts
\&
\& puts "fetching data from #{rrd}"
\& (fstart, fend, data, step) = RRD.fetch(rrd, "\-\-start", start.to_s, "\-\-end",
\&      (start + 300 * 300).to_s, "AVERAGE")
\& puts "got #{data.length} data points from #{fstart} to #{fend}"
\& puts
\&
\& puts "generating graph #{name}.png"
\& RRD.graph(
\&   "#{name}.png",
\&    "\-\-title", " RubyRRD Demo",
\&    "\-\-start", "#{start+3600}",
\&    "\-\-end", "start + 1000 min",
\&    "\-\-interlaced",
\&    "\-\-imgformat", "PNG",
\&    "\-\-width=450",
\&    "DEF:a=#{rrd}:a:AVERAGE",
\&    "DEF:b=#{rrd}:b:AVERAGE",
\&    "CDEF:line=TIME,2400,%,300,LT,a,UNKN,IF",
\&    "AREA:b#00b6e4:beta",
\&    "AREA:line#0022e9:alpha",
\&    "LINE3:line#ff0000")
\& puts
.Ve
.PP
If you use the \fB\-\-ruby\-site\-install\fR configure option you can drop the \f(CW$:\fR
line since the RRDtool module will be found automatically.
.PP
If RRDtool runs into trouble, it will throw an exception which you might
want to catch.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast,
rrdxport, rrdinfo
.SH AUTHOR
.IX Header "AUTHOR"
Loïs Lherbier <lois.lherbier@covadis.ch>
.PP
Miles Egan <miles@caddr.com>