.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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 "Net::IDN::Punycode 3"
.TH Net::IDN::Punycode 3 "2016-08-24" "perl v5.16.3" "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"
Net::IDN::Punycode \- A Bootstring encoding of Unicode for IDNA (RFC\ 3492)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use Net::IDN::Punycode qw(:all);
\&  $punycode = encode_punycode($unicode);
\&  $unicode  = decode_punycode($punycode);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements the Punycode encoding, and only the Punycode encoding.
.PP
This module does not implement any other steps required for converting
internationalised domain names (IDNs) to and from \s-1ASCII.\s0 In particular, it does
not do any string preparation as specified by \fINameprep\fR/\fI\s-1IDNA2008\s0\fR/\fI\s-1PRECIS\s0\fR
and does not add nor remove the \s-1ACE\s0 prefix (\f(CW\*(C`xn\-\-\*(C'\fR). Thus, use
Net::IDN::Encode if you want to convert domain names.
.PP
Punycode is an instance of a more general algorithm called Bootstring, which
allows strings composed from a small set of \*(L"basic\*(R" code points to uniquely
represent any string of code points drawn from a larger set. Punycode is
Bootstring with particular parameter values appropriate for \s-1IDNA.\s0
.SH "WARNING"
.IX Header "WARNING"
You may be tempted to use this module directly and add/remove the \s-1ACE\s0 prefix
(\f(CW\*(C`xn\-\-\*(C'\fR) in your code for performance reasons. Usually, this is not a good
idea.  If you convert domain labels (or other strings) without proper
prepration, you may end up with an \s-1ASCII\s0 encoding that is not interoperable or
even poses security issues due to spoofing.
.PP
Even if you think that your domain names are valid and already mapped to the
correct form, this may not be true. For example, some environments might
automatically convert your perfectly valiad domain names to a different but
equivalent Unicode normalisation form (e.g., \s-1NFD\s0 instead of \s-1NFC\s0), which already
breaks \s-1IDNA.\s0
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
No functions are exported by default. You can use the tag \f(CW\*(C`:all\*(C'\fR
or import them individually.
.PP
The following functions are available:
.IP "encode_punycode($input)" 4
.IX Item "encode_punycode($input)"
Encodes \f(CW$input\fR with Punycode and returns the result.
.Sp
This function will throw an exception on invalid/unencodable input.
.IP "decode_punycode($input)" 4
.IX Item "decode_punycode($input)"
Decodes \f(CW$input\fR with Punycode and returns the result.
.Sp
This function will throw an exception on invalid input.
.SH "AUTHORS"
.IX Header "AUTHORS"
Tatsuhiko Miyagawa <miyagawa@bulknews.net> (versions 0.01 to 0.02)
.PP
Claus Fa\*:rber <CFAERBER@cpan.org> (versions 1.000 and higher)
.SH "LICENSE"
.IX Header "LICENSE"
Copyright 2002\-2004 Tatsuhiko Miyagawa <miyagawa@bulknews.net>
.PP
Copyright 2007\-2014 Claus Fa\*:rber <CFAERBER@cpan.org>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1RFC\s0\ 3492 (<http://www.ietf.org/rfc/rfc3492.txt>),
\&\s-1IETF::ACE\s0, Convert::RACE