summaryrefslogtreecommitdiff
path: root/gpspipe.1
blob: f75ebc7e3cbb8c58b0c597d5d3693f522741d206 (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
74
75
76
77
78
79
80
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "GPSPIPE" 1 "" "" ""
.SH NAME
gpspipe \- tool to connect to gpsd and retrieve sentences
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 8
\fBgpspipe\fR [\-h] [\-n\ \fIcount\fR] [\-r] [\-s\ \fIserial\-device\fR] [\-t] [\-w] [\fIserver\fR [\fI:port\fR]]
.ad
.hy

.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
\-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  here: \fIhttp://gpsd.berlios.de/\fR\&.