.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] [limitns] [litvars] [debug] cfgfile, cfgfile, ...

.SH OPTIONS
.TP
.B symtbl

This option causes the test driver to include a symbol table with some
predefined test variables in it.  These are useful for experimenting
with variable dereferencing, substitution, and type/value enforcement.
The default is to not predefine any such variables. (Note that whether
this option is present or not, \'tconfpy\' always creates a number of
predefined variables of its own internally.  See the \'tconfpy\'
documentation for the details.)

.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.  The default is to permit new variable creation.

.TP
.B limitns

This option will populate the initial symbol table so that only a
limited number of namespaces can be used.  If this option is present,
only the root namespace, and namespaces beginning with the string "NS"
will be allowed.  In this case, namespaces will be required to be from
3 to 8 characters long.  The default without this option is to allow
new namespaces to be used without restrictions on name or length.  The
initial namespace is set to root ("") whether or not this option is
selected.

.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.

.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.


.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
The symbol table dump at the end of a program run could be formatted better.

.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