1310419Sdelphij.Dd November 21 2016 2275970Scy.Dt NTPTRACE @NTPTRACE_MS@ User Commands 3275970Scy.Os 4275970Scy.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 5275970Scy.\" 6310419Sdelphij.\" It has been AutoGen-ed November 21, 2016 at 07:59:08 AM by AutoGen 5.18.5 7275970Scy.\" From the definitions ntptrace-opts.def 8275970Scy.\" and the template file agmdoc-cmd.tpl 9275970Scy.Sh NAME 10275970Scy.Nm ntptrace 11275970Scy.Nd Trace peers of an NTP server 12275970Scy.Sh SYNOPSIS 13275970Scy.Nm 14275970Scy.\" Mixture of short (flag) options and long options 15275970Scy.Op Fl flags 16275970Scy.Op Fl flag Op Ar value 17275970Scy.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18275970Scy[host] 19275970Scy.Pp 20275970Scy.Sh DESCRIPTION 21275970Scy\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 22275970Scythe chain of NTP servers from a given host back to the primary time source. For 23275970Scyntptrace to work properly, each of these servers must implement the NTP Control 24275970Scyand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 25275970Scy.sp 26275970ScyIf given no arguments, ntptrace starts with localhost. Here is an example of 27275970Scythe output from ntptrace: 28275970Scy.sp 29275970Scy.Bd -literal -offset indent 30275970Scy% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 31275970Scyserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 32275970Scystratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 33275970Scy.Ed 34275970Scy.sp 35275970ScyOn each line, the fields are (left to right): the host name, the host stratum, 36275970Scythe time offset between that host and the local host (as measured by 37275970Scy\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 38275970Scysynchronization distance, and (only for stratum\-1 servers) the reference clock 39275970ScyID. All times are given in seconds. Note that the stratum is the server hop 40275970Scycount to the primary source, while the synchronization distance is the 41275970Scyestimated error relative to the primary source. These terms are precisely 42275970Scydefined in RFC\-1305. 43275970Scy.Sh "OPTIONS" 44275970Scy.Bl -tag 45275970Scy.It Fl n , Fl \-numeric 46275970ScyPrint IP addresses instead of hostnames. 47275970Scy.sp 48275970ScyOutput hosts as dotted\-quad numeric format rather than converting to 49275970Scythe canonical host names. 50275970Scy.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 51275970ScyMaximum number of peers to trace. 52275970ScyThis option takes an integer number as its argument. 53275970ScyThe default 54275970Scy.Ar number 55275970Scyfor this option is: 56275970Scy.ti +4 57275970Scy 99 58275970Scy.sp 59275970ScyThis option has not been fully documented. 60275970Scy.It Fl r Ar string , Fl \-host Ns = Ns Ar string 61275970ScySingle remote host. 62275970ScyThe default 63275970Scy.Ar string 64275970Scyfor this option is: 65275970Scy.ti +4 66275970Scy 127.0.0.1 67275970Scy.sp 68275970ScyThis option has not been fully documented. 69275970Scy.It Fl \&? , Fl \-help 70275970ScyDisplay usage information and exit. 71275970Scy.It Fl \&! , Fl \-more\-help 72275970ScyPass the extended usage information through a pager. 73275970Scy.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 74275970ScyOutput version of program and exit. The default mode is `v', a simple 75275970Scyversion. The `c' mode will print copyright information and `n' will 76275970Scyprint the full copyright notice. 77275970Scy.El 78275970Scy.Sh "EXIT STATUS" 79275970ScyOne of the following exit values will be returned: 80275970Scy.Bl -tag 81275970Scy.It 0 " (EXIT_SUCCESS)" 82275970ScySuccessful program execution. 83275970Scy.It 1 " (EXIT_FAILURE)" 84275970ScyThe operation failed or the command syntax was not valid. 85275970Scy.It 70 " (EX_SOFTWARE)" 86275970Scylibopts had an internal operational error. Please report 87275970Scyit to autogen\-users@lists.sourceforge.net. Thank you. 88275970Scy.El 89275970Scy.Sh "NOTES" 90275970ScyThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 91275970Scyoption definitions. 92