summaryrefslogtreecommitdiff
path: root/gps.1
blob: 0ba4ae6b01a02b558867c87f060e4cc77a4161eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
.\" ** You probably do not want to edit this file directly **
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
.TH "GPS" "1" "10/31/2006" "9 Aug 2004" "9 Aug 2004"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
gps, xgps, xgpsspeed, cgps, cgpxlogger \- test clients for gpsd
.SH "SYNOPSIS"
.HP 5
\fBxgps\fR [\fIX\-options\fR] [\-h] [\-j] [\-V] [\-speedunits\ {[mph]\ [kph]\ [knots]}] [\-altunits\ {[feet]\ [meters]}] [\-l\ [[d]\ [m]\ [s]]] [\-s\ \fIsmoothing\fR] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
.HP 10
\fBxgpsspeed\fR [\-rv] [\fIX\-options\fR] [\-h] [\-V] [\-nc\ \fIX\-color\fR] [\-speedunits\ {[mph]\ [kph]\ [knots]}] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
.HP 5
\fBcgps\fR [\-h] [\-j] [\-V] [\-speedunits\ {[mph]\ [kph]\ [knots]}] [\-altunits\ {[feet]\ [meters]}] [\-l\ [[d]\ [m]\ [s]]] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
.HP 10
\fBgpxlogger\fR [\fIlogfile\fR]
.HP 11
\fBcgpxlogger\fR [\-s\ \fIgpsd\-server\fR] [\-p\ \fIgpsd\-port\fR] [\-i\ \fIpoll\-interval\fR] [\-h]
.SH "DESCRIPTION"
.SS "xgps"
.PP
xgps
is a simple test client for
gpsd
with an X interface. It displays current GPS position/time/velocity information and (for GPSes that support the feature) the locations of accessible satellites.
.PP
xgps
accepts an \-h option as for
gpsd, or a \-V option to dump the package version and exit.
.PP
An optional argument may specify a server to get data from; a colon\-separated suffix is taken as a port number. If there is a second colon\-separated suffix, that is taken as a device name to be handed to the daemon in an F= command.
.PP
The
\fB\-speedunits\fR
option can be used to set the speed units for display; follow the keyword with knots for nautical miles per hour, kph for kilometres per hour, or mph for miles per hour. The default is miles per hour. This option can also be set as the X resource 'speedunits'.
.PP
The
\fB\-altunits\fR
option can be used to set the altitude units for display; follow the keyword with 'meters' or 'feet'. The default is feet. This option can also be set as the X resource 'altunits'.
.PP
The
\fB\-j\fR
option tells the daemon to hold fix data across cycles, eliminating jitter from NMEA sevices that emit several partial reports (see the
\fB\-s\fR
for a client\-side way to do something similar).
.PP
The
\fB\-l\fR
option sets the format of latitude and longitude reports. The value 'd' produces decimal degrees and is the default. The value 'm' produces degrees and decimal minutes. The value 's' produces degrees, minutes, and decimal seconds.
.PP
There is a known bug in
xgps; it assumes the default font size is no more than 18 pixels. If this is not the case, the satellite data display will show fewer than 12 satellites.
.SS "xgpsspeed"
.PP
xgpsspeed
is a speedometer that uses position information from the GPS. It accepts an \-h option and optional argument as for
gps, or a \-V option to dump the package version and exit. Additionally, it accepts \-rv (reverse video) and \-nc (needle color) options.
.PP
The \-speedunits option can be used to set the speed units for display; follow the keyword with knots for nautical miles per hour, kph for kilometres per hour, or mph for miles per hour. The default is miles per hour. This option can also be set as the X resource 'speedunits'.
.SS "cgps"
.PP
cgps
is a client resembling
xgps, but without the pictorial satellite display and able to run on a serial terminal or terminal emulator.
.PP
The
\fB\-s\fR
option prevents
cgps
from printing the raw data. This display can also be toggled with the s command.
.PP
The
\fB\-j\fR
option tells the daemon not to clear data at start of cycle, eliminating jitter from NMEA sevices that emit several partial reports per cycle.
.PP
Rather than use X resources to determine which units to use,
cgps
looks at variables in its environment. Here are the variables and values it checks:
.sp
.nf
    GPSD_UNITS one of: 
              imperial   = miles/feet
              nautical   = knots/feet
              metric     = km/meters
    LC_MEASUREMENT
	      en_US      = miles/feet
              C          = miles/feet
              POSIX      = miles/feet
              [other]    = km/meters
    LANG
	      en_US      = miles/feet
              C          = miles/feet
              POSIX      = miles/feet
              [other]    = km/meters
.fi
.PP
cgps
terminates when you send it a SIGHUP or SIGINT; given default terminal settings this will happen when you type Ctl\-C at it. It will also terminate on 'q'
.PP
The 'j' command toggles whether or not fix data is cleared at start of cycle; see
\fBgpsd\fR(8)
for discussion.
.SS "cgpxlogger"
.PP
This program connects to gpsd, polls for location, and logs each fix to standard output in GPX (XML) format.
.PP
The program also writes start and end messages to syslog.
.SS "gpxlogger"
.PP
This program listens to DBUS broadcasts from gpsd (org.gpsd.fix) and logs each fix to standard output as they arrive in an XML format.
.PP
The output may be composed of multiple tracks. A new track is created if there's no fix for 5 seconds.
.PP
The program also writes start and end messages to syslog.
.SH "SEE ALSO"
.PP
\fBgpsd\fR(8),
\fBlibgps\fR(3),
\fBlibgpsd\fR(3),
\fBgpsprof\fR(1),
\fBgpsfake\fR(1).
.SH "AUTHORS"
.PP
Remco Treffcorn, Derrick Brashear, Russ Nelson & Eric S. Raymond(xgps). Jeff Francis (cgps). Amaury Jacquot
<sxpert@esitcom.org>
& Petter Reinholdtsen
<pere@hungry.com>
(gpxlogger). Chris Kuethe
<chris.kuethe@gmail.com>
(cgpxlogger).
.PP
This manual page by Eric S. Raymond
<esr@thyrsus.com>. There is a project page, with
xgps
screenshots, at
[1]\&\fIberlios.de\fR.
.SH "REFERENCES"
.TP 3
1.\ berlios.de
\%http://gpsd.berlios.de/