From: Jakub Jankowski <shasta@toxcorp.com>
Date: Thu, 21 Jan 2016 20:43:26 +0000 (+0100)
Subject: docs: Add info about mode7 requirement for ntpd
X-Git-Tag: collectd-5.5.1^2~1
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=e68993d241360e8da64e1c1f2d8adb3bc7f67e34;p=collectd.git

docs: Add info about mode7 requirement for ntpd

Since ntpd-4.2.7p230 "mode 7" requests are ignored by default, and
that's what ntpd plugin uses currently. The ntp daemon must be
explicitly configured to enable mode7 requests.
This patch adds short information about that to collectd.conf manpage.

Related to collectd/collectd#932

Signed-off-by: Jakub Jankowski <shasta@toxcorp.com>
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index f4bd32ae..d856d21c 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -3751,6 +3751,18 @@ Default: C<Collectd notify: %s@%s>
 
 =head2 Plugin C<ntpd>
 
+The C<ntpd> plugin collects per-peer ntpd data such as time offset and time
+dispersion.
+
+For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
+wire - using B<mode 7> specific requests. This mode is deprecated with
+newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
+correctly with them, the ntp daemon must be explicitly configured to
+enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
+manual page for details.
+
+Available configuration options for the C<ntpd> plugin:
+
 =over 4
 
 =item B<Host> I<Hostname>