[%#
# IMPORTANT NOTE
# This documentation is generated automatically from source
# templates. Any changes you make here may be lost.
#
# The 'docsrc' documentation source bundle is available for download
# from http://www.template-toolkit.org/docs.html and contains all
# the source templates, XML files, scripts, etc., from which the
# documentation for the Template Toolkit is built.
-%]
[% META book = 'Tools'
page = 'ttree'
%]
[% WRAPPER toc;
PROCESS tocitem
title ="SYNOPSIS"
subs = [];
PROCESS tocitem
title ="DESCRIPTION"
subs = [
"The <file>.ttreerc</file> Configuration File",
"Directory Options",
"File Options",
"Template Dependencies",
"Template Toolkit Options"
];
PROCESS tocitem
title ="AUTHORS"
subs = [];
PROCESS tocitem
title ="VERSION"
subs = [];
PROCESS tocitem
title ="COPYRIGHT"
subs = [];
PROCESS tocitem
title ="SEE ALSO"
subs = [];
END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
title="SYNOPSIS"
-%]<pre> ttree [options] [files]</pre>
[%- END %]
[% WRAPPER section
title="DESCRIPTION"
-%]<p>
The <file>ttree</file> script is used to process entire directory trees containing
template files. The resulting output from processing each file is then
written to a corresponding file in a destination directory. The script
compares the modification times of source and destination files (where
they already exist) and processes only those files that have been modified.
In other words, it is the equivalent of 'make' for the Template Toolkit.
</p>
<p>
It supports a number of options which can be used to configure
behaviour, define locations and set Template Toolkit options. The
script first reads the <file>.ttreerc</file> configuration file in the HOME
directory, or an alternative file specified in the TTREERC environment
variable. Then, it processes any command line arguments, including
any additional configuration files specified via the <code>'-f'</code> (file)
option.
</p>
[% WRAPPER subsection
title = "The <file>.ttreerc</file> Configuration File"
-%]<p>
When you run <file>ttree</file> for the first time it will ask you if you want
it to create a <file>.ttreerc</file> file for you. This will be created in your
home directory.
</p>
<pre> $ ttree
Do you want me to create a sample '.ttreerc' file for you?
(file: /home/abw/.ttreerc) [y/n]: y
/home/abw/.ttreerc created. Please edit accordingly and re-run ttree</pre>
<p>
The purpose of this file is to set any <i>global</i> configuration options
that you want applied <i>every</i> time <file>ttree</file> is run. For example, you
can use the <code>'ignore'</code> and <code>'copy'</code> option to provide regular expressions
that specify which files should be ignored and which should be copied
rather than being processed as templates. You may also want to set
flags like <code>'verbose'</code> and <code>'recurse'</code> according to your preference.
</p>
<p>
A minimal <file>.ttreerc</file>:
</p>
<pre> # ignore these files
ignore = \b(CVS|RCS)\b
ignore = ^#
ignore = ~$</pre>
<pre> # copy these files
copy = \.(gif|png|jpg|pdf)$ </pre>
<pre> # recurse into directories
recurse</pre>
<pre> # provide info about what's going on
verbose</pre>
<p>
In most cases, you'll want to create a different <file>ttree</file> configuration
file for each project you're working on. The <code>'cfg'</code> option allows you
to specify a directory where <file>ttree</file> can find further configuration
files.
</p>
<pre> cfg = /home/abw/.ttree</pre>
<p>
The <code>'-f'</code> command line option can be used to specify which configuration
file should be used. You can specify a filename using an absolute or
relative path:
</p>
<pre> $ ttree -f /home/abw/web/example/etc/ttree.cfg
$ ttree -f ./etc/ttree.cfg
$ ttree -f ../etc/ttree.cfg</pre>
<p>
If the configuration file does not begin with <code>'/'</code> or <code>'.'</code> or something
that looks like a MS-DOS absolute path (e.g. <code>'C:\\etc\\ttree.cfg'</code>) then
<file>ttree</file> will look for it in the directory specified by the <code>'cfg'</code> option.
</p>
<pre> $ ttree -f test1 # /home/abw/.ttree/test1</pre>
<p>
The <code>'cfg'</code> option can only be used in the <file>.ttreerc</file> file. All the
other options can be used in the <file>.ttreerc</file> or any other <file>ttree</file>
configuration file. They can all also be specified as command line
options.
</p>
<p>
Remember that <file>.ttreerc</file> is always processed <i>before</i> any
configuration file specified with the <code>'-f'</code> option. Certain options
like <code>'lib'</code> can be used any number of times and accumulate their values.
</p>
<p>
For example, consider the following configuration files:
</p>
<p>
<file>/home/abw/.ttreerc</file>:
</p>
<pre> cfg = /home/abw/.ttree
lib = /usr/local/tt2/templates</pre>
<p>
<file>/home/abw/.ttree/myconfig</file>:
</p>
<pre> lib = /home/abw/web/example/templates/lib</pre>
<p>
When <file>ttree</file> is invoked as follows:
</p>
<pre> $ ttree -f myconfig</pre>
<p>
the <code>'lib'</code> option will be set to the following directories:
</p>
<pre> /usr/local/tt2/templates
/home/abw/web/example/templates/lib</pre>
<p>
Any templates located under <file>/usr/local/tt2/templates</file> will be used
in preference to those located under
<file>/home/abw/web/example/templates/lib</file>. This may be what you want,
but then again, it might not. For this reason, it is good practice to
keep the <file>.ttreerc</file> as simple as possible and use different
configuration files for each <file>ttree</file> project.
</p>
[%- END %]
[% WRAPPER subsection
title = "Directory Options"
-%]<p>
The <code>'src'</code> option is used to define the directory containing the
source templates to be processed. It can be provided as a command
line option or in a configuration file as shown here:
</p>
<pre> src = /home/abw/web/example/templates/src</pre>
<p>
Each template in this directory typically corresponds to a single
web page or other document.
</p>
<p>
The <code>'dest'</code> option is used to specify the destination directory for the
generated output.
</p>
<pre> dest = /home/abw/web/example/html</pre>
<p>
The <code>'lib'</code> option is used to define one or more directories containing
additional library templates. These templates are not documents in
their own right and typically comprise of smaller, modular components
like headers, footers and menus that are incorporated into pages templates.
</p>
<pre> lib = /home/abw/web/example/templates/lib
lib = /usr/local/tt2/templates</pre>
<p>
The <code>'lib'</code> option can be used repeatedly to add further directories to
the search path.
</p>
<p>
A list of templates can be passed to <file>ttree</file> as command line arguments.
</p>
<pre> $ ttree foo.html bar.html</pre>
<p>
It looks for these templates in the <code>'src'</code> directory and processes them
through the Template Toolkit, using any additional template components
from the <code>'lib'</code> directories. The generated output is then written to
the corresponding file in the <code>'dest'</code> directory.
</p>
<p>
If <file>ttree</file> is invoked without explicitly specifying any templates
to be processed then it will process every file in the <code>'src'</code> directory.
If the <code>'-r'</code> (recurse) option is set then it will additionally iterate
down through sub-directories and process and other template files it finds
therein.
</p>
<pre> $ ttree -r</pre>
<p>
If a template has been processed previously, <file>ttree</file> will compare the
modification times of the source and destination files. If the source
template (or one it is dependant on) has not been modified more
recently than the generated output file then <file>ttree</file> will not process
it. The <file>-a</file> (all) option can be used to force <file>ttree</file> to process
all files regardless of modification time.
</p>
<pre> $ tree -a</pre>
<p>
Any templates explicitly named as command line argument are always
processed and the modification time checking is bypassed.
</p>
[%- END %]
[% WRAPPER subsection
title = "File Options"
-%]<p>
The <code>'ignore'</code>, <code>'copy'</code> and <code>'accept'</code> options are used to specify Perl
regexen to filter file names. Files that match any of the <code>'ignore'</code>
options will not be processed. Remaining files that match any of the
<code>'copy'</code> regexen will be copied to the destination directory. Remaining
files that then match any of the <code>'accept'</code> criteria are then processed
via the Template Toolkit. If no <code>'accept'</code> parameter is specified then
all files will be accepted for processing if not already copied or
ignored.
</p>
<pre> # ignore these files
ignore = \b(CVS|RCS)\b
ignore = ^#
ignore = ~$</pre>
<pre> # copy these files
copy = \.(gif|png|jpg|pdf)$ </pre>
<pre> # accept only .tt2 templates
accept = \.tt2$</pre>
<p>
The <code>'suffix'</code> option is used to define mappings between the file
extensions for source templates and the generated output files. The
following example specifies that source templates with a <code>'.tt2'</code>
suffix should be output as <code>'.html'</code> files:
</p>
<pre> suffix tt2=html</pre>
<p>
Or on the command line,
</p>
<pre> --suffix tt2=html</pre>
<p>
You can provide any number of different suffix mappings by repeating
this option.
</p>
[%- END %]
[% WRAPPER subsection
title = "Template Dependencies"
-%]<p>
The <code>'depend'</code> and <code>'depend_file'</code> options allow you to specify
how any given template file depends on another file or group of files.
The <code>'depend'</code> option is used to express a single dependency.
</p>
<pre> $ ttree --depend foo=bar,baz</pre>
<p>
This command line example shows the <code>'--depend'</code> option being used to
specify that the <file>foo</file> file is dependant on the <file>bar</file> and <file>baz</file>
templates. This option can be used many time on the command line:
</p>
<pre> $ ttree --depend foo=bar,baz --depend crash=bang,wallop</pre>
<p>
or in a configuration file:
</p>
<pre> depend foo=bar,baz
depend crash=bang,wallop</pre>
<p>
The file appearing on the left of the <code>'='</code> is specified relative to
the <code>'src'</code> or <code>'lib'</code> directories. The file(s) appearing on the right
can be specified relative to any of these directories or as absolute
file paths.
</p>
<p>
For example:
</p>
<pre> $ ttree --depend foo=bar,/tmp/baz</pre>
<p>
To define a dependency that applies to all files, use <code>'*'</code> on the
left of the <code>'='</code>.
</p>
<pre> $ ttree --depend *=header,footer</pre>
<p>
or in a configuration file:
</p>
<pre> depend *=header,footer</pre>
<p>
Any templates that are defined in the <code>'pre_process'</code>, <code>'post_process'</code>,
<code>'process'</code> or <code>'wrapper'</code> options will automatically be added to the
list of global dependencies that apply to all templates.
</p>
<p>
The <code>'depend_file'</code> option can be used to specify a file that contains
dependency information.
</p>
<pre> $ ttree --depend_file=/home/abw/web/example/etc/ttree.dep</pre>
<p>
Here is an example of a dependency file:
</p>
<pre> # This is a comment. It is ignored.
index.html: header footer menubar
header: titlebar hotlinks
menubar: menuitem
# spanning multiple lines with the backslash
another.html: header footer menubar \
sidebar searchform</pre>
<p>
Lines beginning with the <code>'#'</code> character are comments and are ignored.
Blank lines are also ignored. All other lines should provide a
filename followed by a colon and then a list of dependant files
separated by whitespace, commas or both. Whitespace around the colon
is also optional. Lines ending in the <code>'\'</code> character are continued
onto the following line.
</p>
<p>
Files that contain spaces can be quoted. That is only necessary
for files after the colon (':'). The file before the colon may be
quoted if it contains a colon.
</p>
<p>
As with the command line options, the <code>'*'</code> character can be used
as a wildcard to specify a dependency for all templates.
</p>
<pre> * : config,header</pre>
[%- END %]
[% WRAPPER subsection
title = "Template Toolkit Options"
-%]<p>
<file>ttree</file> also provides access to the usual range of Template Toolkit
options. For example, the <code>'--pre_chomp'</code> and <code>'--post_chomp'</code> <file>ttree</file>
options correspond to the <code>'PRE_CHOMP'</code> and <code>'POST_CHOMP'</code> options.
</p>
<p>
Run <code>'ttree -h'</code> for a summary of the options available.
</p>
[%- END %]
[%- END %]
[% WRAPPER section
title="AUTHORS"
-%]<p>
Andy Wardley <abw@andywardley.com>
</p>
<p>
[% ttlink('http://www.andywardley.com/', 'http://www.andywardley.com/') -%]
</p>
<p>
With contributions from Dylan William Hardison (support for
dependencies), Bryce Harrington (<code>'absolute'</code> and <code>'relative'</code> options),
Mark Anderson (<code>'suffix'</code> and <code>'debug'</code> options), Harald Joerg and Leon
Brocard who gets everywhere, it seems.
</p>
[%- END %]
[% WRAPPER section
title="VERSION"
-%]<p>
2.70, distributed as part of the
Template Toolkit version 2.14, released on 04 October 2004.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
-%]<pre> Copyright (C) 1996-2004 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
title="SEE ALSO"
-%]<p>
[% ttlink('Template::Tools::tpage', 'tpage') -%]
</p>
[%- END %]