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       -l FMT, --llfmt FMT
38           Sets the format of latitude and longitude reports. The value 'd'
39           produces decimal degrees and is the default. The value 'm' produces
40           degrees and decimal minutes. The value 's' produces degrees,
41           minutes, and decimal seconds.
42
43       -s, --silent
44           Prevents cgps from displaying the raw data coming from the daemon.
45           This display can also be toggled with the s command.
46
47       -m, --magtrack
48           Display your magnetic track (as opposed to your true track). This
49           is a calculated value, not a measured value. Magnetic variation is
50           always potentially subject to large errors, but is usually better
51           than two degrees.
52
53       -u UNITS, --units UNITS
54           Set the system units for display; follow the keyword with 'i' for
55           'imperial' for American units (International Feet in altitude and
56           error estimates, miles per hour in speeds), 'n' for 'nautical'
57           (feet in altitude and error estimates, knots in speed) or 'm' for
58           'metric' (meters in altitude and error estimates, kilometers per
59           hour in speeds).
60
61           Note: The USA Survey Foot is not supported.
62
63       -V, --version
64           Print the package version and 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

COMMANDS

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

ENVIRONMENT

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

RETURN VALUES

118       0
119           on success.
120
121       1
122           on failure
123

SEE ALSO

125       gegps(1), gpsctl(1), gps(1), gpsprof*(1), gpsfake(1), gpscat(1),
126       gpspipe(1), gpsmon(1), xgps*(1). xgpsspeed(1)
127
128       libgps(3), libgpsmm(3)
129
130       gpsd(8)
131

RESOURCES

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

COPYING

136       This file is Copyright 2013 by the GPSD project
137       SPDX-License-Identifier: BSD-2-clause
138
139
140
141GPSD Version 3.23.1               2021-09-03                           CGPS(1)
Impressum