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

Add configuration examples to driver pages.

parent 4b57ffd7
......@@ -152,6 +152,14 @@ with the Hayes connection and hang-up commands and result codes.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock acts
----------------------------------------------------------------------------
The modem-control string is, alas, hardwired into the driver.
== Author ==
David L. Mills <mills@udel.edu>
......
......@@ -120,6 +120,12 @@ over the last 16 seconds.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock arbiter
----------------------------------------------------------------------------
== Author ==
David L. Mills <mills@udel.edu>
......
......@@ -68,6 +68,18 @@ written as-is to the +clockstats+ file.
+mode+::
Not used by this driver.
== Configuration Examples ==
----------------------------------------------------------------------------
refclock austron
----------------------------------------------------------------------------
For debugging:
----------------------------------------------------------------------------
refclock austron flag 4 1
----------------------------------------------------------------------------
== Author ==
David L. Mills <mills@udel.edu>
......
......@@ -387,6 +387,12 @@ alarms are nonfatal; only the data in the burst are discarded.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock chu
----------------------------------------------------------------------------
== Author ==
David L. Mills <mills@udel.edu>
......
......@@ -36,6 +36,12 @@ L - \n (newline)
This driver does not interpret fudges, option flags, or the mode.
== Configuration Example ==
----------------------------------------------------------------------------
refclock dumbclock
----------------------------------------------------------------------------
'''''
include::includes/footer.txt[]
......@@ -455,6 +455,10 @@ screen width and looks similar to:
+mode+::
Used to select the device type and serial parameters.
== Configuration Examples ==
See the examples above under "Supported devices"
== Making your own generic clocks ==
The generic clock mechanism deviates from the way other NTP reference
......
......@@ -236,11 +236,13 @@ signal, it should not be used to create a possible PPS peer: These get
extra clout and can effectively become the sole source of input for the
control loop. You do not want to use sloppy data for that.
'''''
== Configuration Example ==
Additional Information
----------------------------------------------------------------------------
refclock gpsd mode 2
----------------------------------------------------------------------------
link:refclock.html[Reference Clock Drivers]
This is configured for the experimental automatic mode.
'''''
......
......@@ -79,6 +79,12 @@ http://www.symmetricom.com/[Symmetricom].
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock hp58503a
----------------------------------------------------------------------------
'''''
include::includes/footer.txt[]
......@@ -195,6 +195,12 @@ The error flags are defined as follows in hex:
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock irig
----------------------------------------------------------------------------
== Author ==
David L. Mills <mills@udel.edu>
......
......@@ -383,6 +383,10 @@ filegen clockstats file clockstats type day enable
+mode+::
Used to select a device type and serial paramters.
== Configuration Examples ==
See the examples in the Description section.
'''''
include::includes/footer.txt[]
......@@ -69,6 +69,12 @@ running correctly.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock jupiter
----------------------------------------------------------------------------
== Additional Information ==
The driver was resurrected from a sorry state using the Windows NT port
......
......@@ -59,6 +59,12 @@ No +filegen clockstats+ monitor data are produced by this driver.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock local
----------------------------------------------------------------------------
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
......
......@@ -74,6 +74,12 @@ Format].
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock mx4200
----------------------------------------------------------------------------
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
......
......@@ -66,6 +66,12 @@ Default setting is 0 = don't log received data and converted utc time.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock neoclock
----------------------------------------------------------------------------
== Author ==
Please send any comments or question to
......
......@@ -236,7 +236,13 @@ switched on by sending the following string.
+flag4 {0 | 1}+::
Obscures location in timecode: 0 for disable (default), 1 for enable.
+mode+::
Used to control baud rate and GPS sentence selection.
Used to control baud rate, GPS sentence selection, and logging.
== Configuration Example ==
----------------------------------------------------------------------------
refclock nmea mode 17 # GPMRC only at 9600bps
----------------------------------------------------------------------------
== Additional Information ==
......
......@@ -79,6 +79,12 @@ specific receiver in use will be required.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock oncore
----------------------------------------------------------------------------
== Additional Information ==
The driver was initially developed on FreeBSD, and has since been tested
......
......@@ -241,6 +241,12 @@ link:#refid[+refid string+]::
other options are *1* for an *Endrun Praecis* in Trimble emulation mode,
and *2* for the *Trimble Thunderbolt* GPS Disciplined Clock Receiver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock palisade
----------------------------------------------------------------------------
== DEFINEs ==
The following constants are defined in the driver source code. These
......
......@@ -118,6 +118,17 @@ synchronization without needing the Internet at all.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock pps flag2 1 # Capture PPS on trailing edge
----------------------------------------------------------------------------
This driver does not need to be configured explicitly in order to be
active; thus no "refclock pps" is required unless you need to set a
driver option, . It is initialized by whatever other driver is using
it. That will be one of the following: generic, nmea, or spectracom.
== Clockstats ==
If clockstats is enabled, the driver will log a few counters. Examples:
......
......@@ -176,6 +176,15 @@ for the specific unit.
+mode+::
Not used by this driver.
== Configuration Example ==
The most common use of this driver is to get samples from a gpsd instance:
----------------------------------------------------------------------------
refclock shm unit 0 prefer refid GPS
refclock shm unit 1 refid PPS
----------------------------------------------------------------------------
== Public vs. Private SHM segments ==
The driver attempts to create a shared memory segment with an identifier
......
......@@ -110,6 +110,12 @@ received.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock spectracom
----------------------------------------------------------------------------
== Author ==
David L. Mills <mills@udel.edu>
......
......@@ -120,6 +120,12 @@ written as-is to the +clockstats+ file.
+mode+::
Not used by this driver.
== Configuration Example ==
----------------------------------------------------------------------------
refclock truetime
----------------------------------------------------------------------------
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
......
......@@ -27,6 +27,12 @@ link:refclock.html[Reference Clock Drivers]
This driver does not interpret any fudges, option bits, or the mode.
== Configuration Example ==
----------------------------------------------------------------------------
refclock zyfer
----------------------------------------------------------------------------
'''''
include::includes/footer.txt[]
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