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