summaryrefslogtreecommitdiff
path: root/www
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2016-05-07 08:14:08 -0400
committerEric S. Raymond <esr@thyrsus.com>2016-05-07 08:33:49 -0400
commit731438035a1a7c64820857f44a00807df3e9e437 (patch)
treeb8294fa778ba517ed713c785daff037c4cc805cc /www
parent774f18e9e27a5934fd0e3e514ea47de88ca9b5ba (diff)
downloadgpsd-731438035a1a7c64820857f44a00807df3e9e437.tar.gz
Implement 'timeservice' build option. Document it in the Time Sevice HOWTO.
Diffstat (limited to 'www')
-rw-r--r--www/gpsd-time-service-howto.txt28
1 files changed, 22 insertions, 6 deletions
diff --git a/www/gpsd-time-service-howto.txt b/www/gpsd-time-service-howto.txt
index ad4e4518..54fbe5ff 100644
--- a/www/gpsd-time-service-howto.txt
+++ b/www/gpsd-time-service-howto.txt
@@ -281,18 +281,32 @@ have serious problems.
== Software Prerequisites ==
-gpsd includes support for interpreting 1PPS pulses that is mostly
-autoconfiguring and requires no special setup. If you built GPSD from
-sources, make sure the build is with pps=yes and ntpshm=yes (the
-default). The command "gpsd -L" should indicate that
-time-service features and PPS are enabled.
-
If your kernel provides the RFC 2783 KPPS (kernel PPS) API, gpsd will
use that for extra accuracy. Many Linux distributions have a package
called "pps-tools" that will install KPPS support and the timepps.h
header file. We recommend you do that. If your kernel is built in
the normal modular way, this package installation will suffice.
+=== Building gpsd ==
+
+A full gpsd build includes support for interpreting 1PPS pulses that is mostly
+autoconfiguring and requires no special setup.
+
+You can build a version stripped to the mimimum configuration required
+for time service like this:
+
+-----------------------------------------------------------------------------
+scons timeservice=yes nmea0183=yes
+-----------------------------------------------------------------------------
+
+You may substitute a different GPS (e.g. "ublox" or "sirf")
+
+Otherwise, make sure the build is with pps=yes and ntpshm=yes (the
+default). The command "gpsd -L" should indicate that time-service
+features and PPS are enabled.
+
+=== Kernel support ===
+
If you are scratch-building a Linux kernel, the configuration
must include either these two lines, or the same with "y" replaced
by "m" to enable the drivers as modules:
@@ -329,6 +343,8 @@ Other OSes have different ways to enable KPPS in their kernels.
When we learn what those are, we'll document them or point
at references.
+=== Time service daemon ===
+
You will need to have either ntpd or chrony installed. If you are
running a Unix variant with a package system, the packages will
probably be named 'ntpd' and either 'chrony' or 'chronyd'.