INN::Config(3pm) InterNetNews Documentation INN::Config(3pm)NAME
Config.pm - Export all the variables an INN Perl script might need
DESCRIPTION
This Perl module sets up any and all the variables that an INN Perl
script might need. More particularly, it allows to use inn.conf
variables: they are all provided by innconfval, as well as the version
of INN (in the variable $INN::Config::version). Other useful variables
are also provided (directories, files, programs, masks, parameters) and
you should have a look at the source code of the module to see what you
can use in your Perl scripts.
You only have to declare the module at the beginning of them:
use lib '<pathnews>/lib/perl';
use INN::Config;
Then, you can for instance use:
print $INN::Config::localmaxartsize;
to print the value of localmaxartsize as it is set in inn.conf.
You can also specify a version when you import the module. If you
write:
use INN::Config 2.5.0;
only versions of INN superior to 2.5.0 will be able to run the Perl
script.
It is also possible to import the variables directly in your namespace
if you specify what you want to import:
use INN::Config qw($localmaxartsize $pathbin);
Note that a legacy innshellvars.pl is also provided in pathnews/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: innshellvars and
innshellvars.tcl. They offer the same capabilities as this module.
HISTORY
innshellvars.pl 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.
$Id: Config.pm.in 8357 2009-02-27 17:56:00Z iulius $
SEE ALSOinn.conf(5), innconfval(1), perl(1).
INN 2.5.2 2009-05-21 INN::Config(3pm)
