TclApp Command Line Options

This reference outlines the command-line options for TclApp. For detailed instructions for wrapping Tcl applications at the command line, see Using TclApp on the Command-Line in the TclApp user guide.

Commands by Functional Group

Files and Paths

Packages

Compiling

Compression

Metadata

Misc

Command List

-alias PATH
Specify wrapped name of file that follows. See Specifying Source and Destination Base Directories.
-anchor PATH
Specify base path in archive for files that follow. See Specifying Source and Destination Base Directories.
-a, -app NAME
Like -pkg, and marks the package as the entrypoint for the application (command-line only). See Specifying the Startup Application.
-archive LOCATION
Specifies the location of additional archives to query for packages. The following types of archive are automatically detected:

The archives are queried in the order specified (with the standard archives appended). The first matching package is taken.

The set of .tap search paths (pkgSearchPathList) is used in previous versions of TclApp is now the standard set of archive locations. Automatic type-detection ensures that the old .tap paths found in the list can be used without any conversion or intervention.

Note: The -prefix file is always considered the last package archive, making it the ultimate fallback. Without prefix a standard virtual base is used, containing just Tcl and Tk.

See Wrapping Packages.

-architecture
Specify the target architecture(s) for starkits. Multiple architectures can be specified, this is called multi-platform wrapping. Valid architecture names are:

TDK distributions:

Other ActiveTcl, ActiveTcl Enterprise and OEM architectures:

User generated platform names can also be specified (see platforms.tcl). If -architecture is not set and no prefix file is present, the architecture is "tcl". If a prefix file is used (i.e. for starpacks), its architecture is assumed.

Package references are resolved for all architectures specified.

-arguments ARGUMENTS
Specify additional arguments to application. These are treated as if they were submitted to an unwrapped application on the command line. The arguments are stored in the Tcl argv variable. They are inserted before any command-line arguments entered by the end user when the wrapped application is executed. See Specifying Run-Time Arguments.
-code 'SCRIPT ...'
Application initialization script(s). If multiple scripts are specified, they are executed in order. See also -postcode. See Specifying Code to Execute at Application Startup.
-compile
compile tcl files before wrapping them (implies '-pkgref tbcload'). See Compiling .tcl Files.
-compilefile [...] FILE
Compiles the next file specified in the command line. Forces the inclusion of '-pkgref tbcload' (if not overridden by -notbcload). See Compiling .tcl Files.
-compilefor TCL-VERSION
Compile bytecodes for the specific version Tcl. See Compiling .tcl Files.
-config FILE
Get command line arguments from a file. The file can be a '.tpj' file (TclApp project file) or a text file containing command-line options (space or newline separated). This option is useful when adding a specific TclApp wrapping task into a build system. See Specifying an External Configuration File.
-encoding NAME
Specify additional encoding for starpack. Valid encoding names are the same as those returned by Tcl's 'encoding names' built-in command. See Specifying Encodings.
-executable FILE
Name of the basekit (deprecated, use -prefix).
-follow
Requests expansion of the required dependencies. If one or more dependencies have no matching instances, the application will abort after the expansion step unless -force is specified. See Wrapping Packages.
-follow-recommend
Requests expansion of both required and recommended dependencies. If one or more dependencies have no matching instances, the application will abort after the expansion step unless -force is specified. See Wrapping Packages.
-force
Force the application to perform wrapping even if the expansion step was unable to find instances for all dependencies. This option is ignored when -follow or -follow-recommend is not specified, or if no profile packages are specified. See Wrapping Packages.
-help
Print help message.
-interpreter PATH
Name interpreter to insert into starkit. See Specifying the Interpreter: Creating Starpacks and Starkits.
-icon PATH
Path to the icon to embed into the executable. Assigning a Custom Icon to the Output File.
-infoplist 'DICT'
Specify Info.plist metadata for OS X applications in Tcl dictionary format. All keys are optional. See OS X Info.plist documentation. See Setting Custom Info.plist Information into the Output File
-log PATH
Path to logfile. See Storing Log Output.
-merge 'FILE ...'
Merge given files into output file. Cannot be used in conjunction with '-prefix' or '-executable'. See Merging the Output.
-metadata 'DICT'
Specify TEApot metadata in Tcl dictionary format. See Setting Custom Metadata into the Output File.
-nocompilefile [...] FILE
Exempts the next file specified from compilation (overrides the global '-compile'setting). See Compiling .tcl Files.
-nocompress
Do not compress the files in the wrap result. By default starkits and starpacks are compressed during wrapping and decompressed when they are read by the application. This makes for larger filesizes for the resulting starkits and starpacks, but may speed up execution. See Suppressing Compression.
-nologo
Suppress copyright banner in output during wrapping.
-nospecials
Prevent generation of 'main.tcl' and application 'pkgIndex.tcl'. See Suppressing Special Files.
-notbcload
Suppresses the implicit '-pkgref tbcload' of -compile above. See Compiling .tcl Files.
-osxapp
Make the output an OS X .app bundle. If '.app' is not specified in the basename, it will be appended when the directory tree is created. The wrapped executable itself is put in 'application.app/Contents/MacOS/'. See Creating a '.app' Bundle.
-out FILE
Name of output file. The default name is 'tclapp-out'. The file extension inherited from the prefix file or set to '.kit' if none is specified. See Specifying the Output File Name.
-pkgfile FILE
Sets the path to a package archive file (a .zip archive or .tm' Tcl module) for inclusion in the wrap result. The package in the file is wrapped without any special processing. Dependency expansion is done only for profile packages. See Wrapping Packages.
-pkgref 'NAME ...'

Wrap all files of the named package without specifying the filenames. This option provides access to the full syntax of package references as used by TEApot.

Example package references.

See Wrapping Packages.

-pkg 'NAME | NAME-VERSION'
Wrap all files of the specified package (Deprecated, replaced by -pkgref). See Wrapping Packages.
-pkgdir PATH
Specify an additional package search path for when the wrapped application is executed. See Specifying a Non-Standard Package Directory.
-pkg-accept
Deprecated alias to -upgrade (for backward compatibility).
-postcode 'SCRIPT ...'
Application initialization script(s) run after the application has started. If multiple scripts are specified, they are executed in order. See also -code. See Specifying Code to Execute at Application Startup.
-prefix FILE|REF
Either path of the basekit to use for wrapping a starpack, or a teapot-reference. See Specifying the Interpreter: Creating Starpacks and Starkits.
-relativeto DIRECTORY
Specify a relative directory for files that follow. See Specifying Source and Destination Base Directories.
-startup FILE
Declare starting script filename. See Specifying the Startup File.
-stringinfo 'DICT'
Specify Win32 String Resources for Windows applications in Tcl dictionary format. See Setting Custom String Information into the Output File.
-temp DIRECTORY
Specify an alternate temp directory. See Specifying a Temporary Directory.
-upgrade
Indicate that automatic upgrades of the specified version numbers are acceptable. If not present, exact versions are required. See Wrapping Packages.
-verbose
Produce detailed output during wrapping. See Verbose versus Quiet Logging.