misc/58134: ntpdate documented as obsolete, and shouldn't be.

[John Hay]

The following reply was made to PR misc/58134; it has been noted by GNATS.

From: John Hay <jhay at icomtek.csir.co.za>
To: Chris <chris-gnats33 at randomcamel.net>
Cc: FreeBSD-gnats-submit at freebsd.org
Subject: Re: misc/58134: ntpdate documented as obsolete, and shouldn't be.
Date: Thu, 16 Oct 2003 19:55:00 +0200

 >         the ntpdate(8) manpage claims:
 > 
 >         DESCRIPTION
 >              Note: The functionality of this program is now
 >              available in the ntpd(8) program.  See the -q command line
 >              option in the ntpd(8) page.  After a suitable period of
 >              mourning, the ntpdate utility is to be retired from this
 >              distribution.
 > 
 >         and the ntpd(8) manpage claims:
 > 
 >         -q  Exit the ntpd just after the first time the clock is set.
 >             This behavior mimics that of the ntpdate(8) program, which is
 >             to be retired.  The -g and -x options can be used with this
 >             option.
 > 
 >         however, ntpd -q has never seemed to work properly, just hanging
 >         even with an ntp.conf with valid servers. on top of that, ntpdate
 >         seems to be standard everywhere else (NetBSD and Linux sysadmins
 >         have never heard of -q), so removing it would violate POLA for
 >         anyone moving scripts to FreeBSD from other OSen.
 >                   
 > >How-To-Repeat:
 >         read manpages, try running ntpd -q.
 > >Fix:
 > 
 >         I'd suggest fixing the manpages and forgetting anyone ever planned
 >         to obsolete ntpdate, whether this involves emailing the ntp
 >         maintainers or not. the current manpages are confusing and
 >         apparently inaccurate.
 
 Remember that the official ntp docs are only available in html format.
 It is converted from that to man pages for your convenience. If you
 look at the official pages (which are a little newer than our man pages),
 don't you think it closely reflects that?
 
 http://www.eecis.udel.edu/~mills/ntp/html/ntpdate.html
 
 The fact that NetBSD and Linux hasn't heard of the -q option, is not a
 reflection on FreeBSD, just get them to upgrade their ntp. :-)
 
 I think if you really want something in ntp to change, the place to
 lobby it is with the ntp people.
 
 John
 -- 
 John Hay -- John.Hay at icomtek.csir.co.za / jhay at FreeBSD.org