Setting a max and min for gpsd timeout.

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index fcffa7c..bbee6b1 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -2503,9 +2503,9 @@ instance "visible"). 0 means no GPS satellites are visible.
 
 =item B<dilution_of_precision>
 
-Vertical and horizontal dilution.
+Vertical and horizontal dilution (type instance "horizontal" or "vertical").
 It should be between 0 and 3.
-Look at the documentaiton of your GPS to know more.
+Look at the documentation of your GPS to know more.
 
 =back
 
@@ -2516,10 +2516,10 @@ Synopsis:
    # 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
+   # 15 ms timeout
+   Timeout 0.015
+   # PauseConnect of 5 sec. between connection attempts.
+   PauseConnect 5
  </Plugin>
 
 Available configuration options:
@@ -2528,7 +2528,7 @@ Available configuration options:
 
 =item B<Host> I<Host>
 
-The host on which gpsd runs. Defaults to B<localhost>.
+The host on which gpsd daemon runs. Defaults to B<localhost>.
 
 =item B<Port> I<Port>
 
@@ -2536,11 +2536,21 @@ Port to connect to gpsd on the host machine. Defaults to B<2947>.
 
 =item B<Timeout> I<Seconds>
 
-Timeout in seconds (default 15 sec).
+Timeout in seconds (default 0.015 sec).
 
-=item B<Pause> I<Seconds>
+The GPS data stream is fetch by the plugin form the daemon.
+It waits for data to be available, if none arrives it times out 
+and loop for another reading.
+Mind to put a low value gpsd expects value in the micro-seconds area 
+(recommended is 500 us) since the waiting function is blocking.
+Value must be between 500 us and 5 sec., if outside that range the 
+default value is applied.
 
-Pause to apply between readings in seconds (default 1 sec).
+This only applies from gpsd release-2.95.
+
+=item B<PauseConnect> I<Seconds>
+
+Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
 
 =back