We need you!


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

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated with new default value for overwrite.


fromfileThe source file containing the original configuration.No. Patching destinations can also be updated by manual definition using nested <entry> elements. If specified, fromfile must exist.
tofileThe file to patch to.

Exactly one of these is required.

Similar to the Ant copy task, fromfile can be used with tofile or todir. Nested <fileset> elements can be used with todir, but not with tofile, since the use of <fileset> implies a bulk patching operation. Neither tofile nor todir have to exist, but an error will occur if they cannot be created, or if create is set to false.

todirThe directory to patch to.
targetfileAn alternative file to write the patched configuration to.No. When specified, tofile itself is not modified. Cannot be used when nested <fileset>s are specified (since it makes no sense).
preservelastmodifiedGive the new configuration file(s) the same last-modified time as the original source file(s).No; defaults to false.
overwriteAllow existing destination files to be overwritten.No; defaults to falsetrue. If If overwrite and create are both set to false, an error occurs.
createAllow destination files to be created where they don't already exist.No; defaults to true. If overwrite and create are both set to false, an error occurs.
cleanupDeletes original configuration file(s) after new patched file(s) is/are successfully written. If any destination or target file could not be processed or written for any reason, the original file is never deleted, even if this is set to true.No; defaults to false.
failonerrorIf false, the listener will try to continue processing remaining actions even when errors in reading, processing, or writing files occur. Instead of immediately failing, a warning message is written to the log.No; defaults to true.
enablemultiplemappingsIf true the task will process to all the mappings for a given source path. If false the task will only process the first file or directory. This attribute is only relevant if there is a mapper subelement.No; defaults to false.
conditionSpecifies the name of an IzPack installer condition that must be fulfilled before the configuration is executed.No.
keepOldKeys (ini4j)Whether to generally preserve entries with the same name (but not necessarily the same value) from the source configuration file, if they can be found.

If keepOldKeys="true" and the entry occurs in the old configuration and also in the new configuration, the new configuration entry is left and the value is set according to keepOldValues. Otherwise, if the configuration entry found in an old configuration is not found in a new configuration, the old configuration entry and value is merged into the new configuration. Manual <entry> definitions will override the old value of a preserved key entry.
No; defaults to true.
keepOldValues (ini4j)Whether to preserve the values of equal entries from an old configuration, if they can be found.

Set false to overwrite old configuration values by default with the new ones, regardless whether they have been already set in an old configuration. Values from an old configuration can only be preserved, if the appropriate entries exist in an old configuration. Manual <entry> definitions will override the old value of a key entry even when keepOldValues is true. 
No; defaults to true.
escape (ini4j)Whether to parse the following sequences as escape characters (and write them accordingly to the target file) when they appear in a parsed configuration file:
  • \\ (escape character)
  • \t (tab)
  • \n (new line)
  • \f (form feed for printers)
  • \b (backspace)
  • \r (line feed)
No; defaults to true.
escapeNewLine (ini4j)When true, lines are concatenated as far as the last character before the line break backslash ('\'). In this case the trailing line break is omitted, interpreting several lines ending on '\' as a single "long" line.No; defaults to true.
headerComment (ini4j)Allows header comments in the file. If this is true, the comment before the first entry is treated as the global header comment for the whole file, not logically assigning this comment to the first option itself. The header comment might be internally overwritten separately, and is separated using a newlineNo; defaults to false.
emptyLines (ini4j)Preserves empty lines. If false, empty lines in configuration files are discarded when saving the file.No; defaults to true.
operator (ini4j)

Set this option to override the default operator key-value assignment operator.

When a file is parsed, the first occurrence of the = or : character is respected as being the operator between a key and its value; but the target file is always saved using = with a leading and trailing space character, i.e. " = ". This works fine for 'standard' Windows INI files. This attribute overrides the operator to use when writing  non-standard target files, e.g. for preserving : as the operator, or to explicitly set the string "=" (i.e. no leading/trailing whitespaces).

No; defaults to " = ". A string of one or more character is acceptable.
resolveExpressions (ini4j)Whether ini4j expressions should be resolved when a configuration is being patched. This is not the same as substituting IzPack variables, but resolves references to configuration entries in the same configuration file. See [ini4j] - Expression handling.No; defaults to false.