Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / usr.sbin / ntp / doc / ntptrace.8
1 .\"
2 .\" $FreeBSD: src/usr.sbin/ntp/doc/ntptrace.8,v 1.1.2.6 2003/03/11 22:31:30 trhodes Exp $
3 .\" $DragonFly: src/usr.sbin/ntp/doc/Attic/ntptrace.8,v 1.2 2003/06/17 04:29:58 dillon Exp $
4 .\"
5 .Dd January 6, 2000
6 .Dt NTPTRACE 8
7 .Os
8 .Sh NAME
9 .Nm ntptrace
10 .Nd "trace a chain of NTP servers back to the primary source"
11 .Sh SYNOPSIS
12 .Nm
13 .Op Fl vdn
14 .Op Fl r Ar retries
15 .Op Fl t Ar timeout
16 .Op Ar server
17 .Sh DESCRIPTION
18 The
19 .Nm
20 utility determines where a given Network Time Protocol (NTP) server gets
21 its time from, and follows the chain of NTP servers back to their
22 master time source.
23 If given no arguments, it starts with
24 .Dq localhost .
25 .Pp
26 Here is an example of the output from
27 .Nm :
28 .Bd -literal
29 % ntptrace
30 localhost: stratum 4, offset 0.0019529, synch distance 0.144135
31 server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784
32 usndh.edu: stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
33 .Ed
34 .Pp
35 On each line, the fields are (left to right): the host name, the
36 host stratum,
37 the time offset between that host and the local host
38 (as measured by
39 .Nm ;
40 this is why it is not always zero for
41 .Dq localhost ) ,
42 the host
43 synchronization distance,
44 and (only for stratum-1 servers) the reference clock ID.  All times
45 are given in seconds.
46 Note that the stratum is the server hop count to the primary source,
47 while the synchronization distance is the estimated error
48 relative to the primary source.
49 These terms are precisely defined in RFC 1305.
50 .Pp
51 The following options are available:
52 .Bl -tag -width indent
53 .It Fl d
54 Turn on some debugging output.
55 .It Fl n
56 Turn off the printing of host names; instead, host IP addresses
57 are given.  This may be necessary if a nameserver is down.
58 .It Fl r Ar retries
59 Set the number of retransmission attempts for each host; the default is 5.
60 .It Fl t Ar timeout
61 Set the retransmission timeout (in seconds); the default is 2.
62 .It Fl v
63 Print verbose information about the NTP servers.
64 .El
65 .Sh SEE ALSO
66 .Xr ntpd 8 ,
67 .Xr ntpdc 8
68 .Rs
69 .%A D L Mills
70 .%T Network Time Protocol (Version 3)
71 .%O RFC1305
72 .Re
73 .Sh BUGS
74 This program makes no attempt to improve accuracy by doing multiple
75 samples.