Adding a set of files
The <fileset>
element
The <fileset>
tag is a nested element to the <pack> element and allows files to be added to that pack by selecting them similar like in an Apache Ant fileset.
Attributes
Attribute | Description | Required | Values |
---|---|---|---|
| A base directory for the fileset (relative paths are treaten against the compiler base directory) | yes | |
|
|
| |
| the destination path, works like for | no | ("${INSTALL_PATH}") |
| specifies the operating system, works like for | 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 "" and the to attribute exactly to the value given here. Since IzPack 5.0 | no | String - valid globmapper target expression |
blockable | For Windows only, ignored on non-Windows systems: Pending file operations are introduced during the installation in two phases:
Note:
| no |
|
| comma- or space-separated list of patterns of files that must be included; all files are included when omitted. This is an alternative for multiple include tags. | ||
| comma- or space-separated list of patterns of files that must be excluded; no files (except default excludes) are excluded when omitted. This is an alternative for multiple exclude tags. | ||
| an id of a condition which has to be fulfilled to install the files in this fileset | ||
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 <fileset>
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.
<include>
Explicitely include files by pattern, similar like Ant fileset patterns. For more information see the FileSet core type.
Note: There is currently no file name mapper support in pack filesets.
<exclude>
Explicitely exclude files by pattern, similar like Ant fileset patterns. For more information see the FileSet core type.
Note: There is currently no file name mapper support in pack filesets.
Fileset Selectors
There can be used all fileset selectors defined in FileSet as nested elements.
<pack200>
The <pack200> element adds Java bytecode compression to all files in this fileset.
Make sure to apply it only to JAR files or similar files containing Java bytecode.
See Compressing pack files for more information how to cutomize this feature.
Since: IzPack 5.1