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

Improve driver documentation - mainly adding the mode bit to summaries.

parent 9a324fc1
......@@ -149,7 +149,8 @@ with the Hayes connection and hang-up commands and result codes.
Not used by this driver.
+flag4 {0 | 1}+::
Not used by this driver.
+mode+::
Not used by this driver.
== Author ==
......
......@@ -117,6 +117,8 @@ over the last 16 seconds.
Not used by this driver.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
+mode+::
Not used by this driver.
== Author ==
......
......@@ -65,6 +65,8 @@ written as-is to the +clockstats+ file.
Not used by this driver.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
+mode+::
Not used by this driver.
== Author ==
......
......@@ -384,6 +384,8 @@ alarms are nonfatal; only the data in the burst are discarded.
before the driver is started.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
+mode+::
Not used by this driver.
== Author ==
......
......@@ -32,6 +32,10 @@ C - \r (carriage return)
L - \n (newline)
---------------------------
== Driver Options ==
This driver does not interpret fudges, option flags, or the mode.
'''''
include::includes/footer.txt[]
......@@ -452,6 +452,8 @@ screen width and looks similar to:
+flag4 {0 | 1}+::
Delete next leap second instead of adding it. (You'll need to wait a
bit for that to happen 8-)
+mode+::
Used to select the device type and serial parameters.
== Making your own generic clocks ==
......
= GPSD NG client driver =
= GPSD JSON client driver =
== Synopsis ==
......@@ -83,7 +83,7 @@ A few operation modes can be selected with the mode word.
|===========================================================================
3+|The Mode Word
|Bits |Value |Description
.4+<.>|0..1 | 0 |STI only operation. This mode is affected by the timing
.4+<.>|0..1 | 0 |STI (serial time information) only operation. This mode is affected by the timing
stability of whatever protocol is used between the GPS and GPSD
Running on STI only is not recommended in general. Possible use cases include:
......@@ -193,7 +193,7 @@ since the last poll.
== Driver Options ==
+time1+ 'time'::
Specifies tkhe PPS time offset calibration factor, in seconds and
Specifies the PPS time offset calibration factor, in seconds and
fraction, with default 0.0.
+time2+ 'time'::
_[Primary Unit]_ Specifies the TPV/TIME time offset calibration
......@@ -218,6 +218,8 @@ since the last poll.
hunts.
+flag4 {0 | 1}+::
_[Primary Unit]_ If set, write a clock stats line on every poll cycle.
+mode+::
Control STI and strict operating modes.
[[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
......
......@@ -76,6 +76,8 @@ http://www.symmetricom.com/[Symmetricom].
Not used by this driver.
+flag4 {0 | 1}+::
Not used by this driver.
+mode+::
Not used by this driver.
'''''
......
......@@ -192,6 +192,8 @@ The error flags are defined as follows in hex:
speaker volume must be set before the driver is started.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
+mode+::
Not used by this driver.
== Author ==
......
......@@ -380,6 +380,8 @@ filegen clockstats file clockstats type day enable
See corresponding receiver.
+flag4 {0 | 1}+::
See corresponding receiver.
+mode+::
Used to select a device type and serial paramters.
'''''
......
......@@ -66,6 +66,8 @@ running correctly.
clear.
+flag4 {0 | 1}+::
Not used by this driver.
+mode+::
Not used by this driver.
== Additional Information ==
......
......@@ -56,6 +56,8 @@ No +filegen clockstats+ monitor data are produced by this driver.
Not used by this driver.
+flag4 {0 | 1}+::
Not used by this driver.
+mode+::
Not used by this driver.
== Additional Information ==
......
......@@ -71,6 +71,8 @@ Format].
Not used by this driver.
+flag4 {0 | 1}+::
Not used by this driver.
+mode+::
Not used by this driver.
== Additional Information ==
......
......@@ -63,7 +63,10 @@ link:clockopt.html[+flag4 {0 | 1}+]::
+
Default setting is 0 = don't log received data and converted utc time.
Author:
+mode+::
Not used by this driver.
== Author ==
Please send any comments or question to
mailto:neoclock4@linum.com[neoclock4x@linum.com].
......
......@@ -235,6 +235,8 @@ switched on by sending the following string.
if 0 (default); use the kernel discipline if 1.
+flag4 {0 | 1}+::
Obscures location in timecode: 0 for disable (default), 1 for enable.
+mode+::
Used to control baud rate and GPS sentence selection.
== Additional Information ==
......
......@@ -76,6 +76,8 @@ specific receiver in use will be required.
Not used by this driver.
+flag4 {0 | 1}+::
Not used by this driver.
+mode+::
Not used by this driver.
== Additional Information ==
......
......@@ -51,7 +51,7 @@ hardware platforms:
| Various | Free BSD | NTP Distribution |20 us
|=============================================================================
*Attention*: Thunderbolt Receiver has not being tested on the previous
*Attention*: Thunderbolt Receiver has not been tested on the previous
software and hardware platforms.
== GPS Receiver ==
......@@ -220,15 +220,22 @@ Nov 14 16:16:21 terrapin ntpd[1127]: Palisade #0: message
link:#refid[+refid string+]::
Specifies the driver reference identifier, *GPS*.
+flag1 {0 | 1}+::
Not used by this driver.
[[flag2]]link:#Configuration[+flag2 {0 | 1}+]::
When set to 1, driver does not use hardware event capture. The
synchronous packet output by the receiver at the beginning of each
second is time stamped by the driver. If triggering the event pulse
fails, the driver falls back to this mode automatically.
== Mode Parameter ==
+flag3 {0 | 1}+::
Not used by this driver.
+flag4 {0 | 1}+::
Not used by this driver.
mode 'number'::
+mode+ 'number'::
The mode parameter to the server command specifies the specific hardware
this driver is for. The default is 0 for a normal Trimble Palisade. The
other options are *1* for an *Endrun Praecis* in Trimble emulation mode,
......
......@@ -99,7 +99,7 @@ synchronization without needing the Internet at all.
Specifies the driver stratum, in decimal from 0 to 15, with default 0.
+refid+ 'string'::
Specifies the driver reference identifier, an ASCII string from one to
four characters, with default +PPS+.
four characters, with default +PPS+.
+flag1 {0 | 1}+::
Not used by this driver.
+flag2 {0 | 1}+::
......@@ -115,6 +115,8 @@ synchronization without needing the Internet at all.
+flag4 {0 | 1}+::
Record a timestamp once for each second if 1. Useful for constructing
Allan deviation plots.
+mode+::
Not used by this driver.
== Clockstats ==
......
......@@ -173,6 +173,8 @@ for the specific unit.
+flag4 {0 | 1}+::
If flag4 is set, clockstats records will be written when the driver is
polled.
+mode+::
Not used by this driver.
== Public vs. Private SHM segments ==
......
......@@ -107,6 +107,8 @@ received.
if 0 (default); use the kernel discipline if 1.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
+mode+::
Not used by this driver.
== Author ==
......
......@@ -117,6 +117,8 @@ written as-is to the +clockstats+ file.
Not used by this driver.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
+mode+::
Not used by this driver.
== Additional Information ==
......
......@@ -23,6 +23,10 @@ and IRIG output.
link:refclock.html[Reference Clock Drivers]
== Driver Options ==
This driver does not interpret any fudges, option bits, or the mode.
'''''
include::includes/footer.txt[]
......@@ -30,7 +30,7 @@
* This driver works slightly different from most others, as the PPS
* information (if available) is also coming from GPSD via the data
* connection. This makes using both the PPS data and the serial data
* easier, but OTOH it's not possible to use the ATOM driver to feed a
* easier, but OTOH it's not possible to use the PPS driver to feed a
* raw PPS stream to the core of NTPD.
*
* To go around this, the driver can use a secondary clock unit
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment