From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Wed, 23 Jan 2008 08:42:33 +0000 (+0100)
Subject: collectd.conf(5), collectd-exec(5): Documented the `NotificationExec' and `NagiosExec... 
X-Git-Tag: collectd-4.3.0beta0~30
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=f4a528f0bc857a568cca1c1af589da8625b19e09;p=collectd.git

collectd.conf(5), collectd-exec(5): Documented the `NotificationExec' and `NagiosExec' options.
---

diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod
index 1a91b7f9..fee83fb3 100644
--- a/src/collectd-exec.pod
+++ b/src/collectd-exec.pod
@@ -9,7 +9,7 @@ collectd-exec - Documentation of collectd's C<exec plugin>
   # ...
   <Plugin exec>
     Exec "myuser:mygroup" "myprog"
-    Exec "otheruser" "/path/to/another/binary"
+    Exec "otheruser" "/path/to/another/binary" "arg0" "arg1"
     NotificationExec "user" "/usr/lib/collectd/exec/handle_notification"
     NagiosExec "nagios:nagios" "/usr/lib/nagios/plugins/check_something"
   </Plugin>
@@ -17,7 +17,9 @@ collectd-exec - Documentation of collectd's C<exec plugin>
 =head1 DESCRIPTION
 
 The C<exec plugin> forks of an executable either to receive values, to dispatch
-notifications to the outside world or to be able to use Nagios plugins.
+notifications to the outside world or to be able to use Nagios plugins. The
+syntax of the configuration is explained in L<collectd.conf(5)> but summarized
+in the above synopsis.
 
 If you want/need better performance or more functionality you should take a
 long look at the C<perl plugin>, L<collectd-perl(5)>.
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 4671ae13..20c84b51 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -285,7 +285,11 @@ output that is expected from it.
 
 =over 4
 
-=item B<Exec> I<User>[:[I<Group>]] I<Executable>
+=item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
+
+=item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
+
+=item B<NagiosExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
 
 Execute the executable I<Executable> as user I<User>. If the user name is
 followed by a colon and a group name, the effective group is set to that group.
@@ -298,6 +302,16 @@ superuser privileges. If the daemon is run as an unprivileged user you must
 specify the same user/group here. If the daemon is run with superuser
 privileges, you must supply a non-root user here.
 
+The executable may be followed by optional arguments that are passed to the
+program. Please note that due to the configuration parsing numbers and boolean
+values may be changed. If you want to be absolutely sure that something is
+passed as-is please enclose it in quotes.
+
+The B<Exec>, B<NotificationExec>, and B<NagiosExec> statements change the
+semantics of the programs executed, i.E<nbsp>e. the data passed to them and the
+response expected from them. This is documented in great detail in
+L<collectd-exec(5)>.
+
 =back
 
 =head2 Plugin C<hddtemp>