Commit eb436687 authored by Eric S. Raymond's avatar Eric S. Raymond

Documentation mega-patch to go with the new refclock syntax.

Replace almost all clock configuration examples in documentation and comments
with equivalents in the new syntax. (The few exceptions are historically
marked.)

Change all uses of the term 'fudge' with respect to flag bits. These
are now described as "driver options". The term 'fudge' is reserved
for time fudges.

Drop the old configuration examples from the UDel machines.

Add a note to the documentation start page about the new syntax,
mentioning that the old one is still supported.
parent 9a2332d3
......@@ -97,10 +97,10 @@ configuration file command +tinker codec+ command can be used to change
the systematic offset in units of 125 PPM.
The drivers include provisions to select the input port and to monitor
the input signal. The +fudge flag 2+ command selects the microphone port
the input signal. The +flag 2+ option selects the microphone port
if set to zero or the line-in port if set to one. It does not seem
useful to specify the compact disc player port. The +fudge flag 3+
command enables the input signal monitor using the previously selected
useful to specify the compact disc player port. The +flag 3+
option enables the input signal monitor using the previously selected
output port and output gain. Both of these flags can be set in the
configuration file or remotely using the +{ntpq}+ utility program.
......@@ -216,7 +216,7 @@ results in a level the line-in port can handle..
It is very easy to underdriven or overdrive the audio codec, in which
case the drivers will not synchronize to the signal. The drivers use
+fudge flag2+ to enable audio monitoring of the input signal. This is
the +flag2+ option to enable audio monitoring of the input signal. This is
useful during setup to confirm the signal is actually reaching the audio
codec and generally free of noise and interference. Note that the
monitor volume must be set before the driver is started.
......
......@@ -21,15 +21,7 @@ include::includes/clockopt.txt[]
Unless noted otherwise, further information about these commands is on
the link:refclock.html[Reference Clock Support] page.
Reference clocks are identified by a syntactically correct but invalid
IP address, in order to distinguish them from ordinary NTP peers. These
addresses are of the form 127.127._t_._u_, where _t_ is an integer
denoting the clock type and _u_ indicates the unit number in the range
0-3. While it may seem overkill, it is in fact sometimes useful to
configure multiple reference clocks of the same type, in which case the
unit numbers must be unique.
[[cmd]]
[[options]]
== Commands and Options ==
include::includes/clock-options.txt[]
......
......@@ -31,14 +31,13 @@ and auxiliary commands that specify environment variables that control
various related operations.
The various modes described on the link:assoc.html[Association
Management] page are determined by the command keyword and the DNS name
or IP address. Addresses are classed by type as (s) a remote server or
peer (IPv4 class A, B and C or IPv6), (b) the IPv4 broadcast address of
a local interface, (m) a multicast address (IPv4 class D or IPv6), or
(r) a reference clock address (127.127.x.x). For multicast addresses the
IANA has assigned the multicast group address IPv4 224.0.1.1 and IPv6
ff05::101 (site local) exclusively to NTP, but other nonconflicting
addresses can be used.
Management] page are determined by the command keyword and the DNS
name or IP address. Addresses are classed by type as (s) a remote
server or peer (IPv4 class A, B and C or IPv6), (b) the IPv4 broadcast
address of a local interface, or (m) a multicast address (IPv4 class D
or IPv6). For multicast addresses the IANA has assigned the multicast
group address IPv4 224.0.1.1 and IPv6 ff05::101 (site local)
exclusively to NTP, but other nonconflicting addresses can be used.
If the Basic Socket Interface Extensions for IPv6 (RFC-2553) is
detected, support for the IPv6 address family is generated in addition
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.1._u_
Name: localclock
Reference ID: LOCL
== Description ==
......@@ -35,7 +35,7 @@ disabled if another source is available and operating.
No +filegen clockstats+ monitor data are produced by this driver.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.10.'u'
Name: austron
Reference ID: GPS
Serial Port: /dev/gps__u__; 9600bps 8N1
Features: +tty_clk+
......@@ -27,9 +27,9 @@ For use with a single computer, the receiver can be connected directly
to the receiver. For use with multiple computers, one of them is
connected directly to the receiver and generates the polling messages.
The other computers just listen to the receiver output directly or
through a buffer amplifier. For computers that just listen,
+fudge flag2+ must be set and the +ppsclock+ streams module configured
on each of them.
through a buffer amplifier. For computers that just listen, the
+flag2+ option must be set and the +ppsclock+ streams module
configured on each of them.
This receiver is capable of a comprehensive and large volume of
statistics and operational data. The specific data collection commands
......@@ -42,10 +42,10 @@ of the distribution.
== Monitor Data ==
When enabled by the +flag4+ fudge flag, every received timecode is
When enabled by the +flag4+ option, every received timecode is
written as-is to the +clockstats+ file.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.11.'u'
Name: arbiter
Reference ID: GPS
Driver ID: GPS_ARBITER
Serial Port: /dev/gps__u__; 9600bps 8N1
......@@ -87,7 +87,7 @@ intrinsic jitter of the radio itself.
== Monitor Data ==
When enabled by the +flag4+ fudge flag, an additional line containing
When enabled by the +flag4+ option, an additional line containing
the latitude, longitude, elevation and optional deviation data is
written to the +clockstats+ file. The deviation data operates with an
external pulse-per-second (PPS) input, such as a cesium oscillator or
......@@ -97,7 +97,7 @@ The deviation data consists of the mean offset and standard deviation of
the external PPS signal relative the GPS signal, both in microseconds
over the last 16 seconds.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.18.'u'
Name: acts
Reference ID: NIST | USNO | PTB | WWVB
xSerial Port: /dev/acts__u__; 9600 8N1
Features: tty_clk
......@@ -36,7 +36,7 @@ changes for nonstandard modems or special circumstances.
There are three modes of operation selected by the +mode+ keyword in the
+server+ configuration command. In manual mode (2) the calling program
is initiated by setting fudge +flag1+. This can be done manually using
is initiated by setting the +flag1+ option. This can be done manually using
+{ntpq}+, or by a cron job. In auto mode (0) +flag1+ is set at each poll
event. In backup mode (1) +flag1+ is set at each poll event, but only if
no other synchronization sources are available.
......@@ -48,8 +48,8 @@ specified by the Hayes ATDT prefix followed by the number itself,
including the prefix and long-distance digits and delay code, if
necessary. The +flag1+ is reset and the calling program terminated if
(a) valid clock update has been determined, (b) no more numbers remain
in the list, (c) a device fault or timeout occurs or (d) fudge +flag1+
is reset manually using +{ntpq}+.
in the list, (c) a device fault or timeout occurs or (d) the +flag1+
option is reset manually using +{ntpq}+.
The driver automatically recognizes the message format of each modem
time service. It selects the parsing algorithm depending on the message
......@@ -61,9 +61,10 @@ set to NIST, USNO, PTB or WWVB as appropriate.
The Spectracom receiver can be connected via a modem if the radio is
configured to send time codes continuously at 1-s intervals. In
principle, fudge +flag2+ enables port locking, allowing the modem to be
shared when not in use by this driver. At least on Solaris with the
current NTP I/O routines, this results in lots of ugly error messages.
principle, the +flag2+ option enables port locking, allowing the modem
to be shared when not in use by this driver. At least on Solaris with
the current NTP I/O routines, this results in lots of ugly error
messages.
The +minpoll+ and +maxpoll+ keywords of the server configuration command
can be used to limit the intervals between calls. The recommended
......@@ -129,7 +130,7 @@ continuous mode or be polled by another local driver.
The received timecode is written as-is to the +clockstats+ file along
with the Hayes connection and hang-up commands and result codes.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.20._u_
Name: nmea
Reference ID: GPS
Serial Port: /dev/gps__u__; 4800-115200bps, 8N1
Serial Port: /dev/gpspps__u__; for PPS
......@@ -30,8 +30,8 @@ limited by the precision of the timecode and the latencies of the serial
interface and operating system.
If the operating system supports PPSAPI
(http://www.ietf.org/rfc/rfc2783.txt[RFC 2783]), fudge flag1 1 enables
its use.
(http://www.ietf.org/rfc/rfc2783.txt[RFC 2783]), the +flag1 1+ option
enables its use.
If there is a /dev/gpspps__u__ it is tried first for PPS, before /dev/gps__u__.
......@@ -91,9 +91,7 @@ The various GPS sentences that this driver recognises look like this:
== The \'mode' byte ==
Specific GPS sentences and bitrates may be selected by setting bits of the \'mode' in the server configuration line:
+server 127.127.20.x mode X+
Specific GPS sentences and bitrates may be selected by setting bits of the \'mode' in the refclock configuration line:
.mode byte bits and bit groups
[cols="10%,10%,10%,70%",options="header"]
......@@ -129,7 +127,7 @@ bit values, but of those enabled still only the first received sentence
in a cycle will be used. Using more than one sentence per cycle is
impossible, because
* there is only link:#fudgetime2[fudge time2] available to compensate
* there is only the link:#fudgetime2[time2] option available to compensate
for transmission delays but every sentence would need a different one
and
* using more than one sentence per cycle overstuffs the internal data
......@@ -213,7 +211,7 @@ switched on by sending the following string.
"$PGRMC,,,,,,,,,,,,2<cr><lf>"
-----------------------------
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the PPS time offset calibration factor, in seconds and
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.22.'u'
Name: pps
Reference ID: PPS
Driver ID: PPS
Serial or Parallel Port: /dev/pps__u__
......@@ -65,14 +65,14 @@ the actual physical device.
The driver normally operates like any other driver and uses the same
mitigation algorithms and PLL/FLL clock discipline incorporated in the
daemon. If kernel PLL/FLL support is available, the kernel PLL/FLL clock
discipline can be used instead. The default behavior is not to use the
kernel PPS clock discipline, even if present. This driver incorporates a
good deal of signal processing to reduce jitter using the median filter
algorithm in the driver. As the result, performance with +minpoll+
configured at 4 (16s) is generally better than the kernel PPS
discipline. However, fudge flag 3 can be used to enable the kernel PPS
discipline if necessary.
daemon. If kernel PLL/FLL support is available, the kernel PLL/FLL
clock discipline can be used instead. The default behavior is not to
use the kernel PPS clock discipline, even if present. This driver
incorporates a good deal of signal processing to reduce jitter using
the median filter algorithm in the driver. As the result, performance
with +minpoll+ configured at 4 (16s) is generally better than the
kernel PPS discipline. However, the +flag 3+ option can be used to
enable the kernel PPS discipline if necessary.
This driver is enabled only under one of two conditions (a) a prefer
peer other than this driver is among the survivors of the mitigation
......@@ -95,7 +95,7 @@ In a similar scenario a PPS signal can be used to discipline the clock
between updates produced by the modem driver. This would provide precise
synchronization without needing the Internet at all.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.26.'u'
Name: hp58503a
Reference ID: GPS
Driver ID: GPS_HP
Serial Port: /dev/hpgps__u__; 9600bps 8N1, 19200bps 7N2 for the HP Z3801A
......@@ -42,7 +42,7 @@ The T is the on-time character, at 980 msec. before the next 1PPS edge.
The # is the timecode format type. We look for format 2. Without any of
the CLK or PPS stuff, then, the receiver buffer timestamp at the <cr> is
24 characters later, which is about 25 msec. at 9600 bps, so the first
approximation for fudge time1 is nominally -0.955 seconds. This number
approximation for the +time1+ option is nominally -0.955 seconds. This number
probably needs adjusting for each machine / OS type, so far: -0.955000
on an HP 9000 Model 712/80 HP-UX 9.05 -0.953175 on an HP 9000 Model 370
HP-UX 9.10
......@@ -56,7 +56,7 @@ the right line paramters.
The timekeeping portion of HP's business has been sold to
http://www.symmetricom.com/[Symmetricom].
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.28.'u'
Name: shm
Reference ID: SHM
== Description ==
......@@ -133,10 +133,9 @@ Here is a sample showing the GPS reception fading out:
== The \'mode' word ==
Some aspects of the driver behavior can be adjusted by setting bits of
the mode option of the refclock declaration.
["literal",subs="normal"]
server 127.127.28.'X' mode 'Y'
.mode word bits and bit groups
[cols="10%,10%,10%,70%",options="header"]
|=============================================================
......@@ -148,7 +147,7 @@ for the specific unit.
|1-31 | - | - | _reserved -- do not use_
|=============================================================
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......@@ -204,7 +203,7 @@ that the allocation of SHM segments must be done early during the clock
setup. The actual polling of the clock is done as the run-time user;
deferring the creation of the SHM segment to this point will create a
SHM segment owned by the runtime-user account. The internal structure of
{ntpd} does not permit the use of a fudge flag if this is to be avoided;
{ntpd} does not permit the use of a refclock option if this is to be avoided;
this is the reason why a mode bit is used for the configuration of a
public segment.
......
......@@ -7,7 +7,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.29._u_
Name: palisade
Reference ID: GPS
Serial Port: +/dev/palisade+__u__; 9600bps 8N1/8O1
......@@ -75,7 +75,7 @@ No user initialization of the receiver is required. This driver is compatible wi
| 7.12 | Yes | 38158-00
|======================================================
Note: When using Palisade 26664-00, you must set fudge flag2 to 1 in
Note: When using Palisade 26664-00, you must set the +flag2+ option to 1 in
*{ntpconf}*. See link:#Configuration[configuration].
== GPS Installation ==
......@@ -129,7 +129,7 @@ Palisade NTP configuration file "{ntpconf}" with event polling:
["literal",subs="normal"]
#------------------------------------------------------------------------------
# The Primary reference
server 127.127.29.0 # Trimble Palisade GPS Refclock Unit #0
refclock palisade unit 0
peer terrapin.csc.ncsu.edu # internet server
# Drift file for expedient re-synchronization after downtime or reboot.
driftfile /etc/ntp.drift
......@@ -139,12 +139,9 @@ Configuration without event polling:
["literal",subs="normal"]
#------------------------------------------------------------------------------
# The Primary reference
server 127.127.29.0 # Trimble Palisade GPS (Stratum 1).
# Set packet delay
link:#time1[fudge 127.127.29.0 time1 0.020]
# and set flag2 to turn off event polling.
link:#flag2[fudge 127.127.29.0 flag2 1]
# The Primary reference.
# Set packet delay and set flag2 to turn off event polling.
refclock palisade unit 0 link:#time1[time1 0.020] link:#flag2[flag2 1]
#------------------------------------------------------------------------------
== Thunderbolt NTP Configuration file ==
......@@ -154,11 +151,7 @@ Configuration without event polling:
["literal",subs="normal"]
#------------------------------------------------------------------------------
# The Primary reference
server 127.127.29.0 mode 2 # Trimble Thunderbolt GPS (Stratum 1).
# Set packet delay
link:#time1[fudge 127.127.29.0 time1 0.020]
# and set flag2 to turn off event polling.
link:#flag2[fudge 127.127.29.0 flag2 1]
refclock palisade unit 0 mode 2 link:#time1[time1 0.020] link:#flag2[flag2 1]
#------------------------------------------------------------------------------
Currently the Thunderbolt mode doesn't support event polling, the
......@@ -192,11 +185,13 @@ UTC almanac.
the interface module. It should flash once per second.
3. Connect Palisade's port A to the NTP host.
4. Configure NTP and the serial I/O port on the host system.
5. Initially use link:#flag2[+fudge flag2+] in *link:#Configuration[{ntpconf}],* to disable event polling (see configuration).
5. Initially use the link:#flag2[+flag2+] option in
*link:#Configuration[{ntpconf}],* to disable event polling (see
configuration).
6. Run NTP in debug mode (-d -d), to observe Palisade_receive events.
7. The driver reports the link:#TrackingStatus[tracking status of the
receiver]. Make sure it is tracking several satellites.
8. Remove fudge flag2 and restart the daemon in debug mode to observe
8. Remove the +flag2+ option and restart the daemon in debug mode to observe
palisade_receive events.
9. If event polling fails, verify the link:#Pinouts[connections] and
that the host hardware supports RTS control.
......@@ -212,7 +207,7 @@ clock driver will be of the form:
Nov 14 16:16:21 terrapin ntpd[1127]: Palisade #0: message
---------------------------------------------------------
== Fudge Factors ==
== Driver Options ==
[[time1]]link:#Configuration[+time1+ 'time]'::
Specifies the time offset calibration factor, in seconds and fraction,
with default 0.0. If event capture is not used, time1 should be set to
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.30._u_
Name: oncore
Reference ID: GPS
Serial Port: /dev/oncore.serial._u_; 9600bps 8N1.
PPS Port: /dev/oncore.pps._u_
......@@ -56,7 +56,7 @@ manual page for information on how to use this option. For either
debugging or using the SHMEM option, an Oncore Reference Manual for the
specific receiver in use will be required.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.31.'u'
Name: jupiter
Reference ID: GPS
Driver ID: JUPITER
Serial Port: +/dev/gps+__u__; 9600bps 8N1
......@@ -44,7 +44,7 @@ first starting to use the driver you should definitely review the
information written to the clockstats file to verify that the driver is
running correctly.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.33._u_
Name: dumbclock
Reference ID: DUMB
Serial Port: /dev/dumbclock_u_; 9600bps 8N1
......
......@@ -3,8 +3,8 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.4._u_
Reference ID: +SPECTRACOM+
Name: spectracom
Reference ID: +GPS+
Serial Port: +/dev/spectracom+'u'; 9600bps 8N1
Features: Optional PPS signal processing, +tty_clk+
Requires: Optional PPS signal processing requires the PPSAPI signal interface.
......@@ -78,12 +78,12 @@ signal is disconnected.
== Monitor Data ==
The driver writes each timecode as received to the +clockstats+ file.
When enabled by the +flag4+ fudge flag, a table of quality data
When enabled by the +flag4+ option, a table of quality data
maintained internally by the Netclock/2 is retrieved and written to the
+clockstats+ file when the first timecode message of a new day is
received.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the PPS time offset calibration factor, in seconds and
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.40.'u'
Name: jjy
Reference ID: JJY
Serial Port: +/dev/jjyu+; See corresponding receiver
......@@ -26,9 +26,7 @@ sold in Japan, and the time service through a telephone line.
NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 1;;
fudge 127.127.40.X time1 0.NNN flag1 {0|1};;
refclock jjy unit X mode 1 time1 0.NNN flag1 {0|1};;
Time1 may specify a constant to be added to the time offset for the
time from the receiver, a fixed-point decimal number in seconds. You
may specify the time offset from several tens of milliseconds (
......@@ -66,9 +64,7 @@ whether it's before or after midnight.
NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 2;;
fudge 127.127.40.X time1 0.NNN;;
refclock jjy unit X mode 2 time1 0.NNN;;
--
+
Interface::
......@@ -84,9 +80,7 @@ Command -\-> Reply +
NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 3;;
fudge 127.127.40.X time1 0.NNN;;
refclock jjy unit X mode 3 time1 0.NNN;;
--
+
Interface::
......@@ -107,9 +101,7 @@ Time code format::
NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 4;;
fudge 127.127.40.X time1 0.NNN;;
refclock jjy unit X mode 4 time1 0.NNN;;
--
+
Interface::
......@@ -135,9 +127,7 @@ GPS driver ( Type 20 )] supports the TS-GPSclock-01 in NMEA mode.
NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 5;;
fudge 127.127.40.X time1 0.NNN flag1 {0|1};;
refclock jjy unit X mode 5 time1 0.NNN flag1 {0|1};;
Time1 may specify a constant to be added to the time offset for the
time from the receiver, a fixed-point decimal number in seconds. +
Flag1 has no effect for time synchronization. When a flag1 is set to
......@@ -177,9 +167,7 @@ menu display and the switches.
NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 6;;
fudge 127.127.40.X time1 0.NNN;;
refclock jjy unit X mode 6 time1 0.NNN;;
--
+
Interface::
......@@ -210,7 +198,7 @@ appropriate "phone" statement among the "phone" statements.
NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode (100, 101 to 180) minpoll N;;
refclock jjy unit X mode (100, 101 to 180) minpoll N;;
The mode 100 is specified, this driver does not issue the loopback
command in order to measure the delay, and the delay of the
delay of the telephone line and the system processing is not
......@@ -244,7 +232,7 @@ minpoll value 12 is 4096 seconds interval ( about 1 hour ), 14 is
16384 seconds interval ( about 4.5 hours ), 16 is 65536 seconds (
about 18 hours ), respectively.
fudge 127.127.40.X flag1 {0|1} flag2 {0|1} flag3 {0|1} flag4 {0|1};;
flag1 {0|1} flag2 {0|1} flag3 {0|1} flag4 {0|1};;
Time1 may specify a constant to be added to the time offset for the time from the receiver, a fixed-point decimal number in seconds. +
When the mode 100 is specified, the time1 may be specified in order to adjust the time offset. +
When the mode 101 to 180 is specified, the time1 should not be
......@@ -372,7 +360,7 @@ filegen clockstats file clockstats type day enable
|+-X-+ | Error message
|============================================================
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.42.'u'
Name: zyfer
Reference ID: GPS
Serial Port: /dev/zyfer__u__; 9600bps 8N1
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.44.'u'
Name: neoclock
Reference ID: neol
Serial Port: /dev/neoclock4x-u
......@@ -17,13 +17,13 @@ is available as a http://www.dcf77.de[DCF77] or TDF receiver. Both
receivers have the same output string. For more information about the
NeoClock4X receiver please visit http://www.linux-funkuhr.de.
== Fudge Factors ==
== Driver Options ==
link:clockopt.html[+time1+ time]::
Specifies the time offset calibration factor with the default value of
0.16958333 seconds. This offset is used to correct serial line and
operating system delays incurred in capturing time stamps. If you want
to fudge the time1 offset *ALWAYS* add a value off 0.16958333. This is
to fudge the +time1+ offset *ALWAYS* add a value off 0.16958333. This is
necessary to compensate for the delay that is caused by transmitting the
timestamp at 2400 Baud. If you want to compensate the delay that the
DCF77 or TDF radio signal takes to travel to your site simply add the
......
......@@ -4,7 +4,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.46.'u'
Bame: gpsd
Reference ID: GPSD
Serial Port: /dev/gps__u__
......@@ -124,7 +124,7 @@ and cluttering the log files is frowned upon. So we attempt to log
persistent or recurring errors only once per hour. On the other hand,
when tracking a problem the syslog flood throttle can get into the way.
Therefore, fudge _flag3_ can be used to _disable_ the flood throttle at
Therefore, option _flag3_ can be used to _disable_ the flood throttle at
any time; the throttle is engaged by default. Running with the syslog
flood throttle disabled for lengthy time is not recommended unless the
log files are closely monitored.
......@@ -146,7 +146,7 @@ samples:
* The phase adjustment from the PPS signal must also be less than 400ms
absolute.
If fudge flag +flag1+ is set for the secondary unit, the unit asserts
If option +flag1+ is set for the secondary unit, the unit asserts
the PPS flag on the clock as long as PPS data is available. This makes
the unit eligible as PPS peer and should only be used if the GPS
receiver can be trusted for the quality of its PPS
......@@ -154,9 +154,9 @@ signal^link:#fn2[2]^. [[fn2bl]] The PPS flag gets cleared if no PPS
records can be acquired for some time. The unit also flushes the
sample buffer at this point to avoid the use of stale PPS data.
*Attention:* This unit uses its own PPS fudge value which must be set as
fudge +time1+. Only the fudge values +time1+ and +flag1+ have an impact
on secondary units.
*Attention:* This unit uses its own PPS fudge value which must be set
as fudge +time1+. Only the fudge values +time1+ and the +flag1+ option
have an impact on secondary units.
== Clockstats ==
......@@ -190,7 +190,7 @@ the last poll.
since the last poll.
|===========================================================================
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies tkhe PPS time offset calibration factor, in seconds and
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.5.'u'
Name: truetime
Reference ID: TRUE
Serial Port: +/dev/true+'u'; 9600bps 8N1
Features: +tty_clk+
......@@ -54,12 +54,12 @@ Send a +R+ to get the satellite position once (GOES only).
Since the old east/west satellite locations are only historical, you
can't set your clock propagation delay settings correctly and still use
automatic mode. The manual says to use a compromise when setting the
switches. This results in significant errors. The solution; use fudge
switches. This results in significant errors. The solution; use fudges
time1 and time2 to incorporate corrections. If your clock is set for 50
and it should be 58 for using the west and 46 for using the east, use
the line
the options
+fudge 127.127.5.0 time1 +0.008 time2 -0.004+
+time1 +0.008 time2 -0.004+
This corrects the 4 milliseconds advance and 8 milliseconds retard
needed. The software will ask the clock which satellite it sees.
......@@ -92,10 +92,10 @@ reference oscillator.
== Monitor Data ==
When enabled by the +flag4+ fudge flag, every received timecode is
When enabled by the +flag4+ option, every received timecode is
written as-is to the +clockstats+ file.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.6.'u'
Name: irig
Reference ID: IRIG
Audio Device: +/dev/audio+ and +/dev/audioctl+
......@@ -124,7 +124,7 @@ following format:
+00 00 98 23 19:26:52 2782 143 0.694 10 0.3 66.5 3094572411.00027+
If clockstats is enabled, the most recent line is written to the
clockstats file every 64 s. If verbose recording is enabled (fudge flag
clockstats file every 64 s. If verbose recording is enabled (option flag
4) each line is written as generated.
The first field contains the error flags in hex, where the hex bits are
......@@ -169,7 +169,7 @@ The error flags are defined as follows in hex:
+x80+::
Device status error (Spectracom).
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
......
......@@ -3,7 +3,7 @@
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.7.'u'
Name: chu
Reference ID: +CHU+
Driver ID: +CHU+
Modem Port: +/dev/chu+'u'; 300 baud, 8-bits, no parity
......@@ -232,7 +232,7 @@ program and the +clockvar+ command. This displays the last determined
timecode and related status and error counters, even when the program is
not discipline the system clock. If the debugging trace feature (+-d+ on
the +{ntpd}+ command line) is enabled, the program produces detailed
status messages as it operates. If the +fudge flag 4+ is set, these
status messages as it operates. If the +flag 4+ option is set, these
messages are written to the +clockstats+ file. All messages produced by
this driver have the prefix +chu+ for convenient filtering with the Unix
+grep+ command.
......@@ -360,7 +360,7 @@ alarms are nonfatal; only the data in the burst are discarded.
least 20 timestamps in the minute; otherwise all data in the minute
are discarded.
== Fudge Factors ==
== Driver Options ==
+time1+ 'time'::
Specifies the propagation delay for CHU (45:18N 75:45N), in seconds
......
......@@ -7,7 +7,7 @@ refclock_parse - multidevice parse driver for generic time radios and GPSDOs.
== Synopsis ==
["verse",subs="normal"]
Address: 127.127.8.'u'
Name: generic
Reference ID: DCF | DCFa | DCFp | GPS | MSF
Serial Port: /dev/refclock-'u'; TTY mode according to clock type
PPS device: /dev/refclockpps-'u'; alternate PPS device
......@@ -113,7 +113,7 @@ SEL-2407 in one of its development labs.