use Config::Auto;
### Not very magical at all.
$config = Config::Auto::parse("myprogram.conf", format => "colon");
### Considerably more magical.
$config = Config::Auto::parse("myprogram.conf");
### Highly magical.
$config = Config::Auto::parse();
### Using the OO interface
$ca = Config::Auto->new( source => $text );
$ca = Config::Auto->new( source => $fh );
$ca = Config::Auto->new( source => $filename );
$href = $ca->score; # compute the score for various formats
$config = $ca->parse; # parse the config
$format = $ca->format; # detected (or provided) config format
$str = $ca->as_string; # config file stringified
$fh = $ca->fh; # config file handle
$file = $ca->file; # config filename
$aref = $ca->data; # data from your config, split by newlines
Config::Auto aims to be the most "DWIM" config parser available, by detecting configuration styles, include paths and even config filenames automagically.
See the ``HOW IT WORKS'' section below on implementation details.
"Config::Auto" recognizes the following formats:
Although "Config::Auto" is at its most magical when called with no parameters, its behavior can be controlled explicitly by using one or two arguments.
If a filename is passed as the "source" argument, the same paths are checked, but "Config::Auto" will look for a file with the passed name instead of the $0-based names.
Supplying the "path" parameter will add additional directories to the search paths. The current directory is searched first, then the paths specified with the path parameter. "path" can either be a scalar or a reference to an array of paths to check.
The "format" parameters forces "Config::Auto" to interpret the contents of the configuration file in the given format without trying to guess.
You can also call it in a procedural context ("Config::Auto::parse()"), where the first argument is the source, and the following arguments are named. This function is provided for backwards compatiblity with releases prior to 0.29.
They keys are equal to formats as returned by the "Config::Auto->formats" and their values are a score between 1 and 100. The format with the highest score will be used to parse your configuration data, unless you provided the "format" option explicitly to the "new()" method.
Set this variable to true if you do not wish to "eval" perl style configuration files.
Default is "false"
$Untaint
Set this variable to true if you automatically want to untaint values obtained from a perl style configuration. See ``perldoc perlsec'' for details on tainting.
Default is "false"
$Debug
Set this variable to true to get extra debug information from "Config::Auto" when finding and/or parsing config files fails.
snerkconfig
~/snerkconfig
/etc/snerkconfig
/usr/local/etc/snerkconfig
snerk.config
~/snerk.config
/etc/snerk.config
/usr/local/etc/snerk.config
snerkrc
~/snerkrc
/etc/snerkrc
/usr/local/etc/snerkrc
.snerkrc
~/.snerkrc
/etc/.snerkrc
/usr/local/etc/.snerkrc
Additional search paths can be specified with the "path" option.
We take the first one we find, and examine it to determine what format it's in. The algorithm used is a heuristic ``which is a fancy way of saying that it doesn't work.'' (Mark Dominus.) We know about colon separated, space separated, equals separated, XML, Perl code, Windows INI, BIND9 and irssi style config files. If it chooses the wrong one, you can force it with the "format" option.
If you don't want it ever to detect and execute config files which are made up of Perl code, set "$Config::Auto::DisablePerl = 1".
When using the perl format, your configuration file will be eval'd. This will cause taint errors. To avoid these warnings, set "$Config::Auto::Untaint = 1". This setting will not untaint the data in your configuration file and should only be used if you trust the source of the filename.
Then the file is parsed and a data structure is returned. Since we're working magic, we have to do the best we can under the circumstances - ``You rush a miracle man, you get rotten miracles.'' (Miracle Max) So there are no guarantees about the structure that's returned. If you have a fairly regular config file format, you'll get a regular data structure back. If your config file is confusing, so will the return structure be. Isn't life tragic?
/etc/resolv.conf:
$VAR1 = {
'nameserver' => [ '163.1.2.1', '129.67.1.1', '129.67.1.180' ],
'search' => [ 'oucs.ox.ac.uk', 'ox.ac.uk' ]
};
/etc/passwd:
$VAR1 = {
'root' => [ 'x', '0', '0', 'root', '/root', '/bin/bash' ],
...
};
/etc/gpm.conf:
$VAR1 = {
'append' => '""',
'responsiveness' => '',
'device' => '/dev/psaux',
'type' => 'ps2',
'repeat_type' => 'ms3'
};
/etc/nsswitch.conf:
$VAR1 = {
'netgroup' => 'nis',
'passwd' => 'compat',
'hosts' => [ 'files', 'dns' ],
...
};
This module originally by Simon Cozens.