summaryrefslogtreecommitdiff
path: root/gpsfake.xml
blob: 1f92032c3e2dc5e09228619f7bcf96590fb446aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC 
   "-//OASIS//DTD DocBook XML V4.1.2//EN"
   "docbook/docbookx.dtd">
<refentry id='gpsfake.1'>
<refmeta>
<refentrytitle>gpsfake</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>12 Feb 2005</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>gpsfake</refname>
<refpurpose>test harness for gpsd, simulating a GPS</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>

<cmdsynopsis>
  <command>gpsfake</command>  
      <arg choice='opt'>-h</arg>
      <arg choice='opt'>-c <replaceable>interval</replaceable></arg>
      <arg choice='opt'>-l</arg>
      <arg choice='opt'>-n</arg>
      <arg choice='opt'>-o <replaceable>options</replaceable></arg>
      <arg choice='opt'>-s <replaceable>speed</replaceable></arg>
      <arg choice='opt'><replaceable>logfile</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1 id='description'><title>DESCRIPTION</title>

<para><application>gpsfake</application> is a test harness for 
<application>gpsd</application> and its clients.  It opens a pty
(pseudo-TTY), launches a <application>gpsd</application> instance that
thinks the slave side of the pty is its GPS device, and repeatedly
feeds the contents of a test logfile through the master side to the
GPS.</para>

<para>The logfile may be of either NMEA sentences or SiRF-II packets.
Leading lines beginning with # will be treated as comments and
ignored.</para>

<para>The <application>gpsd</application> instance is run in
background, but with logging to standard error attached so you 
will see the messages.</para>

</refsect1>
<refsect1 id='options'><title>OPTIONS</title>

<para>The -c option sets the delay between sentences in
seconds. Fractional values of seconds are legal.</para>

<para>The -l option makes the program dump a line or packet number just
before each sentence is fed to the daemon. If the sentence is
textual (e.g., NMEA, the text is dumped as well).</para>

<para>The -n option suppresses launch of the daemon.  Instead,
<application>gpsfake</application> will tell you the name of the slave
pty so you can launch in instance that reads it.</para>

<para>The -o option specifies options to pass to the daemon.
Passing "-n -D 4" is often useful.</para>

<para>The -s option sets the baud rate for the slave tty.  The
default is 4800.</para>

<para>The -h option makes <application>gpsfake</application> print 
a usage message and exit.</para>

<para>The argument must be the name of a file containing the 
data to be cycled at the device. <application>gpsfake</application> 
will print a notification each time it cycles.</para>

</refsect1>
<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xgps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgpsd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsprof</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gnuplot</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
</refsect1>

<refsect1 id='maintainer'><title>AUTHOR</title> 

<para>Eric S. Raymond <email>esr@thyrsus.com</email>.  There is a
project page for <application>gpsd</application> <ulink
url="http://gpsd.berlios.de/">here</ulink>.</para>

</refsect1>

</refentry>