'\" t
.\"     Title: gps2udp
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 6 December 2020
.\"    Manual: GPSD Documentation
.\"    Source: The GPSD Project
.\"  Language: English
.\"
.TH "GPS2UDP" "1" "6 December 2020" "The GPSD Project" "GPSD Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gps2udp \- feed the take from gpsd to one or more aggregation sites
.SH "SYNOPSIS"
.HP \w'\fBgps2udp\fR\ 'u
\fBgps2udp\fR [\-\-ais] [\-\-count\ \fICOUNT\fR] [\-\-daemonize] [\-\-debug\ \fILVL\fR] [\-\-help] [\-\-json] [\-\-nmea] [\-\-tpv] [\-\-udp\ \fIHOST:PORT\fR] [\-a] [\-c\ \fICOUNT\fR] [\-d\ \fILVL\fR] [\-h] [\-j] [\-n] [\-t] [\-u\ \fIHOST:PORT\fR] [\-V] [\-V] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
.SH "DESCRIPTION"
.PP
gps2udp
is a tool to connect to
gpsd
and output the received sentences to one or many UDP host:port destinations\&. This makes the program useful for feeding AIS information from
gpsd
to aishub, marinetraffic, shipfinder,\&.\&.\&.
.PP
gps2udp
does not require root privileges, and can be run concurrently with other tools connecting to the local
gpsd
without causing problems\&.
.PP
The output will consist of one or both of NMEA (\fB\-n\fR
option) or JSON (\fB\-j\fR
option)
gpsd
sentences\&. The output is sent to one or many destinations host through a UDP network socket (\fB\-u HOST:PORT\fR
options) \&.
.PP
Optionally a server, TCP/IP port number and remote device can be given\&. If omitted,
gps2udp
connects to localhost on the default port (2947) and watches all devices opened by
gpsd\&.
.PP
gps2udp
may be run as a daemon (\fB\-b\fR
option)\&.
.PP
gps2udp
is designed to run smoothly in background; it reconnects automatically to
gpsd
whenever it is restarted\&. For debugging purporses, there is an option to exit gracefully after a given count of packets (\fB\-c\fR
option)\&.
.SH "OPTIONS"
.PP
\fB\-?\fR, \fB\-h\fR, \fB\-\-help\fR
.RS 4
\-Print a usage message and exit\&.
.RE
.PP
\fB\-a\fR, \fB\-\-ais\fR
.RS 4
Send only AIS messages\&.
.RE
.PP
\fB\-b\fR, \fB\-\-daemon\fR
.RS 4
Causes
gps2udp
to run as a daemon\&.
.RE
.PP
\fB\-c COUNT\fR, \fB\-\-count COUNT\fR
.RS 4
Exit after COUNT sentences are sent\&.
.RE
.PP
\fB\-d LVL\fR, \fB\-\-debug LVL\fR
.RS 4
Set debug level to LVL\&. LVL = 0 prints nothing\&. LVL =1 prints sent packet on stdout\&. LVL =2 prints ignored packets\&.
.RE
.PP
\fB\-j\fR, \fB\-\-json\fR
.RS 4
Causes JSON sentences to be output\&.
.RE
.PP
\fB\-n\fR, \fB\-\-nmea\fR
.RS 4
Causes NMEA sentences to be output\&.
.RE
.PP
\fB\-t\fR, \fB\-\-tpv\fR
.RS 4
Only output TPV sentences\&. Implies \-\-json\&.
.RE
.PP
\fB\-u HOST:PORT\fR, \fB\-\-udp HOST:PORT\fR
.RS 4
UDP destination for output sentenses (up to five destinations)\&.
.RE
.PP
\fB\-v\fR, \fB\-V\fR, \fB\-\-version\fR
.RS 4
Prints the program version, then exit\&. \-v is deprecated December 2020\&.
.RE
.SH "EXAMPLE"
.PP
With a running
gpsd
accessible on the network
.PP
\fBgps2udp \-d 1 \-n \-u data\&.aishub\&.net:2222 \fR
will collect data from localhost:gpsd display them on stdout and send a copy to test aishub in NMEA format\&.
.PP
\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
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
.SH "SEE ALSO"
.PP
\fBgpsd\fR(8),
\fBgps\fR(1),
\fBlibgps\fR(3),
\fBlibgpsmm\fR(3),
\fBgpsprof\fR(1),
\fBgpsfake\fR(1),
\fBgpsctl\fR(1),
\fBgpscat\fR(1)\&.
\fBgpsmon\fR(1)\&.
.SH "AUTHOR"
.PP
Fulup Ar Foll
<fulup@sinagot\&.net>\&.