Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

config::general::interpolated(3pm) [debian man page]

General::Interpolated(3pm)				User Contributed Perl Documentation				General::Interpolated(3pm)

NAME

       Config::General::Interpolated - Parse variables within Config files

SYNOPSIS

	use Config::General;
	$conf = new Config::General(
	   -ConfigFile	    => 'configfile',
	   -InterPolateVars => 1
	);

DESCRIPTION

       This is an internal module which makes it possible to interpolate Perl style variables in your config file (i.e. $variable or
       "${variable}").

       Normally you don't call it directly.

VARIABLES

       Variables can be defined everywhere in the config and can be used afterwards as the value of an option. Variables cannot be used as keys or
       as part of keys.

       If you define a variable inside a block or a named block then it is only visible within this block or within blocks which are defined
       inside this block. Well - let's take a look to an example:

	# sample config which uses variables
	basedir   = /opt/ora
	user	  = t_space
	sys	  = unix
	<table intern>
	    instance  = INTERN
	    owner     = $user		      # "t_space"
	    logdir    = $basedir/log	      # "/opt/ora/log"
	    sys       = macos
	    <procs>
		misc1	= ${sys}_${instance}  # macos_INTERN
		misc2	= $user 	      # "t_space"
	    </procs>
	</table>

       This will result in the following structure:

	{
	    'basedir' => '/opt/ora',
	    'user'    => 't_space'
	    'sys'     => 'unix',
	    'table'   => {
		 'intern' => {
		       'sys'	  => 'macos',
		       'logdir'   => '/opt/ora/log',
		       'instance' => 'INTERN',
		       'owner' => 't_space',
		       'procs' => {
			    'misc1' => 'macos_INTERN',
			    'misc2' => 't_space'
		   }
		}
	    }

       As you can see, the variable sys has been defined twice. Inside the <procs> block a variable ${sys} has been used, which then were
       interpolated into the value of sys defined inside the <table> block, not the sys variable one level above. If sys were not defined inside
       the <table> block then the "global" variable sys would have been used instead with the value of "unix".

       Variables inside double quotes will be interpolated, but variables inside single quotes will not interpolated. This is the same behavior as
       you know of Perl itself.

       In addition you can surround variable names with curly braces to avoid misinterpretation by the parser.

SEE ALSO

       Config::General

AUTHORS

	Thomas Linden <tlinden |AT| cpan.org>
	Autrijus Tang <autrijus@autrijus.org>
	Wei-Hon Chen <plasmaball@pchome.com.tw>

COPYRIGHT

       Copyright 2001 by Wei-Hon Chen <plasmaball@pchome.com.tw>.  Copyright 2002-2010 by Thomas Linden <tlinden |AT| cpan.org>.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       See <http://www.perl.com/perl/misc/Artistic.html>

VERSION

       2.14

perl v5.10.1							    2010-12-01						General::Interpolated(3pm)

Check Out this Related Man Page

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 ALSO

       inn.conf(5), innconfval(1), perl(1).

INN 2.5.2							    2009-05-21							  INN::Config(3pm)
Man Page