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

NAME

6       cgps - curses terminal client for gpsd
7

SYNOPSIS

9       cgps [OPTIONS] [server[:port[:device]]]
10
11       cgps -h
12
13       cgps -V
14

DESCRIPTION

16       cgps is an ncurses based gpsd client. It is able to run on a serial
17       terminal or terminal emulator. It resembles xgps(1), but without the
18       pictorial satellite display and does not require X or other windowing
19       system.
20
21       cgps does not require root privileges. It will also run fine as root.
22       Running under sudo will cause loss of functionality.
23
24       None of the error estimates provided by gpsd, and displayed by cgps,
25       should be taken as anything other than "goodness" levels. GNSS receiver
26       manufactures often do not document the basis for their estimates. Those
27       that do document their estimates are inconsistent about what they mean.
28

OPTIONS

30       -?, -h, --help
31           Print a summary of options and then exit.
32
33       -D LVL, --debug LVL
34           Sets the debug level; it is primarily for use by GPSD developers.
35           It enables various progress messages to standard error.
36
37       -i, --imu
38           Show IMU instead of fix and satellite data.
39
40       -l FMT, --llfmt FMT
41           Sets the format of latitude and longitude reports. The value 'd'
42           produces decimal degrees and is the default. The value 'm' produces
43           degrees and decimal minutes. The value 's' produces degrees,
44           minutes, and decimal seconds.
45
46       -m, --magtrack
47           Display tracks as magnetic, not true.
48
49       -m, --magtrack
50           Display your magnetic track (as opposed to your true track). This
51           is a calculated value, not a measured value. Magnetic variation is
52           always potentially subject to large errors, but is usually better
53           than two degrees.
54
55       -s, --silent
56           Prevents cgps from displaying the raw data coming from the daemon.
57           This display can also be toggled with the s command.
58
59       -u UNITS, --units UNITS
60           Set the system units for display; follow the keyword with 'i' for
61           'imperial' for American units (International Feet in altitude and
62           error estimates, miles per hour in speeds), 'n' for 'nautical'
63           (feet in altitude and error estimates, knots in speed) or 'm' for
64           'metric' (meters in altitude and error estimates, kilometers per
65           hour in speeds).
66
67           Note: The USA Survey Foot is not supported.
68
69       -V, --version
70           Print the package version and exit.
71

ARGUMENTS

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

COMMANDS

81       cgps terminates when you send it a SIGHUP or SIGINT; given default
82       terminal settings this will happen when you type Ctrl-C at it.
83
84       cgps will accept a few single letter commands while running:
85
86       c
87           Clear the bottom window.
88
89       d
90           Show lat/lon dd.dddddddd, dd mm.mmmmmm and dd mm ss.ssss
91
92       h
93           Popup a help window.
94
95       i
96           Use imperial units.
97
98       m
99           Use metric units.
100
101       n
102           Use nautical units.
103
104       q
105           Clear screen and exit
106
107       s
108           Toggle showing raw JSON data in the bottom window.
109
110       t
111           Toggle true/magnetic track.
112

ENVIRONMENT

114       The environment variable GPSD_UNITS is checked if no unit system is
115       specified on the command line. It may be set to 'i'. 'imperial', 'm',
116       'metric', or 'n', 'nautical'.
117
118       LC_MEASUREMENT and then LANG are checked if no unit system has been
119       specified on the command line, or in GPSD_UNITS. If the value is 'C',
120       'POSIX', or begins with 'en_US' the unit system is set to imperial. The
121       default if no system has been selected defaults to metric.
122

RETURN VALUES

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

SEE ALSO

131       gegps(1), gpsctl(1), gps(1), gpsprof*(1), gpsfake(1), gpscat(1),
132       gpspipe(1), gpsmon(1), xgps*(1). xgpsspeed(1)
133
134       libgps(3), libgpsmm(3)
135
136       gpsd(8)
137

RESOURCES

139       Project web site: https://gpsd.io/
140

COPYING

142       This file is Copyright 2013 by the GPSD project
143       SPDX-License-Identifier: BSD-2-clause
144
145
146
147GPSD Version 3.25                 2023-01-10                           CGPS(1)
Impressum