<info>
The <info>
element is used to specify some general information for the installer. It contains the following elements :
Element | Usage | Required | |||||||
---|---|---|---|---|---|---|---|---|---|
| The name of the application that will be installed. | Yes | |||||||
| The version of the application | Yes | |||||||
| The subpath for the default of the installation path. This will be appended to the installation folder selected by the user and will be created during the installation if it does not exist. A variable substitution will be done at compile time and a maskable slash-backslash conversion will be done at run-time. If this tag is not defined, the application name will be used instead. | No | |||||||
| The URL of the application's official website. Note: You can add the project URL from the Maven POM file by setting the configuration option | No | |||||||
| Specifies the author(s) of the application. It must contain at least one <author> element; see below. Nested elements:
Example:
Note: You can add authors listed in the Maven POM file by setting the configuration option | Yes | |||||||
<uninstaller> | specifies whether to create an uninstaller after installation, and which name to use for it. This tag has the attributes:
| No | |||||||
| This specifies the minimum version of Java required to install your program. Values can be 1.2, 1.2.2, 1.4, etc. The test is a lexical comparison against the java.version System property on the install machine. This tag has attribute:
| Yes | |||||||
| Valid values: | Yes | |||||||
| If this element is present, a web installer will be created. The contents of the tag specifies the URL from which packages are retrieved at install time. The content of the element must be a properly formed URL that points to the remote folder where the packages reside. See Web Installers for more information. | No | |||||||
| If this element is present, it specifies the path for the logfile of the `SummaryLoggerInstallerListener`. If it is not specified the logfile is not created. | No | |||||||
<readinstallationinformation> | Specifies whether the file .installationinformation should be read. This is useful to prevent breaking updates to files installed with older versions of IzPack which wrote .installationinformation by setting Valid values are See InstallationTypePanel and TreePacksPanel to see how this information can be handled by the installer. | ||||||||
| Specifies whether the file .installationinformation should be written. This file includes a list of installed packs and variables set when running an installer.. If true, at the end of the installation a binary file If there is an IzPack variable
This can be useful for simple installers to simplify updating over a previous installation. Valid values are See InstallationTypePanel and TreePacksPanel to see how this information can be handled by the installer.
| No | |||||||
| Adding this element will cause every JAR file that you will add to your packs to be compressed using Pack200. As a special exception, signed JARs are not compressed using Pack200, as it would invalidate the signatures. Compressing makes the compilation process a little bit longer, but it usually results in drastically smaller installer files. The decompression is relatively fast. Please note that Pack200 compression is destructive, i.e., after decompression a JAR won't be identical to its original version (yet the code in the class files remains semantically equivalent). This flag does not affect the compression of jar files added by the | ||||||||
| If this element is included then a randomly named temporary directory will be created at the start of the install and deleted when the installation completes.
| No | |||||||
| Adding this element will make the installer attempt to launch itself with administrator permissions. It also supports a condition attribute to refer to a condition ID so that the elevation is not always attempted (e.g., you may want to activate it only for Windows Vista). This is not supported on all platforms, in which case a message will be provided to the user before continuing the installation. Only use this feature if you really need to be an administrator as part of your installation process.
An example for a windows installer would be | No | |||||||
| Defines what to do if there are pending installation operations left which require a reboot; If there are no pending operations, the options below will be ignored. Possible values are:
The use of | No | |||||||
<singleinstance> | By default, IzPack will pop up a message which asks the user whether an already running instance of the same installer should be ignored or rather whether to abort the new instance. This can be inconvenient for some use cases (clustering, sub-calls when an installer calls itself with different options,...). You can disable this behavior by setting this option to "no".
Since: IzPack 5.0 RC5 | No | |||||||
| If this element is included and specifies a valid date formatted as "YYYY-MM-DD", the installer will display a brief message and exit if started on or after the specified date. If
Since: IzPack 5.0 RC5 | No |
Notes:
Here is an example of a typical <info> section :
<info> <appname>Super extractor</appname> <appversion>2.1 beta 6</appversion> <appsubpath>myCompany/SExtractor</appsubpath> <url>http://www.superextractor.com/</url> <authors> <author name="John John Doo" email="jjd@jjd-mail.com"/> <author name="El Goyo" email="goyoman@mymail.org"/> </authors> <javaversion>1.2</javaversion> <expiresdate>2016-06-29</expiresdate> </info> |
Here is one where the privileges elevation is attempted on Windows Vista and Mac OS X :
<info> <appname>IzPack</appname> <appversion>4.2.0</appversion> <authors> <author email="" name="Julien Ponge (project founder)"/> <author email="" name="The fantastic IzPack developers and contributors"/> </authors> <url>http://izpack.org/</url> <javaversion>1.5</javaversion> <requiresjdk>no</requiresjdk> <run-privileged condition="izpack.windowsinstall.vista|izpack.macinstall"/> <summarylogfilepath>$INSTALL_PATH/installinfo/Summary.htm</summarylogfilepath> </info> |