.\" -*- 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 "SpecParser 3pm"
.TH SpecParser 3pm 2024-07-12 "Lire 2.1.1" "LogReport's Lire 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
Lire::Config::SpecParser \- Create configuration specification from XML files
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Lire::Config::SpecParser;
\&
\& my $parser = new Lire::Config::SpecParser;
\& my $spec = $parser\->parsefile( \*(Aqspec.xml\*(Aq );
\&
\& $parser\->merge_specifications_dir( \*(Aq/etc/lire/config\*(Aq );
\& my $spec = $parser\->configspec();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is an Lire::XMLParser which can build Lire::Config::ConfigSpec
objects from an XML file.
.SS \fBnew()\fP
.IX Subsection "new()"
Creates a new parser object.
.SS \fBconfigspec()\fP
.IX Subsection "configspec()"
Returns the Lire::Config::ConfigSpec object parsed.
.ie n .SS "merge_specifications_dir( $dir )"
.el .SS "merge_specifications_dir( \f(CW$dir\fP )"
.IX Subsection "merge_specifications_dir( $dir )"
Parses all the files ending in '.xml' in the \f(CW$directory\fR. The types
defined in these files will be merged to the ConfigSpec object of this
parser.
.ie n .SS "merge_specification_dir( $file )"
.el .SS "merge_specification_dir( \f(CW$file\fP )"
.IX Subsection "merge_specification_dir( $file )"
Parses the \f(CW$file\fR XML file and merges the types it defines in the
ConfigSpec defined by this parser.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\& Lire::Config::Parser(3pm), Lire::Config::TypeSpec(3pm),
\& Lire::Config::ConfigSpec(3pm)
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Wessel Dankers <wsl@logreport.org>
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR SpecParser.pm,v 1.44 2006/07/23 13:16:30 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002,2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.