1XGPS(1) GPSD Documentation XGPS(1)
2
6 xgps, xgpsspeed - sample clients for gpsd
7
9 xgps [-?] [--help] [--debug DEBUG-LEVEL] [--device DEVICE]
10 [--host HOST] [--llfmt [[d] | [m] | [s]]] [--port PORT]
11 [--rotate DEGREES] [--sats NSATS] [--units [[i] | [n] | [m]]]
12 [--version] [-D LVL] [-h] [-l [[d] | [m] | [s]]] [-r DEGREES]
13 [-s NSATS] [-u [[i] | [n] | [m]]] [-V] [server [:port [:device]]]
14 xgpsspeed [-?] [--debug DEBUG-LEVEL] [--device DEVICE] [--help]
16 [--host HOST] [--landspeed] [--maxspeed MAXSPEED]
17 [--nautical] [--port PORT] [--rotate DEGREES]
18 [--speedunits {[mph] | [kmh] | [knots]}] [--version] [-D LVL]
19 [-h] [-r DEGREES] [-V] [server [:port [:device]]]
20
22 These are two sample clients shipped with gpsd. They have some common
23 options:
24 -?, -h, --help
26 Causes the client to emit a summary of its options and then exit.
27 -device DEVICE
29 The device on the host to connect to. The default is empty (any).
30 -D LVL, --debug LVL
32 Sets the debug level; it is primarily for use by GPSD developers.
33 It enables various progress messages to standard error.
34 --host HOST
36 The host (server) to connect to. The default is localhost.
37 -p PORT, --port PORT
39 The port to connect to. The default is 2947.
40 -V, --version
42 The -V, --version option causes each client to dump the package
43 version and exit.
44 By default, clients collect data from all compatible devices on
46 localhost, using the default GPSD port 2947. An optional argument to
47 any client may specify a server to get data from. A colon-separated
48 suffix is taken as a port number. If there is a second colon-separated
49 suffix, that is taken as a specific device name to be watched. However,
50 if the server specification contains square brackets, the part inside
51 them is taken as an IPv6 address and port/device suffixes are only
52 parsed after the trailing bracket. Possible cases look like this:
53 The options for xgps can be placed in the XGPSOPTS environment
55 variable. XGPSOPTS is processed before the CLI options.
56 localhost:/dev/ttyS1
58 Look at the default port of localhost, trying both IPv4 and IPv6
59 and watching output from serial device 1.
60 example.com:2317
62 Look at port 2317 on example.com, trying both IPv4 and IPv6.
63 71.162.241.5:2317:/dev/ttyS3
65 Look at port 2317 at the specified IPv4 address, collecting data
66 from attached serial device 3.
67 [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5
69 Look at port 2317 at the specified IPv6 address, collecting data
70 from attached serial device 5.
71 xgps
73 xgps is a simple sample client for gpsd with an X interface. It
74 displays current GPS position/time/velocity information and (for GPSes
75 that support the feature) the locations of accessible satellites.
76 In the sky view, satellites are color-coded to indicate quality of
78 signal; consult the data display to the left for exact figures in dB.
79 Diamond-shaped icons indicate GLONASS satellites, squares are used for
80 SBAS (e.g. WAAS, EGNOS), circles indicate GPS, and down-, up-, right-,
81 and left-pointing triangles, respectively, indicate Galileo, BeiDou,
82 QZSS, and other systems' satellites (e.g. IMES, IRNSS, as well as
83 unknown systems). Filled icons were used in the current fix, outline
84 icons were not. Hovering over a symbol with the mouse pointer will
85 temporarily display a small popup window with the satellite details
86 from the Satellite List pane.
87 -l FMT, --llfmt FMT
89 Set the format of latitude and longitude reports. The value 'd'
90 produces decimal degrees and is the default. The value 'm' produces
91 degrees and decimal minutes. The value 's' produces degrees,
92 minutes, and decimal seconds.
93 -r DEG, --rotate DEG
95 Accepts an argument in degrees, to rotate the skyview
96 counterclockwise.
97 xgps looks at variables in the environment to figure out the units for
99 display — imperial, nautical, or metric. Here are the variables and
100 values checked:
101 GPSD_UNITS one of:
103 i = miles/feet
104 imperial = miles/feet
105 n = knots/feet
106 nautical = knots/feet
107 m = km/meters
108 metric = km/meters
109 LC_MEASUREMENT
110 en_US = miles/feet
111 C = miles/feet
112 POSIX = miles/feet
113 [other] = km/meters
114 LANG
115 en_US = miles/feet
116 C = miles/feet
117 POSIX = miles/feet
118 [other] = km/meters
119 These preferences may be overridden by the -u, --units option.
121 The -u option can be used to set the system units for display; follow
123 the keyword with 'i' for 'imperial' for American units (International
124 Feet in altitude and error estimates, miles per hour in speeds), 'n'
125 for 'nautical' (feet in altitude and error estimates, knots in speed)
126 or 'm' for 'metric' (meters in altitude and error estimates, kilometers
127 per hour in speeds).
128 Note: The USA Survey Foot is not supported.
130 xgpsspeed
132 xgpsspeed is a speedometer that uses position information from the GPS.
133 The default display mode is a speed and track presentation modeled
135 after a marine navigation display; for backward compatibility the
136 --nautical option forces this mode. The --landspeed option produces a
137 simple speedometer.
138 The --speedunits option can be used to set the speed units for display;
140 follow the keyword with "knots" for nautical miles per hour, "kmh" for
141 kilometers per hour, or "mph" for miles per hour. The default is miles
142 per hour.
143 In the nautical mode only, --maxspeed sets the maximum on the
145 speedometer.
146
148 The environment variable GPSD_UNITS is checked if no unit system is
149 specified on the command line or in XPGSOPTS it may be set to 'i'.
150 'imperial', 'm', 'metric', or 'n', 'nautical'.
151 LC_MEASUREMENT and then LANG are checked if no unit system has been
153 specified on the command line, in XPGSOPTS or in GPSD_UNITS. If the
154 value is 'C', 'POSIX', or begins with 'en_US' the unit system is set to
155 imperial. The default if no system has been selected defaults to
156 metric.
157 The XGPSOPTS> environment variable may be set to pass commonly used
159 command line options to xgps and xgpsspeed. This is often used to set
160 the -u option for locale specific units. XGPSOPTS is processed before
161 the CLI options.
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, Chen
169 Wei <weichen302@aol.com> (xgpsspeed), Robin Wittler <real@the-real.org>
170 (xgpsspeed).
171 This manual page by Eric S. Raymond <esr@thyrsus.com>
173The GPSD Project 6 December 2020 XGPS(1)