InterpretSIS

The InterpretSIS tool is a PC-side command-line tool. It can be used by device creators to install SIS files to a data drive or ROM drive. This image can be flashed to a device internal drive or removable media.

InterpretSIS can be invoked either through BUILDROM while creating a data drive/ROM drive image or as a stand-alone tool. If invoking the tool through BUILDROM, the SIS files to be installed are listed in the OBEY file using the SISfile keyword. For an example OBEY file, see Building a Data Drive Image.

Syntax

interpretsis [OPTIONS] <ARGS>

The following table lists the options supported by the InterpretSIS tool:

Table: Interpretsis tool options
Options Description Usage

-h

Displays help message.

interpretsis [-h]

-o

Displays the OpenSSL licence.

interpretsis [-o]

-v

Displays the version of the tool.

interpretsis [-v]

-z

The directory representing the Z drive on the device.

interpretsis -[z dir]

-c

(Mandatory). The directory representing the system drive on the device.

interpretsis [-c dir] [-d drive] [-t romstubdir]

-d

The system drive (by default, C drive).

interpretsis [-d drive]

-r

List of ROM or ROFS build log files. For example, see Configuring the content of ROM drive.

This option must not be used with -z option or define the Z drive in the configuration file.

interpretsis [-r rofsbuild_log_file1,rofsbuild_log _file2,...]

-t

ROM Stub SIS files directory. This option must be used with -r option.

interpretsis [-t romstubdir]

-e

Disables eclipsing and SID checks using Z drive. The -z or -r is not required when this option is used.

interpretsis [-e]

-i

Configuration file with HAL attribute values for installation. For example, see Supporting device variant creation.

interpretsis [-i config_file]

-k

Specifies the SISRegistry version to be generated. For example, see Configuring the registry version.

interpretsis [-k [4.0 | 5.0 | 5.1 | 5.2 | 5.3 | 5.4]]

-l

The log file in which the diagnostic information is stored. By default, the information is stored in stderr.

interpretsis [-l logfile]

-n

Language code: Is a decimal number as defined in TLanguage enum.

interpretsis [-n language_code]

-p

Specifies the file containing additional parameters. Command line arguments specified after the file overrides the file contents.

interpretsis [-p param_file]

-s

Specifies the SIS files to install.

This option can be used to override the drive specified in the PKG file. For example, see Overriding the installation drive specified in the PKG file.

The +sucert option can be used with this option to indicate that the file is signed by a SU certificate. For example, see Installing system upgrade packages.

For more information about the options, see additional options.

interpretsis [-s [sisfile | dir] [+drive [+mcard | +mcardnr | +mcardalone | + mcardalonenr | +nonremovablepkg] [+sucert]]] [-s ...]

-w

The level of diagnostics to display –WARN, ERROR, INFO, OFF (WARN by default).

interpretsis [-w [off | error | warn | info]]

-x

Removes the files installed for a package. For example, see Uninstalling preinstalled packages.

This option must not be used with -s option.

interpretsis [-x pkgUID[,pkgUID2,...]]

The following table lists the additional options that can be used:

Table: Additional options
Options Description

mcard

Generates stub SIS file for the installation package. This is required for package propagation.

mcardnr

Generates non-removable stub SIS file for the installation package.

mcardalone

Generates stub SIS file for the installation package and does not generate the SIS Registry entry in the $:\sys\install\sisregistry\<package UID>\ directory. It just creates a preinstalled package on the media card.

mcardalonenr

Generates non-removable stub SIS file for the installation package and does not generating the SIS Registry entry in $:\sys\install\sisregistry\<package UID>\ directory.

nonremovablepkg

Generates a non-removable installation package.

Note: This option converts a removable SIS file to non-removable SIS file at install time. It reduces the effort of creating a new SIS file with the

NR flag during device creation.

sucert

Indicates that the SIS file is signed with a SU certificate.

Important: If the +sucert option is used with the +nonremovablepkg option, while installing an application using Interpretsis, then a non-removable upgrade of that application cannot be performed. The only workaround is to have the .sis file used for the upgrade to be signed with a SU certificate.

The following table lists arguments specified with the InterpretSIS tool:

Arguments Description

pkgUID

The installed package UID either in Hexadecimal or Decimal format (for example, 0x12345678, 305419896).

sisfile

The SIS files to be installed.

dir

The directory that contains the SIS files to be installed.

drive

The drive letter on the device.

Related concepts

Related reference