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