summaryrefslogtreecommitdiff
path: root/gpsdecode.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2011-02-23 10:59:34 -0500
committerEric S. Raymond <esr@thyrsus.com>2011-02-23 10:59:34 -0500
commit1915ea04efe8688d9f65753f159d3695ebc01b03 (patch)
treeee362cba7ad66cd28d31dab14eed27cdf8b07d57 /gpsdecode.xml
parent97309b267e03834b3abca9dd6160d9c51b195a0f (diff)
downloadgpsd-1915ea04efe8688d9f65753f159d3695ebc01b03.tar.gz
Documentation editing.
Diffstat (limited to 'gpsdecode.xml')
-rw-r--r--gpsdecode.xml34
1 files changed, 16 insertions, 18 deletions
diff --git a/gpsdecode.xml b/gpsdecode.xml
index 2d46989f..c776b2e1 100644
--- a/gpsdecode.xml
+++ b/gpsdecode.xml
@@ -40,21 +40,22 @@ services. It produces a JSON dump on standard output from binary on
standard input. The JSON is the same format documented in
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>;
this tool uses the same decoding logic as gpsd, but with a simpler interface
-for batch processing of data files.
+intended for batch processing of data files.
</para>
-<para>NMEA, AIVDM (the NMEA-derived sentence format
-used by AIS, the marine Automatic Identification System), and all
-GPS binary formats known to
+<para>All sensor-input formats known to the GPSD project can be
+decoded by this tool. These include: NMEA, AIVDM (the NMEA-derived
+sentence format used by AIS, the marine Automatic Identification
+System), RTCM2, RTCM3 and all supported GPS binary formats (notably
+including SiRF). See
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-can be decoded.</para>
+for applicable standards and known limitations of the decoding
+logic.</para>
-<para>Two more supported formats are RTCM 2 and 3, a pair of obscure
-and complicated serial protocol used for broadcasting pseudorange
-corrections from differential-GPS reference stations. You can use this
-mode of the tool with
+<para>You can use this tool with
<citerefentry><refentrytitle>nc</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-to examine RTCM feeds from DGPSIP servers or NTRIP broadcasters.</para>
+to examine AIS feeds from AIS pooling services, RTCM feeds from RTCM
+receivers or NTRIP broadcasters.</para>
</refsect1>
<refsect1 id='options'><title>OPTIONS</title>
@@ -63,6 +64,9 @@ to examine RTCM feeds from DGPSIP servers or NTRIP broadcasters.</para>
packets presented on standard input to standard output. This is the
default behavior.</para>
+<para>The <option>-j</option> explicitly sets the output dump format
+to JSON (the default behavior).</para>
+
<para>The <option>-e</option> option option tells the program to
encode JSON on standard input to JSON on standard output. This option
is only useful for regression-testing of the JSON dumping and parsing
@@ -72,9 +76,6 @@ code.</para>
quantities and text expansion of numeric codes. A dump with this
option is lossless.</para>
-<para>The <option>-j</option> explicitly sets the output dump format
-to JSON (the default behavior).</para>
-
<para>The <option>-c</option> sets the AIS dump format to separate
fields with an ASCII pipe symbol. Fields are dumped in the order they
occur in the AIS packet. Numerics are not scaled (-u is
@@ -113,12 +114,9 @@ dump.</para>
</refsect1>
<refsect1 id='maintainer'><title>AUTHOR</title>
-<para>Eric S. Raymond <email>esr@thyrsus.com</email>. This is a
-somewhat hacked version of an RTCM decoder originally written by
-Wolfgang Rupprecht. There is a project page for
-<application>gpsd</application> <ulink
+<para>Eric S. Raymond <email>esr@thyrsus.com</email>. There is a
+project page for <application>gpsd</application> <ulink
url="http://gpsd.berlios.de/">here</ulink>.</para>
-
</refsect1>
</refentry>