File: //usr/local/ssl/local/share/man/man3/Net::DNS::RR::SOA.3
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
.\"
.\" 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" ''
'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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" 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::DNS::RR::SOA 3"
.TH Net::DNS::RR::SOA 3 "2012-01-27" "perl v5.8.8" "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::RR::SOA \- DNS SOA resource record
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\f(CW\*(C`use Net::DNS::RR\*(C'\fR;
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Class for \s-1DNS\s0 Start of Authority (\s-1SOA\s0) resource records.
.SH "METHODS"
.IX Header "METHODS"
.SS "mname"
.IX Subsection "mname"
.Vb 1
\& print "mname = ", $rr\->mname, "\en";
.Ve
.PP
Returns the domain name of the original or primary nameserver for
this zone.
.SS "rname"
.IX Subsection "rname"
.Vb 1
\& print "rname = ", $rr\->rname, "\en";
.Ve
.PP
Returns a domain name that specifies the mailbox for the person
responsible for this zone.
.SS "serial"
.IX Subsection "serial"
.Vb 2
\& print "serial = ", $rr\->serial, "\en";
\& $new_serial = $rr\->serial(value);
.Ve
.PP
Unsigned 32 bit version number of the original copy of the zone.
Zone transfers preserve this value.
.PP
\&\s-1RFC1982\s0 defines a strict (irreflexive) partial ordering for zone
serial numbers. The serial number will be incremented unless the
replacement value argument satisfies the ordering constraint.
.SS "refresh"
.IX Subsection "refresh"
.Vb 1
\& print "refresh = ", $rr\->refresh, "\en";
.Ve
.PP
Returns the zone's refresh interval.
.SS "retry"
.IX Subsection "retry"
.Vb 1
\& print "retry = ", $rr\->retry, "\en";
.Ve
.PP
Returns the zone's retry interval.
.SS "expire"
.IX Subsection "expire"
.Vb 1
\& print "expire = ", $rr\->expire, "\en";
.Ve
.PP
Returns the zone's expire interval.
.SS "minimum"
.IX Subsection "minimum"
.Vb 1
\& print "minimum = ", $rr\->minimum, "\en";
.Ve
.PP
Returns the minimum (default) \s-1TTL\s0 for records in this zone.
.SH "Zone Serial Number Management"
.IX Header "Zone Serial Number Management"
The internal logic of the \fIserial()\fR method offers support for
several widely used zone serial numbering policies.
.SS "Strictly Sequential"
.IX Subsection "Strictly Sequential"
.Vb 1
\& $successor = $soa\->serial( SEQUENTIAL );
.Ve
.PP
The existing serial number is incremented modulo 2**32 because
the value returned by the auxiliary \s-1\fISEQUENTIAL\s0()\fR function can never
satisfy the serial number ordering constraint.
.SS "Date Encoded"
.IX Subsection "Date Encoded"
.Vb 1
\& $successor = $soa\->serial( YYYYMMDDxx );
.Ve
.PP
The 32 bit value returned by the auxiliary \fIYYYYMMDDxx()\fR function
will be used if it satisfies the ordering constraint, otherwise
the existing serial number will be incremented as above.
.PP
Serial number increments must be limited to 100 per day for the
date information to remain useful.
.SS "Time Encoded"
.IX Subsection "Time Encoded"
.Vb 1
\& $successor = $soa\->serial( time );
.Ve
.PP
The 32 bit value returned by the perl \fICORE::time()\fR function will
be used if it satisfies the serial number ordering constraint,
otherwise the existing value will be incremented as above.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 1997\-2002 Michael Fuhr.
.PP
Portions Copyright (c) 2002\-2004 Chris Reinhardt.
.PP
Portions Copyright (c) 2011 Dick Franks.
.PP
All rights reserved. This program is free software; you may redistribute
it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1), Net::DNS, Net::DNS::Resolver, Net::DNS::Packet,
Net::DNS::Header, Net::DNS::Question, Net::DNS::RR,
\&\s-1RFC\s0 1035 Section 3.3.13, \s-1RFC1982\s0