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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.1.2//EN"
"docbook/docbookx.dtd">
<refentry id='gpsctl.1'>
<refmeta>
<refentrytitle>gpsctl</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>29 Oct 2006</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>gpsctl</refname>
<refpurpose>control the modes of a GPS</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>gpsctl</command>
<arg choice='opt'>-h </arg>
<group>
<arg choice='plain'>-b</arg>
<arg choice='plain'>-n</arg>
</group>
<arg choice='opt'>-c <replaceable>control</replaceable></arg>
<arg choice='opt'>-e </arg>
<arg choice='opt'>-f </arg>
<arg choice='opt'>-l </arg>
<arg choice='opt'>-s <replaceable>speed</replaceable></arg>
<arg choice='opt'>-t <replaceable>devicetype</replaceable></arg>
<arg choice='opt'>-D <replaceable>debuglevel</replaceable></arg>
<arg choice='opt'>-V </arg>
<arg choice='opt'><replaceable>serial-port</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>DESCRIPTION</title>
<para><application>gpsctl</application> can switch a dual-mode GPS
between NMEA and vendor-binary modes. It can also be used to set the
device baudrate. Note: Not all devices have these capabilities.</para>
<para>If you have only one GPS attached to your machine, and gpsd is
running, it is not necessary to specify the device;
<application>gpsctl</application> does its work through
<application>gpsd</application>, which will locate it for you.</para>
<para>When <application>gpsd</application> is not running, the device
specification is required, and you will almost certainly need to be
running as root in order to have write access to the device.</para>
<para>The program accepts the following options:</para>
<variablelist remap='TP'>
<varlistentry>
<term>-b</term>
<listitem>
<para>Put the GPS into binary mode. After the GPS resets itself, autobaud to
the new speed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-c</term>
<listitem>
<para>Send a specified control string to the GPS;
<application>gpsctl</application> will provide packet headers and
trailers and checksum as appropriate for binary packet types, and
whatever checksum and trailer is required for text packet types. (You
must include the leading $ for NMEA packets.) C-style backslash
escapes in the string, notably \xNN for hex, will be interpreted;
additionally, \e will be replaced with ESC. This switch implies
<option>-f</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-e</term>
<listitem>
<para>Generate the packet from any other arguments specified and ship
it to standard output instead of the device. This switch can be used
with the <option>-t</option> option without specifying a device. Note:
the packet data for a binary prototype will be raw, not ASCII-ized in
any way.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f</term>
<listitem>
<para>Force low-level access (not through the daemon).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-l</term>
<listitem>
<para>List the known device types and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-n</term>
<listitem>
<para>Put GPS into NMEA mode. After the GPS resets itself autobaud to
its new speed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s</term>
<listitem>
<para>Set the baud rate at which the GPS emits packets.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-t</term>
<listitem>
<para>Force the device type.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-h</term>
<listitem>
<para>Display program usage and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-D</term>
<listitem>
<para>Set level of debug messages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-V</term>
<listitem>
<para>Display program version and exit.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The argument of the forcing option. <option>-t</option>, should be a
string which should be contained in exactly one of the known driver
names; for a list, do <command>gpsctl -l</command>.</para>
<para>Forcing the device type behaves somewhat differently depending
on whether this tool is going through the daemon or not. In high-level
mode, if the device that daemon selects for you doesn't match the
driver you specified, <application>gpsctl</application> exits with
a warning. (This may be useful in scripts.)</para>
<para>In low-level mode, if the device identifies as a Generic NMEA,
use the selected driver instead. This will be useful if you have a
GPS device of known type that is in NMEA mode and not responding to
probes. (This option was originally implemented for talking to
SiRFStar I chips, which don't respond to the normal SiRF ID
probe.)</para>
<para>If no options are given, the program will display a message
identifying the GPS type of the selected device and exit.</para>
</refsect1>
<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgpsd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsprof</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsfake</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
</refsect1>
<refsect1 id='maintainer'><title>AUTHOR</title>
<para>Eric S. Raymond <email>esr@thyrsus.com</email>. There is a
project page for <application>gpsd</application> <ulink
url="http://gpsd.berlios.de/">here</ulink>.</para>
</refsect1>
</refentry>
|
