Several new index entries to make find this easier.

Noted that name=value is allowed in addition to name: value.
This commit is contained in:
Fred Drake 1999-06-15 17:30:59 +00:00
parent 6e1d78a181
commit 1e4402998f
1 changed files with 11 additions and 9 deletions

View File

@ -5,20 +5,22 @@
\modulesynopsis{Configuration file parser.}
\sectionauthor{Christopher G. Petrilli}{petrilli@amber.org}
This module defines the class \class{ConfigParser}. The
\class{ConfigParser} class implements a basic configuration file
This module defines the class \class{ConfigParser}.
\indexii{.ini}{file}\indexii{configuration}{file}\index{ini file}
\index{Windows ini file}
The \class{ConfigParser} class implements a basic configuration file
parser language which provides a structure similar to what you would
find on Microsoft Windows INI files. You can use this to write Python
find on Microsoft Windows INI files. You can use this to write Python
programs which can be customized by end users easily.
The configuration file consists of sections, lead by a
\samp{[section]} header and followed by \samp{name: value} entries,
with continuations in the style of \rfc{822}. The optional values
can contain format strings which refer to other values in the same
section, or values in a special \code{DEFAULT} section. Additional
defaults can be provided upon initialization and retrieval. Lines
beginning with \character{\#} are ignored and may be used to provide
comments.
with continuations in the style of \rfc{822}; \samp{name=value} is
also accepted. The optional values can contain format strings which
refer to other values in the same section, or values in a special
\code{DEFAULT} section. Additional defaults can be provided upon
initialization and retrieval. Lines beginning with \character{\#} are
ignored and may be used to provide comments.
For example: