summaryrefslogtreecommitdiffstats
path: root/web/input/doc/index.md
blob: 763f04c0dd730297870448450300a5c84defb4f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
title: Documentation
parent: Home
menu: 4
---

# Documentation

## Basics

The main Nagios Plugins documentation is split into two parts:

1. **[Manual Pages][man]**  
   This part provides documentation for each individual plugin.

2. **[FAQ][faq]**  
   The FAQ section offers additional information on the Nagios Plugins
   package as a whole.

## Advanced Topics

These documents cover specific topics that go beyond the basics:

* **[Extra-Opts][opts]**  
  Telling plugins to read options from a configuration file.

* **[Writing Perl Plugins][video]**  
  This is a video that shows how to write your own check using the
  [Nagios::Plugin][module] Perl module.

* **[Nagios Plugin Development Guidelines][guidelines]**  
  Reference documentation for plugin developers.

## Proposals

The following ideas are not yet implemented (and might never be):

* **[New Specification Method for Thresholds][new-threshold]**  
  A different way of specifying thresholds on the command line.

* **[Check Aggregation: check\_many][check-many]**  
  A plugin wrapper allowing aggregation and serialization of multiple checks.

[man]: doc/man/index.html "Manual Pages"
[faq]: doc/faq/index.html "Frequently Asked Questions"
[opts]: doc/extra-opts.html
[video]: doc/presentation.html "Nagios::Plugin Presentation"
[module]: http://search.cpan.org/dist/Nagios-Plugin/ "Nagios::Plugin"
[guidelines]: doc/guidelines.html
[new-threshold]: doc/new-threshold-syntax.html
[check-many]: doc/check-many.html

<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->