ntptrace.html revision 1.1.1.10.10.1
1 1.1 christos <html lang="en"> 2 1.1 christos <head> 3 1.1 christos <title>Ntptrace User's Manual</title> 4 1.1 christos <meta http-equiv="Content-Type" content="text/html"> 5 1.1 christos <meta name="description" content="Ntptrace User's Manual"> 6 1.1.1.7 christos <meta name="generator" content="makeinfo 4.7"> 7 1.1 christos <link title="Top" rel="top" href="#Top"> 8 1.1 christos <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9 1.1 christos <meta http-equiv="Content-Style-Type" content="text/css"> 10 1.1 christos <style type="text/css"><!-- 11 1.1 christos pre.display { font-family:inherit } 12 1.1 christos pre.format { font-family:inherit } 13 1.1 christos pre.smalldisplay { font-family:inherit; font-size:smaller } 14 1.1 christos pre.smallformat { font-family:inherit; font-size:smaller } 15 1.1 christos pre.smallexample { font-size:smaller } 16 1.1 christos pre.smalllisp { font-size:smaller } 17 1.1.1.7 christos span.sc { font-variant:small-caps } 18 1.1.1.7 christos span.roman { font-family: serif; font-weight: normal; } 19 1.1 christos --></style> 20 1.1 christos </head> 21 1.1 christos <body> 22 1.1 christos <h1 class="settitle">Ntptrace User's Manual</h1> 23 1.1 christos <div class="node"> 24 1.1 christos <p><hr> 25 1.1.1.7 christos <a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-Description">ntptrace Description</a>, 26 1.1 christos Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27 1.1 christos Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28 1.1.1.7 christos <br> 29 1.1 christos </div> 30 1.1 christos 31 1.1 christos <h2 class="unnumbered">Simple Network Time Protocol User Manual</h2> 32 1.1 christos 33 1.1 christos <p>This document describes the use of the NTP Project's <code>ntptrace</code> program. 34 1.1.1.10.10.1 pgoyette This document applies to version 4.2.8p11 of <code>ntptrace</code>. 35 1.1 christos 36 1.1 christos <div class="shortcontents"> 37 1.1 christos <h2>Short Contents</h2> 38 1.1 christos <ul> 39 1.1 christos <a href="#Top">Simple Network Time Protocol User Manual</a> 40 1.1 christos </ul> 41 1.1 christos </div> 42 1.1 christos 43 1.1 christos <ul class="menu"> 44 1.1 christos <li><a accesskey="1" href="#ntptrace-Description">ntptrace Description</a>: Description 45 1.1 christos <li><a accesskey="2" href="#ntptrace-Invocation">ntptrace Invocation</a>: Invoking ntptrace 46 1.1 christos </ul> 47 1.1 christos 48 1.1 christos <div class="node"> 49 1.1 christos <p><hr> 50 1.1.1.7 christos <a name="ntptrace-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#ntptrace-Description">ntptrace Description</a>, 51 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a> 52 1.1.1.7 christos <br> 53 1.1 christos </div> 54 1.1 christos 55 1.1 christos <h3 class="section">Invoking ntptrace</h3> 56 1.1 christos 57 1.1 christos <p><a name="index-ntptrace-1"></a><a name="index-Trace-peers-of-an-NTP-server-2"></a> 58 1.1 christos <code>ntptrace</code> is a perl script that uses the ntpq utility program to follow 59 1.1 christos the chain of NTP servers from a given host back to the primary time source. For 60 1.1 christos ntptrace to work properly, each of these servers must implement the NTP Control 61 1.1 christos and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 62 1.1 christos 63 1.1 christos <p>If given no arguments, ntptrace starts with localhost. Here is an example of 64 1.1 christos the output from ntptrace: 65 1.1 christos 66 1.1 christos <pre class="example"> % ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 67 1.1 christos server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 68 1.1 christos stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 69 1.1 christos </pre> 70 1.1 christos <p>On each line, the fields are (left to right): the host name, the host stratum, 71 1.1 christos the time offset between that host and the local host (as measured by 72 1.1 christos <code>ntptrace</code>; this is why it is not always zero for "localhost"), the host 73 1.1 christos synchronization distance, and (only for stratum-1 servers) the reference clock 74 1.1 christos ID. All times are given in seconds. Note that the stratum is the server hop 75 1.1 christos count to the primary source, while the synchronization distance is the 76 1.1 christos estimated error relative to the primary source. These terms are precisely 77 1.1 christos defined in RFC-1305. 78 1.1 christos 79 1.1 christos <p>This section was generated by <strong>AutoGen</strong>, 80 1.1 christos using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntptrace</code> program. 81 1.1 christos 82 1.1 christos <ul class="menu"> 83 1.1.1.7 christos <li><a accesskey="1" href="#ntptrace-usage">ntptrace usage</a>: ntptrace help/usage (<span class="option">--help</span>) 84 1.1 christos <li><a accesskey="2" href="#ntptrace-numeric">ntptrace numeric</a>: numeric option (-n) 85 1.1 christos <li><a accesskey="3" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>: max-hosts option (-m) 86 1.1 christos <li><a accesskey="4" href="#ntptrace-host">ntptrace host</a>: host option (-r) 87 1.1 christos <li><a accesskey="5" href="#ntptrace-exit-status">ntptrace exit status</a>: exit status 88 1.1 christos </ul> 89 1.1 christos 90 1.1 christos <div class="node"> 91 1.1 christos <p><hr> 92 1.1.1.7 christos <a name="ntptrace-usage"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-numeric">ntptrace numeric</a>, 93 1.1 christos Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 94 1.1.1.7 christos <br> 95 1.1 christos </div> 96 1.1 christos 97 1.1.1.7 christos <h4 class="subsection">ntptrace help/usage (<span class="option">--help</span>)</h4> 98 1.1 christos 99 1.1 christos <p><a name="index-ntptrace-help-3"></a> 100 1.1 christos This is the automatically generated usage text for ntptrace. 101 1.1 christos 102 1.1 christos <p>The text printed is the same whether selected with the <code>help</code> option 103 1.1.1.7 christos (<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 104 1.1 christos the usage text by passing it through a pager program. 105 1.1 christos <code>more-help</code> is disabled on platforms without a working 106 1.1 christos <code>fork(2)</code> function. The <code>PAGER</code> environment variable is 107 1.1.1.7 christos used to select the program, defaulting to <span class="file">more</span>. Both will exit 108 1.1 christos with a status code of 0. 109 1.1 christos 110 1.1.1.10.10.1 pgoyette <pre class="example">ntptrace - Trace peers of an NTP server - Ver. 4.2.8p11 111 1.1 christos USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [host] 112 1.1 christos 113 1.1 christos -n, --numeric Print IP addresses instead of hostnames 114 1.1 christos -m, --max-hosts=num Maximum number of peers to trace 115 1.1 christos -r, --host=str Single remote host 116 1.1 christos -?, --help Display usage information and exit 117 1.1.1.2 christos --more-help Pass the extended usage text through a pager 118 1.1 christos 119 1.1 christos Options are specified by doubled hyphens and their name or by a single 120 1.1 christos hyphen and the flag character. 121 1.1 christos </pre> 122 1.1 christos <div class="node"> 123 1.1 christos <p><hr> 124 1.1.1.7 christos <a name="ntptrace-numeric"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>, 125 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntptrace-usage">ntptrace usage</a>, 126 1.1 christos Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 127 1.1.1.7 christos <br> 128 1.1 christos </div> 129 1.1 christos 130 1.1 christos <h4 class="subsection">numeric option (-n)</h4> 131 1.1 christos 132 1.1 christos <p><a name="index-ntptrace_002dnumeric-4"></a> 133 1.1 christos This is the “print ip addresses instead of hostnames” option. 134 1.1 christos Output hosts as dotted-quad numeric format rather than converting to 135 1.1 christos the canonical host names. 136 1.1 christos <div class="node"> 137 1.1 christos <p><hr> 138 1.1.1.7 christos <a name="ntptrace-max_002dhosts"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-host">ntptrace host</a>, 139 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntptrace-numeric">ntptrace numeric</a>, 140 1.1 christos Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 141 1.1.1.7 christos <br> 142 1.1 christos </div> 143 1.1 christos 144 1.1 christos <h4 class="subsection">max-hosts option (-m)</h4> 145 1.1 christos 146 1.1 christos <p><a name="index-ntptrace_002dmax_002dhosts-5"></a> 147 1.1 christos This is the “maximum number of peers to trace” option. 148 1.1 christos This option takes a number argument. 149 1.1.1.7 christos This option has no <span class="samp">doc</span> documentation. 150 1.1 christos <div class="node"> 151 1.1 christos <p><hr> 152 1.1.1.7 christos <a name="ntptrace-host"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-exit-status">ntptrace exit status</a>, 153 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>, 154 1.1 christos Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 155 1.1.1.7 christos <br> 156 1.1 christos </div> 157 1.1 christos 158 1.1 christos <h4 class="subsection">host option (-r)</h4> 159 1.1 christos 160 1.1 christos <p><a name="index-ntptrace_002dhost-6"></a> 161 1.1 christos This is the “single remote host” option. 162 1.1 christos This option takes a string argument. 163 1.1.1.7 christos This option has no <span class="samp">doc</span> documentation. 164 1.1 christos <div class="node"> 165 1.1 christos <p><hr> 166 1.1.1.7 christos <a name="ntptrace-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntptrace-host">ntptrace host</a>, 167 1.1 christos Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 168 1.1.1.7 christos <br> 169 1.1 christos </div> 170 1.1 christos 171 1.1 christos <h4 class="subsection">ntptrace exit status</h4> 172 1.1 christos 173 1.1 christos <p>One of the following exit values will be returned: 174 1.1 christos <dl> 175 1.1.1.7 christos <dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 176 1.1.1.7 christos <br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 177 1.1 christos </dl> 178 1.1 christos 179 1.1 christos </body></html> 180 1.1 christos 181
Indexes created Sun Aug 23 00:25:02 UTC 2026