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