.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .\" ======================================================================== .\" .IX Title "Zonemaster::Test::Syntax 3pm" .TH Zonemaster::Test::Syntax 3pm "2021-01-06" "perl v5.32.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" Zonemaster::Test::Syntax \- test validating the syntax of host names and other data .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my @results = Zonemaster::Test::Syntax\->all($zone); .Ve .SH "METHODS" .IX Header "METHODS" .IP "all($zone)" 4 .IX Item "all($zone)" Runs the default set of tests and returns a list of log entries made by the tests. .IP "\fBtranslation()\fR" 4 .IX Item "translation()" Returns a reference to a hash with translation data. Used by the builtin translation system. .IP "\fBmetadata()\fR" 4 .IX Item "metadata()" Returns a reference to a hash, the keys of which are the names of all test methods in the module, and the corresponding values are references to lists with all the tags that the method can use in log entries. .IP "\fBversion()\fR" 4 .IX Item "version()" Returns a version string for the module. .SH "TESTS" .IX Header "TESTS" .IP "syntax01($name)" 4 .IX Item "syntax01($name)" Verifies that the name (Zonemaster::DNSName) given contains only allowed characters. .IP "syntax02($name)" 4 .IX Item "syntax02($name)" Verifies that the name (Zonemaster::DNSName) given does not start or end with a hyphen ('\-'). .IP "syntax03($name)" 4 .IX Item "syntax03($name)" Verifies that the name (Zonemaster::DNSName) given does not contain a hyphen in 3rd and 4th position (in the exception of 'xn\-\-'). .IP "syntax04($name)" 4 .IX Item "syntax04($name)" Verify that a nameserver (Zonemaster::DNSName) given is conform to previous syntax rules. It also verify name total length as well as labels. .IP "syntax05($zone)" 4 .IX Item "syntax05($zone)" Verify that a \s-1SOA\s0 rname (Zonemaster::DNSName) given has a conform usage of at sign (@). .IP "syntax06($zone)" 4 .IX Item "syntax06($zone)" Verify that a \s-1SOA\s0 rname (Zonemaster::DNSName) given is \s-1RFC822\s0 compliant. .IP "syntax07($zone)" 4 .IX Item "syntax07($zone)" Verify that \s-1SOA\s0 mname of zone given is conform to previous syntax rules (syntax01, syntax02, syntax03). It also verify name total length as well as labels. .IP "syntax08(@mx_names)" 4 .IX Item "syntax08(@mx_names)" Verify that \s-1MX\s0 name (Zonemaster::DNSName) given is conform to previous syntax rules (syntax01, syntax02, syntax03). It also verify name total length as well as labels. .SH "INTERNAL METHODS" .IX Header "INTERNAL METHODS" .IP "get_name($item)" 4 .IX Item "get_name($item)" Converts argument to a Zonemaster::DNSName object. .IP "check_name_syntax" 4 .IX Item "check_name_syntax" Implementation of some tests that are used on several kinds of input.