comments and notes

git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/branches/dermoth_ntp_rework@1833 f882894a-f735-0410-b71e-b25c423dba1c

2 files changed, 25 insertions, 3 deletions

diff --git a/plugins/check_ntp_peer.c b/plugins/check_ntp_peer.c
index 840fe0a..016a034 100644
--- a/plugins/check_ntp_peer.c
+++ b/plugins/check_ntp_peer.c
@@ -12,9 +12,14 @@
 *
 * This file contains the check_ntp_peer plugin
 *
-*  This plugin to check ntp servers independant of any commandline
+*  This plugin checks an NTP server independent of any commandline
 *  programs or external libraries.
 *
+*  Use this plugin to check the health of an NTP server. It supports
+*  checking the offset with the sync peer, the jitter and stratum. This
+*  plugin will not check the clock offset between the local host and NTP
+*  server; please use check_ntp_time for that purpose.
+*
 *
 * License Information:
 *
@@ -592,6 +597,13 @@ void print_help(void){
 
         printf("\n");
         printf("%s\n", _("Notes:"));
+        printf(" %s\n", _("This plugin checks an NTP server independent of any commandline"));
+        printf(" %s\n\n", _("programs or external libraries."));
+        printf(" %s\n", _("Use this plugin to check the health of an NTP server. It supports"));
+        printf(" %s\n", _("checking the offset with the sync peer, the jitter and stratum. This"));
+        printf(" %s\n", _("plugin will not check the clock offset between the local host and NTP"));
+        printf(" %s\n\n", _("server; please use check_ntp_time for that purpose."));
+
         printf(" %s\n", _("See:"));
         printf(" %s\n", ("http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT"));
         printf(" %s\n", _("for THRESHOLD format and examples."));
diff --git a/plugins/check_ntp_time.c b/plugins/check_ntp_time.c
index c945076..85015d6 100644
--- a/plugins/check_ntp_time.c
+++ b/plugins/check_ntp_time.c
@@ -12,8 +12,12 @@
 *
 * This file contains the check_ntp_time plugin
 *
-*  This plugin checks the clock offset with an NTP server. It is
-*  independant of any commandline programs or external libraries.
+*  This plugin checks the clock offset between the local host and a
+*  remote NTP server. It is independent of any commandline programs or
+*  external libraries.
+*
+*  If you'd rather want to monitor an NTP server, please use
+*  check_ntp_peer.
 *
 *
 * License Information:
@@ -594,6 +598,12 @@ void print_help(void){
 
         printf("\n");
         printf("%s\n", _("Notes:"));
+        printf(" %s\n", _("This plugin checks the clock offset between the local host and a"));
+        printf(" %s\n", _("remote NTP server. It is independent of any commandline programs or"));
+        printf(" %s\n\n", _("external libraries."));
+        printf(" %s\n", _("If you'd rather want to monitor an NTP server, please use"));
+        printf(" %s\n\n", _("check_ntp_peer."));
+
         printf(" %s\n", _("See:"));
         printf(" %s\n", ("http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT"));
         printf(" %s\n", _("for THRESHOLD format and examples."));