.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" 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 .. .\" 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. \*(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- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "RRDRUBY 1" .TH RRDRUBY 1 "2022-03-14" "1.8.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 \s-1SWIG\s0) .PP The \s-1API\s0 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" Loi\*:s Lherbier .PP Miles Egan