1#========================================================================
2# Template Toolkit - bin/
3#========================================================================
4
5This directory contains the 'tpage' and 'ttree' template processing
6scripts.  These will be installed automatically by a 'make install'.
7
8'tpage' is a simple script interface to the Template module.  You 
9can specify one or more filenames on the command line which will be 
10processed in turn.  The script will read from STDIN if no files are
11specified.  See 'perldoc tpage' for further information.
12
13Examples:
14   tpage websrc/myfile.html > public_html/myfile.html
15   tpage header body footer > mypage.html 
16   foobar | tpage  > foobar.html
17
18
19'ttree' is a more advanced script for processing templates en masse.
20You can point it at a source directory and it will walk traverse down
21through the tree, processing any template files it finds on the way.
22The output generated by each template is written to the corresponding
23file in a destination directory.  It is ideally suited for the task of
24building web site documents from a set of input templates.  It provides 
25a range of configuration options which can be expressed in config files 
26or via command line options.  See 'ttree -h' and 'perldoc ttree' for 
27further information.
28
29Examples:
30   ttree
31   ttree index.html page1.html page2.html          
32   ttree -v -r
33   ttree -src ~/tmp/templates -dest ~/public_html/test
34   trree -f config
35
36The other files including 'tt2inst' and 'gifsplash' are legacy scripts
37from previous version of TT2.  They will be removed at some point in
38the future.
39
40
41