email plugin: Made socket settings configurable.

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 86fcf29..f521571 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -160,6 +160,31 @@ TCP-Port to connect to. Defaults to B<3551>.
 
 =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<hddtemp>
 
 =over 4
@@ -232,30 +257,30 @@ Sets the Time-To-Live of generated ICMP packets.
 
 =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<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>
 
@@ -286,6 +311,8 @@ other sensors are collected.
 
 back
 
+=back
+
 =head2 Plugin C<traffic>
 
 =over 4