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

NAME

6       cgps, gegps, gps, lcdgps, xgps, xgpsspeed - test clients for gpsd
7

SYNOPSIS

9       cgps [-D debug-level] [-h] [-l [[d] | [m] | [s]]] [-m] [-s]
10            [-u [[i] | [n] | [m]]] [-V] [server [:port [:device]]]
11
12       gegps [-d directory] [-h] [-i] [-V]
13
14       lcdgps [-h] [-j] [-l [[d] | [m] | [s]]] [-s] [-u [[i] | [n] | [m]]]
15              [-V] [server [:port [:device]]]
16
17       xgps [-?] [-D debug-level] [-h] [-l [[d] | [m] | [s]]]
18            [-u [[i] | [n] | [m]]] [-r degrees] [-V] [server [:port
19            [:device]]]
20
21       xgpsspeed [--debug debug-level] [--device device] [-h] [--host host]
22                 [--landspeed] [--maxspeed maxspeed] [--nautical]
23                 [--port port] [--speedunits {[mph] | [kph] | [knots]}] [-V]
24                 [server [:port [:device]]]
25

DESCRIPTION

27       These are the demonstration clients shipped with gpsd. They have some
28       common options:
29
30       The -h option causes each client to emit a summary of its options and
31       then exit.
32
33       The -V option causes each client to dump the package version and exit.
34
35       The -l option, when present, sets the format of latitude and longitude
36       reports. The value 'd' produces decimal degrees and is the default. The
37       value 'm' produces degrees and decimal minutes. The value 's' produces
38       degrees, minutes, and decimal seconds.
39
40       xgps, cgps, and lcdgps look at variables in the environment to figure
41       out what units they should default to using for display — imperial,
42       nautical, or metric. Here are the variables and values they check:
43
44               GPSD_UNITS one of:
45                         imperial   = miles/feet
46                         nautical   = knots/feet
47                         metric     = km/meters
48               LC_MEASUREMENT
49                      en_US      = miles/feet
50                         C          = miles/feet
51                         POSIX      = miles/feet
52                         [other]    = km/meters
53               LANG
54                      en_US      = miles/feet
55                         C          = miles/feet
56                         POSIX      = miles/feet
57                         [other]    = km/meters
58
59       These preferences may be overridden by the -u option.
60
61       Where present, the -u option can be used to set the system units for
62       display; follow the keyword with 'i' for 'imperial' for American units
63       (International Feet in altitude and error estimates, miles per hour in
64       speeds), 'n' for 'nautical' (feet in altitude and error estimates,
65       knots in speed) or 'm' for 'metric' (meters in altitude and error
66       estimates, kilometers per hour in speeds).
67
68       Note: The USA Survey Foot is not supported.
69
70       The -D option, when present, sets a debug level; it is primarily for
71       use by GPSD developers. It enables various progress messages to
72       standard error.
73
74       By default, clients collect data from all compatible devices on
75       localhost, using the default GPSD port 2947. An optional argument to
76       any client may specify a server to get data from. A colon-separated
77       suffix is taken as a port number. If there is a second colon-separated
78       suffix, that is taken as a specific device name to be watched. However,
79       if the server specification contains square brackets, the part inside
80       them is taken as an IPv6 address and port/device suffixes are only
81       parsed after the trailing bracket. Possible cases look like this:
82
83       The options for xgps can be placed in the XGPSOPTS environment
84       variable. XGPSOPTS is processed before the CLI options.
85
86       localhost:/dev/ttyS1
87           Look at the default port of localhost, trying both IPv4 and IPv6
88           and watching output from serial device 1.
89
90       example.com:2317
91           Look at port 2317 on example.com, trying both IPv4 and IPv6.
92
93       71.162.241.5:2317:/dev/ttyS3
94           Look at port 2317 at the specified IPv4 address, collecting data
95           from attached serial device 3.
96
97       [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5
98           Look at port 2317 at the specified IPv6 address, collecting data
99           from attached serial device 5.
100
101       Not all clients shipped with GPSD are documented here. See also the
102       separate manual pages for gpspipe(1) and gpsmon(1) and gpxlogger(1) .
103
104   xgps
105       xgps is a simple test client for gpsd with an X interface. It displays
106       current GPS position/time/velocity information and (for GPSes that
107       support the feature) the locations of accessible satellites.
108
109       In the sky view, satellites are color-coded to indicate quality of
110       signal; consult the data display to the left for exact figures in dB.
111       Square icons indicate SBAS/WAAS/EGNOS satellites, circles indicate
112       ordinary GPS satellites. Filled icons were used in the current fix,
113       outline icons were not.
114
115       The -r option accepts an argument in degrees, to rotate the skyview
116       counterclockwise.
117
118   xgpsspeed
119       xgpsspeed is a speedometer that uses position information from the GPS.
120       It accepts an -h option and optional argument as for gps, or a -V
121       option to dump the package version and exit.
122
123       The default display mode is a speed and track presentation modeled
124       after a marine navigation display; for backward compatibility the
125       --nautical option forces this mode. The --landspeed option produces a
126       simple speedometer.
127
128       The -speedunits option can be used to set the speed units for display;
129       follow the keyword with knots for nautical miles per hour, kph for
130       kilometres per hour, or mph for miles per hour. The default is miles
131       per hour.
132
133       In the nautical mode only, --maxspeed sets the maximum on the
134       speedometer.
135
136   cgps
137       cgps is a client resembling xgps, but without the pictorial satellite
138       display and able to run on a serial terminal or terminal emulator.
139
140       The -s option prevents cgps from displaying the data coming from the
141       daemon. This display can also be toggled with the s command.
142
143       The -m option will display your magnetic track (as opposed to your true
144       track). This is a calculated value, not a measured value. Magnetic
145       variation is always potentially subject to large errors, but is usually
146       better than two degrees.
147
148       cgps terminates when you send it a SIGHUP or SIGINT; given default
149       terminal settings this will happen when you type Ctrl-C at it. It will
150       also terminate on 'q'
151
152   lcdgps
153       A client that passes gpsd data to lcdproc, turning your car computer
154       into a very expensive and nearly feature-free GPS receiver. Currently
155       assumes a 4x40 LCD and writes data formatted to fit that size screen.
156       Also displays 4- or 6-character Maidenhead grid square output.
157
158   gegps
159       This program collects fixes from gpsd and feeds them to a running
160       instance of Google Earth for live location tracking.
161
162       The -d argument is the location of the Google Earth installation
163       directory. If not specified, it defaults to the current directory.
164
165       If you have the free (non-subscription) version, start by running with
166       the -i option to drop a clue in the Google Earth installation
167       directory, as 'Open_in_Google_Earth_RT_GPS.kml', then open that file in
168       Places (File > Open...). Run gegps in the normal way after that.
169

ENVIRONMENT

171       The XGPSOPTS> environment variable may be set to pass commonly used
172       command line options to xgps and xgpsspeed. This is often used to set
173       the -u option for locale specific units.  XGPSOPTS is processed before
174       the CLI options.
175

SEE ALSO

177       gpsd(8), libgps(3), libgpsmm(3), gpsfake(1), gpsctl(1), gpscat(1),
178       gpsprof(1).  gpspipe(1).  gpsmon(1).  gpxlogger(1).
179

AUTHORS

181       Remco Treffcorn, Derrick Brashear, Russ Nelson & Eric S. Raymond, Jeff
182       Francis (cgps), Chen Wei <weichen302@aol.com> (gegps & xgpsspeed),
183       Robin Wittler <real@the-real.org> (xgpsspeed).
184
185       This manual page by Eric S. Raymond <esr@thyrsus.com>
186
187
188
189The GPSD Project                  9 Aug 2004                            GPS(1)
Impressum