ntptrace.1ntptracemdoc revision 301301 
1314564Sdim.Dd June 2 2016
2285101Semaste.Dt NTPTRACE 1ntptracemdoc User Commands
3353358Sdim.Os
4353358Sdim.\"  EDIT THIS FILE WITH CAUTION  (ntptrace-opts.mdoc)
5353358Sdim.\"
6285101Semaste.\"  It has been AutoGen-ed  June  2, 2016 at 07:25:05 AM by AutoGen 5.18.5
7296417Sdim.\"  From the definitions    ntptrace-opts.def
8285101Semaste.\"  and the template file   agmdoc-cmd.tpl
9296417Sdim.Sh NAME
10296417Sdim.Nm ntptrace
11285101Semaste.Nd Trace peers of an NTP server
12314564Sdim.Sh SYNOPSIS
13327952Sdim.Nm
14321369Sdim.\" Mixture of short (flag) options and long options
15321369Sdim.Op Fl flags
16285101Semaste.Op Fl flag Op Ar value
17314564Sdim.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18285101Semaste[host]
19314564Sdim.Pp
20314564Sdim.Sh DESCRIPTION
21314564Sdim\fBntptrace\fP is a perl script that uses the ntpq utility program to follow
22314564Sdimthe chain of NTP servers from a given host back to the primary time source. For
23327952Sdimntptrace to work properly, each of these servers must implement the NTP Control
24285101Semasteand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
25314564Sdim.sp
26285101SemasteIf given no arguments, ntptrace starts with localhost. Here is an example of
27314564Sdimthe output from ntptrace:
28314564Sdim.sp
29285101Semaste.Bd -literal -offset indent
30314564Sdim% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
31314564Sdimserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
32285101Semastestratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
33314564Sdim.Ed
34285101Semaste.sp
35314564SdimOn each line, the fields are (left to right): the host name, the host stratum,
36285101Semastethe time offset between that host and the local host (as measured by
37314564Sdim\fBntptrace\fP; this is why it is not always zero for "localhost"), the host
38285101Semastesynchronization distance, and (only for stratum\-1 servers) the reference clock
39285101SemasteID. All times are given in seconds. Note that the stratum is the server hop
40314564Sdimcount to the primary source, while the synchronization distance is the
41285101Semasteestimated error relative to the primary source. These terms are precisely
42314564Sdimdefined in RFC\-1305.
43285101Semaste.Sh "OPTIONS"
44314564Sdim.Bl -tag
45285101Semaste.It  Fl n , Fl \-numeric 
46314564SdimPrint IP addresses instead of hostnames.
47285101Semaste.sp
48285101SemasteOutput hosts as dotted\-quad numeric format rather than converting to
49314564Sdimthe canonical host names.
50314564Sdim.It  Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 
51285101SemasteMaximum number of peers to trace.
52285101SemasteThis option takes an integer number as its argument.
53296417SdimThe default
54.Ar number
55for this option is:
56.ti +4
57 99
58.sp
59This option has not been fully documented.
60.It  Fl r Ar string , Fl \-host Ns = Ns Ar string 
61Single remote host.
62The default
63.Ar string
64for this option is:
65.ti +4
66 127.0.0.1
67.sp
68This option has not been fully documented.
69.It Fl \&? , Fl \-help
70Display usage information and exit.
71.It Fl \&! , Fl \-more\-help
72Pass the extended usage information through a pager.
73.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
74Output version of program and exit.  The default mode is `v', a simple
75version.  The `c' mode will print copyright information and `n' will
76print the full copyright notice.
77.El
78.Sh "EXIT STATUS"
79One of the following exit values will be returned:
80.Bl -tag
81.It 0 " (EXIT_SUCCESS)"
82Successful program execution.
83.It 1 " (EXIT_FAILURE)"
84The operation failed or the command syntax was not valid.
85.It 70 " (EX_SOFTWARE)"
86libopts had an internal operational error.  Please report
87it to autogen\-users@lists.sourceforge.net.  Thank you.
88.El
89.Sh "NOTES"
90This manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP
91option definitions.
92