summaryrefslogtreecommitdiff
path: root/gpsfake.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2013-11-04 00:26:50 -0500
committerEric S. Raymond <esr@thyrsus.com>2013-11-04 00:26:50 -0500
commit9ca6e492d50db21d26e696240e46a847c8ecadeb (patch)
treeac005033b557fc32a917eeb66226141757061b96 /gpsfake.xml
parentd6ceef308329790b4675bc4a10e2db879e0515da (diff)
downloadgpsd-9ca6e492d50db21d26e696240e46a847c8ecadeb.tar.gz
Document some magic comments.
Diffstat (limited to 'gpsfake.xml')
-rw-r--r--gpsfake.xml21
1 files changed, 21 insertions, 0 deletions
diff --git a/gpsfake.xml b/gpsfake.xml
index e2280d81..9d1f7a1f 100644
--- a/gpsfake.xml
+++ b/gpsfake.xml
@@ -177,6 +177,27 @@ port 5000 to the address 192.168.0.1.255. You can monitor them with
this: <command>tcpdump -s0 -n -A -i lo udp and port 5000</command>.</para>
</refsect1>
+<refsect1 id='magic'><title>MAGIC COMMENTS</title>
+
+<para>Certain magic comments in test load headers can change the
+conditions of the test. These are:</para>
+
+<variablelist>
+<varlistentry>
+<term>Serial:</term>
+<listitem><para>May contain a serial-port setting such as 4800 7N2 -
+baud rate followed by 7 or 8 for byte length, N or O or E for parity
+and 1 or 2 for stop bits. The test is run with those settings on the
+slave port that the daemon sees.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>Transport:</term>
+<listitem><para>Values 'TCP' and 'UDP' force the use of TCP and
+UDP feeds respectively (the default is a pty).</para></listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
<refsect1 id='custom'><title>CUSTOM TESTS</title>
<para><application>gpsfake</application> is a trivial wrapper around a