xgps(1) - f37

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

NAME

6       xgps - X client for gpsd
7

SYNOPSIS

9       xgps [OPTIONS] [service[:port[:device]]]
10
11       xgps -h
12
13       xgps -V
14

DESCRIPTION

16       xgps is a simple sample client for gpsd with an X interface. It
17       displays current GNSS position/time/velocity information and (for GNSS
18       receivers that support the feature) the locations of accessible
19       satellites.
20
21       In the sky view, satellites are color-coded to indicate quality of
22       signal, consult the data display to the left for exact figures in dB.
23       Diamond-shaped icons indicate GLONASS satellites, squares are used for
24       SBAS (e.g. WAAS, EGNOS), circles indicate GPS, and down-, up-, right-,
25       and left-pointing triangles, respectively, indicate Galileo, BeiDou,
26       QZSS, and other systems' satellites (e.g. IMES, IRNSS, as well as
27       unknown systems). Filled icons were used in the current fix, outline
28       icons were not. Hovering over a symbol with the mouse pointer will
29       temporarily display a small popup window with the satellite details
30       from the Satellite List pane.
31
32       xgps will run fine as a normal user, and fine as root. Running xgps
33       under sudo will cause some loss of functionality.
34

OPTIONS

36       -?, -h, --help
37           Causes the client to emit a summary of its options and then exit.
38
39       -device DEVICE
40           The device on the host to connect to. The default is empty (any).
41
42       -D LVL, --debug LVL
43           Sets the debug level, it is primarily for use by GPSD developers.
44           It enables various progress messages to standard error.
45
46       --host HOST
47           The host (server) to connect to. The default is localhost.
48
49       -l FMT, --llfmt FMT
50           Set the format of latitude and longitude reports. The value 'd'
51           produces decimal degrees and is the default. The value 'm' produces
52           degrees and decimal minutes. The value 's' produces degrees,
53           minutes, and decimal seconds.
54
55       -p PORT, --port PORT
56           The port to connect to. The default is 2947.
57
58       -r DEG, --rotate DEG
59           Accepts an argument in degrees, to rotate the skyview
60           counterclockwise.
61
62       -V, --version
63           This option causes each client to dump the package version and
64           exit.
65

ARGUMENTS

67       By default, clients collect data from the local gpsd daemon running on
68       localhost, using the default GPSD port 2947. The optional argument to
69       any client may override this behavior: [server[:port[:device]]]
70
71       For further explanation, and examples, see the ARGUMENTS section in the
72       gps(1) man page
73

ENVIRONMENT

75       The XGPSOPTS> environment variable may be set to pass commonly used
76       command line options to xgps. This is often used to set the -u option
77       for locale specific units. XGPSOPTS is processed before the CLI
78       options.
79
80       xgps also looks at other variables in the environment to figure out the
81       units for display — imperial, nautical, or metric. Here are the
82       variables and values checked:
83
84               GPSD_UNITS one of:
85                         i          = miles/feet
86                         imperial   = miles/feet
87                         n          = knots/feet
88                         nautical   = knots/feet
89                         m          = km/meters
90                         metric     = km/meters
91               LC_MEASUREMENT
92                         en_US      = miles/feet
93                         C          = miles/feet
94                         POSIX      = miles/feet
95                         [other]    = km/meters
96               LANG
97                         en_US      = miles/feet
98                         C          = miles/feet
99                         POSIX      = miles/feet
100                         [other]    = km/meters
101
102       These preferences may be overridden by the -u, or --units option.
103
104       The -u option can be used to set the system units for display; follow
105       the keyword with 'i' for 'imperial' for American units (International
106       Feet in altitude and error estimates, miles per hour in speeds), 'n'
107       for 'nautical' (feet in altitude and error estimates, knots in speed)
108       or 'm' for 'metric' (meters in altitude and error estimates, kilometers
109       per hour in speeds).
110
111       Note: The USA Survey Foot is not supported.
112
113       The environment variable GPSD_UNITS is checked if no unit system is
114       specified on the command line or in XPGSOPTS it may be set to 'i'.
115       'imperial', 'm', 'metric', or 'n', 'nautical'.
116
117       LC_MEASUREMENT and then LANG are checked if no unit system has been
118       specified on the command line, in XPGSOPTS or in GPSD_UNITS. If the
119       value is 'C', 'POSIX', or begins with 'en_US' the unit system is set to
120       imperial. The default if no system has been selected defaults to
121       metric.
122

RETURN VALUES

124       0
125           on success.
126
127       1
128           on failure
129

RESOURCES

134       Project web site: https://gpsd.io/
135

COPYING

137       This file is Copyright 2013 by the GPSD project
138       SPDX-License-Identifier: BSD-2-clause
139

AUTHORS

141       Remco Treffcorn
142
143       Derrick Brashear
144
145       Russ Nelson
146
147       Eric S. Raymond
148
149
150
151GPSD, Version 3.24                2021-09-20                           XGPS(1)