{GPL, other}: Relicense to MIT license.
[collectd.git] / src / types.db.pod
index 11c7f79..f0af60e 100644 (file)
@@ -1,3 +1,5 @@
+=encoding UTF-8
+
 =head1 NAME
 
 types.db - Data-set specifications for the system statistics collection daemon
@@ -21,7 +23,8 @@ 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
+B<ABSOLUTE>, B<COUNTER>, B<DERIVE>, 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.
@@ -30,9 +33,22 @@ happen. See L<rrdcreate(1)> for more details.
 
 The location of the types.db file is defined by the B<TypesDB> configuration
 option (see L<collectd.conf(5)>). It defaults to collectd's shared data
-directory, i.E<nbsp>e. F<I<prefix>/share/collectd/>. 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.
+directory, i.E<nbsp>e. F<I<prefix>/share/collectd/>.
+
+=head1 CUSTOM TYPES
+
+If you want to specify custom types, you should do so by specifying a custom
+file in addition to the default one (see L<FILES>) above. You can do that by
+having multiple B<TypesDB> statements in your configuration file or by
+specifying more than one file in one line.
+
+For example:
+
+ TypesDB "/opt/collectd/share/collectd/types.db"
+ TypesDB "/opt/collectd/etc/types.db.custom"
+
+B<Note>: Make sure to make this file available on all systems if you're
+sending values over the network.
 
 =head1 SEE ALSO
 
@@ -43,7 +59,7 @@ L<rrdcreate(1)>
 =head1 AUTHOR
 
 B<collectd> has been written by Florian Forster
-E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
+E<lt>octoE<nbsp>atE<nbsp>collectd.orgE<gt>.
 
 This manpage has been written by Sebastian Harl
 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.