.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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
.\" ========================================================================
.\"
.IX Title "Tirex::Munin 3pm"
.TH Tirex::Munin 3pm "2023-04-11" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
Tirex::Munin \- Parent class for Munin scripts
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $m = Tirex::Munin::SomeSubclass\->new(...)
\&
\& if ($ARGV[0] eq \*(Aqconfig\*(Aq) {
\&     print $m\->config();
\& } else {
\&     $m\->init(...) or die;
\&     print $m\->fetch();
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Parent class for Munin scripts. This class is never instantiated, create subclasses
instead.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "Tirex::Munin::SomeSubclass\->new( map => [ 'map1', 'map2' ], z => [$zr1, $zr2] )"
.el .SS "Tirex::Munin::SomeSubclass\->new( map => [ 'map1', 'map2' ], z => [$zr1, \f(CW$zr2\fP] )"
.IX Subsection "Tirex::Munin::SomeSubclass->new( map => [ 'map1', 'map2' ], z => [$zr1, $zr2] )"
Create new munin object.
.ie n .SS "$m\->do(...)"
.el .SS "\f(CW$m\fP\->do(...)"
.IX Subsection "$m->do(...)"
Do the right Munin action depending on command line.
.PP
All command line args are passed to \fBinit_data()\fR.
.ie n .SS "$m\->\fBinit()\fP"
.el .SS "\f(CW$m\fP\->\fBinit()\fP"
.IX Subsection "$m->init()"
Initialize config source.
.PP
This method is called from \fBnew()\fR, in the Tirex::Munin class it does nothing,
but can be overwritten in subclasses.
.ie n .SS "$m\->\fBconfig()\fP"
.el .SS "\f(CW$m\fP\->\fBconfig()\fP"
.IX Subsection "$m->config()"
Return config in Munin format.
.PP
This method must be overwritten in subclasses.
.ie n .SS "$m\->\fBinit_data()\fP"
.el .SS "\f(CW$m\fP\->\fBinit_data()\fP"
.IX Subsection "$m->init_data()"
Initialize data source.
.PP
This method must be called before \fBfetch()\fR, in the Tirex::Munin class it does
nothing, but can be overwritten in subclasses.
.ie n .SS "$m\->\fBfetch()\fP"
.el .SS "\f(CW$m\fP\->\fBfetch()\fP"
.IX Subsection "$m->fetch()"
Return data in Munin format.
.PP
This method must be overwritten in subclasses.
.SS "Tirex::Munin::make_id($name)"
.IX Subsection "Tirex::Munin::make_id($name)"
Create Id from name by changing all characters except A\-Z, a\-z, and 0\-9 to a _
(underscore).