1Config::INI(3)        User Contributed Perl Documentation       Config::INI(3)
2
3
4

NAME

6       Config::INI - simple .ini-file format
7

VERSION

9       version 0.014
10

GRAMMAR

12       This section describes the format parsed and produced by
13       Config::INI::Reader and ::Writer.  It is not an exhaustive and
14       rigorously tested formal grammar, it's just a description of this
15       particular implementation of the not-quite-standardized "INI" format.
16
17         ini-file   = { <section> | <empty-line> }
18
19         empty-line = [ <space> ] <line-ending>
20
21         section        = <section-header> { <value-assignment> | <empty-line> }
22
23         section-header = [ <space> ] "[" <section-name> "]" [ <space> ] <line-ending>
24         section-name   = string
25
26         value-assignment = [ <space> ] <property-name> [ <space> ]
27                            "="
28                            [ <space> ] <value> [ <space> ]
29                            <line-ending>
30         property-name    = string-without-equals
31         value            = string
32
33         comment     = <space> ";" [ <string> ]
34         line-ending = [ <comment> ] <EOL>
35
36         space = ( <TAB> | " " ) *
37         string-without-equals = string - "="
38         string = ? 1+ characters; not ";" or EOL; begins and ends with non-space ?
39
40       Of special note is the fact that no escaping mechanism is defined,
41       meaning that there is no way to include an EOL or semicolon (for
42       example) in a value, property name, or section name.  If you need this,
43       either subclass, wait for a subclass to be written for you, or find one
44       of the many other INI-style parsers on the CPAN.
45
46       The order of sections and value assignments within a section are not
47       significant, except that given multiple assignments to one property
48       name within a section, only the final one is used.  A section name may
49       be used more than once; this will have the identical meaning as having
50       all property assignments in all sections of that name in sequence.
51

DON'T FORGET

53       The definitions above refer to the format used by the Reader and Writer
54       classes bundled in the Config-INI distribution.  These classes are
55       designed for easy subclassing, so it should be easy to replace their
56       behavior with whatever behavior your want.
57
58       Patches, feature requets, and bug reports are welcome -- but I'm more
59       interested in making sure you can write a subclass that does what you
60       need, and less in making Config-INI do what you want directly.
61

BUGS

63       Bugs should be reported via the CPAN bug tracker at
64
65       http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Config-INI
66       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Config-INI>
67
68       For other issues, or commercial enhancement or support, contact the
69       author.
70

THANKS

72       Thanks to Florian Ragwitz for improving the subclassability of Config-
73       INI's modules, and for helping me do some of my first merging with
74       git(7).
75

AUTHOR

77       Ricardo SIGNES, "E<lt>rjbs@cpan.orgE<gt>"
78
79       Originaly derived from Config::Tiny, by Adam Kennedy.
80

82       Copyright 2007, Ricardo SIGNES.
83
84       This program is free software; you may redistribute it and/or modify it
85       under the same terms as Perl itself.
86
87
88
89perl v5.12.0                      2009-01-16                    Config::INI(3)
Impressum