Merge branch 'collectd-4.10' into collectd-5.0

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 7579664..de3e516 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -72,15 +72,19 @@ options are allowed inside a B<LoadPlugin> block:
 If enabled, collectd will export all global symbols of the plugin (and of all
 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
 available for resolving unresolved symbols in subsequently loaded plugins if
-that is supported by your system. By default, this is disabled.
+that is supported by your system.
 
-This is useful (or possibly even required), e.E<nbsp>g., when loading a plugin
-that embeds some scripting language into the daemon (e.E<nbsp>g. the C<perl>
-or C<python> plugins). Scripting languages usually provide means to load
+This is useful (or possibly even required), e.g., when loading a plugin that
+embeds some scripting language into the daemon (e.g. the I<Perl> and
+I<Python plugins>). Scripting languages usually provide means to load
 extensions written in C. Those extensions require symbols provided by the
-interpreter, which is loaded as a dependency of the respective collectd
-plugin. See the documentation of those plugins (e.E<nbsp>g.,
-L<collectd-perl(5)> or L<collectd-python(5)>) for details.
+interpreter, which is loaded as a dependency of the respective collectd plugin.
+See the documentation of those plugins (e.g., L<collectd-perl(5)> or
+L<collectd-python(5)>) for details.
+
+By default, this is disabled. As a special exception, if the plugin name is
+either C<perl> or C<python>, the default is changed to enabled in order to keep
+the average user from ever having to deal with this low level linking stuff.
 
 =back
 
@@ -2059,8 +2063,10 @@ Hostname of the database server. Defaults to B<localhost>.
 =item B<User> I<Username>
 
 Username to use when connecting to the database. The user does not have to be
-granted any privileges (which is synonym to granting the C<USAGE> privilege).
-Any existing MySQL user will do.
+granted any privileges (which is synonym to granting the C<USAGE> privilege),
+unless you want to collectd replication statistics (see B<MasterStats> and
+B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
+(or C<SUPER>) privileges. Else, any existing MySQL user will do.
 
 =item B<Password> I<Password>
 
@@ -2092,7 +2098,9 @@ C<mysql_real_connect> function for details.
 
 =item B<SlaveStats> I<true|false>
 
-Enable the collection of master / slave statistics in a replication setup.
+Enable the collection of master / slave statistics in a replication setup. In
+order to be able to get access to these statistics, the user needs special
+privileges. See the B<User> documentation above.
 
 =item B<SlaveNotifications> I<true|false>
 
@@ -2850,7 +2858,8 @@ and are checked by default depends on the distribution you use.
 This plugin sends a desktop notification to a notification daemon, as defined
 in the Desktop Notification Specification. To actually display the
 notifications, B<notification-daemon> is required and B<collectd> has to be
-able to access the X server.
+able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
+environment variables have to be set correctly) and the D-Bus message bus.
 
 The Desktop Notification Specification can be found at
 L<http://www.galago-project.org/specs/notification/>.
@@ -4168,34 +4177,20 @@ L<collectd-snmp(5)>. Please see there for details.
 =head2 Plugin C<swap>
 
 The I<Swap plugin> collects information about used and available swap space. On
-Solaris, it is possible to collect information on physical swap devices and the
-view of the virtual memory subsystem on the matter. On I<Solaris>, the
-following options are available:
+I<Solaris>, the following options are available:
 
 =over 4
 
-=item B<ReportPhysical> B<combined>|B<separate>|B<false>
+=item B<ReportByDevice> B<false>|B<true>
 
-Configures how to report physical swap devices. If B<combined> is used (the
+Configures how to report physical swap devices. If set to B<false> is used (the
 default), the summary over all swap devices is reported only, i.e. the globally
-used and available space over all devices. If B<separate> is configured, the
-used and available space of each device will be reported separately. B<false>
-deactivates collection of physical swap information (only valid if collection
-via L<kstat(3KSTAT)> is available).
+used and available space over all devices. If B<true> is configured, the used
+and available space of each device will be reported separately.
 
 This option is only available if the I<Swap plugin> can use the L<swapctl(2)>
 mechanism under I<Solaris>.
 
-=item B<ReportVirtual> B<false>|B<true>
-
-Configures whether or not to report the view of the virtual memory subsystem on
-swap space. This information is used under Solaris if L<swapctl(2)> is not
-available and was the default behavior under I<Solaris> in I<collectdE<nbsp>4>.
-
-This option is only available if the I<Swap plugin> can use L<swapctl(2)> and
-L<kstat(3KSTAT)> to collect swap statistics under I<Solaris>. It defaults to
-B<false>.
-
 =back
 
 =head2 Plugin C<syslog>