path: root/contrib/ntp/scripts/ntptrace/ntptrace.html
blob: 54215f7b95277454e0604ae854578b88c6e76c52 (plain) (tree)



<html lang="en">
<title>Ntptrace User's Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Ntptrace User's Manual">
<meta name="generator" content="makeinfo 4.7">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc { font-variant:small-caps }
  span.roman { font-family: serif; font-weight: normal; } 
<h1 class="settitle">Ntptrace User's Manual</h1>
<div class="node">
<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntptrace-Description">ntptrace Description</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>

<h2 class="unnumbered">Simple Network Time Protocol User Manual</h2>

<p>This document describes the use of the NTP Project's <code>ntptrace</code> program. 
This document applies to version 4.2.8p9 of <code>ntptrace</code>.

  <div class="shortcontents">
<h2>Short Contents</h2>
<a href="#Top">Simple Network Time Protocol User Manual</a>

<ul class="menu">
<li><a accesskey="1" href="#ntptrace-Description">ntptrace Description</a>:             Description
<li><a accesskey="2" href="#ntptrace-Invocation">ntptrace Invocation</a>: 		    Invoking ntptrace

<div class="node">
<a name="ntptrace-Invocation"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntptrace-Description">ntptrace Description</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>

<h3 class="section">Invoking ntptrace</h3>

<p><a name="index-ntptrace-1"></a><a name="index-Trace-peers-of-an-NTP-server-2"></a>
<code>ntptrace</code> is a perl script that uses the ntpq utility program to follow
the chain of NTP servers from a given host back to the primary time source. For
ntptrace to work properly, each of these servers must implement the NTP Control
and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.

  <p>If given no arguments, ntptrace starts with localhost. Here is an example of
the output from ntptrace:

<pre class="example">     % ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
     server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
     stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
  <p>On each line, the fields are (left to right): the host name, the host stratum,
the time offset between that host and the local host (as measured by
<code>ntptrace</code>; this is why it is not always zero for "localhost"), the host
synchronization distance, and (only for stratum-1 servers) the reference clock
ID. All times are given in seconds. Note that the stratum is the server hop
count to the primary source, while the synchronization distance is the
estimated error relative to the primary source. These terms are precisely
defined in RFC-1305.

  <p>This section was generated by <strong>AutoGen</strong>,
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntptrace</code> program.

<ul class="menu">
<li><a accesskey="1" href="#ntptrace-usage">ntptrace usage</a>:                   ntptrace help/usage (<span class="option">--help</span>)
<li><a accesskey="2" href="#ntptrace-numeric">ntptrace numeric</a>:                 numeric option (-n)
<li><a accesskey="3" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>:               max-hosts option (-m)
<li><a accesskey="4" href="#ntptrace-host">ntptrace host</a>:                    host option (-r)
<li><a accesskey="5" href="#ntptrace-exit-status">ntptrace exit status</a>:             exit status

<div class="node">
<a name="ntptrace-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntptrace-numeric">ntptrace numeric</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>

<h4 class="subsection">ntptrace help/usage (<span class="option">--help</span>)</h4>

<p><a name="index-ntptrace-help-3"></a>
This is the automatically generated usage text for ntptrace.

  <p>The text printed is the same whether selected with the <code>help</code> option
(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
the usage text by passing it through a pager program. 
<code>more-help</code> is disabled on platforms without a working
<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
used to select the program, defaulting to <span class="file">more</span>.  Both will exit
with a status code of 0.

<pre class="example">ntptrace - Trace peers of an NTP server - Ver. 4.2.8p9
USAGE: ntptrace [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]... [host]

    -n, --numeric                Print IP addresses instead of hostnames
    -m, --max-hosts=num          Maximum number of peers to trace
    -r, --host=str               Single remote host
    -?, --help                   Display usage information and exit
        --more-help              Pass the extended usage text through a pager

Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
  <div class="node">
<a name="ntptrace-numeric"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntptrace-usage">ntptrace usage</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>

<h4 class="subsection">numeric option (-n)</h4>

<p><a name="index-ntptrace_002dnumeric-4"></a>
This is the &ldquo;print ip addresses instead of hostnames&rdquo; option. 
Output hosts as dotted-quad numeric format rather than converting to
the canonical host names. 
<div class="node">
<a name="ntptrace-max_002dhosts"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntptrace-host">ntptrace host</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntptrace-numeric">ntptrace numeric</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>

<h4 class="subsection">max-hosts option (-m)</h4>

<p><a name="index-ntptrace_002dmax_002dhosts-5"></a>
This is the &ldquo;maximum number of peers to trace&rdquo; option. 
This option takes a number argument. 
This option has no <span class="samp">doc</span> documentation. 
<div class="node">
<a name="ntptrace-host"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntptrace-exit-status">ntptrace exit status</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntptrace-max_002dhosts">ntptrace max-hosts</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>

<h4 class="subsection">host option (-r)</h4>

<p><a name="index-ntptrace_002dhost-6"></a>
This is the &ldquo;single remote host&rdquo; option. 
This option takes a string argument. 
This option has no <span class="samp">doc</span> documentation. 
<div class="node">
<a name="ntptrace-exit-status"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntptrace-host">ntptrace host</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntptrace-Invocation">ntptrace Invocation</a>

<h4 class="subsection">ntptrace exit status</h4>

<p>One of the following exit values will be returned:
<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 
<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid.