xref: /freebsd/contrib/ntp/scripts/ntptrace/ntptrace.1ntptracemdoc (revision 2b15cb3d0922bd70ea592f0da9b4a5b167f4d53f)
1*2b15cb3dSCy Schubert.Dd February 4 2015
2*2b15cb3dSCy Schubert.Dt NTPTRACE 1ntptracemdoc User Commands
3*2b15cb3dSCy Schubert.Os
4*2b15cb3dSCy Schubert.\"  EDIT THIS FILE WITH CAUTION  (ntptrace-opts.mdoc)
5*2b15cb3dSCy Schubert.\"
6*2b15cb3dSCy Schubert.\"  It has been AutoGen-ed  February  4, 2015 at 02:37:48 AM by AutoGen 5.18.5pre4
7*2b15cb3dSCy Schubert.\"  From the definitions    ntptrace-opts.def
8*2b15cb3dSCy Schubert.\"  and the template file   agmdoc-cmd.tpl
9*2b15cb3dSCy Schubert.Sh NAME
10*2b15cb3dSCy Schubert.Nm ntptrace
11*2b15cb3dSCy Schubert.Nd Trace peers of an NTP server
12*2b15cb3dSCy Schubert.Sh SYNOPSIS
13*2b15cb3dSCy Schubert.Nm
14*2b15cb3dSCy Schubert.\" Mixture of short (flag) options and long options
15*2b15cb3dSCy Schubert.Op Fl flags
16*2b15cb3dSCy Schubert.Op Fl flag Op Ar value
17*2b15cb3dSCy Schubert.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18*2b15cb3dSCy Schubert[host]
19*2b15cb3dSCy Schubert.Pp
20*2b15cb3dSCy Schubert.Sh DESCRIPTION
21*2b15cb3dSCy Schubert\fBntptrace\fP is a perl script that uses the ntpq utility program to follow
22*2b15cb3dSCy Schubertthe chain of NTP servers from a given host back to the primary time source. For
23*2b15cb3dSCy Schubertntptrace to work properly, each of these servers must implement the NTP Control
24*2b15cb3dSCy Schubertand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
25*2b15cb3dSCy Schubert.sp
26*2b15cb3dSCy SchubertIf given no arguments, ntptrace starts with localhost. Here is an example of
27*2b15cb3dSCy Schubertthe output from ntptrace:
28*2b15cb3dSCy Schubert.sp
29*2b15cb3dSCy Schubert.Bd -literal -offset indent
30*2b15cb3dSCy Schubert% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
31*2b15cb3dSCy Schubertserver2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
32*2b15cb3dSCy Schubertstratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
33*2b15cb3dSCy Schubert.Ed
34*2b15cb3dSCy Schubert.sp
35*2b15cb3dSCy SchubertOn each line, the fields are (left to right): the host name, the host stratum,
36*2b15cb3dSCy Schubertthe time offset between that host and the local host (as measured by
37*2b15cb3dSCy Schubert\fBntptrace\fP; this is why it is not always zero for "localhost"), the host
38*2b15cb3dSCy Schubertsynchronization distance, and (only for stratum\-1 servers) the reference clock
39*2b15cb3dSCy SchubertID. All times are given in seconds. Note that the stratum is the server hop
40*2b15cb3dSCy Schubertcount to the primary source, while the synchronization distance is the
41*2b15cb3dSCy Schubertestimated error relative to the primary source. These terms are precisely
42*2b15cb3dSCy Schubertdefined in RFC\-1305.
43*2b15cb3dSCy Schubert.Sh "OPTIONS"
44*2b15cb3dSCy Schubert.Bl -tag
45*2b15cb3dSCy Schubert.It  Fl n , Fl \-numeric
46*2b15cb3dSCy SchubertPrint IP addresses instead of hostnames.
47*2b15cb3dSCy Schubert.sp
48*2b15cb3dSCy SchubertOutput hosts as dotted\-quad numeric format rather than converting to
49*2b15cb3dSCy Schubertthe canonical host names.
50*2b15cb3dSCy Schubert.It  Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number
51*2b15cb3dSCy SchubertMaximum number of peers to trace.
52*2b15cb3dSCy SchubertThis option takes an integer number as its argument.
53*2b15cb3dSCy SchubertThe default
54*2b15cb3dSCy Schubert.Ar number
55*2b15cb3dSCy Schubertfor this option is:
56*2b15cb3dSCy Schubert.ti +4
57*2b15cb3dSCy Schubert 99
58*2b15cb3dSCy Schubert.sp
59*2b15cb3dSCy SchubertThis option has not been fully documented.
60*2b15cb3dSCy Schubert.It  Fl r Ar string , Fl \-host Ns = Ns Ar string
61*2b15cb3dSCy SchubertSingle remote host.
62*2b15cb3dSCy SchubertThe default
63*2b15cb3dSCy Schubert.Ar string
64*2b15cb3dSCy Schubertfor this option is:
65*2b15cb3dSCy Schubert.ti +4
66*2b15cb3dSCy Schubert 127.0.0.1
67*2b15cb3dSCy Schubert.sp
68*2b15cb3dSCy SchubertThis option has not been fully documented.
69*2b15cb3dSCy Schubert.It Fl \&? , Fl \-help
70*2b15cb3dSCy SchubertDisplay usage information and exit.
71*2b15cb3dSCy Schubert.It Fl \&! , Fl \-more\-help
72*2b15cb3dSCy SchubertPass the extended usage information through a pager.
73*2b15cb3dSCy Schubert.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
74*2b15cb3dSCy SchubertOutput version of program and exit.  The default mode is `v', a simple
75*2b15cb3dSCy Schubertversion.  The `c' mode will print copyright information and `n' will
76*2b15cb3dSCy Schubertprint the full copyright notice.
77*2b15cb3dSCy Schubert.El
78*2b15cb3dSCy Schubert.Sh "EXIT STATUS"
79*2b15cb3dSCy SchubertOne of the following exit values will be returned:
80*2b15cb3dSCy Schubert.Bl -tag
81*2b15cb3dSCy Schubert.It 0 " (EXIT_SUCCESS)"
82*2b15cb3dSCy SchubertSuccessful program execution.
83*2b15cb3dSCy Schubert.It 1 " (EXIT_FAILURE)"
84*2b15cb3dSCy SchubertThe operation failed or the command syntax was not valid.
85*2b15cb3dSCy Schubert.It 70 " (EX_SOFTWARE)"
86*2b15cb3dSCy Schubertlibopts had an internal operational error.  Please report
87*2b15cb3dSCy Schubertit to autogen\-users@lists.sourceforge.net.  Thank you.
88*2b15cb3dSCy Schubert.El
89*2b15cb3dSCy Schubert.Sh "NOTES"
90*2b15cb3dSCy SchubertThis manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP
91*2b15cb3dSCy Schubertoption definitions.
92