1GPS(1) GPSD Documentation GPS(1)
2
6 gps, xgps, xgpsspeed, cgps, lcdgps - 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]
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 gpxlogger
23 gpxlogger [-D debug-level] [-h] [-V] [-i track timeout] [server [:port
25 [:device]]]
26
28 These are the demonstration clients shipped with gpsd. They have some
29 common options:
30 The -h option causes each client to emit a summary of its options and
32 then exit.
33 The -V option causes each client to dump the package version and exit.
35 The -l option, when present, sets the format of latitude and longitude
37 reports. The value ´d´ produces decimal degrees and is the default. The
38 value ´m´ produces degrees and decimal minutes. The value ´s´ produces
39 degrees, minutes, and decimal seconds.
40 xgps, cgps, and ldcgps look at variables in the environment to figure
42 out what units they should default to using for display — imperial,
43 nautical, or metric. Here are the variables and values they check:
44 GPSD_UNITS one of:
46 imperial = miles/feet
47 nautical = knots/feet
48 metric = km/meters
49 LC_MEASUREMENT
50 en_US = miles/feet
51 C = miles/feet
52 POSIX = miles/feet
53 [other] = km/meters
54 LANG
55 en_US = miles/feet
56 C = miles/feet
57 POSIX = miles/feet
58 [other] = km/meters
59 These preferences may be overridden by the -u option.
61 Where present, the -u option can be used to set the system units for
63 display; follow the keyword with ´i´ for ´imperial´ for American units
64 (feet in altitude and error estimates, miles per hour in speeds), ´n´
65 for ´nautical´ (feet in altitude and error estimates, knots in speed)
66 or ´m´ for ´metric´ (meters in altitude and error estimates,
67 kiliometers per hour in speeds).
68 The -D option, when present, sets a debug level; it is primarily for
70 use by GPSD developers. It enables various progress messages to
71 standard error.
72 By default, clients collect data from all compatible devices on
74 localhost, using the defalt GPSD port 2947. An optional argument to any
75 client may specify a server to get data from. A colon-separated suffix
76 is taken as a port number. If there is a second colon-separated suffix,
77 that is taken as a specific device name to be watched. However, if the
78 server specification contains square brackets, the part inside them is
79 taken as an IPv6 address and port/device suffixes are obnly parsed
80 after the trailing bracket. Possible cases look like this:
81 localhost:/dev/ttyS1
83 Look at the default port of localhost, trying both IPv4 and IPv6
84 and watching ouput from serial device 1.
85 example.com:2317
87 Look at port 2317 on example.com, trying both IPv4 and IPv6.
88 71.162.241.5:2317:/dev/ttyS3
90 Look at port 2317 at the specified IPv4 address, collecting data
91 from attached serial device 3.
92 [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5
94 Look at port 2317 at the specified IPv6 address, collecting data
95 from attached serial device 5.
96 Not all clients shipped with GPSD are documented here. See also the
98 separate manual pages for gpspipe(1) and gpsmon(1).
99 xgps
101 xgps is a simple test client for gpsd with an X interface. It displays
102 current GPS position/time/velocity information and (for GPSes that
103 support the feature) the locations of accessible satellites.
104 In the sky view, satellites are color-coded to indicate quality of
106 signal; consult the data display to the left for exact figures in dB.
107 Square icons indicate WAAS/EGNOS satellites, circles indicate ordinary
108 GPS satellites. Filled icons were used in the last fix, outline icons
109 were not.
110 xgpsspeed
112 xgpsspeed is a speedometer that uses position information from the GPS.
113 It accepts an -h option and optional argument as for gps, or a -V
114 option to dump the package version and exit.
115 The -speedunits option can be used to set the speed units for display;
117 follow the keyword with knots for nautical miles per hour, kph for
118 kilometres per hour, or mph for miles per hour. The default is miles
119 per hour.
120 cgps
122 cgps is a client resembling xgps, but without the pictorial satellite
123 display and able to run on a serial terminal or terminal emulator.
124 The -s option prevents cgps from displaying the raw data. This display
126 can also be toggled with the s command.
127 The -m option will display your magnetic heading (as opposed to your
129 true heading). This is a calculated value, not a measured value, and is
130 subject to a potential error of up to two degrees in the areas for
131 which the calculation is valid (currently Western Europe, Alaska, and
132 Lower 48 in the USA). The formulas used are those found in the Aviation
133 Formulary v1.43.
134 cgps terminates when you send it a SIGHUP or SIGINT; given default
136 terminal settings this will happen when you type Ctl-C at it. It will
137 also terminate on ´q´
138 lcdgps
140 A client that passes gpsd data to lcdproc, turning your car computer
141 into a very expensive and nearly feature-free GPS receiver. Currently
142 assumes a 4x40 LCD and writes data formatted to fit that size screen.
143 Also displays 4- or 6-character Maidenhead grid square output.
144 gpxlogger
146 This program collects fixes from gpsd and logs them to standard output
147 in GPX, an XML profile for track logging.
148 The output may be composed of multiple tracks. A new track is created
150 if there´s no fix for an interval specified by the -i and defaulting to
151 5 seconds.
152 If D-Bus support is available on the host and GPSD is configured to use
154 it, this program listens to DBUS broadcasts from gpsd. (org.gpsd.fix).
155 Otherwise, it uses a conventional socket connection.
156 Presence of a server-port-device specification forces use of sockets
158 even on a D-Bus capable system, though this is unlikely to be of
159 interest to anyone except GPSD developers.
160
162 gpsd(8), libgps(3), libgpsd(3), gpsfake(1), gpsctl(1), gpscat(1),
163 gpsprof(1). gpspipe(1). gpsmon(1).
164
166 Remco Treffcorn, Derrick Brashear, Russ Nelson & Eric S. Raymond, Jeff
167 Francis (cgps). Amaury Jacquot sxpert@sxpert.org & Petter Reinholdtsen
168 pere@hungry.com (gpxlogger). Chris Kuethe chris.kuethe@gmail.com
169 (cgpxlogger).
170 This manual page by Eric S. Raymond esr@thyrsus.com. There is a project
172 page, with xgps screenshots, at berlios.de[1].
173
175 1. berlios.de
176 http://gpsd.berlios.de/
177The GPSD Project 9 Aug 2004 GPS(1)