summaryrefslogtreecommitdiff
path: root/gpsctl.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2006-11-13 04:54:22 +0000
committerEric S. Raymond <esr@thyrsus.com>2006-11-13 04:54:22 +0000
commitccece899a712422cbee12d998244976458bb37bf (patch)
treeef6def7cfb5131c925cccf994e9f75af9e9efa16 /gpsctl.xml
parentfb82fe0952cf2016f1a646e55f680449a5fb56ff (diff)
downloadgpsd-ccece899a712422cbee12d998244976458bb37bf.tar.gz
Type-forcing option now works in gpsctl and is documented.
I have successfully used it to switch a SiRFStar I into binary mode.
Diffstat (limited to 'gpsctl.xml')
-rw-r--r--gpsctl.xml33
1 files changed, 33 insertions, 0 deletions
diff --git a/gpsctl.xml b/gpsctl.xml
index ffe745a3..dad4460e 100644
--- a/gpsctl.xml
+++ b/gpsctl.xml
@@ -22,7 +22,9 @@
<arg choice='plain'>-n</arg>
</group>
<arg choice='opt'>-f </arg>
+ <arg choice='opt'>-l </arg>
<arg choice='opt'>-s <replaceable>speed</replaceable></arg>
+ <arg choice='opt'>-t <replaceable>speed</replaceable></arg>
<arg choice='opt'>-D <replaceable>debuglevel</replaceable></arg>
<arg choice='opt'>-V </arg>
<arg choice='opt'><replaceable>serial-port</replaceable></arg>
@@ -71,6 +73,13 @@ its new speed.</para>
</varlistentry>
<varlistentry>
+<term>-l</term>
+<listitem>
+<para>List the known device types and exit..</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
<term>-s</term>
<listitem>
<para>Set the baud rate at which the GPS emits packets.</para>
@@ -78,6 +87,13 @@ its new speed.</para>
</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>
@@ -99,6 +115,23 @@ its new speed.</para>
</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>