README-dev.md
1== Running valgrind
2
3This distro ships with a valgrind suppressions file that suppresses leaks that
4occur from inside the Perl core as well as leaks from other modules.
5
6You can valgrind with a command like this:
7
8 ./Build && \
9 valgrind --leak-check=full --num-callers=50 --suppressions=./valgrind.supp \
10 -- perl -Mblib -I ../MaxMind-DB-Reader-perl/lib/ t/MaxMind/DB/Reader.t
11
12This assumes you have the MaxMind-DB-Reader-perl repo checked out in the
13parent directory.
14
README.md
1# NAME
2
3MaxMind::DB::Reader::XS - Fast XS implementation of MaxMind DB reader
4
5# VERSION
6
7version 1.000008
8
9# SYNOPSIS
10
11 my $reader = MaxMind::DB::Reader->new( file => 'path/to/database.mmdb' );
12
13 my $record = $reader->record_for_address('1.2.3.4');
14
15# DESCRIPTION
16
17Simply installing this module causes [MaxMind::DB::Reader](https://metacpan.org/pod/MaxMind::DB::Reader) to use the XS
18implementation, which is much faster than the Perl implementation.
19
20The XS implementation links against the
21[libmaxminddb](http://maxmind.github.io/libmaxminddb/) library.
22
23See [MaxMind::DB::Reader](https://metacpan.org/pod/MaxMind::DB::Reader) for API details.
24
25# VERSIONING POLICY
26
27This module uses semantic versioning as described by
28[http://semver.org/](http://semver.org/). Version numbers can be read as X.YYYZZZ, where X is the
29major number, YYY is the minor number, and ZZZ is the patch number.
30
31# MAC OS X SUPPORT
32
33If you're running into install errors under Mac OS X, you may need to force a
34build of the 64 bit binary. For example, if you're installing via `cpanm`:
35
36 ARCHFLAGS="-arch x86_64" cpanm MaxMind::DB::Reader::XS
37
38# UBUNTU SUPPORT
39
40The version of libmaxminddb that is available by default with Ubuntu may be
41too old for this level of MaxMind::DB::Reader::XS. However, we do maintain a
42Launchpad PPA for all supported levels of Ubuntu.
43
44 https://launchpad.net/~maxmind/+archive/ubuntu/ppa
45
46Please visit the PPA page for more information, or, to configure your system,
47run as root:
48
49 # apt-add-repository ppa:maxmind/ppa
50 # apt-get update
51
52The PPA is now configured, and you may install (or upgrade) the libmaxminddb
53library via the usual apt commands.
54
55# SUPPORT
56
57This module is deprecated and will only receive fixes for major bugs and
58security vulnerabilities. New features and functionality will not be added.
59
60Please report all issues with this code using the GitHub issue tracker at
61[https://github.com/maxmind/MaxMind-DB-Reader-XS/issues](https://github.com/maxmind/MaxMind-DB-Reader-XS/issues).
62
63Bugs may be submitted through [https://github.com/maxmind/MaxMind-DB-Reader-XS/issues](https://github.com/maxmind/MaxMind-DB-Reader-XS/issues).
64
65# AUTHORS
66
67- Boris Zentner <bzentner@maxmind.com>
68- Dave Rolsky <drolsky@maxmind.com>
69- Ran Eilam <reilam@maxmind.com>
70
71# CONTRIBUTORS
72
73- Andy Jack <github@veracity.ca>
74- Chris Weyl <cweyl@alumni.drew.edu>
75- Florian Ragwitz <rafl@debian.org>
76- Greg Oschwald <goschwald@maxmind.com>
77- Hidenori Sugiyama <madogiwa@gmail.com>
78- Mark Fowler <mark@twoshortplanks.com>
79- Olaf Alders <oalders@maxmind.com>
80
81# COPYRIGHT AND LICENSE
82
83This software is Copyright (c) 2013 - 2019 by MaxMind, Inc.
84
85This is free software, licensed under:
86
87 The Artistic License 2.0 (GPL Compatible)
88