Package file format

This Package file format is supported for the Symbian OS v6.1, v7.0, v7.0s and v8.0.

A Package (PKG) file is a text file containing instructions that are used by Software Install. A PKG file consists of items/statements that define the information required by the SIS file creation utilities, i.e., makesis.

The first item in a PKG file should detail the languages provided within the SIS file.

This must be followed by the package header, which details the SIS component name, UID, and version information.

Product / platform version compatibility may not be supported by all Symbian OS platforms. It ensures that the application is compatible with the product and/or the platform version.

The next item is optional, and is a digital signature which gives the name of the private key file and associated certificates to be used to digitally sign the SIS file.

The remainder of the PKG file lists the files and components to be included in the SIS file or dependencies upon other installed components.

The PKG file format, which is described in modified BNF notation, can be broken down into the following items:

• languages
• (language code table)
• package-header
• [product / platform version compatibility]
• [package-signature]
• package-body
• dependency
• capabilities
• Example PKG files

The same list with further details:

Item/Statement Description Example languages List of languages provided by the SIS file &EN,FR package-header Component name, UID, major and minor version and build number #{"MyApp-EN", "MyApp-FR"}, (0x1000001F), 1, 2, 3, TYPE=SA [product / platform version compatibility] Where implemented, ensures compatibility between the application and the product and/or platform version. (0x101F617B), 2, 0, 0, {"UIQ20ProductID"} [package-signature] Optional. Private key file and associated certificates used for signature *"files\private.key","files\cert.cer" package-body Comments - are ignored by SIS creation tool condition-block - controls which parts of the SIS file are skipped options-list - to display a list of options to the user install-file - describes which files to install to which destination embedded-sis - to include a SIS file within a SIS file ; this is a comment IF (some_condition) ... package-body ... ENDIF !({"Add-on 1 (20KB)"},{"Add-on 2 (75KB)"}) "files\myFile.txt"-"!:\Documents\myFile.txt"; @"depend.sis",(0x10000003) dependency dependency on another component not embedded in the SIS file (0x10000003), 2, 2, 3, {"Depend-EN", "Depend-FR"} capabilities Determines the capabilities of a device or installed applications +(0=1,1=2,3=-1)

All PKG and text files parsed by makesis may be in either UTF8 or UNICODE format. UTF8 text is converted to UNICODE when creating a UNICODE SIS file. Both little-endian and big-endian UNICODE files may be used; automatic conversion is performed by makesis as appropriate.

Characters may be included within strings using an escape syntax. The following samples, within the package-header, demonstrate the use of a character code to include a "™" symbol at the end of the application name (for decimal and hexadecimal respectively):

    #{"MyApp"<153>}, ...

    #{"MyApp"<0x99>}, ...

Any numeric character code should be entered outside any double quotes and bounded by "<" and ">". The value may be in the range 0-255 when creating an ASCII SIS file or 0-65535 when creating a UNICODE SIS file.

Each PKG item/statement may be spread over multiple lines if desired.

For example PKG files see:

• Example PKG files

• HelloWorld example PKG files