diff options
| -rw-r--r-- | INSTALL | 46 | ||||
| -rw-r--r-- | SConstruct | 5 | ||||
| -rw-r--r-- | build.txt | 7 | ||||
| -rw-r--r-- | www/index.html.in | 15 |
4 files changed, 37 insertions, 36 deletions
@@ -3,12 +3,6 @@ Here are the steps for installing GPSD and verifying its performance. They assume you have GPSD available as an installable binary package, -Whatever distribution you are running, the name of the core GPSD -package containing the service daemon is almost certainly "gpsd". -However, many distributions break up GPSD into separate installable -packages for the core daemon and clients; you should search your -repository index for anything with gpsd as a prefix. - Instructions for building GPSD from source (including cross-building) are in the file "build.txt" in the source distribution. @@ -90,15 +84,18 @@ various additional features have additional prerequisites: |pgtk-2/cairo bindings | the main test client, xgps, needs this |========================================================================== -Note that while Python is required to *build* GPSD from source (the -build uses some code generators in Python), it is not required to run -the service daemon. In particular, you can cross-compile onto an -embedded system without having to take Python with you. - The Python code in GPSD is actually compatible back to Python 2.4 except that you need either the json library module from 2.6 or the functionally equivalent simplejson backport. +== Install the package(s) == + +Whatever distribution you are running, the name of the core GPSD +package containing the service daemon is almost certainly "gpsd". +However, many distributions break up GPSD into separate installable +packages for the core daemon and clients; you should search your +repository index for anything with gpsd as a prefix. + == How to test the software == 1. Start gpsd. You'll need to give it as an argument a path to @@ -135,25 +132,20 @@ http://gpsd.berlios.de/faq.html system, you may need to `dpkg-reconfigure -plow gpsd' to enable the hotplug magic ("Start gpsd automatically"). -2. Check out the list of supported hardware at - - http://gpsd.berlios.de/hardware.html - -If your GPS isn't on the list, please send us information to add a new -line to the table. Directions are included on that page. - -We can also use updates of the latest version number known to work with -hardware already supported. +2. Check out the list of supported hardware at our +http://gpsd.berlios.de/hardware.html[hardware page]. If your GPS isn't +on the list, please send us information to add a new line to the +table. Directions are included on that page. We can also use updates +of the latest version number known to work with hardware already +supported. 3. GPSD includes a PHP script that you can use to generate a PHP status page for your GPS if you wish. (It may not be in the core -package.) - -It will be installed in your HTTP document directory. The first time -it's invoked, it will generate a file called 'gpsd_config.inc' in that -directory containing configuration information; edit to taste. Note -that for the Google Maps feature work you need to set a valid Google -API key in gpsd_config.inc. +package.) It will be installed in your HTTP document directory. The +first time it's invoked, it will generate a file called +'gpsd_config.inc' in that directory containing configuration +information; edit to taste. Note that for the Google Maps feature +work you need to set a valid Google API key in gpsd_config.inc. 4. Note for people using gpsd as time source for ntpd: In case you're using dhcp3-client to configure your system, make sure you disable @@ -1320,7 +1320,7 @@ env.Alias('testregress', check) # None of these productions are fired by default. # The content they handle is the GPSD website, not included in release tarballs. -env.Alias('website', Split(''' +env.Alias('website', Split('''www/installation.html www/gpscat.html www/gpsctl.html www/gpsdecode.html www/gpsd.html www/gpsfake.html www/gpsmon.html www/gpspipe.html www/gpsprof.html www/gps.html @@ -1336,6 +1336,9 @@ env.Alias('website', Split(''' # asciidoc documents if env.WhereIs('asciidoc'): + env.Command("www/installation.html", + "INSTALL", + ["asciidoc -o www/installation.html INSTALL"]) for stem in ['AIVDM', 'NMEA', 'protocol-evolution', 'protocol-transition', 'client-howto']: @@ -30,13 +30,18 @@ this is due to generated code and cannot be fixed. You will need scons version 1.2.0 or later to build the code. The autotools build from 2.96 and earlier versions has been dropped. +While Python is required to build GPSD from source (the build uses +some code generators in Python), it is not required to run the service +daemon. In particular, you can cross-compile onto an embedded system +without having to take Python with you. + Having the following optional components on your system will enable various additional capabilities and extensions: |============================================================================== -|chrpath | simplifies running the tools from the build directory |C++ compiler | allows building libgpsmm C++ wrapper for client library |Qt 4.53+ | allows building libQgpsmm C++ wrapper for client library +|chrpath | simplifies running the tools from the build directory |============================================================================== If you have libusb-1.0.0 or later, the GPSD build will autodetect diff --git a/www/index.html.in b/www/index.html.in index 4e825c9e..b1cf3464 100644 --- a/www/index.html.in +++ b/www/index.html.in @@ -163,11 +163,10 @@ href="https://www.ohloh.net/p/3944">available at Ohloh</a></p> the *BSD family. Presently Linux and OpenBSD are directly supported. We'll support proprietary Unixes if it's not too much work (and it usually isn't). Apple's OS X is back in our good books, but it is -critical that you have all your USB drivers updated. Older drivers -are buggy and prevent <code>gpsd</code> from being able to read from -USB-serial devices.</p> - -<p>No, we don't support Windows — get a better operating system.</p> +critical that you have all your USB drivers updated. Older drivers are +buggy and prevent <code>gpsd</code> from being able to read from +USB-serial devices. No, we don't support Windows — get a better +operating system.</p> <p>If you represent a GPS manufacturer interested in qualifying your device for use with Linux and other open-source operating systems, @@ -176,8 +175,10 @@ documentation, (2) a few (as in, no more than three) eval units, and (3) an engineering contact at your firm. For more, see our page <a href='for-vendors.html'>welcoming vendor cooperation</a>.</p> -<p>See the <a href='faq.html'>FAQ</a> for information on how to report -bugs.</p> +<p>There are simple <a href="installation.html">installation +instructions</a> for people running distributions with binary package +systems. See the <a href='faq.html'>FAQ</a> for information on how to +report bugs.</p> <p>All advertising revenue from this site (on the optimistic assumption that we ever see any!) will go to the project's fund for |