HOME

sh-3ll 1.0
DIR:/home/.cpan/build/Net-DNS-1.36-0/blib/man3/
Current File : /home/.cpan/build/Net-DNS-1.36-0/blib/man3/Net::DNS::ZoneFile.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "Net::DNS::ZoneFile 3"
.TH Net::DNS::ZoneFile 3 "2022-12-30" "perl v5.26.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::DNS::ZoneFile \- DNS zone file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::DNS::ZoneFile;
\&
\&    $zonefile = Net::DNS::ZoneFile\->new( \*(Aqnamed.example\*(Aq );
\&
\&    while ( $rr = $zonefile\->read ) {
\&        $rr\->print;
\&    }
\&
\&    @zone = $zonefile\->read;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Each Net::DNS::ZoneFile object instance represents a zone file
together with any subordinate files introduced by the \f(CW$INCLUDE\fR
directive.  Zone file syntax is defined by \s-1RFC1035.\s0
.PP
A program may have multiple zone file objects, each maintaining
its own independent parser state information.
.PP
The parser supports both the \f(CW$TTL\fR directive defined by \s-1RFC2308\s0
and the \s-1BIND \f(CW$GENERATE\fR\s0 syntax extension.
.PP
All RRs in a zone file must have the same class, which may be
specified for the first \s-1RR\s0 encountered and is then propagated
automatically to all subsequent records.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&    $zonefile = Net::DNS::ZoneFile\->new( \*(Aqfilename\*(Aq, [\*(Aqexample.com\*(Aq] );
\&
\&    $handle   = IO::File\->new( \*(Aqfilename\*(Aq, \*(Aq<:encoding(ISO8859\-7)\*(Aq );
\&    $zonefile = Net::DNS::ZoneFile\->new( $handle, [\*(Aqexample.com\*(Aq] );
.Ve
.PP
The \fBnew()\fR constructor returns a Net::DNS::ZoneFile object which
represents the zone file specified in the argument list.
.PP
The specified file or file handle is open for reading and closed when
exhausted or all references to the ZoneFile object cease to exist.
.PP
The optional second argument specifies \f(CW$ORIGIN\fR for the zone file.
.PP
Zone files are presumed to be \s-1UTF\-8\s0 encoded where that is supported.
.PP
Alternative character encodings may be specified indirectly by creating
a file handle with the desired encoding layer, which is then passed as
an argument to \fBnew()\fR. The specified encoding is propagated to files
introduced by \f(CW$INCLUDE\fR directives.
.SS "read"
.IX Subsection "read"
.Vb 2
\&    $rr = $zonefile\->read;
\&    @rr = $zonefile\->read;
.Ve
.PP
When invoked in scalar context, \fBread()\fR returns a Net::DNS::RR object
representing the next resource record encountered in the zone file,
or undefined if end of data has been reached.
.PP
When invoked in list context, \fBread()\fR returns the list of Net::DNS::RR
objects in the order that they appear in the zone file.
.PP
Comments and blank lines are silently disregarded.
.PP
\&\f(CW$INCLUDE\fR, \f(CW$ORIGIN\fR, \f(CW$TTL\fR and \f(CW$GENERATE\fR directives are processed
transparently.
.SS "name"
.IX Subsection "name"
.Vb 1
\&    $filename = $zonefile\->name;
.Ve
.PP
Returns the name of the current zone file.
Embedded \f(CW$INCLUDE\fR directives will cause this to differ from the
filename argument supplied when the object was created.
.SS "line"
.IX Subsection "line"
.Vb 1
\&    $line = $zonefile\->line;
.Ve
.PP
Returns the number of the last line read from the current zone file.
.SS "origin"
.IX Subsection "origin"
.Vb 1
\&    $origin = $zonefile\->origin;
.Ve
.PP
Returns the fully qualified name of the current origin within the
zone file.
.SS "ttl"
.IX Subsection "ttl"
.Vb 1
\&    $ttl = $zonefile\->ttl;
.Ve
.PP
Returns the default \s-1TTL\s0 as specified by the \f(CW$TTL\fR directive.
.SH "COMPATIBILITY WITH Net::DNS::ZoneFile 1.04"
.IX Header "COMPATIBILITY WITH Net::DNS::ZoneFile 1.04"
Applications which depended on the defunct Net::DNS::ZoneFile 1.04
\&\s-1CPAN\s0 distribution will continue to operate with minimal change using
the compatibility interface described below.
New application code should use the object-oriented interface.
.PP
.Vb 1
\&    use Net::DNS::ZoneFile;
\&
\&    $listref = Net::DNS::ZoneFile\->read( $filename );
\&    $listref = Net::DNS::ZoneFile\->read( $filename, $include_dir );
\&
\&    $listref = Net::DNS::ZoneFile\->readfh( $filehandle );
\&    $listref = Net::DNS::ZoneFile\->readfh( $filehandle, $include_dir );
\&
\&    $listref = Net::DNS::ZoneFile\->parse(  $string );
\&    $listref = Net::DNS::ZoneFile\->parse( \e$string );
\&    $listref = Net::DNS::ZoneFile\->parse(  $string, $include_dir );
\&    $listref = Net::DNS::ZoneFile\->parse( \e$string, $include_dir );
\&
\&    $_\->print for @$listref;
.Ve
.PP
The optional second argument specifies the default path for filenames.
The current working directory is used by default.
.PP
Although not available in the original implementation, the \s-1RR\s0 list can
be obtained directly by calling any of these methods in list context.
.PP
.Vb 1
\&    @rr = Net::DNS::ZoneFile\->read( $filename, $include_dir );
.Ve
.PP
The partial result is returned if an error is encountered by the parser.
.SS "read"
.IX Subsection "read"
.Vb 2
\&    $listref = Net::DNS::ZoneFile\->read( $filename );
\&    $listref = Net::DNS::ZoneFile\->read( $filename, $include_dir );
.Ve
.PP
\&\fBread()\fR parses the contents of the specified file
and returns a reference to the list of Net::DNS::RR objects.
The return value is undefined if an error is encountered by the parser.
.SS "readfh"
.IX Subsection "readfh"
.Vb 2
\&    $listref = Net::DNS::ZoneFile\->readfh( $filehandle );
\&    $listref = Net::DNS::ZoneFile\->readfh( $filehandle, $include_dir );
.Ve
.PP
\&\fBreadfh()\fR parses data from the specified file handle
and returns a reference to the list of Net::DNS::RR objects.
The return value is undefined if an error is encountered by the parser.
.SS "parse"
.IX Subsection "parse"
.Vb 4
\&    $listref = Net::DNS::ZoneFile\->parse(  $string );
\&    $listref = Net::DNS::ZoneFile\->parse( \e$string );
\&    $listref = Net::DNS::ZoneFile\->parse(  $string, $include_dir );
\&    $listref = Net::DNS::ZoneFile\->parse( \e$string, $include_dir );
.Ve
.PP
\&\fBparse()\fR interprets the text in the argument string
and returns a reference to the list of Net::DNS::RR objects.
The return value is undefined if an error is encountered by the parser.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
This package is designed as an improved and compatible replacement
for Net::DNS::ZoneFile 1.04 which was created by Luis Munoz in 2002
as a separate \s-1CPAN\s0 module.
.PP
The present implementation is the result of an agreement to merge our
two different approaches into one package integrated into Net::DNS.
The contribution of Luis Munoz is gratefully acknowledged.
.PP
Thanks are also due to Willem Toorop for his constructive criticism
of the initial version and invaluable assistance during testing.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c)2011\-2012 Dick Franks.
.PP
All rights reserved.
.SH "LICENSE"
.IX Header "LICENSE"
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted, provided
that the original copyright notices appear in all copies and that both
copyright notice and this permission notice appear in supporting
documentation, and that the name of the author not be used in advertising
or publicity pertaining to distribution of the software without specific
prior written permission.
.PP
\&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl, Net::DNS, Net::DNS::RR,
\&\s-1RFC1035\s0 Section 5.1, \s-1RFC2308\s0
.PP
\&\s-1BIND\s0 Administrator Reference Manual <http://bind.isc.org/>