summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorFred Wright <fw@fwright.net>2018-12-28 15:04:59 -0800
committerFred Wright <fw@fwright.net>2018-12-28 15:04:59 -0800
commit574f412da8240dca4624bacbf3506b69a619da8d (patch)
tree3a7ebe0e160506daead353ee11261b1a512ef407 /man
parentcb19184e7718f062fc7c566bf5aa27bfedb913ef (diff)
downloadgpsd-574f412da8240dca4624bacbf3506b69a619da8d.tar.gz
gpsfake: Update doc for recently added options.
TESTED: gpsfake.1 and gpsfake.html reflect the updates.
Diffstat (limited to 'man')
-rw-r--r--man/gpsfake.xml16
1 files changed, 13 insertions, 3 deletions
diff --git a/man/gpsfake.xml b/man/gpsfake.xml
index e8331d47..acf09b73 100644
--- a/man/gpsfake.xml
+++ b/man/gpsfake.xml
@@ -31,6 +31,7 @@ SPDX-License-Identifier: BSD-2-clause
<arg choice='opt'>-l</arg>
<arg choice='opt'>-m <replaceable>monitor</replaceable></arg>
<arg choice='opt'>-g</arg>
+ <arg choice='opt'>-G</arg>
<arg choice='opt'>-n</arg>
<arg choice='opt'>-o <replaceable>options</replaceable></arg>
<arg choice='opt'>-p</arg>
@@ -43,6 +44,7 @@ SPDX-License-Identifier: BSD-2-clause
<arg choice='opt'>-t</arg>
<arg choice='opt'>-T</arg>
<arg choice='opt'>-v</arg>
+ <arg choice='opt'>-W <replaceable>timeout</replaceable></arg>
<arg rep='repeat'>
<arg choice='plain'><replaceable>logfile</replaceable></arg>
</arg>
@@ -121,9 +123,12 @@ daemon should be run. This option is intended to be used with
<citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
and similar programs.</para>
-<para>The <option>-g</option> uses the monitor facility to run the
-<application>gpsd</application> instance within gpsfake under control
-of gdb.</para>
+<para>The <option>-g</option> and <option>-G</option> options use the
+monitor facility to run the <application>gpsd</application> instance
+within gpsfake under control of gdb or lldb, respectively. They also
+disable the timeout on daemon inactivity, to allow for breakpointing. If
+necessary, the timeout can be reenabled by a subsequent
+<option>-W</option>.</para>
<para>The <option>-o</option> specifies options to pass to the daemon. The -n
option passes -n to start the daemon reading the GPS without waiting
@@ -168,6 +173,11 @@ to pty devices is locked out.</para>
mainly useful for debugging <application>gpsfake</application>
itself.</para>
+<para>The <option>-W</option> ("wait") option sets the timeout on daemon
+inactivity, in seconds. The default timeout is 60 seconds, and a value
+of 0 suppresses the timeout altogether. Note that the actual timeout is
+longer due to internal delays, typically by about 20 seconds.</para>
+
<para>The <option>-x</option> dumps packets as
<application>gpsfake</application> gathers them. It is mainly useful
for debugging <application>gpsfake</application> itself.</para>