Merge branch 'pull/collectd-4.0' into collectd-4.0
authorFlorian Forster <octo@leeloo.lan.home.verplant.org>
Wed, 22 Aug 2007 14:37:29 +0000 (16:37 +0200)
committerFlorian Forster <octo@leeloo.lan.home.verplant.org>
Wed, 22 Aug 2007 14:37:29 +0000 (16:37 +0200)
README
contrib/README
src/collectd-nagios.pod
src/collectd-perl.pod
src/collectd-unixsock.pod
src/collectd.conf.pod
src/collectd.pod

diff --git a/README b/README
index 344d31a..6f59a7a 100644 (file)
--- a/README
+++ b/README
@@ -26,7 +26,7 @@ Features
       voltage sensors.
 
     - battery
-      Batterycharge, -current and volatage of ACPI and PMU based laptop
+      Batterycharge, -current and voltage of ACPI and PMU based laptop
       batteries.
 
     - cpu
@@ -109,7 +109,7 @@ Features
 
     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
-      write your own plugins in Perl and return arbitary values using this
+      write your own plugins in Perl and return arbitrary values using this
       API. See collectd-perl(5).
 
       This plugin is still considered to be experimental and subject to change
@@ -139,7 +139,7 @@ Features
       Users currently logged in.
 
     - vserver
-      System ressources used by Linux VServers.
+      System resources used by Linux VServers.
       See <http://linux-vserver.org/>.
 
     - wireless
@@ -149,7 +149,7 @@ Features
     plugins:
 
     - csv
-      Write to comma seperated values (CSV) files. This needs lots of
+      Write to comma separated values (CSV) files. This needs lots of
       diskspace but is extremely portable and can be analysed with almost
       every program that can analyse anything. Even Microsoft's Excel..
 
@@ -181,7 +181,7 @@ Features
       Writes logmessages to a file or STDOUT/STDERR.
 
     - syslog
-      Logs to the standard UNIX logging mechanismn, syslog.
+      Logs to the standard UNIX logging mechanism, syslog.
 
   * Performance: Since collectd is running as a daemon it doesn't spend much
     time starting up again and again. With the exception of the exec plugin no
@@ -191,7 +191,7 @@ Features
     and multicore processors and makes sure that the daemon isn't idle if only
     one plugins waits for an IO-operation to complete.
     
-  * Once set up, hardly any maintenence is neccessary. Setup is kept as easy
+  * Once set up, hardly any maintenance is necessary. Setup is kept as easy
     as possible and the default values should be okay for most users.
 
 
@@ -232,7 +232,7 @@ Prerequisites
 
   * A POSIX-threads (pthread) implementation.
     Since gathering some statistics is slow (network connections, slow devices,
-    etc) the collectd is parellelized. The POSIX threads interface is being
+    etc) the collectd is parallelized. The POSIX threads interface is being
     used and should be found in various implementations for hopefully all
     platforms.
 
@@ -254,7 +254,7 @@ Prerequisites
   * librrd (optional; headers and library; rrdtool 1.0 and 1.2 both work fine)
     If built without `librrd' the resulting binary will be `client only', i.e.
     will send its values via multicast and not create any RRD files itself.
-    Alternatively you can chose to write CSV-files (Comma Seperated Values)
+    Alternatively you can chose to write CSV-files (Comma Separated Values)
     instead.
 
   * libsensors (optional)
index ab3c978..467ecb3 100644 (file)
@@ -1,5 +1,5 @@
 The files in this directory may be used to perform common tasks that aren't
-exactly `collectd's job. They may or may not require in-depth knowlege of RRD
+exactly `collectd's job. They may or may not require in-depth knowledge of RRD
 files and/or `collectd's inner workings. Use at your own risk.
 
 PerlLib/
@@ -10,9 +10,9 @@ documentation of the .pm-files to find out what they're good for.
 add_rra.sh
 ----------
   Before version 3.9.0 collectd used to create a different set of RRAs. The
-most detailed of these old RRAs hat a one minute resolution. This script can
+most detailed of these old RRAs had a one minute resolution. This script can
 be used to add three more RRAs: minimum, maximum and average with a ten second
-resolution and 2200 rows (~6 hours). This will make houly statistics much more
+resolution and 2200 rows (~6 hours). This will make hourly statistics much more
 interesting. Please note that no sanity- checking whatsoever is performed. You
 can seriously fuck up your RRD files if you don't know what you're doing.
 
index 3acd506..7b2442e 100644 (file)
@@ -46,7 +46,7 @@ handled according to the consolidation function given with the B<-g> option.
 =item B<-g> B<none>I<|>B<average>I<|>B<sum>
 
 When multiple data sources are selected from a value spec they can be handled
-differently dependin on this option. The values of the following meaning:
+differently depending on this option. The values of the following meaning:
 
 =over 4
 
@@ -86,7 +86,7 @@ As usual for Nagios plugins this program writes a short, one line status
 message to STDOUT and signals success or failure with it's return value. It
 exists with a return value of B<0> for success or B<1> or B<2> for warning and
 critical, respectively. If the values is not available or some other error
-occured it returnes B<3> for "unknown". 
+occurred it returns B<3> for "unknown". 
 
 =head1 SEE ALSO
 
index 7b74eee..3e15b88 100644 (file)
@@ -17,7 +17,7 @@ collectd-perl - Documentation of collectd's C<perl plugin>
 
 The C<perl plugin> includes a Perl-interpreter in collectd and provides
 Perl-equivalents of the plugin-functions. This makes it possible to write
-plugins for collectd in Perl. This is a lot more performant than executing a
+plugins for collectd in Perl. This is a lot more efficient than executing a
 Perl-script every time you want to read a value with the C<exec plugin> (see
 L<collectd-exec(5)>) and provides a lot more functionality, too.
 
index 7c0e316..9a142f2 100644 (file)
@@ -36,12 +36,12 @@ The following commands are implemented:
 =item B<GETVAL> I<Identifier>
 
 If the value identified by I<Identifier> (see below) is found the complete
-value-list is returned. The response is a space seperated list of
+value-list is returned. The response is a space separated list of
 name-value-pairs:
 
 I<num> I<name>B<=>I<value>[ I<name>B<=>I<value>[ ...]]
 
-If I<num> is less then zero, an error occured. Otherwise it contains the
+If I<num> is less then zero, an error occurred. Otherwise it contains the
 number of values that follow. Each value is of the form I<name>B<=>I<value>.
 Counter-values are converted to a rate, e.E<nbsp>g. bytes per second.
 Undefined values are returned as B<NaN>.
@@ -54,7 +54,7 @@ Example:
 
 Submits a value (identified by I<Identifier>, see below) to the daemon which
 will dispatch it to all it's write-plugins. The I<Valuelist> is a
-colon-seperated list of the time and the values, each either an integer if the
+colon-separated list of the time and the values, each either an integer if the
 data-source is a counter, of a double if the data-source if of type "gauge".
 You can submit an undefined gauge-value by using B<U>. When submitting B<U> to
 a counter the behavior is undefined. The time is given as epoch (i.E<nbsp>e.
@@ -68,7 +68,7 @@ Example:
 
 =head2 Identifiers
 
-Value or value-lists are identified in a uniform fassion:
+Value or value-lists are identified in a uniform fashion:
 
 I<Hostname>/I<Plugin>/I<Type>
 
index f7c10ad..cd3fc40 100644 (file)
@@ -25,10 +25,10 @@ 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
-B<Apache Webserver>. Each line containes either a key-value-pair or a
+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,
-(floating-point-)numbers or a boolean extression, i.E<nbsp>e. either B<true> or
+(floating-point-)numbers or a boolean expression, i.E<nbsp>e. either B<true> or
 B<false>. String containing of only alphanumeric characters and underscores do
 not need to be quoted.
 
@@ -78,7 +78,7 @@ a value higher than the number of plugins you've loaded is totally useless.
 
 =head1 PLUGIN OPTIONS
 
-Some Plugins may register own options. These options must be inclosed in a
+Some Plugins may register own options. These options must be enclosed in a
 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
 require external configuration, too. The C<apache plugin>, for example,
 required C<mod_status> to be configured in the webserver you're going to
@@ -128,7 +128,7 @@ Optional password needed for authentication.
 =item B<CACert> I<File>
 
 File that holds one or more SSL certificates. If you want to use HTTPS you will
-possibly need this option. What CA certificates come bundeled with C<libcurl>
+possibly need this option. What CA certificates come bundled with C<libcurl>
 and are checked by default depends on the distribution you use.
 
 =back
@@ -188,7 +188,7 @@ Select partitions based on the filesystem type.
 
 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
+partitions are collected if a selection is made. If no selection is configured
 at all, B<all> partitions are selected.
 
 =back
@@ -237,7 +237,7 @@ at most B<16384> to prevent typos and dumb mistakes.
 =head2 Plugin C<exec>
 
 Please make sure to read L<collectd-exec(5)> before using this plugin. It
-contains valueable information on when the executable is executed and the
+contains valuable information on when the executable is executed and the
 output that is expected from it.
 
 =over 4
@@ -285,7 +285,7 @@ a more detailed description see B<IgnoreSelected> below.
 If no configuration if given, the B<traffic>-plugin will collect data from
 all interfaces. This may not be practical, especially for loopback- and
 similar interfaces. Thus, you can use the B<Interface>-option to pick the
-interfaces you're interested in. Sometimes, however, it's easier/prefered
+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
@@ -325,11 +325,11 @@ detailed description see B<IgnoreSelected> below.
 
 If no configuration if given, the B<irq>-plugin will collect data from all
 irqs. This may not be practical, especially if no interrupts happen. Thus, you
-can use the B<Irq>-option to pick the interupt you're interested in.
-Sometimes, however, it's easier/prefered to collect all interupts I<except> a
+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 interupts are ignored
-and all other interupts are collected.
+I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
+and all other interrupts are collected.
 
 =back
 
@@ -408,7 +408,7 @@ Password needed to log into the database.
 
 =item B<Database> I<Database>
 
-Select this database. Defaults to I<no database> which is a perfecly reasonable
+Select this database. Defaults to I<no database> which is a perfectly reasonable
 option for what this plugin does.
 
 =back
@@ -433,13 +433,13 @@ the argument is a multicast address the daemon will join that multicast group.
 If no B<Listen> statement is found the server tries join both, the default IPv6
 multicast group and the default IPv4 multicast group. If no B<Server> statement
 is found the client will try to send data to the IPv6 multicast group first. If
-that failes the client will try the IPv4 multicast group.
+that fails the client will try the IPv4 multicast group.
 
 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 multicast group is C<239.192.74.66>.
 
 The optional I<Port> argument sets the port to use. It can either be given
-using a numeric port number or a service name. If the argument is omited the
+using a numeric port number or a service name. If the argument is omitted the
 default port B<25826> is assumed.
 
 =item B<TimeToLive> I<1-255>
@@ -455,7 +455,7 @@ If set to I<true>, write packets that were received via the network plugin to
 the sending sockets. This should only be activated when the B<Listen>- and
 B<Server>-statements differ. Otherwise packets may be send multiple times to
 the same multicast group. While this results in more network traffic than
-neccessary it's not a huge problem since the plugin has a duplicate detection,
+necessary it's not a huge problem since the plugin has a duplicate detection,
 so the values will not loop.
 
 =item B<CacheFlush> I<Seconds>
@@ -549,7 +549,7 @@ and minor and major pagefaults.
 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 using these settings. If you don't want to dive into the depths of RRDTool, you
-can savely ignore these settings.
+can safely ignore these settings.
 
 =over 4
 
@@ -587,7 +587,7 @@ default is 1200.
 
 =item B<RRATimespan> I<Seconds>
 
-Adds an RRA-timespan, given in seconds. Use this option mulitple times to have
+Adds an RRA-timespan, given in seconds. Use this option multiple times to have
 more then one RRA. If this option is never used, the built-in default of (3600,
 86400, 604800, 2678400, 31622400) is used.
 
@@ -644,7 +644,7 @@ voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 If no configuration if given, the B<sensors>-plugin will collect data from all
 sensors. This may not be practical, especially for uninteresting sensors.
 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
-in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
+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
 and all other sensors are collected.
index d5bd792..5a9f420 100644 (file)
@@ -42,7 +42,7 @@ config-option.
 
 Don't fork to the background. I<collectd> will also B<not> close standard file
 descriptors, detach from the session nor write a pid file. This is mainly
-thought for 'supervisioning' init replacements such as I<runit>.
+thought for 'supervising' init replacements such as I<runit>.
 
 =item B<-h>
 
@@ -63,7 +63,7 @@ There are two big groups of plugins, B<input> and B<output> plugins:
 
 =item
 
-Input plugins are queried periodically. They somehow aquire the current value
+Input plugins are queried periodically. They somehow acquire the current value
 of whatever they where designed to work with and submit these values back to
 the daemon, i. e. they "dispatch" the values. As an example, the C<cpu plugin>
 reads the current cpu-counters of time spent in the various modes (user,