The <file> element
...
Attribute | Description | Required | Values
(Default) |
|---|
src
| the file location (relative path). The src name may contain previously defined static variables (see <variables>). | yes | |
targetdir
| the destination directory, could be something like $INSTALL_PATH/subdirX | yes | |
os
| Limit installation of this particular file only to the given target OS type. | no | "unix" | "windows" | "mac" |
override
| Whether to overwrite existing files. true if the file should always overwrite an existing file with the same name.false if the file should be skipped if the file already exists in the targetdir.
Use asktrue or asktrue if the user should be interactively asked what to do and supply default value of "true" for non-interactive use.askfalse if the user should be interactively asked what to do and supply default value of "false" for non-interactive use.
Another possible value is update. It means that update if the new file is only installed if it's modification time is newer than the modification time of the already existing file
(note - . Note that this is not a reliable mechanism for updates - you cannot detect whether a file was altered after installation this way.
) | | "true" | "false" | "asktrue" | "askfalse" | "update"
("update") |
overrideRenameTo | Globmapper to rename a conflicting file to. This works similar like to 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: overrideRenameTo=".bak" will rename the target file by appending the suffix .bak instead of overwriting it. The override attribute must be set "true" to activate this feature.
Since IzPack 5.0 | no | String - valid globmapper target expression |
blockable | For Windows only, ignored on non-Windows systems:
Defines whether and how blocked target files on Windows should be recognized. This might result in pending file operations which require a system reboot. The reboot behavior at the end of an installation for pending file operations can be set using the nested rebootaction in the info element. See above for possible reboot options.
Notes:
Using blockable does not necessarily force you to limit such files on Windows systems. For multi-platform installations there is a compiler warning shown that blockable will be ignored on non-Windows systems.
The native library WinSetupAPI must be explicitely explicitly included using this feature.
Possible values:" ":
No - means recognition of blocked target files will not be done at all, this is the default behavior of previous IzPack versions.
"auto":
Automatic auto means that there will be automatic recognition of a blocked target file by the operating system
, resulting - . This will result in leaving a pending file operation to be finished after system reboot. Using
auto
this - applies only for files that are really blocked, the other files are copied normally, which can result in mixed, old and new target files at the end of the installation
, unless won't be really "force":
Forces force forces the target file to be always assumed
a in leaving to - that will be finished after system reboot. Using
force this applies for each file, regardless whether it is really blocked during installation. This makes sense if you don't want to mix files old and new files at the end of the installation to not
disturbing - disturb a running process,
but - while having the complete set of target files installed after system reboot.
Since IzPack 5.0
| no | "none" | "auto" | "force"
("none")
|
unpack
| if true and the file is an archive then its content contents will be unpacked and added as individual files.
Note: Only archives with ZIP compression are supported. This includes jar, war, zip, etc... | no | "true" | "false"
("false") |
condition
| 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"
("true") |
defaultExcludes | Whether to use global default excludes.
Implicit default exclude patterns are typically: | Code Block |
|---|
*/~{}
*/##
*/.#
*/%%
*/._
**/CVS
*/CVS/*
**/.cvsignore
**/SCCS
*/SCCS/*
**/vssver.scc
**/.svn
*/.svn/*
**/.DS_Store |
Since IzPack 5.0 | no | "true" | "false"
("true") |
followSymLinks | Whether to follow symbolic links on target systems which support them.
Since IzPack 5.0 | no | "true" | "false"
("true") |
...
Attribute | Description |
|---|
key
| key to identify the data |
value
| 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 will 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.