ntptrace.1ntptracemdoc revision 285612
1238730Sdelphij.Dd June 29 2015 2330571Sdelphij.Dt NTPTRACE 1ntptracemdoc User Commands 3238730Sdelphij.Os 4238730Sdelphij.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 5238730Sdelphij.\" 6238730Sdelphij.\" It has been AutoGen-ed June 29, 2015 at 04:26:54 PM by AutoGen 5.18.5 7238730Sdelphij.\" From the definitions ntptrace-opts.def 8238730Sdelphij.\" and the template file agmdoc-cmd.tpl 960786Sps.Sh NAME 1060786Sps.Nm ntptrace 1160786Sps.Nd Trace peers of an NTP server 1260786Sps.Sh SYNOPSIS 1360786Sps.Nm 1460786Sps.\" Mixture of short (flag) options and long options 1560786Sps.Op Fl flags 1660786Sps.Op Fl flag Op Ar value 1760786Sps.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18330571Sdelphij[host] 19330571Sdelphij.Pp 2060786Sps.Sh DESCRIPTION 21330571Sdelphij\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 2260786Spsthe chain of NTP servers from a given host back to the primary time source. For 2360786Spsntptrace to work properly, each of these servers must implement the NTP Control 2460786Spsand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 2560786Sps.sp 26170256SdelphijIf given no arguments, ntptrace starts with localhost. Here is an example of 2760786Spsthe output from ntptrace: 2860786Sps.sp 2960786Sps.Bd -literal -offset indent 3060786Sps% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 3160786Spsserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 3260786Spsstratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 3360786Sps.Ed 34170256Sdelphij.sp 3560786SpsOn each line, the fields are (left to right): the host name, the host stratum, 36191930Sdelphijthe time offset between that host and the local host (as measured by 37128345Stjr\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 38128345Stjrsynchronization distance, and (only for stratum\-1 servers) the reference clock 39128345StjrID. All times are given in seconds. Note that the stratum is the server hop 40128345Stjrcount to the primary source, while the synchronization distance is the 41128345Stjrestimated error relative to the primary source. These terms are precisely 42128345Stjrdefined in RFC\-1305. 43330571Sdelphij.Sh "OPTIONS" 44330571Sdelphij.Bl -tag 45330571Sdelphij.It Fl n , Fl \-numeric 46128345StjrPrint IP addresses instead of hostnames. 47330571Sdelphij.sp 48128345StjrOutput hosts as dotted\-quad numeric format rather than converting to 4960786Spsthe canonical host names. 5060786Sps.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 5160786SpsMaximum number of peers to trace. 5260786SpsThis option takes an integer number as its argument. 5360786SpsThe default 5460786Sps.Ar number 55330571Sdelphijfor this option is: 56330571Sdelphij.ti +4 5760786Sps 99 5860786Sps.sp 5960786SpsThis option has not been fully documented. 6060786Sps.It Fl r Ar string , Fl \-host Ns = Ns Ar string 6160786SpsSingle remote host. 6260786SpsThe default 6360786Sps.Ar string 6460786Spsfor this option is: 6560786Sps.ti +4 6660786Sps 127.0.0.1 6760786Sps.sp 68161475SdelphijThis option has not been fully documented. 6960786Sps.It Fl \&? , Fl \-help 7060786SpsDisplay usage information and exit. 7160786Sps.It Fl \&! , Fl \-more\-help 72161475SdelphijPass the extended usage information through a pager. 73161475Sdelphij.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 7460786SpsOutput version of program and exit. The default mode is `v', a simple 7560786Spsversion. The `c' mode will print copyright information and `n' will 7660786Spsprint the full copyright notice. 7760786Sps.El 7860786Sps.Sh "EXIT STATUS" 7960786SpsOne of the following exit values will be returned: 80161475Sdelphij.Bl -tag 8160786Sps.It 0 " (EXIT_SUCCESS)" 8260786SpsSuccessful program execution. 8360786Sps.It 1 " (EXIT_FAILURE)" 8460786SpsThe operation failed or the command syntax was not valid. 8560786Sps.It 70 " (EX_SOFTWARE)" 8660786Spslibopts had an internal operational error. Please report 8760786Spsit to autogen\-users@lists.sourceforge.net. Thank you. 8860786Sps.El 8960786Sps.Sh "NOTES" 9060786SpsThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 9160786Spsoption definitions. 9260786Sps