summaryrefslogtreecommitdiff
path: root/gpspipe.1
blob: 20c1e767000c29f475fe9d3b3173afb61b935af2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.\" ** You probably do not want to edit this file directly **
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
.TH "GPSPIPE" "1" "09/25/2006" "03 Aug 2005" "03 Aug 2005"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
gpspipe \- tool to connect to gpsd and retrieve sentences
.SH "SYNOPSIS"
.HP 8
\fBgpspipe\fR [\-h] [\-n\ \fIcount\fR] [\-r] [\-R] [\-s\ \fIserial\-device\fR] [\-t] [\-w] [\fIserver\fR [\fI:port\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. Presently it only connect to
gpsd
on the localhost on the default port (2947).
.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
An optional argument may specify a server to get data from; a colon\-separated suffix is taken as a port number.
.SH "OPTIONS"
.PP
\-h makes
gpspipe
print a usage message and exit.
.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.
.PP
\-w causes native
gpsdsentences to be output.
.PP
\-t adds a timestamp to each sentence output.
.PP
\-n [count] causes [count] sentences to be output.
gpspipe
will then exit gracefully.
.PP
\-V prints the version, then exits.
.PP
One or both or \-r and \-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 "AUTHOR"
.PP
Gary E. Miller
<gem@rellim.com>. There is a project page for
gpsd[1]\&\fIhere\fR.
.SH "REFERENCES"
.TP 3
1.\ here
\%http://gpsd.berlios.de/