ntptrace.1ntptracemdoc revision 294569
1169689Skan.Dd January 20 2016 2169689Skan.Dt NTPTRACE 1ntptracemdoc User Commands 3169689Skan.Os 4169689Skan.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 5169689Skan.\" 6169689Skan.\" It has been AutoGen-ed January 20, 2016 at 04:10:18 AM by AutoGen 5.18.5 7169689Skan.\" From the definitions ntptrace-opts.def 8169689Skan.\" and the template file agmdoc-cmd.tpl 9169689Skan.Sh NAME 10169689Skan.Nm ntptrace 11169689Skan.Nd Trace peers of an NTP server 12169689Skan.Sh SYNOPSIS 13169689Skan.Nm 14169689Skan.\" Mixture of short (flag) options and long options 15169689Skan.Op Fl flags 16169689Skan.Op Fl flag Op Ar value 17169689Skan.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18169689Skan[host] 19169689Skan.Pp 20169689Skan.Sh DESCRIPTION 21169689Skan\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 22169689Skanthe chain of NTP servers from a given host back to the primary time source. For 23169689Skanntptrace to work properly, each of these servers must implement the NTP Control 24169689Skanand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 25169689Skan.sp 26169689SkanIf given no arguments, ntptrace starts with localhost. Here is an example of 27169689Skanthe output from ntptrace: 28169689Skan.sp 29169689Skan.Bd -literal -offset indent 30169689Skan% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 31169689Skanserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 32169689Skanstratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 33169689Skan.Ed 34169689Skan.sp 35169689SkanOn each line, the fields are (left to right): the host name, the host stratum, 36169689Skanthe time offset between that host and the local host (as measured by 37169689Skan\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 38169689Skansynchronization distance, and (only for stratum\-1 servers) the reference clock 39169689SkanID. All times are given in seconds. Note that the stratum is the server hop 40169689Skancount to the primary source, while the synchronization distance is the 41169689Skanestimated error relative to the primary source. These terms are precisely 42169689Skandefined in RFC\-1305. 43169689Skan.Sh "OPTIONS" 44169689Skan.Bl -tag 45169689Skan.It Fl n , Fl \-numeric 46169689SkanPrint IP addresses instead of hostnames. 47169689Skan.sp 48169689SkanOutput hosts as dotted\-quad numeric format rather than converting to 49169689Skanthe canonical host names. 50169689Skan.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 51169689SkanMaximum number of peers to trace. 52169689SkanThis option takes an integer number as its argument. 53169689SkanThe default 54169689Skan.Ar number 55169689Skanfor this option is: 56169689Skan.ti +4 57169689Skan 99 58169689Skan.sp 59169689SkanThis option has not been fully documented. 60169689Skan.It Fl r Ar string , Fl \-host Ns = Ns Ar string 61169689SkanSingle remote host. 62169689SkanThe default 63169689Skan.Ar string 64169689Skanfor this option is: 65169689Skan.ti +4 66169689Skan 127.0.0.1 67169689Skan.sp 68169689SkanThis option has not been fully documented. 69169689Skan.It Fl \&? , Fl \-help 70169689SkanDisplay usage information and exit. 71169689Skan.It Fl \&! , Fl \-more\-help 72169689SkanPass the extended usage information through a pager. 73169689Skan.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 74169689SkanOutput version of program and exit. The default mode is `v', a simple 75169689Skanversion. The `c' mode will print copyright information and `n' will 76169689Skanprint the full copyright notice. 77169689Skan.El 78169689Skan.Sh "EXIT STATUS" 79169689SkanOne of the following exit values will be returned: 80169689Skan.Bl -tag 81169689Skan.It 0 " (EXIT_SUCCESS)" 82169689SkanSuccessful program execution. 83169689Skan.It 1 " (EXIT_FAILURE)" 84169689SkanThe operation failed or the command syntax was not valid. 85169689Skan.It 70 " (EX_SOFTWARE)" 86169689Skanlibopts had an internal operational error. Please report 87169689Skanit to autogen\-users@lists.sourceforge.net. Thank you. 88169689Skan.El 89169689Skan.Sh "NOTES" 90169689SkanThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 91169689Skanoption definitions. 92169689Skan