Current File : //usr/local/share/man/man3/Monitoring::Plugin::Config.3pm

.\" 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
.\" ========================================================================
.\"
.IX Title "Monitoring::Plugin::Config 3"
.TH Monitoring::Plugin::Config 3 "2014-01-20" "perl v5.26.3" "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"
Monitoring::Plugin::Config \- read nagios plugin .ini style config files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # Read given nagios plugin config file
\&    $Config = Monitoring::Plugin::Config\->read( \*(Aq/etc/nagios/plugins.ini\*(Aq );
\&
\&    # Search for and read default nagios plugin config file
\&    $Config = Monitoring::Plugin::Config\->read();
\&
\&    # Access sections and properties (returns scalars or arrayrefs)
\&    $rootproperty =  $Config\->{_}\->{rootproperty};
\&    $one = $Config\->{section}\->{one};
\&    $Foo = $Config\->{section}\->{Foo};
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Monitoring::Plugin::Config is a subclass of the excellent Config::Tiny,
with the following changes:
.IP "\(bu" 4
Repeated keys are allowed within sections, returning lists instead of scalars
.IP "\(bu" 4
Write functionality has been removed i.e. access is read only
.IP "\(bu" 4
Monitoring::Plugin::Config searches for a default nagios plugins file if no explicit
filename is given to \f(CW\*(C`read()\*(C'\fR. The current standard locations checked are:
.RS 4
.IP "/etc/nagios/plugins.ini" 4
.IX Item "/etc/nagios/plugins.ini"
.PD 0
.IP "/usr/local/nagios/etc/plugins.ini" 4
.IX Item "/usr/local/nagios/etc/plugins.ini"
.IP "/usr/local/etc/nagios /etc/opt/nagios/plugins.ini" 4
.IX Item "/usr/local/etc/nagios /etc/opt/nagios/plugins.ini"
.IP "/etc/nagios\-plugins.ini" 4
.IX Item "/etc/nagios-plugins.ini"
.IP "/usr/local/etc/nagios\-plugins.ini" 4
.IX Item "/usr/local/etc/nagios-plugins.ini"
.IP "/etc/opt/nagios\-plugins.ini" 4
.IX Item "/etc/opt/nagios-plugins.ini"
.RE
.RS 4
.PD
.Sp
To use a custom location, set a \f(CW\*(C`NAGIOS_CONFIG_PATH\*(C'\fR environment variable
to the set of directories that should be checked. The first \f(CW\*(C`plugins.ini\*(C'\fR or
\&\f(CW\*(C`nagios\-plugins.ini\*(C'\fR file found will be used.
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Tiny, Monitoring::Plugin
.SH "AUTHOR"
.IX Header "AUTHOR"
This code is maintained by the Monitoring Plugin Development Team: see
https://monitoring\-plugins.org
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2014      by Monitoring Plugin Team
Copyright (C) 2006\-2014 by Nagios Plugin Development Team
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.