This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ext/GDBM_File: Add L<> around pod link
[perl5.git] / ext / GDBM_File / GDBM_File.pm
CommitLineData
4633a7c4 1# GDBM_File.pm -- Perl 5 interface to GNU gdbm library.
bd81798f 2
4633a7c4
LW
3=head1 NAME
4
5GDBM_File - Perl5 access to the gdbm library.
6
7=head1 SYNOPSIS
8
9 use GDBM_File ;
02c45c47 10 tie %hash, 'GDBM_File', $filename, &GDBM_WRCREAT, 0640;
4633a7c4
LW
11 # Use the %hash array.
12 untie %hash ;
13
14=head1 DESCRIPTION
15
16B<GDBM_File> is a module which allows Perl programs to make use of the
17facilities provided by the GNU gdbm library. If you intend to use this
18module you should really have a copy of the gdbm manualpage at hand.
19
20Most of the libgdbm.a functions are available through the GDBM_File
21interface.
22
23=head1 AVAILABILITY
24
16c2cc08
RA
25gdbm is available from any GNU archive. The master site is
26C<ftp.gnu.org>, but you are strongly urged to use one of the many
27mirrors. You can obtain a list of mirror sites from
8a6aac01 28L<http://www.gnu.org/order/ftp.html>.
4633a7c4
LW
29
30=head1 BUGS
31
32The available functions and the gdbm/perl interface need to be documented.
33
6c8d78fb
HS
34The GDBM error number and error message interface needs to be added.
35
4633a7c4
LW
36=head1 SEE ALSO
37
9fe6733a 38L<perl(1)>, L<DB_File(3)>, L<perldbmfilter>.
4633a7c4
LW
39
40=cut
41
a0d0e21e
LW
42package GDBM_File;
43
96318ac8 44use strict;
698828ad 45use warnings;
6642cd87 46our($VERSION, @ISA, @EXPORT);
96318ac8 47
a0d0e21e 48require Carp;
96318ac8 49require Tie::Hash;
a0d0e21e 50require Exporter;
da4061d3 51require XSLoader;
9426adcd 52@ISA = qw(Tie::Hash Exporter);
a0d0e21e
LW
53@EXPORT = qw(
54 GDBM_CACHESIZE
6c8d78fb
HS
55 GDBM_CENTFREE
56 GDBM_COALESCEBLKS
a0d0e21e 57 GDBM_FAST
6c8d78fb 58 GDBM_FASTMODE
a0d0e21e
LW
59 GDBM_INSERT
60 GDBM_NEWDB
8722d079 61 GDBM_NOLOCK
6c8d78fb 62 GDBM_OPENMASK
a0d0e21e
LW
63 GDBM_READER
64 GDBM_REPLACE
6c8d78fb
HS
65 GDBM_SYNC
66 GDBM_SYNCMODE
a0d0e21e
LW
67 GDBM_WRCREAT
68 GDBM_WRITER
69);
70
55157468 71# This module isn't dual life, so no need for dev version numbers.
8a6aac01 72$VERSION = '1.16';
c07a80fd 73
da4061d3 74XSLoader::load();
a0d0e21e 75
a0d0e21e 761;