driver_local.adoc 2.99 KB
Newer Older
James Browning's avatar
James Browning committed
1
= Undisciplined Local Clock
2
include::html.include[]
3

James Browning's avatar
James Browning committed
4
== Synopsis
5

6
["verse",subs="normal"]
7
Name: localclock
8 9
Reference ID: LOCL

James Browning's avatar
James Browning committed
10
== Description
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

Note: *We recommend against using this driver.* A much more flexible
replacement is described on the link:orphan.html[Orphan Mode] page.

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.

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.

James Browning's avatar
James Browning committed
35
== Monitor Data
36

37
No +filegen clockstats+ monitor data are produced by this driver.
38

James Browning's avatar
James Browning committed
39
== Driver Options
40

41 42
+unit+ 'number'::
  Not used by this driver.
43
+time1+ 'time'::
44 45
  Specifies the time offset calibration factor, in seconds and fraction,
  with default 0.0.
46
+time2+ 'time'::
47 48
  Specifies the frequency offset calibration factor, in parts per
  million, with default 0.0.
49
+stratum+ 'number'::
50
  Specifies the driver stratum, in decimal from 0 to 15, with default 5.
51
+refid+ 'string'::
52
  Specifies the driver reference identifier, an ASCII string from one to
53 54
  four characters, with default +LOCL+.
+flag1 {0 | 1}+::
55
  If flag1 is 1, set NIST lockclock mode.  In this mode, ntpd assumes
56 57 58
  the system clock is externally disciplined and disables frequency
  adjustment. Meant to be set from the configuration file only;
  changing this flag at runtime may produce undefined behavior.
59
+flag2 {0 | 1}+::
60
  Not used by this driver.
61
+flag3 {0 | 1}+::
62
  Not used by this driver.
63
+flag4 {0 | 1}+::
64
  Not used by this driver.
65 66
+subtype+::
   Not used by this driver.
67 68
+mode+::
   Not used by this driver.
69 70 71 72 73
+path+ 'filename'::
  Not used by this driver.
+ppspath+ 'filename'::
  Not used by this driver.
+baud+ 'number'::
74
  Not used by this driver.
75

James Browning's avatar
James Browning committed
76
== Configuration Example
77 78 79 80 81

----------------------------------------------------------------------------
refclock local
----------------------------------------------------------------------------

James Browning's avatar
James Browning committed
82
== Additional Information
83 84 85

link:refclock.html[Reference Clock Drivers]

James Browning's avatar
James Browning committed
86
== Authors
87 88 89

David L. Mills <mills@udel.edu>

90 91
'''''

92
include::includes/footer.adoc[]