summaryrefslogtreecommitdiffstats
path: root/doc/developer-guidelines.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r--doc/developer-guidelines.sgml20
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index eb5b039..61b9f17 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -1,6 +1,6 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > 1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" >
2<book> 2<book>
3 <title>Nagios Plug-in Developer Guidelines</title> 3 <title>Nagios Plugin Development Guidelines</title>
4 4
5 <bookinfo> 5 <bookinfo>
6 <authorgroup> 6 <authorgroup>
@@ -12,7 +12,7 @@
12 </authorgroup> 12 </authorgroup>
13 13
14 <pubdate>2013</pubdate> 14 <pubdate>2013</pubdate>
15 <title>Nagios plug-in development guidelines</title> 15 <title>Nagios Plugin Development Guidelines</title>
16 16
17 <revhistory> 17 <revhistory>
18 <revision> 18 <revision>
@@ -31,10 +31,10 @@
31 31
32<preface id="preface"><title>Preface</title> 32<preface id="preface"><title>Preface</title>
33 <para>The purpose of this guidelines is to provide a reference for 33 <para>The purpose of this guidelines is to provide a reference for
34 the plug-in developers and encourage the standarization of the 34 the plugin developers and encourage the standarization of the
35 different kind of plug-ins: C, shell, perl, python, etc.</para> 35 different kind of plugins: C, shell, perl, python, etc.</para>
36 36
37 <para>Nagios Plug-in Development Guidelines Copyright (C) 2000-2013 37 <para>Nagios Plugin Development Guidelines Copyright (C) 2000-2013
38 (Nagios Plugins Team)</para> 38 (Nagios Plugins Team)</para>
39 39
40 <para>Permission is granted to make and distribute verbatim 40 <para>Permission is granted to make and distribute verbatim
@@ -48,8 +48,8 @@
48<article> 48<article>
49<section id="DevRequirements"><title>Development platform requirements</title> 49<section id="DevRequirements"><title>Development platform requirements</title>
50 <para> 50 <para>
51 Nagios plugins are developed to the GNU standard, so any OS which is supported by GNU 51 Nagios Plugins are developed to the GNU standard, so any OS which is supported by GNU
52 should run the plugins. While the requirements for compiling the Nagios plugins release 52 should run the plugins. While the requirements for compiling the Nagios Plugins release
53 are very basic, developing from the Git repository requires additional software to be 53 are very basic, developing from the Git repository requires additional software to be
54 installed. These are the minimum levels of software required: 54 installed. These are the minimum levels of software required:
55 55
@@ -141,7 +141,7 @@
141 </section> 141 </section>
142 142
143 <section><title>Screen Output</title> 143 <section><title>Screen Output</title>
144 <para>The plug-in should print the diagnostic and just the 144 <para>The plugin should print the diagnostic and just the
145 usage part of the help message. A well written plugin would 145 usage part of the help message. A well written plugin would
146 then have --help as a way to get the verbose help.</para> 146 then have --help as a way to get the verbose help.</para>
147 147
@@ -330,7 +330,7 @@
330 to provide some to prevent the last pair of a) and the first of b) getting run 330 to provide some to prevent the last pair of a) and the first of b) getting run
331 together.) Please refer to the Nagios documentation for information on how to 331 together.) Please refer to the Nagios documentation for information on how to
332 configure such processing. However, it is the responsibility of the plugin writer 332 configure such processing. However, it is the responsibility of the plugin writer
333 to ensure the performance data is in a "Nagios plugins" format. 333 to ensure the performance data is in a "Nagios Plugins" format.
334 This is the expected format:</para> 334 This is the expected format:</para>
335 335
336 <literallayout> 336 <literallayout>
@@ -379,7 +379,7 @@
379 </listitem> 379 </listitem>
380 </orderedlist> 380 </orderedlist>
381 381
382 <para>It is up to third party programs to convert the Nagios plugins 382 <para>It is up to third party programs to convert the Nagios Plugins
383 performance data into graphs.</para> 383 performance data into graphs.</para>
384 </section> 384 </section>
385 385