Merge branch 'ff/owfs'
authorFlorian Forster <octo@noris.net>
Wed, 23 Jul 2008 15:17:49 +0000 (17:17 +0200)
committerFlorian Forster <octo@noris.net>
Wed, 23 Jul 2008 15:17:49 +0000 (17:17 +0200)
1  2 
src/collectd.conf.pod

diff --combined src/collectd.conf.pod
@@@ -463,7 -463,7 +463,7 @@@ similar interfaces. Thus, you can use t
  interfaces you're interested in. Sometimes, however, it's easier/preferred
  to collect all interfaces I<except> a few ones. This option enables you to
  do that: By setting B<IgnoreSelected> to I<true> the effect of
 -B<Interface> is inversed: All selected interfaces are ignored and all
 +B<Interface> is inverted: All selected interfaces are ignored and all
  other interfaces are collected.
  
  =back
@@@ -503,7 -503,7 +503,7 @@@ irqs. This may not be practical, especi
  can use the B<Irq>-option to pick the interrupt you're interested in.
  Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
  few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 -I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
 +I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
  and all other interrupts are collected.
  
  =back
@@@ -762,7 -762,7 +762,7 @@@ Here are some examples to help you unde
  The behaviour is the same as with all other similar plugins: If nothing is
  selected at all, everything is collected. If some things are selected using the
  options described above, only these statistics are collected. If you set
 -B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
 +B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
  specified statistics will not be collected.
  
  =back
@@@ -928,6 -928,46 +928,46 @@@ L<upsc(8)>
  
  =back
  
+ =head2 Plugin C<onewire>
+ The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
+ L<http://owfs.org/> to read sensors connected via the onewire bus.
+ =over 4
+ =item B<Device> I<Device>
+ Sets the device to read the values from. This can either be a "real" hardware
+ device, such as a serial port or an USB port, or the address of the
+ L<owserver(1)> socket, usually B<localhost:4304>.
+ Though the documentation claims to automatically recognize the given address
+ format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
+ with that version, the following configuration worked for us:
+   <Plugin onewire>
+     Device "-s localhost:4304"
+   </Plugin>
+ =item B<Sensor> I<Sensor>
+ Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
+ below. Sensors are specified without the family byte at the beginning, to you'd
+ use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
+ point.
+ =item B<IgnoreSelected> I<true>|I<false>
+ If no configuration if given, the B<onewire> plugin will collect data from all
+ sensors found. This may not be practical, especially if sensors are added and
+ removed regularly. Sometimes, however, it's easier/preferred to collect only
+ specific sensors or all sensors I<except> a few specified ones. This option
+ enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
+ B<Sensor> is inverted: All selected interfaces are ignored and all other
+ interfaces are collected.
+ =back
  =head2 Plugin C<perl>
  
  This plugin embeds a Perl-interpreter into collectd and provides an interface
@@@ -1303,7 -1343,7 +1343,7 @@@ sensors. This may not be practical, esp
  Thus, you can use the B<Sensor>-option to pick the sensors you're interested
  in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
  few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 -I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 +I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
  and all other sensors are collected.
  
  =back