[ntpsec commit] Polish the refclock pages to a more uniform appearance.
Eric S. Raymond
esr at ntpsec.org
Sun Oct 4 02:31:51 UTC 2015
Module: ntpsec
Branch: master
Commit: 07b85a9461b6f1a4c98be32b2e81d99cbd35bd40
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=07b85a9461b6f1a4c98be32b2e81d99cbd35bd40
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Sat Oct 3 22:29:34 2015 -0400
Polish the refclock pages to a more uniform appearance.
---
docs/asciidoc.conf | 1 +
docs/driver1.txt | 15 ++++++--------
docs/driver10.txt | 17 +++++++--------
docs/driver11.txt | 14 ++++++-------
docs/driver18.txt | 19 +++++++----------
docs/driver20.txt | 21 ++++++++-----------
docs/driver22.txt | 13 ++++++------
docs/driver26.txt | 8 ++-----
docs/driver27.txt | 14 +++++--------
docs/driver28.txt | 11 +++-------
docs/driver29.txt | 29 +++++++++++---------------
docs/driver30.txt | 14 +++----------
docs/driver31.txt | 8 ++-----
docs/driver33.txt | 12 +++--------
docs/driver35.txt | 7 +------
docs/driver37.txt | 12 ++++-------
docs/driver38.txt | 51 +++++++++++++++------------------------------
docs/driver39.txt | 61 +++++++++++++++++++++---------------------------------
docs/driver4.txt | 19 +++++++----------
docs/driver40.txt | 8 +------
docs/driver42.txt | 10 ++-------
docs/driver44.txt | 23 ++++++--------------
docs/driver45.txt | 8 ++-----
docs/driver46.txt | 20 +++++-------------
docs/driver5.txt | 9 +++-----
docs/driver6.txt | 23 +++++++++-----------
docs/driver7.txt | 13 ++++++------
docs/driver8.txt | 27 ++++++++++++------------
docs/driver9.txt | 9 ++------
docs/refclock.txt | 2 +-
30 files changed, 178 insertions(+), 320 deletions(-)
diff --git a/docs/asciidoc.conf b/docs/asciidoc.conf
index 1ad406a..aa97da5 100644
--- a/docs/asciidoc.conf
+++ b/docs/asciidoc.conf
@@ -14,6 +14,7 @@ project-security-list=security at ntpsec.org
project-bug-list=bugs at ntpsec.org
project-bugengine=Bugzilla
project-bugtracker="NTPsec"
+daemon=ntpd
millshome=http://www.eecis.udel.edu/~mills/
ntp-keygen=ntp-keygen(8)
ntpconf=ntpconf(5)
diff --git a/docs/driver1.txt b/docs/driver1.txt
index 583467b..708bb6b 100644
--- a/docs/driver1.txt
+++ b/docs/driver1.txt
@@ -1,17 +1,10 @@
= Undisciplined Local Clock =
-[literal]
-Author: David L. Mills (mills at udel.edu)
-Last update: 9-May-2014 08:34 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
-Address: 127.127.1.'u'
+["verse",subs="normal"]
+Address: 127.127.1._u_
Reference ID: LOCL
-Driver ID: `LOCAL`
== Description ==
@@ -68,6 +61,10 @@ No `filegen clockstats` monitor data are produced by this driver.
link:refclock.html[Reference Clock Drivers]
+== Authors ==
+
+David L. Mills <mills at udel.edu>
+
'''''
include::includes/footer.txt[]
diff --git a/docs/driver10.txt b/docs/driver10.txt
index 9b61694..b48f761 100644
--- a/docs/driver10.txt
+++ b/docs/driver10.txt
@@ -1,18 +1,11 @@
= Austron 2200A/2201A GPS Receivers =
-[literal]
-Author: David L. Mills (mills at udel.edu)
-Last update: 20-Sep-2010 04:17 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.10.'u'
Reference ID: GPS
-Driver ID: GPS_AS2201
-Serial Port: /dev/gps__u__; 9600 baud, 8-bits, no parity
+Serial Port: /dev/gps__u__; 9600bps 8N1
Features: `tty_clk`
== Deprecation warning ==
@@ -45,7 +38,7 @@ collection process can be enabled or disabled using the flag4 flag. If
set, collection is enabled; if not, which is the default, it is
disabled. A comprehensive suite of data reduction and summary scripts is
in the ./scripts/stats directory
-of the ntp3 distribution.
+of the distribution.
== Monitor Data ==
@@ -73,6 +66,10 @@ written as-is to the `clockstats` file.
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
+== Author ==
+
+David L. Mills <mills at udel.edu>
+
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
diff --git a/docs/driver11.txt b/docs/driver11.txt
index b31d68b..fe61a2d 100644
--- a/docs/driver11.txt
+++ b/docs/driver11.txt
@@ -1,18 +1,12 @@
= Arbiter 1088A/B GPS Receiver =
-[literal]
-Author: David L. Mills (mills at udel.edu)
-Last update: 20-Sep-2015 05:56 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.11.'u'
Reference ID: GPS
Driver ID: GPS_ARBITER
-Serial Port: /dev/gps__u__; 9600 baud, 8-bits, no parity
+Serial Port: /dev/gps__u__; 9600bps 8N1
Features: tty_clk
== Deprecation warning ==
@@ -124,6 +118,10 @@ over the last 16 seconds.
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
+== Author ==
+
+David L. Mills <mills at udel.edu>
+
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
diff --git a/docs/driver18.txt b/docs/driver18.txt
index ec012ef..f62e6f5 100644
--- a/docs/driver18.txt
+++ b/docs/driver18.txt
@@ -1,21 +1,13 @@
= NIST/USNO/PTB Modem Time Services =
-[literal]
-Author: David L. Mills (mills at udel.edu)
-Last update: 1-Dec-2012 10:44 UTC
-
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.18.'u'
Reference ID: NIST | USNO | PTB | WWVB
-Driver ID: ACTS_MODEM
-Serial Port: /dev/acts__u__; 9600 baud, 8-bits, no parity
+xSerial Port: /dev/acts__u__; 9600 8N1
Features: tty_clk
-Requires: /usr/include/sys/termios.h header file with modem control and a dial-out (cua) device.
+Requires: a dial-out device.
== Description ==
@@ -157,6 +149,11 @@ with the Hayes connection and hang-up commands and result codes.
`flag4 0 | 1`::
Not used by this driver.
+
+== Author ==
+
+David L. Mills <mills at udel.edu>
+
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
diff --git a/docs/driver20.txt b/docs/driver20.txt
index 1f8d994..3f57697 100644
--- a/docs/driver20.txt
+++ b/docs/driver20.txt
@@ -1,17 +1,12 @@
= Generic NMEA GPS Receiver =
-Last update: 31-Mar-2014 03:55 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.20._u_
Reference ID: GPS
-Driver ID: GPS_NMEA
-Serial Port: /dev/gps__u__; 4800 - 115200 bps, 8-bits, no parity
-Serial Port: /dev/gpsppsu; for just the PPS signal (this is tried first for PPS, before /dev/gps__u__)
+Serial Port: /dev/gps__u__; 4800-115200bps, 8N1
+Serial Port: /dev/gpspps__u__; for PPS
Serial Port: /dev/gps__u__; symlink to server:port (for nmead)
Features: `tty_clk`
@@ -29,15 +24,17 @@ The driver expects the receiver to be set up to transmit at least one
supported sentence every second.
The accuracy depends on the receiver used. Inexpensive GPS models are
-available with a claimed PPS signal accuracy of 1 μs or better relative
+available with a claimed PPS signal accuracy of 1 μs or better relative
to the broadcast signal. However, in most cases the actual accuracy is
limited by the precision of the timecode and the latencies of the serial
interface and operating system.
-If the Operating System supports PPSAPI
+If the operating system supports PPSAPI
(http://www.ietf.org/rfc/rfc2783.txt[RFC 2783]), fudge flag1 1 enables
its use.
+If there is a /dev/gpspps__u__ it is tried first for PPS, before /dev/gps__u__.
+
The various GPS sentences that this driver recognises look like this:
(others quietly ignored)
@@ -241,9 +238,9 @@ switched on by sending the following string.
`flag4 0 | 1`::
Obscures location in timecode: 0 for disable (default), 1 for enable.
-Additional Information
+== Additional Information ==
-`flag1`, `flag2`, and `flag3` are ignored under Windows.
+//`flag1`, `flag2`, and `flag3` are ignored under Windows.
link:refclock.html[Reference Clock Drivers]
diff --git a/docs/driver22.txt b/docs/driver22.txt
index e5279f9..6c88fb6 100644
--- a/docs/driver22.txt
+++ b/docs/driver22.txt
@@ -1,14 +1,8 @@
= PPS Clock Discipline =
-[literal]
-Author: David L. Mills (mills at udel.edu)
-Last change: 31-Mar-2014 07:46 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.22.'u'
Reference ID: PPS
Driver ID: PPS
@@ -140,6 +134,11 @@ Pulse-per-second API for Unix-like operating systems, version 1. Request
for Comments RFC-2783, Internet Engineering Task Force, March 2000, 31
pp.
+== Author ==
+
+David L. Mills <mills at udel.edu>
+
+
'''''
include::includes/footer.txt[]
diff --git a/docs/driver26.txt b/docs/driver26.txt
index 015f395..2250799 100644
--- a/docs/driver26.txt
+++ b/docs/driver26.txt
@@ -1,16 +1,12 @@
= Hewlett Packard 58503A GPS Receiver and HP Z3801A =
-Last update: 5-Oct-2005 04:37 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.26.'u'
Reference ID: GPS
Driver ID: GPS_HP
-Serial Port: /dev/hpgps__u__; 9600 baud, 8-bits, no parity, 19200 baud 7-bits, odd parity for the HP Z3801A
+Serial Port: /dev/hpgps__u__; 9600bps 8N1, 19200bps 7N2 for the HP Z3801A
== Description ==
diff --git a/docs/driver27.txt b/docs/driver27.txt
index 63c3dc7..62f0618 100644
--- a/docs/driver27.txt
+++ b/docs/driver27.txt
@@ -1,16 +1,12 @@
= Arcron MSF Receiver =
-Last update: 20-Sep-2010 04:04 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.27.'u'
-Reference ID: MSFa / MSF / DCF / WWVB
+Reference ID: MSFa | MSF | DCF
Driver ID: MSF_ARCRON
-Serial Port: /dev/arc__u__; 300 baud, 8-bits, 2-stop, no parity
+Serial Port: /dev/arc__u__; 300bps, 8N2
Features: `tty_clk`
== Deprecation warning ==
@@ -19,13 +15,13 @@ This refclock is deprecated and obsolete. The {project-shortname}
maintainers plan to remove it in a future release. If you have a
requirement for it, please make this known to us.
-The "WWVB" functionality of thus driver has been inoperable since the
+The "WWVB" functionality of this driver has been inoperable since the
NIST modulation change in 2013.
== Description ==
This driver supports the Arcron MSF, DCF and WWVB receivers. The clock
-reports its ID as `"MSFa''`, `"MSF''`, `"DCF''` or `"WWVB''` to indicate
+reports its ID as `"MSFa"`, `"MSF"`, `"DCF"` to indicate
the time source.
This documentation describes v1.3 (2003/2/21) of the source and has been
diff --git a/docs/driver28.txt b/docs/driver28.txt
index b98d2a9..dea137d 100644
--- a/docs/driver28.txt
+++ b/docs/driver28.txt
@@ -1,15 +1,10 @@
= Shared Memory Driver =
-Last update: 8-Aug-2014 19:17 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.28.'u'
Reference ID: SHM
-Driver ID: `SHM`
== Description ==
@@ -202,14 +197,14 @@ be hex-decoded as \'NTP0', \'NTP1',..., with funny characters for units >
Public access means a permission set of 0666, while private access
creates the mapping with a permission set of 0600.
-_NTPD_ is started as root on most POSIX-like operating systems and uses
+{daemon} is started as root on most POSIX-like operating systems and uses
the setuid/setgid system API to run under reduced rights once the
initial setup of the process is done. One consequence out of this is
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;
+{daemon} does not permit the use of a fudge flag if this is to be avoided;
this is the reason why a mode bit is used for the configuration of a
public segment.
diff --git a/docs/driver29.txt b/docs/driver29.txt
index 3f52aec..d8c5ee1 100644
--- a/docs/driver29.txt
+++ b/docs/driver29.txt
@@ -1,26 +1,15 @@
= Trimble Palisade and Thunderbolt Receivers =
-Last update: 21-Oct-2010 23:44 UTC
-
-'''''
-
[width="100%",cols="<50%,<50%",frame="none",grid="none"]
|======================================================
| image:pic/driver29.gif[] | image:pic/thunderbolt.jpg[]
|======================================================
== Synopsis ==
-[[refid]]
-//ERROR: grid parameter ignored
-[width="100%",cols="<50%m,<50%s",frame="none",grid="none"]
-|=================================================================
-| Address: | 127.127.29._u_
-| Reference ID: | GPS
-| Driver ID: | GPS PALISADE
-| Serial Port: | /dev/palisade__u__
-| Serial I/O: | 9600 baud, 8-bits, 1-stop, odd parity
-| Serial I/O (Thunderbolt): | 9600 baud, 8-bits, 1-stop, no parity
-|=================================================================
+["verse",subs="normal"]
+Address: 127.127.29._u_
+Reference ID: GPS
+Serial Port: `/dev/palisade`__u__; 9600bps 8N1/8O1
== Description ==
@@ -125,6 +114,9 @@ Windows NT does not support symbolic links to device files. COM**x**: is
used by the driver, based on the refclock unit number, where unit 1
corresponds to COM**1**: and unit 3 corresponds to COM3:.
+The Palisade ships 8N1 (no parity). The Thunderbolt ships 8O1 (odd
+parity).
+
[[Configuration]]
== NTP Configuration ==
@@ -497,11 +489,14 @@ the situation:*
*link:https://lists.ntp.isc.org/pipermail/hackers/2006-April/002216.html[]*
-'''''
-[verse]
+== Authors ==
+
link:https://lists.ntp.isc.org/pipermail/hackers/2006-April/002216.html[*Questions or Comments:*]
+
mailto:sven_dietrich at trimble.com[*Sven Dietrich*]
+
http://www.trimble.com/[*Trimble Navigation Ltd.*]
+
mailto:fernandoph at iar.unlp.edu.ar[*Fernando P. Hauscarriaga*]
*(last updated January 15, 2007)*
diff --git a/docs/driver30.txt b/docs/driver30.txt
index 44866b8..8559963 100644
--- a/docs/driver30.txt
+++ b/docs/driver30.txt
@@ -1,19 +1,12 @@
= Motorola Oncore GPS receiver =
-Last update: 21-Oct-2010 23:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.30._u_
Reference ID: GPS
-Driver ID: ONCORE
-Serial Port: /dev/oncore.serial._u_; 9600 baud, 8-bits, no parity.
-PPS Port: /dev/oncore.pps._u_; PPS_CAPTUREASSERT required,
-Configuration File: ntp.oncore, or ntp.oncore._u_, or
-ntp.oncore_u_, in /etc/ntp or /etc.
+Serial Port: /dev/oncore.serial._u_; 9600bps 8N1.
+PPS Port: /dev/oncore.pps._u_
== Description ==
@@ -30,7 +23,6 @@ using the serial (DCD) or parallel port for PPS input and packs the
receiver in a nice and sturdy box. Less expensive interface kits are
available from http://www.tapr.org[TAPR] and
-
[width="100%",cols="<34%,<33%,<33%",align="center",frame="none",grid="none"]
|==========================================================================
|image:pic/oncore_utplusbig.gif[]|image:pic/oncore_evalbig.gif[]|image:pic/oncore_remoteant.jpg[gif]
diff --git a/docs/driver31.txt b/docs/driver31.txt
index b5ddd14..2355fe5 100644
--- a/docs/driver31.txt
+++ b/docs/driver31.txt
@@ -1,16 +1,12 @@
= Rockwell Jupiter GPS receiver =
-Last update: 20-Sep-2015 03:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.31.'u'
Reference ID: GPS
Driver ID: JUPITER
-Serial Port: `/dev/gps`__u__; 9600 baud, 8-bits, no parity.
+Serial Port: `/dev/gps`__u__; 9600bps 8N1
== Deprecation warning ==
diff --git a/docs/driver33.txt b/docs/driver33.txt
index 1153cf6..3efec36 100644
--- a/docs/driver33.txt
+++ b/docs/driver33.txt
@@ -1,17 +1,11 @@
= Dumb Clock =
-Last update: 20-Sep-2015 04:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.33._u_
-Reference ID: DUMBCLOCK
-Driver ID: DUMBCLOCK
-Serial Port: /dev/dumbclock_u_; 9600 bps, 8-bits, no parity
-Features: (none)
+Reference ID: DUMB
+Serial Port: /dev/dumbclock_u_; 9600bps 8N1
== Deprecation warning ==
diff --git a/docs/driver35.txt b/docs/driver35.txt
index ab5f03b..ed2441a 100644
--- a/docs/driver35.txt
+++ b/docs/driver35.txt
@@ -1,15 +1,10 @@
= Conrad parallel port radio clock =
-Last update: 20-Sep-201p 04:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.35.'u'
Reference ID: PCF
-Driver ID: PCF
Parallel Port: `/dev/pcfclocks/`__u__ or `/dev/pcfclocku`
== Deprecation warning ==
diff --git a/docs/driver37.txt b/docs/driver37.txt
index 24a5ea3..6263de1 100644
--- a/docs/driver37.txt
+++ b/docs/driver37.txt
@@ -1,12 +1,8 @@
= Forum Graphic GPS Dating station =
-Last update: 20-Sep-2015 04:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.37.'u'
Reference ID: GPS
Driver ID: GPS
@@ -27,7 +23,7 @@ Unfortunately sometime FG GPS start continues reporting of the same
date. The only way to fix this problem is GPS power cycling and ntpd
restart after GPS power-up.
-After Jan,10 2000 my FG GPS unit start send a wrong answer after 10:00am
+After Jan 10, 2000 my FG GPS unit start send a wrong answer after 10:00am
till 11:00am. It repeat hour value in result string twice. I wroite a
small code to avoid such problem. Unfortunately I have no second FG GPS
unit to evaluate this problem. Please let me know if your GPS has no
@@ -59,9 +55,9 @@ Each timecode is written to the `clockstats` file in the format
`flag4 0 | 1`::
Not used by this driver.
-'''''
+== Author ==
-_Dmitry Smirnov (das at amt.ru)_
+Dmitry Smirnov <das at amt.ru>
'''''
diff --git a/docs/driver38.txt b/docs/driver38.txt
index 81f5732..ba83938 100644
--- a/docs/driver38.txt
+++ b/docs/driver38.txt
@@ -1,24 +1,14 @@
-= _hopf_ Serial Line Receivers (6021 and kompatible) =
-
-Last update: 20-Sep-2015 04:44 UTC
-
-'''''
+= Hopf Serial Line Receivers (6021 and compatible) =
== Synopsis ==
-[width="25%",cols="<50%,<50%",frame="none",grid="none"]
-|=====================================================
-|Address: | *127.127.38.__X__*
-|[[REFID]]Reference ID:| *.hopf.* (default), *GPS, DCF*
-|Driver ID: | *HOPF_S*
-|Serial Port: | */dev/hopfclockX*
-|Serial I/O: | *9600 baud, 8-bits, 1-stop, no parity*
-|=====================================================
+["verse",subs="normal"]
+Address: 127.127.38.__u__
+Reference ID: hopf
+Serial Port: /dev/hopfclock'u'; 9600 8N1
image:pic/fg6021.gif[]
-'''''
-
== Deprecation warning ==
This refclock is deprecated and obsolete. The {project-shortname}
@@ -27,15 +17,16 @@ requirement for it, please make this known to us.
== Description ==
-The *refclock_hopf_serial* driver supports link:http://www.hopf.com[hopf electronic receivers] with serial Interface kompatibel 6021.
+The *refclock_hopf_serial* driver supports
+link:http://www.hopf.com[hopf electronic receivers] with serial
+Interface compatible with the 6021.
-Additional software and information about the software drivers is available from: link:http://www.ATLSoft.de/ntp[].
+Additional software and information about the software drivers is
+available from: link:http://www.ATLSoft.de/ntp[].
Latest NTP driver source, executables and documentation is maintained
at: link:http://www.ATLSoft.de/ntp[]
-'''''
-
== Operating System Compatibility ==
The hopf clock driver has been tested on the following software and
@@ -49,11 +40,9 @@ The hopf clock driver has been tested on the following software and
| i386 (PC) | Windows 2000
|=====================================================
-'''''
-
== O/S Serial Port Configuration ==
-The driver attempts to open the device link:#REFID[`/dev/hopfclockX`] where _**X**_
+The driver attempts to open the device /dev/hopfclockX` where *X*
is the NTP refclock unit number as defined by the LSB of the refclock
address. Valid refclock unit numbers are 0 - 3.
@@ -64,12 +53,9 @@ port device. This is typically performed by a command such as:
ln -s /dev/ttyS0 /dev/hopfclock0
----------------------------------
-Windows NT does not support symbolic links to device files.
-*COMx*: is used by the driver, based on the refclock unit number, where *unit 1* corresponds to *COM1*: and *unit 3* corresponds to *COM3*:
-
-
-
-'''''
+//Windows NT does not support symbolic links to device files. *COMx*:
+//is used by the driver, based on the refclock unit number, where *unit
+//1* corresponds to *COM1*: and *unit 3* corresponds to *COM3*:
== Fudge Factors ==
@@ -83,18 +69,15 @@ link:#REFID[*`refid` __string__]*::
*`flag1 0 | 1`*::
When set to 1, driver syncs even if only crystal driven.
-'''''
-
== Data Format ==
-as specified in clock manual under pt. [underline]#[ *Data String for NTP* (*_Network Time Protocol_*) ]#
-
-'''''
+As specified in clock manual under pt. [underline]#[ *Data String for
+NTP* (*_Network Time Protocol_*) ]#
== Questions or Comments: ==
-[verse]
mailto:altmeier at atlsoft.de[Bernd Altmeier]
+
http://www.atlsoft.de/[Ing.-Büro für Software www.ATLSoft.de]
'''''
diff --git a/docs/driver39.txt b/docs/driver39.txt
index 88dc8b2..a7397ea 100644
--- a/docs/driver39.txt
+++ b/docs/driver39.txt
@@ -1,37 +1,28 @@
-= _hopf_ PCI-Bus Receiver (6039 GPS/DCF77) =
-
-Last update: 21-Oct-2010 23:44 UTC
-
-'''''
+= Hopf PCI-Bus Receiver (6039 GPS/DCF77) =
== Synopsis ==
-[width="50%",cols="<50%,<50%",frame="none",grid="none"]
-|=============================
-| `Address:` | *127.127.39._X_*
-|[[REFID]] `Reference ID:` | *.hopf.* (default)*, GPS, DCF*
-| `Driver ID:` | *HOPF_P*
-|=============================
+["verse",subs="normal"]
+Address: 127.127.39._u_
+Reference ID: hopf
image:pic/fg6039.jpg[]
-'''''
-
== Description ==
-The *refclock_hopf_pci* driver supports the http://www.hopf.com[hopf] PCI-bus interface 6039 GPS/DCF77. +
-Additional software and information about the software drivers maybe available from: link:http://www.ATLSoft.de/ntp[]. +
-Latest NTP driver source, executables and documentation is maintained
-at: link:http://www.ATLSoft.de/ntp[]
-
-'''''
+The *refclock_hopf_pci* driver supports the http://www.hopf.com[hopf]
+PCI-bus interface 6039 GPS/DCF77. Additional software and
+information about the software drivers maybe available from:
+link:http://www.ATLSoft.de/ntp[]. Latest NTP driver source,
+executables and documentation is maintained at:
+link:http://www.ATLSoft.de/ntp[]
== Operating System Compatibility ==
The hopf clock driver has been tested on the following software and
hardware platforms:
-[width="25%",cols="<50%,<50%",frame="none",grid="none"]
+[options="header",width="25%",cols="<50%,<50%",frame="none",grid="none"]
|=============================
|*Platform* | *Operating System*
| i386 (PC) | Linux
@@ -39,34 +30,30 @@ hardware platforms:
| i386 (PC) | Windows 2000
|=============================
-'''''
-
== O/S System Configuration ==
-.*UNIX*
-The driver attempts to open the device link:#REFID[*`/dev/hopf6039`*] . The device entry will be made by the installation process of the kernel module for the PCI-bus board. The driver sources belongs to the deliver equipment of the PCI-board.
+*UNIX*::
+ The driver attempts to open the device link:#REFID[*`/dev/hopf6039`*].
+ The device entry will be made by the installation process of the
+ kernel module for the PCI-bus board. The driver sources belongs to the
+ deliver equipment of the PCI-board.
-.*Windows NT/2000*
-The driver attempts to open the device by calling the function
-"OpenHopfDevice()". This function will be installed by the Device Driver
-for the PCI-bus board. The driver belongs to the delivery equipment of
-the PCI-board.
-
-'''''
+//*Windows NT/2000*::
+// The driver attempts to open the device by calling the function
+// "OpenHopfDevice()". This function will be installed by the Device
+// Driver for the PCI-bus board. The driver belongs to the delivery
+// equipment of the PCI-board.
== Fudge Factors ==
-link:#REFID[*`refid` __string__*]::
- Specifies the driver reference identifier, *GPS* _or_ *DCF*.
+`refid` __string__::
+ Specifies the driver reference identifier.
-*`flag1 0 | 1`*::
+`flag1 0 | 1`::
When set to 1, driver syncs even if only crystal driven.
-'''''
-
== Questions or Comments: ==
-[verse]
mailto:altmeier at atlsoft.de[Bernd Altmeier]
http://www.atlsoft.de/[Ing.-Büro für Software www.ATLSoft.de]
diff --git a/docs/driver4.txt b/docs/driver4.txt
index 254a74e..040ff4d 100644
--- a/docs/driver4.txt
+++ b/docs/driver4.txt
@@ -1,20 +1,13 @@
= Spectracom =
- Author: David L. Mills (mills at udel.edu)
- Last update: 25-Jun-2015 13:32 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
-Address: 127.127.4.'u'
+["verse",subs="normal"]
+Address: 127.127.4._u_
Reference ID: `SPECTRACOM`
-Driver ID: `SPECTRACOM`
-Serial Port: `/dev/spectracomu`; 9600 baud, 8-bits, no parity
+Serial Port: `/dev/spectracom`'u'; 9600bps 8N1
Features: Optional PPS signal processing, `tty_clk`
-Requires: Optional PPS signal processing requires the PPSAPI signal
-interface.
+Requires: Optional PPS signal processing requires the PPSAPI signal interface.
== Description ==
@@ -115,6 +108,10 @@ received.
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
+== Author ==
+
+David L. Mills <mills at udel.edu>
+
'''''
include::includes/footer.txt[]
diff --git a/docs/driver40.txt b/docs/driver40.txt
index 47b2f42..3ac8fcf 100644
--- a/docs/driver40.txt
+++ b/docs/driver40.txt
@@ -1,16 +1,10 @@
= JJY Receivers =
-Last update: 15-May-2015 00:00 UTC
-//ERROR: No Japanese translation for link
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.40.'u'
Reference ID: JJY
-Driver ID: JJY
Serial Port: `/dev/jjyu`; See corresponding receiver
== Description ==
diff --git a/docs/driver42.txt b/docs/driver42.txt
index d26c384..b848b76 100644
--- a/docs/driver42.txt
+++ b/docs/driver42.txt
@@ -1,17 +1,11 @@
= Zyfer GPStarplus Receiver =
-Last update: 21-Oct-2010 23:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.42.'u'
Reference ID: GPS
-Driver ID: Zyfer GPStarplus
-Serial Port: /dev/zyfer__u__; 9600 baud, 8-bits, no parity
-Features: `(none)`
+Serial Port: /dev/zyfer__u__; 9600bps 8N1
== Description ==
diff --git a/docs/driver44.txt b/docs/driver44.txt
index 869e965..53e189d 100644
--- a/docs/driver44.txt
+++ b/docs/driver44.txt
@@ -1,22 +1,13 @@
= NeoClock4X - DCF77 / TDF serial line receiver + =
-Last update: 21-Oct-2010 23:44 UTC
-
-'''''
-
== Synopsis ==
-image:pic/neoclock4x.gif[float="right",link="http://www.linum.com"]
-
-[width="25%",cols="<50%,<50%",frame="none",grid="none",align="left"]
-|==================
-|Adress |127.127.44.u
-|Reference ID|neol
-|Driver ID |NEOCLK4X
-|Serial Port |/dev/neoclock4x-u
-|==================
+["verse",subs="normal"]
+Address: 127.127.44.'u'
+Reference ID: neol
+Serial Port: /dev/neoclock4x-u
-'''''
+image:pic/neoclock4x.gif[float="right",link="http://www.linum.com"]
== Description ==
@@ -26,8 +17,6 @@ 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 ==
*link:clockopt.html[time1 time]*::
@@ -74,7 +63,7 @@ link:clockopt.html[*flag4 0 | 1*]::
+
Default setting is 0 = don't log received data and converted utc time.
-'''''
+Author:
Please send any comments or question to
mailto:neoclock4 at linum.com[neoclock4x at linum.com].
diff --git a/docs/driver45.txt b/docs/driver45.txt
index d3df9de..f01e0ee 100644
--- a/docs/driver45.txt
+++ b/docs/driver45.txt
@@ -1,14 +1,10 @@
= Spectracom TSYNC PCI =
-Last update: 26-Mar-2012 05:10 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.45.'u'
-Reference ID: one of `GPS`, `IRIG`, `HVQ`, `FREQ`, `ACTS`, `PPS`,`PTP`, `ACT`, `USR`, `LOCL`
+Reference ID: GPS | IRIG | HVQ | FREQ | ACTS | PPS,PTP | ACT | USR | LOCL
Driver ID: Spectracom TSYNC PCI
Driver Port: `/dev/tsyncpci`'u'
Features: `(none)`
diff --git a/docs/driver46.txt b/docs/driver46.txt
index b5bab02..d384b4e 100644
--- a/docs/driver46.txt
+++ b/docs/driver46.txt
@@ -1,17 +1,12 @@
= GPSD NG client driver =
-Last update: 30-Apr-2015 05:53 UTC
-
-'''''
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.46.'u'
Reference ID: GPSD
-Driver ID: GPSD_JSON
-Serial Port: /dev/gps__u__ as symlink to the true device (not used directly; see below)
-Features:
+Serial Port: /dev/gps__u__
== Description ==
@@ -53,10 +48,9 @@ of _GPSD_!) Running without TOFF objects has a negative impact on the
jitter and offset of the serial timing information; if possible, a
version of _GPSD_ with support for TOFF objects should be used.
-The acronym [underline]#STI# is used here as a synonym for _serial time information_
-from the data channel of the receiver, no matter what objects were used
-to obtain it.
-
+The acronym [underline]#STI# is used here as a synonym for _serial
+time information_ from the data channel of the receiver, no matter
+what objects were used to obtain it.
== Naming a Device ==
@@ -123,7 +117,6 @@ use STI alone over not getting synchronised at all.
| 2..31 2+|'(reserved for future extension, do not use)'
|===========================================================================
-
== Syslog flood throttle ==
This driver can create a lot of syslog messages when things go wrong,
@@ -164,7 +157,6 @@ use of stale PPS data.
fudge `time1`. Only the fudge values `time1` and `flag1` have an impact
on secondary units.
-
== Clockstats ==
If flag4 is set when the driver is polled, a clockstats record is
@@ -226,8 +218,6 @@ since the last poll.
`flag4 0 | 1`::
_[Primary Unit]_ If set, write a clock stats line on every poll cycle.
-'''''
-
[[fn1]]link:#fn1bl[^1^)]Data transmission and decoding is done only once by the
primary unit. The decoded data is then processed independently in both
clock units. This avoids double transmission over two sockets and
diff --git a/docs/driver5.txt b/docs/driver5.txt
index 26f9462..a9f0f1b 100644
--- a/docs/driver5.txt
+++ b/docs/driver5.txt
@@ -1,14 +1,11 @@
= TrueTime GPS/GOES Receivers =
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.5.'u'
-Reference ID: GPS, GOES
-Driver ID: TRUETIME
-Serial Port: /dev/true__u__; 9600 baud, 8-bits, no parity
+Reference ID: TRUE
+Serial Port: `/dev/true`'u'; 9600bps 8N1
Features: `tty_clk`
== Deprecation warning ==
diff --git a/docs/driver6.txt b/docs/driver6.txt
index 70ab883..7b04644 100644
--- a/docs/driver6.txt
+++ b/docs/driver6.txt
@@ -1,17 +1,10 @@
= IRIG Audio Decoder =
-[literal]
-Author: David L. Mills (mills at udel.edu)
-Last update: 20-Sep-2015 04:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.6.'u'
Reference ID: IRIG
-Driver ID: IRIG_AUDIO
Audio Device: `/dev/audio` and `/dev/audioctl`
== Deprecation warning ==
@@ -31,7 +24,7 @@ signal is connected via an optional attenuator and cable to either the
microphone or line-in port of a workstation or PC.
The driver requires an audio codec or sound card with sampling rate 8
-kHz and μ-law companding to demodulate the data. This is the same
+kHz and μ-law companding to demodulate the data. This is the same
standard as used by the telephone industry and is supported by most
hardware and operating systems, including Solaris, FreeBSD and Linux,
among others. In this implementation, only one audio driver and codec
@@ -52,12 +45,12 @@ declares itself unsynchronized in this case. Some devices, in particular
Spectracom radio/satellite clocks, provide additional year and status
indication; other devices may not.
-In general and without calibration, the driver is accurate within 500 μs
+In general and without calibration, the driver is accurate within 500 μs
relative to the IRIG time. After calibrating relative to the PPS signal
from a GPS receiver, the mean offset with a 2.4-GHz P4 running FreeBSD
-6.1 is less than 20 μs with standard deviation 10 μs. Most of this is
+6.1 is less than 20 μs with standard deviation 10 μs. Most of this is
due to residuals after filtering and averaging the raw codec samples,
-which have an inherent jitter of 125 μs. The processor load due to the
+which have an inherent jitter of 125 μs. The processor load due to the
driver is 0.6 percent on the P4.
However, be acutely aware that the accuracy with Solaris 2.8 and beyond
@@ -94,7 +87,7 @@ IRIG-B, but the processor load is somewhat less. Technical details about
the IRIG formats can be found in
http://handle.dtic.mil/100.2/ADA346250[IRIG Standard 200-98].
-The driver processes 8000-Hz μ-law companded samples using separate
+The driver processes 8000-Hz μ-law companded samples using separate
signal filters for IRIG-B and IRIG-E, a comb filter, envelope detector
and automatic threshold corrector. An infinite impulse response (IIR)
1000-Hz bandpass filter is used for IRIG-B and an IIR 130-Hz lowpass
@@ -201,6 +194,10 @@ The error flags are defined as follows in hex:
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
+== Author ==
+
+David L. Mills <mills at udel.edu>
+
'''''
include::includes/footer.txt[]
diff --git a/docs/driver7.txt b/docs/driver7.txt
index 889d930..1aa8ad4 100644
--- a/docs/driver7.txt
+++ b/docs/driver7.txt
@@ -1,17 +1,12 @@
= Radio CHU Audio Demodulator/Decoder =
-
- Author: David L. Mills (mills at udel.edu)
- Last update: 20-Sep-2015 04:44 UTC
-
-'''''
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.7.'u'
Reference ID: `CHU`
Driver ID: `CHU`
-Modem Port: `/dev/chuu`; 300 baud, 8-bits, no parity
+Modem Port: `/dev/chu`'u'; 300 baud, 8-bits, no parity
Autotune Port: `/dev/icom`; 1200/9600 baud, 8-bits, no parity
Audio Device: `/dev/audio` and `/dev/audioctl`
@@ -390,6 +385,10 @@ alarm are nonfatal; only the data in the burst are discarded.
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
+== Author ==
+
+David L. Mills <mills at udel.edu>
+
'''''
include::includes/footer.txt[]
diff --git a/docs/driver8.txt b/docs/driver8.txt
index 4adf670..4f650c1 100644
--- a/docs/driver8.txt
+++ b/docs/driver8.txt
@@ -1,24 +1,22 @@
= Generic Reference Driver =
-Last update: 27-Jan-2014 05:31 UTC
+== Name ==
-'''''
+refclock_parse - multidevice parse driver for generic time radios and GPSDOs.
== Synopsis ==
-["literal",subs="normal"]
-Address: 127.127.8.u
-Reference ID: PARSE
-Driver ID: GENERIC
-Serial Port: /dev/refclock-u; TTY mode according to clock type
-PPS device: /dev/refclockpps-_u_; alternate PPS device (if not
-available via the serial port)
+["verse",subs="normal"]
+Address: 127.127.8.'u'
+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
== Description ==
-The PARSE driver supports 20 different clock types/configurations. PARSE is actually a multi-clock driver.
+The PARSE driver supports 20 different clock
+types/configurations. PARSE is actually a multi-clock driver.
-//ERROR: The (see list below) ref that used to live here was to a dead IMAP URL.
The actual receiver status is mapped into various synchronization states
generally used by receivers. The driver is configured to interpret the
time codes of Meinberg DCF77 AM receivers, DCF77 FM receivers, Meinberg
@@ -303,7 +301,7 @@ the mode parameter is the mode value as above plus 128. If 128 is not
added to the mode value, PPS will be detected to be available but will
not be used.
-== Hardware PPS support + ==
+== Hardware PPS support ==
For PPS to be used, add 128 to the mode parameter.
@@ -316,8 +314,9 @@ via the serial port.
== Monitor Data ==
-Clock state statistics are written hourly to the syslog service. Online
-information can be found by examining the clock variables via the ntpq cv command.
+Clock state statistics are written hourly to the syslog
+service. Online information can be found by examining the clock
+variables via the ntpq cv command.
Some devices have quite extensive additional information
(GPS16x/GPS17x, Trimble). The driver reads out much of the internal GPS
diff --git a/docs/driver9.txt b/docs/driver9.txt
index faf89ef..e413d2f 100644
--- a/docs/driver9.txt
+++ b/docs/driver9.txt
@@ -1,16 +1,11 @@
= Magnavox MX4200 GPS Receiver =
-Last update: 20-Sep-2015 04:44 UTC
-
-'''''
-
== Synopsis ==
-["literal",subs="normal"]
+["verse",subs="normal"]
Address: 127.127.9.'u'
Reference ID: GPS
-Driver ID: GPS_MX4200
-Serial Port: /dev/gps__u__; 4800 baud, 8-bits, no parity
+Serial Port: /dev/gps__u__; 4800bps 8N1
Features: `ppsclock` (required)
== Deprecation warning ==
diff --git a/docs/refclock.txt b/docs/refclock.txt
index 3d6990b..aefbafd 100644
--- a/docs/refclock.txt
+++ b/docs/refclock.txt
@@ -188,7 +188,7 @@ The flags field should be interpreted as follows:
|====================================================================
Driver numbers 2, 3, 12, 13, 14, 15, 16, 17, 19, 21, 23, 24, 25, 32, 34,
-36, 41, and 43 (all unused numbers below 45) are reserved. Some of
+36, 41, and 43 (all unused numbers below 46) are reserved. Some of
these were used by refclock types (now obsolete) in older NTP versions
More information about the vc
mailing list