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.
 
 
 
 
 
 

118 lines
3.9 KiB

  1. '\" t
  2. .\" Title: gps2udp
  3. .\" Author: [see the "AUTHOR" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 01 Marc 2013
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "GPS2UDP" "1" "01 Marc 2013" "The GPSD Project" "GPSD Documentation"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. gps2udp \- feed the take from gpsd to one or more aggregation sites
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBgps2udp\fR\ 'u
  34. \fBgps2udp\fR [\-h] [\-n] [\-j] [\-a] [\-u\ \fIhostname:udpport\fR] [\-c\ \fIcount\fR] [\-d\ \fI1|2\fR] [\-v] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
  35. .SH "DESCRIPTION"
  36. .PP
  37. gps2udp
  38. is a tool to connect to
  39. gpsd
  40. and output the received sentences to one or many UDP host:port destinations\&. This makes the program useful for feeding AIS information from
  41. gpsd
  42. to aishub, marinetraffic, shipfinder,\&.\&.\&.
  43. .PP
  44. gps2udp
  45. does not require root privileges, and can be run concurrently with other tools connecting to the local
  46. gpsd
  47. without causing problems\&.
  48. .PP
  49. The output will consist of one or both of NMEA (\-n option) or JSON (\-j option)
  50. gpsd
  51. sentences\&. The output is sent to one or many destinations host through a UDP network socket (\-u host:port options) \&.
  52. .PP
  53. Optionally a server, TCP/IP port number and remote device can be given\&. If omitted,
  54. gps2udp
  55. connects to localhost on the default port (2947) and watches all devices opened by
  56. gpsd\&.
  57. .PP
  58. gps2udp
  59. may be run as a daemon (\-b option)\&.
  60. .PP
  61. gps2udp
  62. is designed to run smoothly in background; it reconnects automatically to
  63. gpsd
  64. whenever it is restarted\&. For debugging purporses, there is an option to exit gracefully after a given count of packets (\-c option)\&.
  65. .SH "OPTIONS"
  66. .PP
  67. \-h makes
  68. gps2udp
  69. print a usage message and exit\&.
  70. .PP
  71. \-n causes NMEA sentences to be output\&.
  72. .PP
  73. \-j causes JSON sentences to be output\&.
  74. .PP
  75. \-u host:port UDP destination for output sentenses (up to five destinations)\&.
  76. .PP
  77. \-a output only AIS messages\&.
  78. .PP
  79. \-b causes
  80. gps2udp
  81. to run as a daemon\&.
  82. .PP
  83. \-c [count] causes [count] sentences to be output\&.
  84. gps2udp
  85. will then exit gracefully\&.
  86. .PP
  87. \-d 1 prints sent packet on stdout\&.
  88. .PP
  89. \-d 2 prints unsent packet on stdout\&.
  90. .PP
  91. \-v prints the version, then exits\&.
  92. .SH "EXAMPLE"
  93. .PP
  94. With a running
  95. gpsd
  96. accessible on the network
  97. .PP
  98. \fBgps2udp \-d 1 \-n \-u data\&.aishub\&.net:2222 \fR
  99. will collect data from localhost:gpsd display them on stdout and send a copy to test aishub in NMEA format\&.
  100. .PP
  101. \fBgps2udp \-a \-n \-b \-u data\&.aishub\&.net:2222 \-u 5\&.9\&.207\&.224:5321 \-u 109\&.200\&.19\&.151:4001 fridu\&.net:2947\fR
  102. will collect data from a remote gpsd located on fridu\&.net host, will filter AIS messages and send them to 3 destination (aishub, marinetraffic, shipfinder) in NMEA format, command is running in background mode
  103. .SH "SEE ALSO"
  104. .PP
  105. \fBgpsd\fR(8),
  106. \fBgps\fR(1),
  107. \fBlibgps\fR(3),
  108. \fBlibgpsmm\fR(3),
  109. \fBgpsprof\fR(1),
  110. \fBgpsfake\fR(1),
  111. \fBgpsctl\fR(1),
  112. \fBgpscat\fR(1)\&.
  113. \fBgpsmon\fR(1)\&.
  114. .SH "AUTHOR"
  115. .PP
  116. Fulup Ar Foll
  117. <fulup@sinagot\&.net>\&.