X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcollectd-snmp.pod;h=fd7a50896486211c3fac9b0ef6d10304738dcb4c;hb=31ee0e5282b59f89ac5c9bcaebb993450e45dba1;hp=a08b69ed3e7e6527bdebb9ecca86b1d9c3f66308;hpb=b7d4060cacd04d4bd0e174e85f91ca5afcacf01d;p=collectd.git

diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod
index a08b69ed..fd7a5089 100644
--- a/src/collectd-snmp.pod
+++ b/src/collectd-snmp.pod
@@ -1,3 +1,5 @@
+=encoding UTF-8
+
 =head1 NAME
 
 collectd-snmp - Documentation of collectd's C<snmp plugin>
@@ -33,7 +35,7 @@ collectd-snmp - Documentation of collectd's C<snmp plugin>
       Version 1
       Community "community_string"
       Collect "std_traffic"
-      Inverval 120
+      Interval 120
     </Host>
     <Host "some.server.mydomain.org">
       Address "192.168.0.42"
@@ -67,9 +69,8 @@ and ten threads are used.
 Since the aim of the C<snmp plugin> is to provide a generic interface to SNMP,
 it's configuration is not trivial and may take some time.
 
-Since the C<Net-SNMP> library is used you cann use all the environment
-variables that are interpreted by that package. See L<snmpcmd(1)> for more
-details.
+Since the C<Net-SNMP> library is used you can use all the environment variables
+that are interpreted by that package. See L<snmpcmd(1)> for more details.
 
 There are two types of blocks that can be contained in the
 C<E<lt>PluginE<nbsp>snmpE<gt>> block: B<Data> and B<Host>:
@@ -86,7 +87,7 @@ queried. The following options can be set:
 collectd's type that is to be used, e.E<nbsp>g. "if_octets" for interface
 traffic or "users" for a user count. The types are read from the B<TypesDB>
 (see L<collectd.conf(5)>), so you may want to check for which types are
-defined.
+defined. See L<types.db(5)> for a description of the format of this file.
 
 =item B<Table> I<true|false>
 
@@ -146,7 +147,7 @@ copied into the value-list. In this case I<Instance> may be empty, i.E<nbsp>e.
 
 If B<Table> is set to I<true>, you may feel the need to add something to the
 instance of the files. If set, I<String> is prepended to the instance as
-determinded by querying the agent. When B<Table> is set to I<false> this option
+determined by querying the agent. When B<Table> is set to I<false> this option
 has no effect.
 
 The C<UPS-MIB> is an example where you need this setting: It has voltages of
@@ -176,7 +177,8 @@ traffic.
 The gauge-values returned by the SNMP-agent are multiplied by I<Value>.  This
 is useful when values are transfered as a fixed point real number. For example,
 thermometers may transfer B<243> but actually mean B<24.3>, so you can specify
-a scale value of B<0.1> to correct this. The default value is of course B<1.0>.
+a scale value of B<0.1> to correct this. The default value is, of course,
+B<1.0>.
 
 This value is not applied to counter-values.
 
@@ -185,7 +187,7 @@ This value is not applied to counter-values.
 I<Value> is added to gauge-values returned by the SNMP-agent after they have
 been multiplied by any B<Scale> value. If, for example, a thermometer returns
 degrees Kelvin you could specify a shift of B<273.15> here to store values in
-degrees Celsius. The default value is is course B<0.0>.
+degrees Celsius. The default value is, of course, B<0.0>.
 
 This value is not applied to counter-values.
 
@@ -207,7 +209,7 @@ Set the address to connect to.
 
 =item B<Version> B<1>|B<2>
 
-Set the SNMP version to use. When giving B<2> version 2c is actually used.
+Set the SNMP version to use. When giving B<2> version C<2c> is actually used.
 Version 3 is not supported by this plugin.
 
 =item B<Community> I<Community>
@@ -222,16 +224,11 @@ before using it here.
 
 =item B<Interval> I<Seconds>
 
-Collect data from this host every I<Seconds> seconds. This value needs to be a
-multiple of the global B<Interval> setting and, if it is not, will be rounded
-B<down> to one and a warning is logged in this case. So if your global
-B<Interval> is set to I<10> and you configure I<25> here, it's rounded down to
-I<20>. By default the global B<Interval> setting will be used.
-
-This option is meant for devices with not much CPU power, e.E<nbsp>g. network
-equipment such as switches, embedded devices, rack monitoring systems and so
-on. Since the B<Step> of generated RRD files depends on this setting it's
-wise to select a reasonable value once and never change it.
+Collect data from this host every I<Seconds> seconds. This option is meant for
+devices with not much CPU power, e.E<nbsp>g. network equipment such as
+switches, embedded devices, rack monitoring systems and so on. Since the
+B<Step> of generated RRD files depends on this setting it's wise to select a
+reasonable value once and never change it.
 
 =back