ntptrace.1ntptracemdoc revision 362716
1.Dd June 23 2020 2.Dt NTPTRACE 1ntptracemdoc User Commands 3.Os 4.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 5.\" 6.\" It has been AutoGen-ed June 23, 2020 at 02:21:38 AM by AutoGen 5.18.5 7.\" From the definitions ntptrace-opts.def 8.\" and the template file agmdoc-cmd.tpl 9.Sh NAME 10.Nm ntptrace 11.Nd Trace peers of an NTP server 12.Sh SYNOPSIS 13.Nm 14.\" Mixture of short (flag) options and long options 15.Op Fl flags 16.Op Fl flag Op Ar value 17.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18[host] 19.Pp 20.Sh DESCRIPTION 21\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 22the chain of NTP servers from a given host back to the primary time source. For 23ntptrace to work properly, each of these servers must implement the NTP Control 24and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 25.sp 26If given no arguments, ntptrace starts with localhost. Here is an example of 27the output from ntptrace: 28.sp 29.Bd -literal -offset indent 30% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 31server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 32stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 33.Ed 34.sp 35On each line, the fields are (left to right): the host name, the host stratum, 36the time offset between that host and the local host (as measured by 37\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 38synchronization distance, and (only for stratum\-1 servers) the reference clock 39ID. All times are given in seconds. Note that the stratum is the server hop 40count to the primary source, while the synchronization distance is the 41estimated error relative to the primary source. These terms are precisely 42defined in RFC\-1305. 43.Sh "OPTIONS" 44.Bl -tag 45.It Fl n , Fl \-numeric 46Print IP addresses instead of hostnames. 47.sp 48Output hosts as dotted\-quad numeric format rather than converting to 49the canonical host names. 50.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 51Maximum number of peers to trace. 52This option takes an integer number as its argument. 53The default 54.Ar number 55for this option is: 56.ti +4 57 99 58.sp 59This option has not been fully documented. 60.It Fl r Ar string , Fl \-host Ns = Ns Ar string 61Single remote host. 62The default 63.Ar string 64for this option is: 65.ti +4 66 127.0.0.1 67.sp 68This option has not been fully documented. 69.It Fl \&? , Fl \-help 70Display usage information and exit. 71.It Fl \&! , Fl \-more\-help 72Pass the extended usage information through a pager. 73.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 74Output version of program and exit. The default mode is `v', a simple 75version. The `c' mode will print copyright information and `n' will 76print the full copyright notice. 77.El 78.Sh "EXIT STATUS" 79One of the following exit values will be returned: 80.Bl -tag 81.It 0 " (EXIT_SUCCESS)" 82Successful program execution. 83.It 1 " (EXIT_FAILURE)" 84The operation failed or the command syntax was not valid. 85.It 70 " (EX_SOFTWARE)" 86libopts had an internal operational error. Please report 87it to autogen\-users@lists.sourceforge.net. Thank you. 88.El 89.Sh "NOTES" 90This manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 91option definitions. 92