ntptrace.mdoc.in revision 294569
168651Skris.Dd January 20 2016 268651Skris.Dt NTPTRACE @NTPTRACE_MS@ User Commands 368651Skris.Os 468651Skris.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 568651Skris.\" 668651Skris.\" It has been AutoGen-ed January 20, 2016 at 04:10:18 AM by AutoGen 5.18.5 768651Skris.\" From the definitions ntptrace-opts.def 8280304Sjkim.\" and the template file agmdoc-cmd.tpl 968651Skris.Sh NAME 1068651Skris.Nm ntptrace 1168651Skris.Nd Trace peers of an NTP server 1268651Skris.Sh SYNOPSIS 1368651Skris.Nm 1468651Skris.\" Mixture of short (flag) options and long options 15280304Sjkim.Op Fl flags 1668651Skris.Op Fl flag Op Ar value 1768651Skris.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 1868651Skris[host] 1968651Skris.Pp 2068651Skris.Sh DESCRIPTION 2168651Skris\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 22280304Sjkimthe chain of NTP servers from a given host back to the primary time source. For 2368651Skrisntptrace to work properly, each of these servers must implement the NTP Control 2468651Skrisand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 2568651Skris.sp 2668651SkrisIf given no arguments, ntptrace starts with localhost. Here is an example of 2768651Skristhe output from ntptrace: 2868651Skris.sp 2968651Skris.Bd -literal -offset indent 3068651Skris% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 3168651Skrisserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 3268651Skrisstratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 3368651Skris.Ed 3468651Skris.sp 3568651SkrisOn each line, the fields are (left to right): the host name, the host stratum, 3668651Skristhe time offset between that host and the local host (as measured by 37280304Sjkim\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 3868651Skrissynchronization distance, and (only for stratum\-1 servers) the reference clock 3968651SkrisID. All times are given in seconds. Note that the stratum is the server hop 40280304Sjkimcount to the primary source, while the synchronization distance is the 4168651Skrisestimated error relative to the primary source. These terms are precisely 4268651Skrisdefined in RFC\-1305. 4368651Skris.Sh "OPTIONS" 4468651Skris.Bl -tag 4568651Skris.It Fl n , Fl \-numeric 4668651SkrisPrint IP addresses instead of hostnames. 4768651Skris.sp 4868651SkrisOutput hosts as dotted\-quad numeric format rather than converting to 4968651Skristhe canonical host names. 5068651Skris.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 5168651SkrisMaximum number of peers to trace. 52280304SjkimThis option takes an integer number as its argument. 5368651SkrisThe default 5468651Skris.Ar number 5568651Skrisfor this option is: 5668651Skris.ti +4 5768651Skris 99 5868651Skris.sp 59160814SsimonThis option has not been fully documented. 60160814Ssimon.It Fl r Ar string , Fl \-host Ns = Ns Ar string 61160814SsimonSingle remote host. 62109998SmarkmThe default 6368651Skris.Ar string 64280304Sjkimfor this option is: 65280304Sjkim.ti +4 66280304Sjkim 127.0.0.1 67280304Sjkim.sp 6868651SkrisThis option has not been fully documented. 6968651Skris.It Fl \&? , Fl \-help 70280304SjkimDisplay usage information and exit. 7168651Skris.It Fl \&! , Fl \-more\-help 7268651SkrisPass the extended usage information through a pager. 7368651Skris.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 7468651SkrisOutput version of program and exit. The default mode is `v', a simple 7568651Skrisversion. The `c' mode will print copyright information and `n' will 7668651Skrisprint the full copyright notice. 77280304Sjkim.El 78280304Sjkim.Sh "EXIT STATUS" 79280304SjkimOne of the following exit values will be returned: 80280304Sjkim.Bl -tag 81109998Smarkm.It 0 " (EXIT_SUCCESS)" 82280304SjkimSuccessful program execution. 83109998Smarkm.It 1 " (EXIT_FAILURE)" 84109998SmarkmThe operation failed or the command syntax was not valid. 85280304Sjkim.It 70 " (EX_SOFTWARE)" 86280304Sjkimlibopts had an internal operational error. Please report 87280304Sjkimit to autogen\-users@lists.sourceforge.net. Thank you. 88280304Sjkim.El 89280304Sjkim.Sh "NOTES" 90280304SjkimThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 91280304Sjkimoption definitions. 92280304Sjkim