1GPS(1) GPSD Documentation GPS(1)
2
6 gps, xgps, xgpsspeed, cgps, lcdgps, gegps - test clients for gpsd
7
9 xgps [-D debug-level] [-h] [-V] [-l [[d] | [m] | [s]]]
10 [-u [[i] | [n] | [m]]] [server [:port [:device]]]
11 xgpsspeed [-D debug-level] [-h] [-V] [--nautical] [--landspeed]
13 [--speedunits {[mph] | [kph] | [knots]}] [server [:port
14 [:device]]]
15 cgps [-D debug-level] [-h] [-V] [-l [[d] | [m] | [s]]] [-m] [-s]
17 [-u [[i] | [n] | [m]]] [server [:port [:device]]]
18 lcdgps [-h] [-V] [-l [[d] | [m] | [s]]] [-u [[i] | [n] | [m]]] [server
20 [:port [:device]]]
21 gegps [-d directory] [-i]
23
25 These are the demonstration clients shipped with gpsd. They have some
26 common options:
27 The -h option causes each client to emit a summary of its options and
29 then exit.
30 The -V option causes each client to dump the package version and exit.
32 The -l option, when present, sets the format of latitude and longitude
34 reports. The value 'd' produces decimal degrees and is the default. The
35 value 'm' produces degrees and decimal minutes. The value 's' produces
36 degrees, minutes, and decimal seconds.
37 xgps, cgps, and lcdgps look at variables in the environment to figure
39 out what units they should default to using for display — imperial,
40 nautical, or metric. Here are the variables and values they check:
41 GPSD_UNITS one of:
43 imperial = miles/feet
44 nautical = knots/feet
45 metric = km/meters
46 LC_MEASUREMENT
47 en_US = miles/feet
48 C = miles/feet
49 POSIX = miles/feet
50 [other] = km/meters
51 LANG
52 en_US = miles/feet
53 C = miles/feet
54 POSIX = miles/feet
55 [other] = km/meters
56 These preferences may be overridden by the -u option.
58 Where present, the -u option can be used to set the system units for
60 display; follow the keyword with 'i' for 'imperial' for American units
61 (feet in altitude and error estimates, miles per hour in speeds), 'n'
62 for 'nautical' (feet in altitude and error estimates, knots in speed)
63 or 'm' for 'metric' (meters in altitude and error estimates, kilometers
64 per hour in speeds).
65 The -D option, when present, sets a debug level; it is primarily for
67 use by GPSD developers. It enables various progress messages to
68 standard error.
69 By default, clients collect data from all compatible devices on
71 localhost, using the default GPSD port 2947. An optional argument to
72 any client may specify a server to get data from. A colon-separated
73 suffix is taken as a port number. If there is a second colon-separated
74 suffix, that is taken as a specific device name to be watched. However,
75 if the server specification contains square brackets, the part inside
76 them is taken as an IPv6 address and port/device suffixes are only
77 parsed after the trailing bracket. Possible cases look like this:
78 localhost:/dev/ttyS1
80 Look at the default port of localhost, trying both IPv4 and IPv6
81 and watching output from serial device 1.
82 example.com:2317
84 Look at port 2317 on example.com, trying both IPv4 and IPv6.
85 71.162.241.5:2317:/dev/ttyS3
87 Look at port 2317 at the specified IPv4 address, collecting data
88 from attached serial device 3.
89 [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5
91 Look at port 2317 at the specified IPv6 address, collecting data
92 from attached serial device 5.
93 Not all clients shipped with GPSD are documented here. See also the
95 separate manual pages for gpspipe(1) and gpsmon(1) and gpxlogger(1) .
96 xgps
98 xgps is a simple test client for gpsd with an X interface. It displays
99 current GPS position/time/velocity information and (for GPSes that
100 support the feature) the locations of accessible satellites.
101 In the sky view, satellites are color-coded to indicate quality of
103 signal; consult the data display to the left for exact figures in dB.
104 Square icons indicate WAAS/EGNOS satellites, circles indicate ordinary
105 GPS satellites. Filled icons were used in the last fix, outline icons
106 were not.
107 xgpsspeed
109 xgpsspeed is a speedometer that uses position information from the GPS.
110 It accepts an -h option and optional argument as for gps, or a -V
111 option to dump the package version and exit.
112 The default display mode is a speed and track presentation modeled
114 after a marine navigation display; for backward compatibility the
115 --nautical option forces this mode. The --landspeed option produces a
116 simple speedometer.
117 The -speedunits option can be used to set the speed units for display;
119 follow the keyword with knots for nautical miles per hour, kph for
120 kilometres per hour, or mph for miles per hour. The default is miles
121 per hour.
122 In the nautical mode only, --maxspeed sets the maximum on the
124 speedometer.
125 cgps
127 cgps is a client resembling xgps, but without the pictorial satellite
128 display and able to run on a serial terminal or terminal emulator.
129 The -s option prevents cgps from displaying the data coming from the
131 daemon. This display can also be toggled with the s command.
132 The -m option will display your magnetic heading (as opposed to your
134 true heading). This is a calculated value, not a measured value, and is
135 subject to a potential error of up to two degrees in the areas for
136 which the calculation is valid (currently Western Europe, Alaska, and
137 Lower 48 in the USA). The formulas used are those found in the Aviation
138 Formulary v1.43.
139 cgps terminates when you send it a SIGHUP or SIGINT; given default
141 terminal settings this will happen when you type Ctrl-C at it. It will
142 also terminate on 'q'
143 lcdgps
145 A client that passes gpsd data to lcdproc, turning your car computer
146 into a very expensive and nearly feature-free GPS receiver. Currently
147 assumes a 4x40 LCD and writes data formatted to fit that size screen.
148 Also displays 4- or 6-character Maidenhead grid square output.
149 gegps
151 This program collects fixes from gpsd and feeds them to a running
152 instance of Google Earth for live location tracking.
153 The -d argument is the location of the Google Earth installation
155 directory. If not specified, it defaults to the current directory.
156 If you have the free (non-subscription) version, start by running with
158 the -i option to drop a clue in the Google Earth installation
159 directory, as 'Open_in_Google_Earth_RT_GPS.kml', then open that file in
160 Places (File > Open...). Run gpsd in the normal way after that.
161
163 gpsd(8), libgps(3), libgpsmm(3), gpsfake(1), gpsctl(1), gpscat(1),
164 gpsprof(1). gpspipe(1). gpsmon(1). gpxlogger(1).
165
167 Remco Treffcorn, Derrick Brashear, Russ Nelson & Eric S. Raymond, Jeff
168 Francis (cgps), Chen Wei <weichen302@aol.com> (gegps & xgpsspeed),
169 Robin Wittler <real@the-real.org> (xgpsspeed).
170 This manual page by Eric S. Raymond <esr@thyrsus.com>
172The GPSD Project 9 Aug 2004 GPS(1)