1193323Sed.Dd February 27 2018 2193323Sed.Dt NTPTRACE 1ntptracemdoc User Commands 3193323Sed.Os 4193323Sed.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 5193323Sed.\" 6193323Sed.\" It has been AutoGen-ed February 27, 2018 at 10:50:13 AM by AutoGen 5.18.5 7193323Sed.\" From the definitions ntptrace-opts.def 8193323Sed.\" and the template file agmdoc-cmd.tpl 9193323Sed.Sh NAME 10193323Sed.Nm ntptrace 11193323Sed.Nd Trace peers of an NTP server 12193323Sed.Sh SYNOPSIS 13193323Sed.Nm 14193323Sed.\" Mixture of short (flag) options and long options 15193323Sed.Op Fl flags 16193323Sed.Op Fl flag Op Ar value 17193323Sed.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18193323Sed[host] 19193323Sed.Pp 20193323Sed.Sh DESCRIPTION 21193323Sed\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 22193323Sedthe chain of NTP servers from a given host back to the primary time source. For 23249423Sdimntptrace to work properly, each of these servers must implement the NTP Control 24249423Sdimand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 25249423Sdim.sp 26198090SrdivackyIf given no arguments, ntptrace starts with localhost. Here is an example of 27193323Sedthe output from ntptrace: 28198892Srdivacky.sp 29193323Sed.Bd -literal -offset indent 30249423Sdim% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 31193323Sedserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 32198892Srdivackystratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 33193323Sed.Ed 34193323Sed.sp 35193323SedOn each line, the fields are (left to right): the host name, the host stratum, 36193323Sedthe time offset between that host and the local host (as measured by 37249423Sdim\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 38263508Sdimsynchronization distance, and (only for stratum\-1 servers) the reference clock 39239462SdimID. All times are given in seconds. Note that the stratum is the server hop 40193323Sedcount to the primary source, while the synchronization distance is the 41239462Sdimestimated error relative to the primary source. These terms are precisely 42193323Seddefined in RFC\-1305. 43193323Sed.Sh "OPTIONS" 44193323Sed.Bl -tag 45193323Sed.It Fl n , Fl \-numeric 46193323SedPrint IP addresses instead of hostnames. 47193323Sed.sp 48212904SdimOutput hosts as dotted\-quad numeric format rather than converting to 49193323Sedthe canonical host names. 50239462Sdim.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 51239462SdimMaximum number of peers to trace. 52239462SdimThis option takes an integer number as its argument. 53239462SdimThe default 54239462Sdim.Ar number 55239462Sdimfor this option is: 56239462Sdim.ti +4 57239462Sdim 99 58239462Sdim.sp 59193323SedThis option has not been fully documented. 60193323Sed.It Fl r Ar string , Fl \-host Ns = Ns Ar string 61193323SedSingle remote host. 62206083SrdivackyThe default 63193323Sed.Ar string 64239462Sdimfor this option is: 65239462Sdim.ti +4 66193323Sed 127.0.0.1 67234353Sdim.sp 68234353SdimThis option has not been fully documented. 69234353Sdim.It Fl \&? , Fl \-help 70234353SdimDisplay usage information and exit. 71234353Sdim.It Fl \&! , Fl \-more\-help 72234353SdimPass the extended usage information through a pager. 73234353Sdim.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 74234353SdimOutput version of program and exit. The default mode is `v', a simple 75234353Sdimversion. The `c' mode will print copyright information and `n' will 76234353Sdimprint the full copyright notice. 77234353Sdim.El 78234353Sdim.Sh "EXIT STATUS" 79234353SdimOne of the following exit values will be returned: 80234353Sdim.Bl -tag 81234353Sdim.It 0 " (EXIT_SUCCESS)" 82234353SdimSuccessful program execution. 83234353Sdim.It 1 " (EXIT_FAILURE)" 84234353SdimThe operation failed or the command syntax was not valid. 85234353Sdim.It 70 " (EX_SOFTWARE)" 86234353Sdimlibopts had an internal operational error. Please report 87234353Sdimit to autogen\-users@lists.sourceforge.net. Thank you. 88234353Sdim.El 89234353Sdim.Sh "NOTES" 90234353SdimThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 91234353Sdimoption definitions. 92234353Sdim