.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "ConfigFile 3pm"
.TH ConfigFile 3pm 2025-09-28 "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::ConfigFile \- Class for configuration file manipulation.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Lire::Config::ConfigFile;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Object representing a Lire configuration file.
.ie n .SS "new( \*(Aqfilename\*(Aq => $file, spec => $config_spec )"
.el .SS "new( \*(Aqfilename\*(Aq => \f(CW$file\fP, spec => \f(CW$config_spec\fP )"
.IX Subsection "new( 'filename' => $file, spec => $config_spec )"
Creates a new Lire::Config::ConfigFile object. The constructor
takes two parameters:
.IP filename 4
.IX Item "filename"
The file form where the configuration was stored or was loaded from.
.IP spec 4
.IX Item "spec"
The Lire::Config::TypeSpec object to which this configuration adheres.
.SS "filename( [$new_filename] )"
.IX Subsection "filename( [$new_filename] )"
Returns (and optionally changes) the filename where this configuration
file should be stored.
.SS \fBspec()\fP
.IX Subsection "spec()"
Returns the Lire::Config::TypeSpec object to which this configuration file
adheres.
.ie n .SS "global( [ $config] )"
.el .SS "global( [ \f(CW$config\fP] )"
.IX Subsection "global( [ $config] )"
Returns or modify the \*(Aqglobal\*(Aq configuration part of the file. This is
an instance Lire::Config::Compound object.
.SS \fBsave()\fP
.IX Subsection "save()"
Saves this ConfigConfigFile object back to the filename from which
it was loaded.
.SS \fBrevert()\fP
.IX Subsection "revert()"
Reads back the configuration from the file.
.SS \fBas_value()\fP
.IX Subsection "as_value()"
Returns this configuration file as an hash reference. Delegates
to the global configuration object contained in the file.
.ie n .SS "get( $name )"
.el .SS "get( \f(CW$name\fP )"
.IX Subsection "get( $name )"
Returns the configuration parameter \f(CW$name\fR from this configuration file.
Delegates to the global configuration object contained in the file.
.ie n .SS "is_set( $name )"
.el .SS "is_set( \f(CW$name\fP )"
.IX Subsection "is_set( $name )"
Checks that a configuration parameter is set in this file.
Delegates to the global configuration object contained in the file.
.ie n .SS "set( $param )"
.el .SS "set( \f(CW$param\fP )"
.IX Subsection "set( $param )"
Sets a configuration variable in the file. Delegates
to the global configuration object contained in the file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::Config::Dictionary\fR\|(3pm)
.SH AUTHORS
.IX Header "AUTHORS"
Wessel Dankers <wsl@logreport.org>
Francis J. Lacoste <flacoste@logreport.org>
Wolfgang Sourdeau <wolfgang@logreport.org>
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR ConfigFile.pm,v 1.9 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.