1GPSCAT(1)                     GPSD Documentation                     GPSCAT(1)
2
3
4

NAME

6       gpscat - dump the output from a GPS
7

SYNOPSIS

9       gpscat [OPTIONS] file-or-serial-port
10
11       gpscat -h
12
13       gpscat -V
14

DESCRIPTION

16       gpscat is a simple program for logging and packetizing GPS data
17       streams. It takes input from a specified file or serial device
18       (presumed to have a GPS attached) and reports to standard output. The
19       program runs until end of input or it is interrupted by ^C or other
20       means. It does not terminate on a bad packet; this is intentional.
21
22       In raw mode (the default) gpscat simply dumps its input to standard
23       output. Nonprintable characters other than ASCII whitespace are
24       rendered as hexadecimal string escapes.
25
26       In packetizing mode, gpscat uses the same code as gpsd(8)'s packet
27       sniffer to break the input into packets. Packets are reported one per
28       line; line breaks in the packets themselves are escaped.
29
30       This program is useful as a sanity checker when examining a new device.
31       It can be used as a primitive NMEA logger, but beware that (a)
32       interrupting it likely to cut off output in mid-sentence, and (b) to
33       avoid displaying incomplete NMEA sentences right up next to shell
34       prompts that often contain a $, raw mode always emits an extra final
35       linefeed.
36
37       Also, be aware that packetizing mode will produce useless results --
38       probably consuming the entirety of input and appearing to hang -- if it
39       is fed data that is not a sequence of packets of one of the known
40       types.
41

OPTIONS

43       The program accepts the following options:
44
45       -?, -h, --help
46           Display program usage and exit.
47
48       -D LVL, --debug LVL
49           In packetizer mode, enable progress messages from the packet
50           getter. Probably only of interest to developers testing packet
51           getter changes. Higher arguments to -D produce more output.
52
53       -p, --packetizer
54           Invoke packetizer mode.
55
56       -s SPEED, --speed SPEED
57           Set the port’s baud rate (and optionally its parity and stop bits)
58           to SPEED before reading. Argument should begin with one of the
59           normal integer baud rates (300, 1200, 4800, 9600, 19200, 38400,
60           etc.). It may be followed by an optional suffix [NOE][12] to set
61           parity (None, Odd, Even) and stop bits (1 or 2). Specifying -s
62           4800N1 is frequently helpful with unknown devices.
63
64       -t, --typeflag
65           Invoke packetizer mode, with the packet type and length (in
66           parentheses) reported before a colon and space on each line.
67
68       -V, --version
69           Display program version and exit.
70

RETURN VALUES

72       0
73           on success.
74
75       1
76           on failure
77

SEE ALSO

79       gpsd(8), gps(1), gpsfake(1). cgps(1)
80

RESOURCES

82       Project web site: https://gpsd.io/
83

COPYING

85       This file is Copyright 2013 by the GPSD project
86       SPDX-License-Identifier: BSD-2-clause
87

AUTHOR

89       Eric S. Raymond
90
91
92
93GPSD Version 3.24                 2021-09-20                         GPSCAT(1)