From: Marc Fournier <marc.fournier@camptocamp.com>
Date: Sat, 21 Nov 2015 10:36:09 +0000 (+0100)
Subject: gps: merge manpage into main collectd.conf.pod
X-Git-Tag: collectd-5.6.0~73^2~4
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=8884f852e080b84c470cf6ff2be85896ad128f44;p=collectd.git

gps: merge manpage into main collectd.conf.pod

Also mention plugin in README and attribute Nicolas in AUTHORS file.
---

diff --git a/AUTHORS b/AUTHORS
index 02b12568..882b5ba3 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -197,6 +197,9 @@ Michał Mirosław <mirq-linux at rere.qmqm.pl>
 Mirko Buffoni <briareos at eswat.org>
  - Port/Socket selection in the MySQL plugin.
 
+Nicolas Jourden <nicolas.jourden at laposte.net>
+ - gps plugin.
+
 Niki W. Waibel <niki.waibel at newlogic.com>
  - Initial autotools fixes.
  - libltdl code.
diff --git a/README b/README
index ad5b6678..a55b2a2b 100644
--- a/README
+++ b/README
@@ -119,6 +119,9 @@ Features
     - gmond
       Receive multicast traffic from Ganglia instances.
 
+    - gps
+      Monitor gps related data through gpsd.
+
     - hddtemp
       Hard disk temperatures using hddtempd.
 
@@ -680,6 +683,10 @@ Prerequisites
     Used by the `network' plugin for encryption and authentication.
     <http://www.gnupg.org/>
 
+  * libgps (optional)
+    Used by the `gps' plugin.
+    <http://developer.berlios.de/projects/gpsd/>
+
   * libhal (optional)
     If present, the `uuid' plugin will check for UUID from HAL.
     <http://hal.freedesktop.org/>
diff --git a/src/Makefile.am b/src/Makefile.am
index fa3f4736..68ee552d 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -1356,7 +1356,6 @@ EXTRA_DIST +=   collectd.conf.pod \
 		collectd-threshold.pod \
 		collectd-unixsock.pod \
 		postgresql_default.conf \
-		gps.pod \
 		types.db.pod
 
 .pod.1:
diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 61c01f94..a2f25ee5 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -121,6 +121,7 @@
 #@BUILD_PLUGIN_FILECOUNT_TRUE@LoadPlugin filecount
 #@BUILD_PLUGIN_FSCACHE_TRUE@LoadPlugin fscache
 #@BUILD_PLUGIN_GMOND_TRUE@LoadPlugin gmond
+#@BUILD_PLUGIN_GPS_TRUE@LoadPlugin gps
 #@BUILD_PLUGIN_HDDTEMP_TRUE@LoadPlugin hddtemp
 @BUILD_PLUGIN_INTERFACE_TRUE@@BUILD_PLUGIN_INTERFACE_TRUE@LoadPlugin interface
 #@BUILD_PLUGIN_IPC_TRUE@@BUILD_PLUGIN_IPC_TRUE@LoadPlugin ipc
@@ -555,6 +556,13 @@
 #  </Metric>
 #</Plugin>
 
+#<Plugin gps>
+#  Host "127.0.0.1"
+#  Port "2947"
+#  Timeout 15
+#  Pause 1
+#</Plugin>
+
 #<Plugin hddtemp>
 #  Host "127.0.0.1"
 #  Port "7634"
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 8a508089..fcffa7c9 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -2482,6 +2482,68 @@ source, this is optional. Otherwise the option is required.
 
 =back
 
+=head2 Plugin C<gps>
+
+The C<gps plugin> connects to gpsd on the host machine.
+The host, port, timeout and pause are configurable.
+
+This is useful if you run an NTP server using a GPS for source and you want to
+monitor it.
+
+Mind your GPS must send $--GSA for having the data reported!
+
+The following elements are collected:
+
+=over 4
+
+=item B<satellites>
+
+Number of satellites used for fix (type instance "used") and in view (type
+instance "visible"). 0 means no GPS satellites are visible.
+
+=item B<dilution_of_precision>
+
+Vertical and horizontal dilution.
+It should be between 0 and 3.
+Look at the documentaiton of your GPS to know more.
+
+=back
+
+Synopsis:
+
+ LoadPlugin gps
+ <Plugin "gps">
+   # Connect to localhost on gpsd regular port:
+   Host "127.0.0.1"
+   Port "2947"
+   # 15 seconds timeout
+   Timeout 15
+   # Pause of 1 second between readings:
+   Pause 1
+ </Plugin>
+
+Available configuration options:
+
+=over 4
+
+=item B<Host> I<Host>
+
+The host on which gpsd runs. Defaults to B<localhost>.
+
+=item B<Port> I<Port>
+
+Port to connect to gpsd on the host machine. Defaults to B<2947>.
+
+=item B<Timeout> I<Seconds>
+
+Timeout in seconds (default 15 sec).
+
+=item B<Pause> I<Seconds>
+
+Pause to apply between readings in seconds (default 1 sec).
+
+=back
+
 =head2 Plugin C<hddtemp>
 
 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
diff --git a/src/gps.pod b/src/gps.pod
deleted file mode 100644
index 3148299b..00000000
--- a/src/gps.pod
+++ /dev/null
@@ -1,78 +0,0 @@
-=encoding UTF-8
-
-=head1 NAME
-
-gps - Documentation of collectd's C<gps plugin>
-
-=head1 SYNOPSIS
-
-LoadPlugin gps
-<Plugin "gps">
-  # Connect to localhost on gpsd regular port:
-  Host "127.0.0.1"
-  Port "2947"
-  # 15 seconds timeout
-  Timeout 15
-  # Pause of 1 second between readings:
-  Pause 1
-</Plugin>
-
-
-=head1 DESCRIPTION
-
-The C<gps plugin> connects to gpsd on the host machine.
-The host, port, timeout and pause are configurable. 
-
-This is useful if you run an NTP server using a GPS for source and you want to
-monitor it.
-
-Mind your GPS must send $--GSA for having the data reported!
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<Host> I<Host>
-
-The host on which gpsd runs. Defaults to B<localhost>.
-
-=item B<Port> I<Port>
-
-Port to connect to gpsd on the host machine. Defaults to B<2947>.
-
-=item B<Timeout> I<Seconds>
-
-Timeout in seconds (default 15 sec).
-
-=item B<Pause> I<Seconds>
-
-Pause to apply between readings in seconds (default 1 sec).
-
-=back
-
-=head1 NOTIFICATION DATA FORMAT
-
-=over 4
-
-=item B<satellites>
-
-Number of satellites used for fix (type instance "used") and in view (type
-instance "visible"). 0 means no GPS satellites are visible.
-
-=item B<dilution_of_precision>
-
-Vertical and horizontal dilution.
-It should be between 0 and 3.
-Look at the documentaiton of your GPS to know more.
-
-=head1 SEE ALSO
-
-L<collectd(1)>,
-L<collectd.conf(5)>,
-gpsd
-
-=head1 AUTHOR
-
-Nicolas JOURDEN E<lt>nicolas.jourden at laposte.netE<gt>
-
-=cut