OS Manuals

/usr/bin/ttree

comprehensive template processing system

From perl-template-toolkit 3.106-r4 (os), captured 2026-11-05 by running ttree --help (exit 0). permalink

ttree 3.106 (Template Toolkit version 3.106)

usage: ttree [options] [files]

Options:
   -a      (--all)          Process all files, regardless of modification
   -r      (--recurse)      Recurse into sub-directories
   -p      (--preserve)     Preserve file ownership and permission
   -n      (--nothing)      Do nothing, just print summary (enables -v)
   -v      (--verbose)      Verbose mode. Use twice for more verbosity: -v -v
   -h      (--help)         This help
   -s DIR  (--src=DIR)      Source directory
   -d DIR  (--dest=DIR)     Destination directory
   -c DIR  (--cfg=DIR)      Location of configuration files
   -l DIR  (--lib=DIR)      Library directory (INCLUDE_PATH)  (multiple)
   -f FILE (--file=FILE)    Read named configuration file     (multiple)

Display options:
   --colour / --color       Enable colo(u)rful verbose output.
   --summary                Show processing summary.

File search specifications (all may appear multiple times):
   --ignore=REGEX           Ignore files matching REGEX
   --copy=REGEX             Copy files matching REGEX
   --link=REGEX             Link files matching REGEX
   --copy_dir=DIR           Copy files in dir DIR (recursive)
   --accept=REGEX           Process only files matching REGEX

File Dependencies Options:
   --depend foo=bar,baz     Specify that 'foo' depends on 'bar' and 'baz'.
   --depend_file FILE       Read file dependancies from FILE.
   --depend_debug           Enable debugging for dependencies

File suffix rewriting (may appear multiple times)
   --suffix old=new         Change any '.old' suffix to '.new'

File encoding options
   --binmode=value          Set binary mode of output files
   --encoding=value         Set encoding of input files

Additional options to set Template Toolkit configuration items:
   --define var=value       Define template variable
   --interpolate            Interpolate '$var' references in text
   --anycase                Accept directive keywords in any case.
   --pre_chomp              Chomp leading whitespace
   --post_chomp             Chomp trailing whitespace
   --trim                   Trim blank lines around template blocks
   --eval_perl              Evaluate [% PERL %] ... [% END %] code blocks
   --load_perl              Load regular Perl modules via USE directive
   --absolute               Enable the ABSOLUTE option
   --relative               Enable the RELATIVE option
   --pre_process=TEMPLATE   Process TEMPLATE before each main template
   --post_process=TEMPLATE  Process TEMPLATE after each main template
   --process=TEMPLATE       Process TEMPLATE instead of main template
   --wrapper=TEMPLATE       Process TEMPLATE wrapper around main template
   --default=TEMPLATE       Use TEMPLATE as default
   --error=TEMPLATE         Use TEMPLATE to handle errors
   --debug=STRING           Set TT DEBUG option to STRING
   --start_tag=STRING       STRING defines start of directive tag
   --end_tag=STRING         STRING defined end of directive tag
   --tag_style=STYLE        Use pre-defined tag STYLE
   --plugin_base=PACKAGE    Base PACKAGE for plugins
   --compile_ext=STRING     File extension for compiled template files
   --compile_dir=DIR        Directory for compiled template files
   --perl5lib=DIR           Specify additional Perl library directories
   --template_module=MODULE Specify alternate Template module
   --expose_blocks          Make blocks visible as pseudo-files



See 'perldoc ttree' for further information.
Options (49)
OptionDescriptionSource
-a(--all) Process all files, regardless of modificationhelp
-r(--recurse) Recurse into sub-directorieshelp
-p(--preserve) Preserve file ownership and permissionhelp
-n(--nothing) Do nothing, just print summary (enables -v)help
-v(--verbose) Verbose mode.help
-h(--help) This helphelp
-s DIR(--src=DIR) Source directoryhelp
-d DIR(--dest=DIR) Destination directoryhelp
-c DIR(--cfg=DIR) Location of configuration fileshelp
-l DIR(--lib=DIR) Library directory (INCLUDE_PATH) (multiple)help
-f FILERead named configuration file (multiple)help
--colour /Enable colo(u)rful verbose output.help
--summaryShow processing summary.help
--ignore REGEXIgnore files matching REGEXhelp
--copy REGEXCopy files matching REGEXhelp
--link REGEXLink files matching REGEXhelp
--copy_dir DIRCopy files in dir DIR (recursive)help
--accept REGEXProcess only files matching REGEXhelp
--depend foo=barSpecify that 'foo' depends on 'bar' and 'baz'.help
--depend_file FILERead file dependancies from FILE.help
--depend_debugEnable debugging for dependencieshelp
--suffix old=newChange any '.old' suffix to '.new'help
--binmode valueSet binary mode of output fileshelp
--encoding valueSet encoding of input fileshelp
--define var=valueDefine template variablehelp
--interpolateInterpolate '$var' references in texthelp
--anycaseAccept directive keywords in any case.help
--pre_chompChomp leading whitespacehelp
--post_chompChomp trailing whitespacehelp
--trimTrim blank lines around template blockshelp
--eval_perlEvaluate [% PERL %] ...help
--load_perlLoad regular Perl modules via USE directivehelp
--absoluteEnable the ABSOLUTE optionhelp
--relativeEnable the RELATIVE optionhelp
--pre_process TEMPLATEProcess TEMPLATE before each main templatehelp
--post_process TEMPLATEProcess TEMPLATE after each main templatehelp
--process TEMPLATEProcess TEMPLATE instead of main templatehelp
--wrapper TEMPLATEProcess TEMPLATE wrapper around main templatehelp
--default TEMPLATEUse TEMPLATE as defaulthelp
--error TEMPLATEUse TEMPLATE to handle errorshelp
--debug STRINGSet TT DEBUG option to STRINGhelp
--start_tag STRINGSTRING defines start of directive taghelp
--end_tag STRINGSTRING defined end of directive taghelp
--tag_style STYLEUse pre-defined tag STYLEhelp
--plugin_base PACKAGEBase PACKAGE for pluginshelp
--compile_ext STRINGFile extension for compiled template fileshelp
--compile_dir DIRDirectory for compiled template fileshelp
--perl5lib DIRSpecify additional Perl library directorieshelp
--expose_blocksMake blocks visible as pseudo-fileshelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.