summaryrefslogtreecommitdiff
path: root/gps.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2010-01-13 02:48:06 +0000
committerEric S. Raymond <esr@thyrsus.com>2010-01-13 02:48:06 +0000
commit19178965f484ddc11eabf098ba4d436a5d7c684d (patch)
tree8d792367b6f76c86274fae66c6d3a05aa13580bb /gps.xml
parent28744833f7d899bdb110de593a3bfed003a503b7 (diff)
downloadgpsd-19178965f484ddc11eabf098ba4d436a5d7c684d.tar.gz
Improved client argument parsing to recognize IPv6 addresses...
...and do the right thing with suffixes. Teach the client library to connect using IPv6 when appropriate.
Diffstat (limited to 'gps.xml')
-rw-r--r--gps.xml37
1 files changed, 32 insertions, 5 deletions
diff --git a/gps.xml b/gps.xml
index 7007cf1a..3f709c3b 100644
--- a/gps.xml
+++ b/gps.xml
@@ -153,11 +153,38 @@ altitude and error estimates, kiliometers per hour in speeds). </para>
level; it is primarily for use by GPSD developers. It enables
various progress messages to standard error.</para>
-<para>An optional argument to any client 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 (or
-equivalent).</para>
+<para>By default, clients collect data from all compatible devices on
+localhost, using the defalt GPSD port 2947. An optional argument to any
+client 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 specific device name to be
+watched. However, if the server specification contains square
+brackets, the part inside them is taken as an IPv6 address and
+port/device suffixes are obnly parsed after the trailing bracket.
+Possible cases look like this:</para>
+
+<variablelist>
+<varlistentry>
+<term>localhost:/dev/ttyS1</term>
+<listitem><para>Look at the default port of localhost, trying both
+IPv4 and IPv6 and watching ouput from serial device 1.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>example.com:2317</term>
+<listitem><para>Look at port 2317 on example.com, trying both
+IPv4 and IPv6.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>71.162.241.5:2317:/dev/ttyS3</term>
+<listitem><para>Look at port 2317 at the specified IPv4
+address, collecting data from attached serial device 3.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5</term>
+<listitem><para>Look at port 2317 at the specified IPv6
+address, collecting data from attached serial device 5.</para></listitem>
+</varlistentry>
+</variablelist>
<para>Not all clients shipped with GPSD are documented here. See also
the separate manual pages for