]> git.ipfire.org Git - thirdparty/chrony.git/commitdiff
doc: update for NTPv4 support
authorMiroslav Lichvar <mlichvar@redhat.com>
Mon, 13 Oct 2014 10:47:19 +0000 (12:47 +0200)
committerMiroslav Lichvar <mlichvar@redhat.com>
Tue, 14 Oct 2014 14:57:01 +0000 (16:57 +0200)
README
chrony.1
chrony.texi.in

diff --git a/README b/README
index b6b2de58bc6b79133db6a02171153e6694e45802..d5e9f60dff92a7d4752db64ce9f3915e3eadbe6f 100644 (file)
--- a/README
+++ b/README
@@ -41,7 +41,8 @@ session to the next)
 
 With a good reference clock the accuracy can reach one microsecond.
 
-chronyd can also operate as an RFC1305-compatible NTP server and peer.
+chronyd can also operate as an NTPv4 (RFC 5905) server, peer and broadcast
+server.
 
 
 What will chrony run on?
index b28504a116b45d08f3215389fbd2381940328fc5..d17e3c4c246e81b4d6085a1cbad695c1a9650d3b 100644 (file)
--- a/chrony.1
+++ b/chrony.1
@@ -11,12 +11,12 @@ chrony \- programs for keeping computer clocks accurate
 \fBchrony\fR is a pair of programs for keeping computer clocks accurate.
 \fIchronyd\fR is a background (daemon) program and \fIchronyc\fR is a
 command-line interface to it. Time reference sources for chronyd can be
-RFC1305 NTP servers, human (via keyboard and \fIchronyc\fR), or the computer's
+NTP servers, human (via keyboard and \fIchronyc\fR), or the computer's
 real-time clock at boot time (Linux only). chronyd can determine the rate at
 which the computer gains or loses time and compensate for it while no external
 reference is present. Its use of NTP servers can be switched on and off
 (through \fIchronyc\fR) to support computers with dial-up/intermittent access
-to the Internet, and it can also act as an RFC1305-compatible NTP server.
+to the Internet, and it can also act as an NTP server.
 
 .SH USAGE
 \fIchronyc\fR is a command-line interface program which can be used to
@@ -51,7 +51,8 @@ session to the next)
 
 With a good reference clock the accuracy can reach one microsecond.
 
-\fIchronyd\fR can also operate as an RFC1305-compatible NTP server and peer.
+\fIchronyd\fR can also operate as an NTPv4 (RFC 5905) server, peer and
+broadcast server.
 
 .SH "SEE ALSO"
 .BR chronyc(1),
index 6344dec3a66d45e827c935af265506222d48085c..fd2f487d00d12a01736faeda162bf4af0b929d54 100644 (file)
@@ -94,10 +94,9 @@ Data Security, Inc. MD5 Message-Digest Algorithm} for authenticating
 messages between different machines on the network.
 
 In writing the @code{chronyd} program, extensive use has been made of
-RFC1305, written by David Mills.  The @code{ntp} suite's source code has
-been occasionally used to check details of the protocol that the RFC did
-not make absolutely clear.  The core algorithms in @code{chronyd} are
-all completely distinct from @code{ntp}, however.
+RFC 1305 and RFC 5905, written by David Mills.  The source code of
+the NTP reference implementation has been used to check details of the
+protocol.
 @c }}}
 @c {{{ S:Availability
 @node Availability
@@ -211,11 +210,10 @@ Things @code{ntpd} can do that @code{chronyd} can't:
 
 @itemize @bullet
 @item
-@code{ntpd} fully supports NTP version 4 (RFC5905), including broadcast,
-multicast, manycast clients / servers and the orphan mode.  It also
-supports extra authentication schemes based on public-key cryptography
-(RFC5906). @code{chronyd} uses NTP version 3 (RFC1305), which is
-compatible with version 4.
+@code{ntpd} supports all operating modes from RFC 5905, including
+broadcast, multicast and manycast client / server.  It supports the
+orphan mode and it also supports authentication based on public-key
+cryptography described in RFC 5906.
 
 @item
 @code{ntpd} has been ported to more types of computer / operating
@@ -1935,7 +1933,7 @@ An example line (which actually appears as a single line in the file)
 from the measurements log file is shown below.
 
 @example
-2010-12-22 05:40:50 158.152.1.76    N  8 1111 111 1111 10 10 1.0 \
+2014-10-13 05:40:50 158.152.1.76    N  2 111 111 1111  10 10 1.0 \
    -4.966e-03  2.296e-01  1.577e-05  1.615e-01  7.446e-03
 @end example
 
@@ -1944,7 +1942,7 @@ values from the example line above) :
 
 @enumerate 1
 @item
-Date [2010-12-22]
+Date [2014-10-13]
 @item
 Hour:Minute:Second [05:40:50].  Note that the date/time pair is
 expressed in UTC, not the local time zone.
@@ -1958,12 +1956,13 @@ currently synchronised.) [N]
 @item
 Stratum of remote computer. [2]
 @item
-RFC1305 tests 1 through 4 (1=pass, 0=fail) [1111]
+RFC 5905 tests 1 through 3 (1=pass, 0=fail) [111]
 @item
-Tests for maximum delay, maximum delay ratio and maximum delay dev ratio,
-against defined parameters (1=pass, 0=fail) [111]
+RFC 5905 tests 5 through 7 (1=pass, 0=fail) [111]
 @item
-RFC1305 tests 5 through 8 (1=pass, 0=fail) [1111]
+Tests for maximum delay, maximum delay ratio and maximum delay dev ratio,
+against defined parameters, and a test for synchronisation loop
+(1=pass, 0=fail) [1111]
 @item
 Local poll [10]
 @item
@@ -1973,15 +1972,16 @@ Remote poll [10]
 to increase or decrease the polling level.  This is adjusted based on number
 of measurements currently being used for the regression algorithm). [1.0]
 @item
-The estimated local clock error (`theta' in RFC1305).  Positive indicates that the local clock is slow. [-4.966e-03].
+The estimated local clock error (`theta' in RFC 5905).  Positive
+indicates that the local clock is slow of the remote source. [-4.966e-03].
 @item
-The peer delay (`delta' in RFC1305). [2.296e-01]
+The peer delay (`delta' in RFC 5905). [2.296e-01]
 @item
-The peer dispersion (`epsilon' in RFC1305). [1.577e-05]
+The peer dispersion (`epsilon' in RFC 5905). [1.577e-05]
 @item
-The root delay (`Delta' in RFC1305). [1.615e-01]
+The root delay (`DELTA' in RFC 5905). [1.615e-01]
 @item
-The root dispersion (`E' in RFC1305). [7.446e-03]
+The root dispersion (`EPSILON' in RFC 5905). [7.446e-03]
 @end enumerate
 
 A banner is periodically written to the log file to indicate the