diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 86fcf296c5b26bf5d732a17bf65864a4309297e5..aa4799a48ac0dad96b5912cf3e0b4d89e37486d7 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
=back
=back
+=head2 Plugin C<df>
+
+=over 4
+
+=item B<Device> I<Device>
+
+Select partitions based on the devicename.
+
+=item B<MountPoint> I<Directory>
+
+Select partitions based on the mountpoint.
+
+=item B<FSType> I<FSType>
+
+Select partitions based on the filesystem type.
+
+=item B<IgnoreSelected> I<true>|I<false>
+
+Invert the selection: If set to true, all partitions B<except> the ones that
+match any one of the criteria are collected. By default only selected
+partitions are collected if a selection is made. If no selection is conifured
+at all, B<all> partitions are selected.
+
+=back
+
+=head2 Plugin C<dns>
+
+=over 4
+
+=item B<Interface> I<Interface>
+
+The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
+option sets the interface that should be used. If this option is not set, or
+set to "any", the plugin will try to get packets from B<all> interfaces. This
+may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
+
+=item B<IgnoreSource> I<IP-address>
+
+Ignore packets that originate from this address.
+
+=back
+
+=head2 Plugin C<email>
+
+=over 4
+
+=item B<SocketGroup> I<Group>
+
+If running as root change the group of the UNIX-socket after it has been
+created. Defaults to B<collectd>.
+
+=item B<SocketPerms> I<Permissions>
+
+Change the file permissions of the UNIX-socket after it has been created. The
+permissions must be given as a numeric, octal value as you would pass to
+L<chmod(1)>. Defaults to B<0770>.
+
+=item B<MaxConns> I<Number>
+
+Sets the maximum number of connections that can be handled in parallel. Since
+this many threads will be started immediately setting this to a very high
+value will waste valuable resources. Defaults to B<5> and will be forced to be
+at most B<16384> to prevent typos and dumb mistakes.
+
+=back
+
=head2 Plugin C<hddtemp>
=over 4
=head2 Plugin C<hddtemp>
=over 4
=item B<ExtendedSensorNaming> I<true>|I<false>
=item B<ExtendedSensorNaming> I<true>|I<false>
-If set to I<true> this option switches on the extended sensors
-and RRD files naming.
+If set to I<true> this option switches on the extended sensors and RRD-files
+naming. This option exists to preserve backwards compatibility. It is
+recommended that you set this option to I<true>. The default is I<false> to
+maintain compatibility only.
-Sensors get names like I<chip-bus-address/type-feature>
-(e.g. I<it8712-isa-0290/voltage-in1>) and RRD files are therefore
-stored in a standalone directory inside the B<DataDir> directory and get
-names like I<lm_sensors-chip-bus-address/type-feature.rrd>
-(e.g. I<lm_sensors-it8712-isa-0290/voltage-in1.rrd>).
+Sensors get names like I<chip-bus-address/type-feature> (e.g.
+I<it8712-isa-0290/voltage-in1>) and RRD files are therefore stored in a
+standalone directory inside the B<DataDir> directory and get names like
+I<lm_sensors-chip-bus-address/type-feature.rrd> (e.g.
+I<lm_sensors-it8712-isa-0290/voltage-in1.rrd>).
The B<ExtendedSensorNaming> option breaks the compatibility with previous
sensors and RRD files naming and the place where RRDs are stored. If you turn
it on, the plugin will create new RRD files in a standalone directory inside
The B<ExtendedSensorNaming> option breaks the compatibility with previous
sensors and RRD files naming and the place where RRDs are stored. If you turn
it on, the plugin will create new RRD files in a standalone directory inside
-the B<DataDir> directory and without previous history. You can rename
-previous RRD files to the new ones to continue collecting data into the same
-RRDs.
-
-If not set or set to I<false>, the extended naming is not active. Sensors
-get names like I<chip-feature> (e.g. I<it8712-in1>) and RRD files
-are stored in the main B<DataDir> directory and get names like
-I<sensors-chip-feature.rrd> (e.g. I<sensors-it8712-in1.rrd>).
-You simply continue using the plugin the old way and additionally also
-getting data for newly added sensors in this mode.
+the B<DataDir> directory and without previous history. You can rename ``old''
+RRD-files to preserve already collected statistics, because the file layout
+hasn't changed. If you have two chips of the same type, you need to use
+B<ExtendedSensorNaming> in order to collect information from both chips.
-Default setting is I<false>.
+If not set or set to I<false>, the extended naming is not active. Sensors get
+names like I<chip-feature> (e.g. I<it8712-in1>) and RRD files are stored in the
+main B<DataDir> directory and get names like I<sensors-chip-feature.rrd> (e.g.
+I<sensors-it8712-in1.rrd>). You simply continue using the plugin the old way
+and additionally also getting data for newly added sensors in this mode.
=item B<Sensor> I<chip-feature> or B<Sensor> I<chip-bus-address/type-feature>
=item B<Sensor> I<chip-feature> or B<Sensor> I<chip-bus-address/type-feature>
back
back
+=back
+
=head2 Plugin C<traffic>
=over 4
=head2 Plugin C<traffic>
=over 4