summaryrefslogtreecommitdiff
path: root/ext/Fcntl/Fcntl.pm
diff options
context:
space:
mode:
Diffstat (limited to 'ext/Fcntl/Fcntl.pm')
-rw-r--r--ext/Fcntl/Fcntl.pm25
1 files changed, 24 insertions, 1 deletions
diff --git a/ext/Fcntl/Fcntl.pm b/ext/Fcntl/Fcntl.pm
index d3f73c4cd7..b9251509db 100644
--- a/ext/Fcntl/Fcntl.pm
+++ b/ext/Fcntl/Fcntl.pm
@@ -1,7 +1,30 @@
package Fcntl;
+=head1 NAME
+
+Fcntl - load the C Fcntl.h defines
+
+=head1 SYNOPSIS
+
+ use Fcntl;
+
+=head1 DESCRIPTION
+
+This module is just a translation of the C F<fnctl.h> file.
+Unlike the old mechanism of requiring a translated F<fnctl.ph>
+file, this uses the B<h2xs> program (see the Perl source distribution)
+and your native C compiler. This means that it has a
+far more likely chance of getting the numbers right.
+
+=head1 NOTE
+
+Only C<#define> symbols get translated; you must still correctly
+pack up your own arguments to pass as args for locking functions, etc.
+
+=cut
+
require Exporter;
-require AutoLoader;
+use AutoLoader;
require DynaLoader;
@ISA = qw(Exporter DynaLoader);
# Items to export into callers namespace by default