We need you!


The IzPack documentation needs work, and you are invited to edit it!

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

The Pack <file> element

The <file> tag is a nested element to the <pack> element and specifies a single file or a directory recursively to be added to that pack.

You can use <fileset> to add multiple files.







the file location (relative path) - if this is a directory its contents will be added recursively. It may contain previously defined static variables (see <variables>).




the destination directory, could be something like $INSTALL_PATH/subdirX




Limit installation of this particular file only to the given target OS type.


"unix" | "windows" | "mac"


Whether to overwrite existing files.
Use asktrue or askfalse if the user should be interactively asked what to do and supply default value for non-interactive use. Another possible value is update. It means that the new file is only installed if it's modification time is newer than the modification time of the already existing file (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"


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: 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


String - valid globmapper target expression


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.

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 included using this feature.

Possible values:
No recognition of blocked target files will be done at all, this is the default behavior of previous IzPack versions.
Automatic recognition of a blocked target file by the operating system, resulting 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 the system won't be really rebooted.
Forces target file to be always assumed a blocked, resulting in leaving a pending file operation to 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 a running process, but having the complete set of target files installed after system reboot.

Since IzPack 5.0


"none" | "auto" | "force"


if true and the file is an archive then its content will be unpacked and added as individual files.
Note: Only archives with ZIP compression are supported. This includes jar, war, zip, etc... 


"true" | "false"


Limit installation of this particular file to the given condition, which must be true during the file installation.


String - a valid condition ID


Whether to treat the file name case-sensitive.


"true" | "false"


Whether to use global default excludes.
Implicit default exclude patterns are typically:

Since IzPack 5.0


"true" | "false"


Whether to follow symbolic links on target systems which support them.
Since IzPack 5.0


"true" | "false"

Nested Elements

The following nested elements can be used in the <file> tag:


Limit the installation of this file to conditions depending on the target OS, see OS Restrictions.


This tag can also be specified in order to pass additional data related to a file tag for customizing.




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.

  • No labels