'\" t
.\"     Title: gpspipe
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 03 Aug 2005
.\"    Manual: GPSD Documentation
.\"    Source: The GPSD Project
.\"  Language: English
.\"
.TH "GPSPIPE" "1" "03 Aug 2005" "The GPSD Project" "GPSD Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gpspipe \- tool to connect to gpsd and retrieve sentences
.SH "SYNOPSIS"
.HP \w'\fBgpspipe\fR\ 'u
\fBgpspipe\fR [\-h] [\-d] [\-l] [\-o\ \fIfilename\fR] [\-n\ \fIcount\fR] [\-r] [\-R] [\-s\ \fIserial\-device\fR] [\-t] [\-T\ \fItimestamp\-format\fR] [\-u] [\-p] [\-w] [\-S] [\-2] [\-v] [\-D\ \fIdebug\-level\fR] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
.SH "DESCRIPTION"
.PP
gpspipe
is a tool to connect to
gpsd
and output the received sentences to stdout\&. This makes the program useful as a pipe from
gpsd
to another program or file\&.
.PP
gpspipe
does not require root privileges, and can be run concurrently with other tools connecting to the local
gpsd
without causing problems\&.
.PP
The output will consist of one or both of the raw NMEA or native
gpsd
sentences\&. Each line can be optionally time stamped\&. There is also an option to exit gracefully after a given count of packets\&.
.PP
Optionally a server, TCP/IP port number and remote device can be given\&. If omitted,
gpspipe
connects to localhost on the default port (2947) and watches all devices opened by
gpsd\&.
.PP
gpspipe
may be run as a daemon, but requires the \-o flag for writing the output to a file\&.
.SH "OPTIONS"
.PP
\-h makes
gpspipe
print a usage message and exit\&.
.PP
\-d causes
gpspipe
to run as a daemon\&.
.PP
\-l causes
gpspipe
to sleep for ten seconds before attempting to connect to gpsd\&. This is very useful when running as a daemon, giving gpsd time to start before attempting a connection\&.
.PP
\-r causes raw NMEA sentences to be output\&.
.PP
\-R causes super\-raw (gps binary) data to be output\&. This overrides NMEA and gpsd output modes\&.
.PP
\-s option causes the collected data to be written to the specified serial device with settings 4800 8N1\&. Thus
gpspipe
can be used with \-s and \-r options to emulate a serial port hardwired to a GPS that
gpsd
is managing\&.
.PP
\-o option causes the collected data to be written to the specified file\&. Use of this option is mandatory if
gpspipe
is run as a daemon\&.
.PP
\-w causes native
gpsdsentences to be output\&.
.PP
\-S sets the scaled flag\&.
.PP
\-2 sets the split24 flag on AIS reports\&. Note: this option is experimental and may be changed or removed in a future release\&.
.PP
\-t adds a timestamp to each sentence output\&.
.PP
\-T sets the format of the timestamp\&. See
\fBstrftime\fR(3)
for the available placeholders\&. Setting this option implies \-t\&. Default setting is "%F %T"
.PP
\-u usec resolution time stamp, implies \-t\&. Use \-uu to output sec\&.usec\&.
.PP
\-p enables dumping of profiling information in JSON\&.
.PP
\-P enables dumping of PPS drift JSON in NMEA and raw modes\&.
.PP
\-n [count] causes [count] sentences to be output\&.
gpspipe
will then exit gracefully\&.
.PP
\-v causes
gpspipe
to show a spinning activity indicator on stderr\&. This is useful if stdout is redirected into a file or a pipe\&. By default the spinner is advanced with every messages written; specifying \-v more than once will double the number of messages required to rotate the spinner\&.
.PP
\-V prints the version, then exits\&.
.PP
At least one of \-R, \-r or \-w must be specified\&.
.SH "EXAMPLE"
.PP
When
gpsd is running
\fBgpspipe \-r \-n 100\fR
will send one hundred raw NMEA sentences to standard output, then exit\&.
.SH "SEE ALSO"
.PP
\fBgpsd\fR(8),
\fBgps\fR(1),
\fBlibgps\fR(3),
\fBlibgpsmm\fR(3),
\fBgpsprof\fR(1),
\fBgpsfake\fR(1),
\fBgpsctl\fR(1),
\fBgpscat\fR(1)\&.
\fBgpsmon\fR(1)\&.
.SH "AUTHOR"
.PP
Gary E\&. Miller
<gem@rellim\&.com>\&.