Commit 6ba41392 authored by Eric S. Raymond's avatar Eric S. Raymond

Polish the refclock pages to a more uniform appearance.

parent d89c68ab
......@@ -14,6 +14,7 @@ project-security-list=security@ntpsec.org
project-bug-list=bugs@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)
......
= Undisciplined Local Clock =
[literal]
Author: David L. Mills (mills@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@udel.edu>
'''''
include::includes/footer.txt[]
= Austron 2200A/2201A GPS Receivers =
[literal]
Author: David L. Mills (mills@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@udel.edu>
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
......
= Arbiter 1088A/B GPS Receiver =
[literal]
Author: David L. Mills (mills@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@udel.edu>
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
......
= NIST/USNO/PTB Modem Time Services =
[literal]
Author: David L. Mills (mills@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@udel.edu>
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
......
= 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 &mu;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]
......
= PPS Clock Discipline =
[literal]
Author: David L. Mills (mills@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@udel.edu>
'''''
include::includes/footer.txt[]
= 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 ==
......
= 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
......
= 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.
......
= 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@trimble.com[*Sven Dietrich*]
http://www.trimble.com/[*Trimble Navigation Ltd.*]
mailto:fernandoph@iar.unlp.edu.ar[*Fernando P. Hauscarriaga*]
*(last updated January 15, 2007)*
......
= 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]
......
= 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 ==
......
= 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 ==
......
= 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 ==
......
= 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@amt.ru)_
Dmitry Smirnov <das@amt.ru>
'''''
......
= _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@atlsoft.de[Bernd Altmeier]
http://www.atlsoft.de/[Ing.-Büro für Software www.ATLSoft.de]
'''''
......
= _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@atlsoft.de[Bernd Altmeier]
http://www.atlsoft.de/[Ing.-Büro für Software www.ATLSoft.de]
......
= Spectracom =
Author: David L. Mills (mills@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@udel.edu>
'''''
include::includes/footer.txt[]
= 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 ==
......
= 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 ==
......
= 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
'''''