.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MaxMind::DB::Reader::XS 3pm"
.TH MaxMind::DB::Reader::XS 3pm "2022-10-20" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MaxMind::DB::Reader::XS \- Fast XS implementation of MaxMind DB reader
.SH "VERSION"
.IX Header "VERSION"
version 1.000009
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $reader = MaxMind::DB::Reader\->new( file => \*(Aqpath/to/database.mmdb\*(Aq );
\&
\& my $record = $reader\->record_for_address(\*(Aq1.2.3.4\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Simply installing this module causes MaxMind::DB::Reader to use the \s-1XS\s0
implementation, which is much faster than the Perl implementation.
.PP
The \s-1XS\s0 implementation links against the
libmaxminddb library.
.PP
See MaxMind::DB::Reader for \s-1API\s0 details.
.SH "VERSIONING POLICY"
.IX Header "VERSIONING POLICY"
This module uses semantic versioning as described by
. Version numbers can be read as X.YYYZZZ, where X is the
major number, \s-1YYY\s0 is the minor number, and \s-1ZZZ\s0 is the patch number.
.SH "MAC OS X SUPPORT"
.IX Header "MAC OS X SUPPORT"
If you're running into install errors under Mac \s-1OS X,\s0 you may need to force a
build of the 64 bit binary. For example, if you're installing via \f(CW\*(C`cpanm\*(C'\fR:
.PP
.Vb 1
\& ARCHFLAGS="\-arch x86_64" cpanm MaxMind::DB::Reader::XS
.Ve
.SH "UBUNTU SUPPORT"
.IX Header "UBUNTU SUPPORT"
The version of libmaxminddb that is available by default with Ubuntu may be
too old for this level of MaxMind::DB::Reader::XS. However, we do maintain a
Launchpad \s-1PPA\s0 for all supported levels of Ubuntu.
.PP
.Vb 1
\& https://launchpad.net/~maxmind/+archive/ubuntu/ppa
.Ve
.PP
Please visit the \s-1PPA\s0 page for more information, or, to configure your system,
run as root:
.PP
.Vb 2
\& # apt\-add\-repository ppa:maxmind/ppa
\& # apt\-get update
.Ve
.PP
The \s-1PPA\s0 is now configured, and you may install (or upgrade) the libmaxminddb
library via the usual apt commands.
.SH "SUPPORT"
.IX Header "SUPPORT"
This module is deprecated and will only receive fixes for major bugs and
security vulnerabilities. New features and functionality will not be added.
.PP
Please report all issues with this code using the GitHub issue tracker at
.
.PP
Bugs may be submitted through .
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Boris Zentner
.IP "\(bu" 4
Dave Rolsky
.IP "\(bu" 4
Ran Eilam
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
.IP "\(bu" 4
Andy Jack
.IP "\(bu" 4
Chris Weyl
.IP "\(bu" 4
Florian Ragwitz
.IP "\(bu" 4
Greg Oschwald
.IP "\(bu" 4
Hidenori Sugiyama
.IP "\(bu" 4
Mark Fowler
.IP "\(bu" 4
Nick Logan
.IP "\(bu" 4
Olaf Alders
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2013 \- 2022 by MaxMind, Inc.
.PP
This is free software, licensed under:
.PP
.Vb 1
\& The Artistic License 2.0 (GPL Compatible)
.Ve