Date: Tue, 25 Dec 2001 16:08:57 -0800 (PST) From: Norihiro Kumagai <kumagai@attbi.com> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/33179: Some errata in ntpdate.8 manpage Message-ID: <200112260008.fBQ08v910184@c9795-a.vncvr1.wa.home.com>
next in thread | raw e-mail | index | archive | help
>Number: 33179 >Category: docs >Synopsis: Some errata in ntpdate.8 manpage >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Tue Dec 25 16:10:01 PST 2001 >Closed-Date: >Last-Modified: >Originator: Norihiro Kumagai >Release: FreeBSD 4.4-RELEASE i386 >Organization: FreeBSD Japanese Manual Page Translation Project (jpman) >Environment: System: FreeBSD c9795-a.vncvr1.wa.home.com 4.4-RELEASE FreeBSD 4.4-RELEASE #16: Sun Nov 4 13:05:43 PST 2001 kuma@c9795-a.vncvr1.wa.home.com:/usr/src/sys/compile/C9795A i386 In fact, the latest(as in Dec 21, 2001) ntp manpages. >Description: In the latest (revision 1.1.2.3) src/usr.sbin/ntp/doc/nptdate.8 file, 1) Several possible spelling incorrects are included. 2) Possible unnecessary trailing spaces in the .Nm/.Xr and some other macro lines. Please study the following patch file. Note that because I am not a native English speaker, some (or all:-) of the following correction proposal might be inappropriate. >How-To-Repeat: src/usr.sbin/ntp/doc/ntpdate.8 revision 1.1.2.3 >Fix: --- ntpdate.8 Wed Aug 29 07:50:56 2001 +++ ntpdate-mod.8 Tue Dec 25 15:56:26 2001 @@ -22,21 +22,21 @@ .Em Note : The functionality of this program is now available in the -.Xr ntpd 8 +.Xr ntpd 8 program. See the -.Fl q +.Fl q command line option in the -.Xr ntpd 8 +.Xr ntpd 8 page. After a suitable period of mourning, the -.Nm +.Nm program is to be retired from this distribution. .Pp -.Nm +.Nm sets the local date and time by polling the Network Time Protocol (NTP) server(s) given as the .Ar server @@ -48,7 +48,7 @@ selection algorithms are applied to select the best of these. Note that the accuracy and reliability of -.Nm +.Nm depends on the number of servers, the number of polls each time it is run and the interval between runs. @@ -58,7 +58,7 @@ .It Fl a Ar key Enable the authentication function and specify the key identifier to be used for authentication as the argument -.Ar key +.Ar key . The keys and key identifiers must match in both the client and server key files. The default is to disable @@ -74,9 +74,9 @@ if the offset is greater than +-128 ms. Note that, if the offset is much greater -than +-128 ms in this case, that it can take a long time (hours) to +than +-128 ms in this case, it can take a long time (hours) to slew the clock to the correct value. -During this time. the host +During this time, the host should not be used to synchronize clients. .It Fl b Force the time to be stepped using the @@ -89,7 +89,7 @@ time. .It Fl d Enable the debugging mode, in which -.Nm +.Nm will go through all the steps, but not adjust the local clock. Information @@ -100,7 +100,7 @@ .Ar authdelay , in seconds and fraction (see -.Xr ntpd 8 +.Xr ntpd 8 for details). This number is usually small enough to be negligible for most purposes, though specifying a @@ -112,14 +112,14 @@ .Pa /etc/ntp.keys . This file should be in the format described in -.Xr ntpd 8 . +.Xr ntpd 8 . .It Fl o Ar version Specify the NTP version for outgoint packets as the integer .Ar version , which can be 1 or 2. The default is 3. This allows -.Nm +.Nm to be used with older NTP versions. .It Fl p Ar samples Specify the number of samples to be acquired from each server @@ -132,31 +132,31 @@ .It Fl s Divert logging output from the standard output (default) to the system -.Xr syslog 3 +.Xr syslog 3 facility. This is designed primarily for convenience of -.Xr cron 8 +.Xr cron 8 scripts. .It Fl t Ar timeout Specify the maximum time waiting for a server response as the value .Ar timeout , in seconds and fraction. -The value is is +The value is rounded to a multiple of 0.2 seconds. The default is 1 second, a value suitable for polling across a LAN. .It Fl u Direct -.Nm -to use an unprivileged port or outgoing +.Nm +to use an unprivileged port for outgoing packets. This is most useful when behind a firewall that blocks incoming traffic to privileged ports, and you want to synchronise with hosts beyond the firewall. Note that the -.Fl d +.Fl d option always uses unprivileged ports. .It Fl v @@ -167,43 +167,43 @@ identification string to be logged. .El .Pp -.Nm +.Nm can be run manually as necessary to set the host clock, or it can be run from the host startup script to set the clock at boot time. This is useful in some cases to set the clock initially before starting the NTP daemon -.Xr ntpd 8 . +.Xr ntpd 8 . It is also possible to run -.Nm +.Nm from a -.Xr cron 8 +.Xr cron 8 script. However, it is important to note that -.Nm +.Nm with contrived -.Xr cron 8 +.Xr cron 8 scripts is no substitute for the NTP daemon, which uses sophisticated algorithms to maximize accuracy and reliability while minimizing resource use. Finally, since -.Nm +.Nm does not discipline the host clock frequency as does -.Xr ntpd 8 , +.Xr ntpd 8 , the accuracy using -.Nm +.Nm is limited. .Pp Time adjustments are made by -.Nm +.Nm in one of two ways. If -.Nm +.Nm determines the clock is in error more than 0.5 second it will simply step the time by calling the system .Xr settimeofday 2 @@ -215,22 +215,22 @@ The latter technique is less disruptive and more accurate when the error is small, and works quite well when -.Nm +.Nm is run by -.Xr cron 8 +.Xr cron 8 every hour or two. .Pp -.Nm +.Nm will decline to set the date if an NTP server daemon (e.g., -.Xr ntpd 8 ) +.Xr ntpd 8 ) is running on the same host. When running -.Nm +.Nm on a regular basis from -.Xr cron 8 +.Xr cron 8 as an alternative to running a daemon, doing so once every hour or two will result in precise enough timekeeping to avoid stepping the @@ -239,12 +239,12 @@ If NetInfo support is compiled into .Nm , then the -.Ic server +.Ic server argument is optional if -.Nm +.Nm can find a time server in the NetInfo configuration for -.Xr ntpd 8 . +.Xr ntpd 8 . .Sh FILES .Bl -tag -width /etc/ntp.keys -compact .It Pa /etc/ntp.keys >Release-Note: >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200112260008.fBQ08v910184>