Documentation cleanup for gps2udp.

5 files changed, 41 insertions, 19 deletions

diff --git a/.gitignore b/.gitignore
index 0a4181a9..fecc80a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -101,6 +101,7 @@ www/NMEA.html
 www/faq.html
 www/gps.html
 www/gps_report.cgi
+www/gps2udp.html
 www/gpscat.html
 www/gpsctl.html
 www/gpsd.html
diff --git a/AUTHORS b/AUTHORS
index ed577fa0..f61e1500 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -7,3 +7,4 @@ Jeff Francis <jeff@gritch.org>
 Amaury Jacquot <sxpert@esitcom.org>
 Chris Kuethe <chris.kuethe@gmail.com>
 Ville Nuorvala <vnuorval@tcs.hut.fi>
+Fulup Ar Foll <fulup@sinagot.net>
diff --git a/gps2udp.xml b/gps2udp.xml
index 46ea69cc..e43ddae5 100644
--- a/gps2udp.xml
+++ b/gps2udp.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-This file is Copyright (c) 2010 by the GPSD project
+This file is Copyright (c) 2013 by the GPSD project
 BSD terms apply: see the file COPYING in the distribution root for details.
 -->
 <!DOCTYPE refentry PUBLIC
@@ -16,7 +16,7 @@ BSD terms apply: see the file COPYING in the distribution root for details.
 </refmeta>
 <refnamediv id='name'>
 <refname>gps2udp</refname>
-<refpurpose>tool to connect to gpsd and push sentences to aishub, marinetraffic, ....</refpurpose>
+<refpurpose>feed the take from gpsd to one or more aggregation sites</refpurpose>
 </refnamediv>
 <refsynopsisdiv id='synopsis'>
 
@@ -41,25 +41,34 @@ BSD terms apply: see the file COPYING in the distribution root for details.
 
 <refsect1 id='description'><title>DESCRIPTION</title>
 
-<para><application>gps2udp</application> is a tool to connect
-to <application>gpsd</application> and output the received
-sentences to one or many UDP host:port destinations.  This makes the program useful to feed AIS information from <application>gpsd</application> to aishub, marinetraffic, shipfinder,... </para>
+<para><application>gps2udp</application> is a tool to connect to
+<application>gpsd</application> and output the received sentences to
+one or many UDP host:port destinations.  This makes the program useful
+for feeding AIS information from <application>gpsd</application> to
+aishub, marinetraffic, shipfinder,... </para>
 
 <para><application>gps2udp</application> does not require root
 privileges, and can be run concurrently with other tools connecting
 to the local <application>gpsd</application> without causing problems.</para>
 
-<para>The output will consist of one or both of NMEA (-n option) or Jason (-j option)
-<application>gpsd</application> sentences. The output are sent to one or many destinations host through a UDP network socket (-u host:port options) .</para>
+<para>The output will consist of one or both of NMEA (-n option) or
+JSON (-j option) <application>gpsd</application> sentences. The
+output is sent to one or many destinations host through a UDP network
+socket (-u host:port options) .</para>
 
 <para>Optionally a server, TCP/IP port number and remote device can be given.
 If omitted, <application>gps2udp</application> connects to localhost on
 the default port (2947) and watches all devices opened by
 <application>gpsd</application>.</para>
 
-<para><application>gps2udp</application> may be run as a daemon (-b option).</para>
+<para><application>gps2udp</application> may be run as a daemon (-b
+option).</para>
 
-<para><application>gps2udp</application> is design to run smoothly in background, it reconnecte automatically to <application>gpsd</application> is ever this one is restarted. For debug perporse, there is an option to exit gracefully after a given count of packets (-c option).</para>
+<para><application>gps2udp</application> is designed to run smoothly in
+background; it reconnects automatically to
+<application>gpsd</application> whenever it is restarted. For
+debugging purporses, there is an option to exit gracefully after a given
+count of packets (-c option).</para>
 
 </refsect1>
 <refsect1 id='options'><title>OPTIONS</title>
@@ -68,8 +77,9 @@ the default port (2947) and watches all devices opened by
 a usage message and exit.</para>
 
 <para>-n causes NMEA sentences to be output.</para>
-<para>-j causes JASON sentences to be output.</para>
-<para>-u host:port UDP destination for output sentenses (up to five destinations).</para>
+<para>-j causes JSON sentences to be output.</para>
+<para>-u host:port UDP destination for output sentenses (up to five
+destinations).</para>
 
 <para>-a output only AIS messages.</para>
 <para>-b causes <application>gps2udp</application> to run as a daemon.</para>
@@ -78,16 +88,22 @@ a usage message and exit.</para>
 
 <para>-d prints sent packet on stdout.</para>
 <para>-v prints the version, then exits.</para>
-
 </refsect1>
 
 <refsect1 id='exampletitle'><title>EXAMPLE</title>
-<para>With a running <application>gpsd accessible on the network</application> </para>
-
-<para><command>gps2udp -d -n -u data.aishub.net:2222
-</command> will collect data from localhost:gpsd display them on stdout and send a copy to test aishub in NMEA format.</para>
-
-<para><command>gps2udp -a -n -b -u data.aishub.net 2222 -u 5.9.207.224 5321 -u 109.200.19.151 4001 vz-fulup.vpn:2947</command> will collect data from a remote gpsd located on vz-fulup.vpn host, will filter AIS messages and send them to 3 destination [aishub, marinetraffic, shipfinder] in NMEA format, command is running in background mode</para>
+<para>With a running <application>gpsd accessible on the
+network</application> </para>
+
+<para><command>gps2udp -d -n -u data.aishub.net:2222 </command> will
+collect data from localhost:gpsd display them on stdout and send a
+copy to test aishub in NMEA format.</para>
+
+<para><command>gps2udp -a -n -b -u data.aishub.net 2222 -u 5.9.207.224
+5321 -u 109.200.19.151 4001 vz-fulup.vpn:2947</command> will collect
+data from a remote gpsd located on vz-fulup.vpn host, will filter AIS
+messages and send them to 3 destination (aishub, marinetraffic,
+shipfinder) in NMEA format, command is running in background
+mode</para>
 </refsect1>
 
 <refsect1 id='see_also'><title>SEE ALSO</title>
@@ -106,7 +122,7 @@ a usage message and exit.</para>
 
 <refsect1 id='maintainer'><title>AUTHOR</title>
 
-<para>Fulup Ar Foll <email>fulup (à) sinagot.net</email>.</para>
+<para>Fulup Ar Foll <email>fulup@sinagot.net</email>.</para>
 
 </refsect1>
 
diff --git a/www/cycle.png b/www/cycle.png
index f9f651b6..b58465c2 100644
--- a/www/cycle.png
+++ b/www/cycle.png
diff --git a/www/index.html.in b/www/index.html.in
index 80576914..bbf03698 100644
--- a/www/index.html.in
+++ b/www/index.html.in
@@ -288,6 +288,10 @@ protocol of the <code>gpsd</code> daemon.</dd>
 
 <dt><a href="gpsinit.html">gpsinit.8</a></dt>
 <dd>Initialize kernel modules for use with <code>gpsd</code> daemon.</dd>
+
+<dt><a href="gps2udp.html">gps2udp.1</a></dt>
+<dd>Feed the take from <code>gpsd</code> to one or more aggregation
+sites via UDP.</dd>
 </dl>
 
 <p>Also, see the <a href="faq.html">FAQ</a>.</p>