projects
/
collectd.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
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
e9d5014
..
3148299
100644
(file)
--- a/
src/gps.pod
+++ b/
src/gps.pod
@@
-6,35
+6,47
@@
gps - Documentation of collectd's C<gps plugin>
=head1 SYNOPSIS
=head1 SYNOPSIS
- # See collectd.conf(5)
- LoadPlugin gps
- <Plugin "gps">
- Host "localhost"
- Port "2947"
- Timeout 1000
- </Plugin>
+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.
=head1 DESCRIPTION
The C<gps plugin> connects to gpsd on the host machine.
-The port and the timeout are configurable.
+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
=head1 OPTIONS
=over 4
-=item B<Host>
+=item B<Host> I<Host>
+
+The host on which gpsd runs. Defaults to B<localhost>.
-The host on which gpsd runs.
+=item B<Port> I<Port>
-=item B<Port>
+Port to connect to gpsd on the host machine. Defaults to B<2947>.
-Port to connect to gpsd on the host machine.
+=item B<Timeout> I<Seconds>
-=item B<Timeout>
+Timeout in seconds (default 15 sec).
-Timeout in ms.
+=item B<Pause> I<Seconds>
+
+Pause to apply between readings in seconds (default 1 sec).
=back
=back
@@
-42,21
+54,16
@@
Timeout in ms.
=over 4
=over 4
-=item B<
gps_sat
>
+=item B<
satellites
>
-Number of satel
ites in view.
-
0 means no GPS
are visible.
+Number of satel
lites used for fix (type instance "used") and in view (type
+
instance "visible"). 0 means no GPS satellites
are visible.
-=item B<
gps_hdop
>
+=item B<
dilution_of_precision
>
-
H
orizontal dilution.
+
Vertical and h
orizontal dilution.
It should be between 0 and 3.
It should be between 0 and 3.
-Look at the documentaiton of your GPS.
-
-=item B<gps_vdop>
-
-Vertical dilution.
-Same as above.
+Look at the documentaiton of your GPS to know more.
=head1 SEE ALSO
=head1 SEE ALSO
@@
-66,6
+73,6
@@
gpsd
=head1 AUTHOR
=head1 AUTHOR
-Nicolas J
ourden E<lt>nicolas.jourden@
laposte.netE<gt>
+Nicolas J
OURDEN E<lt>nicolas.jourden at
laposte.netE<gt>
=cut
=cut