README
1NAME
2 Config::General - Generic Config Module
3
4SYNOPSIS
5 use Config::General;
6 $conf = new Config::General(-ConfigFile => "myconfig.rc");
7 my %config = $conf->getall;
8
9
10DESCRIPTION
11 This module opens a config file and parses it's contents
12 for you. After parsing the module returns a hash structure
13 which contains the representation of the config file.
14
15 The format of config files supported by Config::General is
16 inspired by the well known apache config format, in fact,
17 this module is 100% read-compatible to apache configs, but
18 you can also just use simple name/value pairs in your config
19 files.
20
21 In addition to the capabilities of a apache config file
22 it supports some enhancements such as here-documents, C-
23 style comments or multiline options. It is also possible to
24 save the config back to disk, which makes the module a
25 perfect backend for configuration interfaces.
26
27 It is possible to use variables in config files and there
28 exists also support for object oriented access to the
29 configuration.
30
31
32INSTALLATION
33
34 to install, type:
35 perl Makefile.PL
36 make
37 make test
38 make install
39
40 to read the complete documentation, type:
41 perldoc Config::General
42 perldoc Config::General::Extended
43 perldoc Config::General::Interpolated
44
45 see some example config files which can
46 be parsed with Config::Genreal in the subdirectory
47 t/cfg.*
48
49
50UPDATE
51
52 If you are updating from version 1.xx, you might be interested,
53 that some things in the API has changed, which might force you
54 to change your application code. These changes were necessary
55 to clean up the module interface. Now it has a consistent
56 "look and feel" and behaves more naturally. Therefore historic
57 remains were removed.
58
59 Here is a short list:
60
61 o it is no more possible to use Config::General::Extended
62 and Config::General::Interpolated directly. Instead use
63 Config::General and turn on -InterPolateVars and
64 -ExtendedAccess respectively.
65
66 o the method NoMultiOptions() is deprecated. Set the parameter
67 -AllowMultiOptions to false when calling new() to create
68 a new Config::General object.
69
70 o the method save() is deprecated. Use save_file() or
71 save_string() instead.
72
73 o the parameter -file is deprecated. Use -ConfigFile instead.
74
75 o the parameter -hash is deprecated. Use -ConfigHash instead.
76
77 For a more detailed explanation of changes refer to the Changelog.
78
79
80COPYRIGHT
81 Config::General
82 Config::General::Extended
83 Copyright (c) 2000-2015 by Thomas Linden <tom@daemon.de>
84
85 Config::General::Interpolated
86 Copyright (c) 2001 by Wei-Hon Chen <plasmaball@pchome.com.tw>
87 Copyright (c) 2002-2014 by Thomas Linden <tom@daemon.de>.
88
89 This library is free software; you can redistribute it
90 and/or modify it under the same terms as Perl itself.
91
92HOMEPAGE
93
94 The homepage of Config::General is located at:
95
96 http://www.daemon.de/config-general/
97
98BUGS
99 make test does currently not catch all possible scenarios.
100
101
102AUTHOR
103 Thomas Linden <tlinden |AT| cpan.org>
104
105
106VERSION
107 2.63
108