.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Net::IDN::Overview 3"
.TH Net::IDN::Overview 3 2023-07-26 "perl v5.38.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
Net::IDN::Overwiew \- Internationalized Domain Names for Applications (IDNA)
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`Net::IDN::*\*(C'\fR modules provide a framework for the handling of
Internationalized Domain Names for Applications (IDNA) in perl programmes.
.PP
This document provides an overview of the available modules in order to 
allow you to choose the best module for the task at hand.
.SS "AVAILABLE MODULES"
.IX Subsection "AVAILABLE MODULES"
\fIHIGH-LEVEL (USE THIS)\fR
.IX Subsection "HIGH-LEVEL (USE THIS)"
.IP Net::IDN::Encode 4
.IX Item "Net::IDN::Encode"
provides a high-level interface for converting domain names (and
for convenience, email addresses).
.Sp
Use this module if you just want to convert domain names and don't
care about how this is done internally.
.Sp
Currently, this module uses Net::IDN::UTS46. However, this
might change in the future if another specification (e.g. a
revision of IDNA2008) becomes more appropriate.
.Sp
The author aims for Net::IDN::Encode to always use the specification that will
provide the "least surprising" results.
.PP
\fISTANDARD-SPECIFIC\fR
.IX Subsection "STANDARD-SPECIFIC"
.PP
These modules implement different versions of the the IDNA
specifications. Use one of these modules only if you require
compatibility with a specific incarnation of IDNA.
.IP Net::IDN::IDNA2003 4
.IX Item "Net::IDN::IDNA2003"
implements the original IDNA specification, released in 2003
(IDNA2003), which is now obsolete.
.Sp
IDNA2003 is defined in RFC\ 3490 <http://tools.ietf.org/rfc/3490>
and related documents.
.IP Net::IDN::UTS46 4
.IX Item "Net::IDN::UTS46"
implements Unicode Technical Standard #46 (UTS #46
<http://unicode.org/reports/tr46/>), Unicode IDNA Compatibility
Processing.  This specification supports all domain names allowed
under either IDNA2003 or IDNA2008.
.PP
\fIENCODING\fR
.IX Subsection "ENCODING"
.IP Net::IDN::Punycode 4
.IX Item "Net::IDN::Punycode"
performs the actual conversion between the ASCII and Unicode form
of strings.  Punycode is defined in RFC\ 3492
<http://tools.ietf.org/rfc/3492> and related documents.
.Sp
Usually, it is not a good idea to use this module directly. If you
convert domain labels (or other strings) without proper
preparation, you may end up with an ASCII encoding that is not
interoperable or poses security issues due to spoofing.
.Sp
Even if you think that your domain names are valid and in
already-mapped format, you might be fooled by different Unicode
normalization forms (for example, some environments might
automatically convert your data to NFD, which breaks IDNA).
.PP
\fIDEPRECATED/COMPATIBILITY\fR
.IX Subsection "DEPRECATED/COMPATIBILITY"
.PP
These modules are only maintained in order to not break
applications that might rely on them
.IP Encode::Punycode 4
.IX Item "Encode::Punycode"
provides an Encode plugin for Punycode. As Punycode is not a
general-purpose encoding, there are limited applications.
.IP IDNA::Punycode 4
.IX Item "IDNA::Punycode"
has an API depending on global variables. Don't use this module.
.SS DISTRIBUTIONS
.IX Subsection "DISTRIBUTIONS"
.IP Net-IDN-Encode 4
.IX Item "Net-IDN-Encode"
is the main distribution covering the most common cases for
converting domain names between ASCII and Unicode.
.Sp
The author tries to keep the dependency chain as small as possible; currently
this distribution only depends on perl\ 5.8.5 (including the core module
Unicode::Normalize ).
.IP Net\-IDN\-IDNA2003 4
.IX Item "Net-IDN-IDNA2003"
provides the Net::IDN::IDNA2003 module. This is separate
because it has an dependency on Unicode::Stringprep (through
Net::IDN::Nameprep).
.IP Encode-Punycode 4
.IX Item "Encode-Punycode"
.PD 0
.IP IDNA-Punycode 4
.IX Item "IDNA-Punycode"
.PD
are separate because they are of limited use to the average
user/perl programmer.
.SH AUTHOR
.IX Header "AUTHOR"
Claus Färber <CFAERBER@cpan.org>