Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

135 lines
4.8 KiB

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!--
  3. This file is Copyright (c) 2010 by the GPSD project
  4. SPDX-License-Identifier: BSD-2-clause
  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. <cmdsynopsis>
  23. <command>gpscat</command>
  24. <arg choice='opt'>-s <replaceable>speed</replaceable></arg>
  25. <arg choice='opt'>-p</arg>
  26. <arg choice='opt'>-t</arg>
  27. <arg choice='opt'>-D <replaceable>debuglevel</replaceable></arg>
  28. <arg choice='plain'><replaceable>file-or-serial-port</replaceable></arg>
  29. </cmdsynopsis>
  30. </refsynopsisdiv>
  31. <refsect1 id='description'><title>DESCRIPTION</title>
  32. <para><application>gpscat</application> is a simple program for
  33. logging and packetizing GPS data streams. It takes input from a
  34. specified file or serial device (presumed to have a GPS attached) and
  35. reports to standard output. The program runs until end of input or it is
  36. interrupted by ^C or other means. It does not terminate on a bad
  37. packet; this is intentional.</para>
  38. <para>In raw mode (the default) <application>gpscat</application>
  39. simply dumps its input to standard output. Nonprintable characters
  40. other than ASCII whitespace are rendered as hexadecimal string escapes.</para>
  41. <para>In packetizing mode, <application>gpscat</application> uses the
  42. same code as
  43. <citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s
  44. packet sniffer to break the input into packets. Packets are reported
  45. one per line; line breaks in the packets themselves are
  46. escaped.</para>
  47. <para>This program is useful as a sanity checker when examining a new
  48. device. It can be used as a primitive NMEA logger, but beware that
  49. (a) interrupting it likely to cut off output in mid-sentence, and (b)
  50. to avoid displaying incomplete NMEA sentences right up next to shell
  51. prompts that often contain a $, raw mode always emits an extra final
  52. linefeed.</para>
  53. <para>Also, be aware that packetizing mode will produce useless
  54. results &mdash; probably consuming the entirety of input and appearing
  55. to hang &mdash; if it is fed data that is not a sequence of packets
  56. of one of the known types.</para>
  57. <para>The program accepts the following options:</para>
  58. <variablelist remap='TP'>
  59. <varlistentry>
  60. <term>-p</term>
  61. <listitem>
  62. <para>Invoke packetizer mode.</para>
  63. </listitem>
  64. </varlistentry>
  65. <varlistentry>
  66. <term>-s</term>
  67. <listitem>
  68. <para>Set the port's baud rate (and optionally its parity and stop
  69. bits) before reading. Argument should begin with one of the normal integer
  70. baud rates (300, 1200, 4800, 9600, 19200, 38400, etc.). It may be
  71. followed by an optional suffix [NOE][12] to set parity (None, Odd,
  72. Even) and stop bits (1 or 2).</para>
  73. </listitem>
  74. </varlistentry>
  75. <varlistentry>
  76. <term>-t</term>
  77. <listitem>
  78. <para>Invoke packetizer mode, with the packet type and length (in
  79. parentheses) reported before a colon and space on each line.</para>
  80. </listitem>
  81. </varlistentry>
  82. <varlistentry>
  83. <term>-D</term>
  84. <listitem>
  85. <para>In packetizer mode, enable progress messages from the packet
  86. getter. Probably only of interest to developers testing packet
  87. getter changes. Higher arguements to D produce more output.</para>
  88. </listitem>
  89. </varlistentry>
  90. <varlistentry>
  91. <term>-h</term>
  92. <listitem>
  93. <para>Display program usage and exit.</para>
  94. </listitem>
  95. </varlistentry>
  96. </variablelist>
  97. <para>Specifying -s 4800N1 is frequently helpful with unknown
  98. devices.</para>
  99. </refsect1>
  100. <refsect1 id='see_also'><title>SEE ALSO</title>
  101. <para>
  102. <citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  103. <citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  104. <citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  105. <citerefentry><refentrytitle>libgpsmm</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  106. <citerefentry><refentrytitle>gpsfake</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  107. <citerefentry><refentrytitle>gpsprof</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  108. <citerefentry><refentrytitle>gpsctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  109. <citerefentry><refentrytitle>gpsdctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  110. <citerefentry><refentrytitle>gpsmon</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  111. </para>
  112. </refsect1>
  113. <refsect1 id='maintainer'><title>AUTHOR</title>
  114. <para>Eric S. Raymond <email>esr@thyrsus.com</email>.</para>
  115. </refsect1>
  116. </refentry>