.\" 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::Writer 3pm"
.TH MaxMind::DB::Writer 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::Writer \- Create MaxMind DB database files
.SH "VERSION"
.IX Header "VERSION"
version 0.300003
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use MaxMind::DB::Writer::Tree;
\&
\& my %types = (
\& color => \*(Aqutf8_string\*(Aq,
\& dogs => [ \*(Aqarray\*(Aq, \*(Aqutf8_string\*(Aq ],
\& size => \*(Aquint16\*(Aq,
\& );
\&
\& my $tree = MaxMind::DB::Writer::Tree\->new(
\& ip_version => 6,
\& record_size => 24,
\& database_type => \*(AqMy\-IP\-Data\*(Aq,
\& languages => [\*(Aqen\*(Aq],
\& description => { en => \*(AqMy database of IP data\*(Aq },
\& map_key_type_callback => sub { $types{ $_[0] } },
\& );
\&
\& $tree\->insert_network(
\& \*(Aq8.8.8.0/24\*(Aq,
\& {
\& color => \*(Aqblue\*(Aq,
\& dogs => [ \*(AqFido\*(Aq, \*(AqMs. Pretty Paws\*(Aq ],
\& size => 42,
\& },
\& );
\&
\& open my $fh, \*(Aq>:raw\*(Aq, \*(Aq/path/to/my\-ip\-data.mmdb\*(Aq;
\& $tree\->write_tree($fh);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This distribution contains the code necessary to write MaxMind \s-1DB\s0 database
files . See MaxMind::DB::Writer::Tree
for \s-1API\s0 docs.
.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::Writer
.Ve
.SH "WINDOWS SUPPORT"
.IX Header "WINDOWS SUPPORT"
This distribution does not currently work on Windows. Reasonable patches for
Windows support are very welcome. You will probably need to start by making
Math::Int128 work on Windows, since we use that module's C \s-1API\s0 for dealing
with 128\-bit integers to represent IPv6 addresses numerically.
.SH "SUPPORT"
.IX Header "SUPPORT"
Please report all issues with this code using the GitHub issue tracker at
.
.PP
We welcome patches as pull requests against our GitHub repository at
.
.PP
Bugs may be submitted through .
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Olaf Alders
.IP "\(bu" 4
Greg Oschwald
.IP "\(bu" 4
Dave Rolsky
.IP "\(bu" 4
Mark Fowler
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
.IP "\(bu" 4
Florian Ragwitz
.IP "\(bu" 4
Ilya Melamed
.IP "\(bu" 4
Jan Bieron
.IP "\(bu" 4
Narsimham Chelluri
.IP "\(bu" 4
Thomas J Mather
.IP "\(bu" 4
William Storey
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by MaxMind, Inc.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.