gps plugin: Store timeout and pause as cdtime_t.

[collectd.git] / src / gps.pod

diff --git a/src/gps.pod b/src/gps.pod
index 540a1627a056ed61da8360a322d815ba2b788b32..3148299bde6fdd2f9b5254d547c821020ffca9bd 100644 (file)
--- a/src/gps.pod
+++ b/src/gps.pod
@@ -23,28 +23,28 @@ LoadPlugin 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 !
+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>
+=item B<Host> I<Host>
 
-The host on which gpsd runs (default localhost).
+The host on which gpsd runs. Defaults to B<localhost>.
 
-=item B<Port>
+=item B<Port> I<Port>
 
-Port to connect to gpsd on the host machine (with quotes), (default 2947).
+Port to connect to gpsd on the host machine. Defaults to B<2947>.
 
-=item B<Timeout>
+=item B<Timeout> I<Seconds>
 
 Timeout in seconds (default 15 sec).
 
-=item B<Pause>
+=item B<Pause> I<Seconds>
 
 Pause to apply between readings in seconds (default 1 sec).
 
@@ -56,16 +56,15 @@ Pause to apply between readings in seconds (default 1 sec).
 
 =item B<satellites>
 
-Number of satellites in view.
-0 means no GPS are visible.
+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 or horizontal dilution.
+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)>,