Commit | Line | Data |
3fea05b9 |
1 | #============================================================= -*-perl-*- |
2 | # |
3 | # Template::Tools |
4 | # |
5 | # DESCRIPTION |
6 | # Index page for documentation about the command line tools |
7 | # distributed with the Template Toolkit. |
8 | # |
9 | # AUTHOR |
10 | # Andy Wardley <abw@wardley.org> |
11 | # |
12 | # COPYRIGHT |
13 | # Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved. |
14 | # |
15 | # This module is free software; you can redistribute it and/or |
16 | # modify it under the same terms as Perl itself. |
17 | # |
18 | #======================================================================== |
19 | |
20 | =head1 NAME |
21 | |
22 | Template::Tools - Command Line Tools for the Template Toolkit |
23 | |
24 | =head1 Template Tools |
25 | |
26 | The Template Toolkit includes the following command line tools |
27 | for processing templates. |
28 | |
29 | =head2 tpage |
30 | |
31 | The L<tpage|Template::Tools::tpage> script can be used to process |
32 | a single template using the Template Toolkit. |
33 | |
34 | $ tpage --define msg="Hello World" greeting.tt2 |
35 | |
36 | Use the C<-h> option to get a summary of options: |
37 | |
38 | $ tpage -h |
39 | |
40 | See the L<Template::Tools::tpage> documentation for further information |
41 | and examples of use. |
42 | |
43 | =head2 ttree |
44 | |
45 | The L<ttree|Template::Tools::ttree> script can be used to process |
46 | an entire directory of templates. |
47 | |
48 | $ ttree --src /path/to/templates --dest /path/to/output |
49 | |
50 | Use the C<-h> option to get a summary of options: |
51 | |
52 | $ ttree -h |
53 | |
54 | See the L<Template::Tools::ttree> documentation for further information |
55 | and examples of use. |
56 | |
57 | =cut |
58 | |
59 | # Local Variables: |
60 | # mode: perl |
61 | # perl-indent-level: 4 |
62 | # indent-tabs-mode: nil |
63 | # End: |
64 | # |
65 | # vim: expandtab shiftwidth=4: |