The Pack <file>
element
The <file>
tag is a nested element to the <pack> element and specifies a single file to be added to that pack.
You can use <fileset>
to add multiple files.
Attributes
Attribute | Description | Required | Values |
---|---|---|---|
| the file location (relative path). The src name may contain previously defined static variables (see | yes |
|
| the destination directory, could be something like | yes |
|
| Limit installation of this particular file only to the given target OS type. | no | "unix" | "windows" | "mac" |
| Whether to overwrite existing files. | no | "true" | "false" | "asktrue" | "askfalse" | "update" |
overrideRenameTo | Globmapper to rename a conflicting file to. This works similar like the <globmapper> in File Name Mappers, whereby the mapper's from attribute is set to the empty string and the to attribute exactly to the value given here. Example: | no | String - valid globmapper target expression |
blockable | For Windows only, ignored on non-Windows systems: | no |
|
| if true and the file is an archive then its content will be unpacked and added as individual files. | no | "true" | "false" |
| Limit installation of this particular file to the given condition, which must be true during the file installation. | no | String - a valid condition ID |
casesensitive | Whether to treat the file name case-sensitive. | no | "true" | "false" |
defaultExcludes | Whether to use global default excludes. */~{} */## */.# */%% */._ **/CVS */CVS/* **/.cvsignore **/SCCS */SCCS/* **/vssver.scc **/.svn */.svn/* **/.DS_Store Since IzPack 5.0 | no | "true" | "false" |
followSymLinks | Whether to follow symbolic links on target systems which support them. | no | "true" | "false" |
Nested Elements
The following nested elements can be used in the <file>
tag:
<os>
Limit the installation of this file to conditions depending on the target OS, see OS Restrictions.
<additionaldata>
This tag can also be specified in order to pass additional data related to a file tag for customizing.
Attribute | Description |
---|---|
| key to identify the data |
| value which can be used by a custom action |
;<additionaldata> is an element which may provide additional information as key-value pairs to certain custom actions. The particular key-value pairs you might use depend on the particular custom action.
Currently, there are two built-in custom actions consuming such data, ChmodCompilerListener
and ChmodInstallerListener
, where relevant keys are
permission.dir
,permission.file
with integer values interpreted as permissions like in the Unix chmod:
If value begins with "0
" -> octal number,
otherwise is is a decimal number representing some permission.
These permissions are applied to the appropriate files either during the compilation of the package or while installing them later, depending on whether the consumer implements a CompilerListener or InstallerListener.