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