diff options
Diffstat (limited to 'ext/GDBM_File/GDBM_File.pm')
-rw-r--r-- | ext/GDBM_File/GDBM_File.pm | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/ext/GDBM_File/GDBM_File.pm b/ext/GDBM_File/GDBM_File.pm index 73bcdbeb24..d612add948 100644 --- a/ext/GDBM_File/GDBM_File.pm +++ b/ext/GDBM_File/GDBM_File.pm @@ -1,3 +1,41 @@ +# GDBM_File.pm -- Perl 5 interface to GNU gdbm library. +=head1 NAME + +GDBM_File - Perl5 access to the gdbm library. + +=head1 SYNOPSIS + + use GDBM_File ; + tie %hash, GDBM_File, $filename, &GDBM_WRCREAT, 0640); + # Use the %hash array. + untie %hash ; + +=head1 DESCRIPTION + +B<GDBM_File> is a module which allows Perl programs to make use of the +facilities provided by the GNU gdbm library. If you intend to use this +module you should really have a copy of the gdbm manualpage at hand. + +Most of the libgdbm.a functions are available through the GDBM_File +interface. + +=head1 AVAILABILITY + +Gdbm is available from any GNU archive. The master site is +C<prep.ai.mit.edu>, but your are strongly urged to use one of the many +mirrors. You can obtain a list of mirror sites by issuing the +command C<finger fsf@prep.ai.mit.edu>. + +=head1 BUGS + +The available functions and the gdbm/perl interface need to be documented. + +=head1 SEE ALSO + +L<perl(1)>, L<DB_File(3)>. + +=cut + package GDBM_File; require Carp; |