ntptrace.8 revision 290000
16059Samurai.Dd February 4 2015 26059Samurai.Dt NTPTRACE 8 User Commands 36059Samurai.Os 46059Samurai.\" EDIT THIS FILE WITH CAUTION (ntptrace-opts.mdoc) 56059Samurai.\" 66059Samurai.\" $FreeBSD: releng/10.1/usr.sbin/ntp/doc/ntptrace.8 290000 2015-10-26 11:37:31Z glebius $ 76059Samurai.\" 86059Samurai.\" It has been AutoGen-ed February 4, 2015 at 02:37:48 AM by AutoGen 5.18.5pre4 96059Samurai.\" From the definitions ntptrace-opts.def 106059Samurai.\" and the template file agmdoc-cmd.tpl 116059Samurai.Sh NAME 126059Samurai.Nm ntptrace 136059Samurai.Nd Trace peers of an NTP server 146059Samurai.Sh SYNOPSIS 156059Samurai.Nm 166059Samurai.\" Mixture of short (flag) options and long options 176059Samurai.Op Fl flags 186059Samurai.Op Fl flag Op Ar value 196059Samurai.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 2050479Speter[host] 218857Srgrimes.Pp 226059Samurai.Sh DESCRIPTION 236059Samurai\fBntptrace\fP is a perl script that uses the ntpq utility program to follow 246059Samuraithe chain of NTP servers from a given host back to the primary time source. For 2528679Sbrianntptrace to work properly, each of these servers must implement the NTP Control 2643313Sbrianand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 276059Samurai.sp 286059SamuraiIf given no arguments, ntptrace starts with localhost. Here is an example of 296059Samuraithe output from ntptrace: 306059Samurai.sp 3136285Sbrian.Bd -literal -offset indent 3230715Sbrian% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 3330715Sbrianserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 3430715Sbrianstratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 3536285Sbrian.Ed 3630715Sbrian.sp 3746686SbrianOn each line, the fields are (left to right): the host name, the host stratum, 3837009Sbrianthe time offset between that host and the local host (as measured by 3931343Sbrian\fBntptrace\fP; this is why it is not always zero for "localhost"), the host 4030715Sbriansynchronization distance, and (only for stratum\-1 servers) the reference clock 4130715SbrianID. All times are given in seconds. Note that the stratum is the server hop 426059Samuraicount to the primary source, while the synchronization distance is the 4336285Sbrianestimated error relative to the primary source. These terms are precisely 4436285Sbriandefined in RFC\-1305. 4536285Sbrian.Sh "OPTIONS" 4636285Sbrian.Bl -tag 4736285Sbrian.It Fl n , Fl \-numeric 4836285SbrianPrint IP addresses instead of hostnames. 4938557Sbrian.sp 5038557SbrianOutput hosts as dotted\-quad numeric format rather than converting to 5136285Sbrianthe canonical host names. 5236285Sbrian.It Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 5336285SbrianMaximum number of peers to trace. 5436285SbrianThis option takes an integer number as its argument. 5536285SbrianThe default 5636285Sbrian.Ar number 5743313Sbrianfor this option is: 5843313Sbrian.ti +4 5943313Sbrian 99 6036285Sbrian.sp 616059SamuraiThis option has not been fully documented. 626059Samurai.It Fl r Ar string , Fl \-host Ns = Ns Ar string 6346828SbrianSingle remote host. 646059SamuraiThe default 6528679Sbrian.Ar string 6628679Sbrianfor this option is: 676059Samurai.ti +4 6831962Sbrian 127.0.0.1 6930187Sbrian.sp 7028679SbrianThis option has not been fully documented. 7128679Sbrian.It Fl \&? , Fl \-help 7228679SbrianDisplay usage information and exit. 7330187Sbrian.It Fl \&! , Fl \-more\-help 7428679SbrianPass the extended usage information through a pager. 7528679Sbrian.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 7628679SbrianOutput version of program and exit. The default mode is `v', a simple 7728679Sbrianversion. The `c' mode will print copyright information and `n' will 7828679Sbrianprint the full copyright notice. 796059Samurai.El 806059Samurai.Sh "EXIT STATUS" 816059SamuraiOne of the following exit values will be returned: 826059Samurai.Bl -tag 8337189Sbrian.It 0 " (EXIT_SUCCESS)" 846059SamuraiSuccessful program execution. 856059Samurai.It 1 " (EXIT_FAILURE)" 866059SamuraiThe operation failed or the command syntax was not valid. 876059Samurai.It 70 " (EX_SOFTWARE)" 886059Samurailibopts had an internal operational error. Please report 896059Samuraiit to autogen\-users@lists.sourceforge.net. Thank you. 906059Samurai.El 916059Samurai.Sh "NOTES" 926059SamuraiThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP 936059Samuraioption definitions. 946059Samurai