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.
 
 
 
 
 
 

96 lines
3.8 KiB

  1. '\" t
  2. .\" Title: gpscat
  3. .\" Author: [see the "AUTHOR" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 16 Nov 2006
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "GPSCAT" "1" "16 Nov 2006" "The GPSD Project" "GPSD Documentation"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. gpscat \- dump the output from a GPS
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBgpscat\fR\ 'u
  34. \fBgpscat\fR [\-s\ \fIspeed\fR] [\-p] [\-t] [\-D\ \fIdebuglevel\fR] \fIfile\-or\-serial\-port\fR
  35. .SH "DESCRIPTION"
  36. .PP
  37. gpscat
  38. is a simple program for logging and packetizing GPS data streams\&. It takes input from a specified file or serial device (presumed to have a GPS attached) and reports to standard output\&. The program runs until end of input or it is interrupted by ^C or other means\&. It does not terminate on a bad packet; this is intentional\&.
  39. .PP
  40. In raw mode (the default)
  41. gpscat
  42. simply dumps its input to standard output\&. Nonprintable characters other than ASCII whitespace are rendered as hexadecimal string escapes\&.
  43. .PP
  44. In packetizing mode,
  45. gpscat
  46. uses the same code as
  47. \fBgpsd\fR(8)\*(Aqs packet sniffer to break the input into packets\&. Packets are reported one per line; line breaks in the packets themselves are escaped\&.
  48. .PP
  49. This program is useful as a sanity checker when examining a new device\&. It can be used as a primitive NMEA logger, but beware that (a) interrupting it likely to cut off output in mid\-sentence, and (b) to avoid displaying incomplete NMEA sentences right up next to shell prompts that often contain a $, raw mode always emits an extra final linefeed\&.
  50. .PP
  51. Also, be aware that packetizing mode will produce useless results \(em probably consuming the entirety of input and appearing to hang \(em if it is fed data that is not a sequence of packets of one of the known types\&.
  52. .PP
  53. The program accepts the following options:
  54. .PP
  55. \-p
  56. .RS 4
  57. Invoke packetizer mode\&.
  58. .RE
  59. .PP
  60. \-s
  61. .RS 4
  62. Set the port\*(Aqs baud rate (and optionally its parity and stop bits) before reading\&. Argument should begin with one of the normal integer baud rates (300, 1200, 4800, 9600, 19200, 38400, etc\&.)\&. It may be followed by an optional suffix [NOE][12] to set parity (None, Odd, Even) and stop bits (1 or 2)\&.
  63. .RE
  64. .PP
  65. \-t
  66. .RS 4
  67. Invoke packetizer mode, with the packet type and length (in parentheses) reported before a colon and space on each line\&.
  68. .RE
  69. .PP
  70. \-D
  71. .RS 4
  72. In packetizer mode, enable progress messages from the packet getter\&. Probably only of interest to developers testing packet getter changes\&. Higher arguements to D produce more output\&.
  73. .RE
  74. .PP
  75. \-h
  76. .RS 4
  77. Display program usage and exit\&.
  78. .RE
  79. .PP
  80. Specifying \-s 4800N1 is frequently helpful with unknown devices\&.
  81. .SH "SEE ALSO"
  82. .PP
  83. \fBgpsd\fR(8),
  84. \fBgps\fR(1),
  85. \fBlibgps\fR(3),
  86. \fBlibgpsmm\fR(3),
  87. \fBgpsfake\fR(1)\&.
  88. \fBgpsprof\fR(1),
  89. \fBgpsctl\fR(1),
  90. \fBgpsdctl\fR(8),
  91. \fBgpsmon\fR(1)\&.
  92. .SH "AUTHOR"
  93. .PP
  94. Eric S\&. Raymond
  95. <esr@thyrsus\&.com>\&.