From: Florian Forster <octo@verplant.org>
Date: Sat, 26 Jan 2008 17:00:13 +0000 (+0100)
Subject: Net::Oping: Added a note about the need to be root to the module's POD.
X-Git-Tag: Net-Oping-1.01~2
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;ds=sidebyside;h=3929b04688e0b36669f63da10a70c53cc36d2f83;p=liboping.git

Net::Oping: Added a note about the need to be root to the module's POD.
---

diff --git a/bindings/perl/lib/Net/Oping.pm b/bindings/perl/lib/Net/Oping.pm
index ffaaa1b..2f01d21 100644
--- a/bindings/perl/lib/Net/Oping.pm
+++ b/bindings/perl/lib/Net/Oping.pm
@@ -247,6 +247,15 @@ sub get_error
 
 =back
 
+=head1 CAVEATS
+
+The C<oping> library opens a raw socket to be able to send ICMP packets. On
+most systems normal users are not allowed to do this. This is why on most
+systems the L<ping(1)> utility is installed as SetUID-root. Since, when using
+this module, no external process is spawned B<this> process needs the
+appropriate permissions. This means that either your script has to run as
+superuser or, under Linux, needs the C<CAP_NET_RAW> capability.
+
 =head1 SEE ALSO
 
 L<liboping(3)>