diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/gpspipe.xml | 38 |
1 files changed, 22 insertions, 16 deletions
diff --git a/man/gpspipe.xml b/man/gpspipe.xml index 9c5da4f3..e522bba6 100644 --- a/man/gpspipe.xml +++ b/man/gpspipe.xml @@ -8,7 +8,7 @@ SPDX-License-Identifier: BSD-2-clause "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> <refentry id='gpspipe.1'> <refentryinfo> - <date>17 Jun 2018</date> + <date>14 Dec 2018</date> </refentryinfo> <refmeta> <refentrytitle>gpspipe</refentrytitle> @@ -24,28 +24,27 @@ SPDX-License-Identifier: BSD-2-clause <cmdsynopsis> <command>gpspipe</command> <arg choice='opt'>-2</arg> + <arg choice='opt'>-?</arg> <arg choice='opt'>-d</arg> - <arg choice='opt'>-D <replaceable>debug-level</replaceable> - </arg> + <arg choice='opt'>-D <replaceable>debug-level</replaceable></arg> <arg choice='opt'>-h</arg> <arg choice='opt'>-l</arg> - <arg choice='opt'>-n <replaceable>count</replaceable> - </arg> - <arg choice='opt'>-o <replaceable>filename</replaceable> - </arg> + <arg choice='opt'>-n <replaceable>count</replaceable></arg> + <arg choice='opt'>-o <replaceable>filename</replaceable></arg> <arg choice='opt'>-p</arg> + <arg choice='opt'>-P</arg> <arg choice='opt'>-r</arg> <arg choice='opt'>-R</arg> <arg choice='opt'>-S</arg> - <arg choice='opt'>-s <replaceable>serial-device</replaceable> - </arg> + <arg choice='opt'>-s <replaceable>serial-device</replaceable></arg> <arg choice='opt'>-t</arg> - <arg choice='opt'>-T <replaceable>timestamp-format</replaceable> - </arg> + <arg choice='opt'>-T <replaceable>timestamp-format</replaceable></arg> <arg choice='opt'>-u</arg> <arg choice='opt'>-v</arg> + <arg choice='opt'>-V</arg> <arg choice='opt'>-w</arg> - <arg choice='opt'>-x</arg> + <arg choice='opt'>-x <replaceable>seconds</replaceable></arg> + <arg choice='opt'>-Z</arg> <group> <replaceable>server</replaceable> <group> @@ -84,7 +83,10 @@ requires the -o flag for writing the output to a file.</para> <title>OPTIONS</title> <para>-2 sets the split24 flag on AIS reports. Note: this option is experimental and may be changed or removed in a future release.</para> + <para>-? makes <application>gpspipe</application> print +a usage message and exit.</para> <para>-d causes <application>gpspipe</application> to run as a daemon.</para> + <para>-D [debug-level] set debug level..</para> <para>-h makes <application>gpspipe</application> print a usage message and exit.</para> <para>-l causes <application>gpspipe</application> to sleep for ten @@ -93,7 +95,7 @@ when running as a daemon, giving gpsd time to start before attempting a connection.</para> <para>-n [count] causes [count] sentences to be output. <application>gpspipe</application> will then exit gracefully.</para> - <para>-o option causes the collected data to be written to the + <para>-o [filename] option causes the collected data to be written to the specified file. Use of this option is mandatory if <application>gpspipe</application> is run as a daemon.</para> <para>-p enables dumping of profiling information in JSON.</para> @@ -106,8 +108,9 @@ specified serial device with settings 4800 8N1. Thus <application>gpspipe</application> can be used with -s and -r options to emulate a serial port hardwired to a GPS that <application>gpsd</application> is managing.</para> - <para>-S sets the scaled flag.</para> - <para>-t adds a timestamp to each sentence output.</para> + <para>-S sets the scaled flag. This is for AIS and subframe data, but +currently appears to do nothing.</para> + <para>-t adds a UTC timestamp to each sentence output.</para> <para>-T sets the format of the timestamp. See <citerefentry> <refentrytitle>strftime</refentrytitle> @@ -115,7 +118,8 @@ to emulate a serial port hardwired to a GPS that </citerefentry> for the available placeholders. Setting this option implies -t. Default setting is "%F %T"</para> - <para>-u usec resolution time stamp, implies -t. Use -uu to output sec.usec.</para> + <para>-u usec resolution time stamp, implies -t. Use -uu to output + sec.usec.</para> <para>-v causes <application>gpspipe</application> to show a spinning activity indicator on stderr. This is useful if stdout is redirected into a file or a pipe. By default the spinner is advanced with every @@ -125,7 +129,9 @@ of messages required to rotate the spinner.</para> <para>-w causes native <application>gpsd</application> sentences to be output.</para> <para>-x [seconds] Exit after delay of [seconds].</para> + <para>-Z sets the timestamp format iso8601: implies '-t'</para> <para>At least one of -R, -r or -w must be specified.</para> + <para>You must use -o if you use -d.</para> </refsect1> <refsect1 id='exampletitle'> <title>EXAMPLES</title> |