Improve most used helps (#4453)

src/centreon/plugins/dbi.pm

@@ -365,32 +365,34 @@ dbi class
 
 =item B<--datasource>
 
-Datasource (required. Depends of database server).
+Database server information, mandatory if the server's address and port are not
+defined in the corresponding options. The syntax depends on the database type.
 
 =item B<--username>
 
-Database username.
+User name used to connect to the database.
 
 =item B<--password>
 
-Database password.
+Password for the defined user name.
 
 =item B<--connect-options>
 
-Add options in database connect.
+Add connection options for the DBI connect method.
 Format: name=value,name2=value2,...
 
 =item B<--connect-query>
 
-Execute a query just after connection.
+Execute a query just after the connection.
 
 =item B<--sql-errors-exit>
 
-Exit code for DB Errors (default: unknown)
+Expected status in case of DB error or timeout.
+Possible values are warning, critical and unknown (default).
 
 =item B<--timeout>
 
-Timeout in seconds for connection
+Timeout in seconds for connection.
 
 =item B<--exec-timeout>
 

src/centreon/plugins/http.pm

@@ -256,20 +256,20 @@ Set the address you want to connect to. Useful if hostname is only a vhost, to a
 
 =item B<--proxyurl>
 
-Proxy URL
+Proxy URL. Eg: http://my.proxy:3128
 
 =item B<--proxypac>
 
-Proxy pac file (can be a URL or local file)
+Proxy pac file (can be a URL or a local file).
 
 =item B<--insecure>
 
-Insecure SSL connections.
+Accept insecure SSL connections.
 
 =item B<--http-backend>
 
-Set the backend used (Default: 'lwp')
+Perl library to use for HTTP transactions.
-For curl: --http-backend=curl
+Possible values are: lwp (default) and curl.
 
 =back
 

src/centreon/plugins/multi.pm

@@ -108,13 +108,14 @@ Check multiple modes at once.
 
 =item B<--modes-exec>
 
-Which modes to select (separated by coma).
+Modes to use, separated by commas.
 Example for linux: --modes-exec=cpu,memory,storage,interfaces
 
 =item B<--option-mode>
 
-Set options for a specifi mode (can be multiple).
+Define options for the modes selected in --modes-exec.
-Example interfaces and storage snmp:
+The option can be used several times.
+E.g.: to define two options for the interfaces mode and one for the storage mode:
 --option-mode='interfaces,--statefile-dir=/tmp' --option-mode='interfaces,--add-traffic' --option-mode='storage,--statefile-dir=/tmp'
 
 =back

src/centreon/plugins/output.pm

@@ -1553,11 +1553,11 @@ Common examples:
 
 =over 4
 
-Change storage free perfdata in used: --change-perfdata=free,used,invert()
+Convert storage free perfdata into used: --change-perfdata=free,used,invert()
 
-Change storage free perfdata in used: --change-perfdata=used,free,invert()
+Convert storage free perfdata into used: --change-perfdata=used,free,invert()
 
-Scale traffic values automaticaly: --change-perfdata=traffic,,scale(auto)
+Scale traffic values automatically: --change-perfdata=traffic,,scale(auto)
 
 Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps
 
@@ -1567,8 +1567,14 @@ Change traffic values in percent: --change-perfdata=traffic_in,,percent()
 
 =item B<--extend-perfdata-group>
 
-Extend perfdata from multiple perfdatas (methods in target are: min, max, average, sum)
+Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names.
-Syntax: --extend-perfdata-group=searchlabel,newlabel,target[,[newuom],[min],[max]]
+Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[newuom],[min],[max]]
+regex: regular expression
+namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex).
+calculation: how the values of the new metrics should be calculated
+newuom (optional): unit of measure for the new metrics
+min (optional): lowest value the metrics can reach
+max (optional): highest value the metrics can reach
 
 Common examples:
 
@@ -1614,40 +1620,47 @@ and an output.
 
 =item B<--output-ignore-label>
 
-Remove the status label from the beginning of the output.
+Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the 
+beginning of the output.
 Eg: 'OK: Ram Total:...' will become 'Ram Total:...'
 
 =item B<--output-xml>
 
-Display output in XML format.
+Return the output in XML format (to send to an XML API).
 
 =item B<--output-json>
 
-Display output in JSON format.
+Return the output in JSON format (to send to a JSON API).
 
 =item B<--output-openmetrics>
 
-Display metrics in OpenMetrics format.
+Return the output in OpenMetrics format (to send to a tool expecting this
+format).
 
 =item B<--output-file>
 
-Write output in file (can be used with json and xml options)
+Write output in file (can be combined with json, xml and openmetrics options).
+E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
 
 =item B<--disco-format>
 
-Display discovery arguments (if the mode manages it).
+Applies only to modes beginning with 'list-'.
+Returns the list of available macros to configure a service discovery rule
+(formatted in XML).
 
 =item B<--disco-show>
 
-Display discovery values (if the mode manages it).
+Applies only to modes beginning with 'list-'.
+Returns the list of discovered objects (formatted in XML) for service discovery.
 
 =item B<--float-precision>
 
-Set the float precision for thresholds (default: 8).
+Define the float precision for thresholds (default: 8).
 
 =item B<--source-encoding>
 
-Set encoding of monitoring sources (in some cases. Default: 'UTF-8').
+Define the character encoding of the response sent by the monitored resource
+Default: 'UTF-8'.
 
 =head1 DESCRIPTION
 

src/centreon/plugins/script.pm

@@ -455,33 +455,34 @@ List all available plugins.
 
 =item B<--version>
 
-Print global version.
+Return the version of the plugin.
 
 =item B<--help>
 
-Print a brief help message and exits.
+Return the help message for the plugin and exit.
 
 =item B<--ignore-warn-msg>
 
-Perl warn messages are ignored (not displayed).
+Ignore Perl warning messages (they will not be displayed).
 
 =item B<--runas>
 
-Run the script as a different user (prefer to use directly the good user).
+Run the script as a different user.
 
 =item B<--global-timeout>
 
-Set script timeout.
+Define the script's timeout.
 
 =item B<--environment>
 
-Set environment variables for the script (set them in the execution environment
+Define environment variables for the script (set them in the execution environment
 before running it for better performance).
 
 =item B<--convert-args>
 
-Change strings of arguments. Useful to use '!' in nrpe protocol.
+Replace a pattern in the provided arguments. Useful to bypass forbidden characters.
-Example: --convert-args='##,\x21'
+E.g.: when a password transmitted via the NRPE protocol contains '!' (which is
+interpreted as a separator), you can send '##' instead of the '!' and the plugin will replace '##' with '!', using the --convert-args='##,\x21' option.
 
 =back
 

src/centreon/plugins/script_custom.pm

@@ -287,7 +287,7 @@ Check minimal version of mode. If not, unknown error.
 
 =item B<--version>
 
-Display the plugin's version.
+Return the version of the plugin.
 
 =item B<--custommode>
 

src/centreon/plugins/script_simple.pm

@@ -218,7 +218,7 @@ Check minimal version of mode. If not, unknown error.
 
 =item B<--version>
 
-Display the plugin's version.
+Return the version of the plugin.
 
 =item B<--pass-manager>
 

src/centreon/plugins/script_snmp.pm

@@ -226,7 +226,7 @@ Check minimal version of mode. If not, unknown error.
 
 =item B<--version>
 
-Display the plugin's version.
+Return the version of the plugin.
 
 =item B<--pass-manager>
 

src/centreon/plugins/script_sql.pm

@@ -286,19 +286,20 @@ Check minimal version of mode. If not, unknown error.
 
 =item B<--version>
 
-Display the plugin's version.
+Return the version of the plugin.
 
 =item B<--sqlmode>
 
-Choose a sql mode (Default: "dbi").
+This plugin offers several ways to query the database (default: dbi).
+See --list-sqlmode.
 
 =item B<--list-sqlmode>
 
-List available sql modes.
+List all available sql modes.
 
 =item B<--multiple>
 
-Multiple database connections (required by some specific modes).
+Enable connecting to multiple databases (required by some specific modes such as replication).
 
 =item B<--pass-manager>
 

src/centreon/plugins/script_wsman.pm

@@ -222,7 +222,7 @@ Check minimal version of mode. If not, unknown error.
 
 =item B<--version>
 
-Display the plugin's version.
+Return the version of the plugin.
 
 =item B<--pass-manager>
 

src/centreon/plugins/snmp.pm

@@ -1106,27 +1106,29 @@ snmp class
 
 =item B<--hostname>
 
-Hostname to query (required).
+Name or address of the host to monitor (mandatory).
 
 =item B<--snmp-community>
 
-Read community (defaults to public).
+SNMP community (default value: public). It is recommended to use a read-only
+community.
 
 =item B<--snmp-version>
 
-Version: 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3.
+Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3.
 
 =item B<--snmp-port>
 
-Port (default: 161).
+UDP port to send the SNMP request to (default: 161).
 
 =item B<--snmp-timeout>
 
-Timeout in secondes (default: 1) before retries.
+Time to wait before sending the request again if no reply has been received,
+in seconds (default: 1). See also --snmp-retries.
 
 =item B<--snmp-retries>
 
-Set the number of retries (default: 5) before failure.
+Maximum number of retries (default: 5).
 
 =item B<--maxrepetitions>
 
@@ -1138,11 +1140,13 @@ How many oid values per SNMP request (default: 50) (for get_leef method. Be caut
 
 =item B<--snmp-autoreduce>
  
-Auto reduce SNMP request size in case of SNMP errors (By default, the divisor is 2).
+Progressively reduce the number requested OIDs in bulk mode. Use it in case of
+SNMP errors (By default, the number is divided by 2).
 
 =item B<--snmp-force-getnext>
 
-Use snmp getnext function (even in snmp v2c and v3).
+Use snmp getnext function in snmp v2c and v3. This will request one OID at a
+time.
 
 =item B<--snmp-cache-file>
 
@@ -1150,69 +1154,77 @@ Use SNMP cache file.
 
 =item B<--snmp-username>
 
-Security name (only for SNMP v3).
+SNMP v3 only:
+User name (securityName). 
 
 =item B<--authpassphrase>
 
-Authentication protocol pass phrase.
+SNMP v3 only:
+Pass phrase hashed using the authentication protocol defined in the 
+--authprotocol option.
 
 =item B<--authprotocol>
 
+SNMP v3 only:
 Authentication protocol: MD5|SHA. Since net-snmp 5.9.1: SHA224|SHA256|SHA384|SHA512.
 
 =item B<--privpassphrase>
 
-Privacy protocol pass phrase
+SNMP v3 only:
+Privacy pass phrase (privPassword) to encrypt messages using the protocol
+defined in the --privprotocol option.
 
 =item B<--privprotocol>
 
-Privacy protocol: DES|AES. Since net-snmp 5.9.1: AES192|AES192C|AES256|AES256C.
+SNMP v3 only:
+Privacy protocol (privProtocol) used to encrypt messages.
+Supported protocols are: DES|AES and since net-snmp 5.9.1: AES192|AES192C|AES256|AES256C.
 
 =item B<--contextname>
 
-Context name
+SNMP v3 only:
+Context name (contextName), if relevant for the monitored host.
 
 =item B<--contextengineid>
 
-Context engine ID
+SNMP v3 only:
+Context engine ID (contextEngineID), if relevant for the monitored host, given 
+as a hexadecimal string.
 
 =item B<--securityengineid>
 
-Security engine ID
+SNMP v3 only:
+Security engine ID, given as a hexadecimal string.
 
 =item B<--snmp-errors-exit>
 
-Exit code for SNMP Errors (default: unknown)
+Expected status in case of SNMP error or timeout.
+Possible values are warning, critical and unknown (default).
 
 =item B<--snmp-tls-transport>
 
-TLS Transport communication used (can be: 'dtlsudp', 'tlstcp').
+Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp').
 
 =item B<--snmp-tls-our-identity>
 
-Our X.509 identity to use, which should either be a fingerprint or the
+X.509 certificate to identify ourselves. Can be the path to the certificate file
-filename that holds the certificate.
+or its contents.
 
 =item B<--snmp-tls-their-identity>
 
-The remote server's identity to connect to, specified as either a
+X.509 certificate to identify the remote host. Can be the path to the 
-fingerprint or a file name.  Either this must be specified, or the
+certificate file or its contents. This option is unnecessary if the certificate
-hostname below along with a trust anchor.
+is already trusted by your system.
 
 =item B<--snmp-tls-their-hostname>
 
-The remote server's hostname that is expected.  If their certificate
+Common Name (CN) expected in the certificate sent by the host if it differs from
-was signed by a CA then their hostname presented in the certificate
+the value of the --hostname parameter.
-must match this value or the connection fails to be established (to
-avoid man-in-the-middle attacks).
 
 =item B<--snmp-tls-trust-cert>
 
-A trusted certificate to use as trust anchor (like a CA certificate)
+A trusted CA certificate used to verify a remote host's certificate. 
-for verifying a remote server's certificate. If a CA certificate is
+If you use this option, you must also  define --snmp-tls-their-hostname.
-used to validate a certificate then the TheirHostname parameter must
-also be specified to ensure their presented hostname in the certificate
-matches.
 
 =back
 

src/centreon/plugins/ssh.pm

@@ -108,8 +108,8 @@ SSH abstraction layer for sscli, plink and libssh backends
 
 =item B<--ssh-backend>
 
-Set the backend used (Default: 'sshcli')
+Define the backend you want to use.
-Can be: sshcli, plink, libssh.
+It can be: sshcli (default), plink and libssh.
 
 =item B<--ssh-username>