Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

131 lines
5.1 KiB

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!--
  3. This file is Copyright (c) 2013 by the GPSD project
  4. SPDX-License-Identifier: BSD-2-clause
  5. -->
  6. <!DOCTYPE refentry PUBLIC
  7. "-//OASIS//DTD DocBook XML V4.1.2//EN"
  8. "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
  9. <refentry id='gps2udp.1'>
  10. <refentryinfo><date>01 Marc 2013</date></refentryinfo>
  11. <refmeta>
  12. <refentrytitle>gps2udp</refentrytitle>
  13. <manvolnum>1</manvolnum>
  14. <refmiscinfo class="source">The GPSD Project</refmiscinfo>
  15. <refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
  16. </refmeta>
  17. <refnamediv id='name'>
  18. <refname>gps2udp</refname>
  19. <refpurpose>feed the take from gpsd to one or more aggregation sites</refpurpose>
  20. </refnamediv>
  21. <refsynopsisdiv id='synopsis'>
  22. <cmdsynopsis>
  23. <command>gps2udp</command>
  24. <arg choice='opt'>-h</arg>
  25. <arg choice='opt'>-n</arg>
  26. <arg choice='opt'>-j</arg>
  27. <arg choice='opt'>-a</arg>
  28. <arg choice='opt'>-u <replaceable>hostname:udpport</replaceable></arg>
  29. <arg choice='opt'>-c <replaceable>count</replaceable></arg>
  30. <arg choice='opt'>-d <replaceable>1|2</replaceable></arg>
  31. <arg choice='opt'>-v</arg>
  32. <group>
  33. <replaceable>server</replaceable>
  34. <group><replaceable>:port</replaceable>
  35. <group><replaceable>:device</replaceable></group>
  36. </group>
  37. </group>
  38. </cmdsynopsis>
  39. </refsynopsisdiv>
  40. <refsect1 id='description'><title>DESCRIPTION</title>
  41. <para><application>gps2udp</application> is a tool to connect to
  42. <application>gpsd</application> and output the received sentences to
  43. one or many UDP host:port destinations. This makes the program useful
  44. for feeding AIS information from <application>gpsd</application> to
  45. aishub, marinetraffic, shipfinder,... </para>
  46. <para><application>gps2udp</application> does not require root
  47. privileges, and can be run concurrently with other tools connecting
  48. to the local <application>gpsd</application> without causing problems.</para>
  49. <para>The output will consist of one or both of NMEA (-n option) or
  50. JSON (-j option) <application>gpsd</application> sentences. The
  51. output is sent to one or many destinations host through a UDP network
  52. socket (-u host:port options) .</para>
  53. <para>Optionally a server, TCP/IP port number and remote device can be given.
  54. If omitted, <application>gps2udp</application> connects to localhost on
  55. the default port (2947) and watches all devices opened by
  56. <application>gpsd</application>.</para>
  57. <para><application>gps2udp</application> may be run as a daemon (-b
  58. option).</para>
  59. <para><application>gps2udp</application> is designed to run smoothly in
  60. background; it reconnects automatically to
  61. <application>gpsd</application> whenever it is restarted. For
  62. debugging purporses, there is an option to exit gracefully after a given
  63. count of packets (-c option).</para>
  64. </refsect1>
  65. <refsect1 id='options'><title>OPTIONS</title>
  66. <para>-h makes <application>gps2udp</application> print
  67. a usage message and exit.</para>
  68. <para>-n causes NMEA sentences to be output.</para>
  69. <para>-j causes JSON sentences to be output.</para>
  70. <para>-u host:port UDP destination for output sentenses (up to five
  71. destinations).</para>
  72. <para>-a output only AIS messages.</para>
  73. <para>-b causes <application>gps2udp</application> to run as a daemon.</para>
  74. <para>-c [count] causes [count] sentences to be output.
  75. <application>gps2udp</application> will then exit gracefully.</para>
  76. <para>-d 1 prints sent packet on stdout.</para>
  77. <para>-d 2 prints unsent packet on stdout.</para>
  78. <para>-v prints the version, then exits.</para>
  79. </refsect1>
  80. <refsect1 id='exampletitle'><title>EXAMPLE</title>
  81. <para>With a running <application>gpsd</application> accessible on the
  82. network </para>
  83. <para><command>gps2udp -d 1 -n -u data.aishub.net:2222 </command> will
  84. collect data from localhost:gpsd display them on stdout and send a
  85. copy to test aishub in NMEA format.</para>
  86. <para><command>gps2udp -a -n -b -u data.aishub.net:2222 -u 5.9.207.224:5321 -u 109.200.19.151:4001 fridu.net:2947</command> will collect
  87. data from a remote gpsd located on fridu.net host, will filter AIS
  88. messages and send them to 3 destination (aishub, marinetraffic,
  89. shipfinder) in NMEA format, command is running in background
  90. mode</para>
  91. </refsect1>
  92. <refsect1 id='see_also'><title>SEE ALSO</title>
  93. <para>
  94. <citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  95. <citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  96. <citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  97. <citerefentry><refentrytitle>libgpsmm</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  98. <citerefentry><refentrytitle>gpsprof</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  99. <citerefentry><refentrytitle>gpsfake</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  100. <citerefentry><refentrytitle>gpsctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  101. <citerefentry><refentrytitle>gpscat</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  102. <citerefentry><refentrytitle>gpsmon</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  103. </para>
  104. </refsect1>
  105. <refsect1 id='maintainer'><title>AUTHOR</title>
  106. <para>Fulup Ar Foll <email>fulup@sinagot.net</email>.</para>
  107. </refsect1>
  108. </refentry>