TFPrint Command-Line Reference
Reference Overview
TFPrint is the command-line interface of TFORMer SDK. It generates output from a stand-alone form layout or a form in a repository, using supplied data or data already provided by the layout. A TFS job file can select layouts, records and destinations for several jobs in one invocation.
Use the TFPrint guide for the basic workflow and first examples. This reference describes the command-line and TFS job-file interfaces.
| Topic | Contents |
|---|---|
| Syntax | Invocation forms, required arguments, quoting, command files and paths |
| Parameters | Parameter index, layout, data, output, SDK options, licensing and other switches |
| Command-Line Help | Verbatim help text with the Linux differences, and explanatory notes |
| Errors and Exit Codes | Process status, diagnostics and checks for callers |
| TFS Job Files | XML elements, attributes, inheritance, destinations and examples |
Platforms and Installation
On Windows the executable is TFPrint.exe; on Linux it is tfprint. Use the executable and runtime libraries for your process architecture. Output types and printer handling differ between platforms; see Output Target.
The command examples use tfprint as the executable name. Replace it with the full path to your installed executable when it is not on the executable search path. Replace layout, data, destination and license placeholders with your own values.
See Windows installation, Linux installation, Windows deployment and Linux deployment for the runtime files and requirements. Run the installed executable's help when checking the switches available in a particular package.
Shared Topics
The following chapters supply the shared rules used by TFPrint:
- Layouts, Repositories and Data Fields describes the objects selected by
-Fand the data field names used in input. - Data Sources and Formats describes XML, delimited text, record copies and data field handling.
- Output Options describes the options passed through
-SDK, including their output-type restrictions. - Output Configuration describes shared defaults and the configuration file selected by
-CONFIG. - Licensing describes license types, validity and permitted use; the license parameter describes the command-line forms.
- Server and Web Applications describes input availability and the local-file fallback.
- Windows deployment and Linux deployment describe automatic license lookup and platform requirements.
- Troubleshooting and Contact and Support provide the common support information.