diff --git a/test-tc.1 b/test-tc.1 new file mode 100644 index 0000000..7f534cb --- /dev/null +++ b/test-tc.1 @@ -0,0 +1,62 @@ +.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] [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 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.2 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/tconfpy. + +.SH AUTHOR +.nf +Tim Daneliuk +tconfpy@tundraware.com +