summaryrefslogtreecommitdiff
path: root/gpsfake.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2011-07-22 08:21:23 -0400
committerEric S. Raymond <esr@thyrsus.com>2011-07-22 08:21:23 -0400
commit5706bd2373f57680a61fe94d62ea70b1b42cfefb (patch)
tree83afc9380bacac1eb8e5af22b30987f5fee0b048 /gpsfake.xml
parentb55a205776e2e8a3462fac9b770d6815beda32c7 (diff)
downloadgpsd-5706bd2373f57680a61fe94d62ea70b1b42cfefb.tar.gz
In gpsfake, remove an unused feature and document what's there.
All regression tests pass.
Diffstat (limited to 'gpsfake.xml')
-rw-r--r--gpsfake.xml24
1 files changed, 21 insertions, 3 deletions
diff --git a/gpsfake.xml b/gpsfake.xml
index b611bd61..3617d9bb 100644
--- a/gpsfake.xml
+++ b/gpsfake.xml
@@ -59,9 +59,27 @@ interleaved in the order the files are specified.</para>
privileges, and can be run concurrently with a production
<application>gpsd</application> instance without causing problems.</para>
-<para>The logfiles may be of NMEA, SiRF packets, TSIP packets, or
-Zodiac packets. Leading lines beginning with # will be treated as
-comments and ignored.</para>
+<para>The logfiles may contain packets in any supported format,
+including in particular NMEA, SiRF, TSIP, or Zodiac. Leading lines
+beginning with # will be treated as comments and ignored, except in
+the following special cases:</para>
+
+<itemizedlist>
+<listitem><para>
+a comment of the form #Date: yyyy-mm-dd (ISO8601 date format) may be
+used to set the initial date for the log.
+</para></listitem>
+
+<listitem><para>
+a comment of the form #Serial: [0-9]* [78][NOE][12] may be used to set
+serial parameters for the log - baud rate, word length, stop bits.
+</para></listitem>
+
+<listitem><para>
+a comment of the form #Transport: UDP may be used to fake a UDP source
+rather than the normal pty.
+</para></listitem>
+</itemizedlist>
<para>The <application>gpsd</application> instance is run in
foreground. The thread sending fake GPS data to the daemon