diff options
Diffstat (limited to 'libgpsd.xml')
| -rw-r--r-- | libgpsd.xml | 105 |
1 files changed, 0 insertions, 105 deletions
diff --git a/libgpsd.xml b/libgpsd.xml deleted file mode 100644 index 204299aa..00000000 --- a/libgpsd.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<!-- lifted from troff+man by doclifter --> -<refentry> -<refentryinfo><date>14 Aug 2004</date></refentryinfo> -<refmeta> -<refentrytitle>3</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo class='source'>Linux</refmiscinfo> -</refmeta> -<refnamediv id='name'> -<refname>libgpsd</refname> -<refpurpose>service library for communicationg with the GPS daemon</refpurpose> -</refnamediv> -<refsynopsisdiv id='synopsis'> -<funcsynopsis> -<funcsynopsisinfo> - -#include <gps.h> - -</funcsynopsisinfo> -<funcprototype> -<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>gps_query</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - <paramdef>struct gps_data_t *<parameter>gpsdata</parameter></paramdef> - <paramdef>char *<parameter>requests</parameter></paramdef> -</funcprototype> -<funcprototype> -<funcdef>int <function>gps_poll</function></funcdef> - <paramdef>int <parameter>fd</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>gps_close</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> -</funcprototype> -</funcsynopsis> -</refsynopsisdiv> - - -<refsect1 id='description'><title>DESCRIPTION</title> - -<para><emphasis remap='B'>libgps</emphasis> is a service library which -supports querying GPS devices; link it with the linker option --lgps. There are two interfaces supported in it; one high-level -interface that goes through -<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>1</manvolnum></citerefentry> -and is intended for concurrent use by several applications, and one -low-level interface that speaks directly with the serial or USB device -to which the GPS is attached. This page describes the high-level -interface is safe for multiple applications to use simultaneously; it -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>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>gpsd_close()</function> ends the session.</para> - -<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 -<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>1</manvolnum></citerefentry>. -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>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>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> - -<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> - -</refsect1> - -<refsect1 id='see_also'><title>SEE ALSO</title> -<para> -<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>1</manvolnum></citerefentry> -<citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry> -</para> -</refsect1> - -<refsect1 id='author'><title>AUTHOR</title> -<para>Eric S. Raymond <esr@thyrsus.com>.</para> -</refsect1> -</refentry> - |