Net::Oping: Added a note about the need to be root to the module's POD.
[liboping.git] / bindings / perl / lib / Net / Oping.pm
index d33c578..2f01d21 100644 (file)
@@ -29,8 +29,6 @@ configuring the time of live (TTL) are not yet supported by this interface.
 
 =cut
 
-use 5.008007;
-
 use strict;
 use warnings;
 
@@ -39,7 +37,7 @@ use Carp (qw(cluck confess));
 our $VERSION = '1.00';
 
 require XSLoader;
-XSLoader::load('Net::Oping', $VERSION);
+XSLoader::load ('Net::Oping', $VERSION);
 return (1);
 
 =head1 INTERFACE
@@ -249,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)>