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