summaryrefslogtreecommitdiffstats
path: root/web/input/doc/faq/use-perl-module.md
diff options
context:
space:
mode:
Diffstat (limited to 'web/input/doc/faq/use-perl-module.md')
-rw-r--r--web/input/doc/faq/use-perl-module.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/web/input/doc/faq/use-perl-module.md b/web/input/doc/faq/use-perl-module.md
new file mode 100644
index 0000000..64ba18a
--- /dev/null
+++ b/web/input/doc/faq/use-perl-module.md
@@ -0,0 +1,37 @@
1title: Using Nagios::Plugin
2parent: FAQ
3---
4
5# How do I use the Nagios::Plugin module?
6
7The Nagios::Plugin Perl module can be obtained from two main locations:
8
9* from the Nagios Plugins tarball with an
10 [extra configure option][configure-module]
11* from [CPAN][cpan-module]
12
13If you install from the Nagios Plugins tarball, the Perl module will be
14installed in `$prefix/perl`.
15
16If you install from CPAN, the Perl module will be installed into your Perl's
17system directories by default.
18
19To write your plugin, you should start it with:
20
21 use FindBin;
22 use lib "$FindBin::Bin/../perl/lib";
23 use Nagios::Plugin;
24
25This bit of code tells Perl to look for the Nagios::Plugin module in a
26directory relative to where the plugin is executed - this is a hard
27dependency. If Nagios::Plugin is not found there, Perl's system directories
28will be searched.
29
30This approach allows a system administrator to decide whether they want
31Nagios::Plugin installed via system directories or within the `$prefix` area
32of the plugins.
33
34[configure-module]: doc/faq/build-perl-module.html "configure with Nagios::Plugin"
35[cpan-module]: http://search.cpan.org/dist/Nagios-Plugin/ "Nagios::Plugin on CPAN"
36
37<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->