Big documentation update to go with hotplugging.

1 files changed, 25 insertions, 23 deletions

diff --git a/README b/README
index a8f571fa..0baa168c 100644
--- a/README
+++ b/README
@@ -2,7 +2,8 @@ COPYRIGHT
 =========
 
 This software (gpsd) is Copyrighted 1997, 1998, 1999, 2000, 2001, 2002 by
-Remco Treffkorn, I am releasing it under the terms and conditions of the 
+Remco Treffkorn. Portions of it are also Copyright (c) 2005 by Eric S. 
+Raymond. It is released under the terms and conditions of the 
 
 	GNU GENERAL PUBLIC LICENSE Version 2, June 1991
 
@@ -11,23 +12,15 @@ or later. a copy of which is included in the file COPYING.
 GENERAL
 =======
 
-gpsd is a userland daemon acting as a liason between a GPS or
-Loran-C receiver and clients. The receiver is expected to generate
-position information either as NMEA-0183 sentences or in Rockwell 
-binary format.
-
-gpsd listens on port 2947 for clients requesting position, time,
-velocity or altitude information.  gpsd can take information from the
-GPS and translate it into something easier to understand for clients.
-
-There is a test client included. It is called "xgps". It simply
-connects to the daemon and displays your latitude, longitude,
-altitude, speed, track, and the signal quality from visible
-satellites.  When the GPS emits GSV, it will show a diagram of
-satellites in their current position in the sky.
-
-The gpsprobe program queries GPSes for their capabilities and generates
-a gnuplot recipe for an error scattergram to standard outout.
+gpsd is a userland daemon acting as a translator between GPS or
+Loran-C receivers and clients. gpsd listens on port 2947 for clients
+requesting position/time/velocity information.  The receivers are
+expected to generate position information in a well-known format -- as
+NMEA-0183 sentences, SiRF binary, Rockwell binary, or Garmin binary
+format.  gpsd takes this information from the GPS and translates it
+into something uniform and easier to understand for clients.  The
+distribution includes sample clients, application interface libraries,
+and test/profiling tools
 
 There is a project site for gpsd at <http://gpsd.berlios.de/>.
 Look there for updates, news, and project mailing lists.  See that
@@ -36,6 +29,13 @@ website for a list of GPS units known to be compatible.
 See the file INSTALL for installation instructions and some tips on
 how to troubleshoot your installation.
 
+Distro integrators: An RPM spec file is included in the gpsd distribution.
+It wants to set up an init script to start gpsd at runtime, and hotplug
+scripts to notify it when a potential GPS device goes active and should 
+be polled.  The goal is zero configuration; users should never have to
+tell gpsd how to configure itself.  If you can't use RPM, use what you
+see in the specfile as a model.
+
 CREDITS
 =======
 
@@ -65,9 +65,9 @@ His new features include:
      sentence from NMEA 3.0. 
    * Now parses both the NMEA 3.01 and pre-3.01 variants of the VTG sentence 
      correctly.
-   * New y command supports satellite location -- it should no longer ever be 
-     necessary for clients to go to raw mode unless they want to monitor and 
-     log the NMEA stream itself.
+   * New 'y' command supports satellite location -- it should no longer ever
+     be necessary for clients to go to raw mode unless they want to monitor and
+     and log the NMEA stream itself.
    * New 'w' command toggles 'watcher' mode. In watcher mode gpsd ships
      a gpsd-style response for each incoming sentence as if the client
      had just sent all commands that asked for data contained in the sentence.
@@ -82,13 +82,15 @@ His new features include:
    * Cleaned-up error reporting, we don't use syslog when running in foreground
      but send all error and status messages to the tty instead.
    * Added -n option to do batch monitoring of GPSes.
-   * xgpsspeed is working again.  xgps has been seriously reworked and improved.
+   * xgpsspeed is working again; xgps has been seriously reworked and improved.
    * RPMs which include installation of gpsd to start up at boot time 
      are available.
    * New gpsprobe program probes the capabilities of GPSes and generates
      error scattergrams from fixes.  (Later this moved to gpsprof.)
-   * Autobauding and self-configuration -- gpsd now figures out which baud 
+   * Autobauding, self-configuration, and hotplugging.  gpsd can now get
+     its device from a hotplug script, and figures out itself which baud 
      rate to use and what the GPS's device type is.
+   * More new commands: 'I', 'U', 'E', 'B', 'Z'. See the docs.
    * Support for SiRF binary mode.
 
 Gary Miller <gem@rellim.com> wrote the driver for Garmin binary protocol.