xref: /freebsd/contrib/ntp/html/drivers/driver1.html (revision 416ba5c74546f32a993436a99516d35008e9f384)
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
5<meta name="generator" content="HTML Tidy, see www.w3.org">
6<title>Undisciplined Local Clock</title>
7<link href="scripts/style.css" type="text/css" rel="stylesheet">
8</head>
9<body>
10<h3>Undisciplined Local Clock</h3>
11<p>Author: David L. Mills (mills@udel.edu)<br>
12Last update:
13  <!-- #BeginDate format:En2m -->9-May-2014  08:34<!-- #EndDate -->
14  UTC</p>
15<hr>
16<h4>Synopsis</h4>
17<p>Address: 127.127.1.<i>u</i><br>
18  Reference ID: <tt>LOCL</tt><br>
19  Driver ID: <tt>LOCAL</tt></p>
20<h4>Description</h4>
21<p>Note: <strong>We recommend against using this driver.</strong> A much more flexible replacement is described on the <a href="../orphan.html">Orphan Mode</a> page.</p>
22<p>This driver was intended for use in an isolated network where no external source of synchronization such as a radio clock or modem is available. It allows a designated time server to act as a primary server to provide synchronization to other clients on the network. Pick a machine that has a good clock oscillator and configure it with this driver. Set the clock using the best means available, like eyeball-and-wristwatch. Then, point all the other machines at this one or use broadcast mode to distribute time.</p>
23<p>Another application for this driver is if a particular server clock is to be used as the clock of last resort when all other normal synchronization sources have gone away. This is especially useful if that server has an ovenized oscillator. For this you would usually, but not necessarily, configure this driver at a stratum greater than any other likely sources of time, such as the default 5 for this driver, to prevent this driver taking over when legitimate sources elsewhere in the network are  available. To further protect the Internet infrastructure from accidental or malicious exposure to this driver, the driver is disabled if another source is available and operating.</p>
24<h4>Monitor Data</h4>
25<p>No <tt>filegen clockstats</tt> monitor data are produced by this driver.</p>
26<h4>Fudge Factors</h4>
27<dl>
28  <dt><tt>time1 <i>time</i></tt></dt>
29  <dd>Specifies the time offset calibration factor, in seconds and fraction, with default 0.0.</dd>
30  <dt><tt>time2 <i>time</i></tt></dt>
31  <dd>Specifies the frequency offset calibration factor, in parts per million, with default 0.0.</dd>
32  <dt><tt>stratum <i>number</i></tt></dt>
33  <dd>Specifies the driver stratum, in decimal from 0 to 15, with default 5.</dd>
34  <dt><tt>refid <i>string</i></tt></dt>
35  <dd>Specifies the driver reference identifier, an ASCII string from one to four characters, with default <tt>LOCL</tt>.</dd>
36  <dt><tt>flag1 0 | 1</tt></dt>
37  <dd>Not used by this driver.</dd>
38  <dt><tt>flag2 0 | 1</tt></dt>
39  <dd>Not used by this driver.</dd>
40  <dt><tt>flag3 0 | 1</tt></dt>
41  <dd>Not used by this driver.</dd>
42  <dt><tt>flag4 0 | 1</tt></dt>
43  <dd>Not used by this driver.</dd>
44</dl>
45<h4>Additional Information</h4>
46<p><a href="../refclock.html">Reference Clock Drivers</a></p>
47<hr>
48<script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
49</body>
50</html>
51