Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If the paths are relative, they will be matched relative to $INSTALL_PATH. Update checks are only enabled if at least one <include> is specified. See {{com.izforge.izpack.installer.Unpacker
for details.

<file> - add files and/or directories

The <file> tag specifies a single file (a directory is a file, too!) to include into the pack.

...

Attributes

...

Attribute

...

Description

...

Required

...

Values
(Default)

...

src

...

the file location (relative path) - if this is a directory its content will be added recursively. It 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.
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.)

...

no

...

"true" | "false" | "asktrue" | "askfalse" | "update"
("update")

...

overrideRenameTo

...

no

...

String - valid globmapper target expression

...

blockable

...

no

...

"none" | "auto" | "force"
("none")

...

unpack

...

if true and the file is an archive then its content will be unpacked and added as individual files

...

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")

...

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 below.
<singlefile> - add a single file

Specifies a single file to include. The difference to <file> is that this tag allows the file to be renamed, therefore it has a target attribute instead of targetdir.

...

Attributes

...

Attribute

...

Description

...

Required

...

Values
(Default)

...

src

...

the file location (relative path). It may contain previously defined static variables (see <variables>).

...

yes

...

 

...

target

...

the destination file name, could be something like $INSTALL_PATH/subdirX/fileY

...

yes

...

 

...

os

...

can optionally specify a target operating system (unix, windows, mac) - this means that the file will only be installed on its target operating system

...

no

...

"unix" | "windows" | "mac"

...

override

...

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.)

...

no

...

"true" | "false" | "asktrue" | "askfalse" | "update"
("update")

...

overrideRenameTo

...

no

...

String - valid globmapper target expression

...

blockable

...

no

...

"none" | "auto" | "force"
("none")

...

condition

...

an id of a condition which has to be fullfilled to install this file

...

 

...

 

...

Nested Elements

...

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

  • <os>
    Limit the installation of this file to conditions depending on the target OS, see below.
  • <additionaldata>
    Add customizing data, see below.
<fileset> - add a fileset

The <fileset> tag allows files to be specified similar like in Apache Ant.

...

Attributes

...

Attribute

...

Description

...

Required

...

Values
(Default)

...

dir

...

A base directory for the fileset (relative paths are treaten against the compiler base directory)

...

yes

...

 

...

file

...

A single file to copy, can be relative to the directory specified in dir. If not given, the whole directory dir is recursively included, filtered by the include and exclude expressions below.

...

no

...

 

...

targetdir

...

the destination path, works like for <file>

...

yes

...

 

...

casesensitive

...

optionally lets you specify if the names are case- sensitive or not - takes yes or no

...

no

...

 

...

os

...

specifies the operating system, works like for <file>

...

no

...

"unix" | "windows" | "mac"

...

override

...

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.)

...

no

...

"true" | "false" | "asktrue" | "askfalse" | "update"
("update")

...

overrideRenameTo

...

no

...

String - valid globmapper target expression

...

blockable

...

no

...

"none" | "auto" | "force"
("none")

...

includes

...

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.

...

 

...

 

...

excludes

...

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.

...

 

...

 

...

condition

...

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"
("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")

...

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 below.
  • <additionaldata>
    Add customizing data, see below.
  • <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.
<parsable> - parse a file after installation

...

This enables a model in which a single developer is responsible for maintaining the packs and resources (e.g. separate packsLang.xml_xyz files providing internationalization; see Internationalization of the PacksPanel) related to the development-package assigned to him. The main install XML references these xml-files to avoid synchronization efforts between the central installation XML and the developer-maintained installer XMLs.

Attributes

Attribute

Description

file

Relative path during compile-time to an externally defined packs-definition

...