.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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 "BIND::Config::Parser 3pm"
.TH BIND::Config::Parser 3pm "2005-06-26" "perl v5.14.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"
BIND::Config::Parser \- Parse BIND Config file.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use BIND::Config::Parser;
\&
\& # Create the parser
\& my $parser = new BIND::Config::Parser;
\&
\& my $indent = 0;
\&
\& # Set up callback handlers
\& $parser\->set_open_block_handler( sub {
\&         print "\et" x $indent, join( " ", @_ ), " {\en";
\&         $indent++;
\& } );
\& $parser\->set_close_block_handler( sub {
\&         $indent\-\-;
\&         print "\et" x $indent, "};\en";
\& } );
\& $parser\->set_statement_handler( sub {
\&         print "\et" x $indent, join( " ", @_ ), ";\en";
\& } );
\&
\& # Parse the file
\& $parser\->parse_file( "named.conf" );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
BIND::Config::Parser provides a lightweight parser to the configuration
file syntax of \s-1BIND\s0 v8 and v9 using a \f(CW\*(C`Parse::RecDescent\*(C'\fR grammar.
.PP
It is in a similar vein to \f(CW\*(C`BIND::Conf_Parser\*(C'\fR. However, as it has no
knowledge of the directives, it doesn't need to be kept updated as new
directives are added, it simply knows how to carve up a \s-1BIND\s0 configuration
file into logical chunks.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "new( );" 4
.IX Item "new( );"
Create a new \f(CW\*(C`BIND::Config::Parser\*(C'\fR object.
.SH "METHODS"
.IX Header "METHODS"
.IP "set_open_block_handler( \s-1CODE_REF\s0 );" 4
.IX Item "set_open_block_handler( CODE_REF );"
Set the code to be called when a configuration block is opened. At least one
argument will be passed; the name of that block, for example \f(CW\*(C`options\*(C'\fR or
\&\f(CW\*(C`zone\*(C'\fR, etc. as well as any additional items up to but not including the
opening curly brace.
.IP "set_close_block_handler( \s-1CODE_REF\s0 );" 4
.IX Item "set_close_block_handler( CODE_REF );"
Set the code to be called when a configuration block is closed. No arguments
are passed.
.IP "set_statement_handler( \s-1CODE_REF\s0 );" 4
.IX Item "set_statement_handler( CODE_REF );"
Set the code to be called on a single line configuration element. At least one
argument will be passed; the name of that element, as well as any additional
items up to but not including the ending semi-colon.
.IP "parse_file( \s-1FILENAME\s0 );" 4
.IX Item "parse_file( FILENAME );"
Parse \s-1FILENAME\s0, triggering the above defined handlers on the relevant sections.
.SH "TODO"
.IX Header "TODO"
Probably the odd one or two things. I'm fairly sure the grammar is correct.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2005 Matt Dainty.
.PP
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.SH "AUTHORS"
.IX Header "AUTHORS"
Matt Dainty <matt@bodgit\-n\-scarper.com>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl, Parse::RecDescent, BIND::Conf_Parser.