summaryrefslogtreecommitdiff
path: root/gpsctl.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2009-02-07 07:54:17 +0000
committerEric S. Raymond <esr@thyrsus.com>2009-02-07 07:54:17 +0000
commit7a7c0568276dd09b91bca4ace86ffa0b58b18602 (patch)
tree1a2c4c01b7813321734da3ae22d9ec379b67680e /gpsctl.xml
parentf149cbc07c91d3f9b918fce546166837b729c251 (diff)
downloadgpsd-7a7c0568276dd09b91bca4ace86ffa0b58b18602.tar.gz
Make the tool time out if it can't open the device.
Diffstat (limited to 'gpsctl.xml')
-rw-r--r--gpsctl.xml32
1 files changed, 32 insertions, 0 deletions
diff --git a/gpsctl.xml b/gpsctl.xml
index e4a59ab6..105c72ab 100644
--- a/gpsctl.xml
+++ b/gpsctl.xml
@@ -126,6 +126,15 @@ its new speed.</para>
</varlistentry>
<varlistentry>
+<term>-T</term>
+<listitem>
+<para>Change the sampling timeout. Defaults to 3 seconds, which
+should always be sufficient to get a packet from a device emitting at
+the normal rate of 1 per second.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
<term>-h</term>
<listitem>
<para>Display program usage and exit.</para>
@@ -169,6 +178,29 @@ identifying the GPS type of the selected device and exit.</para>
</refsect1>
+<refsect1 id='examples'><title>EXAMPLES</title>
+
+<variablelist>
+<varlistentry>
+<term><command>gpsctl /dev/ttyUSB0</command></term>
+<listitem>
+<para>Attempt to identify the device on USB serial device 0. Time out
+after the default 3 seconds. Adding the <option>-f</option> will
+force low-level access and suppress the normal complaint when this
+tool can't find a GPSD to work through.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
+
<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,