summaryrefslogtreecommitdiff
path: root/libgpsd.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2004-08-22 04:40:25 +0000
committerEric S. Raymond <esr@thyrsus.com>2004-08-22 04:40:25 +0000
commitcbd605c7a72144985e0c3f49c5a5addc8acaa81e (patch)
tree6e7e89276e22fcc31306a3e1b714e6c9d87533dc /libgpsd.xml
parent6192eb6cc53678169e73d9c79f9e16dff1837d06 (diff)
downloadgpsd-cbd605c7a72144985e0c3f49c5a5addc8acaa81e.tar.gz
A big name change. The gps* and gpsd* namespaces swap places, so gps_*
names are now the *upper*-level library. This is part 1; due to a technical limitation in Subversion, the file renames have to be done in a separate commit.
Diffstat (limited to 'libgpsd.xml')
-rw-r--r--libgpsd.xml24
1 files changed, 12 insertions, 12 deletions
diff --git a/libgpsd.xml b/libgpsd.xml
index 73b22b33..204299aa 100644
--- a/libgpsd.xml
+++ b/libgpsd.xml
@@ -21,25 +21,25 @@
</funcsynopsisinfo>
<funcprototype>
-<funcdef>int <function>gpsd_open</function></funcdef>
- <paramdef>struct gps_data *<parameter>gpsdata</parameter></paramdef>
+<funcdef>int <function>gps_open</function></funcdef>
+ <paramdef>struct gps_data_t *<parameter>gpsdata</parameter></paramdef>
<paramdef>char *<parameter>server</parameter></paramdef>
<paramdef>char * <parameter>port</parameter></paramdef>
</funcprototype>
<funcprototype>
-<funcdef>int <function>gpsd_query</function></funcdef>
+<funcdef>int <function>gps_query</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
- <paramdef>struct gps_data *<parameter>gpsdata</parameter></paramdef>
+ <paramdef>struct gps_data_t *<parameter>gpsdata</parameter></paramdef>
<paramdef>char *<parameter>requests</parameter></paramdef>
</funcprototype>
<funcprototype>
-<funcdef>int <function>gpsd_poll</function></funcdef>
+<funcdef>int <function>gps_poll</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
- <paramdef>struct gps_data * <parameter>gpsdata</parameter></paramdef>
+ <paramdef>struct gps_data_t * <parameter>gpsdata</parameter></paramdef>
<paramdef>void *<parameter>raw_hook</parameter>(char *buf)</paramdef>
</funcprototype>
<funcprototype>
-<funcdef>void <function>gpsd_close</function></funcdef>
+<funcdef>void <function>gps_close</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -61,14 +61,14 @@ is probably the one you want. The low-level interface is documented
at
<citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
-<para>Calling <function>gps_open()</function> initializes a GPS-data
+<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>
-<para><function>gps_close()</function> ends the session.</para>
+<para><function>gpsd_close()</function> ends the session.</para>
-<para><function>gps_query()</function> queries the daemon, accepts a
+<para><function>gpsd_query()</function> queries the daemon, accepts a
one-line response, and updates parts of the GPS-data structure that
correspond to data changed since the last call. The second argument
must be a string containing letters from the command set documented at
@@ -76,11 +76,11 @@ must be a string containing letters from the command set documented at
This function returns a 1 if any data changed since the last query, a
0 if no data changed, or a -1 if there was a Unix-level read error.</para>
-<para><function>gps_poll()</function> accepts a one-line response from
+<para><function>gpsd_poll()</function> accepts a one-line response from
the daemon and interprets it as though it were a query response (the
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>gps_query()</function>, telling the daemon to stream updates
+<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>