types.db(5): Added a manpage documenting the format of the TypesDB file.

Appropriate pointers have been added to other manpages where appropriate.

Signed-off-by: Sebastian Harl <sh@tokkee.org>
Signed-off-by: Florian Forster <octo@huhu.verplant.org>

diff --git a/.gitignore b/.gitignore
index 855e36b3ab407f878280b968502d8ce74cb50f2b..5eb8974bed8d8a0f492c885d167903e604ee5ac5 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -46,6 +46,7 @@ src/*.o
 src/collectd
 src/collectd*.1
 src/collectd*.5
+src/types.db.5
 src/config.h.in~
 src/liboconfig/.libs
 src/liboconfig/*.la

diff --git a/src/Makefile.am b/src/Makefile.am
index 7f37fee6550f482446f6999d58a12bbd030d0139..35d79c6dd600e0fee636180a33a4b813e9bd7ffa 100644 (file)
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -633,7 +633,8 @@ endif
 
 dist_man_MANS = collectd.1 collectd-nagios.1 collectd.conf.5 \
                collectd-email.5 collectd-exec.5 collectd-perl.5 \
-               collectd-snmp.5 collectd-unixsock.5 collectdmon.1
+               collectd-snmp.5 collectd-unixsock.5 collectdmon.1 \
+               types.db.5
 
 #collectd_1_SOURCES = collectd.pod
 
@@ -641,7 +642,7 @@ EXTRA_DIST = types.db
 
 EXTRA_DIST += collectd-email.pod collectd-exec.pod collectd-nagios.pod \
        collectd-perl.pod collectd-snmp.pod collectd-unixsock.pod \
-       collectd.conf.pod collectd.pod collectdmon.pod
+       collectd.conf.pod collectd.pod collectdmon.pod types.db.pod
 
 .pod.1:
        pod2man --release=$(VERSION) --center=$(PACKAGE) $< >.pod2man.tmp 2>/dev/null && mv -f .pod2man.tmp $@ || true

diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod
index 4102136b16922a90be628f6e4d4e0df07847433a..7ef5428fbaf60f31965a187d02ab76271d5da30a 100644 (file)
--- a/src/collectd-exec.pod
+++ b/src/collectd-exec.pod
@@ -46,7 +46,8 @@ omitted, too. I<plugin> and each I<instance>-part may be chosen freely as long
 as the tuple (plugin, plugin instance, type instance) uniquely identifies the
 plugin within collectd. I<type> identifies the type and number of values
 (i.E<nbsp>e. data-set) passed to collectd. A large list of predefined
-data-sets is available in the B<types.db> file.
+data-sets is available in the B<types.db> file. See L<types.db(5)> for a
+description of the format of this file.
 
 The I<OptionList> is an optional list of I<Options>, where each option if a
 key-value-pair. A list of currently understood options can be found below, all

diff --git a/src/collectd-perl.pod b/src/collectd-perl.pod
index 00a1cbbbb8bf5ba553ef483b091c33f1e874adeb..194aa54e9c7372bd44df69d293e63396da1cb182 100644 (file)
--- a/src/collectd-perl.pod
+++ b/src/collectd-perl.pod
@@ -193,9 +193,10 @@ argument which simply tells B<plugin_register> what is being registered.)
 The last argument, I<data>, is either a function name or an array-reference.
 If I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
 array-reference which points to an array of hashes. Each hash describes one
-data-source. For the exact layout see B<Data-Set> above. Please note that
+data-set. For the exact layout see B<Data-Set> above. Please note that
 there is a large number of predefined data-sets available in the B<types.db>
-file which are automatically registered with collectd.
+file which are automatically registered with collectd - see L<types.db(5)> for
+a description of the format of this file.
 
 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
 ...) then I<data> is expected to be a function name. If the name is not
@@ -455,6 +456,7 @@ instead.
 L<collectd(1)>,
 L<collectd.conf(5)>,
 L<collectd-exec(5)>,
+L<types.db(5)>,
 L<perl(1)>,
 L<threads(3perl)>,
 L<threads::shared(3perl)>,

diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod
index ea490293f17ab21990536ed06eb533056edd1d77..d0acc06d342bc70d50f3516d325dd7b1d68887c9 100644 (file)
--- a/src/collectd-snmp.pod
+++ b/src/collectd-snmp.pod
@@ -85,7 +85,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>
 

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 7e416b4fe071fc6da85d896350c31fb85bc531b8..4671ae13757777f87d8328e0b27e3391f21b08eb 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -74,7 +74,8 @@ Path to the plugins (shared objects) of collectd.
 
 =item B<TypesDB> I<File> [I<File> ...]
 
-Set one or more files that contain the data-set descriptions.
+Set one or more files that contain the data-set descriptions. See
+L<types.db(5)> for a description of the format of this file.
 
 =item B<Interval> I<Seconds>
 
@@ -1144,6 +1145,7 @@ L<collectd(1)>,
 L<collectd-exec(5)>,
 L<collectd-perl(5)>,
 L<collectd-unixsock(5)>,
+L<types.db(5)>,
 L<hddtemp(8)>,
 L<kstat(3KSTAT)>,
 L<mbmon(1)>,

diff --git a/src/collectd.pod b/src/collectd.pod
index e09fd841322489279ddc9f1a5d118103fbd9d49a..2a326bb6fa544d2de91ac5bb3abfc5274d76e721 100644 (file)
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -102,6 +102,7 @@ L<collectd-exec(5)>,
 L<collectd-perl(5)>,
 L<collectd-snmp(5)>,
 L<collectd-unixsock(5)>,
+L<types.db(5)>,
 L<http://collectd.org/>
 
 =head1 AUTHOR

diff --git a/src/types.db.pod b/src/types.db.pod
new file mode 100644 (file)
index 0000000..f0a49f6
--- /dev/null
+++ b/src/types.db.pod
@@ -0,0 +1,51 @@
+=head1 NAME
+
+types.db - Data-set specifications for the system statistics collection daemon
+B<collectd>
+
+=head1 SYNOPSIS
+
+  bitrate    value:GAUGE:0:4294967295
+  counter    value:COUNTER:U:U
+  if_octets  rx:COUNTER:0:4294967295, tx:COUNTER:0:4294967295
+
+=head1 DESCRIPTION
+
+The types.db file contains one line for each data-set specification. Each line
+consists of two fields delimited by spaces and/or horizontal tabs. The first
+field defines the name of the data-set, while the second field defines a list
+of data-source specifications, delimited by spaces and, optionally, a comma
+(",") right after each list-entry.
+
+The format of the data-source specification has been inspired by RRDtool's
+data-source specification. Each data-source is defined by a quadruple made up
+of the data-source name, type, minimal and maximal values, delimited by colons
+(":"): I<ds-name>:I<ds-type>:I<min>:I<max>. I<ds-type> may be either
+B<COUNTER> or B<GAUGE>. I<min> and I<max> define the range of valid values for
+data stored for this data-source. If B<U> is specified for either the min or
+max value, it will be set to unknown, meaning that no range checks will
+happen. See L<rrdcreate(1)> for more details.
+
+=head1 FILES
+
+The location of the types.db file is defined by the B<TypesDB> configuration
+option (see L<collectd.conf(5)>). If you want to specify custom data-sets, you
+should do so by using a custom file specified as an additional argument to the
+B<TypesDB> option.
+
+=head1 SEE ALSO
+
+L<collectd(1)>,
+L<collectd.conf(5)>,
+L<rrdcreate(1)>
+
+=head1 AUTHOR
+
+B<collectd> has been written by Florian Forster
+E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
+
+This manpage has been written by Sebastian Harl
+E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
+
+=cut
+