Newer
Older
tconfpy / test-tc.1
.ds CP 2003-2004
.TH test-tc 1 "TundraWare Inc."

.SH NAME test-tc.py
Test driver to exercise the \'tconfpy\' Python module.


.SH SYNOPSIS
test-tc.py [symtbl] [nonewvar] [nonewns] [debug] [litvars] cfgfile, cfgfile, ...

.SH OPTIONS
.TP
.B symtbl

This option causes the test driver to include a symbol table
with some pre-defined symbols in it before parsing the configuration
files you specify on the command line.  The default is to not
pre-define any symbols.

.TP
.B nonewvar

This option tells \'tconfpy\' to disallow the creation of new variables
in the configuration file (via the \'AllowNewVars\' API option).  The user
is limited to referencing and modifying only those variables already
present in the symbol table.  Typically used when passing an initial
symbol table to the parser to limit the user to only those variables.

.TP
.B nonewns

This option tells \'tconfpy\' to disallow the creation of new lexical
namespaces in the configuration file (via the \'AllowNewNamespaces\'
API option).  The user is limited to only those namespaces pre-defined
in the \'NAMESPACE\' symbol of the initial symbol table.  If no symbol
table is passed, then only the \'\' namespace is available for use.

.TP
.B debug

This option causes the test driver to invoke \'tconfpy\' with
debugging enabled and then display debug output when parsing is
complete.  The default is for debug output to be disabled.

.TP
.B litvars

By default, \'tconfpy\' does nothing to text encountered inside
of \'.literal\' blocks in a configuration file.  If this option
is present, the test driver tells \'tconfpy\' to replace any variable
references present in a \'.literal\' block.  See the \'tconfpy\'
documentation for a more complete description.

.SH ADDING OR CHANGING PRE-DEFINED VARIABLES IN THE TEST DRIVER

This test driver uses a simple table-driven scheme for pre-defining
variables should you desire this feature.  This can be found near
the beginning of the \'test-tc.py\' file.  All this should be
fairly self-explanatory once you understand the various variable
attributes recognized by \'tconfpy\'.  Edit this table as 
desired to create more variables or different attribute values
for your testing purposes.

.SH OTHER
Requires Python 2.3 or later.

.SH BUGS AND MISFEATURES
None known as of this release.

.SH COPYRIGHT AND LICENSING
\'tconfpy\' is Copyright(c) \*(CP TundraWare Inc.  For terms of use, see
the tconfpy-license.txt file in the program distribution.  If you
install \'tconfpy\' on a FreeBSD system using the 'ports' mechanism, you
will also find this file in /usr/local/share/doc/py-tconfpy.

.SH AUTHOR
.nf
Tim Daneliuk
tconfpy@tundraware.com