From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Sat, 19 May 2007 13:58:14 +0000 (+0200)
Subject: collectd-email(5): Moved information about the `email plugin' into an own manpage.
X-Git-Tag: collectd-4.0.0-rc10~5
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=79c9bbd7a08532936e9c229e41d1d9201d7b7f21;p=collectd.git

collectd-email(5): Moved information about the `email plugin' into an own manpage.
---

diff --git a/src/Makefile.am b/src/Makefile.am
index ea08a3e2..5303b520 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -549,7 +549,7 @@ collectd_LDADD += "-dlopen" wireless.la
 collectd_DEPENDENCIES += wireless.la
 endif
 
-dist_man_MANS = collectd.1 collectd-nagios.1 collectd.conf.5 collectd-exec.5 collectd-unixsock.5
+dist_man_MANS = collectd.1 collectd-nagios.1 collectd.conf.5 collectd-email.5 collectd-exec.5 collectd-unixsock.5
 #collectd_1_SOURCES = collectd.pod
 
 EXTRA_DIST = types.db
diff --git a/src/collectd-email.pod b/src/collectd-email.pod
new file mode 100644
index 00000000..e19d13ec
--- /dev/null
+++ b/src/collectd-email.pod
@@ -0,0 +1,72 @@
+=head1 NAME
+
+collectd-email - Documentation of collectd's C<email plugin>
+
+=head1 SYNOPSIS
+
+  # See collectd.conf(5)
+  LoadPlugin email
+  # ...
+  <Plugin email>
+    SocketGroup "collectd"
+    SocketPerms "0770"
+    MaxConns 5
+  </Plugin>
+
+=head1 DESCRIPTION
+
+The C<email plugin> opens an UNIX-socket over which one can submit email
+statistics, such as the number of "ham", "spam", "virus", etc. mails
+received/handled, spam scores and matched spam checks.
+
+This plugin is intended to be used with the
+L<Mail::SpamAssassin::Plugin::Collectd> SpamAssassin-plugin which is included
+in F<contrib/>, but is of course not limited to that use.
+
+=head1 OPERATION
+
+This plugin collects data indirectly by providing a UNIX-socket that external
+programs can connect to. A simple line based protocol is used to communicate
+with the plugin:
+
+=over 4
+
+=item
+
+E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
+
+  e:<type>:<size>
+
+If C<size> is less than or equal to zero, C<size> is ignored.
+
+=item
+
+Spam score:
+
+  s:<value>
+
+=item
+
+Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
+
+  c:<type1>[,<type2>,...]
+
+Each line is limited to 256 characters (including the newline character). 
+Longer lines will be ignored.
+
+=back
+
+=head1 SEE ALSO
+
+L<collectd(1)>,
+L<collectd.conf(5)>
+
+=head1 AUTHOR
+
+The C<email plugin> has been written by Sebastian Harl E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
+
+The SpamAssassin-plugin has been written by Alexander Wirt E<lt>formorerE<nbsp>atE<nbsp>formorer.deE<gt>.
+
+This manpage has been written by Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
+
+=cut
diff --git a/src/collectd.pod b/src/collectd.pod
index f0ff5904..5e4b3b24 100644
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -87,29 +87,6 @@ detail. In particular those are L<collectd-exec(5)>, L<collectd-unixsock(5)>,
 
 =head1 SPECIAL PLUGINS
 
-=head2 email
-
-This plugin collects data indirectly by providing a UNIX socket that external
-programs can connect to. A simple line based protocol is used to communicate
-with the plugin:
-
-E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
-
-  e:<type>:<size>
-
-If C<size> is less than or equal to zero, C<size> is ignored.
-
-Spam score:
-
-  s:<value>
-
-Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
-
-  c:<type1>[,<type2>,...]
-
-Each line is limited to 256 characters (including the newline character). 
-Longer lines will be ignored.
-
 =head2 perl
 
 The C<perl plugin> includes a Perl-interpreter in collectd and provides
@@ -240,6 +217,7 @@ The message is passed to all log-callbacks that are registered with collectd.
 =head1 SEE ALSO
 
 L<collectd.conf(5)>,
+L<collectd-email(5)>,
 L<collectd-exec(5)>,
 L<collectd-unixsock(5)>,
 L<http://collectd.org/>