1285612Sdelphij.Dd February 4 2015 2285612Sdelphij.Dt NTPTRACE 8 User Commands 3285612Sdelphij.Os 4285612Sdelphij.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 555857Ssheldonh.\" 655857Ssheldonh.\" $FreeBSD: releng/10.3/usr.sbin/ntp/doc/ntptrace.8 285612 2015-07-15 19:21:26Z delphij $ 755857Ssheldonh.\" 8285612Sdelphij.\" It has been AutoGen-ed February 4, 2015 at 02:37:48 AM by AutoGen 5.18.5pre4 9285612Sdelphij.\" From the definitions ntptrace-opts.def 10285612Sdelphij.\" and the template file agmdoc-cmd.tpl 1155857Ssheldonh.Sh NAME 1255857Ssheldonh.Nm ntptrace 13285612Sdelphij.Nd Trace peers of an NTP server 1455857Ssheldonh.Sh SYNOPSIS 1568965Sru.Nm 16285612Sdelphij.\" Mixture of short (flag) options and long options 17285612Sdelphij.Op Fl flags 18285612Sdelphij.Op Fl flag Op Ar value 19285612Sdelphij.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 20285612Sdelphij[host] 21285612Sdelphij.Pp 2255857Ssheldonh.Sh DESCRIPTION 23285612Sdelphij\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 24285612Sdelphijthe chain of NTP servers from a given host back to the primary time source. For 25285612Sdelphijntptrace to work properly, each of these servers must implement the NTP Control 26285612Sdelphijand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 27285612Sdelphij.sp 28285612SdelphijIf given no arguments, ntptrace starts with localhost. Here is an example of 29285612Sdelphijthe output from ntptrace: 30285612Sdelphij.sp 31285612Sdelphij.Bd -literal -offset indent 32285612Sdelphij% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 33285612Sdelphijserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 34285612Sdelphijstratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 3555857Ssheldonh.Ed 36285612Sdelphij.sp 37285612SdelphijOn each line, the fields are (left to right): the host name, the host stratum, 38285612Sdelphijthe time offset between that host and the local host (as measured by 39285612Sdelphij\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 40285612Sdelphijsynchronization distance, and (only for stratum\-1 servers) the reference clock 41285612SdelphijID. All times are given in seconds. Note that the stratum is the server hop 42285612Sdelphijcount to the primary source, while the synchronization distance is the 43285612Sdelphijestimated error relative to the primary source. These terms are precisely 44285612Sdelphijdefined in RFC\-1305. 45285612Sdelphij.Sh "OPTIONS" 46285612Sdelphij.Bl -tag 47285612Sdelphij.It Fl n , Fl \-numeric 48285612SdelphijPrint IP addresses instead of hostnames. 49285612Sdelphij.sp 50285612SdelphijOutput hosts as dotted\-quad numeric format rather than converting to 51285612Sdelphijthe canonical host names. 52285612Sdelphij.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 53285612SdelphijMaximum number of peers to trace. 54285612SdelphijThis option takes an integer number as its argument. 55285612SdelphijThe default 56285612Sdelphij.Ar number 57285612Sdelphijfor this option is: 58285612Sdelphij.ti +4 59285612Sdelphij 99 60285612Sdelphij.sp 61285612SdelphijThis option has not been fully documented. 62285612Sdelphij.It Fl r Ar string , Fl \-host Ns = Ns Ar string 63285612SdelphijSingle remote host. 64285612SdelphijThe default 65285612Sdelphij.Ar string 66285612Sdelphijfor this option is: 67285612Sdelphij.ti +4 68285612Sdelphij 127.0.0.1 69285612Sdelphij.sp 70285612SdelphijThis option has not been fully documented. 71285612Sdelphij.It Fl \&? , Fl \-help 72285612SdelphijDisplay usage information and exit. 73285612Sdelphij.It Fl \&! , Fl \-more\-help 74285612SdelphijPass the extended usage information through a pager. 75285612Sdelphij.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 76285612SdelphijOutput version of program and exit. The default mode is `v', a simple 77285612Sdelphijversion. The `c' mode will print copyright information and `n' will 78285612Sdelphijprint the full copyright notice. 7955857Ssheldonh.El 80285612Sdelphij.Sh "EXIT STATUS" 81285612SdelphijOne of the following exit values will be returned: 82285612Sdelphij.Bl -tag 83285612Sdelphij.It 0 " (EXIT_SUCCESS)" 84285612SdelphijSuccessful program execution. 85285612Sdelphij.It 1 " (EXIT_FAILURE)" 86285612SdelphijThe operation failed or the command syntax was not valid. 87285612Sdelphij.It 70 " (EX_SOFTWARE)" 88285612Sdelphijlibopts had an internal operational error. Please report 89285612Sdelphijit to autogen\-users@lists.sourceforge.net. Thank you. 90285612Sdelphij.El 91285612Sdelphij.Sh "NOTES" 92285612SdelphijThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 93285612Sdelphijoption definitions. 94