tyler.durden/centreon-plugins
1
0
Fork 0
mirror of https://github.com/centreon/centreon-plugins.git synced 2025-07-28 16:14:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

+ Some typo doc fix

Browse Source
This commit is contained in:
Quentin Garnier 2014-12-24 14:39:09 +01:00
parent 8d8e479459
commit 7c046646bc
2 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
centreon-plugins/docs/developer/guide.rst
View File

@ -28,7 +28,7 @@ Root directories are organized by section :
* Operating System : os * Operating System : os
* Storage equipment : storage * Storage equipment : storage
According to the monitored object, there exists an organization which can use : According to the monitored object, it exists an organization which can use :
* Type * Type
* Constructor * Constructor
@ -38,12 +38,12 @@ According to the monitored object, there exists an organization which can use :
For example, if you want to add a plugin to monitor Linux by SNMP, you need to create this directory : For example, if you want to add a plugin to monitor Linux by SNMP, you need to create this directory :
:: ::
mkdir -p os/linux/snmp $ mkdir -p os/linux/snmp
You also need to create a "mode" directory for futures modes : You also need to create a "mode" directory for futures modes :
:: ::
mkdir os/linux/snmp/mode $ mkdir os/linux/snmp/mode
--------------- ---------------
Plugin creation Plugin creation
@ -52,7 +52,7 @@ Plugin creation
Once the directory is created, create the plugin file inside it : Once the directory is created, create the plugin file inside it :
:: ::
touch plugin.pm $ touch plugin.pm
Then, edit plugin.pm to add **license terms** by copying it from an other plugin. Don't forget to put your name at the end of it : Then, edit plugin.pm to add **license terms** by copying it from an other plugin. Don't forget to put your name at the end of it :
@ -83,7 +83,7 @@ The plugin need a **new** function to instantiate the object :
my ($class, %options) = @_; my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options); my $self = $class->SUPER::new(package => __PACKAGE__, %options);
bless $self, $class; bless $self, $class;
... ...
return $self; return $self;
@ -130,7 +130,6 @@ A description of the plugin is needed to generate the documentation :
.. tip:: .. tip::
plugin has ".pm" extension because it's a perl module. So don't forget to add **1;** at the end of the file plugin has ".pm" extension because it's a perl module. So don't forget to add **1;** at the end of the file
------------- -------------
Mode creation Mode creation
------------- -------------
@ -162,7 +161,7 @@ Declare used libraries (always the same) :
use warnings; use warnings;
use base qw(centreon::plugins::mode); use base qw(centreon::plugins::mode);
The mode need a **new** function to instantiate the object : The mode needs a **new** function to instantiate the object :
.. code-block:: perl .. code-block:: perl
@ -283,7 +282,6 @@ A description of the mode and its arguments is needed to generate the documentat
=cut =cut
--------------- ---------------
Commit and push Commit and push
--------------- ---------------

4
centreon-plugins/docs/user/guide.rst
View File

@ -481,7 +481,7 @@ I use an option but it doesn't seem to work
Before opening a ticket on the forge, please use the option ``--sanity-options``. It checks if you have misspell an option: Before opening a ticket on the forge, please use the option ``--sanity-options``. It checks if you have misspell an option:
:: ::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=traffic --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --interface='.*' --name --regex --verbose --skip --skip-speed0 --sanity-options $ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=traffic --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --interface='.*' --name --regex --verbose --skip --skip-speed0 --sanity-options
Unknown option: regex Unknown option: regex
I get the error: "UNKNOWN: Need to specify '--custommode'." I get the error: "UNKNOWN: Need to specify '--custommode'."
@ -515,7 +515,7 @@ I can't see help messages
"centreon-plugins" files must unix format (no windows carriage returns). You can change it with the following command: "centreon-plugins" files must unix format (no windows carriage returns). You can change it with the following command:
:: ::
$ find . -name "*.p[ml]" -type f -exec dos2unix \{\} \; $ find . -name "*.p[ml]" -type f -exec dos2unix \{\} \;
.. Warning:: Execute the command in "centreon-plugins" directory. .. Warning:: Execute the command in "centreon-plugins" directory.