Eliminate duplicated code between sirf.c/sirfflash.c/nmea_parse.c.

Integrate gpspipe.

1 files changed, 81 insertions, 0 deletions

diff --git a/gpspipe.xml b/gpspipe.xml
new file mode 100644
index 00000000..925c1d6d
--- /dev/null
+++ b/gpspipe.xml
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='gpspipe.1'>
+<refmeta>
+<refentrytitle>gpspipe</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>03 Aug 2005</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>gpspipe</refname>
+<refpurpose>tool to connect to gpsd and retrieve sentences</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>gpsfake</command>
+      <arg choice='opt'>-h</arg>
+      <arg choice='opt'>-n <replaceable>count</replaceable></arg>
+      <arg choice='opt'>-r</arg>
+      <arg choice='opt'>-t</arg>
+      <arg choice='opt'>-w</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para><application>gpspipe</application> is a tool to connect
+to <application>gpsd</application> and output the received
+sentences to stdout.  This makes the program useful as a pipe from
+<application>gpsd</application> to another program or file.  Presently
+it only connect to <application>gpsd</application> on the localhost on
+the default port (2947). </para>
+
+<para><application>gpspipe</application> does not require root
+privileges, and can be run concurrently with other tools connecting
+to the local <application>gpsd</application> without causing problems.</para>
+
+<para>The output will consist of one or both of the raw NMEA or native
+<application>gpsd</application> sentences.  Each line can be optionally
+time stamped.  There is also an option to exit gracefully after a
+given count of packets.</para>
+
+</refsect1>
+<refsect1 id='options'><title>OPTIONS</title>
+
+<para>-h makes <application>gpspipe</application> print
+a usage message and exit.</para>
+
+<para>-r causes raw NMEA sentences to be output.</para>
+
+<para>-w causes native <application>gpsd</application>sentences to be
+output.</para>
+
+<para>-t adds a timestamp to each sentence output.</para>
+
+<para>-n [count] causes [count] sentences to be output.  
+<application>gpspipe</application> will then exit gracefully.</para>
+
+<para>-V prints the version, then exits.</para>
+
+<para>One or both or -r and -w must be specified.</para>
+</refsect1>
+
+<refsect1 id='exampletitle'><title>EXAMPLE</title> 
+<para>When <application>gpsd is running</application> <command>gpspipe
+-r -n 100</command> will send one hundred raw NMEA sentences to
+standard output.  The exit.</para>
+</refsect1>
+
+<refsect1 id='maintainer'><title>AUTHOR</title>
+
+<para>Gary E. Miller<email>gem@rellim.com</email>.  There is a
+project page for <application>gpsd</application> <ulink
+url="http://gpsd.berlios.de/">here</ulink>.</para>
+
+</refsect1>
+
+</refentry>
+