summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-06-15 17:30:59 (GMT)
committerFred Drake <fdrake@acm.org>1999-06-15 17:30:59 (GMT)
commit1e4402998f663d9d3df8239633aa97f0b02df9b5 (patch)
treebe249b5a6b65252f75cab975339475b01a3e8acc
parent6e1d78a18149a752618324311339797ce89c7700 (diff)
downloadcpython-1e4402998f663d9d3df8239633aa97f0b02df9b5.zip
cpython-1e4402998f663d9d3df8239633aa97f0b02df9b5.tar.gz
cpython-1e4402998f663d9d3df8239633aa97f0b02df9b5.tar.bz2
Several new index entries to make find this easier.
Noted that name=value is allowed in addition to name: value.
-rw-r--r--Doc/lib/libcfgparser.tex20
1 files changed, 11 insertions, 9 deletions
diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex
index 4ebc9a4..fa76b22 100644
--- a/Doc/lib/libcfgparser.tex
+++ b/Doc/lib/libcfgparser.tex
@@ -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: