gpscat.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!--
   3 This file is Copyright (c) 2010 by the GPSD project
   4 BSD terms apply: see the file COPYING in the distribution root for details.
   5 -->
   6 <!DOCTYPE refentry PUBLIC
   7    "-//OASIS//DTD DocBook XML V4.1.2//EN"
   8    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   9 <refentry id='gpscat.1'>
  10 <refentryinfo><date>16 Nov 2006</date></refentryinfo>
  11 <refmeta>
  12 <refentrytitle>gpscat</refentrytitle>
  13 <manvolnum>1</manvolnum>
  14 <refmiscinfo class="source">The GPSD Project</refmiscinfo>
  15 <refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
  16 </refmeta>
  17 <refnamediv id='name'>
  18 <refname>gpscat</refname>
  19 <refpurpose>dump the output from a GPS</refpurpose>
  20 </refnamediv>
  21 <refsynopsisdiv id='synopsis'>
  22
  23 <cmdsynopsis>
  24   <command>gpscat</command>
  25       <arg choice='opt'>-s <replaceable>speed</replaceable></arg>
  26       <arg choice='opt'>-p</arg>
  27       <arg choice='opt'>-t</arg>
  28       <arg choice='opt'>-D <replaceable>debuglevel</replaceable></arg>
  29       <arg choice='plain'><replaceable>serial-port</replaceable></arg>
  30 </cmdsynopsis>
  31 </refsynopsisdiv>
  32
  33 <refsect1 id='description'><title>DESCRIPTION</title>
  34
  35 <para><application>gpscat</application> is a simple program for
  36 logging and packetizing GPS data streams.  It takes input from a
  37 specified file or serial device (presumed to have a GPS attached) and
  38 reports to standard output. The program runs until end of input or it is
  39 interrupted by ^C or other means. It does not terminate on a bad
  40 backet; this is intentional.</para>
  41
  42 <para>In raw mode (the default) <application>gpscat</application>
  43 simply dumps its input to standard output.  Nonprintable characters
  44 other than ASCII whitepace are rendered as hexadecimal string escapes.</para>
  45
  46 <para>In packetizing mode, <application>gpscat</application> uses the
  47 same code as
  48 <citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s
  49 packet sniffer to break the input into packets.  Packets are reported
  50 one per line; line breaks in the packets themselves are
  51 escaped.</para>
  52
  53 <para>This program is useful as a sanity checker when examining a new
  54 device.  It can be used as a primitive NMEA logger, but beware that
  55 (a) interrupting it likely to cut off output in mid-sentence, and (b)
  56 to avoid displaying incomplete NMEA sentences right up next to shell
  57 prompts that often contain a $, raw mode always emits an extra final
  58 linefeed.</para>
  59
  60 <para>Also, be aware that packetizing mode will produce useless
  61 results &mdash; probably consuming the entirety of input and appearing
  62 to hang &mdash; if it is fed data that is not a sequence of packets
  63 of one of the known types.</para>
  64
  65 <para>The program accepts the following options:</para>
  66 <variablelist remap='TP'>
  67
  68 <varlistentry>
  69 <term>-p</term>
  70 <listitem>
  71 <para>Invoke packetizer mode.</para>
  72 </listitem>
  73 </varlistentry>
  74
  75 <varlistentry>
  76 <term>-s</term>
  77 <listitem>
  78 <para>Set the port's baud rate (and optionally its parity and stop
  79 bits) before reading.  Argument should begin with one of the normal integer
  80 baud rates (300, 1200, 4800, 9600, 19200, 38400, etc.).  It may be
  81 followed by an optional suffix [NOE][12] to set parity (None, Even,
  82 Odd) and stop bits (1 or 2).</para>
  83 </listitem>
  84 </varlistentry>
  85
  86 <varlistentry>
  87 <term>-t</term>
  88 <listitem>
  89 <para>Invoke packetizer mode, with the packet type and length (in
  90 parentheses) reported before a colon and space on each line.</para>
  91 </listitem>
  92 </varlistentry>
  93
  94 <varlistentry>
  95 <term>-D</term>
  96 <listitem>
  97 <para>In packetizer mode, enable progress messages from the packet
  98 getter.  Probably only of interest to developers testing packet
  99 getter changes.</para>
 100 </listitem>
 101 </varlistentry>
 102
 103 <varlistentry>
 104 <term>-h</term>
 105 <listitem>
 106 <para>Display program usage and exit.</para>
 107 </listitem>
 108 </varlistentry>
 109 </variablelist>
 110
 111 <para>Specifying -s 4800N1 is frequently helpful with unknown
 112 devices.</para>
 113
 114 </refsect1>
 115
 116 <refsect1 id='see_also'><title>SEE ALSO</title>
 117 <para>
 118 <citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 119 <citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 120 <citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 121 <citerefentry><refentrytitle>libgpsd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 122 <citerefentry><refentrytitle>gpsfake</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 123 <citerefentry><refentrytitle>gpsprof</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 124 <citerefentry><refentrytitle>gpsctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 125 <citerefentry><refentrytitle>gpsmon</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 126 </para>
 127 </refsect1>
 128
 129 <refsect1 id='maintainer'><title>AUTHOR</title>
 130
 131 <para>Eric S. Raymond <email>esr@thyrsus.com</email>.  There is a
 132 project page for <application>gpsd</application> <ulink
 133 url="http://gpsd.berlios.de/">here</ulink>.</para>
 134 </refsect1>
 135 </refentry>