ControlTier > core
 

Docs-Generate

Command Reference

Description

Generate the configured template-based documents.

The role of the Docs-Generate command is to generate any template based documents. Typically, these are configuration file templates that reference property names provided by the object context. The implementation provided by Deployment is to iterate over the set of properties of the pattern: ^document.(.*).template$ and to call the command, Doc-Generate for each one.

If -archivedir <directory> option is used then any files that were created from the previous run of Docs-Generate are copied to that that directory.

Usage

ctl -t Deployment -o <objectname> -c Docs-Generate [-archivedir <${entity.instance.dir}/var>] [-buildstamp <>] [-filterfile <>]

Options

Option Description Type Default
archivedir dir to store current output docs string ${entity.instance.dir}/var
buildstamp build identifer. currently ignored string
filterfile file filter tokens and values string ${entity.attribute.filterFile}