ntptrace.html revision 310419
1276695Sbrueffer<html lang="en"> 2276695Sbrueffer<head> 3276695Sbrueffer<title>Ntptrace User's Manual</title> 4276695Sbrueffer<meta http-equiv="Content-Type" content="text/html"> 5276695Sbrueffer<meta name="description" content="Ntptrace User's Manual"> 6276695Sbrueffer<meta name="generator" content="makeinfo 4.7"> 7276695Sbrueffer<link title="Top" rel="top" href="#Top"> 8276695Sbrueffer<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9276695Sbrueffer<meta http-equiv="Content-Style-Type" content="text/css"> 10276695Sbrueffer<style type="text/css"><!-- 11276695Sbrueffer pre.display { font-family:inherit } 12276695Sbrueffer pre.format { font-family:inherit } 13276695Sbrueffer pre.smalldisplay { font-family:inherit; font-size:smaller } 14276695Sbrueffer pre.smallformat { font-family:inherit; font-size:smaller } 15276695Sbrueffer pre.smallexample { font-size:smaller } 16276695Sbrueffer pre.smalllisp { font-size:smaller } 17276695Sbrueffer span.sc { font-variant:small-caps } 18276695Sbrueffer span.roman { font-family: serif; font-weight: normal; } 19276695Sbrueffer--></style> 20276695Sbrueffer</head> 21276695Sbrueffer<body> 22276695Sbrueffer<h1 class="settitle">Ntptrace User's Manual</h1> 23276695Sbrueffer<div class="node"> 24276695Sbrueffer<p><hr> 25276695Sbrueffer<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-Description">ntptrace Description</a>, 26276695SbruefferPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27276695SbruefferUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28276695Sbrueffer<br> 29276695Sbrueffer</div> 30276695Sbrueffer 31276695Sbrueffer<h2 class="unnumbered">Simple Network Time Protocol User Manual</h2> 32276695Sbrueffer 33276695Sbrueffer<p>This document describes the use of the NTP Project's <code>ntptrace</code> program. 34276695SbruefferThis document applies to version 4.2.8p9 of <code>ntptrace</code>. 35276695Sbrueffer 36276695Sbrueffer <div class="shortcontents"> 37276695Sbrueffer<h2>Short Contents</h2> 38276695Sbrueffer<ul> 39276695Sbrueffer<a href="#Top">Simple Network Time Protocol User Manual</a> 40276695Sbrueffer</ul> 41276695Sbrueffer</div> 42276695Sbrueffer 43276695Sbrueffer<ul class="menu"> 44276695Sbrueffer<li><a accesskey="1" href="#ntptrace-Description">ntptrace Description</a>: Description 45276695Sbrueffer<li><a accesskey="2" href="#ntptrace-Invocation">ntptrace Invocation</a>: Invoking ntptrace 46276695Sbrueffer</ul> 47276695Sbrueffer 48276695Sbrueffer<div class="node"> 49276695Sbrueffer<p><hr> 50276695Sbrueffer<a name="ntptrace-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#ntptrace-Description">ntptrace Description</a>, 51276695SbruefferUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52276695Sbrueffer<br> 53276695Sbrueffer</div> 54276695Sbrueffer 55276695Sbrueffer<h3 class="section">Invoking ntptrace</h3> 56276695Sbrueffer 57276695Sbrueffer<p><a name="index-ntptrace-1"></a><a name="index-Trace-peers-of-an-NTP-server-2"></a> 58276695Sbrueffer<code>ntptrace</code> is a perl script that uses the ntpq utility program to follow 59276695Sbruefferthe chain of NTP servers from a given host back to the primary time source. For 60276695Sbruefferntptrace to work properly, each of these servers must implement the NTP Control 61276695Sbruefferand Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. 62276695Sbrueffer 63276695Sbrueffer <p>If given no arguments, ntptrace starts with localhost. Here is an example of 64276695Sbruefferthe output from ntptrace: 65276695Sbrueffer 66<pre class="example"> % ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 67 server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: 68 stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' 69</pre> 70 <p>On each line, the fields are (left to right): the host name, the host stratum, 71the time offset between that host and the local host (as measured by 72<code>ntptrace</code>; this is why it is not always zero for "localhost"), the host 73synchronization distance, and (only for stratum-1 servers) the reference clock 74ID. All times are given in seconds. Note that the stratum is the server hop 75count to the primary source, while the synchronization distance is the 76estimated error relative to the primary source. These terms are precisely 77defined in RFC-1305. 78 79 <p>This section was generated by <strong>AutoGen</strong>, 80using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntptrace</code> program. 81 82<ul class="menu"> 83<li><a accesskey="1" href="#ntptrace-usage">ntptrace usage</a>: ntptrace help/usage (<span class="option">--help</span>) 84<li><a accesskey="2" href="#ntptrace-numeric">ntptrace numeric</a>: numeric option (-n) 85<li><a accesskey="3" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>: max-hosts option (-m) 86<li><a accesskey="4" href="#ntptrace-host">ntptrace host</a>: host option (-r) 87<li><a accesskey="5" href="#ntptrace-exit-status">ntptrace exit status</a>: exit status 88</ul> 89 90<div class="node"> 91<p><hr> 92<a name="ntptrace-usage"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-numeric">ntptrace numeric</a>, 93Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 94<br> 95</div> 96 97<h4 class="subsection">ntptrace help/usage (<span class="option">--help</span>)</h4> 98 99<p><a name="index-ntptrace-help-3"></a> 100This is the automatically generated usage text for ntptrace. 101 102 <p>The text printed is the same whether selected with the <code>help</code> option 103(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 104the usage text by passing it through a pager program. 105<code>more-help</code> is disabled on platforms without a working 106<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 107used to select the program, defaulting to <span class="file">more</span>. Both will exit 108with a status code of 0. 109 110<pre class="example">ntptrace - Trace peers of an NTP server - Ver. 4.2.8p9 111USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [host] 112 113 -n, --numeric Print IP addresses instead of hostnames 114 -m, --max-hosts=num Maximum number of peers to trace 115 -r, --host=str Single remote host 116 -?, --help Display usage information and exit 117 --more-help Pass the extended usage text through a pager 118 119Options are specified by doubled hyphens and their name or by a single 120hyphen and the flag character. 121</pre> 122 <div class="node"> 123<p><hr> 124<a name="ntptrace-numeric"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>, 125Previous: <a rel="previous" accesskey="p" href="#ntptrace-usage">ntptrace usage</a>, 126Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 127<br> 128</div> 129 130<h4 class="subsection">numeric option (-n)</h4> 131 132<p><a name="index-ntptrace_002dnumeric-4"></a> 133This is the “print ip addresses instead of hostnames” option. 134Output hosts as dotted-quad numeric format rather than converting to 135the canonical host names. 136<div class="node"> 137<p><hr> 138<a name="ntptrace-max_002dhosts"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-host">ntptrace host</a>, 139Previous: <a rel="previous" accesskey="p" href="#ntptrace-numeric">ntptrace numeric</a>, 140Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 141<br> 142</div> 143 144<h4 class="subsection">max-hosts option (-m)</h4> 145 146<p><a name="index-ntptrace_002dmax_002dhosts-5"></a> 147This is the “maximum number of peers to trace” option. 148This option takes a number argument. 149This option has no <span class="samp">doc</span> documentation. 150<div class="node"> 151<p><hr> 152<a name="ntptrace-host"></a>Next: <a rel="next" accesskey="n" href="#ntptrace-exit-status">ntptrace exit status</a>, 153Previous: <a rel="previous" accesskey="p" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>, 154Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 155<br> 156</div> 157 158<h4 class="subsection">host option (-r)</h4> 159 160<p><a name="index-ntptrace_002dhost-6"></a> 161This is the “single remote host” option. 162This option takes a string argument. 163This option has no <span class="samp">doc</span> documentation. 164<div class="node"> 165<p><hr> 166<a name="ntptrace-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntptrace-host">ntptrace host</a>, 167Up: <a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a> 168<br> 169</div> 170 171<h4 class="subsection">ntptrace exit status</h4> 172 173<p>One of the following exit values will be returned: 174 <dl> 175<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 176<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 177</dl> 178 179</body></html> 180 181