summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 84d0070)
raw | patch | inline | side by side (parent: 84d0070)
author | Florian Forster <octo@leeloo.lan.home.verplant.org> | |
Wed, 23 Jan 2008 08:42:33 +0000 (09:42 +0100) | ||
committer | Florian Forster <octo@leeloo.lan.home.verplant.org> | |
Wed, 23 Jan 2008 08:42:33 +0000 (09:42 +0100) |
src/collectd-exec.pod | patch | blob | history | |
src/collectd.conf.pod | patch | blob | history |
diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod
index 1a91b7f9065bacaf06d742ea01c0aeeb42b80079..fee83fb3d133126b85f93c88b001bb35a5036620 100644 (file)
--- a/src/collectd-exec.pod
+++ b/src/collectd-exec.pod
# ...
<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>
=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 4671ae13757777f87d8328e0b27e3391f21b08eb..20c84b51bf32476a3060c01ad99161a47557a85e 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
=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.
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>