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

NAME

6       gps - Overview of gpsd clients and helpers
7

SYNOPSIS

9       Clients:
10
11       cgps [OPTIONS] [server[:port[:device]]]
12
13       gegps [OPTIONS] [server[:port[:device]]]
14
15       gps2udp [OPTIONS] [server[:port[:device]]]
16
17       gpscsv [OPTIONS] [server[:port[:device]]]
18
19       gpsmon [OPTIONS] [server[:port[:device]]]
20
21       gpspipe [OPTIONS] [server[:port[:device]]]
22
23       gpsplot [OPTIONS] [server[:port[:device]]]
24
25       gpsprof [OPTIONS] [server[:port[:device]]]
26
27       gpsrinex [OPTIONS] [server[:port[:device]]]
28
29       gpssubframe [OPTIONS] [server[:port[:device]]]
30
31       gpxlogger [OPTIONS] [server[:port[:device]]]
32
33       lcdgps [OPTIONS] [server[:port[:device]]]
34
35       ubxtool [OPTIONS] [server[:port[:device]]]
36
37       xgps [OPTIONS] [server[:port[:device]]]
38
39       xgpsspeed [OPTIONS] [server[:port[:device]]]
40
41       zerk [OPTIONS] [server[:port[:device]]]
42
43       Helpers:
44
45       gpscat [OPTIONS] file-or-serial-port
46
47       gpsctl [OPTIONS]
48
49       gpsdctl action device
50
51       gpsdecode [OPTIONS]
52
53       gpsdebuginfo
54
55       gpsfake [OPTIONS]
56
57       gpsinit [OPTIONS]
58
59       ntpshmmon [OPTIONS]
60
61       ppscheck [OPTIONS] device
62

DESCRIPTION

64       gpsd is a daemon for managing GPS receivers, GNSS receivers, AIS
65       receivers, and more. Over time it has agglomerated a number of diverse
66       clients that communicate with gpsd for various tasks.
67
68   CLIENTS
69       Each of the gpsd clients connects to a gpsd daemon to use the data in
70       various ways. See the sections ARGUMENTS and OPTIONS for more
71       information on the clients.
72
73       cgps
74           curses terminal client for gpsd
75
76       gegps
77           Google Earth client for gpsd
78
79       gps
80           Overview of gpsd clients and helpers
81
82       gpscsv
83           dump the JSON output from gpsd as CSV
84
85       gpsdecode
86           decode GPS, RTCM or AIS streams into a readable format
87
88       gpsmon
89           real-time GPS packet monitor and control utility
90
91       gpspipe
92           tool to connect to gpsd and retrieve sentences
93
94       gpsplot
95           tool to dynamically dump plot data from gpsd
96
97       gpsprof
98           profile a GPS and gpsd, plotting latency information
99
100       gpsrinex
101           Read data from gpsd convert to RINEX3 and save to a file.
102
103       gpssubframe
104           tool to dump subframe sentences from gpsd
105
106       gpxlogger
107           Tool to connect to gpsd and generate a GPX file
108
109       lcdgps
110           LCD client for gpsd
111
112       xgps
113           X client for gpsd
114
115       xgpsspeed
116           X speedometer for gpsd
117
118   HELPERS
119       The gpsd helpers can be used for administration of gpsd systems.
120
121       gps2udp
122           feed the take from gpsd to one or more aggregation sites
123
124       gpscat
125           dump the output from a GPS
126
127       gpsctl
128           control the modes of a GNSS receiver
129
130       gpsdctl
131           tool for sending commands to gpsd over its control socket
132
133       gpsdebuginfo
134           Generate a gpsd debug dump of your host.
135
136       gpsfake
137           test harness for gpsd, simulating a GNSS receiver
138
139       gpsinit
140           initialize CAN kernel modules for GPSD
141
142       ntploggps
143           log gpsd data
144
145       ntpshmmon
146           capture samples from gpsd or other ntpd refclock sources
147
148   LIBRARIES
149       Programmers can find additional information on the gpsd here:
150
151       gpsd_json
152           gpsd request/response protocol
153
154       libgps
155           C service library for communicating with the GPS daemon
156
157       libgpsmm
158           C++ and QT class wrappers for the GPS daemon
159
160       libQgpsmm
161           C++ and QT class wrappers for the GPS daemon
162

OPTIONS

164       The gpsd clients share a few common options:
165
166       -?, -h, --help
167           Print a summary of options and then exit.
168
169       -V, --version
170           Print the package version and exit.
171

ARGUMENTS

173       By default, clients collect data from the local gpsd daemon running on
174       localhost, using the default GPSD port 2947. The optional argument to
175       any client may override this behavior:
176
177       [server[:port[:device]]]
178
179       server
180           The optional host name, IPv4 address, or IPv6 address of the gpsd
181           daemon to connect to. If the server specification contains square
182           brackets, the part inside them is taken as an IPv6 address and
183           port/device suffixes are only parsed after the trailing bracket.
184           The default is localhost.
185
186       port
187           The optional TCP port of the daemon to connect to. The default is
188           2947.
189
190       device
191           The optional device name to be watched.
192
193       Some possible cases look like this:
194
195       example.com
196           Connect to the default port 2497 on example.com, trying both IPv4
197           and IPv6.
198
199       example.com:2317
200           Look at port 2317 on example.com, trying both IPv4 and IPv6.
201
202       localhost::/dev/ttyS1
203           Look at the default port, 2947, of localhost, trying both IPv4 and
204           IPv6 and watching output from serial device 1.
205
206       71.162.241.5:2317:/dev/ttyS3
207           Look at port 2317 at the specified IPv4 address, collecting data
208           from attached serial device 3.
209
210       [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5
211           Look at port 2317 at the specified IPv6 address, collecting data
212           from attached serial device 5.
213

ENVIRONMENT

215       Most of the gpsd clients check for the environment variables
216       GPSD_UNITS, LC_MEASUREMENT, and LANG. Maybe more.
217
218       GPSD_UNITS is checked if no unit system is specified on the command
219       line. It may be set to 'i'. 'imperial', 'm', 'metric', or 'n',
220       'nautical'.
221
222       LC_MEASUREMENT and then LANG are checked if no unit system has been
223       specified on the command line, or in GPSD_UNITS. If the value is 'C',
224       'POSIX', or begins with 'en_US' the unit system is set to imperial. The
225       default if no system has been selected is metric.
226

RETURN VALUES

228       The gpsd clients return simple success or failure codes:
229
230       0
231           on success.
232
233       1
234           on failure
235

SEE ALSO

237       gegps(1), gpsctl(1), gpsdebuginfo(1), gpsprof*(1), gpsfake(1),
238       gpscat(1), gpspipe(1), gpsmon(1), xgps*(1). xgpsspeed(1)
239
240       libgps(3), libgpsmm(3)
241
242       gpsd(8)
243

RESOURCES

245       Project web site: https://gpsd.io/
246

COPYING

248       This file is Copyright 2013 by the GPSD project
249       SPDX-License-Identifier: BSD-2-clause
250
251
252
253GPSD Version 3.24                 2021-09-20                            GPS(1)