collectd: The new `FQDNLookup' option controls whether or not the FQDN should be...

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 56c313a..d33b280 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -24,7 +24,7 @@ B<collectd> behaves. The most significant option is B<LoadPlugin>, which
 controls which plugins to load. These plugins ultimately define collectd's
 behavior.
 
-The syntax of this config file is similar to the config file of the famos
+The syntax of this config file is similar to the config file of the famous
 B<Apache Webserver>. Each line contains either a key-value-pair or a
 section-start or -end. Empty lines and everything after the hash-symbol `#' is
 ignored. Values are either string, enclosed in double-quotes,
@@ -83,6 +83,23 @@ you may want to increase this if you have more than five plugins that take a
 long time to read. Mostly those are plugin that do network-IO. Setting this to
 a value higher than the number of plugins you've loaded is totally useless.
 
+=item B<Hostname> I<Name>
+
+Sets the hostname that identifies a host. If you omit this setting, the
+hostname will be determinded using the L<gethostname(2)> system call.
+
+=item B<FQDNLookup> B<true|false>
+
+If B<Hostname> is determined automatically this setting controls whether or not
+the daemon should try to figure out the "full qualified domain name", FQDN.
+This is done using a lookup of the name returned by C<gethostname>.
+
+Using this feature (i.E<nbsp>e. setting this option to B<true>) is recommended.
+However, to preserve backwards compatibility the default is set to B<false>.
+The sample config file that is installed with C<makeE<nbsp>install> includes a
+line with sets this option, though, so that default installations will have
+this setting enabled.
+
 =back
 
 =head1 PLUGIN OPTIONS
@@ -371,6 +388,10 @@ B<stderr> can be used to write to the standard output and standard error
 channels, respectively. This, of course, only makes much sense when collectd is
 running in foreground- or non-daemon-mode.
 
+=item B<Timestamp> B<true>|B<false>
+
+Prefix all lines printed by the current time. Defaults to B<true>.
+
 =back
 
 =head2 Plugin C<mbmon>
@@ -589,7 +610,7 @@ either.
 
 =head2 Plugin C<nginx>
 
-This plugin collects the number of connections and requests handeled by the
+This plugin collects the number of connections and requests handled by the
 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
 queries the page provided by the C<ngx_http_stub_status_module> module, which
 isn't compiled by default. Please refer to
@@ -829,13 +850,13 @@ specifically.
 =item B<LocalPort> I<Port>
 
 Count the connections to a specific local port. This can be used to see how
-many connections are handeled by a specific daemon, e.E<nbsp>g. the mailserver.
+many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
 You have to specify the port in numeric form, so for the mailserver example
 you'd need to set B<25>.
 
 =item B<RemotePort> I<Port>
 
-Count the connections to a specific remote port. This is usefull to see how
+Count the connections to a specific remote port. This is useful to see how
 much a remote service is used. This is most useful if you want to know how many
 connections a local service has opened to remote services, e.E<nbsp>g. how many
 connections a mail server or news server has to other mail or news servers, or