...
The specification for application shortcuts is provided to the Shortcut Panel in the XML file format. The root element is <shortcuts>
.
Nested Elements
defaultCurrentUser
...
The attributes listed in this table are mostly common to all platforms, but some are not valid on Unixor sensible on all operating systems. These cases are noted. Additional, UnixOS-specific attributes, are listed separatelybelow.
Attribute | Description | Required | ||
---|---|---|---|---|
name | The name that the shortcut will have. This is the text that makes up the menu name if the shortcut is placed in a menu or the caption that is displayed with the shortcut if it is placed on the desktop. | Yes | ||
target | The application that should be launched when the shortcut is clicked. The value is translated through the variable substitutor, so variables such as
| Yes | ||
commandLine | Specifies command line arguments to pass to the target through the shortcut. Command line arguments are not supported by all operating systems. As a result, your applications will not be portable if they depend on command line arguments. Instead, consider using system properties or configuration files. See Shortcut Tips on command line arguments. | No | ||
workingDirectory | Defines the working directory for the application at the time it is launched. Exercise caution in relying on this too heavily if your application should be portable, since this might not be supported by all operating systems. The value is translated through the variable substitutor, so variables such as $INSTALL_PATH can be used to describe the directory. | No | ||
description | The value of this attribute will be visible to the user when a brief description about associated application is requested. The form of the request and the way in which this description is displayed varies between operating systems. On Windows, the description is shown as a tool tip when the mouse cursor hovers over the icon for a few seconds. On some operating systems this feature might not be supported. | No | ||
iconFile | A file that holds the icon that should be displayed as a symbol for this shortcut. This value is translated through the variable substitutor, so variables such as
See Shortcut Tips on shortcut icons. | No | ||
iconIndex | If the file type for the icon supports multiple icons in one file, then this attribute may be used to specify the correct index for the icon. In file formats that do not support multiple icons, this value is ignored. This is only likely to be useful for Windows shortcuts, if the icon is in a multiple-icon ICO, or embedded in a DLL or EXE file. See Shortcut Tips on shortcut icons. | No | ||
initialState | If the target operating system supports this feature, then this value will set the initial window state of the application. Valid options are:
The | No; default is | ||
programGroup | If the value is true , then a copy of this shortcut will be placed in the group menu (see programGroup). On Unix (KDE) this will always be placed on the top level. | At least one location attribute is required, as all default to false . If no location attribute is true , the shortcut will not be displayed anywhere. If multiple locations attributes are true , a copy of the shortcut will be displayed in all of those locations. | ||
desktop | If the value is true , then a copy of the shortcut is placed on the desktop. On Unix the shortcuts will only be placed on the KDE desktop of the user currently running the installer. For Gnome the user can simply copy the .desktop files from */Desktop to /gnome-desktop . | |||
applications | If the value is true , then a copy of the shortcut is placed in the applications menu (if the target operating system supports this). This is the same location as the applications choice for the programGroup element. Setting applications="true" is equivalent to setting programGroup="true" on Unix. | |||
startMenu | If the value is true , then a copy of the shortcut is placed directly in the top most menu that is available for placing application shortcuts. This is not supported on Unix. | |||
startup | If the value is true , then a copy of the shortcut is placed in a location where all applications get automatically started at OS launch time, if this is available on the target OS. This is not supported on Unix. | |||
subgroup | Specifies a sub-path (i.e. a sub-folder) of the main program group in which this shortcut will be placed. This is not supported on Unix. | No; has no effect unless programGroup is true . | ||
condition | Specifies the name of an installer condition that must evaluate to true for this shortcut to be created. If the condition does not exist, the shortcut is created. | No |
Unix-specific attributes
These attributes apply only to Unix-based systems (including Linux).
Attribute | Description | Required | ||
---|---|---|---|---|
type | Specifies the type of shortcut. Valid values are:
| Yes | ||
url | Specifies a locally installed HTML file, other file with a known MIME type (e.g. plain text), or a WWW URL (e.g. http://izpack.org/ ). This value is translated through the variable substitutor, so variables such as $INSTALL_PATH (for local documents) can be used. | Yes, if type=link | ||
mimeType |
| |||
encoding | This should always set to UTF-8 . | Yes | ||
terminal | Set to true to allow the user to see the console output of a program (e.g. in Java applications "System.out"). | No; defaults to false . | ||
terminalOptions |
| No | ||
KdeSubstUID | This is the sudo option for a shortcut. If set to true , you will be asked for the password of the KdeUsername . | No; defaults to | ||
KdeUsername | The username with correct sudo permissions where KdeSubstUID is true . This is root in most cases. | No; defaults to root . | ||
createForAll | If a user with administrative rights, such as root, performs the installation, set to true to make this shortcut appear to other users as well as root. | No; defaults to false . | ||
categories | The category in the Desktop Application Menu where the shortcut will be placed. Here are some sample categories and their apps. For more examples, examine the desktop files in
| No; no default. | ||
tryexec | Specifies a command to pass through 'raw' to the operating system. | No; default is to use target and (where present) commandLine |
createForPack
This is an optional nested element, with one required attribute, name
, specifying the name of a pack that must be selected for this shortcut to be created. Multiple <createForPack>
elements can be nested in the same <shortcut>
.
...