ntptrace.1ntptraceman revision 293896 
1.de1 NOP
2.  it 1 an-trap
3.  if \\n[.$] \,\\$*\/
4..
5.ie t \
6.ds B-Font [CB]
7.ds I-Font [CI]
8.ds R-Font [CR]
9.el \
10.ds B-Font B
11.ds I-Font I
12.ds R-Font R
13.TH ntptrace 1ntptraceman "07 Jan 2016" "ntp (4.2.8p5)" "User Commands"
14.\"
15.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-tqaWUj/ag-Gqa4Tj)
16.\"
17.\" It has been AutoGen-ed January 7, 2016 at 11:26:54 PM by AutoGen 5.18.5
18.\" From the definitions ntptrace-opts.def
19.\" and the template file agman-cmd.tpl
20.SH NAME
21\f\*[B-Font]ntptrace\fP
22\- Trace peers of an NTP server
23.SH SYNOPSIS
24\f\*[B-Font]ntptrace\fP
25.\" Mixture of short (flag) options and long options
26[\f\*[B-Font]\-flags\f[]]
27[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
28[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
29[host]
30.sp \n(Ppu
31.ne 2
32
33.SH DESCRIPTION
34\fBntptrace\fP is a perl script that uses the ntpq utility program to follow
35the chain of NTP servers from a given host back to the primary time source. For
36ntptrace to work properly, each of these servers must implement the NTP Control
37and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
38.sp
39If given no arguments, ntptrace starts with localhost. Here is an example of
40the output from ntptrace:
41.sp
42.br
43.in +4
44.nf
45% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
46server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
47stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
48.in -4
49.fi
50.sp
51On each line, the fields are (left to right): the host name, the host stratum,
52the time offset between that host and the local host (as measured by
53\fBntptrace\fP; this is why it is not always zero for "localhost"), the host
54synchronization distance, and (only for stratum\-1 servers) the reference clock
55ID. All times are given in seconds. Note that the stratum is the server hop
56count to the primary source, while the synchronization distance is the
57estimated error relative to the primary source. These terms are precisely
58defined in RFC\-1305.
59.SH "OPTIONS"
60.TP
61.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[]
62Print IP addresses instead of hostnames.
63.sp
64Output hosts as dotted-quad numeric format rather than converting to
65the canonical host names.
66.TP
67.NOP \f\*[B-Font]\-m\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-max\-hosts\f[]=\f\*[I-Font]number\f[]
68Maximum number of peers to trace.
69This option takes an integer number as its argument.
70The default
71\f\*[I-Font]number\f[]
72for this option is:
73.ti +4
74 99
75.sp
76This option has not been fully documented.
77.TP
78.NOP \f\*[B-Font]\-r\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-host\f[]=\f\*[I-Font]string\f[]
79Single remote host.
80The default
81\f\*[I-Font]string\f[]
82for this option is:
83.ti +4
84 127.0.0.1
85.sp
86This option has not been fully documented.
87.TP
88.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
89Display usage information and exit.
90.TP
91.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
92Pass the extended usage information through a pager.
93.TP
94.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
95Output version of program and exit.  The default mode is `v', a simple
96version.  The `c' mode will print copyright information and `n' will
97print the full copyright notice.
98.PP
99.SH "EXIT STATUS"
100One of the following exit values will be returned:
101.TP
102.NOP 0 " (EXIT_SUCCESS)"
103Successful program execution.
104.TP
105.NOP 1 " (EXIT_FAILURE)"
106The operation failed or the command syntax was not valid.
107.TP
108.NOP 70 " (EX_SOFTWARE)"
109libopts had an internal operational error.  Please report
110it to autogen-users@lists.sourceforge.net.  Thank you.
111.PP
112.SH "NOTES"
113This manual page was \fIAutoGen\fP-erated from the \fBntptrace\fP
114option definitions.
115