summaryrefslogtreecommitdiff
path: root/libgps.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2004-08-24 02:17:21 +0000
committerEric S. Raymond <esr@thyrsus.com>2004-08-24 02:17:21 +0000
commit7d75805d3141b772918f29aaefb3bc9c1208b313 (patch)
treee8c0d91d01ffc54fc6dfd22482f631c2ba64b2cf /libgps.xml
parentbb21a227d4783a1585826d9d83098e62227759cb (diff)
downloadgpsd-7d75805d3141b772918f29aaefb3bc9c1208b313.tar.gz
Clean up things so gpscli_report() is no longer required on client side.
Diffstat (limited to 'libgps.xml')
-rw-r--r--libgps.xml13
1 files changed, 8 insertions, 5 deletions
diff --git a/libgps.xml b/libgps.xml
index 3258a3a4..4a16016a 100644
--- a/libgps.xml
+++ b/libgps.xml
@@ -64,7 +64,9 @@ at
<para>Calling <function>gpsd_open()</function> initializes a GPS-data
structure to hold the data collected by the GPS, and returns a socket
attached to
-<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
+<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Negative
+return values indicate errors at the socket layer; see
+<filename>gps.h</filename> for values and explanations.</para>
<para><function>gpsd_close()</function> ends the session.</para>
@@ -82,12 +84,13 @@ return value is as for a query). It is meant to be used after the
user has issued an 'R' or 'W' command with
<function>gpsd_query()</function>, telling the daemon to stream updates
to the client. If the third argument is non-NULL, it is used as a
-hook function to be called on each line of streamed data.</para>
+hook function to be called on each line of streamed data. </para>
<para>Several member groups within the GPS-data structure have
-timestamp, time-to-live, update_count, and change-flag members
-associated with them; these get updated on each query or poll as
-well.</para>
+last-modified timestamps and change-flag members associated with them;
+these get updated on each query or poll as well.
+Consult <filename>gps.h</filename> to learn about the data members
+and associated timestamps.</para>
</refsect1>