.\" -*- 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 "INN::Config 3pm"
.TH INN::Config 3pm 2024-04-01 "INN 2.7.2" "InterNetNews 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
INN::Config \- Export all the variables an INN Perl script might need
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This Perl module sets up any and all the variables that an INN Perl script
might need.  More particularly, it allows using \fIinn.conf\fR variables:
they are all provided by \fBinnconfval\fR, as well as the version of INN
(in the variable \f(CW\*(C`$INN::Config::VERSION\*(C'\fR for its short number form, on in
\&\f(CW\*(C`$INN::Config::version\*(C'\fR for its complete form).  Other useful variables
are also provided (directories, files, programs, masks, parameters).
The complete list can be obtained with the following script that prints
them out:
.PP
.Vb 3
\&    use lib \*(Aq<pathnews>/lib/perl\*(Aq;
\&    use INN::Config;
\&    use Data::Dumper;
\&
\&    my ($varname, $value);
\&    foreach my $var (@INN::Config::EXPORT_OK) {
\&        if ($var =~ /^\e$(.*)$/) {
\&            $varname = "INN::Config::$1";
\&            $value = Dumper($$varname);
\&            $value =~ s/^\e$VAR1 = //;
\&            print "\e$$varname = $value";
\&        } elsif ($var =~ /^\e@(.*)$/) {
\&            $varname = "INN::Config::$1";
\&            $value = Dumper(\e@$varname);
\&            $value =~ s/^\e$VAR1 = //;
\&            print "\e@$varname = $value";
\&        }
\&    }
.Ve
.PP
A local Perl script named \fIinnshellvars.pl.local\fR in \fIpathetc\fR will be
loaded, if present and executable, at the end of the run of this module.
A typical use is to add or override variables.
.PP
You only have to declare the module at the beginning of them:
.PP
.Vb 2
\&    use lib \*(Aq<pathnews>/lib/perl\*(Aq;
\&    use INN::Config;
.Ve
.PP
Then, you can for instance use:
.PP
.Vb 1
\&    print $INN::Config::localmaxartsize;
.Ve
.PP
to print the value of \fIlocalmaxartsize\fR as it is set in \fIinn.conf\fR.
.PP
You can also specify a version when you import the module.  If
you write:
.PP
.Vb 1
\&    use INN::Config 2.5.0;
.Ve
.PP
only versions of INN superior to 2.5.0 will be able to run the Perl
script.
.PP
It is also possible to import the variables directly in your namespace
if you specify what you want to import:
.PP
.Vb 1
\&    use INN::Config qw($localmaxartsize $pathbin);
.Ve
.PP
Note that a legacy \fIinnshellvars.pl\fR is also provided in \fIpathnews\fR/lib
for compatibility reasons with old Perl scripts not shipped with INN.
It was used by versions of INN anterior to 2.5.0.  The corresponding
scripts for Shell and Tcl are, however, still in use: \fIinnshellvars\fR
and \fIinnshellvars.tcl\fR.  They offer the same capabilities as this
module.
.SH HISTORY
.IX Header "HISTORY"
\&\fIinnshellvars.pl\fR was written by James Brister <brister@vix.com>
for InterNetNews in 1996.  It was converted to the INN::Config Perl
module by Julien Elie in 2007.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
inn.conf(5), innconfval(1), perl(1).