.\" -*- 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 "Zonemaster::Engine::Normalization 3pm"
.TH Zonemaster::Engine::Normalization 3pm 2024-04-22 "perl v5.38.2" "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
Zonemaster::Engine::Normalization \- utility functions for names normalization
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Zonemaster::Engine::Normalization;
\&
\&    my ($errors, $final_domain) = normalize_name($domain);
.Ve
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.IP normalize_label($label) 4
.IX Item "normalize_label($label)"
Normalize a single label from a domain name.
.Sp
If the label is ASCII only, it is down cased, else it is converted according
to IDNA2008.
.Sp
Downcasing of upper case non-ASCII characters, normalization to the Unicode
NFC format and conversion from U\-label to A\-label is performed by libidn2
using "to_idn($name, ...)" in Zonemaster::LDNS.
.Sp
Returns a tuple \f(CW\*(C`($errors: ArrayRef[Zonemaster::Engine::Normalization::Error], $alabel: String)\*(C'\fR.
.Sp
In case of errors, the returned label will be undefined. If the method
succeeded an empty error array is returned.
.IP normalize_name($name) 4
.IX Item "normalize_name($name)"
Normalize a domain name.
.Sp
The normalization process is detailed in the normalization document <https://github.com/zonemaster/zonemaster/blob/master/docs/specifications/tests/RequirementsAndNormalizationOfDomainNames.md>.
.Sp
Returns a tuple \f(CW\*(C`($errors: ArrayRef[Zonemaster::Engine::Normalization::Error], $name: String)\*(C'\fR.
.Sp
In case of errors, the returned name will be undefined. If the method succeeded
an empty error array is returned.